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