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