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