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