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