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