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