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