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