Update README with a new port
[libffi.git] / include / ffi.h.in
1 /* -----------------------------------------------------------------*-C-*-
2 libffi @VERSION@ - Copyright (c) 2011, 2014 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 #if defined(_MSC_VER) && !defined(__clang__)
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 /* Need minimal decorations for DLLs to works on Windows. */
170 /* GCC has autoimport and autoexport. Rely on Libtool to */
171 /* help MSVC export from a DLL, but always declare data */
172 /* to be imported for MSVC clients. This costs an extra */
173 /* indirection for MSVC clients using the static version */
174 /* of the library, but don't worry about that. Besides, */
175 /* as a workaround, they can define FFI_BUILDING if they */
176 /* *know* they are going to link with the static library. */
177 #if defined _MSC_VER && !defined FFI_BUILDING
178 #define FFI_EXTERN extern __declspec(dllimport)
179 #else
180 #define FFI_EXTERN extern
181 #endif
182
183 /* These are defined in types.c */
184 FFI_EXTERN ffi_type ffi_type_void;
185 FFI_EXTERN ffi_type ffi_type_uint8;
186 FFI_EXTERN ffi_type ffi_type_sint8;
187 FFI_EXTERN ffi_type ffi_type_uint16;
188 FFI_EXTERN ffi_type ffi_type_sint16;
189 FFI_EXTERN ffi_type ffi_type_uint32;
190 FFI_EXTERN ffi_type ffi_type_sint32;
191 FFI_EXTERN ffi_type ffi_type_uint64;
192 FFI_EXTERN ffi_type ffi_type_sint64;
193 FFI_EXTERN ffi_type ffi_type_float;
194 FFI_EXTERN ffi_type ffi_type_double;
195 FFI_EXTERN ffi_type ffi_type_pointer;
196
197 #if @HAVE_LONG_DOUBLE@
198 FFI_EXTERN ffi_type ffi_type_longdouble;
199 #else
200 #define ffi_type_longdouble ffi_type_double
201 #endif
202
203 #ifdef FFI_TARGET_HAS_COMPLEX_TYPE
204 FFI_EXTERN ffi_type ffi_type_complex_float;
205 FFI_EXTERN ffi_type ffi_type_complex_double;
206 #if @HAVE_LONG_DOUBLE@
207 FFI_EXTERN ffi_type ffi_type_complex_longdouble;
208 #else
209 #define ffi_type_complex_longdouble ffi_type_complex_double
210 #endif
211 #endif
212 #endif /* LIBFFI_HIDE_BASIC_TYPES */
213
214 typedef enum {
215 FFI_OK = 0,
216 FFI_BAD_TYPEDEF,
217 FFI_BAD_ABI
218 } ffi_status;
219
220 typedef struct {
221 ffi_abi abi;
222 unsigned nargs;
223 ffi_type **arg_types;
224 ffi_type *rtype;
225 unsigned bytes;
226 unsigned flags;
227 #ifdef FFI_EXTRA_CIF_FIELDS
228 FFI_EXTRA_CIF_FIELDS;
229 #endif
230 } ffi_cif;
231
232 /* Used internally, but overridden by some architectures */
233 ffi_status ffi_prep_cif_core(ffi_cif *cif,
234 ffi_abi abi,
235 unsigned int isvariadic,
236 unsigned int nfixedargs,
237 unsigned int ntotalargs,
238 ffi_type *rtype,
239 ffi_type **atypes);
240
241 /* ---- Definitions for the raw API -------------------------------------- */
242
243 #ifndef FFI_SIZEOF_ARG
244 # if LONG_MAX == 2147483647
245 # define FFI_SIZEOF_ARG 4
246 # elif LONG_MAX == FFI_64_BIT_MAX
247 # define FFI_SIZEOF_ARG 8
248 # endif
249 #endif
250
251 #ifndef FFI_SIZEOF_JAVA_RAW
252 # define FFI_SIZEOF_JAVA_RAW FFI_SIZEOF_ARG
253 #endif
254
255 typedef union {
256 ffi_sarg sint;
257 ffi_arg uint;
258 float flt;
259 char data[FFI_SIZEOF_ARG];
260 void* ptr;
261 } ffi_raw;
262
263 #if FFI_SIZEOF_JAVA_RAW == 4 && FFI_SIZEOF_ARG == 8
264 /* This is a special case for mips64/n32 ABI (and perhaps others) where
265 sizeof(void *) is 4 and FFI_SIZEOF_ARG is 8. */
266 typedef union {
267 signed int sint;
268 unsigned int uint;
269 float flt;
270 char data[FFI_SIZEOF_JAVA_RAW];
271 void* ptr;
272 } ffi_java_raw;
273 #else
274 typedef ffi_raw ffi_java_raw;
275 #endif
276
277
278 void ffi_raw_call (ffi_cif *cif,
279 void (*fn)(void),
280 void *rvalue,
281 ffi_raw *avalue);
282
283 void ffi_ptrarray_to_raw (ffi_cif *cif, void **args, ffi_raw *raw);
284 void ffi_raw_to_ptrarray (ffi_cif *cif, ffi_raw *raw, void **args);
285 size_t ffi_raw_size (ffi_cif *cif);
286
287 /* This is analogous to the raw API, except it uses Java parameter */
288 /* packing, even on 64-bit machines. I.e. on 64-bit machines */
289 /* longs and doubles are followed by an empty 64-bit word. */
290
291 void ffi_java_raw_call (ffi_cif *cif,
292 void (*fn)(void),
293 void *rvalue,
294 ffi_java_raw *avalue);
295
296 void ffi_java_ptrarray_to_raw (ffi_cif *cif, void **args, ffi_java_raw *raw);
297 void ffi_java_raw_to_ptrarray (ffi_cif *cif, ffi_java_raw *raw, void **args);
298 size_t ffi_java_raw_size (ffi_cif *cif);
299
300 /* ---- Definitions for closures ----------------------------------------- */
301
302 #if FFI_CLOSURES
303
304 #ifdef _MSC_VER
305 __declspec(align(8))
306 #endif
307 typedef struct {
308 #if @FFI_EXEC_TRAMPOLINE_TABLE@
309 void *trampoline_table;
310 void *trampoline_table_entry;
311 #else
312 char tramp[FFI_TRAMPOLINE_SIZE];
313 #endif
314 ffi_cif *cif;
315 void (*fun)(ffi_cif*,void*,void**,void*);
316 void *user_data;
317 #ifdef __GNUC__
318 } ffi_closure __attribute__((aligned (8)));
319 #else
320 } ffi_closure;
321 # ifdef __sgi
322 # pragma pack 0
323 # endif
324 #endif
325
326 void *ffi_closure_alloc (size_t size, void **code);
327 void ffi_closure_free (void *);
328
329 ffi_status
330 ffi_prep_closure (ffi_closure*,
331 ffi_cif *,
332 void (*fun)(ffi_cif*,void*,void**,void*),
333 void *user_data)
334 __attribute__((deprecated ("use ffi_prep_closure_loc instead")));
335
336 ffi_status
337 ffi_prep_closure_loc (ffi_closure*,
338 ffi_cif *,
339 void (*fun)(ffi_cif*,void*,void**,void*),
340 void *user_data,
341 void*codeloc);
342
343 #ifdef __sgi
344 # pragma pack 8
345 #endif
346 typedef struct {
347 #if @FFI_EXEC_TRAMPOLINE_TABLE@
348 void *trampoline_table;
349 void *trampoline_table_entry;
350 #else
351 char tramp[FFI_TRAMPOLINE_SIZE];
352 #endif
353 ffi_cif *cif;
354
355 #if !FFI_NATIVE_RAW_API
356
357 /* if this is enabled, then a raw closure has the same layout
358 as a regular closure. We use this to install an intermediate
359 handler to do the transaltion, void** -> ffi_raw*. */
360
361 void (*translate_args)(ffi_cif*,void*,void**,void*);
362 void *this_closure;
363
364 #endif
365
366 void (*fun)(ffi_cif*,void*,ffi_raw*,void*);
367 void *user_data;
368
369 } ffi_raw_closure;
370
371 typedef struct {
372 #if @FFI_EXEC_TRAMPOLINE_TABLE@
373 void *trampoline_table;
374 void *trampoline_table_entry;
375 #else
376 char tramp[FFI_TRAMPOLINE_SIZE];
377 #endif
378
379 ffi_cif *cif;
380
381 #if !FFI_NATIVE_RAW_API
382
383 /* if this is enabled, then a raw closure has the same layout
384 as a regular closure. We use this to install an intermediate
385 handler to do the transaltion, void** -> ffi_raw*. */
386
387 void (*translate_args)(ffi_cif*,void*,void**,void*);
388 void *this_closure;
389
390 #endif
391
392 void (*fun)(ffi_cif*,void*,ffi_java_raw*,void*);
393 void *user_data;
394
395 } ffi_java_raw_closure;
396
397 ffi_status
398 ffi_prep_raw_closure (ffi_raw_closure*,
399 ffi_cif *cif,
400 void (*fun)(ffi_cif*,void*,ffi_raw*,void*),
401 void *user_data);
402
403 ffi_status
404 ffi_prep_raw_closure_loc (ffi_raw_closure*,
405 ffi_cif *cif,
406 void (*fun)(ffi_cif*,void*,ffi_raw*,void*),
407 void *user_data,
408 void *codeloc);
409
410 ffi_status
411 ffi_prep_java_raw_closure (ffi_java_raw_closure*,
412 ffi_cif *cif,
413 void (*fun)(ffi_cif*,void*,ffi_java_raw*,void*),
414 void *user_data);
415
416 ffi_status
417 ffi_prep_java_raw_closure_loc (ffi_java_raw_closure*,
418 ffi_cif *cif,
419 void (*fun)(ffi_cif*,void*,ffi_java_raw*,void*),
420 void *user_data,
421 void *codeloc);
422
423 #endif /* FFI_CLOSURES */
424
425 #if FFI_GO_CLOSURES
426
427 typedef struct {
428 void *tramp;
429 ffi_cif *cif;
430 void (*fun)(ffi_cif*,void*,void**,void*);
431 } ffi_go_closure;
432
433 ffi_status ffi_prep_go_closure (ffi_go_closure*, ffi_cif *,
434 void (*fun)(ffi_cif*,void*,void**,void*));
435
436 void ffi_call_go (ffi_cif *cif, void (*fn)(void), void *rvalue,
437 void **avalue, void *closure);
438
439 #endif /* FFI_GO_CLOSURES */
440
441 /* ---- Public interface definition -------------------------------------- */
442
443 ffi_status ffi_prep_cif(ffi_cif *cif,
444 ffi_abi abi,
445 unsigned int nargs,
446 ffi_type *rtype,
447 ffi_type **atypes);
448
449 ffi_status ffi_prep_cif_var(ffi_cif *cif,
450 ffi_abi abi,
451 unsigned int nfixedargs,
452 unsigned int ntotalargs,
453 ffi_type *rtype,
454 ffi_type **atypes);
455
456 void ffi_call(ffi_cif *cif,
457 void (*fn)(void),
458 void *rvalue,
459 void **avalue);
460
461 ffi_status ffi_get_struct_offsets (ffi_abi abi, ffi_type *struct_type,
462 size_t *offsets);
463
464 /* Useful for eliminating compiler warnings */
465 #define FFI_FN(f) ((void (*)(void))f)
466
467 /* ---- Definitions shared with assembly code ---------------------------- */
468
469 #endif
470
471 /* If these change, update src/mips/ffitarget.h. */
472 #define FFI_TYPE_VOID 0
473 #define FFI_TYPE_INT 1
474 #define FFI_TYPE_FLOAT 2
475 #define FFI_TYPE_DOUBLE 3
476 #if @HAVE_LONG_DOUBLE@
477 #define FFI_TYPE_LONGDOUBLE 4
478 #else
479 #define FFI_TYPE_LONGDOUBLE FFI_TYPE_DOUBLE
480 #endif
481 #define FFI_TYPE_UINT8 5
482 #define FFI_TYPE_SINT8 6
483 #define FFI_TYPE_UINT16 7
484 #define FFI_TYPE_SINT16 8
485 #define FFI_TYPE_UINT32 9
486 #define FFI_TYPE_SINT32 10
487 #define FFI_TYPE_UINT64 11
488 #define FFI_TYPE_SINT64 12
489 #define FFI_TYPE_STRUCT 13
490 #define FFI_TYPE_POINTER 14
491 #define FFI_TYPE_COMPLEX 15
492
493 /* This should always refer to the last type code (for sanity checks) */
494 #define FFI_TYPE_LAST FFI_TYPE_COMPLEX
495
496 #ifdef __cplusplus
497 }
498 #endif
499
500 #endif