README

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