js/src/ctypes/libffi/README

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