1 /* -----------------------------------------------------------------*-C-*-
2 libffi @VERSION@ - Copyright (c) 1996-2003, 2007 Red Hat, Inc.
4 Permission is hereby granted, free of charge, to any person obtaining
5 a copy of this software and associated documentation files (the
6 ``Software''), to deal in the Software without restriction, including
7 without limitation the rights to use, copy, modify, merge, publish,
8 distribute, sublicense, and/or sell copies of the Software, and to
9 permit persons to whom the Software is furnished to do so, subject to
10 the following conditions:
12 The above copyright notice and this permission notice shall be included
13 in all copies or substantial portions of the Software.
15 THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND, EXPRESS
16 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18 IN NO EVENT SHALL CYGNUS SOLUTIONS BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 OTHER DEALINGS IN THE SOFTWARE.
23 ----------------------------------------------------------------------- */
25 /* -------------------------------------------------------------------
26 The basic API is described in the README file.
28 The raw API is designed to bypass some of the argument packing
29 and unpacking on architectures for which it can be avoided.
31 The closure API allows interpreted functions to be packaged up
32 inside a C function pointer, so that they can be called as C functions,
33 with no understanding on the client side that they are interpreted.
34 It can also be used in other cases in which it is necessary to package
35 up a user specified parameter and a function pointer as a single
38 The closure API must be implemented in order to get its functionality,
39 e.g. for use by gij. Routines are provided to emulate the raw API
40 if the underlying platform doesn't allow faster implementation.
42 More details on the raw and cloure API can be found in:
44 http://gcc.gnu.org/ml/java/1999-q3/msg00138.html
48 http://gcc.gnu.org/ml/java/1999-q3/msg00174.html
49 -------------------------------------------------------------------- */
58 /* Specify which architecture libffi is configured for. */
61 /* ---- System configuration information --------------------------------- */
63 #include <ffitarget.h>
70 /* LONG_LONG_MAX is not always defined (not if STRICT_ANSI, for example).
71 But we can find it either under the correct ANSI name, or under GNU
74 # define FFI_LONG_LONG_MAX LONG_LONG_MAX
77 # define FFI_LONG_LONG_MAX LLONG_MAX
80 # define FFI_LONG_LONG_MAX __LONG_LONG_MAX__
85 /* The closure code assumes that this works on pointers, i.e. a size_t */
86 /* can hold a pointer. */
88 typedef struct _ffi_type
91 unsigned short alignment
;
93 struct _ffi_type
**elements
;
96 #ifndef LIBFFI_HIDE_BASIC_TYPES
98 # define ffi_type_uchar ffi_type_uint8
99 # define ffi_type_schar ffi_type_sint8
101 #error "char size not supported"
104 #if SHRT_MAX == 32767
105 # define ffi_type_ushort ffi_type_uint16
106 # define ffi_type_sshort ffi_type_sint16
107 #elif SHRT_MAX == 2147483647
108 # define ffi_type_ushort ffi_type_uint32
109 # define ffi_type_sshort ffi_type_sint32
111 #error "short size not supported"
115 # define ffi_type_uint ffi_type_uint16
116 # define ffi_type_sint ffi_type_sint16
117 #elif INT_MAX == 2147483647
118 # define ffi_type_uint ffi_type_uint32
119 # define ffi_type_sint ffi_type_sint32
120 #elif INT_MAX == 9223372036854775807
121 # define ffi_type_uint ffi_type_uint64
122 # define ffi_type_sint ffi_type_sint64
124 #error "int size not supported"
127 #if LONG_MAX == 2147483647
128 # if FFI_LONG_LONG_MAX != 9223372036854775807
129 #error "no 64-bit data type supported"
131 #elif LONG_MAX != 9223372036854775807
132 #error "long size not supported"
135 #if LONG_MAX == 2147483647
136 # define ffi_type_ulong ffi_type_uint32
137 # define ffi_type_slong ffi_type_sint32
138 #elif LONG_MAX == 9223372036854775807
139 # define ffi_type_ulong ffi_type_uint64
140 # define ffi_type_slong ffi_type_sint64
142 #error "long size not supported"
145 /* These are defined in types.c */
146 extern ffi_type ffi_type_void
;
147 extern ffi_type ffi_type_uint8
;
148 extern ffi_type ffi_type_sint8
;
149 extern ffi_type ffi_type_uint16
;
150 extern ffi_type ffi_type_sint16
;
151 extern ffi_type ffi_type_uint32
;
152 extern ffi_type ffi_type_sint32
;
153 extern ffi_type ffi_type_uint64
;
154 extern ffi_type ffi_type_sint64
;
155 extern ffi_type ffi_type_float
;
156 extern ffi_type ffi_type_double
;
157 extern ffi_type ffi_type_pointer
;
159 #if @HAVE_LONG_DOUBLE@
160 extern ffi_type ffi_type_longdouble
;
162 #define ffi_type_longdouble ffi_type_double
164 #endif /* LIBFFI_HIDE_BASIC_TYPES */
172 typedef unsigned FFI_TYPE
;
177 ffi_type
**arg_types
;
181 #ifdef FFI_EXTRA_CIF_FIELDS
182 FFI_EXTRA_CIF_FIELDS
;
186 /* ---- Definitions for the raw API -------------------------------------- */
188 #ifndef FFI_SIZEOF_ARG
189 # if LONG_MAX == 2147483647
190 # define FFI_SIZEOF_ARG 4
191 # elif LONG_MAX == 9223372036854775807
192 # define FFI_SIZEOF_ARG 8
196 #ifndef FFI_SIZEOF_JAVA_RAW
197 # define FFI_SIZEOF_JAVA_RAW FFI_SIZEOF_ARG
204 char data
[FFI_SIZEOF_ARG
];
208 #if FFI_SIZEOF_JAVA_RAW == 4 && FFI_SIZEOF_ARG == 8
209 /* This is a special case for mips64/n32 ABI (and perhaps others) where
210 sizeof(void *) is 4 and FFI_SIZEOF_ARG is 8. */
215 char data
[FFI_SIZEOF_JAVA_RAW
];
219 typedef ffi_raw ffi_java_raw
;
223 void ffi_raw_call (ffi_cif
*cif
,
228 void ffi_ptrarray_to_raw (ffi_cif
*cif
, void **args
, ffi_raw
*raw
);
229 void ffi_raw_to_ptrarray (ffi_cif
*cif
, ffi_raw
*raw
, void **args
);
230 size_t ffi_raw_size (ffi_cif
*cif
);
232 /* This is analogous to the raw API, except it uses Java parameter */
233 /* packing, even on 64-bit machines. I.e. on 64-bit machines */
234 /* longs and doubles are followed by an empty 64-bit word. */
236 void ffi_java_raw_call (ffi_cif
*cif
,
239 ffi_java_raw
*avalue
);
241 void ffi_java_ptrarray_to_raw (ffi_cif
*cif
, void **args
, ffi_java_raw
*raw
);
242 void ffi_java_raw_to_ptrarray (ffi_cif
*cif
, ffi_java_raw
*raw
, void **args
);
243 size_t ffi_java_raw_size (ffi_cif
*cif
);
245 /* ---- Definitions for closures ----------------------------------------- */
250 char tramp
[FFI_TRAMPOLINE_SIZE
];
252 void (*fun
)(ffi_cif
*,void*,void**,void*);
254 } ffi_closure
__attribute__((aligned (8)));
256 void *ffi_closure_alloc (size_t size
, void **code
);
257 void ffi_closure_free (void *);
260 ffi_prep_closure (ffi_closure
*,
262 void (*fun
)(ffi_cif
*,void*,void**,void*),
266 ffi_prep_closure_loc (ffi_closure
*,
268 void (*fun
)(ffi_cif
*,void*,void**,void*),
273 char tramp
[FFI_TRAMPOLINE_SIZE
];
277 #if !FFI_NATIVE_RAW_API
279 /* if this is enabled, then a raw closure has the same layout
280 as a regular closure. We use this to install an intermediate
281 handler to do the transaltion, void** -> ffi_raw*. */
283 void (*translate_args
)(ffi_cif
*,void*,void**,void*);
288 void (*fun
)(ffi_cif
*,void*,ffi_raw
*,void*);
294 char tramp
[FFI_TRAMPOLINE_SIZE
];
298 #if !FFI_NATIVE_RAW_API
300 /* if this is enabled, then a raw closure has the same layout
301 as a regular closure. We use this to install an intermediate
302 handler to do the transaltion, void** -> ffi_raw*. */
304 void (*translate_args
)(ffi_cif
*,void*,void**,void*);
309 void (*fun
)(ffi_cif
*,void*,ffi_java_raw
*,void*);
312 } ffi_java_raw_closure
;
315 ffi_prep_raw_closure (ffi_raw_closure
*,
317 void (*fun
)(ffi_cif
*,void*,ffi_raw
*,void*),
321 ffi_prep_raw_closure_loc (ffi_raw_closure
*,
323 void (*fun
)(ffi_cif
*,void*,ffi_raw
*,void*),
328 ffi_prep_java_raw_closure (ffi_java_raw_closure
*,
330 void (*fun
)(ffi_cif
*,void*,ffi_java_raw
*,void*),
334 ffi_prep_java_raw_closure_loc (ffi_java_raw_closure
*,
336 void (*fun
)(ffi_cif
*,void*,ffi_java_raw
*,void*),
340 #endif /* FFI_CLOSURES */
342 /* ---- Public interface definition -------------------------------------- */
344 ffi_status
ffi_prep_cif(ffi_cif
*cif
,
350 void ffi_call(ffi_cif
*cif
,
355 /* Useful for eliminating compiler warnings */
356 #define FFI_FN(f) ((void (*)())f)
358 /* ---- Definitions shared with assembly code ---------------------------- */
362 /* If these change, update src/mips/ffitarget.h. */
363 #define FFI_TYPE_VOID 0
364 #define FFI_TYPE_INT 1
365 #define FFI_TYPE_FLOAT 2
366 #define FFI_TYPE_DOUBLE 3
367 #if @HAVE_LONG_DOUBLE@
368 #define FFI_TYPE_LONGDOUBLE 4
370 #define FFI_TYPE_LONGDOUBLE FFI_TYPE_DOUBLE
372 #define FFI_TYPE_UINT8 5
373 #define FFI_TYPE_SINT8 6
374 #define FFI_TYPE_UINT16 7
375 #define FFI_TYPE_SINT16 8
376 #define FFI_TYPE_UINT32 9
377 #define FFI_TYPE_SINT32 10
378 #define FFI_TYPE_UINT64 11
379 #define FFI_TYPE_SINT64 12
380 #define FFI_TYPE_STRUCT 13
381 #define FFI_TYPE_POINTER 14
383 /* This should always refer to the last type code (for sanity checks) */
384 #define FFI_TYPE_LAST FFI_TYPE_POINTER