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