1 /* Copyright (C) 2010, 2011, 2012 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
30 #include "libguile/_scm.h"
31 #include "libguile/bytevectors.h"
32 #include "libguile/instructions.h"
33 #include "libguile/threads.h"
34 #include "libguile/foreign.h"
38 SCM_SYMBOL (sym_void
, "void");
39 SCM_SYMBOL (sym_float
, "float");
40 SCM_SYMBOL (sym_double
, "double");
41 SCM_SYMBOL (sym_uint8
, "uint8");
42 SCM_SYMBOL (sym_int8
, "int8");
43 SCM_SYMBOL (sym_uint16
, "uint16");
44 SCM_SYMBOL (sym_int16
, "int16");
45 SCM_SYMBOL (sym_uint32
, "uint32");
46 SCM_SYMBOL (sym_int32
, "int32");
47 SCM_SYMBOL (sym_uint64
, "uint64");
48 SCM_SYMBOL (sym_int64
, "int64");
49 SCM_SYMBOL (sym_short
, "short");
50 SCM_SYMBOL (sym_int
, "int");
51 SCM_SYMBOL (sym_long
, "long");
52 SCM_SYMBOL (sym_unsigned_short
, "unsigned-short");
53 SCM_SYMBOL (sym_unsigned_int
, "unsigned-int");
54 SCM_SYMBOL (sym_unsigned_long
, "unsigned-long");
55 SCM_SYMBOL (sym_size_t
, "size_t");
57 /* that's for pointers, you know. */
58 SCM_SYMBOL (sym_asterisk
, "*");
60 SCM_SYMBOL (sym_null
, "%null-pointer");
61 SCM_SYMBOL (sym_null_pointer_error
, "null-pointer-error");
63 /* The cell representing the null pointer. */
64 static SCM null_pointer
;
66 #if SIZEOF_VOID_P == 4
67 # define scm_to_uintptr scm_to_uint32
68 # define scm_from_uintptr scm_from_uint32
69 #elif SIZEOF_VOID_P == 8
70 # define scm_to_uintptr scm_to_uint64
71 # define scm_from_uintptr scm_from_uint64
73 # error unsupported pointer size
77 /* Raise a null pointer dereference error. */
79 null_pointer_error (const char *func_name
)
81 scm_error (sym_null_pointer_error
, func_name
,
82 "null pointer dereference", SCM_EOL
, SCM_EOL
);
86 static SCM
cif_to_procedure (SCM cif
, SCM func_ptr
);
89 static SCM pointer_weak_refs
= SCM_BOOL_F
;
90 static scm_i_pthread_mutex_t weak_refs_lock
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
94 register_weak_reference (SCM from
, SCM to
)
96 scm_i_pthread_mutex_lock (&weak_refs_lock
);
97 scm_hashq_set_x (pointer_weak_refs
, from
, to
);
98 scm_i_pthread_mutex_unlock (&weak_refs_lock
);
102 pointer_finalizer_trampoline (GC_PTR ptr
, GC_PTR data
)
104 scm_t_pointer_finalizer finalizer
= data
;
105 finalizer (SCM_POINTER_VALUE (PTR2SCM (ptr
)));
108 SCM_DEFINE (scm_pointer_p
, "pointer?", 1, 0, 0,
110 "Return @code{#t} if @var{obj} is a pointer object, "
111 "@code{#f} otherwise.\n")
112 #define FUNC_NAME s_scm_pointer_p
114 return scm_from_bool (SCM_POINTER_P (obj
));
118 SCM_DEFINE (scm_make_pointer
, "make-pointer", 1, 1, 0,
119 (SCM address
, SCM finalizer
),
120 "Return a foreign pointer object pointing to @var{address}. "
121 "If @var{finalizer} is passed, it should be a pointer to a "
122 "one-argument C function that will be called when the pointer "
123 "object becomes unreachable.")
124 #define FUNC_NAME s_scm_make_pointer
127 scm_t_uintptr c_address
;
129 c_address
= scm_to_uintptr (address
);
130 if (SCM_UNBNDP (finalizer
))
134 SCM_VALIDATE_POINTER (2, finalizer
);
135 c_finalizer
= SCM_POINTER_VALUE (finalizer
);
138 return scm_from_pointer ((void *) c_address
, c_finalizer
);
143 scm_from_pointer (void *ptr
, scm_t_pointer_finalizer finalizer
)
147 if (ptr
== NULL
&& finalizer
== NULL
)
151 ret
= scm_cell (scm_tc7_pointer
, (scm_t_bits
) ptr
);
155 /* Register a finalizer for the newly created instance. */
156 GC_finalization_proc prev_finalizer
;
157 GC_PTR prev_finalizer_data
;
158 GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (ret
),
159 pointer_finalizer_trampoline
,
162 &prev_finalizer_data
);
169 SCM_DEFINE (scm_pointer_address
, "pointer-address", 1, 0, 0,
171 "Return the numerical value of @var{pointer}.")
172 #define FUNC_NAME s_scm_pointer_address
174 SCM_VALIDATE_POINTER (1, pointer
);
176 return scm_from_uintptr ((scm_t_uintptr
) SCM_POINTER_VALUE (pointer
));
180 SCM_DEFINE (scm_pointer_to_scm
, "pointer->scm", 1, 0, 0,
182 "Unsafely cast @var{pointer} to a Scheme object.\n"
183 "Cross your fingers!")
184 #define FUNC_NAME s_scm_pointer_to_scm
186 SCM_VALIDATE_POINTER (1, pointer
);
188 return SCM_PACK ((scm_t_bits
) SCM_POINTER_VALUE (pointer
));
192 SCM_DEFINE (scm_scm_to_pointer
, "scm->pointer", 1, 0, 0,
194 "Return a foreign pointer object with the @code{object-address}\n"
196 #define FUNC_NAME s_scm_scm_to_pointer
200 ret
= scm_from_pointer ((void*) SCM_UNPACK (scm
), NULL
);
202 register_weak_reference (ret
, scm
);
208 SCM_DEFINE (scm_pointer_to_bytevector
, "pointer->bytevector", 2, 2, 0,
209 (SCM pointer
, SCM len
, SCM offset
, SCM uvec_type
),
210 "Return a bytevector aliasing the @var{len} bytes pointed\n"
211 "to by @var{pointer}.\n\n"
212 "The user may specify an alternate default interpretation for\n"
213 "the memory by passing the @var{uvec_type} argument, to indicate\n"
214 "that the memory is an array of elements of that type.\n"
215 "@var{uvec_type} should be something that\n"
216 "@code{uniform-vector-element-type} would return, like @code{f32}\n"
218 "When @var{offset} is passed, it specifies the offset in bytes\n"
219 "relative to @var{pointer} of the memory region aliased by the\n"
220 "returned bytevector.")
221 #define FUNC_NAME s_scm_pointer_to_bytevector
225 size_t boffset
, blen
;
226 scm_t_array_element_type btype
;
228 SCM_VALIDATE_POINTER (1, pointer
);
229 ptr
= SCM_POINTER_VALUE (pointer
);
231 if (SCM_UNLIKELY (ptr
== NULL
))
232 null_pointer_error (FUNC_NAME
);
234 if (SCM_UNBNDP (uvec_type
))
235 btype
= SCM_ARRAY_ELEMENT_TYPE_VU8
;
239 for (i
= 0; i
<= SCM_ARRAY_ELEMENT_TYPE_LAST
; i
++)
240 if (scm_is_eq (uvec_type
, scm_i_array_element_types
[i
]))
244 case SCM_ARRAY_ELEMENT_TYPE_VU8
:
245 case SCM_ARRAY_ELEMENT_TYPE_U8
:
246 case SCM_ARRAY_ELEMENT_TYPE_S8
:
247 case SCM_ARRAY_ELEMENT_TYPE_U16
:
248 case SCM_ARRAY_ELEMENT_TYPE_S16
:
249 case SCM_ARRAY_ELEMENT_TYPE_U32
:
250 case SCM_ARRAY_ELEMENT_TYPE_S32
:
251 case SCM_ARRAY_ELEMENT_TYPE_U64
:
252 case SCM_ARRAY_ELEMENT_TYPE_S64
:
253 case SCM_ARRAY_ELEMENT_TYPE_F32
:
254 case SCM_ARRAY_ELEMENT_TYPE_F64
:
255 case SCM_ARRAY_ELEMENT_TYPE_C32
:
256 case SCM_ARRAY_ELEMENT_TYPE_C64
:
260 scm_wrong_type_arg_msg (FUNC_NAME
, SCM_ARG1
, uvec_type
,
261 "uniform vector type");
265 if (SCM_UNBNDP (offset
))
268 boffset
= scm_to_size_t (offset
);
270 blen
= scm_to_size_t (len
);
272 ret
= scm_c_take_typed_bytevector ((signed char *) ptr
+ boffset
,
274 register_weak_reference (ret
, pointer
);
279 SCM_DEFINE (scm_bytevector_to_pointer
, "bytevector->pointer", 1, 1, 0,
280 (SCM bv
, SCM offset
),
281 "Return a pointer pointer aliasing the memory pointed to by\n"
282 "@var{bv} or @var{offset} bytes after @var{bv} when @var{offset}\n"
284 #define FUNC_NAME s_scm_bytevector_to_pointer
290 SCM_VALIDATE_BYTEVECTOR (1, bv
);
291 ptr
= SCM_BYTEVECTOR_CONTENTS (bv
);
293 if (SCM_UNBNDP (offset
))
296 boffset
= scm_to_unsigned_integer (offset
, 0,
297 SCM_BYTEVECTOR_LENGTH (bv
) - 1);
299 ret
= scm_from_pointer (ptr
+ boffset
, NULL
);
300 register_weak_reference (ret
, bv
);
305 SCM_DEFINE (scm_set_pointer_finalizer_x
, "set-pointer-finalizer!", 2, 0, 0,
306 (SCM pointer
, SCM finalizer
),
307 "Arrange for the C procedure wrapped by @var{finalizer} to be\n"
308 "called on the pointer wrapped by @var{pointer} when @var{pointer}\n"
309 "becomes unreachable. Note: the C procedure should not call into\n"
310 "Scheme. If you need a Scheme finalizer, use guardians.")
311 #define FUNC_NAME s_scm_set_pointer_finalizer_x
314 GC_finalization_proc prev_finalizer
;
315 GC_PTR prev_finalizer_data
;
317 SCM_VALIDATE_POINTER (1, pointer
);
318 SCM_VALIDATE_POINTER (2, finalizer
);
320 c_finalizer
= SCM_POINTER_VALUE (finalizer
);
322 SCM_SET_CELL_WORD_0 (pointer
, SCM_CELL_WORD_0 (pointer
) | (1 << 16UL));
324 GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (pointer
),
325 pointer_finalizer_trampoline
,
328 &prev_finalizer_data
);
330 return SCM_UNSPECIFIED
;
335 scm_i_pointer_print (SCM pointer
, SCM port
, scm_print_state
*pstate
)
337 scm_puts ("#<pointer 0x", port
);
338 scm_uintprint (scm_to_uintptr (scm_pointer_address (pointer
)), 16, port
);
339 scm_putc ('>', port
);
343 /* Non-primitive helpers functions. These procedures could be
344 implemented in terms of the primitives above but would be inefficient
345 (heap allocation overhead, Scheme/C round trips, etc.) */
347 SCM_DEFINE (scm_dereference_pointer
, "dereference-pointer", 1, 0, 0,
349 "Assuming @var{pointer} points to a memory region that\n"
350 "holds a pointer, return this pointer.")
351 #define FUNC_NAME s_scm_dereference_pointer
353 SCM_VALIDATE_POINTER (1, pointer
);
355 return scm_from_pointer (* (void **) SCM_POINTER_VALUE (pointer
), NULL
);
359 SCM_DEFINE (scm_string_to_pointer
, "string->pointer", 1, 1, 0,
360 (SCM string
, SCM encoding
),
361 "Return a foreign pointer to a nul-terminated copy of\n"
362 "@var{string} in the given @var{encoding}, defaulting to\n"
363 "the current locale encoding. The C string is freed when\n"
364 "the returned foreign pointer becomes unreachable.\n\n"
365 "This is the Scheme equivalent of @code{scm_to_stringn}.")
366 #define FUNC_NAME s_scm_string_to_pointer
368 SCM_VALIDATE_STRING (1, string
);
370 /* XXX: Finalizers slow down libgc; they could be avoided if
371 `scm_to_string' & co. were able to use libgc-allocated memory. */
373 if (SCM_UNBNDP (encoding
))
374 return scm_from_pointer (scm_to_locale_string (string
), free
);
380 SCM_VALIDATE_STRING (2, encoding
);
382 enc
= scm_to_locale_string (encoding
);
383 scm_dynwind_begin (0);
384 scm_dynwind_free (enc
);
386 ret
= scm_from_pointer
387 (scm_to_stringn (string
, NULL
, enc
,
388 scm_i_get_conversion_strategy (SCM_BOOL_F
)),
398 SCM_DEFINE (scm_pointer_to_string
, "pointer->string", 1, 2, 0,
399 (SCM pointer
, SCM length
, SCM encoding
),
400 "Return the string representing the C string pointed to by\n"
401 "@var{pointer}. If @var{length} is omitted or @code{-1}, the\n"
402 "string is assumed to be nul-terminated. Otherwise\n"
403 "@var{length} is the number of bytes in memory pointed to by\n"
404 "@var{pointer}. The C string is assumed to be in the given\n"
405 "@var{encoding}, defaulting to the current locale encoding.\n\n"
406 "This is the Scheme equivalent of @code{scm_from_stringn}.")
407 #define FUNC_NAME s_scm_pointer_to_string
411 SCM_VALIDATE_POINTER (1, pointer
);
413 if (SCM_UNBNDP (length
)
414 || scm_is_true (scm_eqv_p (length
, scm_from_int (-1))))
417 len
= scm_to_size_t (length
);
419 if (SCM_UNBNDP (encoding
))
420 return scm_from_locale_stringn (SCM_POINTER_VALUE (pointer
), len
);
426 SCM_VALIDATE_STRING (3, encoding
);
428 enc
= scm_to_locale_string (encoding
);
429 scm_dynwind_begin (0);
430 scm_dynwind_free (enc
);
432 ret
= scm_from_stringn (SCM_POINTER_VALUE (pointer
), len
, enc
,
433 scm_i_get_conversion_strategy (SCM_BOOL_F
));
444 SCM_DEFINE (scm_alignof
, "alignof", 1, 0, 0, (SCM type
),
445 "Return the alignment of @var{type}, in bytes.\n\n"
446 "@var{type} should be a valid C type, like @code{int}.\n"
447 "Alternately @var{type} may be the symbol @code{*}, in which\n"
448 "case the alignment of a pointer is returned. @var{type} may\n"
449 "also be a list of types, in which case the alignment of a\n"
450 "@code{struct} with ABI-conventional packing is returned.")
451 #define FUNC_NAME s_scm_alignof
453 if (SCM_I_INUMP (type
))
455 switch (SCM_I_INUM (type
))
457 case SCM_FOREIGN_TYPE_FLOAT
:
458 return scm_from_size_t (alignof_type (float));
459 case SCM_FOREIGN_TYPE_DOUBLE
:
460 return scm_from_size_t (alignof_type (double));
461 case SCM_FOREIGN_TYPE_UINT8
:
462 return scm_from_size_t (alignof_type (scm_t_uint8
));
463 case SCM_FOREIGN_TYPE_INT8
:
464 return scm_from_size_t (alignof_type (scm_t_int8
));
465 case SCM_FOREIGN_TYPE_UINT16
:
466 return scm_from_size_t (alignof_type (scm_t_uint16
));
467 case SCM_FOREIGN_TYPE_INT16
:
468 return scm_from_size_t (alignof_type (scm_t_int16
));
469 case SCM_FOREIGN_TYPE_UINT32
:
470 return scm_from_size_t (alignof_type (scm_t_uint32
));
471 case SCM_FOREIGN_TYPE_INT32
:
472 return scm_from_size_t (alignof_type (scm_t_int32
));
473 case SCM_FOREIGN_TYPE_UINT64
:
474 return scm_from_size_t (alignof_type (scm_t_uint64
));
475 case SCM_FOREIGN_TYPE_INT64
:
476 return scm_from_size_t (alignof_type (scm_t_int64
));
478 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
481 else if (scm_is_eq (type
, sym_asterisk
))
483 return scm_from_size_t (alignof_type (void*));
484 else if (scm_is_pair (type
))
486 /* TYPE is a structure. Section 3-3 of the i386, x86_64, PowerPC,
487 and SPARC P.S. of the System V ABI all say: "Aggregates
488 (structures and arrays) and unions assume the alignment of
489 their most strictly aligned component." */
492 for (max
= 0; scm_is_pair (type
); type
= SCM_CDR (type
))
496 align
= scm_to_size_t (scm_alignof (SCM_CAR (type
)));
501 return scm_from_size_t (max
);
504 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
508 SCM_DEFINE (scm_sizeof
, "sizeof", 1, 0, 0, (SCM type
),
509 "Return the size of @var{type}, in bytes.\n\n"
510 "@var{type} should be a valid C type, like @code{int}.\n"
511 "Alternately @var{type} may be the symbol @code{*}, in which\n"
512 "case the size of a pointer is returned. @var{type} may also\n"
513 "be a list of types, in which case the size of a @code{struct}\n"
514 "with ABI-conventional packing is returned.")
515 #define FUNC_NAME s_scm_sizeof
517 if (SCM_I_INUMP (type
))
519 switch (SCM_I_INUM (type
))
521 case SCM_FOREIGN_TYPE_FLOAT
:
522 return scm_from_size_t (sizeof (float));
523 case SCM_FOREIGN_TYPE_DOUBLE
:
524 return scm_from_size_t (sizeof (double));
525 case SCM_FOREIGN_TYPE_UINT8
:
526 return scm_from_size_t (sizeof (scm_t_uint8
));
527 case SCM_FOREIGN_TYPE_INT8
:
528 return scm_from_size_t (sizeof (scm_t_int8
));
529 case SCM_FOREIGN_TYPE_UINT16
:
530 return scm_from_size_t (sizeof (scm_t_uint16
));
531 case SCM_FOREIGN_TYPE_INT16
:
532 return scm_from_size_t (sizeof (scm_t_int16
));
533 case SCM_FOREIGN_TYPE_UINT32
:
534 return scm_from_size_t (sizeof (scm_t_uint32
));
535 case SCM_FOREIGN_TYPE_INT32
:
536 return scm_from_size_t (sizeof (scm_t_int32
));
537 case SCM_FOREIGN_TYPE_UINT64
:
538 return scm_from_size_t (sizeof (scm_t_uint64
));
539 case SCM_FOREIGN_TYPE_INT64
:
540 return scm_from_size_t (sizeof (scm_t_int64
));
542 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
545 else if (scm_is_eq (type
, sym_asterisk
))
547 return scm_from_size_t (sizeof (void*));
548 else if (scm_is_pair (type
))
552 while (scm_is_pair (type
))
554 off
= ROUND_UP (off
, scm_to_size_t (scm_alignof (scm_car (type
))));
555 off
+= scm_to_size_t (scm_sizeof (scm_car (type
)));
556 type
= scm_cdr (type
);
558 return scm_from_size_t (off
);
561 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
566 /* return 1 on success, 0 on failure */
568 parse_ffi_type (SCM type
, int return_p
, long *n_structs
, long *n_struct_elts
)
570 if (SCM_I_INUMP (type
))
572 if ((SCM_I_INUM (type
) < 0 )
573 || (SCM_I_INUM (type
) > SCM_FOREIGN_TYPE_LAST
))
575 else if (SCM_I_INUM (type
) == SCM_FOREIGN_TYPE_VOID
&& !return_p
)
580 else if (scm_is_eq (type
, sym_asterisk
))
587 len
= scm_ilength (type
);
592 if (!parse_ffi_type (scm_car (type
), 0, n_structs
, n_struct_elts
))
595 type
= scm_cdr (type
);
603 fill_ffi_type (SCM type
, ffi_type
*ftype
, ffi_type
***type_ptrs
,
606 if (SCM_I_INUMP (type
))
608 switch (SCM_I_INUM (type
))
610 case SCM_FOREIGN_TYPE_FLOAT
:
611 *ftype
= ffi_type_float
;
613 case SCM_FOREIGN_TYPE_DOUBLE
:
614 *ftype
= ffi_type_double
;
616 case SCM_FOREIGN_TYPE_UINT8
:
617 *ftype
= ffi_type_uint8
;
619 case SCM_FOREIGN_TYPE_INT8
:
620 *ftype
= ffi_type_sint8
;
622 case SCM_FOREIGN_TYPE_UINT16
:
623 *ftype
= ffi_type_uint16
;
625 case SCM_FOREIGN_TYPE_INT16
:
626 *ftype
= ffi_type_sint16
;
628 case SCM_FOREIGN_TYPE_UINT32
:
629 *ftype
= ffi_type_uint32
;
631 case SCM_FOREIGN_TYPE_INT32
:
632 *ftype
= ffi_type_sint32
;
634 case SCM_FOREIGN_TYPE_UINT64
:
635 *ftype
= ffi_type_uint64
;
637 case SCM_FOREIGN_TYPE_INT64
:
638 *ftype
= ffi_type_sint64
;
640 case SCM_FOREIGN_TYPE_VOID
:
641 *ftype
= ffi_type_void
;
644 scm_wrong_type_arg_msg ("pointer->procedure", 0, type
,
648 else if (scm_is_eq (type
, sym_asterisk
))
651 *ftype
= ffi_type_pointer
;
658 len
= scm_ilength (type
);
661 ftype
->alignment
= 0;
662 ftype
->type
= FFI_TYPE_STRUCT
;
663 ftype
->elements
= *type_ptrs
;
664 *type_ptrs
+= len
+ 1;
666 for (i
= 0; i
< len
; i
++)
668 ftype
->elements
[i
] = *types
;
670 fill_ffi_type (scm_car (type
), ftype
->elements
[i
],
672 type
= scm_cdr (type
);
674 ftype
->elements
[i
] = NULL
;
678 /* Return a "cif" (call interface) for the given RETURN_TYPE and
681 make_cif (SCM return_type
, SCM arg_types
, const char *caller
)
682 #define FUNC_NAME caller
685 long i
, nargs
, n_structs
, n_struct_elts
;
689 ffi_type
**type_ptrs
;
692 nargs
= scm_ilength (arg_types
);
693 SCM_ASSERT (nargs
>= 0, arg_types
, 3, FUNC_NAME
);
694 /* fixme: assert nargs < 1<<32 */
695 n_structs
= n_struct_elts
= 0;
697 /* For want of talloc, we're going to have to do this in two passes: first we
698 figure out how much memory is needed for all types, then we allocate the
699 cif and the types all in one block. */
700 if (!parse_ffi_type (return_type
, 1, &n_structs
, &n_struct_elts
))
701 scm_wrong_type_arg (FUNC_NAME
, 1, return_type
);
702 for (walk
= arg_types
; scm_is_pair (walk
); walk
= scm_cdr (walk
))
703 if (!parse_ffi_type (scm_car (walk
), 0, &n_structs
, &n_struct_elts
))
704 scm_wrong_type_arg (FUNC_NAME
, 3, scm_car (walk
));
706 /* the memory: with space for the cif itself */
707 cif_len
= sizeof (ffi_cif
);
709 /* then ffi_type pointers: one for each arg, one for each struct
710 element, and one for each struct (for null-termination) */
711 cif_len
= (ROUND_UP (cif_len
, alignof_type (void *))
712 + (nargs
+ n_structs
+ n_struct_elts
)*sizeof(void*));
714 /* then the ffi_type structs themselves, one per arg and struct element, and
715 one for the return val */
716 cif_len
= (ROUND_UP (cif_len
, alignof_type (ffi_type
))
717 + (nargs
+ n_struct_elts
+ 1)*sizeof(ffi_type
));
719 mem
= scm_gc_malloc_pointerless (cif_len
, "foreign");
720 /* ensure all the memory is initialized, even the holes */
721 memset (mem
, 0, cif_len
);
722 cif
= (ffi_cif
*) mem
;
724 /* reuse cif_len to walk through the mem */
725 cif_len
= ROUND_UP (sizeof (ffi_cif
), alignof_type (void *));
726 type_ptrs
= (ffi_type
**)(mem
+ cif_len
);
727 cif_len
= ROUND_UP (cif_len
728 + (nargs
+ n_structs
+ n_struct_elts
)*sizeof(void*),
729 alignof_type (ffi_type
));
730 types
= (ffi_type
*)(mem
+ cif_len
);
732 /* whew. now knit the pointers together. */
733 cif
->rtype
= types
++;
734 fill_ffi_type (return_type
, cif
->rtype
, &type_ptrs
, &types
);
735 cif
->arg_types
= type_ptrs
;
737 for (walk
= arg_types
, i
= 0; scm_is_pair (walk
); walk
= scm_cdr (walk
), i
++)
739 cif
->arg_types
[i
] = types
++;
740 fill_ffi_type (scm_car (walk
), cif
->arg_types
[i
], &type_ptrs
, &types
);
743 /* round out the cif, and we're done. */
744 cif
->abi
= FFI_DEFAULT_ABI
;
749 if (FFI_OK
!= ffi_prep_cif (cif
, FFI_DEFAULT_ABI
, cif
->nargs
, cif
->rtype
,
751 SCM_MISC_ERROR ("ffi_prep_cif failed", SCM_EOL
);
757 SCM_DEFINE (scm_pointer_to_procedure
, "pointer->procedure", 3, 0, 0,
758 (SCM return_type
, SCM func_ptr
, SCM arg_types
),
759 "Make a foreign function.\n\n"
760 "Given the foreign void pointer @var{func_ptr}, its argument and\n"
761 "return types @var{arg_types} and @var{return_type}, return a\n"
762 "procedure that will pass arguments to the foreign function\n"
763 "and return appropriate values.\n\n"
764 "@var{arg_types} should be a list of foreign types.\n"
765 "@code{return_type} should be a foreign type.")
766 #define FUNC_NAME s_scm_pointer_to_procedure
770 SCM_VALIDATE_POINTER (2, func_ptr
);
772 cif
= make_cif (return_type
, arg_types
, FUNC_NAME
);
774 return cif_to_procedure (scm_from_pointer (cif
, NULL
), func_ptr
);
780 /* Pre-generate trampolines for less than 10 arguments. */
782 #ifdef WORDS_BIGENDIAN
783 #define OBJCODE_HEADER 0, 0, 0, 8, 0, 0, 0, 40
784 #define META_HEADER 0, 0, 0, 32, 0, 0, 0, 0
786 #define OBJCODE_HEADER 8, 0, 0, 0, 40, 0, 0, 0
787 #define META_HEADER 32, 0, 0, 0, 0, 0, 0, 0
792 /* 0 */ scm_op_assert_nargs_ee, 0, nreq, /* assert number of args */ \
793 /* 3 */ scm_op_object_ref, 0, /* push the pair with the cif and the function pointer */ \
794 /* 5 */ scm_op_foreign_call, nreq, /* and call (will return value as well) */ \
795 /* 7 */ scm_op_nop, \
796 /* 8 */ META (3, 7, nreq)
798 #define META(start, end, nreq) \
800 /* 0 */ scm_op_make_eol, /* bindings */ \
801 /* 1 */ scm_op_make_eol, /* sources */ \
802 /* 2 */ scm_op_make_int8, start, scm_op_make_int8, end, /* arity: from ip N to ip N */ \
803 /* 6 */ scm_op_make_int8, nreq, /* the arity is N required args */ \
804 /* 8 */ scm_op_list, 0, 3, /* make a list of those 3 vals */ \
805 /* 11 */ scm_op_list, 0, 1, /* and the arities will be a list of that one list */ \
806 /* 14 */ scm_op_load_symbol, 0, 0, 4, 'n', 'a', 'm', 'e', /* `name' */ \
807 /* 22 */ scm_op_object_ref, 1, /* the name from the object table */ \
808 /* 24 */ scm_op_cons, /* make a pair for the properties */ \
809 /* 25 */ scm_op_list, 0, 4, /* pack bindings, sources, and arities into list */ \
810 /* 28 */ scm_op_return, /* and return */ \
811 /* 29 */ scm_op_nop, scm_op_nop, scm_op_nop \
816 scm_t_uint64 dummy
; /* ensure 8-byte alignment; perhaps there's a better way */
817 const scm_t_uint8 bytes
[10 * (sizeof (struct scm_objcode
) + 8
818 + sizeof (struct scm_objcode
) + 32)];
822 CODE (0), CODE (1), CODE (2), CODE (3), CODE (4),
823 CODE (5), CODE (6), CODE (7), CODE (8), CODE (9)
829 #undef OBJCODE_HEADER
833 (defun generate-objcode-cells (n)
834 "Generate objcode cells for up to N arguments"
839 (format " { STATIC_OBJCODE_TAG, SCM_PACK (raw_bytecode.bytes + %d) },\n"
840 (* (+ 4 4 8 4 4 32) i)))
841 (insert " { SCM_BOOL_F, SCM_PACK (0) },\n")
844 #define STATIC_OBJCODE_TAG \
845 SCM_PACK (SCM_MAKE_OBJCODE_TAG (SCM_OBJCODE_TYPE_STATIC, 0))
849 scm_t_uint64 dummy
; /* alignment */
850 scm_t_cell cells
[10 * 2]; /* 10 double cells */
853 /* C-u 1 0 M-x generate-objcode-cells RET */
855 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 0) },
856 { SCM_BOOL_F
, SCM_PACK (0) },
857 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 56) },
858 { SCM_BOOL_F
, SCM_PACK (0) },
859 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 112) },
860 { SCM_BOOL_F
, SCM_PACK (0) },
861 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 168) },
862 { SCM_BOOL_F
, SCM_PACK (0) },
863 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 224) },
864 { SCM_BOOL_F
, SCM_PACK (0) },
865 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 280) },
866 { SCM_BOOL_F
, SCM_PACK (0) },
867 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 336) },
868 { SCM_BOOL_F
, SCM_PACK (0) },
869 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 392) },
870 { SCM_BOOL_F
, SCM_PACK (0) },
871 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 448) },
872 { SCM_BOOL_F
, SCM_PACK (0) },
873 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 504) },
874 { SCM_BOOL_F
, SCM_PACK (0) }
878 static const SCM objcode_trampolines
[10] = {
879 SCM_PACK (objcode_cells
.cells
+0),
880 SCM_PACK (objcode_cells
.cells
+2),
881 SCM_PACK (objcode_cells
.cells
+4),
882 SCM_PACK (objcode_cells
.cells
+6),
883 SCM_PACK (objcode_cells
.cells
+8),
884 SCM_PACK (objcode_cells
.cells
+10),
885 SCM_PACK (objcode_cells
.cells
+12),
886 SCM_PACK (objcode_cells
.cells
+14),
887 SCM_PACK (objcode_cells
.cells
+16),
888 SCM_PACK (objcode_cells
.cells
+18),
892 cif_to_procedure (SCM cif
, SCM func_ptr
)
896 SCM objcode
, table
, ret
;
898 c_cif
= (ffi_cif
*) SCM_POINTER_VALUE (cif
);
899 nargs
= c_cif
->nargs
;
902 objcode
= objcode_trampolines
[nargs
];
904 scm_misc_error ("make-foreign-function", "args >= 10 currently unimplemented",
907 table
= scm_c_make_vector (2, SCM_UNDEFINED
);
908 SCM_SIMPLE_VECTOR_SET (table
, 0, scm_cons (cif
, func_ptr
));
909 SCM_SIMPLE_VECTOR_SET (table
, 1, SCM_BOOL_F
); /* name */
910 ret
= scm_make_program (objcode
, table
, SCM_BOOL_F
);
915 /* Set *LOC to the foreign representation of X with TYPE. */
917 unpack (const ffi_type
*type
, void *loc
, SCM x
, int return_value_p
)
918 #define FUNC_NAME "scm_i_foreign_call"
923 *(float *) loc
= scm_to_double (x
);
925 case FFI_TYPE_DOUBLE
:
926 *(double *) loc
= scm_to_double (x
);
929 /* For integer return values smaller than `int', libffi expects the
930 result in an `ffi_arg'-long buffer. */
934 *(ffi_arg
*) loc
= scm_to_uint8 (x
);
936 *(scm_t_uint8
*) loc
= scm_to_uint8 (x
);
940 *(ffi_arg
*) loc
= scm_to_int8 (x
);
942 *(scm_t_int8
*) loc
= scm_to_int8 (x
);
944 case FFI_TYPE_UINT16
:
946 *(ffi_arg
*) loc
= scm_to_uint16 (x
);
948 *(scm_t_uint16
*) loc
= scm_to_uint16 (x
);
950 case FFI_TYPE_SINT16
:
952 *(ffi_arg
*) loc
= scm_to_int16 (x
);
954 *(scm_t_int16
*) loc
= scm_to_int16 (x
);
956 case FFI_TYPE_UINT32
:
958 *(ffi_arg
*) loc
= scm_to_uint32 (x
);
960 *(scm_t_uint32
*) loc
= scm_to_uint32 (x
);
962 case FFI_TYPE_SINT32
:
964 *(ffi_arg
*) loc
= scm_to_int32 (x
);
966 *(scm_t_int32
*) loc
= scm_to_int32 (x
);
968 case FFI_TYPE_UINT64
:
969 *(scm_t_uint64
*) loc
= scm_to_uint64 (x
);
971 case FFI_TYPE_SINT64
:
972 *(scm_t_int64
*) loc
= scm_to_int64 (x
);
974 case FFI_TYPE_STRUCT
:
975 SCM_VALIDATE_POINTER (1, x
);
976 memcpy (loc
, SCM_POINTER_VALUE (x
), type
->size
);
978 case FFI_TYPE_POINTER
:
979 SCM_VALIDATE_POINTER (1, x
);
980 *(void **) loc
= SCM_POINTER_VALUE (x
);
991 /* Return a Scheme representation of the foreign value at LOC of type
992 TYPE. When RETURN_VALUE_P is true, LOC is assumed to point to a
993 return value buffer; otherwise LOC is assumed to point to an
996 pack (const ffi_type
* type
, const void *loc
, int return_value_p
)
1001 return SCM_UNSPECIFIED
;
1002 case FFI_TYPE_FLOAT
:
1003 return scm_from_double (*(float *) loc
);
1004 case FFI_TYPE_DOUBLE
:
1005 return scm_from_double (*(double *) loc
);
1007 /* For integer return values smaller than `int', libffi stores the
1008 result in an `ffi_arg'-long buffer, of which only the
1009 significant bits must be kept---hence the pair of casts below.
1010 See <http://thread.gmane.org/gmane.comp.lib.ffi.general/406>
1013 case FFI_TYPE_UINT8
:
1015 return scm_from_uint8 ((scm_t_uint8
) *(ffi_arg
*) loc
);
1017 return scm_from_uint8 (* (scm_t_uint8
*) loc
);
1018 case FFI_TYPE_SINT8
:
1020 return scm_from_int8 ((scm_t_int8
) *(ffi_arg
*) loc
);
1022 return scm_from_int8 (* (scm_t_int8
*) loc
);
1023 case FFI_TYPE_UINT16
:
1025 return scm_from_uint16 ((scm_t_uint16
) *(ffi_arg
*) loc
);
1027 return scm_from_uint16 (* (scm_t_uint16
*) loc
);
1028 case FFI_TYPE_SINT16
:
1030 return scm_from_int16 ((scm_t_int16
) *(ffi_arg
*) loc
);
1032 return scm_from_int16 (* (scm_t_int16
*) loc
);
1033 case FFI_TYPE_UINT32
:
1035 return scm_from_uint32 ((scm_t_uint32
) *(ffi_arg
*) loc
);
1037 return scm_from_uint32 (* (scm_t_uint32
*) loc
);
1038 case FFI_TYPE_SINT32
:
1040 return scm_from_int32 ((scm_t_int32
) *(ffi_arg
*) loc
);
1042 return scm_from_int32 (* (scm_t_int32
*) loc
);
1043 case FFI_TYPE_UINT64
:
1044 return scm_from_uint64 (*(scm_t_uint64
*) loc
);
1045 case FFI_TYPE_SINT64
:
1046 return scm_from_int64 (*(scm_t_int64
*) loc
);
1048 case FFI_TYPE_STRUCT
:
1050 void *mem
= scm_gc_malloc_pointerless (type
->size
, "foreign");
1051 memcpy (mem
, loc
, type
->size
);
1052 return scm_from_pointer (mem
, NULL
);
1054 case FFI_TYPE_POINTER
:
1055 return scm_from_pointer (*(void **) loc
, NULL
);
1063 scm_i_foreign_call (SCM foreign
, const SCM
*argv
)
1065 /* FOREIGN is the pair that cif_to_procedure set as the 0th element of the
1068 void (*func
) (void);
1076 cif
= SCM_POINTER_VALUE (SCM_CAR (foreign
));
1077 func
= SCM_POINTER_VALUE (SCM_CDR (foreign
));
1079 /* Argument pointers. */
1080 args
= alloca (sizeof (void *) * cif
->nargs
);
1082 /* Compute the worst-case amount of memory needed to store all the argument
1083 values. Note: as of libffi 3.0.9 `cif->bytes' is undocumented and is zero,
1084 so it can't be used for that purpose. */
1085 for (i
= 0, arg_size
= 0; i
< cif
->nargs
; i
++)
1086 arg_size
+= cif
->arg_types
[i
]->size
+ cif
->arg_types
[i
]->alignment
- 1;
1088 /* Space for argument values, followed by return value. */
1089 data
= alloca (arg_size
+ cif
->rtype
->size
1090 + max (sizeof (void *), cif
->rtype
->alignment
));
1092 /* Unpack ARGV to native values, setting ARGV pointers. */
1093 for (i
= 0, off
= 0;
1095 off
= (scm_t_uint8
*) args
[i
] - data
+ cif
->arg_types
[i
]->size
,
1098 /* Suitably align the storage area for argument I. */
1099 args
[i
] = (void *) ROUND_UP ((scm_t_uintptr
) data
+ off
,
1100 cif
->arg_types
[i
]->alignment
);
1101 assert ((scm_t_uintptr
) args
[i
] % cif
->arg_types
[i
]->alignment
== 0);
1102 unpack (cif
->arg_types
[i
], args
[i
], argv
[i
], 0);
1105 /* Prepare space for the return value. On some platforms, such as
1106 `armv5tel-*-linux-gnueabi', the return value has to be at least
1107 word-aligned, even if its type doesn't have any alignment requirement as is
1108 the case with `char'. */
1109 rvalue
= (void *) ROUND_UP ((scm_t_uintptr
) data
+ off
,
1110 max (sizeof (void *), cif
->rtype
->alignment
));
1113 ffi_call (cif
, func
, rvalue
, args
);
1115 return pack (cif
->rtype
, rvalue
, 1);
1119 /* Function pointers aka. "callbacks" or "closures". */
1123 /* Trampoline to invoke a libffi closure that wraps a Scheme
1126 invoke_closure (ffi_cif
*cif
, void *ret
, void **args
, void *data
)
1129 SCM proc
, *argv
, result
;
1131 proc
= PTR2SCM (data
);
1133 argv
= alloca (cif
->nargs
* sizeof (*argv
));
1135 /* Pack ARGS to SCM values, setting ARGV pointers. */
1136 for (i
= 0; i
< cif
->nargs
; i
++)
1137 argv
[i
] = pack (cif
->arg_types
[i
], args
[i
], 0);
1139 result
= scm_call_n (proc
, argv
, cif
->nargs
);
1141 unpack (cif
->rtype
, ret
, result
, 1);
1144 SCM_DEFINE (scm_procedure_to_pointer
, "procedure->pointer", 3, 0, 0,
1145 (SCM return_type
, SCM proc
, SCM arg_types
),
1146 "Return a pointer to a C function of type @var{return-type}\n"
1147 "taking arguments of types @var{arg-types} (a list) and\n"
1148 "behaving as a proxy to procedure @var{proc}. Thus\n"
1149 "@var{proc}'s arity, supported argument types, and return\n"
1150 "type should match @var{return-type} and @var{arg-types}.\n")
1151 #define FUNC_NAME s_scm_procedure_to_pointer
1153 SCM cif_pointer
, pointer
;
1156 void *closure
, *executable
;
1158 cif
= make_cif (return_type
, arg_types
, FUNC_NAME
);
1160 closure
= ffi_closure_alloc (sizeof (ffi_closure
), &executable
);
1161 err
= ffi_prep_closure_loc ((ffi_closure
*) closure
, cif
,
1162 invoke_closure
, SCM2PTR (proc
),
1166 ffi_closure_free (closure
);
1167 SCM_MISC_ERROR ("`ffi_prep_closure_loc' failed", SCM_EOL
);
1170 /* CIF points to GC-managed memory and it should remain as long as
1171 POINTER (see below) is live. Wrap it in a Scheme pointer to then
1172 hold a weak reference on it. */
1173 cif_pointer
= scm_from_pointer (cif
, NULL
);
1175 if (closure
== executable
)
1177 pointer
= scm_from_pointer (executable
, ffi_closure_free
);
1178 register_weak_reference (pointer
,
1179 scm_list_2 (proc
, cif_pointer
));
1183 /* CLOSURE needs to be freed eventually. However, since
1184 `GC_all_interior_pointers' is disabled, we can't just register
1185 a finalizer for CLOSURE. Instead, we create a pointer object
1186 for CLOSURE, with a finalizer, and register it as a weak
1187 reference of POINTER. */
1190 pointer
= scm_from_pointer (executable
, NULL
);
1191 friend = scm_from_pointer (closure
, ffi_closure_free
);
1193 register_weak_reference (pointer
,
1194 scm_list_3 (proc
, cif_pointer
, friend));
1201 #endif /* FFI_CLOSURES */
1206 scm_init_foreign (void)
1208 #ifndef SCM_MAGIC_SNARFER
1209 #include "libguile/foreign.x"
1211 scm_define (sym_void
, scm_from_uint8 (SCM_FOREIGN_TYPE_VOID
));
1212 scm_define (sym_float
, scm_from_uint8 (SCM_FOREIGN_TYPE_FLOAT
));
1213 scm_define (sym_double
, scm_from_uint8 (SCM_FOREIGN_TYPE_DOUBLE
));
1214 scm_define (sym_uint8
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT8
));
1215 scm_define (sym_int8
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT8
));
1216 scm_define (sym_uint16
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT16
));
1217 scm_define (sym_int16
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT16
));
1218 scm_define (sym_uint32
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
));
1219 scm_define (sym_int32
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
));
1220 scm_define (sym_uint64
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
));
1221 scm_define (sym_int64
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
));
1223 scm_define (sym_short
,
1224 #if SIZEOF_SHORT == 8
1225 scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
)
1226 #elif SIZEOF_SHORT == 4
1227 scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
)
1228 #elif SIZEOF_SHORT == 2
1229 scm_from_uint8 (SCM_FOREIGN_TYPE_INT16
)
1231 # error unsupported sizeof (short)
1235 scm_define (sym_unsigned_short
,
1236 #if SIZEOF_SHORT == 8
1237 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1238 #elif SIZEOF_SHORT == 4
1239 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1240 #elif SIZEOF_SHORT == 2
1241 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT16
)
1243 # error unsupported sizeof (short)
1247 scm_define (sym_int
,
1249 scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
)
1250 #elif SIZEOF_INT == 4
1251 scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
)
1253 # error unsupported sizeof (int)
1257 scm_define (sym_unsigned_int
,
1258 #if SIZEOF_UNSIGNED_INT == 8
1259 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1260 #elif SIZEOF_UNSIGNED_INT == 4
1261 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1263 # error unsupported sizeof (unsigned int)
1267 scm_define (sym_long
,
1268 #if SIZEOF_LONG == 8
1269 scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
)
1270 #elif SIZEOF_LONG == 4
1271 scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
)
1273 # error unsupported sizeof (long)
1277 scm_define (sym_unsigned_long
,
1278 #if SIZEOF_UNSIGNED_LONG == 8
1279 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1280 #elif SIZEOF_UNSIGNED_LONG == 4
1281 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1283 # error unsupported sizeof (unsigned long)
1287 scm_define (sym_size_t
,
1288 #if SIZEOF_SIZE_T == 8
1289 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1290 #elif SIZEOF_SIZE_T == 4
1291 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1293 # error unsupported sizeof (size_t)
1297 null_pointer
= scm_cell (scm_tc7_pointer
, 0);
1298 scm_define (sym_null
, null_pointer
);
1302 scm_register_foreign (void)
1304 scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION
,
1306 (scm_t_extension_init_func
)scm_init_foreign
,
1308 pointer_weak_refs
= scm_make_weak_key_hash_table (SCM_UNDEFINED
);