libffi/include/ffi.h.in

   1 /* -----------------------------------------------------------------*-C-*-
   2    libffi @VERSION@ - Copyright (c) 2011 Anthony Green
   3                     - Copyright (c) 1996-2003, 2007, 2008 Red Hat, Inc.
   4
   5    Permission is hereby granted, free of charge, to any person
   6    obtaining a copy of this software and associated documentation
   7    files (the ``Software''), to deal in the Software without
   8    restriction, including without limitation the rights to use, copy,
   9    modify, merge, publish, distribute, sublicense, and/or sell copies
  10    of the Software, and to permit persons to whom the Software is
  11    furnished to do so, subject to the following conditions:
  12
  13    The above copyright notice and this permission notice shall be
  14    included in all copies or substantial portions of the Software.
  15
  16    THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND,
  17    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19    NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  20    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  21    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23    DEALINGS IN THE SOFTWARE.
  24
  25    ----------------------------------------------------------------------- */
  26
  27 /* -------------------------------------------------------------------
  28    The basic API is described in the README file.
  29
  30    The raw API is designed to bypass some of the argument packing
  31    and unpacking on architectures for which it can be avoided.
  32
  33    The closure API allows interpreted functions to be packaged up
  34    inside a C function pointer, so that they can be called as C functions,
  35    with no understanding on the client side that they are interpreted.
  36    It can also be used in other cases in which it is necessary to package
  37    up a user specified parameter and a function pointer as a single
  38    function pointer.
  39
  40    The closure API must be implemented in order to get its functionality,
  41    e.g. for use by gij.  Routines are provided to emulate the raw API
  42    if the underlying platform doesn't allow faster implementation.
  43
  44    More details on the raw and cloure API can be found in:
  45
  46    http://gcc.gnu.org/ml/java/1999-q3/msg00138.html
  47
  48    and
  49
  50    http://gcc.gnu.org/ml/java/1999-q3/msg00174.html
  51    -------------------------------------------------------------------- */
  52
  53 #ifndef LIBFFI_H
  54 #define LIBFFI_H
  55
  56 #ifdef __cplusplus
  57 extern "C" {
  58 #endif
  59
  60 /* Specify which architecture libffi is configured for. */
  61 #ifndef @TARGET@
  62 #define @TARGET@
  63 #endif
  64
  65 /* ---- System configuration information --------------------------------- */
  66
  67 #include <ffitarget.h>
  68
  69 #ifndef LIBFFI_ASM
  70
  71 #ifdef _MSC_VER
  72 #define __attribute__(X)
  73 #endif
  74
  75 #include <stddef.h>
  76 #include <limits.h>
  77
  78 /* LONG_LONG_MAX is not always defined (not if STRICT_ANSI, for example).
  79    But we can find it either under the correct ANSI name, or under GNU
  80    C's internal name.  */
  81
  82 #define FFI_64_BIT_MAX 9223372036854775807
  83
  84 #ifdef LONG_LONG_MAX
  85 # define FFI_LONG_LONG_MAX LONG_LONG_MAX
  86 #else
  87 # ifdef LLONG_MAX
  88 #  define FFI_LONG_LONG_MAX LLONG_MAX
  89 #  ifdef _AIX52 /* or newer has C99 LLONG_MAX */
  90 #   undef FFI_64_BIT_MAX
  91 #   define FFI_64_BIT_MAX 9223372036854775807LL
  92 #  endif /* _AIX52 or newer */
  93 # else
  94 #  ifdef __GNUC__
  95 #   define FFI_LONG_LONG_MAX __LONG_LONG_MAX__
  96 #  endif
  97 #  ifdef _AIX /* AIX 5.1 and earlier have LONGLONG_MAX */
  98 #   ifndef __PPC64__
  99 #    if defined (__IBMC__) || defined (__IBMCPP__)
 100 #     define FFI_LONG_LONG_MAX LONGLONG_MAX
 101 #    endif
 102 #   endif /* __PPC64__ */
 103 #   undef  FFI_64_BIT_MAX
 104 #   define FFI_64_BIT_MAX 9223372036854775807LL
 105 #  endif
 106 # endif
 107 #endif
 108
 109 /* The closure code assumes that this works on pointers, i.e. a size_t  */
 110 /* can hold a pointer.                                                  */
 111
 112 typedef struct _ffi_type
 113 {
 114   size_t size;
 115   unsigned short alignment;
 116   unsigned short type;
 117   struct _ffi_type **elements;
 118 } ffi_type;
 119
 120 #ifndef LIBFFI_HIDE_BASIC_TYPES
 121 #if SCHAR_MAX == 127
 122 # define ffi_type_uchar                ffi_type_uint8
 123 # define ffi_type_schar                ffi_type_sint8
 124 #else
 125  #error "char size not supported"
 126 #endif
 127
 128 #if SHRT_MAX == 32767
 129 # define ffi_type_ushort       ffi_type_uint16
 130 # define ffi_type_sshort       ffi_type_sint16
 131 #elif SHRT_MAX == 2147483647
 132 # define ffi_type_ushort       ffi_type_uint32
 133 # define ffi_type_sshort       ffi_type_sint32
 134 #else
 135  #error "short size not supported"
 136 #endif
 137
 138 #if INT_MAX == 32767
 139 # define ffi_type_uint         ffi_type_uint16
 140 # define ffi_type_sint         ffi_type_sint16
 141 #elif INT_MAX == 2147483647
 142 # define ffi_type_uint         ffi_type_uint32
 143 # define ffi_type_sint         ffi_type_sint32
 144 #elif INT_MAX == 9223372036854775807
 145 # define ffi_type_uint         ffi_type_uint64
 146 # define ffi_type_sint         ffi_type_sint64
 147 #else
 148  #error "int size not supported"
 149 #endif
 150
 151 #if LONG_MAX == 2147483647
 152 # if FFI_LONG_LONG_MAX != FFI_64_BIT_MAX
 153  #error "no 64-bit data type supported"
 154 # endif
 155 #elif LONG_MAX != FFI_64_BIT_MAX
 156  #error "long size not supported"
 157 #endif
 158
 159 #if LONG_MAX == 2147483647
 160 # define ffi_type_ulong        ffi_type_uint32
 161 # define ffi_type_slong        ffi_type_sint32
 162 #elif LONG_MAX == FFI_64_BIT_MAX
 163 # define ffi_type_ulong        ffi_type_uint64
 164 # define ffi_type_slong        ffi_type_sint64
 165 #else
 166  #error "long size not supported"
 167 #endif
 168
 169 /* These are defined in types.c */
 170 extern ffi_type ffi_type_void;
 171 extern ffi_type ffi_type_uint8;
 172 extern ffi_type ffi_type_sint8;
 173 extern ffi_type ffi_type_uint16;
 174 extern ffi_type ffi_type_sint16;
 175 extern ffi_type ffi_type_uint32;
 176 extern ffi_type ffi_type_sint32;
 177 extern ffi_type ffi_type_uint64;
 178 extern ffi_type ffi_type_sint64;
 179 extern ffi_type ffi_type_float;
 180 extern ffi_type ffi_type_double;
 181 extern ffi_type ffi_type_pointer;
 182
 183 #if @HAVE_LONG_DOUBLE@
 184 extern ffi_type ffi_type_longdouble;
 185 #else
 186 #define ffi_type_longdouble ffi_type_double
 187 #endif
 188 #endif /* LIBFFI_HIDE_BASIC_TYPES */
 189
 190 typedef enum {
 191   FFI_OK = 0,
 192   FFI_BAD_TYPEDEF,
 193   FFI_BAD_ABI
 194 } ffi_status;
 195
 196 typedef unsigned FFI_TYPE;
 197
 198 typedef struct {
 199   ffi_abi abi;
 200   unsigned nargs;
 201   ffi_type **arg_types;
 202   ffi_type *rtype;
 203   unsigned bytes;
 204   unsigned flags;
 205 #ifdef FFI_EXTRA_CIF_FIELDS
 206   FFI_EXTRA_CIF_FIELDS;
 207 #endif
 208 } ffi_cif;
 209
 210 #if HAVE_LONG_DOUBLE_VARIANT
 211 /* Used to adjust size/alignment of ffi types.  */
 212 void ffi_prep_types (ffi_abi abi);
 213 # endif
 214
 215 /* Used internally, but overridden by some architectures */
 216 ffi_status ffi_prep_cif_core(ffi_cif *cif,
 217                              ffi_abi abi,
 218                              unsigned int isvariadic,
 219                              unsigned int nfixedargs,
 220                              unsigned int ntotalargs,
 221                              ffi_type *rtype,
 222                              ffi_type **atypes);
 223
 224 /* ---- Definitions for the raw API -------------------------------------- */
 225
 226 #ifndef FFI_SIZEOF_ARG
 227 # if LONG_MAX == 2147483647
 228 #  define FFI_SIZEOF_ARG        4
 229 # elif LONG_MAX == FFI_64_BIT_MAX
 230 #  define FFI_SIZEOF_ARG        8
 231 # endif
 232 #endif
 233
 234 #ifndef FFI_SIZEOF_JAVA_RAW
 235 #  define FFI_SIZEOF_JAVA_RAW FFI_SIZEOF_ARG
 236 #endif
 237
 238 typedef union {
 239   ffi_sarg  sint;
 240   ffi_arg   uint;
 241   float     flt;
 242   char      data[FFI_SIZEOF_ARG];
 243   void*     ptr;
 244 } ffi_raw;
 245
 246 #if FFI_SIZEOF_JAVA_RAW == 4 && FFI_SIZEOF_ARG == 8
 247 /* This is a special case for mips64/n32 ABI (and perhaps others) where
 248    sizeof(void *) is 4 and FFI_SIZEOF_ARG is 8.  */
 249 typedef union {
 250   signed int    sint;
 251   unsigned int  uint;
 252   float         flt;
 253   char          data[FFI_SIZEOF_JAVA_RAW];
 254   void*         ptr;
 255 } ffi_java_raw;
 256 #else
 257 typedef ffi_raw ffi_java_raw;
 258 #endif
 259
 260
 261 void ffi_raw_call (ffi_cif *cif,
 262                    void (*fn)(void),
 263                    void *rvalue,
 264                    ffi_raw *avalue);
 265
 266 void ffi_ptrarray_to_raw (ffi_cif *cif, void **args, ffi_raw *raw);
 267 void ffi_raw_to_ptrarray (ffi_cif *cif, ffi_raw *raw, void **args);
 268 size_t ffi_raw_size (ffi_cif *cif);
 269
 270 /* This is analogous to the raw API, except it uses Java parameter      */
 271 /* packing, even on 64-bit machines.  I.e. on 64-bit machines           */
 272 /* longs and doubles are followed by an empty 64-bit word.              */
 273
 274 void ffi_java_raw_call (ffi_cif *cif,
 275                         void (*fn)(void),
 276                         void *rvalue,
 277                         ffi_java_raw *avalue);
 278
 279 void ffi_java_ptrarray_to_raw (ffi_cif *cif, void **args, ffi_java_raw *raw);
 280 void ffi_java_raw_to_ptrarray (ffi_cif *cif, ffi_java_raw *raw, void **args);
 281 size_t ffi_java_raw_size (ffi_cif *cif);
 282
 283 /* ---- Definitions for closures ----------------------------------------- */
 284
 285 #if FFI_CLOSURES
 286
 287 #ifdef _MSC_VER
 288 __declspec(align(8))
 289 #endif
 290 typedef struct {
 291   char tramp[FFI_TRAMPOLINE_SIZE];
 292   ffi_cif   *cif;
 293   void     (*fun)(ffi_cif*,void*,void**,void*);
 294   void      *user_data;
 295 #ifdef __GNUC__
 296 } ffi_closure __attribute__((aligned (8)));
 297 #else
 298 } ffi_closure;
 299 # ifdef __sgi
 300 #  pragma pack 0
 301 # endif
 302 #endif
 303
 304 void *ffi_closure_alloc (size_t size, void **code);
 305 void ffi_closure_free (void *);
 306
 307 ffi_status
 308 ffi_prep_closure (ffi_closure*,
 309                   ffi_cif *,
 310                   void (*fun)(ffi_cif*,void*,void**,void*),
 311                   void *user_data);
 312
 313 ffi_status
 314 ffi_prep_closure_loc (ffi_closure*,
 315                       ffi_cif *,
 316                       void (*fun)(ffi_cif*,void*,void**,void*),
 317                       void *user_data,
 318                       void*codeloc);
 319
 320 #ifdef __sgi
 321 # pragma pack 8
 322 #endif
 323 typedef struct {
 324   char tramp[FFI_TRAMPOLINE_SIZE];
 325
 326   ffi_cif   *cif;
 327
 328 #if !FFI_NATIVE_RAW_API
 329
 330   /* if this is enabled, then a raw closure has the same layout
 331      as a regular closure.  We use this to install an intermediate
 332      handler to do the transaltion, void** -> ffi_raw*. */
 333
 334   void     (*translate_args)(ffi_cif*,void*,void**,void*);
 335   void      *this_closure;
 336
 337 #endif
 338
 339   void     (*fun)(ffi_cif*,void*,ffi_raw*,void*);
 340   void      *user_data;
 341
 342 } ffi_raw_closure;
 343
 344 typedef struct {
 345   char tramp[FFI_TRAMPOLINE_SIZE];
 346
 347   ffi_cif   *cif;
 348
 349 #if !FFI_NATIVE_RAW_API
 350
 351   /* if this is enabled, then a raw closure has the same layout
 352      as a regular closure.  We use this to install an intermediate
 353      handler to do the transaltion, void** -> ffi_raw*. */
 354
 355   void     (*translate_args)(ffi_cif*,void*,void**,void*);
 356   void      *this_closure;
 357
 358 #endif
 359
 360   void     (*fun)(ffi_cif*,void*,ffi_java_raw*,void*);
 361   void      *user_data;
 362
 363 } ffi_java_raw_closure;
 364
 365 ffi_status
 366 ffi_prep_raw_closure (ffi_raw_closure*,
 367                       ffi_cif *cif,
 368                       void (*fun)(ffi_cif*,void*,ffi_raw*,void*),
 369                       void *user_data);
 370
 371 ffi_status
 372 ffi_prep_raw_closure_loc (ffi_raw_closure*,
 373                           ffi_cif *cif,
 374                           void (*fun)(ffi_cif*,void*,ffi_raw*,void*),
 375                           void *user_data,
 376                           void *codeloc);
 377
 378 ffi_status
 379 ffi_prep_java_raw_closure (ffi_java_raw_closure*,
 380                            ffi_cif *cif,
 381                            void (*fun)(ffi_cif*,void*,ffi_java_raw*,void*),
 382                            void *user_data);
 383
 384 ffi_status
 385 ffi_prep_java_raw_closure_loc (ffi_java_raw_closure*,
 386                                ffi_cif *cif,
 387                                void (*fun)(ffi_cif*,void*,ffi_java_raw*,void*),
 388                                void *user_data,
 389                                void *codeloc);
 390
 391 #endif /* FFI_CLOSURES */
 392
 393 /* ---- Public interface definition -------------------------------------- */
 394
 395 ffi_status ffi_prep_cif(ffi_cif *cif,
 396                         ffi_abi abi,
 397                         unsigned int nargs,
 398                         ffi_type *rtype,
 399                         ffi_type **atypes);
 400
 401 ffi_status ffi_prep_cif_var(ffi_cif *cif,
 402                             ffi_abi abi,
 403                             unsigned int nfixedargs,
 404                             unsigned int ntotalargs,
 405                             ffi_type *rtype,
 406                             ffi_type **atypes);
 407
 408 void ffi_call(ffi_cif *cif,
 409               void (*fn)(void),
 410               void *rvalue,
 411               void **avalue);
 412
 413 /* Useful for eliminating compiler warnings */
 414 #define FFI_FN(f) ((void (*)(void))f)
 415
 416 /* ---- Definitions shared with assembly code ---------------------------- */
 417
 418 #endif
 419
 420 /* If these change, update src/mips/ffitarget.h. */
 421 #define FFI_TYPE_VOID       0
 422 #define FFI_TYPE_INT        1
 423 #define FFI_TYPE_FLOAT      2
 424 #define FFI_TYPE_DOUBLE     3
 425 #if @HAVE_LONG_DOUBLE@
 426 #define FFI_TYPE_LONGDOUBLE 4
 427 #else
 428 #define FFI_TYPE_LONGDOUBLE FFI_TYPE_DOUBLE
 429 #endif
 430 #define FFI_TYPE_UINT8      5
 431 #define FFI_TYPE_SINT8      6
 432 #define FFI_TYPE_UINT16     7
 433 #define FFI_TYPE_SINT16     8
 434 #define FFI_TYPE_UINT32     9
 435 #define FFI_TYPE_SINT32     10
 436 #define FFI_TYPE_UINT64     11
 437 #define FFI_TYPE_SINT64     12
 438 #define FFI_TYPE_STRUCT     13
 439 #define FFI_TYPE_POINTER    14
 440
 441 /* This should always refer to the last type code (for sanity checks) */
 442 #define FFI_TYPE_LAST       FFI_TYPE_POINTER
 443
 444 #ifdef __cplusplus
 445 }
 446 #endif
 447
 448 #endif