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