README

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