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