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