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