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