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