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