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_to_pointer (SCM pointer
)
144 #define FUNC_NAME "scm_to_pointer"
146 SCM_VALIDATE_POINTER (1, pointer
);
147 return SCM_POINTER_VALUE (pointer
);
152 scm_from_pointer (void *ptr
, scm_t_pointer_finalizer finalizer
)
156 if (ptr
== NULL
&& finalizer
== NULL
)
160 ret
= scm_cell (scm_tc7_pointer
, (scm_t_bits
) ptr
);
164 /* Register a finalizer for the newly created instance. */
165 GC_finalization_proc prev_finalizer
;
166 GC_PTR prev_finalizer_data
;
167 GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (ret
),
168 pointer_finalizer_trampoline
,
171 &prev_finalizer_data
);
178 SCM_DEFINE (scm_pointer_address
, "pointer-address", 1, 0, 0,
180 "Return the numerical value of @var{pointer}.")
181 #define FUNC_NAME s_scm_pointer_address
183 SCM_VALIDATE_POINTER (1, pointer
);
185 return scm_from_uintptr ((scm_t_uintptr
) SCM_POINTER_VALUE (pointer
));
189 SCM_DEFINE (scm_pointer_to_scm
, "pointer->scm", 1, 0, 0,
191 "Unsafely cast @var{pointer} to a Scheme object.\n"
192 "Cross your fingers!")
193 #define FUNC_NAME s_scm_pointer_to_scm
195 SCM_VALIDATE_POINTER (1, pointer
);
197 return SCM_PACK ((scm_t_bits
) SCM_POINTER_VALUE (pointer
));
201 SCM_DEFINE (scm_scm_to_pointer
, "scm->pointer", 1, 0, 0,
203 "Return a foreign pointer object with the @code{object-address}\n"
205 #define FUNC_NAME s_scm_scm_to_pointer
209 ret
= scm_from_pointer ((void*) SCM_UNPACK (scm
), NULL
);
211 register_weak_reference (ret
, scm
);
217 SCM_DEFINE (scm_pointer_to_bytevector
, "pointer->bytevector", 2, 2, 0,
218 (SCM pointer
, SCM len
, SCM offset
, SCM uvec_type
),
219 "Return a bytevector aliasing the @var{len} bytes pointed\n"
220 "to by @var{pointer}.\n\n"
221 "The user may specify an alternate default interpretation for\n"
222 "the memory by passing the @var{uvec_type} argument, to indicate\n"
223 "that the memory is an array of elements of that type.\n"
224 "@var{uvec_type} should be something that\n"
225 "@code{uniform-vector-element-type} would return, like @code{f32}\n"
227 "When @var{offset} is passed, it specifies the offset in bytes\n"
228 "relative to @var{pointer} of the memory region aliased by the\n"
229 "returned bytevector.")
230 #define FUNC_NAME s_scm_pointer_to_bytevector
234 size_t boffset
, blen
;
235 scm_t_array_element_type btype
;
237 SCM_VALIDATE_POINTER (1, pointer
);
238 ptr
= SCM_POINTER_VALUE (pointer
);
240 if (SCM_UNLIKELY (ptr
== NULL
))
241 null_pointer_error (FUNC_NAME
);
243 if (SCM_UNBNDP (uvec_type
))
244 btype
= SCM_ARRAY_ELEMENT_TYPE_VU8
;
248 for (i
= 0; i
<= SCM_ARRAY_ELEMENT_TYPE_LAST
; i
++)
249 if (scm_is_eq (uvec_type
, scm_i_array_element_types
[i
]))
253 case SCM_ARRAY_ELEMENT_TYPE_VU8
:
254 case SCM_ARRAY_ELEMENT_TYPE_U8
:
255 case SCM_ARRAY_ELEMENT_TYPE_S8
:
256 case SCM_ARRAY_ELEMENT_TYPE_U16
:
257 case SCM_ARRAY_ELEMENT_TYPE_S16
:
258 case SCM_ARRAY_ELEMENT_TYPE_U32
:
259 case SCM_ARRAY_ELEMENT_TYPE_S32
:
260 case SCM_ARRAY_ELEMENT_TYPE_U64
:
261 case SCM_ARRAY_ELEMENT_TYPE_S64
:
262 case SCM_ARRAY_ELEMENT_TYPE_F32
:
263 case SCM_ARRAY_ELEMENT_TYPE_F64
:
264 case SCM_ARRAY_ELEMENT_TYPE_C32
:
265 case SCM_ARRAY_ELEMENT_TYPE_C64
:
269 scm_wrong_type_arg_msg (FUNC_NAME
, SCM_ARG1
, uvec_type
,
270 "uniform vector type");
274 if (SCM_UNBNDP (offset
))
277 boffset
= scm_to_size_t (offset
);
279 blen
= scm_to_size_t (len
);
281 ret
= scm_c_take_typed_bytevector ((signed char *) ptr
+ boffset
,
283 register_weak_reference (ret
, pointer
);
288 SCM_DEFINE (scm_bytevector_to_pointer
, "bytevector->pointer", 1, 1, 0,
289 (SCM bv
, SCM offset
),
290 "Return a pointer pointer aliasing the memory pointed to by\n"
291 "@var{bv} or @var{offset} bytes after @var{bv} when @var{offset}\n"
293 #define FUNC_NAME s_scm_bytevector_to_pointer
299 SCM_VALIDATE_BYTEVECTOR (1, bv
);
300 ptr
= SCM_BYTEVECTOR_CONTENTS (bv
);
302 if (SCM_UNBNDP (offset
))
305 boffset
= scm_to_unsigned_integer (offset
, 0,
306 SCM_BYTEVECTOR_LENGTH (bv
) - 1);
308 ret
= scm_from_pointer (ptr
+ boffset
, NULL
);
309 register_weak_reference (ret
, bv
);
314 SCM_DEFINE (scm_set_pointer_finalizer_x
, "set-pointer-finalizer!", 2, 0, 0,
315 (SCM pointer
, SCM finalizer
),
316 "Arrange for the C procedure wrapped by @var{finalizer} to be\n"
317 "called on the pointer wrapped by @var{pointer} when @var{pointer}\n"
318 "becomes unreachable. Note: the C procedure should not call into\n"
319 "Scheme. If you need a Scheme finalizer, use guardians.")
320 #define FUNC_NAME s_scm_set_pointer_finalizer_x
323 GC_finalization_proc prev_finalizer
;
324 GC_PTR prev_finalizer_data
;
326 SCM_VALIDATE_POINTER (1, pointer
);
327 SCM_VALIDATE_POINTER (2, finalizer
);
329 c_finalizer
= SCM_POINTER_VALUE (finalizer
);
331 GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (pointer
),
332 pointer_finalizer_trampoline
,
335 &prev_finalizer_data
);
337 return SCM_UNSPECIFIED
;
342 scm_i_pointer_print (SCM pointer
, SCM port
, scm_print_state
*pstate
)
344 scm_puts ("#<pointer 0x", port
);
345 scm_uintprint (scm_to_uintptr (scm_pointer_address (pointer
)), 16, port
);
346 scm_putc ('>', port
);
350 /* Non-primitive helpers functions. These procedures could be
351 implemented in terms of the primitives above but would be inefficient
352 (heap allocation overhead, Scheme/C round trips, etc.) */
354 SCM_DEFINE (scm_dereference_pointer
, "dereference-pointer", 1, 0, 0,
356 "Assuming @var{pointer} points to a memory region that\n"
357 "holds a pointer, return this pointer.")
358 #define FUNC_NAME s_scm_dereference_pointer
360 SCM_VALIDATE_POINTER (1, pointer
);
362 return scm_from_pointer (* (void **) SCM_POINTER_VALUE (pointer
), NULL
);
366 SCM_DEFINE (scm_string_to_pointer
, "string->pointer", 1, 1, 0,
367 (SCM string
, SCM encoding
),
368 "Return a foreign pointer to a nul-terminated copy of\n"
369 "@var{string} in the given @var{encoding}, defaulting to\n"
370 "the current locale encoding. The C string is freed when\n"
371 "the returned foreign pointer becomes unreachable.\n\n"
372 "This is the Scheme equivalent of @code{scm_to_stringn}.")
373 #define FUNC_NAME s_scm_string_to_pointer
375 SCM_VALIDATE_STRING (1, string
);
377 /* XXX: Finalizers slow down libgc; they could be avoided if
378 `scm_to_string' & co. were able to use libgc-allocated memory. */
380 if (SCM_UNBNDP (encoding
))
381 return scm_from_pointer (scm_to_locale_string (string
), free
);
387 SCM_VALIDATE_STRING (2, encoding
);
389 enc
= scm_to_locale_string (encoding
);
390 scm_dynwind_begin (0);
391 scm_dynwind_free (enc
);
393 ret
= scm_from_pointer
394 (scm_to_stringn (string
, NULL
, enc
,
395 scm_i_get_conversion_strategy (SCM_BOOL_F
)),
405 SCM_DEFINE (scm_pointer_to_string
, "pointer->string", 1, 2, 0,
406 (SCM pointer
, SCM length
, SCM encoding
),
407 "Return the string representing the C string pointed to by\n"
408 "@var{pointer}. If @var{length} is omitted or @code{-1}, the\n"
409 "string is assumed to be nul-terminated. Otherwise\n"
410 "@var{length} is the number of bytes in memory pointed to by\n"
411 "@var{pointer}. The C string is assumed to be in the given\n"
412 "@var{encoding}, defaulting to the current locale encoding.\n\n"
413 "This is the Scheme equivalent of @code{scm_from_stringn}.")
414 #define FUNC_NAME s_scm_pointer_to_string
418 SCM_VALIDATE_POINTER (1, pointer
);
420 if (SCM_UNBNDP (length
)
421 || scm_is_true (scm_eqv_p (length
, scm_from_int (-1))))
424 len
= scm_to_size_t (length
);
426 if (SCM_UNBNDP (encoding
))
427 return scm_from_locale_stringn (SCM_POINTER_VALUE (pointer
), len
);
433 SCM_VALIDATE_STRING (3, encoding
);
435 enc
= scm_to_locale_string (encoding
);
436 scm_dynwind_begin (0);
437 scm_dynwind_free (enc
);
439 ret
= scm_from_stringn (SCM_POINTER_VALUE (pointer
), len
, enc
,
440 scm_i_get_conversion_strategy (SCM_BOOL_F
));
451 SCM_DEFINE (scm_alignof
, "alignof", 1, 0, 0, (SCM type
),
452 "Return the alignment of @var{type}, in bytes.\n\n"
453 "@var{type} should be a valid C type, like @code{int}.\n"
454 "Alternately @var{type} may be the symbol @code{*}, in which\n"
455 "case the alignment of a pointer is returned. @var{type} may\n"
456 "also be a list of types, in which case the alignment of a\n"
457 "@code{struct} with ABI-conventional packing is returned.")
458 #define FUNC_NAME s_scm_alignof
460 if (SCM_I_INUMP (type
))
462 switch (SCM_I_INUM (type
))
464 case SCM_FOREIGN_TYPE_FLOAT
:
465 return scm_from_size_t (alignof_type (float));
466 case SCM_FOREIGN_TYPE_DOUBLE
:
467 return scm_from_size_t (alignof_type (double));
468 case SCM_FOREIGN_TYPE_UINT8
:
469 return scm_from_size_t (alignof_type (scm_t_uint8
));
470 case SCM_FOREIGN_TYPE_INT8
:
471 return scm_from_size_t (alignof_type (scm_t_int8
));
472 case SCM_FOREIGN_TYPE_UINT16
:
473 return scm_from_size_t (alignof_type (scm_t_uint16
));
474 case SCM_FOREIGN_TYPE_INT16
:
475 return scm_from_size_t (alignof_type (scm_t_int16
));
476 case SCM_FOREIGN_TYPE_UINT32
:
477 return scm_from_size_t (alignof_type (scm_t_uint32
));
478 case SCM_FOREIGN_TYPE_INT32
:
479 return scm_from_size_t (alignof_type (scm_t_int32
));
480 case SCM_FOREIGN_TYPE_UINT64
:
481 return scm_from_size_t (alignof_type (scm_t_uint64
));
482 case SCM_FOREIGN_TYPE_INT64
:
483 return scm_from_size_t (alignof_type (scm_t_int64
));
485 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
488 else if (scm_is_eq (type
, sym_asterisk
))
490 return scm_from_size_t (alignof_type (void*));
491 else if (scm_is_pair (type
))
493 /* TYPE is a structure. Section 3-3 of the i386, x86_64, PowerPC,
494 and SPARC P.S. of the System V ABI all say: "Aggregates
495 (structures and arrays) and unions assume the alignment of
496 their most strictly aligned component." */
499 for (max
= 0; scm_is_pair (type
); type
= SCM_CDR (type
))
503 align
= scm_to_size_t (scm_alignof (SCM_CAR (type
)));
508 return scm_from_size_t (max
);
511 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
515 SCM_DEFINE (scm_sizeof
, "sizeof", 1, 0, 0, (SCM type
),
516 "Return the size of @var{type}, in bytes.\n\n"
517 "@var{type} should be a valid C type, like @code{int}.\n"
518 "Alternately @var{type} may be the symbol @code{*}, in which\n"
519 "case the size of a pointer is returned. @var{type} may also\n"
520 "be a list of types, in which case the size of a @code{struct}\n"
521 "with ABI-conventional packing is returned.")
522 #define FUNC_NAME s_scm_sizeof
524 if (SCM_I_INUMP (type
))
526 switch (SCM_I_INUM (type
))
528 case SCM_FOREIGN_TYPE_FLOAT
:
529 return scm_from_size_t (sizeof (float));
530 case SCM_FOREIGN_TYPE_DOUBLE
:
531 return scm_from_size_t (sizeof (double));
532 case SCM_FOREIGN_TYPE_UINT8
:
533 return scm_from_size_t (sizeof (scm_t_uint8
));
534 case SCM_FOREIGN_TYPE_INT8
:
535 return scm_from_size_t (sizeof (scm_t_int8
));
536 case SCM_FOREIGN_TYPE_UINT16
:
537 return scm_from_size_t (sizeof (scm_t_uint16
));
538 case SCM_FOREIGN_TYPE_INT16
:
539 return scm_from_size_t (sizeof (scm_t_int16
));
540 case SCM_FOREIGN_TYPE_UINT32
:
541 return scm_from_size_t (sizeof (scm_t_uint32
));
542 case SCM_FOREIGN_TYPE_INT32
:
543 return scm_from_size_t (sizeof (scm_t_int32
));
544 case SCM_FOREIGN_TYPE_UINT64
:
545 return scm_from_size_t (sizeof (scm_t_uint64
));
546 case SCM_FOREIGN_TYPE_INT64
:
547 return scm_from_size_t (sizeof (scm_t_int64
));
549 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
552 else if (scm_is_eq (type
, sym_asterisk
))
554 return scm_from_size_t (sizeof (void*));
555 else if (scm_is_pair (type
))
559 while (scm_is_pair (type
))
561 off
= ROUND_UP (off
, scm_to_size_t (scm_alignof (scm_car (type
))));
562 off
+= scm_to_size_t (scm_sizeof (scm_car (type
)));
563 type
= scm_cdr (type
);
565 return scm_from_size_t (off
);
568 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
573 /* return 1 on success, 0 on failure */
575 parse_ffi_type (SCM type
, int return_p
, long *n_structs
, long *n_struct_elts
)
577 if (SCM_I_INUMP (type
))
579 if ((SCM_I_INUM (type
) < 0 )
580 || (SCM_I_INUM (type
) > SCM_FOREIGN_TYPE_LAST
))
582 else if (SCM_I_INUM (type
) == SCM_FOREIGN_TYPE_VOID
&& !return_p
)
587 else if (scm_is_eq (type
, sym_asterisk
))
594 len
= scm_ilength (type
);
599 if (!parse_ffi_type (scm_car (type
), 0, n_structs
, n_struct_elts
))
602 type
= scm_cdr (type
);
610 fill_ffi_type (SCM type
, ffi_type
*ftype
, ffi_type
***type_ptrs
,
613 if (SCM_I_INUMP (type
))
615 switch (SCM_I_INUM (type
))
617 case SCM_FOREIGN_TYPE_FLOAT
:
618 *ftype
= ffi_type_float
;
620 case SCM_FOREIGN_TYPE_DOUBLE
:
621 *ftype
= ffi_type_double
;
623 case SCM_FOREIGN_TYPE_UINT8
:
624 *ftype
= ffi_type_uint8
;
626 case SCM_FOREIGN_TYPE_INT8
:
627 *ftype
= ffi_type_sint8
;
629 case SCM_FOREIGN_TYPE_UINT16
:
630 *ftype
= ffi_type_uint16
;
632 case SCM_FOREIGN_TYPE_INT16
:
633 *ftype
= ffi_type_sint16
;
635 case SCM_FOREIGN_TYPE_UINT32
:
636 *ftype
= ffi_type_uint32
;
638 case SCM_FOREIGN_TYPE_INT32
:
639 *ftype
= ffi_type_sint32
;
641 case SCM_FOREIGN_TYPE_UINT64
:
642 *ftype
= ffi_type_uint64
;
644 case SCM_FOREIGN_TYPE_INT64
:
645 *ftype
= ffi_type_sint64
;
647 case SCM_FOREIGN_TYPE_VOID
:
648 *ftype
= ffi_type_void
;
651 scm_wrong_type_arg_msg ("pointer->procedure", 0, type
,
655 else if (scm_is_eq (type
, sym_asterisk
))
658 *ftype
= ffi_type_pointer
;
665 len
= scm_ilength (type
);
668 ftype
->alignment
= 0;
669 ftype
->type
= FFI_TYPE_STRUCT
;
670 ftype
->elements
= *type_ptrs
;
671 *type_ptrs
+= len
+ 1;
673 for (i
= 0; i
< len
; i
++)
675 ftype
->elements
[i
] = *types
;
677 fill_ffi_type (scm_car (type
), ftype
->elements
[i
],
679 type
= scm_cdr (type
);
681 ftype
->elements
[i
] = NULL
;
685 /* Return a "cif" (call interface) for the given RETURN_TYPE and
688 make_cif (SCM return_type
, SCM arg_types
, const char *caller
)
689 #define FUNC_NAME caller
692 long i
, nargs
, n_structs
, n_struct_elts
;
696 ffi_type
**type_ptrs
;
699 nargs
= scm_ilength (arg_types
);
700 SCM_ASSERT (nargs
>= 0, arg_types
, 3, FUNC_NAME
);
701 /* fixme: assert nargs < 1<<32 */
702 n_structs
= n_struct_elts
= 0;
704 /* For want of talloc, we're going to have to do this in two passes: first we
705 figure out how much memory is needed for all types, then we allocate the
706 cif and the types all in one block. */
707 if (!parse_ffi_type (return_type
, 1, &n_structs
, &n_struct_elts
))
708 scm_wrong_type_arg (FUNC_NAME
, 1, return_type
);
709 for (walk
= arg_types
; scm_is_pair (walk
); walk
= scm_cdr (walk
))
710 if (!parse_ffi_type (scm_car (walk
), 0, &n_structs
, &n_struct_elts
))
711 scm_wrong_type_arg (FUNC_NAME
, 3, scm_car (walk
));
713 /* the memory: with space for the cif itself */
714 cif_len
= sizeof (ffi_cif
);
716 /* then ffi_type pointers: one for each arg, one for each struct
717 element, and one for each struct (for null-termination) */
718 cif_len
= (ROUND_UP (cif_len
, alignof_type (void *))
719 + (nargs
+ n_structs
+ n_struct_elts
)*sizeof(void*));
721 /* then the ffi_type structs themselves, one per arg and struct element, and
722 one for the return val */
723 cif_len
= (ROUND_UP (cif_len
, alignof_type (ffi_type
))
724 + (nargs
+ n_struct_elts
+ 1)*sizeof(ffi_type
));
726 mem
= scm_gc_malloc_pointerless (cif_len
, "foreign");
727 /* ensure all the memory is initialized, even the holes */
728 memset (mem
, 0, cif_len
);
729 cif
= (ffi_cif
*) mem
;
731 /* reuse cif_len to walk through the mem */
732 cif_len
= ROUND_UP (sizeof (ffi_cif
), alignof_type (void *));
733 type_ptrs
= (ffi_type
**)(mem
+ cif_len
);
734 cif_len
= ROUND_UP (cif_len
735 + (nargs
+ n_structs
+ n_struct_elts
)*sizeof(void*),
736 alignof_type (ffi_type
));
737 types
= (ffi_type
*)(mem
+ cif_len
);
739 /* whew. now knit the pointers together. */
740 cif
->rtype
= types
++;
741 fill_ffi_type (return_type
, cif
->rtype
, &type_ptrs
, &types
);
742 cif
->arg_types
= type_ptrs
;
744 for (walk
= arg_types
, i
= 0; scm_is_pair (walk
); walk
= scm_cdr (walk
), i
++)
746 cif
->arg_types
[i
] = types
++;
747 fill_ffi_type (scm_car (walk
), cif
->arg_types
[i
], &type_ptrs
, &types
);
750 /* round out the cif, and we're done. */
751 cif
->abi
= FFI_DEFAULT_ABI
;
756 if (FFI_OK
!= ffi_prep_cif (cif
, FFI_DEFAULT_ABI
, cif
->nargs
, cif
->rtype
,
758 SCM_MISC_ERROR ("ffi_prep_cif failed", SCM_EOL
);
764 SCM_DEFINE (scm_pointer_to_procedure
, "pointer->procedure", 3, 0, 0,
765 (SCM return_type
, SCM func_ptr
, SCM arg_types
),
766 "Make a foreign function.\n\n"
767 "Given the foreign void pointer @var{func_ptr}, its argument and\n"
768 "return types @var{arg_types} and @var{return_type}, return a\n"
769 "procedure that will pass arguments to the foreign function\n"
770 "and return appropriate values.\n\n"
771 "@var{arg_types} should be a list of foreign types.\n"
772 "@code{return_type} should be a foreign type.")
773 #define FUNC_NAME s_scm_pointer_to_procedure
777 SCM_VALIDATE_POINTER (2, func_ptr
);
779 cif
= make_cif (return_type
, arg_types
, FUNC_NAME
);
781 return cif_to_procedure (scm_from_pointer (cif
, NULL
), func_ptr
);
787 /* Pre-generate trampolines for less than 10 arguments. */
789 #ifdef WORDS_BIGENDIAN
790 #define OBJCODE_HEADER 0, 0, 0, 8, 0, 0, 0, 40
791 #define META_HEADER 0, 0, 0, 32, 0, 0, 0, 0
793 #define OBJCODE_HEADER 8, 0, 0, 0, 40, 0, 0, 0
794 #define META_HEADER 32, 0, 0, 0, 0, 0, 0, 0
799 /* 0 */ scm_op_assert_nargs_ee, 0, nreq, /* assert number of args */ \
800 /* 3 */ scm_op_object_ref, 0, /* push the pair with the cif and the function pointer */ \
801 /* 5 */ scm_op_foreign_call, nreq, /* and call (will return value as well) */ \
802 /* 7 */ scm_op_nop, \
803 /* 8 */ META (3, 7, nreq)
805 #define META(start, end, nreq) \
807 /* 0 */ scm_op_make_eol, /* bindings */ \
808 /* 1 */ scm_op_make_eol, /* sources */ \
809 /* 2 */ scm_op_make_int8, start, scm_op_make_int8, end, /* arity: from ip N to ip N */ \
810 /* 6 */ scm_op_make_int8, nreq, /* the arity is N required args */ \
811 /* 8 */ scm_op_list, 0, 3, /* make a list of those 3 vals */ \
812 /* 11 */ scm_op_list, 0, 1, /* and the arities will be a list of that one list */ \
813 /* 14 */ scm_op_load_symbol, 0, 0, 4, 'n', 'a', 'm', 'e', /* `name' */ \
814 /* 22 */ scm_op_object_ref, 1, /* the name from the object table */ \
815 /* 24 */ scm_op_cons, /* make a pair for the properties */ \
816 /* 25 */ scm_op_list, 0, 4, /* pack bindings, sources, and arities into list */ \
817 /* 28 */ scm_op_return, /* and return */ \
818 /* 29 */ scm_op_nop, scm_op_nop, scm_op_nop \
823 scm_t_uint64 dummy
; /* ensure 8-byte alignment; perhaps there's a better way */
824 const scm_t_uint8 bytes
[10 * (sizeof (struct scm_objcode
) + 8
825 + sizeof (struct scm_objcode
) + 32)];
829 CODE (0), CODE (1), CODE (2), CODE (3), CODE (4),
830 CODE (5), CODE (6), CODE (7), CODE (8), CODE (9)
836 #undef OBJCODE_HEADER
840 (defun generate-objcode-cells (n)
841 "Generate objcode cells for up to N arguments"
846 (format " { STATIC_OBJCODE_TAG, SCM_PACK (raw_bytecode.bytes + %d) },\n"
847 (* (+ 4 4 8 4 4 32) i)))
848 (insert " { SCM_BOOL_F, SCM_PACK (0) },\n")
851 #define STATIC_OBJCODE_TAG \
852 SCM_PACK (SCM_MAKE_OBJCODE_TAG (SCM_OBJCODE_TYPE_STATIC, 0))
856 scm_t_uint64 dummy
; /* alignment */
857 scm_t_cell cells
[10 * 2]; /* 10 double cells */
860 /* C-u 1 0 M-x generate-objcode-cells RET */
862 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 0) },
863 { SCM_BOOL_F
, SCM_PACK (0) },
864 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 56) },
865 { SCM_BOOL_F
, SCM_PACK (0) },
866 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 112) },
867 { SCM_BOOL_F
, SCM_PACK (0) },
868 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 168) },
869 { SCM_BOOL_F
, SCM_PACK (0) },
870 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 224) },
871 { SCM_BOOL_F
, SCM_PACK (0) },
872 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 280) },
873 { SCM_BOOL_F
, SCM_PACK (0) },
874 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 336) },
875 { SCM_BOOL_F
, SCM_PACK (0) },
876 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 392) },
877 { SCM_BOOL_F
, SCM_PACK (0) },
878 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 448) },
879 { SCM_BOOL_F
, SCM_PACK (0) },
880 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 504) },
881 { SCM_BOOL_F
, SCM_PACK (0) }
885 static const SCM objcode_trampolines
[10] = {
886 SCM_PACK (objcode_cells
.cells
+0),
887 SCM_PACK (objcode_cells
.cells
+2),
888 SCM_PACK (objcode_cells
.cells
+4),
889 SCM_PACK (objcode_cells
.cells
+6),
890 SCM_PACK (objcode_cells
.cells
+8),
891 SCM_PACK (objcode_cells
.cells
+10),
892 SCM_PACK (objcode_cells
.cells
+12),
893 SCM_PACK (objcode_cells
.cells
+14),
894 SCM_PACK (objcode_cells
.cells
+16),
895 SCM_PACK (objcode_cells
.cells
+18),
899 cif_to_procedure (SCM cif
, SCM func_ptr
)
903 SCM objcode
, table
, ret
;
905 c_cif
= (ffi_cif
*) SCM_POINTER_VALUE (cif
);
906 nargs
= c_cif
->nargs
;
909 objcode
= objcode_trampolines
[nargs
];
911 scm_misc_error ("make-foreign-function", "args >= 10 currently unimplemented",
914 table
= scm_c_make_vector (2, SCM_UNDEFINED
);
915 SCM_SIMPLE_VECTOR_SET (table
, 0, scm_cons (cif
, func_ptr
));
916 SCM_SIMPLE_VECTOR_SET (table
, 1, SCM_BOOL_F
); /* name */
917 ret
= scm_make_program (objcode
, table
, SCM_BOOL_F
);
922 /* Set *LOC to the foreign representation of X with TYPE. */
924 unpack (const ffi_type
*type
, void *loc
, SCM x
, int return_value_p
)
925 #define FUNC_NAME "scm_i_foreign_call"
930 *(float *) loc
= scm_to_double (x
);
932 case FFI_TYPE_DOUBLE
:
933 *(double *) loc
= scm_to_double (x
);
936 /* For integer return values smaller than `int', libffi expects the
937 result in an `ffi_arg'-long buffer. */
941 *(ffi_arg
*) loc
= scm_to_uint8 (x
);
943 *(scm_t_uint8
*) loc
= scm_to_uint8 (x
);
947 *(ffi_arg
*) loc
= scm_to_int8 (x
);
949 *(scm_t_int8
*) loc
= scm_to_int8 (x
);
951 case FFI_TYPE_UINT16
:
953 *(ffi_arg
*) loc
= scm_to_uint16 (x
);
955 *(scm_t_uint16
*) loc
= scm_to_uint16 (x
);
957 case FFI_TYPE_SINT16
:
959 *(ffi_arg
*) loc
= scm_to_int16 (x
);
961 *(scm_t_int16
*) loc
= scm_to_int16 (x
);
963 case FFI_TYPE_UINT32
:
965 *(ffi_arg
*) loc
= scm_to_uint32 (x
);
967 *(scm_t_uint32
*) loc
= scm_to_uint32 (x
);
969 case FFI_TYPE_SINT32
:
971 *(ffi_arg
*) loc
= scm_to_int32 (x
);
973 *(scm_t_int32
*) loc
= scm_to_int32 (x
);
975 case FFI_TYPE_UINT64
:
976 *(scm_t_uint64
*) loc
= scm_to_uint64 (x
);
978 case FFI_TYPE_SINT64
:
979 *(scm_t_int64
*) loc
= scm_to_int64 (x
);
981 case FFI_TYPE_STRUCT
:
982 SCM_VALIDATE_POINTER (1, x
);
983 memcpy (loc
, SCM_POINTER_VALUE (x
), type
->size
);
985 case FFI_TYPE_POINTER
:
986 SCM_VALIDATE_POINTER (1, x
);
987 *(void **) loc
= SCM_POINTER_VALUE (x
);
998 /* Return a Scheme representation of the foreign value at LOC of type
999 TYPE. When RETURN_VALUE_P is true, LOC is assumed to point to a
1000 return value buffer; otherwise LOC is assumed to point to an
1003 pack (const ffi_type
* type
, const void *loc
, int return_value_p
)
1008 return SCM_UNSPECIFIED
;
1009 case FFI_TYPE_FLOAT
:
1010 return scm_from_double (*(float *) loc
);
1011 case FFI_TYPE_DOUBLE
:
1012 return scm_from_double (*(double *) loc
);
1014 /* For integer return values smaller than `int', libffi stores the
1015 result in an `ffi_arg'-long buffer, of which only the
1016 significant bits must be kept---hence the pair of casts below.
1017 See <http://thread.gmane.org/gmane.comp.lib.ffi.general/406>
1020 case FFI_TYPE_UINT8
:
1022 return scm_from_uint8 ((scm_t_uint8
) *(ffi_arg
*) loc
);
1024 return scm_from_uint8 (* (scm_t_uint8
*) loc
);
1025 case FFI_TYPE_SINT8
:
1027 return scm_from_int8 ((scm_t_int8
) *(ffi_arg
*) loc
);
1029 return scm_from_int8 (* (scm_t_int8
*) loc
);
1030 case FFI_TYPE_UINT16
:
1032 return scm_from_uint16 ((scm_t_uint16
) *(ffi_arg
*) loc
);
1034 return scm_from_uint16 (* (scm_t_uint16
*) loc
);
1035 case FFI_TYPE_SINT16
:
1037 return scm_from_int16 ((scm_t_int16
) *(ffi_arg
*) loc
);
1039 return scm_from_int16 (* (scm_t_int16
*) loc
);
1040 case FFI_TYPE_UINT32
:
1042 return scm_from_uint32 ((scm_t_uint32
) *(ffi_arg
*) loc
);
1044 return scm_from_uint32 (* (scm_t_uint32
*) loc
);
1045 case FFI_TYPE_SINT32
:
1047 return scm_from_int32 ((scm_t_int32
) *(ffi_arg
*) loc
);
1049 return scm_from_int32 (* (scm_t_int32
*) loc
);
1050 case FFI_TYPE_UINT64
:
1051 return scm_from_uint64 (*(scm_t_uint64
*) loc
);
1052 case FFI_TYPE_SINT64
:
1053 return scm_from_int64 (*(scm_t_int64
*) loc
);
1055 case FFI_TYPE_STRUCT
:
1057 void *mem
= scm_gc_malloc_pointerless (type
->size
, "foreign");
1058 memcpy (mem
, loc
, type
->size
);
1059 return scm_from_pointer (mem
, NULL
);
1061 case FFI_TYPE_POINTER
:
1062 return scm_from_pointer (*(void **) loc
, NULL
);
1070 scm_i_foreign_call (SCM foreign
, const SCM
*argv
)
1072 /* FOREIGN is the pair that cif_to_procedure set as the 0th element of the
1075 void (*func
) (void);
1083 cif
= SCM_POINTER_VALUE (SCM_CAR (foreign
));
1084 func
= SCM_POINTER_VALUE (SCM_CDR (foreign
));
1086 /* Argument pointers. */
1087 args
= alloca (sizeof (void *) * cif
->nargs
);
1089 /* Compute the worst-case amount of memory needed to store all the argument
1090 values. Note: as of libffi 3.0.9 `cif->bytes' is undocumented and is zero,
1091 so it can't be used for that purpose. */
1092 for (i
= 0, arg_size
= 0; i
< cif
->nargs
; i
++)
1093 arg_size
+= cif
->arg_types
[i
]->size
+ cif
->arg_types
[i
]->alignment
- 1;
1095 /* Space for argument values, followed by return value. */
1096 data
= alloca (arg_size
+ cif
->rtype
->size
1097 + max (sizeof (void *), cif
->rtype
->alignment
));
1099 /* Unpack ARGV to native values, setting ARGV pointers. */
1100 for (i
= 0, off
= 0;
1102 off
= (scm_t_uint8
*) args
[i
] - data
+ cif
->arg_types
[i
]->size
,
1105 /* Suitably align the storage area for argument I. */
1106 args
[i
] = (void *) ROUND_UP ((scm_t_uintptr
) data
+ off
,
1107 cif
->arg_types
[i
]->alignment
);
1108 assert ((scm_t_uintptr
) args
[i
] % cif
->arg_types
[i
]->alignment
== 0);
1109 unpack (cif
->arg_types
[i
], args
[i
], argv
[i
], 0);
1112 /* Prepare space for the return value. On some platforms, such as
1113 `armv5tel-*-linux-gnueabi', the return value has to be at least
1114 word-aligned, even if its type doesn't have any alignment requirement as is
1115 the case with `char'. */
1116 rvalue
= (void *) ROUND_UP ((scm_t_uintptr
) data
+ off
,
1117 max (sizeof (void *), cif
->rtype
->alignment
));
1120 ffi_call (cif
, func
, rvalue
, args
);
1122 return pack (cif
->rtype
, rvalue
, 1);
1126 /* Function pointers aka. "callbacks" or "closures". */
1130 /* Trampoline to invoke a libffi closure that wraps a Scheme
1133 invoke_closure (ffi_cif
*cif
, void *ret
, void **args
, void *data
)
1136 SCM proc
, *argv
, result
;
1138 proc
= PTR2SCM (data
);
1140 argv
= alloca (cif
->nargs
* sizeof (*argv
));
1142 /* Pack ARGS to SCM values, setting ARGV pointers. */
1143 for (i
= 0; i
< cif
->nargs
; i
++)
1144 argv
[i
] = pack (cif
->arg_types
[i
], args
[i
], 0);
1146 result
= scm_call_n (proc
, argv
, cif
->nargs
);
1148 unpack (cif
->rtype
, ret
, result
, 1);
1151 SCM_DEFINE (scm_procedure_to_pointer
, "procedure->pointer", 3, 0, 0,
1152 (SCM return_type
, SCM proc
, SCM arg_types
),
1153 "Return a pointer to a C function of type @var{return_type}\n"
1154 "taking arguments of types @var{arg_types} (a list) and\n"
1155 "behaving as a proxy to procedure @var{proc}. Thus\n"
1156 "@var{proc}'s arity, supported argument types, and return\n"
1157 "type should match @var{return_type} and @var{arg_types}.\n")
1158 #define FUNC_NAME s_scm_procedure_to_pointer
1160 SCM cif_pointer
, pointer
;
1163 void *closure
, *executable
;
1165 cif
= make_cif (return_type
, arg_types
, FUNC_NAME
);
1167 closure
= ffi_closure_alloc (sizeof (ffi_closure
), &executable
);
1168 err
= ffi_prep_closure_loc ((ffi_closure
*) closure
, cif
,
1169 invoke_closure
, SCM2PTR (proc
),
1173 ffi_closure_free (closure
);
1174 SCM_MISC_ERROR ("`ffi_prep_closure_loc' failed", SCM_EOL
);
1177 /* CIF points to GC-managed memory and it should remain as long as
1178 POINTER (see below) is live. Wrap it in a Scheme pointer to then
1179 hold a weak reference on it. */
1180 cif_pointer
= scm_from_pointer (cif
, NULL
);
1182 if (closure
== executable
)
1184 pointer
= scm_from_pointer (executable
, ffi_closure_free
);
1185 register_weak_reference (pointer
,
1186 scm_list_2 (proc
, cif_pointer
));
1190 /* CLOSURE needs to be freed eventually. However, since
1191 `GC_all_interior_pointers' is disabled, we can't just register
1192 a finalizer for CLOSURE. Instead, we create a pointer object
1193 for CLOSURE, with a finalizer, and register it as a weak
1194 reference of POINTER. */
1197 pointer
= scm_from_pointer (executable
, NULL
);
1198 friend = scm_from_pointer (closure
, ffi_closure_free
);
1200 register_weak_reference (pointer
,
1201 scm_list_3 (proc
, cif_pointer
, friend));
1208 #endif /* FFI_CLOSURES */
1213 scm_init_foreign (void)
1215 #ifndef SCM_MAGIC_SNARFER
1216 #include "libguile/foreign.x"
1218 scm_define (sym_void
, scm_from_uint8 (SCM_FOREIGN_TYPE_VOID
));
1219 scm_define (sym_float
, scm_from_uint8 (SCM_FOREIGN_TYPE_FLOAT
));
1220 scm_define (sym_double
, scm_from_uint8 (SCM_FOREIGN_TYPE_DOUBLE
));
1221 scm_define (sym_uint8
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT8
));
1222 scm_define (sym_int8
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT8
));
1223 scm_define (sym_uint16
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT16
));
1224 scm_define (sym_int16
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT16
));
1225 scm_define (sym_uint32
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
));
1226 scm_define (sym_int32
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
));
1227 scm_define (sym_uint64
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
));
1228 scm_define (sym_int64
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
));
1230 scm_define (sym_short
,
1231 #if SIZEOF_SHORT == 8
1232 scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
)
1233 #elif SIZEOF_SHORT == 4
1234 scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
)
1235 #elif SIZEOF_SHORT == 2
1236 scm_from_uint8 (SCM_FOREIGN_TYPE_INT16
)
1238 # error unsupported sizeof (short)
1242 scm_define (sym_unsigned_short
,
1243 #if SIZEOF_SHORT == 8
1244 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1245 #elif SIZEOF_SHORT == 4
1246 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1247 #elif SIZEOF_SHORT == 2
1248 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT16
)
1250 # error unsupported sizeof (short)
1254 scm_define (sym_int
,
1256 scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
)
1257 #elif SIZEOF_INT == 4
1258 scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
)
1260 # error unsupported sizeof (int)
1264 scm_define (sym_unsigned_int
,
1265 #if SIZEOF_UNSIGNED_INT == 8
1266 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1267 #elif SIZEOF_UNSIGNED_INT == 4
1268 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1270 # error unsupported sizeof (unsigned int)
1274 scm_define (sym_long
,
1275 #if SIZEOF_LONG == 8
1276 scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
)
1277 #elif SIZEOF_LONG == 4
1278 scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
)
1280 # error unsupported sizeof (long)
1284 scm_define (sym_unsigned_long
,
1285 #if SIZEOF_UNSIGNED_LONG == 8
1286 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1287 #elif SIZEOF_UNSIGNED_LONG == 4
1288 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1290 # error unsupported sizeof (unsigned long)
1294 scm_define (sym_size_t
,
1295 #if SIZEOF_SIZE_T == 8
1296 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1297 #elif SIZEOF_SIZE_T == 4
1298 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1300 # error unsupported sizeof (size_t)
1304 null_pointer
= scm_cell (scm_tc7_pointer
, 0);
1305 scm_define (sym_null
, null_pointer
);
1309 scm_register_foreign (void)
1311 scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION
,
1313 (scm_t_extension_init_func
)scm_init_foreign
,
1315 pointer_weak_refs
= scm_make_weak_key_hash_table (SCM_UNDEFINED
);