README

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