1 \input texinfo @c -*-texinfo-*-
3 @setfilename libffi.info
8 @c Merge the standard indexes into a single one.
19 This manual is for Libffi, a portable foreign-function interface
22 Copyright @copyright{} 2008, 2010 Red Hat, Inc.
25 Permission is granted to copy, distribute and/or modify this document
26 under the terms of the GNU General Public License as published by the
27 Free Software Foundation; either version 2, or (at your option) any
28 later version. A copy of the license is included in the
29 section entitled ``GNU General Public License''.
34 @dircategory Development
36 * libffi: (libffi). Portable foreign-function interface library.
42 @vskip 0pt plus 1filll
54 * Introduction:: What is libffi?
55 * Using libffi:: How to use libffi.
56 * Missing Features:: Things libffi can't do.
64 @chapter What is libffi?
66 Compilers for high level languages generate code that follow certain
67 conventions. These conventions are necessary, in part, for separate
68 compilation to work. One such convention is the @dfn{calling
69 convention}. The calling convention is a set of assumptions made by
70 the compiler about where function arguments will be found on entry to
71 a function. A calling convention also specifies where the return
72 value for a function is found. The calling convention is also
73 sometimes called the @dfn{ABI} or @dfn{Application Binary Interface}.
74 @cindex calling convention
76 @cindex Application Binary Interface
78 Some programs may not know at the time of compilation what arguments
79 are to be passed to a function. For instance, an interpreter may be
80 told at run-time about the number and types of arguments used to call
81 a given function. @samp{Libffi} can be used in such programs to
82 provide a bridge from the interpreter program to compiled code.
84 The @samp{libffi} library provides a portable, high level programming
85 interface to various calling conventions. This allows a programmer to
86 call any function specified by a call interface description at run
89 @acronym{FFI} stands for Foreign Function Interface. A foreign
90 function interface is the popular name for the interface that allows
91 code written in one language to call code written in another language.
92 The @samp{libffi} library really only provides the lowest, machine
93 dependent layer of a fully featured foreign function interface. A
94 layer must exist above @samp{libffi} that handles type conversions for
95 values passed between the two languages.
97 @cindex Foreign Function Interface
101 @chapter Using libffi
104 * The Basics:: The basic libffi API.
105 * Simple Example:: A simple example.
106 * Types:: libffi type descriptions.
107 * Multiple ABIs:: Different passing styles on one platform.
108 * The Closure API:: Writing a generic function.
109 * Closure Example:: A closure example.
116 @samp{Libffi} assumes that you have a pointer to the function you wish
117 to call and that you know the number and types of arguments to pass
118 it, as well as the return type of the function.
120 The first thing you must do is create an @code{ffi_cif} object that
121 matches the signature of the function you wish to call. This is a
122 separate step because it is common to make multiple calls using a
123 single @code{ffi_cif}. The @dfn{cif} in @code{ffi_cif} stands for
124 Call InterFace. To prepare a call interface object, use the function
129 @defun ffi_status ffi_prep_cif (ffi_cif *@var{cif}, ffi_abi @var{abi}, unsigned int @var{nargs}, ffi_type *@var{rtype}, ffi_type **@var{argtypes})
130 This initializes @var{cif} according to the given parameters.
132 @var{abi} is the ABI to use; normally @code{FFI_DEFAULT_ABI} is what
133 you want. @ref{Multiple ABIs} for more information.
135 @var{nargs} is the number of arguments that this function accepts.
136 @samp{libffi} does not yet handle varargs functions; see @ref{Missing
137 Features} for more information.
139 @var{rtype} is a pointer to an @code{ffi_type} structure that
140 describes the return type of the function. @xref{Types}.
142 @var{argtypes} is a vector of @code{ffi_type} pointers.
143 @var{argtypes} must have @var{nargs} elements. If @var{nargs} is 0,
144 this argument is ignored.
146 @code{ffi_prep_cif} returns a @code{libffi} status code, of type
147 @code{ffi_status}. This will be either @code{FFI_OK} if everything
148 worked properly; @code{FFI_BAD_TYPEDEF} if one of the @code{ffi_type}
149 objects is incorrect; or @code{FFI_BAD_ABI} if the @var{abi} parameter
154 To call a function using an initialized @code{ffi_cif}, use the
155 @code{ffi_call} function:
158 @defun void ffi_call (ffi_cif *@var{cif}, void *@var{fn}, void *@var{rvalue}, void **@var{avalues})
159 This calls the function @var{fn} according to the description given in
160 @var{cif}. @var{cif} must have already been prepared using
163 @var{rvalue} is a pointer to a chunk of memory that will hold the
164 result of the function call. This must be large enough to hold the
165 result and must be suitably aligned; it is the caller's responsibility
166 to ensure this. If @var{cif} declares that the function returns
167 @code{void} (using @code{ffi_type_void}), then @var{rvalue} is
168 ignored. If @var{rvalue} is @samp{NULL}, then the return value is
171 @var{avalues} is a vector of @code{void *} pointers that point to the
172 memory locations holding the argument values for a call. If @var{cif}
173 declares that the function has no arguments (i.e., @var{nargs} was 0),
174 then @var{avalues} is ignored. Note that argument values may be
175 modified by the callee (for instance, structs passed by value); the
176 burden of copying pass-by-value arguments is placed on the caller.
181 @section Simple Example
183 Here is a trivial example that calls @code{puts} a few times.
197 /* Initialize the argument info vectors */
198 args[0] = &ffi_type_pointer;
201 /* Initialize the cif */
202 if (ffi_prep_cif(&cif, FFI_DEFAULT_ABI, 1,
203 &ffi_type_uint, args) == FFI_OK)
206 ffi_call(&cif, puts, &rc, values);
207 /* rc now holds the result of the call to puts */
209 /* values holds a pointer to the function's arg, so to
210 call puts() again all we need to do is change the
213 ffi_call(&cif, puts, &rc, values);
225 * Primitive Types:: Built-in types.
226 * Structures:: Structure types.
227 * Type Example:: Structure type example.
230 @node Primitive Types
231 @subsection Primitive Types
233 @code{Libffi} provides a number of built-in type descriptors that can
234 be used to describe argument and return types:
238 @tindex ffi_type_void
239 The type @code{void}. This cannot be used for argument types, only
243 @tindex ffi_type_uint8
244 An unsigned, 8-bit integer type.
247 @tindex ffi_type_sint8
248 A signed, 8-bit integer type.
250 @item ffi_type_uint16
251 @tindex ffi_type_uint16
252 An unsigned, 16-bit integer type.
254 @item ffi_type_sint16
255 @tindex ffi_type_sint16
256 A signed, 16-bit integer type.
258 @item ffi_type_uint32
259 @tindex ffi_type_uint32
260 An unsigned, 32-bit integer type.
262 @item ffi_type_sint32
263 @tindex ffi_type_sint32
264 A signed, 32-bit integer type.
266 @item ffi_type_uint64
267 @tindex ffi_type_uint64
268 An unsigned, 64-bit integer type.
270 @item ffi_type_sint64
271 @tindex ffi_type_sint64
272 A signed, 64-bit integer type.
275 @tindex ffi_type_float
276 The C @code{float} type.
278 @item ffi_type_double
279 @tindex ffi_type_double
280 The C @code{double} type.
283 @tindex ffi_type_uchar
284 The C @code{unsigned char} type.
287 @tindex ffi_type_schar
288 The C @code{signed char} type. (Note that there is not an exact
289 equivalent to the C @code{char} type in @code{libffi}; ordinarily you
290 should either use @code{ffi_type_schar} or @code{ffi_type_uchar}
291 depending on whether @code{char} is signed.)
293 @item ffi_type_ushort
294 @tindex ffi_type_ushort
295 The C @code{unsigned short} type.
297 @item ffi_type_sshort
298 @tindex ffi_type_sshort
299 The C @code{short} type.
302 @tindex ffi_type_uint
303 The C @code{unsigned int} type.
306 @tindex ffi_type_sint
307 The C @code{int} type.
310 @tindex ffi_type_ulong
311 The C @code{unsigned long} type.
314 @tindex ffi_type_slong
315 The C @code{long} type.
317 @item ffi_type_longdouble
318 @tindex ffi_type_longdouble
319 On platforms that have a C @code{long double} type, this is defined.
320 On other platforms, it is not.
322 @item ffi_type_pointer
323 @tindex ffi_type_pointer
324 A generic @code{void *} pointer. You should use this for all
325 pointers, regardless of their real type.
328 Each of these is of type @code{ffi_type}, so you must take the address
329 when passing to @code{ffi_prep_cif}.
333 @subsection Structures
335 Although @samp{libffi} has no special support for unions or
336 bit-fields, it is perfectly happy passing structures back and forth.
337 You must first describe the structure to @samp{libffi} by creating a
338 new @code{ffi_type} object for it.
342 The @code{ffi_type} has the following members:
345 This is set by @code{libffi}; you should initialize it to zero.
347 @item unsigned short alignment
348 This is set by @code{libffi}; you should initialize it to zero.
350 @item unsigned short type
351 For a structure, this should be set to @code{FFI_TYPE_STRUCT}.
353 @item ffi_type **elements
354 This is a @samp{NULL}-terminated array of pointers to @code{ffi_type}
355 objects. There is one element per field of the struct.
361 @subsection Type Example
363 The following example initializes a @code{ffi_type} object
364 representing the @code{tm} struct from Linux's @file{time.h}.
366 Here is how the struct is defined:
379 /* Those are for future use. */
380 long int __tm_gmtoff__;
381 __const char *__tm_zone__;
385 Here is the corresponding code to describe this struct to
391 ffi_type *tm_type_elements[12];
394 tm_type.size = tm_type.alignment = 0;
395 tm_type.elements = &tm_type_elements;
397 for (i = 0; i < 9; i++)
398 tm_type_elements[i] = &ffi_type_sint;
400 tm_type_elements[9] = &ffi_type_slong;
401 tm_type_elements[10] = &ffi_type_pointer;
402 tm_type_elements[11] = NULL;
404 /* tm_type can now be used to represent tm argument types and
405 return types for ffi_prep_cif() */
411 @section Multiple ABIs
413 A given platform may provide multiple different ABIs at once. For
414 instance, the x86 platform has both @samp{stdcall} and @samp{fastcall}
417 @code{libffi} provides some support for this. However, this is
418 necessarily platform-specific.
420 @c FIXME: document the platforms
422 @node The Closure API
423 @section The Closure API
425 @code{libffi} also provides a way to write a generic function -- a
426 function that can accept and decode any combination of arguments.
427 This can be useful when writing an interpreter, or to provide wrappers
428 for arbitrary functions.
430 This facility is called the @dfn{closure API}. Closures are not
431 supported on all platforms; you can check the @code{FFI_CLOSURES}
432 define to determine whether they are supported on the current
438 Because closures work by assembling a tiny function at runtime, they
439 require special allocation on platforms that have a non-executable
440 heap. Memory management for closures is handled by a pair of
443 @findex ffi_closure_alloc
444 @defun void *ffi_closure_alloc (size_t @var{size}, void **@var{code})
445 Allocate a chunk of memory holding @var{size} bytes. This returns a
446 pointer to the writable address, and sets *@var{code} to the
447 corresponding executable address.
449 @var{size} should be sufficient to hold a @code{ffi_closure} object.
452 @findex ffi_closure_free
453 @defun void ffi_closure_free (void *@var{writable})
454 Free memory allocated using @code{ffi_closure_alloc}. The argument is
455 the writable address that was returned.
459 Once you have allocated the memory for a closure, you must construct a
460 @code{ffi_cif} describing the function call. Finally you can prepare
461 the closure function:
463 @findex ffi_prep_closure_loc
464 @defun ffi_status ffi_prep_closure_loc (ffi_closure *@var{closure}, ffi_cif *@var{cif}, void (*@var{fun}) (ffi_cif *@var{cif}, void *@var{ret}, void **@var{args}, void *@var{user_data}), void *@var{user_data}, void *@var{codeloc})
465 Prepare a closure function.
467 @var{closure} is the address of a @code{ffi_closure} object; this is
468 the writable address returned by @code{ffi_closure_alloc}.
470 @var{cif} is the @code{ffi_cif} describing the function parameters.
472 @var{user_data} is an arbitrary datum that is passed, uninterpreted,
473 to your closure function.
475 @var{codeloc} is the executable address returned by
476 @code{ffi_closure_alloc}.
478 @var{fun} is the function which will be called when the closure is
479 invoked. It is called with the arguments:
482 The @code{ffi_cif} passed to @code{ffi_prep_closure_loc}.
485 A pointer to the memory used for the function's return value.
486 @var{fun} must fill this, unless the function is declared as returning
488 @c FIXME: is this NULL for void-returning functions?
491 A vector of pointers to memory holding the arguments to the function.
494 The same @var{user_data} that was passed to
495 @code{ffi_prep_closure_loc}.
498 @code{ffi_prep_closure_loc} will return @code{FFI_OK} if everything
499 went ok, and something else on error.
502 After calling @code{ffi_prep_closure_loc}, you can cast @var{codeloc}
503 to the appropriate pointer-to-function type.
506 You may see old code referring to @code{ffi_prep_closure}. This
507 function is deprecated, as it cannot handle the need for separate
508 writable and executable addresses.
510 @node Closure Example
511 @section Closure Example
513 A trivial example that creates a new @code{puts} by binding
514 @code{fputs} with @code{stdin}.
520 /* Acts like puts with the file given at time of enclosure. */
521 void puts_binding(ffi_cif *cif, unsigned int *ret, void* args[],
524 *ret = fputs(*(char **)args[0], stream);
531 ffi_closure *closure;
533 int (*bound_puts)(char *);
536 /* Allocate closure and bound_puts */
537 closure = ffi_closure_alloc(sizeof(ffi_closure), &bound_puts);
541 /* Initialize the argument info vectors */
542 args[0] = &ffi_type_pointer;
544 /* Initialize the cif */
545 if (ffi_prep_cif(&cif, FFI_DEFAULT_ABI, 1,
546 &ffi_type_uint, args) == FFI_OK)
548 /* Initialize the closure, setting stream to stdout */
549 if (ffi_prep_closure_loc(closure, &cif, puts_binding,
550 stdout, bound_puts) == FFI_OK)
552 rc = bound_puts("Hello World!");
553 /* rc now holds the result of the call to fputs */
558 /* Deallocate both closure, and bound_puts */
559 ffi_closure_free(closure);
567 @node Missing Features
568 @chapter Missing Features
570 @code{libffi} is missing a few features. We welcome patches to add
575 There is no support for calling varargs functions. This may work on
576 some platforms, depending on how the ABI is defined, but it is not
580 There is no support for bit fields in structures.
588 The ``raw'' API is undocumented.
589 @c argument promotion?