1.0.10.27: Change unportable find option "-path"
[sbcl.git] / doc / manual / ffi.texinfo
1 @node  Foreign Function Interface
2 @comment  node-name,  next,  previous,  up
3 @chapter Foreign Function Interface
4
5 This chapter describes SBCL's interface to C programs and
6 libraries (and, since C interfaces are a sort of @emph{lingua
7 franca} of the Unix world, to other programs and libraries in
8 general.)
9
10 @quotation
11 Note: In the modern Lisp world, the usual term for this functionality
12 is Foreign Function Interface, or @acronym{FFI}, where despite the
13 mention of ``function'' in this term, @acronym{FFI} also
14 refers to direct manipulation of C data structures as well as
15 functions. The traditional CMUCL terminology is Alien Interface, and
16 while that older terminology is no longer used much in the system
17 documentation, it still reflected in names in the implementation,
18 notably in the name of the @code{SB-ALIEN} package.
19 @end quotation
20
21 @menu
22 * Introduction to the Foreign Function Interface::  
23 * Foreign Types::               
24 * Operations On Foreign Values::  
25 * Foreign Variables::           
26 * Foreign Data Structure Examples::  
27 * Loading Shared Object Files::  
28 * Foreign Function Calls::      
29 * Step-By-Step Example of the Foreign Function Interface::  
30 @end menu
31
32 @node  Introduction to the Foreign Function Interface
33 @comment  node-name,  next,  previous,  up
34 @section Introduction to the Foreign Function Interface
35 @c AKA "Introduction to Aliens" in the CMU CL manual
36
37 Because of Lisp's emphasis on dynamic memory allocation and garbage
38 collection, Lisp implementations use non-C-like memory representations
39 for objects.  This representation mismatch creates friction when a Lisp
40 program must share objects with programs which expect C data.  There
41 are three common approaches to establishing communication:
42
43 @itemize
44 @item
45 The burden can be placed on the foreign program (and programmer) by
46 requiring the knowledge and use of the representations used internally
47 by the Lisp implementation.  This can require a considerable amount of
48 ``glue'' code on the C side, and that code tends to be sensitively
49 dependent on the internal implementation details of the Lisp system.
50
51 @item
52 The Lisp system can automatically convert objects back and forth
53 between the Lisp and foreign representations.  This is convenient, but
54 translation becomes prohibitively slow when large or complex data
55 structures must be shared. This approach is supported by the SBCL
56 @acronym{FFI}, and used automatically by the when passing integers and
57 strings.
58
59 @item
60 The Lisp program can directly manipulate foreign objects through the
61 use of extensions to the Lisp language.
62
63 @end itemize
64
65 SBCL, like CMUCL before it, relies primarily on the automatic
66 conversion and direct manipulation approaches. The @code{SB-ALIEN}
67 package provices a facility wherein foreign values of simple scalar
68 types are automatically converted and complex types are directly
69 manipulated in their foreign representation.  Additionally the
70 lower-level System Area Pointers (or @acronym{SAP}s) can be used where
71 necessary to provide untyped access to foreign memory.
72
73 Any foreign objects that can't automatically be converted into Lisp
74 values are represented by objects of type @code{alien-value}.  Since
75 Lisp is a dynamically typed language, even foreign objects must have a
76 run-time type; this type information is provided by encapsulating the
77 raw pointer to the foreign data within an @code{alien-value} object.
78
79 The type language and operations on foreign types are
80 intentionally similar to those of the C language.
81
82 @node  Foreign Types
83 @comment  node-name,  next,  previous,  up
84 @section Foreign Types
85 @c AKA "Alien Types" in the CMU CL manual
86
87 Alien types have a description language based on nested list
88 structure. For example the C type
89
90 @example
91 struct foo @{
92     int a;
93     struct foo *b[100];
94 @};
95 @end example
96
97 has the corresponding SBCL @acronym{FFI} type
98
99 @lisp
100 (struct foo
101   (a int)
102   (b (array (* (struct foo)) 100)))
103 @end lisp
104
105
106 @menu
107 * Defining Foreign Types::      
108 * Foreign Types and Lisp Types::  
109 * Foreign Type Specifiers::     
110 @end menu
111
112 @node  Defining Foreign Types
113 @comment  node-name,  next,  previous,  up
114 @subsection Defining Foreign Types
115
116 Types may be either named or anonymous.  With structure and union
117 types, the name is part of the type specifier, allowing recursively
118 defined types such as:
119
120 @lisp
121 (struct foo (a (* (struct foo))))
122 @end lisp
123
124 An anonymous structure or union type is specified by using the name
125 @code{nil}.  The @code{with-alien} macro defines a local scope which
126 ``captures'' any named type definitions.  Other types are not
127 inherently named, but can be given named abbreviations using the
128 @code{define-alien-type} macro.
129
130 @node  Foreign Types and Lisp Types
131 @comment  node-name,  next,  previous,  up
132 @subsection Foreign Types and Lisp Types
133
134 The foreign types form a subsystem of the SBCL type system.  An
135 @code{alien} type specifier provides a way to use any foreign type as a
136 Lisp type specifier.  For example,
137
138 @lisp
139 (typep @var{foo} '(alien (* int)))
140 @end lisp
141
142 can be used to determine whether @var{foo} is a pointer to a foreign
143 @code{int}. @code{alien} type specifiers can be used in the same ways
144 as ordinary Lisp type specifiers (like @code{string}.) Alien type
145 declarations are subject to the same precise type checking as any
146 other declaration.  @xref{Precise Type Checking}.
147
148 Note that the type identifiers used in the foreign type system overlap
149 with native Lisp type specifiers in some cases.  For example, the type
150 specifier @code{(alien single-float)} is identical to
151 @code{single-float}, since foreign floats are automatically converted
152 to Lisp floats.  When @code{type-of} is called on an alien value that
153 is not automatically converted to a Lisp value, then it will return an
154 @code{alien} type specifier.
155
156 @node  Foreign Type Specifiers
157 @comment  node-name,  next,  previous,  up
158 @subsection Foreign Type Specifiers
159
160 Note: All foreign type names are exported from the @code{sb-alien}
161 package. Some foreign type names are also symbols in
162 the @code{common-lisp} package, in which case they are
163 reexported from the @code{sb-alien} package, so that
164 e.g. it is legal to refer to @code{sb-alien:single-float}.
165
166 These are the basic foreign type specifiers: 
167
168 @itemize
169 @item
170 The foreign type specifier @code{(* @var{foo})} describes a pointer to
171 an object of type @var{foo}.  A pointed-to type @var{foo} of @code{t}
172 indicates a pointer to anything, similar to @code{void *} in
173 ANSI C. A null alien pointer can be detected with the
174 @code{sb-alien:null-alien} function.
175
176 @item
177 The foreign type specifier @code{(array @var{foo} &rest
178 dimensions)} describes array of the specified @code{dimensions},
179 holding elements of type @var{foo}. Note that (unlike in C) @code{(*
180 @var{foo})} and @code{(array @var{foo})} are considered to be
181 different types when type checking is done. If equivalence of pointer
182 and array types is desired, it may be explicitly coerced using
183 @code{sb-alien:cast}.
184
185 Arrays are accessed using @code{sb-alien:deref}, passing the indices
186 as additional arguments.  Elements are stored in column-major order
187 (as in C), so the first dimension determines only the size of the
188 memory block, and not the layout of the higher dimensions.  An array
189 whose first dimension is variable may be specified by using @code{nil}
190 as the first dimension.  Fixed-size arrays can be allocated as array
191 elements, structure slots or @code{sb-alien:with-alien}
192 variables. Dynamic arrays can only be allocated using
193 @code{sb-alien:make-alien}.
194
195 @item
196 The foreign type specifier @code{(sb-alien:struct @var{name} &rest
197 @var{fields})} describes a structure type with the specified
198 @var{name} and @var{fields}. Fields are allocated at the same offsets
199 used by the implementation's C compiler, as guessed by the SBCL
200 internals. An optional @code{:alignment} keyword argument can be
201 specified for each field to explicitly control the alignment of a
202 field. If @var{name} is @code{nil} then the structure is anonymous.
203
204 If a named foreign @code{struct} specifier is passed to
205 @code{define-alien-type} or @code{with-alien}, then this defines,
206 respectively, a new global or local foreign structure type.  If no
207 @var{fields} are specified, then the fields are taken
208 from the current (local or global) alien structure type definition of
209 @var{name}.
210
211 @item
212 The foreign type specifier @code{(sb-alien:union @var{name} &rest
213 @var{fields})} is similar to @code{sb-alien:struct}, but describes a
214 union type.  All fields are allocated at the same offset, and the size
215 of the union is the size of the largest field.  The programmer must
216 determine which field is active from context.
217
218 @item
219 The foreign type specifier @code{(sb-alien:enum @var{name} &rest
220 @var{specs})} describes an enumeration type that maps between integer
221 values and symbols. If @var{name} is @code{nil}, then the type is
222 anonymous.  Each element of the @var{specs} list is either a Lisp
223 symbol, or a list @code{(@var{symbol} @var{value})}.  @var{value} is
224 an integer. If @var{value} is not supplied, then it defaults to one
225 greater than the value for the preceding spec (or to zero if it is the
226 first spec).
227
228 @item
229 The foreign type specifier @code{(sb-alien:signed &optional
230 @var{bits})} specifies a signed integer with the specified number of
231 @var{bits} precision. The upper limit on integer
232 precision is determined by the machine's word size. If
233 @var{bits} is not specified, the maximum size will be
234 used.
235
236 @item
237 The foreign type specifier @code{(integer &optional @var{bits})}
238 is equivalent to the corresponding type specifier using
239 @code{sb-alien:signed} instead of @code{integer}.
240
241 @item
242 The foreign type specifier @code{(sb-alien:unsigned &optional
243 @var{bits})} is like corresponding type specifier using
244 @code{sb-alien:signed} except that the variable is treated as an
245 unsigned integer.
246
247 @item
248 The foreign type specifier @code{(boolean &optional @var{bits})} is
249 similar to an enumeration type, but maps from Lisp @code{nil} and
250 @code{t} to C @code{0} and @code{1} respectively. @var{bits}
251 determines the amount of storage allocated to hold the truth value.
252
253 @item
254 The foreign type specifier @code{single-float} describes a
255 floating-point number in IEEE single-precision format.
256
257 @item
258 The foreign type specifier @code{double-float} describes a
259 floating-point number in IEEE double-precision format.
260
261 @item
262 The foreign type specifier @code{(function @var{result-type} &rest
263 @var{arg-types})} describes a foreign function that takes arguments of
264 the specified @var{arg-types} and returns a result of type
265 @var{result-type}.  Note that the only context where a foreign
266 @code{function} type is directly specified is in the argument to
267 @code{sb-alien:alien-funcall}.  In all other contexts, foreign
268 functions are represented by foreign function pointer types: @code{(*
269 (function @dots{}))}.
270
271 @item
272 The foreign type specifier @code{sb-alien:system-area-pointer}
273 describes a pointer which is represented in Lisp as a
274 @code{system-area-pointer} object.  SBCL exports this type from
275 @code{sb-alien} because CMUCL did, but tentatively (as of the first
276 draft of this section of the manual, SBCL 0.7.6) it is deprecated,
277 since it doesn't seem to be required by user code.
278
279 @item
280 The foreign type specifier @code{sb-alien:void} is used in function
281 types to declare that no useful value is returned.  Using
282 @code{alien-funcall} to call a @code{void} foreign function will
283 return zero values.
284
285 @item
286 The foreign type specifier @code{(sb-alien:c-string &key external-format
287 element-type)} is similar to @code{(* char)}, but is interpreted as a
288 null-terminated string, and is automatically converted into a Lisp
289 string when accessed; or if the pointer is C @code{NULL} or @code{0},
290 then accessing it gives Lisp @code{nil}.
291
292 External format conversion is automatically done when Lisp strings are
293 passed to foreign code, or when foreign strings are passed to Lisp code.
294 If the type specifier has an explicit @code{external-format}, that
295 external format will be used. Otherwise a default external format that
296 has been determined at SBCL startup time based on the current locale
297 settings will be used. For example, when the following alien routine is
298 called, the Lisp string given as argument is converted to an
299 @code{ebcdic} octet representation.
300
301 @lisp
302 (define-alien-routine test int (str (c-string :external-format :ebcdic-us)))
303 @end lisp
304
305 Lisp strings of type @code{base-string} are stored with a trailing NUL
306 termination, so no copying (either by the user or the implementation) is
307 necessary when passing them to foreign code, assuming that the
308 @code{external-format} and @code{element-type} of the @code{c-string}
309 type are compatible with the internal representation of the string. For
310 an SBCL built with Unicode support that means an @code{external-format}
311 of @code{:ascii} and an @code{element-type} of @code{base-char}. Without
312 Unicode support the @code{external-format} can also be
313 @code{:iso-8859-1}, and the @code{element-type} can also be
314 @code{character}. If the @code{external-format} or @code{element-type}
315 is not compatible, or the string is a @code{(simple-array character
316 (*))}, this data is copied by the implementation as required.
317
318 Assigning a Lisp string to a @code{c-string} structure field or
319 variable stores the contents of the string to the memory already
320 pointed to by that variable.  When a foreign object of type @code{(*
321 char)} is assigned to a @code{c-string}, then the
322 @code{c-string} pointer is assigned to.  This allows
323 @code{c-string} pointers to be initialized.  For example:
324
325 @lisp
326 (cl:in-package "CL-USER") ; which USEs package "SB-ALIEN"
327
328 (define-alien-type nil (struct foo (str c-string)))
329
330 (defun make-foo (str)
331   (let ((my-foo (make-alien (struct foo))))
332     (setf (slot my-foo 'str) (make-alien char (length str))
333           (slot my-foo 'str) str)
334     my-foo))
335 @end lisp
336
337 Storing Lisp @code{NIL} in a @code{c-string} writes C @code{NULL} to
338 the variable.
339
340 @item
341 @code{sb-alien} also exports translations of these C type
342 specifiers as foreign type specifiers: @code{sb-alien:char},
343 @code{sb-alien:short}, @code{sb-alien:int},
344 @code{sb-alien:long}, @code{sb-alien:unsigned-char},
345 @code{sb-alien:unsigned-short},
346 @code{sb-alien:unsigned-int},
347 @code{sb-alien:unsigned-long}, @code{sb-alien:float}, and
348 @code{sb-alien:double}.
349
350 @end itemize
351
352 @node  Operations On Foreign Values
353 @comment  node-name,  next,  previous,  up
354 @section Operations On Foreign Values
355 @c AKA "Alien Operations" in the CMU CL manual
356
357 This section describes how to read foreign values as Lisp values, how
358 to coerce foreign values to different kinds of foreign values, and how
359 to dynamically allocate and free foreign variables.
360
361 @menu
362 * Accessing Foreign Values::    
363 * Coercing Foreign Values::     
364 * Foreign Dynamic Allocation::  
365 @end menu
366
367 @node  Accessing Foreign Values
368 @comment  node-name,  next,  previous,  up
369 @subsection Accessing Foreign Values
370
371 @defun sb-alien:deref @var{pointer-or-array} &rest @var{indices}
372 @findex deref
373
374 The @code{sb-alien:deref} function returns the value pointed to by a
375 foreign pointer, or the value of a foreign array element. When
376 dereferencing a pointer, an optional single index can be specified to
377 give the equivalent of C pointer arithmetic; this index is scaled by
378 the size of the type pointed to. When dereferencing an array, the
379 number of indices must be the same as the number of dimensions in the
380 array type. @code{deref} can be set with @code{setf} to assign a new
381 value.
382 @end defun
383
384 @defun sb-alien:slot @var{struct-or-union} @var{slot-name}
385 @findex slot
386
387 The @code{sb-alien:slot} function extracts the value of the slot named
388 @var{slot-name} from a foreign @code{struct} or @code{union}. If
389 @var{struct-or-union} is a pointer to a structure or union, then it is
390 automatically dereferenced.  @code{sb-alien:slot} can be set with
391 @code{setf} to assign a new value. Note that @var{slot-name} is
392 evaluated, and need not be a compile-time constant (but only constant
393 slot accesses are efficiently compiled).
394 @end defun
395
396
397 @subsubsection Untyped memory
398
399 As noted at the beginning of the chapter, the System Area Pointer
400 facilities allow untyped access to foreign memory.  @acronym{SAP}s can
401 be converted to and from the usual typed foreign values using
402 @code{sap-alien} and @code{alien-sap} (described elsewhere), and also
403 to and from integers - raw machine addresses.  They should thus be
404 used with caution; corrupting the Lisp heap or other memory with
405 @acronym{SAP}s is trivial.
406
407 @defun sb-sys:int-sap @var{machine-address}
408 @findex int-sap
409
410 Creates a @acronym{SAP} pointing at the virtual address
411 @var{machine-address}.
412 @end defun
413
414 @defun sb-sys:sap-ref-32 @var{sap} @var{offset}
415 @findex sap-ref-32
416
417 Access the value of the memory location at @var{offset} bytes from
418 @var{sap}.  This form may also be used with @code{setf} to alter the
419 memory at that location.
420 @end defun
421
422 @defun sb-sys:sap= @var{sap1} @var{sap2}
423 @findex sap=
424
425 Compare @var{sap1} and @var{sap2} for equality.
426 @end defun
427
428 Similarly named functions exist for accessing other sizes of word,
429 other comparisons, and other conversions.  The reader is invited to
430 use @code{apropos} and @code{describe} for more details
431
432 @lisp
433 (apropos "sap" :sb-sys)
434 @end lisp
435
436
437 @node  Coercing Foreign Values
438 @comment  node-name,  next,  previous,  up
439 @subsection Coercing Foreign Values
440
441 @defun sb-alien:addr @var{alien-expr}
442 @findex addr
443
444 The @code{sb-alien:addr} macro returns a pointer to the location
445 specified by @var{alien-expr}, which must be either a foreign
446 variable, a use of @code{sb-alien:deref}, a use of
447 @code{sb-alien:slot}, or a use of @code{sb-alien:extern-alien}.
448 @end defun
449
450 @defun sb-alien:cast @var{foreign-value} @var{new-type}
451 @findex cast
452
453 The @code{sb-alien:cast} macro converts @var{foreign-value} to a new
454 foreign value with the specified @var{new-type}. Both types, old and
455 new, must be foreign pointer, array or function types.  Note that the
456 resulting Lisp foreign variable object is not @code{eq} to the
457 argument, but it does refer to the same foreign data bits.
458 @end defun
459
460 @defun sb-alien:sap-alien @var{sap} @var{type}
461 @findex sap-alien
462
463 The @code{sb-alien:sap-alien} function converts @var{sap} (a system
464 area pointer) to a foreign value with the specified
465 @var{type}. @var{type} is not evaluated.  </para>
466
467 The @var{type} must be some foreign pointer, array, or record type.
468 @end defun
469
470 @defun sb-alien:alien-sap @var{foreign-value} @var{type}
471 @findex alien-sap
472
473 The @code{sb-alien:alien-sap} function returns the @acronym{SAP} which
474 points to @var{alien-value}'s data.
475
476 The @var{foreign-value} must be of some foreign pointer, array, or
477 record type.
478 @end defun
479
480
481 @node  Foreign Dynamic Allocation
482 @comment  node-name,  next,  previous,  up
483 @subsection Foreign Dynamic Allocation
484
485 Lisp code can call the C standard library functions @code{malloc} and
486 @code{free} to dynamically allocate and deallocate foreign
487 variables. The Lisp code shares the same allocator with foreign C
488 code, so it's OK for foreign code to call @code{free} on the result of
489 Lisp @code{sb-alien:make-alien}, or for Lisp code to call
490 @code{sb-alien:free-alien} on foreign objects allocated by C
491 code.
492
493 @defmac sb-alien:make-alien @var{type} @var{size}
494 @findex make-alien
495
496 The @code{sb-alien:make-alien} macro
497 returns a dynamically allocated foreign value of the specified
498 @var{type} (which is not evaluated.)  The allocated memory is not
499 initialized, and may contain arbitrary junk.  If supplied,
500 @var{size} is an expression to evaluate to compute the size of the
501 allocated object.  There are two major cases:
502
503 @itemize
504 @item
505 When @var{type} is a foreign array type, an array of that type is
506 allocated and a pointer to it is returned.  Note that you must use
507 @code{deref} to change the result to an array before you can use
508 @code{deref} to read or write elements:
509
510 @lisp
511 (cl:in-package "CL-USER") ; which USEs package "SB-ALIEN"
512 (defvar *foo* (make-alien (array char 10)))
513 (type-of *foo*) @result{} (alien (* (array (signed 8) 10)))
514 (setf (deref (deref foo) 0) 10) @result{} 10
515 @end lisp
516
517 If supplied, @var{size} is used as the first dimension for the
518     array.
519
520 @item
521 When @var{type} is any other foreign type, then an object for that
522 type is allocated, and a pointer to it is returned.  So
523 @code{(make-alien int)} returns a @code{(* int)}.  If @var{size} is
524 specified, then a block of that many objects is allocated, with the
525 result pointing to the first one.
526
527 @end itemize
528
529 @end defmac
530
531 @defun sb-alien:free-alien @var{foreign-value}
532 @findex free-alien
533
534 The @code{sb-alien:free-alien} function
535 frees the storage for @var{foreign-value}, 
536 which must have been allocated with Lisp @code{make-alien}
537 or C @code{malloc}.
538
539 See also the @code{sb-alien:with-alien} macro, which allocates foreign
540 values on the stack.
541 @end defun
542
543 @node  Foreign Variables
544 @comment  node-name,  next,  previous,  up
545 @section Foreign Variables
546 @c AKA "Alien Variables" in the CMU CL manual
547
548 Both local (stack allocated) and external (C global) foreign variables
549 are supported.
550
551 @menu
552 * Local Foreign Variables::     
553 * External Foreign Variables::  
554 @end menu
555
556 @node  Local Foreign Variables
557 @comment  node-name,  next,  previous,  up
558 @subsection Local Foreign Variables
559
560 @defmac sb-alien:with-alien @var{var-definitions} &body @var{body}
561 @findex with-alien
562
563 The @code{with-alien} macro establishes local foreign variables with
564 the specified alien types and names.  This form is analogous to
565 defining a local variable in C: additional storage is allocated, and
566 the initial value is copied.  This form is less analogous to
567 @code{LET}-allocated Lisp variables, since the variables can't be
568 captured in closures: they live only for the dynamic extent of the
569 body, and referring to them outside is a gruesome error.
570
571 The @var{var-definitions} argument is a list of 
572 variable definitions, each of the form
573 @lisp
574 (@var{name} @var{type} &optional @var{initial-value})
575 @end lisp
576
577 The names of the variables are established as symbol-macros; the
578 bindings have lexical scope, and may be assigned with @code{setq} or
579 @code{setf}.
580  
581 The @code{with-alien} macro also establishes a new scope for named
582 structures and unions.  Any @var{type} specified for a variable may
583 contain named structure or union types with the slots specified.
584 Within the lexical scope of the binding specifiers and body, a locally
585 defined foreign structure type @var{foo} can be referenced by its name
586 using @code{(struct @var{foo})}.
587 @end defmac
588
589 @node  External Foreign Variables
590 @comment  node-name,  next,  previous,  up
591 @subsection External Foreign Variables
592
593 External foreign names are strings, and Lisp names are symbols. When
594 an external foreign value is represented using a Lisp variable, there
595 must be a way to convert from one name syntax into the other. The
596 macros @code{extern-alien}, @code{define-alien-variable} and
597 @code{define-alien-routine} use this conversion heuristic:
598
599 @itemize
600
601 @item
602 Alien names are converted to Lisp names by uppercasing and replacing
603 underscores with hyphens.
604
605 @item
606 Conversely, Lisp names are converted to alien names by lowercasing and
607 replacing hyphens with underscores.
608
609 @item
610 Both the Lisp symbol and alien string names may be separately
611 specified by using a list of the form
612
613 @lisp
614 (alien-string lisp-symbol)
615 @end lisp
616
617 @end itemize
618
619 @defmac sb-alien:define-alien-variable @var{name} @var{type}
620 @findex define-alien-variable
621
622 The @code{define-alien-variable} macro defines @var{name} as an
623 external foreign variable of the specified foreign @code{type}.
624 @var{name} and @code{type} are not evaluated.  The Lisp name of the
625 variable (see above) becomes a global alien variable.  Global alien
626 variables are effectively ``global symbol macros''; a reference to the
627 variable fetches the contents of the external variable.  Similarly,
628 setting the variable stores new contents -- the new contents must be
629 of the declared @code{type}. Someday, they may well be implemented
630 using the @acronym{ANSI} @code{define-symbol-macro} mechanism, but as
631 of SBCL 0.7.5, they are still implemented using an older more-or-less
632 parallel mechanism inherited from CMUCL.
633   
634 For example, to access a C-level counter @var{foo}, one could write
635
636 @lisp
637 (define-alien-variable "foo" int)
638 ;; Now it is possible to get the value of the C variable foo simply by
639 ;; referencing that Lisp variable:
640 (print foo)
641 (setf foo 14)
642 (incf foo)
643 @end lisp
644 @end defmac
645
646 @defun sb-alien:get-errno
647 @findex get-errno
648
649 Since in modern C libraries, the @code{errno} ``variable'' is typically
650 no longer a variable, but some bizarre artificial construct
651 which behaves superficially like a variable within a given thread,
652 it can no longer reliably be accessed through the ordinary 
653 @code{define-alien-variable} mechanism. Instead, SBCL provides
654 the operator @code{sb-alien:get-errno} to allow Lisp code to read it.
655 @end defun
656
657 @defmac sb-alien:extern-alien @var{name} @var{type}
658 @findex extern-alien
659
660 The @code{extern-alien} macro returns an alien with the specified
661 @var{type} which points to an externally defined value.  @var{name} is
662 not evaluated, and may be either a string or a symbol.  @var{type} is
663 an unevaluated alien type specifier.
664 @end defmac
665
666 @node  Foreign Data Structure Examples
667 @comment  node-name,  next,  previous,  up
668 @section Foreign Data Structure Examples
669 @c AKA "Alien Data Structure Example" in the CMU CL manual
670
671 Now that we have alien types, operations and variables, we can
672 manipulate foreign data structures.  This C declaration
673
674 @example
675 struct foo @{
676     int a;
677     struct foo *b[100];
678 @};
679 @end example
680
681 can be translated into the following alien type:
682
683 @lisp
684 (define-alien-type nil
685   (struct foo
686     (a int)
687     (b (array (* (struct foo)) 100))))
688 @end lisp
689
690 Once the @code{foo} alien type has been defined as above, the C
691 expression
692
693 @example
694 struct foo f;
695 f.b[7].a;
696 @end example
697
698 can be translated in this way:
699
700 @lisp
701 (with-alien ((f (struct foo)))
702   (slot (deref (slot f 'b) 7) 'a)
703   ;;
704   ;; Do something with f...
705   )
706 @end lisp
707
708 Or consider this example of an external C variable and some accesses:
709
710 @example
711 struct c_struct @{
712         short x, y;
713         char a, b;
714         int z;
715         c_struct *n;
716 @};
717 extern struct c_struct *my_struct;
718 my_struct->x++;
719 my_struct->a = 5;
720 my_struct = my_struct->n;
721 @end example
722
723 which can be manipulated in Lisp like this:
724
725 @lisp
726 (define-alien-type nil
727   (struct c-struct
728           (x short)
729           (y short)
730           (a char)
731           (b char)
732           (z int)
733           (n (* c-struct))))
734 (define-alien-variable "my_struct" (* c-struct))
735 (incf (slot my-struct 'x))
736 (setf (slot my-struct 'a) 5)
737 (setq my-struct (slot my-struct 'n))
738 @end lisp
739
740 @node  Loading Shared Object Files
741 @comment  node-name,  next,  previous,  up
742 @section Loading Shared Object Files
743
744 Foreign object files can be loaded into the running Lisp process by
745 calling @code{load-shared-object}.
746
747 @include fun-sb-alien-load-shared-object.texinfo
748
749 @node  Foreign Function Calls
750 @comment  node-name,  next,  previous,  up
751 @section Foreign Function Calls
752
753 The foreign function call interface allows a Lisp program to call
754 many functions written in languages that use the C calling convention.
755
756 Lisp sets up various signal handling routines and other environment
757 information when it first starts up, and expects these to be in place
758 at all times. The C functions called by Lisp should not change the
759 environment, especially the signal handlers: the signal handlers
760 installed by Lisp typically have interesting flags set (e.g to request
761 machine context information, or for signal delivery on an alternate
762 stack) which the Lisp runtime relies on for correct operation.
763 Precise details of how this works may change without notice between
764 versions; the source, or the brain of a friendly SBCL developer, is
765 the only documentation.  Users of a Lisp built with the
766 @code{:sb-thread} feature should also read the section about threads,
767 @ref{Threading}.
768
769 @menu
770 * The alien-funcall Primitive::  
771 * The define-alien-routine Macro::  
772 * define-alien-routine Example::  
773 * Calling Lisp From C::         
774 @end menu
775
776 @node  The alien-funcall Primitive
777 @comment  node-name,  next,  previous,  up
778 @subsection The @code{alien-funcall} Primitive
779
780 @defun sb-alien:alien-funcall @var{alien-function} &rest @var{arguments}
781 @findex alien-funcall
782
783 The @code{alien-funcall} function is the foreign function call
784 primitive: @var{alien-function} is called with the supplied
785 @var{arguments} and its C return value is returned as a Lisp value.
786 The @var{alien-function} is an arbitrary run-time expression; to refer
787 to a constant function, use @code{extern-alien} or a value defined by
788 @code{define-alien-routine}.
789   
790 The type of @code{alien-function} must be @code{(alien (function
791 ...))}  or @code{(alien (* (function ...)))}.  The function type is
792 used to determine how to call the function (as though it was declared
793 with a prototype.)  The type need not be known at compile time, but
794 only known-type calls are efficiently compiled.  Limitations:
795
796 @itemize
797
798 @item
799 Structure type return values are not implemented.
800
801 @item
802 Passing of structures by value is not implemented.
803
804 @end itemize
805
806 @end defun
807
808 Here is an example which allocates a @code{(struct foo)}, calls a
809 foreign function to initialize it, then returns a Lisp vector of all
810 the @code{(* (struct foo))} objects filled in by the foreign call:
811
812 @lisp
813 ;; Allocate a foo on the stack.
814 (with-alien ((f (struct foo)))
815   ;; Call some C function to fill in foo fields.
816   (alien-funcall (extern-alien "mangle_foo" (function void (* foo)))
817                  (addr f))
818   ;; Find how many foos to use by getting the A field.
819   (let* ((num (slot f 'a))
820          (result (make-array num)))
821     ;; Get a pointer to the array so that we don't have to keep extracting it:
822     (with-alien ((a (* (array (* (struct foo)) 100)) (addr (slot f 'b))))
823       ;; Loop over the first N elements and stash them in the result vector.
824       (dotimes (i num)
825         (setf (svref result i) (deref (deref a) i)))
826       ;; Voila.
827       result)))
828 @end lisp
829
830 @node  The define-alien-routine Macro
831 @comment  node-name,  next,  previous,  up
832 @subsection The @code{define-alien-routine} Macro
833
834 @defmac sb-alien:define-alien-routine @var{name} @var{result-type} &rest @var{arg-specifiers}
835 @findex define-alien-routine
836
837 The @code{define-alien-routine} macro is a convenience for
838 automatically generating Lisp interfaces to simple foreign functions.
839 The primary feature is the parameter style specification, which
840 translates the C pass-by-reference idiom into additional return
841 values.
842
843 @var{name} is usually a string external symbol, but may also be a
844 symbol Lisp name or a list of the foreign name and the Lisp name.  If
845 only one name is specified, the other is automatically derived as for
846 @code{extern-alien}.  @var{result-type} is the alien type of the
847 return value.
848
849 Each element of the @var{arg-specifiers} list 
850 specifies an argument to the foreign function, and is
851 of the form
852 @lisp
853 (aname atype &amp;optional style)
854 @end lisp
855
856 @var{aname} is the symbol name of the argument to the constructed
857 function (for documentation). @var{atype} is the alien type of
858 corresponding foreign argument.  The semantics of the actual call are
859 the same as for @code{alien-funcall}. @var{style} specifies how this
860 argument should be handled at call and return time, and should be one
861 of the following:
862
863 @itemize
864
865 @item
866 @code{:in} specifies that the argument is passed by value. This is the
867 default. @code{:in} arguments have no corresponding return value from
868 the Lisp function.
869
870 @item
871 @code{:copy} is similar to @code{:in}, but the argument is copied to a
872 pre-allocated object and a pointer to this object is passed to the
873 foreign routine.
874
875 @item
876 @code{:out} specifies a pass-by-reference output value.  The type of
877 the argument must be a pointer to a fixed-sized object (such as an
878 integer or pointer).  @code{:out} and @code{:in-out} style cannot be
879 used with pointers to arrays, records or functions.  An object of the
880 correct size is allocated on the stack, and its address is passed to
881 the foreign function.  When the function returns, the contents of this
882 location are returned as one of the values of the Lisp function (and
883 the location is automatically deallocated).
884
885 @item
886 @code{:in-out} is a combination of @code{:copy} and @code{:out}.  The
887 argument is copied to a pre-allocated object and a pointer to this
888 object is passed to the foreign routine.  On return, the contents of
889 this location is returned as an additional value.
890
891 @end itemize
892
893 @quotation
894 Note: Any efficiency-critical foreign interface function should be inline
895 expanded, which can be done by preceding the
896 @code{define-alien-routine} call with:
897
898 @lisp
899 (declaim (inline lisp-name))
900 @end lisp
901
902 In addition to avoiding the Lisp call overhead, this allows
903 pointers, word-integers and floats to be passed using non-descriptor
904 representations, avoiding consing.)
905 @end quotation
906
907 @end defmac
908
909 @node  define-alien-routine Example
910 @comment  node-name,  next,  previous,  up
911 @subsection @code{define-alien-routine} Example
912
913 Consider the C function @code{cfoo} with the following calling
914 convention:
915
916 @example
917 void
918 cfoo (str, a, i)
919     char *str;
920     char *a; /* update */
921     int *i; /* out */
922 @{
923   /* body of cfoo(...) */
924 @}
925 @end example
926
927 This can be described by the following call to
928 @code{define-alien-routine}:
929
930 @lisp
931 (define-alien-routine "cfoo" void
932   (str c-string)
933   (a char :in-out)
934   (i int :out))
935 @end lisp
936
937 The Lisp function @code{cfoo} will have two arguments (@var{str} and
938 @var{a}) and two return values (@var{a} and @var{i}).
939
940 @node  Calling Lisp From C
941 @comment  node-name,  next,  previous,  up
942 @subsection Calling Lisp From C
943
944 Calling Lisp functions from C is sometimes possible, but is extremely
945 hackish and poorly supported as of SBCL 0.7.5.  See @code{funcall0}
946 @dots{} @code{funcall3} in the runtime system. The arguments must be
947 valid SBCL object descriptors (so that e.g. fixnums must be
948 left-shifted by 2.) As of SBCL 0.7.5, the format of object descriptors
949 is documented only by the source code and, in parts, by the old CMUCL
950 @file{INTERNALS} documentation.
951
952 Note that the garbage collector moves objects, and won't be
953 able to fix up any references in C variables.  There are three
954 mechanisms for coping with this: 
955
956 @enumerate
957 @item
958 The @code{sb-ext:purify} moves all live Lisp
959 data into static or read-only areas such that it will never be moved
960 (or freed) again in the life of the Lisp session
961
962 @item
963 @code{sb-sys:with-pinned-objects} is a macro which arranges for some
964 set of objects to be pinned in memory for the dynamic extent of its
965 body forms.  On ports which use the generational garbage collector (as
966 of SBCL 0.8.3, only the x86) this has a page granularity - i.e. the
967 entire 4k page or pages containing the objects will be locked down. On
968 other ports it is implemented by turning off GC for the duration (so
969 could be said to have a whole-world granularity).
970
971 @item
972 Disable GC, using the @code{without-gcing} macro or @code{gc-off}
973 call.
974 @end enumerate
975
976 @c <!-- FIXME: This is a "changebar" section from the CMU CL manual.
977 @c      I (WHN 2002-07-14) am not very familiar with this content, so 
978 @c      I'm not immediately prepared to try to update it for SBCL, and
979 @c      I'm not feeling masochistic enough to work to encourage this
980 @c      kind of low-level hack anyway. However, I acknowledge that callbacks
981 @c      are sometimes really really necessary, so I include the original
982 @c      text in case someone is hard-core enough to benefit from it. If
983 @c      anyone brings the information up to date for SBCL, it belong
984 @c      either in the main manual or on a CLiki SBCL Internals page.
985 @c LaTeX \subsection{Accessing Lisp Arrays}
986 @c LaTeX 
987 @c LaTeX Due to the way \cmucl{} manages memory, the amount of memory that can
988 @c LaTeX be dynamically allocated by \code{malloc} or \funref{make-alien} is
989 @c LaTeX limited\footnote{\cmucl{} mmaps a large piece of memory for it's own
990 @c LaTeX   use and this memory is typically about 8 MB above the start of the C
991 @c LaTeX   heap.  Thus, only about 8 MB of memory can be dynamically
992 @c LaTeX   allocated.}.
993
994 @c Empirically determined to be considerably >8Mb on this x86 linux
995 @c machine, but I don't know what the actual values are - dan 2003.09.01
996
997 @c Note that this technique is used in SB-GROVEL in the SBCL contrib
998
999 @c LaTeX 
1000 @c LaTeX To overcome this limitation, it is possible to access the content of
1001 @c LaTeX Lisp arrays which are limited only by the amount of physical memory
1002 @c LaTeX and swap space available.  However, this technique is only useful if
1003 @c LaTeX the foreign function takes pointers to memory instead of allocating
1004 @c LaTeX memory for itself.  In latter case, you will have to modify the
1005 @c LaTeX foreign functions.
1006 @c LaTeX 
1007 @c LaTeX This technique takes advantage of the fact that \cmucl{} has
1008 @c LaTeX specialized array types (\pxlref{specialized-array-types}) that match
1009 @c LaTeX a typical C array.  For example, a \code{(simple-array double-float
1010 @c LaTeX   (100))} is stored in memory in essentially the same way as the C
1011 @c LaTeX array \code{double x[100]} would be.  The following function allows us
1012 @c LaTeX to get the physical address of such a Lisp array:
1013 @c LaTeX \begin{example}
1014 @c LaTeX (defun array-data-address (array)
1015 @c LaTeX   "Return the physical address of where the actual data of an array is
1016 @c LaTeX stored.
1017 @c LaTeX 
1018 @c LaTeX ARRAY must be a specialized array type in CMU Lisp.  This means ARRAY
1019 @c LaTeX must be an array of one of the following types:
1020 @c LaTeX 
1021 @c LaTeX                   double-float
1022 @c LaTeX                   single-float
1023 @c LaTeX                   (unsigned-byte 32)
1024 @c LaTeX                   (unsigned-byte 16)
1025 @c LaTeX                   (unsigned-byte  8)
1026 @c LaTeX                   (signed-byte 32)
1027 @c LaTeX                   (signed-byte 16)
1028 @c LaTeX                   (signed-byte  8)
1029 @c LaTeX "
1030 @c LaTeX   (declare (type (or #+signed-array (array (signed-byte 8))
1031 @c LaTeX                      #+signed-array (array (signed-byte 16))
1032 @c LaTeX                      #+signed-array (array (signed-byte 32))
1033 @c LaTeX                      (array (unsigned-byte 8))
1034 @c LaTeX                      (array (unsigned-byte 16))
1035 @c LaTeX                      (array (unsigned-byte 32))
1036 @c LaTeX                      (array single-float)
1037 @c LaTeX                      (array double-float))
1038 @c LaTeX                  array)
1039 @c LaTeX            (optimize (speed 3) (safety 0))
1040 @c LaTeX            (ext:optimize-interface (safety 3)))
1041 @c LaTeX   ;; with-array-data will get us to the actual data.  However, because
1042 @c LaTeX   ;; the array could have been displaced, we need to know where the
1043 @c LaTeX   ;; data starts.
1044 @c LaTeX   (lisp::with-array-data ((data array)
1045 @c LaTeX                           (start)
1046 @c LaTeX                           (end))
1047 @c LaTeX     (declare (ignore end))
1048 @c LaTeX     ;; DATA is a specialized simple-array.  Memory is laid out like this:
1049 @c LaTeX     ;;
1050 @c LaTeX     ;;   byte offset    Value
1051 @c LaTeX     ;;        0         type code (should be 70 for double-float vector)
1052 @c LaTeX     ;;        4         4 * number of elements in vector
1053 @c LaTeX     ;;        8         1st element of vector
1054 @c LaTeX     ;;      ...         ...
1055 @c LaTeX     ;;
1056 @c LaTeX     (let ((addr (+ 8 (logandc1 7 (kernel:get-lisp-obj-address data))))
1057 @c LaTeX           (type-size (let ((type (array-element-type data)))
1058 @c LaTeX                        (cond ((or (equal type '(signed-byte 8))
1059 @c LaTeX                                   (equal type '(unsigned-byte 8)))
1060 @c LaTeX                               1)
1061 @c LaTeX                              ((or (equal type '(signed-byte 16))
1062 @c LaTeX                                   (equal type '(unsigned-byte 16)))
1063 @c LaTeX                               2)
1064 @c LaTeX                              ((or (equal type '(signed-byte 32))
1065 @c LaTeX                                   (equal type '(unsigned-byte 32)))
1066 @c LaTeX                               4)
1067 @c LaTeX                              ((equal type 'single-float)
1068 @c LaTeX                               4)
1069 @c LaTeX                              ((equal type 'double-float)
1070 @c LaTeX                               8)
1071 @c LaTeX                              (t
1072 @c LaTeX                               (error "Unknown specialized array element type"))))))
1073 @c LaTeX       (declare (type (unsigned-byte 32) addr)
1074 @c LaTeX                (optimize (speed 3) (safety 0) (ext:inhibit-warnings 3)))
1075 @c LaTeX       (system:int-sap (the (unsigned-byte 32)
1076 @c LaTeX                         (+ addr (* type-size start)))))))
1077 @c LaTeX \end{example}
1078 @c LaTeX 
1079 @c LaTeX Assume we have the C function below that we wish to use:
1080 @c LaTeX \begin{example}
1081 @c LaTeX   double dotprod(double* x, double* y, int n)
1082 @c LaTeX   \{
1083 @c LaTeX     int k;
1084 @c LaTeX     double sum = 0;
1085 @c LaTeX 
1086 @c LaTeX     for (k = 0; k < n; ++k) \{
1087 @c LaTeX       sum += x[k] * y[k];
1088 @c LaTeX     \}
1089 @c LaTeX   \}
1090 @c LaTeX \end{example}
1091 @c LaTeX The following example generates two large arrays in Lisp, and calls the C
1092 @c LaTeX function to do the desired computation.  This would not have been
1093 @c LaTeX possible using \code{malloc} or \code{make-alien} since we need about
1094 @c LaTeX 16 MB of memory to hold the two arrays.
1095 @c LaTeX \begin{example}
1096 @c LaTeX   (define-alien-routine "dotprod" double
1097 @c LaTeX     (x (* double-float) :in)
1098 @c LaTeX     (y (* double-float) :in)
1099 @c LaTeX     (n int :in))
1100 @c LaTeX     
1101 @c LaTeX   (let ((x (make-array 1000000 :element-type 'double-float))
1102 @c LaTeX         (y (make-array 1000000 :element-type 'double-float)))
1103 @c LaTeX     ;; Initialize X and Y somehow
1104 @c LaTeX     (let ((x-addr (system:int-sap (array-data-address x)))
1105 @c LaTeX           (y-addr (system:int-sap (array-data-address y))))
1106 @c LaTeX       (dotprod x-addr y-addr 1000000)))    
1107 @c LaTeX \end{example}
1108 @c LaTeX In this example, it may be useful to wrap the inner \code{let}
1109 @c LaTeX expression in an \code{unwind-protect} that first turns off garbage
1110 @c LaTeX collection and then turns garbage collection on afterwards.  This will
1111 @c LaTeX prevent garbage collection from moving \code{x} and \code{y} after we
1112 @c LaTeX have obtained the (now erroneous) addresses but before the call to
1113 @c LaTeX \code{dotprod} is made.
1114 @c LaTeX 
1115 @c -->
1116
1117
1118 @node  Step-By-Step Example of the Foreign Function Interface
1119 @comment  node-name,  next,  previous,  up
1120 @section Step-By-Step Example of the Foreign Function Interface
1121
1122 This section presents a complete example of an interface to a somewhat
1123 complicated C function.
1124
1125 Suppose you have the following C function which you want to be able to
1126 call from Lisp in the file @file{test.c}
1127
1128 @example
1129 struct c_struct
1130 @{
1131   int x;
1132   char *s;
1133 @};
1134  
1135 struct c_struct *c_function (i, s, r, a)
1136     int i;
1137     char *s;
1138     struct c_struct *r;
1139     int a[10];
1140 @{
1141   int j;
1142   struct c_struct *r2;
1143  
1144   printf("i = %d\n", i);
1145   printf("s = %s\n", s);
1146   printf("r->x = %d\n", r->x);
1147   printf("r->s = %s\n", r->s);
1148   for (j = 0; j < 10; j++) printf("a[%d] = %d.\n", j, a[j]);
1149   r2 = (struct c_struct *) malloc (sizeof(struct c_struct));
1150   r2->x = i + 5;
1151   r2->s = "a C string";
1152   return(r2);
1153 @};
1154 @end example
1155
1156 It is possible to call this C function from Lisp using the file
1157 @file{test.lisp} containing
1158
1159 @lisp
1160 (cl:defpackage "TEST-C-CALL" (:use "CL" "SB-ALIEN" "SB-C-CALL"))
1161 (cl:in-package "TEST-C-CALL")
1162
1163 ;;; Define the record C-STRUCT in Lisp.
1164 (define-alien-type nil
1165     (struct c-struct
1166             (x int)
1167             (s c-string)))
1168
1169 ;;; Define the Lisp function interface to the C routine.  It returns a
1170 ;;; pointer to a record of type C-STRUCT.  It accepts four parameters:
1171 ;;; I, an int; S, a pointer to a string; R, a pointer to a C-STRUCT
1172 ;;; record; and A, a pointer to the array of 10 ints.
1173 ;;;
1174 ;;; The INLINE declaration eliminates some efficiency notes about heap
1175 ;;; allocation of alien values.
1176 (declaim (inline c-function))
1177 (define-alien-routine c-function
1178     (* (struct c-struct))
1179   (i int)
1180   (s c-string)
1181   (r (* (struct c-struct)))
1182   (a (array int 10)))
1183
1184 ;;; a function which sets up the parameters to the C function and
1185 ;;; actually calls it
1186 (defun call-cfun ()
1187   (with-alien ((ar (array int 10))
1188                (c-struct (struct c-struct)))
1189     (dotimes (i 10)                     ; Fill array.
1190       (setf (deref ar i) i))
1191     (setf (slot c-struct 'x) 20)
1192     (setf (slot c-struct 's) "a Lisp string")
1193
1194     (with-alien ((res (* (struct c-struct))
1195                       (c-function 5 "another Lisp string" (addr c-struct) ar)))
1196       (format t "~&amp;back from C function~%")
1197       (multiple-value-prog1
1198           (values (slot res 'x)
1199                   (slot res 's))
1200
1201         ;; Deallocate result. (after we are done referring to it:
1202         ;; "Pillage, *then* burn.")
1203         (free-alien res)))))
1204 @end lisp
1205
1206 To execute the above example, it is necessary to compile the C
1207 routine, e.g.: @samp{cc -c test.c && ld -shared -o test.so test.o} (In
1208 order to enable incremental loading with some linkers, you may need to
1209 say @samp{cc -G 0 -c test.c})
1210
1211 Once the C code has been compiled, you can start up Lisp and load it in:
1212 @samp{sbcl}.  Lisp should start up with its normal prompt.
1213
1214 Within Lisp, compile the Lisp file. (This step can be done
1215 separately. You don't have to recompile every time.)
1216 @samp{(compile-file "test.lisp")}
1217
1218 Within Lisp, load the foreign object file to define the necessary
1219 symbols: @samp{(load-shared-object "test.so")}. 
1220
1221 Now you can load the compiled Lisp (``fasl'') file into Lisp:
1222 @samp{(load "test.fasl")}
1223 And once the Lisp file is loaded, you can call the 
1224 Lisp routine that sets up the parameters and calls the C
1225 function:
1226 @samp{(test-c-call::call-cfun)}
1227
1228 The C routine should print the following information to standard output:
1229
1230 @example
1231 i = 5
1232 s = another Lisp string
1233 r->x = 20
1234 r->s = a Lisp string
1235 a[0] = 0.
1236 a[1] = 1.
1237 a[2] = 2.
1238 a[3] = 3.
1239 a[4] = 4.
1240 a[5] = 5.
1241 a[6] = 6.
1242 a[7] = 7.
1243 a[8] = 8.
1244 a[9] = 9.
1245 @end example
1246
1247 After return from the C function,
1248 the Lisp wrapper function should print the following output:
1249
1250 @example
1251 back from C function
1252 @end example
1253
1254 And upon return from the Lisp wrapper function,
1255 before the next prompt is printed, the
1256 Lisp read-eval-print loop should print the following return values:
1257
1258 @example
1259 10
1260 "a C string"
1261 @end example