| /* -----------------------------------------------------------------*-C-*- |
| libffi @VERSION@ - Copyright (c) 1996-2002 Cygnus Solutions |
| |
| Permission is hereby granted, free of charge, to any person obtaining |
| a copy of this software and associated documentation files (the |
| ``Software''), to deal in the Software without restriction, including |
| without limitation the rights to use, copy, modify, merge, publish, |
| distribute, sublicense, and/or sell copies of the Software, and to |
| permit persons to whom the Software is furnished to do so, subject to |
| the following conditions: |
| |
| The above copyright notice and this permission notice shall be included |
| in all copies or substantial portions of the Software. |
| |
| THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| IN NO EVENT SHALL CYGNUS SOLUTIONS BE LIABLE FOR ANY CLAIM, DAMAGES OR |
| OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| OTHER DEALINGS IN THE SOFTWARE. |
| |
| ----------------------------------------------------------------------- */ |
| |
| /* ------------------------------------------------------------------- |
| The basic API is described in the README file. |
| |
| The raw API is designed to bypass some of the argument packing |
| and unpacking on architectures for which it can be avoided. |
| |
| The closure API allows interpreted functions to be packaged up |
| inside a C function pointer, so that they can be called as C functions, |
| with no understanding on the client side that they are interpreted. |
| It can also be used in other cases in which it is necessary to package |
| up a user specified parameter and a function pointer as a single |
| function pointer. |
| |
| The closure API must be implemented in order to get its functionality, |
| e.g. for use by gij. Routines are provided to emulate the raw API |
| if the underlying platform doesn't allow faster implementation. |
| |
| More details on the raw and cloure API can be found in: |
| |
| http://gcc.gnu.org/ml/java/1999-q3/msg00138.html |
| |
| and |
| |
| http://gcc.gnu.org/ml/java/1999-q3/msg00174.html |
| -------------------------------------------------------------------- */ |
| |
| #ifndef LIBFFI_H |
| #define LIBFFI_H |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /* Specify which architecture libffi is configured for. */ |
| #define @TARGET@ |
| |
| /* ---- System configuration information --------------------------------- */ |
| |
| #include <fficonfig.h> |
| |
| #if !defined(LIBFFI_ASM) |
| #include <stddef.h> |
| #if defined(FFI_DEBUG) |
| #include <stdio.h> |
| #endif |
| #endif |
| |
| /* ---- Generic type definitions ----------------------------------------- */ |
| |
| #define FLOAT32 float |
| #define FLOAT64 double |
| #define FLOAT80 long double |
| |
| #define UINT8 unsigned char |
| #define SINT8 signed char |
| |
| #if SIZEOF_INT == 2 |
| |
| #define UINT16 unsigned int |
| #define SINT16 int |
| #define ffi_type_uint ffi_type_uint16 |
| #define ffi_type_sint ffi_type_sint16 |
| |
| #else |
| #if SIZEOF_SHORT == 2 |
| |
| #define UINT16 unsigned short |
| #define SINT16 short |
| #define ffi_type_ushort ffi_type_uint16 |
| #define ffi_type_sshort ffi_type_sint16 |
| |
| #endif |
| #endif |
| |
| #if SIZEOF_INT == 4 |
| |
| #define UINT32 unsigned int |
| #define SINT32 int |
| #define ffi_type_uint ffi_type_uint32 |
| #define ffi_type_sint ffi_type_sint32 |
| |
| #else |
| #if SIZEOF_SHORT == 4 |
| |
| #define UINT32 unsigned short |
| #define SINT32 short |
| #define ffi_type_ushort ffi_type_uint32 |
| #define ffi_type_sshort ffi_type_sint32 |
| |
| #else |
| #if SIZEOF_LONG == 4 |
| |
| #define UINT32 unsigned long |
| #define SINT32 long |
| #define ffi_type_ulong ffi_type_uint32 |
| #define ffi_type_slong ffi_type_sint32 |
| |
| #endif |
| #endif |
| #endif |
| |
| #if SIZEOF_INT == 8 |
| |
| #define UINT64 unsigned int |
| #define SINT64 int |
| #define ffi_type_uint ffi_type_uint64 |
| #define ffi_type_sint ffi_type_sint64 |
| |
| #else |
| #if SIZEOF_LONG == 8 |
| |
| #define UINT64 unsigned long |
| #define SINT64 long |
| #define ffi_type_ulong ffi_type_uint64 |
| #define ffi_type_slong ffi_type_sint64 |
| |
| #else |
| #if SIZEOF_LONG_LONG == 8 |
| |
| #define UINT64 unsigned long long |
| #define SINT64 long long |
| #define ffi_type_ulong ffi_type_uint64 |
| #define ffi_type_slong ffi_type_sint64 |
| |
| #endif |
| #endif |
| #endif |
| |
| /* ---- System specific configurations ----------------------------------- */ |
| |
| #ifdef MIPS |
| #include <ffi_mips.h> |
| #else |
| #define SIZEOF_ARG SIZEOF_VOID_P |
| #endif |
| |
| #ifdef SPARC |
| #if defined(__arch64__) || defined(__sparcv9) |
| #define SPARC64 |
| #endif |
| #endif |
| |
| #ifndef LIBFFI_ASM |
| |
| /* ---- Generic type definitions ----------------------------------------- */ |
| |
| #define ALIGN(v, a) (((((size_t) (v))-1) | ((a)-1))+1) |
| /* The closure code assumes that this works on pointers, i.e. a size_t */ |
| /* can hold a pointer. */ |
| |
| typedef enum ffi_abi { |
| |
| /* Leave this for debugging purposes */ |
| FFI_FIRST_ABI = 0, |
| |
| /* ---- Sparc -------------------- */ |
| #ifdef SPARC |
| FFI_V8, |
| FFI_V8PLUS, |
| FFI_V9, |
| #ifdef SPARC64 |
| FFI_DEFAULT_ABI = FFI_V9, |
| #else |
| FFI_DEFAULT_ABI = FFI_V8, |
| #endif |
| #endif |
| |
| /* ---- Intel x86 ---------------- */ |
| #ifdef X86 |
| FFI_SYSV, |
| FFI_DEFAULT_ABI = FFI_SYSV, |
| #endif |
| |
| /* ---- Intel x86 Win32 ---------- */ |
| #ifdef X86_WIN32 |
| FFI_SYSV, |
| FFI_DEFAULT_ABI = FFI_SYSV, |
| #endif |
| |
| /* ---- Intel ia64 ---------------- */ |
| #ifdef IA64 |
| FFI_UNIX, /* Linux and all Unix variants use the same conventions */ |
| FFI_DEFAULT_ABI = FFI_UNIX, |
| #endif |
| |
| /* ---- Mips --------------------- */ |
| #ifdef MIPS |
| FFI_O32, |
| FFI_N32, |
| FFI_N64, |
| #endif |
| |
| /* ---- Alpha -------------------- */ |
| #ifdef ALPHA |
| FFI_OSF, |
| FFI_DEFAULT_ABI = FFI_OSF, |
| #endif |
| |
| /* ---- Motorola m68k ------------ */ |
| #ifdef M68K |
| FFI_SYSV, |
| FFI_DEFAULT_ABI = FFI_SYSV, |
| #endif |
| |
| /* ---- PowerPC ------------------ */ |
| #ifdef POWERPC |
| FFI_SYSV, |
| FFI_GCC_SYSV, |
| FFI_DEFAULT_ABI = FFI_GCC_SYSV, |
| #endif |
| |
| #ifdef POWERPC_AIX |
| FFI_AIX, |
| FFI_DARWIN, |
| FFI_DEFAULT_ABI = FFI_AIX, |
| #endif |
| |
| #ifdef POWERPC_DARWIN |
| FFI_AIX, |
| FFI_DARWIN, |
| FFI_DEFAULT_ABI = FFI_DARWIN, |
| #endif |
| |
| /* ---- ARM --------------------- */ |
| #ifdef ARM |
| FFI_SYSV, |
| FFI_DEFAULT_ABI = FFI_SYSV, |
| #endif |
| |
| /* Leave this for debugging purposes */ |
| FFI_LAST_ABI |
| |
| } ffi_abi; |
| |
| typedef struct _ffi_type |
| { |
| size_t size; |
| unsigned short alignment; |
| unsigned short type; |
| /*@null@*/ struct _ffi_type **elements; |
| } ffi_type; |
| |
| /* These are defined in ffi.c */ |
| extern ffi_type ffi_type_void; |
| extern ffi_type ffi_type_uint8; |
| extern ffi_type ffi_type_sint8; |
| extern ffi_type ffi_type_uint16; |
| extern ffi_type ffi_type_sint16; |
| extern ffi_type ffi_type_uint32; |
| extern ffi_type ffi_type_sint32; |
| extern ffi_type ffi_type_uint64; |
| extern ffi_type ffi_type_sint64; |
| extern ffi_type ffi_type_float; |
| extern ffi_type ffi_type_double; |
| extern ffi_type ffi_type_longdouble; |
| extern ffi_type ffi_type_pointer; |
| |
| /* Characters are 8 bit integral types */ |
| #define ffi_type_schar ffi_type_sint8 |
| #define ffi_type_uchar ffi_type_uint8 |
| |
| typedef enum { |
| FFI_OK = 0, |
| FFI_BAD_TYPEDEF, |
| FFI_BAD_ABI |
| } ffi_status; |
| |
| typedef unsigned FFI_TYPE; |
| |
| typedef struct { |
| ffi_abi abi; |
| unsigned nargs; |
| /*@dependent@*/ ffi_type **arg_types; |
| /*@dependent@*/ ffi_type *rtype; |
| unsigned bytes; |
| unsigned flags; |
| |
| #ifdef MIPS |
| #if _MIPS_SIM == _ABIN32 |
| unsigned rstruct_flag; |
| #endif |
| #endif |
| |
| } ffi_cif; |
| |
| #if SIZEOF_ARG == 4 |
| typedef UINT32 ffi_arg; |
| #else |
| #if SIZEOF_ARG == 8 |
| typedef UINT64 ffi_arg; |
| #else |
| -- unsupported configuration |
| #endif |
| #endif |
| |
| /* ---- Definitions for the raw API -------------------------------------- */ |
| |
| #if !FFI_NO_RAW_API |
| |
| #if SIZEOF_ARG == 4 |
| |
| #define UINT_ARG UINT32 |
| #define SINT_ARG SINT32 |
| |
| #endif |
| |
| #if SIZEOF_ARG == 8 |
| |
| #define UINT_ARG UINT64 |
| #define SINT_ARG SINT64 |
| |
| #endif |
| |
| typedef union { |
| SINT_ARG sint; |
| UINT_ARG uint; |
| float flt; |
| char data[SIZEOF_ARG]; |
| void* ptr; |
| } ffi_raw; |
| |
| void ffi_raw_call (/*@dependent@*/ ffi_cif *cif, |
| void (*fn)(), |
| /*@out@*/ void *rvalue, |
| /*@dependent@*/ ffi_raw *avalue); |
| |
| void ffi_ptrarray_to_raw (ffi_cif *cif, void **args, ffi_raw *raw); |
| void ffi_raw_to_ptrarray (ffi_cif *cif, ffi_raw *raw, void **args); |
| size_t ffi_raw_size (ffi_cif *cif); |
| |
| #if !NO_JAVA_RAW_API |
| |
| /* This is analogous to the raw API, except it uses Java parameter */ |
| /* packing, even on 64-bit machines. I.e. on 64-bit machines */ |
| /* longs and doubles are followed by an empty 64-bit word. */ |
| |
| void ffi_java_raw_call (/*@dependent@*/ ffi_cif *cif, |
| void (*fn)(), |
| /*@out@*/ void *rvalue, |
| /*@dependent@*/ ffi_raw *avalue); |
| |
| void ffi_java_ptrarray_to_raw (ffi_cif *cif, void **args, ffi_raw *raw); |
| void ffi_java_raw_to_ptrarray (ffi_cif *cif, ffi_raw *raw, void **args); |
| size_t ffi_java_raw_size (ffi_cif *cif); |
| |
| #endif /* !NO_JAVA_RAW_API */ |
| |
| #endif /* !FFI_NO_RAW_API */ |
| |
| /* ---- Definitions for closures ----------------------------------------- */ |
| |
| #ifdef X86 |
| |
| #define FFI_CLOSURES 1 /* x86 supports closures */ |
| #define FFI_TRAMPOLINE_SIZE 10 |
| #define FFI_NATIVE_RAW_API 1 /* and has native raw api support */ |
| |
| #elif defined(X86_WIN32) |
| |
| #define FFI_CLOSURES 1 /* x86 supports closures */ |
| #define FFI_TRAMPOLINE_SIZE 10 |
| #define FFI_NATIVE_RAW_API 1 /* and has native raw api support */ |
| |
| #elif defined(IA64) |
| |
| #define FFI_CLOSURES 1 |
| #define FFI_TRAMPOLINE_SIZE 24 /* Really the following struct, which */ |
| /* can be interpreted as a C function */ |
| /* decriptor: */ |
| |
| struct ffi_ia64_trampoline_struct { |
| void * code_pointer; /* Pointer to ffi_closure_UNIX */ |
| void * fake_gp; /* Pointer to closure, installed as gp */ |
| void * real_gp; /* Real gp value, reinstalled by */ |
| /* ffi_closure_UNIX. */ |
| }; |
| #define FFI_NATIVE_RAW_API 0 |
| |
| #elif defined(ALPHA) |
| |
| #define FFI_CLOSURES 1 |
| #define FFI_TRAMPOLINE_SIZE 24 |
| #define FFI_NATIVE_RAW_API 0 |
| |
| #elif defined(POWERPC) |
| |
| #define FFI_CLOSURES 1 |
| #define FFI_TRAMPOLINE_SIZE 40 |
| #define FFI_NATIVE_RAW_API 0 |
| |
| #elif defined(POWERPC_DARWIN) |
| |
| #define FFI_CLOSURES 1 |
| #define FFI_TRAMPOLINE_SIZE 40 |
| #define FFI_NATIVE_RAW_API 0 |
| |
| #elif defined(POWERPC_AIX) |
| |
| #define FFI_CLOSURES 1 |
| #define FFI_TRAMPOLINE_SIZE 24 /* see struct below */ |
| #define FFI_NATIVE_RAW_API 0 |
| |
| #else |
| |
| #define FFI_CLOSURES 0 |
| #define FFI_NATIVE_RAW_API 0 |
| |
| #endif |
| |
| #if defined(POWERPC_DARWIN) || defined(POWERPC_AIX) |
| |
| struct ffi_aix_trampoline_struct { |
| void * code_pointer; /* Pointer to ffi_closure_ASM */ |
| void * toc; /* TOC */ |
| void * static_chain; /* Pointer to closure */ |
| }; |
| |
| #endif |
| |
| |
| |
| #if FFI_CLOSURES |
| |
| typedef struct { |
| char tramp[FFI_TRAMPOLINE_SIZE]; |
| ffi_cif *cif; |
| void (*fun)(ffi_cif*,void*,void**,void*); |
| void *user_data; |
| } ffi_closure; |
| |
| ffi_status |
| ffi_prep_closure (ffi_closure*, |
| ffi_cif *, |
| void (*fun)(ffi_cif*,void*,void**,void*), |
| void *user_data); |
| |
| #if !FFI_NO_RAW_API |
| |
| typedef struct { |
| char tramp[FFI_TRAMPOLINE_SIZE]; |
| |
| ffi_cif *cif; |
| |
| #if !FFI_NATIVE_RAW_API |
| |
| /* if this is enabled, then a raw closure has the same layout |
| as a regular closure. We use this to install an intermediate |
| handler to do the transaltion, void** -> ffi_raw*. */ |
| |
| void (*translate_args)(ffi_cif*,void*,void**,void*); |
| void *this_closure; |
| |
| #endif |
| |
| void (*fun)(ffi_cif*,void*,ffi_raw*,void*); |
| void *user_data; |
| |
| } ffi_raw_closure; |
| |
| ffi_status |
| ffi_prep_raw_closure (ffi_raw_closure*, |
| ffi_cif *cif, |
| void (*fun)(ffi_cif*,void*,ffi_raw*,void*), |
| void *user_data); |
| |
| #ifndef NO_JAVA_RAW_API |
| ffi_status |
| ffi_prep_java_raw_closure (ffi_raw_closure*, |
| ffi_cif *cif, |
| void (*fun)(ffi_cif*,void*,ffi_raw*,void*), |
| void *user_data); |
| #endif |
| |
| #endif /* !FFI_NO_RAW_API */ |
| #endif /* FFI_CLOSURES */ |
| |
| /* ---- Public interface definition -------------------------------------- */ |
| |
| ffi_status ffi_prep_cif(/*@out@*/ /*@partial@*/ ffi_cif *cif, |
| ffi_abi abi, |
| unsigned int nargs, |
| /*@dependent@*/ /*@out@*/ /*@partial@*/ ffi_type *rtype, |
| /*@dependent@*/ ffi_type **atypes); |
| |
| void ffi_call(/*@dependent@*/ ffi_cif *cif, |
| void (*fn)(), |
| /*@out@*/ void *rvalue, |
| /*@dependent@*/ void **avalue); |
| |
| /* Useful for eliminating compiler warnings */ |
| #define FFI_FN(f) ((void (*)())f) |
| |
| /* ---- Definitions shared with assembly code ---------------------------- */ |
| |
| #endif |
| |
| #define FFI_TYPE_VOID 0 |
| #define FFI_TYPE_INT 1 |
| #define FFI_TYPE_FLOAT 2 |
| #define FFI_TYPE_DOUBLE 3 |
| #if SIZEOF_LONG_DOUBLE == SIZEOF_DOUBLE |
| #define FFI_TYPE_LONGDOUBLE FFI_TYPE_DOUBLE |
| #else |
| #define FFI_TYPE_LONGDOUBLE 4 |
| #endif |
| |
| #define FFI_TYPE_UINT8 5 /* If this changes, update ffi_mips.h. */ |
| #define FFI_TYPE_SINT8 6 /* If this changes, update ffi_mips.h. */ |
| #define FFI_TYPE_UINT16 7 |
| #define FFI_TYPE_SINT16 8 |
| #define FFI_TYPE_UINT32 9 |
| #define FFI_TYPE_SINT32 10 |
| #define FFI_TYPE_UINT64 11 |
| #define FFI_TYPE_SINT64 12 |
| #define FFI_TYPE_STRUCT 13 /* If this changes, update ffi_mips.h. */ |
| #define FFI_TYPE_POINTER 14 |
| |
| /* This should always refer to the last type code (for sanity checks) */ |
| #define FFI_TYPE_LAST FFI_TYPE_POINTER |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif |
| |