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