The Ecere SDK - sdk/blob - deps/libffi-3.0.11/i686-pc-mingw32/include/ffi.h

   1 /* -----------------------------------------------------------------*-C-*-
   2    libffi 3.0.11 - 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 #if defined(__MINGW32__)
  62 #if defined(__x86_64__)
  63
  64 #ifndef X86_WIN64
  65 #define X86_WIN64
  66 #endif
  67
  68 #else
  69
  70 #ifndef X86_WIN32
  71 #define X86_WIN32
  72 #endif
  73
  74 #endif
  75 #endif
  76
  77 /* ---- System configuration information --------------------------------- */
  78
  79 #include <ffitarget.h>
  80
  81 #ifndef LIBFFI_ASM
  82
  83 #ifdef _MSC_VER
  84 #define __attribute__(X)
  85 #endif
  86
  87 #include <stddef.h>
  88 #include <limits.h>
  89
  90 /* LONG_LONG_MAX is not always defined (not if STRICT_ANSI, for example).
  91    But we can find it either under the correct ANSI name, or under GNU
  92    C's internal name.  */
  93
  94 #define FFI_64_BIT_MAX 9223372036854775807
  95
  96 #ifdef LONG_LONG_MAX
  97 # define FFI_LONG_LONG_MAX LONG_LONG_MAX
  98 #else
  99 # ifdef LLONG_MAX
 100 #  define FFI_LONG_LONG_MAX LLONG_MAX
 101 #  ifdef _AIX52 /* or newer has C99 LLONG_MAX */
 102 #   undef FFI_64_BIT_MAX
 103 #   define FFI_64_BIT_MAX 9223372036854775807LL
 104 #  endif /* _AIX52 or newer */
 105 # else
 106 #  ifdef __GNUC__
 107 #   define FFI_LONG_LONG_MAX __LONG_LONG_MAX__
 108 #  endif
 109 #  ifdef _AIX /* AIX 5.1 and earlier have LONGLONG_MAX */
 110 #   ifndef __PPC64__
 111 #    if defined (__IBMC__) || defined (__IBMCPP__)
 112 #     define FFI_LONG_LONG_MAX LONGLONG_MAX
 113 #    endif
 114 #   endif /* __PPC64__ */
 115 #   undef  FFI_64_BIT_MAX
 116 #   define FFI_64_BIT_MAX 9223372036854775807LL
 117 #  endif
 118 # endif
 119 #endif
 120
 121 /* The closure code assumes that this works on pointers, i.e. a size_t  */
 122 /* can hold a pointer.                                                  */
 123
 124 typedef struct _ffi_type
 125 {
 126   size_t size;
 127   unsigned short alignment;
 128   unsigned short type;
 129   struct _ffi_type **elements;
 130 } ffi_type;
 131
 132 #ifndef LIBFFI_HIDE_BASIC_TYPES
 133 #if SCHAR_MAX == 127
 134 # define ffi_type_uchar                ffi_type_uint8
 135 # define ffi_type_schar                ffi_type_sint8
 136 #else
 137  #error "char size not supported"
 138 #endif
 139
 140 #if SHRT_MAX == 32767
 141 # define ffi_type_ushort       ffi_type_uint16
 142 # define ffi_type_sshort       ffi_type_sint16
 143 #elif SHRT_MAX == 2147483647
 144 # define ffi_type_ushort       ffi_type_uint32
 145 # define ffi_type_sshort       ffi_type_sint32
 146 #else
 147  #error "short size not supported"
 148 #endif
 149
 150 #if INT_MAX == 32767
 151 # define ffi_type_uint         ffi_type_uint16
 152 # define ffi_type_sint         ffi_type_sint16
 153 #elif INT_MAX == 2147483647
 154 # define ffi_type_uint         ffi_type_uint32
 155 # define ffi_type_sint         ffi_type_sint32
 156 #elif INT_MAX == 9223372036854775807
 157 # define ffi_type_uint         ffi_type_uint64
 158 # define ffi_type_sint         ffi_type_sint64
 159 #else
 160  #error "int size not supported"
 161 #endif
 162
 163 #if LONG_MAX == 2147483647
 164 # if FFI_LONG_LONG_MAX != FFI_64_BIT_MAX
 165  #error "no 64-bit data type supported"
 166 # endif
 167 #elif LONG_MAX != FFI_64_BIT_MAX
 168  #error "long size not supported"
 169 #endif
 170
 171 #if LONG_MAX == 2147483647
 172 # define ffi_type_ulong        ffi_type_uint32
 173 # define ffi_type_slong        ffi_type_sint32
 174 #elif LONG_MAX == FFI_64_BIT_MAX
 175 # define ffi_type_ulong        ffi_type_uint64
 176 # define ffi_type_slong        ffi_type_sint64
 177 #else
 178  #error "long size not supported"
 179 #endif
 180
 181 /* Need minimal decorations for DLLs to works on Windows. */
 182 /* GCC has autoimport and autoexport.  Rely on Libtool to */
 183 /* help MSVC export from a DLL, but always declare data   */
 184 /* to be imported for MSVC clients.  This costs an extra  */
 185 /* indirection for MSVC clients using the static version  */
 186 /* of the library, but don't worry about that.  Besides,  */
 187 /* as a workaround, they can define FFI_BUILDING if they  */
 188 /* *know* they are going to link with the static library. */
 189 #if defined _MSC_VER && !defined FFI_BUILDING
 190 #define FFI_EXTERN extern __declspec(dllimport)
 191 #else
 192 #define FFI_EXTERN extern
 193 #endif
 194
 195 /* These are defined in types.c */
 196 FFI_EXTERN ffi_type ffi_type_void;
 197 FFI_EXTERN ffi_type ffi_type_uint8;
 198 FFI_EXTERN ffi_type ffi_type_sint8;
 199 FFI_EXTERN ffi_type ffi_type_uint16;
 200 FFI_EXTERN ffi_type ffi_type_sint16;
 201 FFI_EXTERN ffi_type ffi_type_uint32;
 202 FFI_EXTERN ffi_type ffi_type_sint32;
 203 FFI_EXTERN ffi_type ffi_type_uint64;
 204 FFI_EXTERN ffi_type ffi_type_sint64;
 205 FFI_EXTERN ffi_type ffi_type_float;
 206 FFI_EXTERN ffi_type ffi_type_double;
 207 FFI_EXTERN ffi_type ffi_type_pointer;
 208
 209 #if 1
 210 FFI_EXTERN ffi_type ffi_type_longdouble;
 211 #else
 212 #define ffi_type_longdouble ffi_type_double
 213 #endif
 214 #endif /* LIBFFI_HIDE_BASIC_TYPES */
 215
 216 typedef enum {
 217   FFI_OK = 0,
 218   FFI_BAD_TYPEDEF,
 219   FFI_BAD_ABI
 220 } ffi_status;
 221
 222 typedef unsigned FFI_TYPE;
 223
 224 typedef struct {
 225   ffi_abi abi;
 226   unsigned nargs;
 227   ffi_type **arg_types;
 228   ffi_type *rtype;
 229   unsigned bytes;
 230   unsigned flags;
 231 #ifdef FFI_EXTRA_CIF_FIELDS
 232   FFI_EXTRA_CIF_FIELDS;
 233 #endif
 234 } ffi_cif;
 235
 236 /* Used internally, but overridden by some architectures */
 237 ffi_status ffi_prep_cif_core(ffi_cif *cif,
 238                              ffi_abi abi,
 239                              unsigned int isvariadic,
 240                              unsigned int nfixedargs,
 241                              unsigned int ntotalargs,
 242                              ffi_type *rtype,
 243                              ffi_type **atypes);
 244
 245 /* ---- Definitions for the raw API -------------------------------------- */
 246
 247 #ifndef FFI_SIZEOF_ARG
 248 # if LONG_MAX == 2147483647
 249 #  define FFI_SIZEOF_ARG        4
 250 # elif LONG_MAX == FFI_64_BIT_MAX
 251 #  define FFI_SIZEOF_ARG        8
 252 # endif
 253 #endif
 254
 255 #ifndef FFI_SIZEOF_JAVA_RAW
 256 #  define FFI_SIZEOF_JAVA_RAW FFI_SIZEOF_ARG
 257 #endif
 258
 259 typedef union {
 260   ffi_sarg  sint;
 261   ffi_arg   uint;
 262   float     flt;
 263   char      data[FFI_SIZEOF_ARG];
 264   void*     ptr;
 265 } ffi_raw;
 266
 267 #if FFI_SIZEOF_JAVA_RAW == 4 && FFI_SIZEOF_ARG == 8
 268 /* This is a special case for mips64/n32 ABI (and perhaps others) where
 269    sizeof(void *) is 4 and FFI_SIZEOF_ARG is 8.  */
 270 typedef union {
 271   signed int    sint;
 272   unsigned int  uint;
 273   float         flt;
 274   char          data[FFI_SIZEOF_JAVA_RAW];
 275   void*         ptr;
 276 } ffi_java_raw;
 277 #else
 278 typedef ffi_raw ffi_java_raw;
 279 #endif
 280
 281
 282 void ffi_raw_call (ffi_cif *cif,
 283                    void (*fn)(void),
 284                    void *rvalue,
 285                    ffi_raw *avalue);
 286
 287 void ffi_ptrarray_to_raw (ffi_cif *cif, void **args, ffi_raw *raw);
 288 void ffi_raw_to_ptrarray (ffi_cif *cif, ffi_raw *raw, void **args);
 289 size_t ffi_raw_size (ffi_cif *cif);
 290
 291 /* This is analogous to the raw API, except it uses Java parameter      */
 292 /* packing, even on 64-bit machines.  I.e. on 64-bit machines           */
 293 /* longs and doubles are followed by an empty 64-bit word.              */
 294
 295 void ffi_java_raw_call (ffi_cif *cif,
 296                         void (*fn)(void),
 297                         void *rvalue,
 298                         ffi_java_raw *avalue);
 299
 300 void ffi_java_ptrarray_to_raw (ffi_cif *cif, void **args, ffi_java_raw *raw);
 301 void ffi_java_raw_to_ptrarray (ffi_cif *cif, ffi_java_raw *raw, void **args);
 302 size_t ffi_java_raw_size (ffi_cif *cif);
 303
 304 /* ---- Definitions for closures ----------------------------------------- */
 305
 306 #if FFI_CLOSURES
 307
 308 #ifdef _MSC_VER
 309 __declspec(align(8))
 310 #endif
 311 typedef struct {
 312 #if 0
 313   void *trampoline_table;
 314   void *trampoline_table_entry;
 315 #else
 316   char tramp[FFI_TRAMPOLINE_SIZE];
 317 #endif
 318   ffi_cif   *cif;
 319   void     (*fun)(ffi_cif*,void*,void**,void*);
 320   void      *user_data;
 321 #ifdef __GNUC__
 322 } ffi_closure __attribute__((aligned (8)));
 323 #else
 324 } ffi_closure;
 325 # ifdef __sgi
 326 #  pragma pack 0
 327 # endif
 328 #endif
 329
 330 void *ffi_closure_alloc (size_t size, void **code);
 331 void ffi_closure_free (void *);
 332
 333 ffi_status
 334 ffi_prep_closure (ffi_closure*,
 335                   ffi_cif *,
 336                   void (*fun)(ffi_cif*,void*,void**,void*),
 337                   void *user_data);
 338
 339 ffi_status
 340 ffi_prep_closure_loc (ffi_closure*,
 341                       ffi_cif *,
 342                       void (*fun)(ffi_cif*,void*,void**,void*),
 343                       void *user_data,
 344                       void*codeloc);
 345
 346 #ifdef __sgi
 347 # pragma pack 8
 348 #endif
 349 typedef struct {
 350 #if 0
 351   void *trampoline_table;
 352   void *trampoline_table_entry;
 353 #else
 354   char tramp[FFI_TRAMPOLINE_SIZE];
 355 #endif
 356   ffi_cif   *cif;
 357
 358 #if !FFI_NATIVE_RAW_API
 359
 360   /* if this is enabled, then a raw closure has the same layout
 361      as a regular closure.  We use this to install an intermediate
 362      handler to do the transaltion, void** -> ffi_raw*. */
 363
 364   void     (*translate_args)(ffi_cif*,void*,void**,void*);
 365   void      *this_closure;
 366
 367 #endif
 368
 369   void     (*fun)(ffi_cif*,void*,ffi_raw*,void*);
 370   void      *user_data;
 371
 372 } ffi_raw_closure;
 373
 374 typedef struct {
 375 #if 0
 376   void *trampoline_table;
 377   void *trampoline_table_entry;
 378 #else
 379   char tramp[FFI_TRAMPOLINE_SIZE];
 380 #endif
 381
 382   ffi_cif   *cif;
 383
 384 #if !FFI_NATIVE_RAW_API
 385
 386   /* if this is enabled, then a raw closure has the same layout
 387      as a regular closure.  We use this to install an intermediate
 388      handler to do the transaltion, void** -> ffi_raw*. */
 389
 390   void     (*translate_args)(ffi_cif*,void*,void**,void*);
 391   void      *this_closure;
 392
 393 #endif
 394
 395   void     (*fun)(ffi_cif*,void*,ffi_java_raw*,void*);
 396   void      *user_data;
 397
 398 } ffi_java_raw_closure;
 399
 400 ffi_status
 401 ffi_prep_raw_closure (ffi_raw_closure*,
 402                       ffi_cif *cif,
 403                       void (*fun)(ffi_cif*,void*,ffi_raw*,void*),
 404                       void *user_data);
 405
 406 ffi_status
 407 ffi_prep_raw_closure_loc (ffi_raw_closure*,
 408                           ffi_cif *cif,
 409                           void (*fun)(ffi_cif*,void*,ffi_raw*,void*),
 410                           void *user_data,
 411                           void *codeloc);
 412
 413 ffi_status
 414 ffi_prep_java_raw_closure (ffi_java_raw_closure*,
 415                            ffi_cif *cif,
 416                            void (*fun)(ffi_cif*,void*,ffi_java_raw*,void*),
 417                            void *user_data);
 418
 419 ffi_status
 420 ffi_prep_java_raw_closure_loc (ffi_java_raw_closure*,
 421                                ffi_cif *cif,
 422                                void (*fun)(ffi_cif*,void*,ffi_java_raw*,void*),
 423                                void *user_data,
 424                                void *codeloc);
 425
 426 #endif /* FFI_CLOSURES */
 427
 428 /* ---- Public interface definition -------------------------------------- */
 429
 430 ffi_status ffi_prep_cif(ffi_cif *cif,
 431                         ffi_abi abi,
 432                         unsigned int nargs,
 433                         ffi_type *rtype,
 434                         ffi_type **atypes);
 435
 436 ffi_status ffi_prep_cif_var(ffi_cif *cif,
 437                             ffi_abi abi,
 438                             unsigned int nfixedargs,
 439                             unsigned int ntotalargs,
 440                             ffi_type *rtype,
 441                             ffi_type **atypes);
 442
 443 void ffi_call(ffi_cif *cif,
 444               void (*fn)(void),
 445               void *rvalue,
 446               void **avalue);
 447
 448 /* Useful for eliminating compiler warnings */
 449 #define FFI_FN(f) ((void (*)(void))f)
 450
 451 /* ---- Definitions shared with assembly code ---------------------------- */
 452
 453 #endif
 454
 455 /* If these change, update src/mips/ffitarget.h. */
 456 #define FFI_TYPE_VOID       0
 457 #define FFI_TYPE_INT        1
 458 #define FFI_TYPE_FLOAT      2
 459 #define FFI_TYPE_DOUBLE     3
 460 #if 1
 461 #define FFI_TYPE_LONGDOUBLE 4
 462 #else
 463 #define FFI_TYPE_LONGDOUBLE FFI_TYPE_DOUBLE
 464 #endif
 465 #define FFI_TYPE_UINT8      5
 466 #define FFI_TYPE_SINT8      6
 467 #define FFI_TYPE_UINT16     7
 468 #define FFI_TYPE_SINT16     8
 469 #define FFI_TYPE_UINT32     9
 470 #define FFI_TYPE_SINT32     10
 471 #define FFI_TYPE_UINT64     11
 472 #define FFI_TYPE_SINT64     12
 473 #define FFI_TYPE_STRUCT     13
 474 #define FFI_TYPE_POINTER    14
 475
 476 /* This should always refer to the last type code (for sanity checks) */
 477 #define FFI_TYPE_LAST       FFI_TYPE_POINTER
 478
 479 #ifdef __cplusplus
 480 }
 481 #endif
 482
 483 #endif