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