README

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