Generate ChangeLog from git in make dist
[libffi.git] / README
1 Status
2 ======
3
4 libffi-3.1 was released on TBD.  Check the libffi web
5 page for updates: <URL:http://sourceware.org/libffi/>.
6
7
8 What is libffi?
9 ===============
10
11 Compilers for high level languages generate code that follow certain
12 conventions. These conventions are necessary, in part, for separate
13 compilation to work. One such convention is the "calling
14 convention". The "calling convention" is essentially a set of
15 assumptions made by the compiler about where function arguments will
16 be found on entry to a function. A "calling convention" also specifies
17 where the return value for a function is found.
18
19 Some programs may not know at the time of compilation what arguments
20 are to be passed to a function. For instance, an interpreter may be
21 told at run-time about the number and types of arguments used to call
22 a given function. Libffi can be used in such programs to provide a
23 bridge from the interpreter program to compiled code.
24
25 The libffi library provides a portable, high level programming
26 interface to various calling conventions. This allows a programmer to
27 call any function specified by a call interface description at run
28 time.  
29
30 FFI stands for Foreign Function Interface.  A foreign function
31 interface is the popular name for the interface that allows code
32 written in one language to call code written in another language. The
33 libffi library really only provides the lowest, machine dependent
34 layer of a fully featured foreign function interface. A layer must
35 exist above libffi that handles type conversions for values passed
36 between the two languages.
37
38
39 Supported Platforms
40 ===================
41
42 Libffi has been ported to many different platforms.
43 For specific configuration details and testing status, please
44 refer to the wiki page here:
45
46  http://www.moxielogic.org/wiki/index.php?title=Libffi_3.0.13
47
48 At the time of release, the following basic configurations have been
49 tested:
50
51 |-----------------+------------------+-------------------------|
52 | Architecture    | Operating System | Compiler                |
53 |-----------------+------------------+-------------------------|
54 | AArch64 (ARM64) | iOS              | Clang                   |
55 | AArch64         | Linux            | GCC                     |
56 | Alpha           | Linux            | GCC                     |
57 | Alpha           | Tru64            | GCC                     |
58 | ARC             | Linux            | GCC                     |
59 | ARM             | Linux            | GCC                     |
60 | ARM             | iOS              | GCC                     |
61 | AVR32           | Linux            | GCC                     |
62 | Blackfin        | uClinux          | GCC                     |
63 | HPPA            | HPUX             | GCC                     |
64 | IA-64           | Linux            | GCC                     |
65 | M68K            | FreeMiNT         | GCC                     |
66 | M68K            | Linux            | GCC                     |
67 | M68K            | RTEMS            | GCC                     |
68 | M88K            | OpenBSD/mvme88k  | GCC                     |
69 | Meta            | Linux            | GCC                     |
70 | MicroBlaze      | Linux            | GCC                     |
71 | MIPS            | IRIX             | GCC                     |
72 | MIPS            | Linux            | GCC                     |
73 | MIPS            | RTEMS            | GCC                     |
74 | MIPS64          | Linux            | GCC                     |
75 | Moxie           | Bare metal       | GCC                     |
76 | Nios II         | Linux            | GCC                     |
77 | PowerPC 32-bit  | AIX              | IBM XL C                |
78 | PowerPC 64-bit  | AIX              | IBM XL C                |
79 | PowerPC         | AMIGA            | GCC                     |
80 | PowerPC         | Linux            | GCC                     |
81 | PowerPC         | Mac OSX          | GCC                     |
82 | PowerPC         | FreeBSD          | GCC                     |
83 | PowerPC 64-bit  | FreeBSD          | GCC                     |
84 | PowerPC 64-bit  | Linux ELFv1      | GCC                     |
85 | PowerPC 64-bit  | Linux ELFv2      | GCC                     |
86 | S390            | Linux            | GCC                     |
87 | S390X           | Linux            | GCC                     |
88 | SPARC           | Linux            | GCC                     |
89 | SPARC           | Solaris          | GCC                     |
90 | SPARC           | Solaris          | Oracle Solaris Studio C |
91 | SPARC64         | Linux            | GCC                     |
92 | SPARC64         | FreeBSD          | GCC                     |
93 | SPARC64         | Solaris          | Oracle Solaris Studio C |
94 | TILE-Gx/TILEPro | Linux            | GCC                     |
95 | VAX             | OpenBSD/vax      | GCC                     |
96 | X86             | FreeBSD          | GCC                     |
97 | X86             | GNU HURD         | GCC                     |
98 | X86             | Interix          | GCC                     |
99 | X86             | kFreeBSD         | GCC                     |
100 | X86             | Linux            | GCC                     |
101 | X86             | Mac OSX          | GCC                     |
102 | X86             | OpenBSD          | GCC                     |
103 | X86             | OS/2             | GCC                     |
104 | X86             | Solaris          | GCC                     |
105 | X86             | Solaris          | Oracle Solaris Studio C |
106 | X86             | Windows/Cygwin   | GCC                     |
107 | X86             | Windows/MingW    | GCC                     |
108 | X86-64          | FreeBSD          | GCC                     |
109 | X86-64          | Linux            | GCC                     |
110 | X86-64          | Linux/x32        | GCC                     |
111 | X86-64          | OpenBSD          | GCC                     |
112 | X86-64          | Solaris          | Oracle Solaris Studio C |
113 | X86-64          | Windows/MingW    | GCC                     |
114 | Xtensa          | Linux            | GCC                     |
115 |-----------------+------------------+-------------------------|
116
117 Please send additional platform test results to
118 libffi-discuss@sourceware.org and feel free to update the wiki page
119 above.
120
121 Installing libffi
122 =================
123
124 First you must configure the distribution for your particular
125 system. Go to the directory you wish to build libffi in and run the
126 "configure" program found in the root directory of the libffi source
127 distribution.
128
129 If you're building libffi directly from version control, configure won't
130 exist yet; run ./autogen.sh first.
131
132 You may want to tell configure where to install the libffi library and
133 header files. To do that, use the --prefix configure switch.  Libffi
134 will install under /usr/local by default. 
135
136 If you want to enable extra run-time debugging checks use the the
137 --enable-debug configure switch. This is useful when your program dies
138 mysteriously while using libffi. 
139
140 Another useful configure switch is --enable-purify-safety. Using this
141 will add some extra code which will suppress certain warnings when you
142 are using Purify with libffi. Only use this switch when using 
143 Purify, as it will slow down the library.
144
145 It's also possible to build libffi on Windows platforms with
146 Microsoft's Visual C++ compiler.  In this case, use the msvcc.sh
147 wrapper script during configuration like so:
148
149 path/to/configure CC=path/to/msvcc.sh LD=link CPP=\"cl -nologo -EP\"
150
151 For 64-bit Windows builds, use CC="path/to/msvcc.sh -m64".
152 You may also need to specify --build appropriately. When building with MSVC
153 under a MingW environment, you may need to remove the line in configure
154 that sets 'fix_srcfile_path' to a 'cygpath' command. ('cygpath' is not
155 present in MingW, and is not required when using MingW-style paths.)
156
157 For iOS builds, the 'libffi.xcodeproj' Xcode project is available.
158
159 Configure has many other options. Use "configure --help" to see them all.
160
161 Once configure has finished, type "make". Note that you must be using
162 GNU make.  You can ftp GNU make from ftp.gnu.org:/pub/gnu/make .
163
164 To ensure that libffi is working as advertised, type "make check".
165 This will require that you have DejaGNU installed.
166
167 To install the library and header files, type "make install".
168
169
170 History
171 =======
172
173 See the git log for details.
174
175 3.1 TBD
176         Archive off the manually maintained ChangeLog in favor of git log.
177         Add AArch64 (ARM64) iOS support.
178         Add Nios II support.
179         Add m88k and DEC VAX support.
180         Add support for stdcall, thiscall, and fastcall on non-Windows 32-bit
181           x86 targets such as Linux.
182         Make the testsuite more robust: eliminated several spurious failures.
183         Android build fix.
184         Fix MIPS N32 ABI bug.
185         Various x86, FreeBSD and UltraSPARC IIi fixes.
186
187 3.0.13 Mar-17-13
188         Add Meta support.
189         Add missing Moxie bits.
190         Fix stack alignment bug on 32-bit x86.
191         Build fix for m68000 targets.
192         Build fix for soft-float Power targets.
193         Fix the install dir location for some platforms when building
194           with GCC (OS X, Solaris).
195         Fix Cygwin regression.
196
197 3.0.12 Feb-11-13
198         Add Moxie support.
199         Add AArch64 support.
200         Add Blackfin support.
201         Add TILE-Gx/TILEPro support.
202         Add MicroBlaze support.
203         Add Xtensa support.
204         Add support for PaX enabled kernels with MPROTECT.
205         Add support for native vendor compilers on
206           Solaris and AIX.
207         Work around LLVM/GCC interoperability issue on x86_64.
208
209 3.0.11 Apr-11-12
210         Lots of build fixes.
211         Add support for variadic functions (ffi_prep_cif_var).
212         Add Linux/x32 support.
213         Add thiscall, fastcall and MSVC cdecl support on Windows.
214         Add Amiga and newer MacOS support.
215         Add m68k FreeMiNT support.
216         Integration with iOS' xcode build tools.
217         Fix Octeon and MC68881 support.
218         Fix code pessimizations.
219
220 3.0.10 Aug-23-11
221         Add support for Apple's iOS.
222         Add support for ARM VFP ABI.
223         Add RTEMS support for MIPS and M68K.
224         Fix instruction cache clearing problems on
225           ARM and SPARC.
226         Fix the N64 build on mips-sgi-irix6.5.
227         Enable builds with Microsoft's compiler.
228         Enable x86 builds with Oracle's Solaris compiler.
229         Fix support for calling code compiled with Oracle's Sparc
230           Solaris compiler.
231         Testsuite fixes for Tru64 Unix.
232         Additional platform support.
233
234 3.0.9 Dec-31-09
235         Add AVR32 and win64 ports.  Add ARM softfp support.
236         Many fixes for AIX, Solaris, HP-UX, *BSD.
237         Several PowerPC and x86-64 bug fixes.
238         Build DLL for windows.
239
240 3.0.8 Dec-19-08
241         Add *BSD, BeOS, and PA-Linux support.
242
243 3.0.7 Nov-11-08
244         Fix for ppc FreeBSD.
245         (thanks to Andreas Tobler)
246
247 3.0.6 Jul-17-08
248         Fix for closures on sh.
249         Mark the sh/sh64 stack as non-executable.
250         (both thanks to Kaz Kojima)
251
252 3.0.5 Apr-3-08
253         Fix libffi.pc file.
254         Fix #define ARM for IcedTea users.
255         Fix x86 closure bug.
256
257 3.0.4 Feb-24-08
258         Fix x86 OpenBSD configury.
259
260 3.0.3 Feb-22-08
261         Enable x86 OpenBSD thanks to Thomas Heller, and
262         x86-64 FreeBSD thanks to Björn König and Andreas Tobler.
263         Clean up test instruction in README.
264
265 3.0.2 Feb-21-08
266         Improved x86 FreeBSD support.
267         Thanks to Björn König.
268
269 3.0.1 Feb-15-08
270         Fix instruction cache flushing bug on MIPS.
271         Thanks to David Daney.
272
273 3.0.0 Feb-15-08
274         Many changes, mostly thanks to the GCC project.
275         Cygnus Solutions is now Red Hat.
276
277   [10 years go by...]
278
279 1.20 Oct-5-98
280         Raffaele Sena produces ARM port.
281
282 1.19 Oct-5-98
283         Fixed x86 long double and long long return support.
284         m68k bug fixes from Andreas Schwab.
285         Patch for DU assembler compatibility for the Alpha from Richard
286         Henderson.
287
288 1.18 Apr-17-98
289         Bug fixes and MIPS configuration changes.
290
291 1.17 Feb-24-98
292         Bug fixes and m68k port from Andreas Schwab. PowerPC port from
293         Geoffrey Keating. Various bug x86, Sparc and MIPS bug fixes.
294
295 1.16 Feb-11-98
296         Richard Henderson produces Alpha port.
297
298 1.15 Dec-4-97
299         Fixed an n32 ABI bug. New libtool, auto* support.
300
301 1.14 May-13-97
302         libtool is now used to generate shared and static libraries.
303         Fixed a minor portability problem reported by Russ McManus
304         <mcmanr@eq.gs.com>.
305
306 1.13 Dec-2-96
307         Added --enable-purify-safety to keep Purify from complaining
308         about certain low level code.
309         Sparc fix for calling functions with < 6 args.
310         Linux x86 a.out fix.
311
312 1.12 Nov-22-96
313         Added missing ffi_type_void, needed for supporting void return 
314         types. Fixed test case for non MIPS machines. Cygnus Support 
315         is now Cygnus Solutions. 
316
317 1.11 Oct-30-96
318         Added notes about GNU make.
319
320 1.10 Oct-29-96
321         Added configuration fix for non GNU compilers.
322
323 1.09 Oct-29-96
324         Added --enable-debug configure switch. Clean-ups based on LCLint 
325         feedback. ffi_mips.h is always installed. Many configuration 
326         fixes. Fixed ffitest.c for sparc builds.
327
328 1.08 Oct-15-96
329         Fixed n32 problem. Many clean-ups.
330
331 1.07 Oct-14-96
332         Gordon Irlam rewrites v8.S again. Bug fixes.
333
334 1.06 Oct-14-96
335         Gordon Irlam improved the sparc port. 
336
337 1.05 Oct-14-96
338         Interface changes based on feedback.
339
340 1.04 Oct-11-96
341         Sparc port complete (modulo struct passing bug).
342
343 1.03 Oct-10-96
344         Passing struct args, and returning struct values works for
345         all architectures/calling conventions. Expanded tests.
346
347 1.02 Oct-9-96
348         Added SGI n32 support. Fixed bugs in both o32 and Linux support.
349         Added "make test".
350
351 1.01 Oct-8-96
352         Fixed float passing bug in mips version. Restructured some
353         of the code. Builds cleanly with SGI tools.
354
355 1.00 Oct-7-96
356         First release. No public announcement.
357
358
359 Authors & Credits
360 =================
361
362 libffi was originally written by Anthony Green <green@moxielogic.com>.
363
364 The developers of the GNU Compiler Collection project have made
365 innumerable valuable contributions.  See the ChangeLog file for
366 details.
367
368 Some of the ideas behind libffi were inspired by Gianni Mariani's free
369 gencall library for Silicon Graphics machines.
370
371 The closure mechanism was designed and implemented by Kresten Krab
372 Thorup.
373
374 Major processor architecture ports were contributed by the following
375 developers:
376
377 aarch64         Marcus Shawcroft, James Greenhalgh
378 alpha           Richard Henderson
379 arm             Raffaele Sena
380 blackfin        Alexandre Keunecke I. de Mendonca
381 cris            Simon Posnjak, Hans-Peter Nilsson
382 frv             Anthony Green
383 ia64            Hans Boehm
384 m32r            Kazuhiro Inaoka
385 m68k            Andreas Schwab
386 m88k            Miod Vallat
387 microblaze      Nathan Rossi
388 mips            Anthony Green, Casey Marshall
389 mips64          David Daney
390 moxie           Anthony Green
391 nios ii         Sandra Loosemore
392 pa              Randolph Chung, Dave Anglin, Andreas Tobler
393 powerpc         Geoffrey Keating, Andreas Tobler, 
394                          David Edelsohn, John Hornkvist
395 powerpc64       Jakub Jelinek
396 s390            Gerhard Tonn, Ulrich Weigand
397 sh              Kaz Kojima
398 sh64            Kaz Kojima
399 sparc           Anthony Green, Gordon Irlam
400 tile-gx/tilepro Walter Lee
401 vax             Miod Vallat
402 x86             Anthony Green, Jon Beniston
403 x86-64          Bo Thorsen
404 xtensa          Chris Zankel
405
406 Jesper Skov and Andrew Haley both did more than their fair share of
407 stepping through the code and tracking down bugs.
408
409 Thanks also to Tom Tromey for bug fixes, documentation and
410 configuration help.
411
412 Thanks to Jim Blandy, who provided some useful feedback on the libffi
413 interface.
414
415 Andreas Tobler has done a tremendous amount of work on the testsuite.
416
417 Alex Oliva solved the executable page problem for SElinux.
418
419 The list above is almost certainly incomplete and inaccurate.  I'm
420 happy to make corrections or additions upon request.
421
422 If you have a problem, or have found a bug, please send a note to the
423 author at green@moxielogic.com, or the project mailing list at
424 libffi-discuss@sourceware.org.