1 /* Copyright (C) 2010, 2011, 2012, 2013 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");
56 SCM_SYMBOL (sym_ssize_t
, "ssize_t");
57 SCM_SYMBOL (sym_ptrdiff_t
, "ptrdiff_t");
59 /* that's for pointers, you know. */
60 SCM_SYMBOL (sym_asterisk
, "*");
62 SCM_SYMBOL (sym_null
, "%null-pointer");
63 SCM_SYMBOL (sym_null_pointer_error
, "null-pointer-error");
65 /* The cell representing the null pointer. */
66 static SCM null_pointer
;
68 #if SIZEOF_VOID_P == 4
69 # define scm_to_uintptr scm_to_uint32
70 # define scm_from_uintptr scm_from_uint32
71 #elif SIZEOF_VOID_P == 8
72 # define scm_to_uintptr scm_to_uint64
73 # define scm_from_uintptr scm_from_uint64
75 # error unsupported pointer size
79 /* Raise a null pointer dereference error. */
81 null_pointer_error (const char *func_name
)
83 scm_error (sym_null_pointer_error
, func_name
,
84 "null pointer dereference", SCM_EOL
, SCM_EOL
);
88 static SCM
cif_to_procedure (SCM cif
, SCM func_ptr
);
91 static SCM pointer_weak_refs
= SCM_BOOL_F
;
95 register_weak_reference (SCM from
, SCM to
)
97 scm_weak_table_putq_x (pointer_weak_refs
, from
, to
);
101 pointer_finalizer_trampoline (void *ptr
, void *data
)
103 scm_t_pointer_finalizer finalizer
= data
;
104 finalizer (SCM_POINTER_VALUE (SCM_PACK_POINTER (ptr
)));
107 SCM_DEFINE (scm_pointer_p
, "pointer?", 1, 0, 0,
109 "Return @code{#t} if @var{obj} is a pointer object, "
110 "@code{#f} otherwise.\n")
111 #define FUNC_NAME s_scm_pointer_p
113 return scm_from_bool (SCM_POINTER_P (obj
));
117 SCM_DEFINE (scm_make_pointer
, "make-pointer", 1, 1, 0,
118 (SCM address
, SCM finalizer
),
119 "Return a foreign pointer object pointing to @var{address}. "
120 "If @var{finalizer} is passed, it should be a pointer to a "
121 "one-argument C function that will be called when the pointer "
122 "object becomes unreachable.")
123 #define FUNC_NAME s_scm_make_pointer
126 scm_t_uintptr c_address
;
128 c_address
= scm_to_uintptr (address
);
129 if (SCM_UNBNDP (finalizer
))
133 SCM_VALIDATE_POINTER (2, finalizer
);
134 c_finalizer
= SCM_POINTER_VALUE (finalizer
);
137 return scm_from_pointer ((void *) c_address
, c_finalizer
);
142 scm_to_pointer (SCM pointer
)
143 #define FUNC_NAME "scm_to_pointer"
145 SCM_VALIDATE_POINTER (1, pointer
);
146 return SCM_POINTER_VALUE (pointer
);
151 scm_from_pointer (void *ptr
, scm_t_pointer_finalizer finalizer
)
155 if (ptr
== NULL
&& finalizer
== NULL
)
159 ret
= scm_cell (scm_tc7_pointer
, (scm_t_bits
) ptr
);
162 scm_i_set_finalizer (SCM2PTR (ret
), pointer_finalizer_trampoline
,
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
);
201 if (SCM_HEAP_OBJECT_P (ret
))
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
,
273 blen
, btype
, 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
313 SCM_VALIDATE_POINTER (1, pointer
);
314 SCM_VALIDATE_POINTER (2, finalizer
);
316 scm_i_add_finalizer (SCM2PTR (pointer
), pointer_finalizer_trampoline
,
317 SCM_POINTER_VALUE (finalizer
));
319 return SCM_UNSPECIFIED
;
324 scm_i_pointer_print (SCM pointer
, SCM port
, scm_print_state
*pstate
)
326 scm_puts_unlocked ("#<pointer 0x", port
);
327 scm_uintprint (scm_to_uintptr (scm_pointer_address (pointer
)), 16, port
);
328 scm_putc_unlocked ('>', port
);
332 /* Non-primitive helpers functions. These procedures could be
333 implemented in terms of the primitives above but would be inefficient
334 (heap allocation overhead, Scheme/C round trips, etc.) */
336 SCM_DEFINE (scm_dereference_pointer
, "dereference-pointer", 1, 0, 0,
338 "Assuming @var{pointer} points to a memory region that\n"
339 "holds a pointer, return this pointer.")
340 #define FUNC_NAME s_scm_dereference_pointer
342 SCM_VALIDATE_POINTER (1, pointer
);
344 return scm_from_pointer (* (void **) SCM_POINTER_VALUE (pointer
), NULL
);
348 SCM_DEFINE (scm_string_to_pointer
, "string->pointer", 1, 1, 0,
349 (SCM string
, SCM encoding
),
350 "Return a foreign pointer to a nul-terminated copy of\n"
351 "@var{string} in the given @var{encoding}, defaulting to\n"
352 "the current locale encoding. The C string is freed when\n"
353 "the returned foreign pointer becomes unreachable.\n\n"
354 "This is the Scheme equivalent of @code{scm_to_stringn}.")
355 #define FUNC_NAME s_scm_string_to_pointer
357 SCM_VALIDATE_STRING (1, string
);
359 /* XXX: Finalizers slow down libgc; they could be avoided if
360 `scm_to_string' & co. were able to use libgc-allocated memory. */
362 if (SCM_UNBNDP (encoding
))
363 return scm_from_pointer (scm_to_locale_string (string
), free
);
369 SCM_VALIDATE_STRING (2, encoding
);
371 enc
= scm_to_locale_string (encoding
);
372 scm_dynwind_begin (0);
373 scm_dynwind_free (enc
);
375 ret
= scm_from_pointer
376 (scm_to_stringn (string
, NULL
, enc
,
377 scm_i_default_port_conversion_handler ()),
387 SCM_DEFINE (scm_pointer_to_string
, "pointer->string", 1, 2, 0,
388 (SCM pointer
, SCM length
, SCM encoding
),
389 "Return the string representing the C string pointed to by\n"
390 "@var{pointer}. If @var{length} is omitted or @code{-1}, the\n"
391 "string is assumed to be nul-terminated. Otherwise\n"
392 "@var{length} is the number of bytes in memory pointed to by\n"
393 "@var{pointer}. The C string is assumed to be in the given\n"
394 "@var{encoding}, defaulting to the current locale encoding.\n\n"
395 "This is the Scheme equivalent of @code{scm_from_stringn}.")
396 #define FUNC_NAME s_scm_pointer_to_string
400 SCM_VALIDATE_POINTER (1, pointer
);
402 if (SCM_UNBNDP (length
)
403 || scm_is_true (scm_eqv_p (length
, scm_from_int (-1))))
406 len
= scm_to_size_t (length
);
408 if (SCM_UNBNDP (encoding
))
409 return scm_from_locale_stringn (SCM_POINTER_VALUE (pointer
), len
);
415 SCM_VALIDATE_STRING (3, encoding
);
417 enc
= scm_to_locale_string (encoding
);
418 scm_dynwind_begin (0);
419 scm_dynwind_free (enc
);
421 ret
= scm_from_stringn (SCM_POINTER_VALUE (pointer
), len
, enc
,
422 scm_i_default_port_conversion_handler ());
433 SCM_DEFINE (scm_alignof
, "alignof", 1, 0, 0, (SCM type
),
434 "Return the alignment of @var{type}, in bytes.\n\n"
435 "@var{type} should be a valid C type, like @code{int}.\n"
436 "Alternately @var{type} may be the symbol @code{*}, in which\n"
437 "case the alignment of a pointer is returned. @var{type} may\n"
438 "also be a list of types, in which case the alignment of a\n"
439 "@code{struct} with ABI-conventional packing is returned.")
440 #define FUNC_NAME s_scm_alignof
442 if (SCM_I_INUMP (type
))
444 switch (SCM_I_INUM (type
))
446 case SCM_FOREIGN_TYPE_FLOAT
:
447 return scm_from_size_t (alignof_type (float));
448 case SCM_FOREIGN_TYPE_DOUBLE
:
449 return scm_from_size_t (alignof_type (double));
450 case SCM_FOREIGN_TYPE_UINT8
:
451 return scm_from_size_t (alignof_type (scm_t_uint8
));
452 case SCM_FOREIGN_TYPE_INT8
:
453 return scm_from_size_t (alignof_type (scm_t_int8
));
454 case SCM_FOREIGN_TYPE_UINT16
:
455 return scm_from_size_t (alignof_type (scm_t_uint16
));
456 case SCM_FOREIGN_TYPE_INT16
:
457 return scm_from_size_t (alignof_type (scm_t_int16
));
458 case SCM_FOREIGN_TYPE_UINT32
:
459 return scm_from_size_t (alignof_type (scm_t_uint32
));
460 case SCM_FOREIGN_TYPE_INT32
:
461 return scm_from_size_t (alignof_type (scm_t_int32
));
462 case SCM_FOREIGN_TYPE_UINT64
:
463 return scm_from_size_t (alignof_type (scm_t_uint64
));
464 case SCM_FOREIGN_TYPE_INT64
:
465 return scm_from_size_t (alignof_type (scm_t_int64
));
467 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
470 else if (scm_is_eq (type
, sym_asterisk
))
472 return scm_from_size_t (alignof_type (void*));
473 else if (scm_is_pair (type
))
475 /* TYPE is a structure. Section 3-3 of the i386, x86_64, PowerPC,
476 and SPARC P.S. of the System V ABI all say: "Aggregates
477 (structures and arrays) and unions assume the alignment of
478 their most strictly aligned component." */
481 for (max
= 0; scm_is_pair (type
); type
= SCM_CDR (type
))
485 align
= scm_to_size_t (scm_alignof (SCM_CAR (type
)));
490 return scm_from_size_t (max
);
493 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
497 SCM_DEFINE (scm_sizeof
, "sizeof", 1, 0, 0, (SCM type
),
498 "Return the size of @var{type}, in bytes.\n\n"
499 "@var{type} should be a valid C type, like @code{int}.\n"
500 "Alternately @var{type} may be the symbol @code{*}, in which\n"
501 "case the size of a pointer is returned. @var{type} may also\n"
502 "be a list of types, in which case the size of a @code{struct}\n"
503 "with ABI-conventional packing is returned.")
504 #define FUNC_NAME s_scm_sizeof
506 if (SCM_I_INUMP (type
))
508 switch (SCM_I_INUM (type
))
510 case SCM_FOREIGN_TYPE_FLOAT
:
511 return scm_from_size_t (sizeof (float));
512 case SCM_FOREIGN_TYPE_DOUBLE
:
513 return scm_from_size_t (sizeof (double));
514 case SCM_FOREIGN_TYPE_UINT8
:
515 return scm_from_size_t (sizeof (scm_t_uint8
));
516 case SCM_FOREIGN_TYPE_INT8
:
517 return scm_from_size_t (sizeof (scm_t_int8
));
518 case SCM_FOREIGN_TYPE_UINT16
:
519 return scm_from_size_t (sizeof (scm_t_uint16
));
520 case SCM_FOREIGN_TYPE_INT16
:
521 return scm_from_size_t (sizeof (scm_t_int16
));
522 case SCM_FOREIGN_TYPE_UINT32
:
523 return scm_from_size_t (sizeof (scm_t_uint32
));
524 case SCM_FOREIGN_TYPE_INT32
:
525 return scm_from_size_t (sizeof (scm_t_int32
));
526 case SCM_FOREIGN_TYPE_UINT64
:
527 return scm_from_size_t (sizeof (scm_t_uint64
));
528 case SCM_FOREIGN_TYPE_INT64
:
529 return scm_from_size_t (sizeof (scm_t_int64
));
531 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
534 else if (scm_is_eq (type
, sym_asterisk
))
536 return scm_from_size_t (sizeof (void*));
537 else if (scm_is_pair (type
))
541 size_t align
= scm_to_size_t (scm_alignof(type
));
542 while (scm_is_pair (type
))
544 off
= ROUND_UP (off
, scm_to_size_t (scm_alignof (scm_car (type
))));
545 off
+= scm_to_size_t (scm_sizeof (scm_car (type
)));
546 type
= scm_cdr (type
);
548 return scm_from_size_t (ROUND_UP(off
, align
));
551 scm_wrong_type_arg (FUNC_NAME
, 1, type
);
556 /* return 1 on success, 0 on failure */
558 parse_ffi_type (SCM type
, int return_p
, long *n_structs
, long *n_struct_elts
)
560 if (SCM_I_INUMP (type
))
562 if ((SCM_I_INUM (type
) < 0 )
563 || (SCM_I_INUM (type
) > SCM_FOREIGN_TYPE_LAST
))
565 else if (SCM_I_INUM (type
) == SCM_FOREIGN_TYPE_VOID
&& !return_p
)
570 else if (scm_is_eq (type
, sym_asterisk
))
577 len
= scm_ilength (type
);
582 if (!parse_ffi_type (scm_car (type
), 0, n_structs
, n_struct_elts
))
585 type
= scm_cdr (type
);
593 fill_ffi_type (SCM type
, ffi_type
*ftype
, ffi_type
***type_ptrs
,
596 if (SCM_I_INUMP (type
))
598 switch (SCM_I_INUM (type
))
600 case SCM_FOREIGN_TYPE_FLOAT
:
601 *ftype
= ffi_type_float
;
603 case SCM_FOREIGN_TYPE_DOUBLE
:
604 *ftype
= ffi_type_double
;
606 case SCM_FOREIGN_TYPE_UINT8
:
607 *ftype
= ffi_type_uint8
;
609 case SCM_FOREIGN_TYPE_INT8
:
610 *ftype
= ffi_type_sint8
;
612 case SCM_FOREIGN_TYPE_UINT16
:
613 *ftype
= ffi_type_uint16
;
615 case SCM_FOREIGN_TYPE_INT16
:
616 *ftype
= ffi_type_sint16
;
618 case SCM_FOREIGN_TYPE_UINT32
:
619 *ftype
= ffi_type_uint32
;
621 case SCM_FOREIGN_TYPE_INT32
:
622 *ftype
= ffi_type_sint32
;
624 case SCM_FOREIGN_TYPE_UINT64
:
625 *ftype
= ffi_type_uint64
;
627 case SCM_FOREIGN_TYPE_INT64
:
628 *ftype
= ffi_type_sint64
;
630 case SCM_FOREIGN_TYPE_VOID
:
631 *ftype
= ffi_type_void
;
634 scm_wrong_type_arg_msg ("pointer->procedure", 0, type
,
638 else if (scm_is_eq (type
, sym_asterisk
))
641 *ftype
= ffi_type_pointer
;
648 len
= scm_ilength (type
);
651 ftype
->alignment
= 0;
652 ftype
->type
= FFI_TYPE_STRUCT
;
653 ftype
->elements
= *type_ptrs
;
654 *type_ptrs
+= len
+ 1;
656 for (i
= 0; i
< len
; i
++)
658 ftype
->elements
[i
] = *types
;
660 fill_ffi_type (scm_car (type
), ftype
->elements
[i
],
662 type
= scm_cdr (type
);
664 ftype
->elements
[i
] = NULL
;
668 /* Return a "cif" (call interface) for the given RETURN_TYPE and
671 make_cif (SCM return_type
, SCM arg_types
, const char *caller
)
672 #define FUNC_NAME caller
675 long i
, nargs
, n_structs
, n_struct_elts
;
679 ffi_type
**type_ptrs
;
682 nargs
= scm_ilength (arg_types
);
683 SCM_ASSERT (nargs
>= 0, arg_types
, 3, FUNC_NAME
);
684 /* fixme: assert nargs < 1<<32 */
685 n_structs
= n_struct_elts
= 0;
687 /* For want of talloc, we're going to have to do this in two passes: first we
688 figure out how much memory is needed for all types, then we allocate the
689 cif and the types all in one block. */
690 if (!parse_ffi_type (return_type
, 1, &n_structs
, &n_struct_elts
))
691 scm_wrong_type_arg (FUNC_NAME
, 1, return_type
);
692 for (walk
= arg_types
; scm_is_pair (walk
); walk
= scm_cdr (walk
))
693 if (!parse_ffi_type (scm_car (walk
), 0, &n_structs
, &n_struct_elts
))
694 scm_wrong_type_arg (FUNC_NAME
, 3, scm_car (walk
));
696 /* the memory: with space for the cif itself */
697 cif_len
= sizeof (ffi_cif
);
699 /* then ffi_type pointers: one for each arg, one for each struct
700 element, and one for each struct (for null-termination) */
701 cif_len
= (ROUND_UP (cif_len
, alignof_type (void *))
702 + (nargs
+ n_structs
+ n_struct_elts
)*sizeof(void*));
704 /* then the ffi_type structs themselves, one per arg and struct element, and
705 one for the return val */
706 cif_len
= (ROUND_UP (cif_len
, alignof_type (ffi_type
))
707 + (nargs
+ n_struct_elts
+ 1)*sizeof(ffi_type
));
709 mem
= scm_gc_malloc_pointerless (cif_len
, "foreign");
710 /* ensure all the memory is initialized, even the holes */
711 memset (mem
, 0, cif_len
);
712 cif
= (ffi_cif
*) mem
;
714 /* reuse cif_len to walk through the mem */
715 cif_len
= ROUND_UP (sizeof (ffi_cif
), alignof_type (void *));
716 type_ptrs
= (ffi_type
**)(mem
+ cif_len
);
717 cif_len
= ROUND_UP (cif_len
718 + (nargs
+ n_structs
+ n_struct_elts
)*sizeof(void*),
719 alignof_type (ffi_type
));
720 types
= (ffi_type
*)(mem
+ cif_len
);
722 /* whew. now knit the pointers together. */
723 cif
->rtype
= types
++;
724 fill_ffi_type (return_type
, cif
->rtype
, &type_ptrs
, &types
);
725 cif
->arg_types
= type_ptrs
;
727 for (walk
= arg_types
, i
= 0; scm_is_pair (walk
); walk
= scm_cdr (walk
), i
++)
729 cif
->arg_types
[i
] = types
++;
730 fill_ffi_type (scm_car (walk
), cif
->arg_types
[i
], &type_ptrs
, &types
);
733 /* round out the cif, and we're done. */
734 cif
->abi
= FFI_DEFAULT_ABI
;
739 if (FFI_OK
!= ffi_prep_cif (cif
, FFI_DEFAULT_ABI
, cif
->nargs
, cif
->rtype
,
741 SCM_MISC_ERROR ("ffi_prep_cif failed", SCM_EOL
);
747 SCM_DEFINE (scm_pointer_to_procedure
, "pointer->procedure", 3, 0, 0,
748 (SCM return_type
, SCM func_ptr
, SCM arg_types
),
749 "Make a foreign function.\n\n"
750 "Given the foreign void pointer @var{func_ptr}, its argument and\n"
751 "return types @var{arg_types} and @var{return_type}, return a\n"
752 "procedure that will pass arguments to the foreign function\n"
753 "and return appropriate values.\n\n"
754 "@var{arg_types} should be a list of foreign types.\n"
755 "@code{return_type} should be a foreign type.")
756 #define FUNC_NAME s_scm_pointer_to_procedure
760 SCM_VALIDATE_POINTER (2, func_ptr
);
762 cif
= make_cif (return_type
, arg_types
, FUNC_NAME
);
764 return cif_to_procedure (scm_from_pointer (cif
, NULL
), func_ptr
);
770 /* Pre-generate trampolines for less than 10 arguments. */
772 #ifdef WORDS_BIGENDIAN
773 #define OBJCODE_HEADER 0, 0, 0, 8, 0, 0, 0, 40
774 #define META_HEADER 0, 0, 0, 32, 0, 0, 0, 0
776 #define OBJCODE_HEADER 8, 0, 0, 0, 40, 0, 0, 0
777 #define META_HEADER 32, 0, 0, 0, 0, 0, 0, 0
782 /* 0 */ scm_op_assert_nargs_ee, 0, nreq, /* assert number of args */ \
783 /* 3 */ scm_op_object_ref, 0, /* push the pair with the cif and the function pointer */ \
784 /* 5 */ scm_op_foreign_call, nreq, /* and call (will return value as well) */ \
785 /* 7 */ scm_op_nop, \
786 /* 8 */ META (3, 7, nreq)
788 #define META(start, end, nreq) \
790 /* 0 */ scm_op_make_eol, /* bindings */ \
791 /* 1 */ scm_op_make_eol, /* sources */ \
792 /* 2 */ scm_op_make_int8, start, scm_op_make_int8, end, /* arity: from ip N to ip N */ \
793 /* 6 */ scm_op_make_int8, nreq, /* the arity is N required args */ \
794 /* 8 */ scm_op_list, 0, 3, /* make a list of those 3 vals */ \
795 /* 11 */ scm_op_list, 0, 1, /* and the arities will be a list of that one list */ \
796 /* 14 */ scm_op_load_symbol, 0, 0, 4, 'n', 'a', 'm', 'e', /* `name' */ \
797 /* 22 */ scm_op_object_ref, 1, /* the name from the object table */ \
798 /* 24 */ scm_op_cons, /* make a pair for the properties */ \
799 /* 25 */ scm_op_list, 0, 4, /* pack bindings, sources, and arities into list */ \
800 /* 28 */ scm_op_return, /* and return */ \
801 /* 29 */ scm_op_nop, scm_op_nop, scm_op_nop \
806 scm_t_uint64 dummy
; /* ensure 8-byte alignment; perhaps there's a better way */
807 const scm_t_uint8 bytes
[10 * (sizeof (struct scm_objcode
) + 8
808 + sizeof (struct scm_objcode
) + 32)];
812 CODE (0), CODE (1), CODE (2), CODE (3), CODE (4),
813 CODE (5), CODE (6), CODE (7), CODE (8), CODE (9)
819 #undef OBJCODE_HEADER
823 (defun generate-objcode-cells (n)
824 "Generate objcode cells for up to N arguments"
829 (format " { STATIC_OBJCODE_TAG, SCM_PACK (raw_bytecode.bytes + %d) },\n"
830 (* (+ 4 4 8 4 4 32) i)))
831 (insert " { SCM_BOOL_F, SCM_PACK (0) },\n")
834 #define STATIC_OBJCODE_TAG \
835 SCM_PACK (SCM_MAKE_OBJCODE_TAG (SCM_OBJCODE_TYPE_STATIC, 0))
839 scm_t_uint64 dummy
; /* alignment */
840 scm_t_cell cells
[10 * 2]; /* 10 double cells */
843 /* C-u 1 0 M-x generate-objcode-cells RET */
845 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 0) },
846 { SCM_BOOL_F
, SCM_PACK (0) },
847 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 56) },
848 { SCM_BOOL_F
, SCM_PACK (0) },
849 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 112) },
850 { SCM_BOOL_F
, SCM_PACK (0) },
851 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 168) },
852 { SCM_BOOL_F
, SCM_PACK (0) },
853 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 224) },
854 { SCM_BOOL_F
, SCM_PACK (0) },
855 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 280) },
856 { SCM_BOOL_F
, SCM_PACK (0) },
857 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 336) },
858 { SCM_BOOL_F
, SCM_PACK (0) },
859 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 392) },
860 { SCM_BOOL_F
, SCM_PACK (0) },
861 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 448) },
862 { SCM_BOOL_F
, SCM_PACK (0) },
863 { STATIC_OBJCODE_TAG
, SCM_PACK (raw_bytecode
.bytes
+ 504) },
864 { SCM_BOOL_F
, SCM_PACK (0) }
868 static const SCM objcode_trampolines
[10] = {
869 SCM_PACK (objcode_cells
.cells
+0),
870 SCM_PACK (objcode_cells
.cells
+2),
871 SCM_PACK (objcode_cells
.cells
+4),
872 SCM_PACK (objcode_cells
.cells
+6),
873 SCM_PACK (objcode_cells
.cells
+8),
874 SCM_PACK (objcode_cells
.cells
+10),
875 SCM_PACK (objcode_cells
.cells
+12),
876 SCM_PACK (objcode_cells
.cells
+14),
877 SCM_PACK (objcode_cells
.cells
+16),
878 SCM_PACK (objcode_cells
.cells
+18),
882 cif_to_procedure (SCM cif
, SCM func_ptr
)
886 SCM objcode
, table
, ret
;
888 c_cif
= (ffi_cif
*) SCM_POINTER_VALUE (cif
);
889 nargs
= c_cif
->nargs
;
892 objcode
= objcode_trampolines
[nargs
];
894 scm_misc_error ("make-foreign-function", "args >= 10 currently unimplemented",
897 table
= scm_c_make_vector (2, SCM_UNDEFINED
);
898 SCM_SIMPLE_VECTOR_SET (table
, 0, scm_cons (cif
, func_ptr
));
899 SCM_SIMPLE_VECTOR_SET (table
, 1, SCM_BOOL_F
); /* name */
900 ret
= scm_make_program (objcode
, table
, SCM_BOOL_F
);
905 /* Set *LOC to the foreign representation of X with TYPE. */
907 unpack (const ffi_type
*type
, void *loc
, SCM x
, int return_value_p
)
908 #define FUNC_NAME "scm_i_foreign_call"
913 *(float *) loc
= scm_to_double (x
);
915 case FFI_TYPE_DOUBLE
:
916 *(double *) loc
= scm_to_double (x
);
919 /* For integer return values smaller than `int', libffi expects the
920 result in an `ffi_arg'-long buffer. */
924 *(ffi_arg
*) loc
= scm_to_uint8 (x
);
926 *(scm_t_uint8
*) loc
= scm_to_uint8 (x
);
930 *(ffi_arg
*) loc
= scm_to_int8 (x
);
932 *(scm_t_int8
*) loc
= scm_to_int8 (x
);
934 case FFI_TYPE_UINT16
:
936 *(ffi_arg
*) loc
= scm_to_uint16 (x
);
938 *(scm_t_uint16
*) loc
= scm_to_uint16 (x
);
940 case FFI_TYPE_SINT16
:
942 *(ffi_arg
*) loc
= scm_to_int16 (x
);
944 *(scm_t_int16
*) loc
= scm_to_int16 (x
);
946 case FFI_TYPE_UINT32
:
948 *(ffi_arg
*) loc
= scm_to_uint32 (x
);
950 *(scm_t_uint32
*) loc
= scm_to_uint32 (x
);
952 case FFI_TYPE_SINT32
:
954 *(ffi_arg
*) loc
= scm_to_int32 (x
);
956 *(scm_t_int32
*) loc
= scm_to_int32 (x
);
958 case FFI_TYPE_UINT64
:
959 *(scm_t_uint64
*) loc
= scm_to_uint64 (x
);
961 case FFI_TYPE_SINT64
:
962 *(scm_t_int64
*) loc
= scm_to_int64 (x
);
964 case FFI_TYPE_STRUCT
:
965 SCM_VALIDATE_POINTER (1, x
);
966 memcpy (loc
, SCM_POINTER_VALUE (x
), type
->size
);
968 case FFI_TYPE_POINTER
:
969 SCM_VALIDATE_POINTER (1, x
);
970 *(void **) loc
= SCM_POINTER_VALUE (x
);
981 /* Return a Scheme representation of the foreign value at LOC of type
982 TYPE. When RETURN_VALUE_P is true, LOC is assumed to point to a
983 return value buffer; otherwise LOC is assumed to point to an
986 pack (const ffi_type
* type
, const void *loc
, int return_value_p
)
991 return SCM_UNSPECIFIED
;
993 return scm_from_double (*(float *) loc
);
994 case FFI_TYPE_DOUBLE
:
995 return scm_from_double (*(double *) loc
);
997 /* For integer return values smaller than `int', libffi stores the
998 result in an `ffi_arg'-long buffer, of which only the
999 significant bits must be kept---hence the pair of casts below.
1000 See <http://thread.gmane.org/gmane.comp.lib.ffi.general/406>
1003 case FFI_TYPE_UINT8
:
1005 return scm_from_uint8 ((scm_t_uint8
) *(ffi_arg
*) loc
);
1007 return scm_from_uint8 (* (scm_t_uint8
*) loc
);
1008 case FFI_TYPE_SINT8
:
1010 return scm_from_int8 ((scm_t_int8
) *(ffi_arg
*) loc
);
1012 return scm_from_int8 (* (scm_t_int8
*) loc
);
1013 case FFI_TYPE_UINT16
:
1015 return scm_from_uint16 ((scm_t_uint16
) *(ffi_arg
*) loc
);
1017 return scm_from_uint16 (* (scm_t_uint16
*) loc
);
1018 case FFI_TYPE_SINT16
:
1020 return scm_from_int16 ((scm_t_int16
) *(ffi_arg
*) loc
);
1022 return scm_from_int16 (* (scm_t_int16
*) loc
);
1023 case FFI_TYPE_UINT32
:
1025 return scm_from_uint32 ((scm_t_uint32
) *(ffi_arg
*) loc
);
1027 return scm_from_uint32 (* (scm_t_uint32
*) loc
);
1028 case FFI_TYPE_SINT32
:
1030 return scm_from_int32 ((scm_t_int32
) *(ffi_arg
*) loc
);
1032 return scm_from_int32 (* (scm_t_int32
*) loc
);
1033 case FFI_TYPE_UINT64
:
1034 return scm_from_uint64 (*(scm_t_uint64
*) loc
);
1035 case FFI_TYPE_SINT64
:
1036 return scm_from_int64 (*(scm_t_int64
*) loc
);
1038 case FFI_TYPE_STRUCT
:
1040 void *mem
= scm_gc_malloc_pointerless (type
->size
, "foreign");
1041 memcpy (mem
, loc
, type
->size
);
1042 return scm_from_pointer (mem
, NULL
);
1044 case FFI_TYPE_POINTER
:
1045 return scm_from_pointer (*(void **) loc
, NULL
);
1053 scm_i_foreign_call (SCM foreign
, const SCM
*argv
)
1055 /* FOREIGN is the pair that cif_to_procedure set as the 0th element of the
1058 void (*func
) (void);
1066 cif
= SCM_POINTER_VALUE (SCM_CAR (foreign
));
1067 func
= SCM_POINTER_VALUE (SCM_CDR (foreign
));
1069 /* Argument pointers. */
1070 args
= alloca (sizeof (void *) * cif
->nargs
);
1072 /* Compute the worst-case amount of memory needed to store all the argument
1073 values. Note: as of libffi 3.0.9 `cif->bytes' is undocumented and is zero,
1074 so it can't be used for that purpose. */
1075 for (i
= 0, arg_size
= 0; i
< cif
->nargs
; i
++)
1076 arg_size
+= cif
->arg_types
[i
]->size
+ cif
->arg_types
[i
]->alignment
- 1;
1078 /* Space for argument values, followed by return value. */
1079 data
= alloca (arg_size
+ cif
->rtype
->size
1080 + max (sizeof (void *), cif
->rtype
->alignment
));
1082 /* Unpack ARGV to native values, setting ARGV pointers. */
1083 for (i
= 0, off
= 0;
1085 off
= (scm_t_uint8
*) args
[i
] - data
+ cif
->arg_types
[i
]->size
,
1088 /* Suitably align the storage area for argument I. */
1089 args
[i
] = (void *) ROUND_UP ((scm_t_uintptr
) data
+ off
,
1090 cif
->arg_types
[i
]->alignment
);
1091 assert ((scm_t_uintptr
) args
[i
] % cif
->arg_types
[i
]->alignment
== 0);
1092 unpack (cif
->arg_types
[i
], args
[i
], argv
[i
], 0);
1095 /* Prepare space for the return value. On some platforms, such as
1096 `armv5tel-*-linux-gnueabi', the return value has to be at least
1097 word-aligned, even if its type doesn't have any alignment requirement as is
1098 the case with `char'. */
1099 rvalue
= (void *) ROUND_UP ((scm_t_uintptr
) data
+ off
,
1100 max (sizeof (void *), cif
->rtype
->alignment
));
1103 ffi_call (cif
, func
, rvalue
, args
);
1105 return pack (cif
->rtype
, rvalue
, 1);
1109 /* Function pointers aka. "callbacks" or "closures". */
1113 /* Trampoline to invoke a libffi closure that wraps a Scheme
1116 invoke_closure (ffi_cif
*cif
, void *ret
, void **args
, void *data
)
1119 SCM proc
, *argv
, result
;
1121 proc
= SCM_PACK_POINTER (data
);
1123 argv
= alloca (cif
->nargs
* sizeof (*argv
));
1125 /* Pack ARGS to SCM values, setting ARGV pointers. */
1126 for (i
= 0; i
< cif
->nargs
; i
++)
1127 argv
[i
] = pack (cif
->arg_types
[i
], args
[i
], 0);
1129 result
= scm_call_n (proc
, argv
, cif
->nargs
);
1131 unpack (cif
->rtype
, ret
, result
, 1);
1134 SCM_DEFINE (scm_procedure_to_pointer
, "procedure->pointer", 3, 0, 0,
1135 (SCM return_type
, SCM proc
, SCM arg_types
),
1136 "Return a pointer to a C function of type @var{return_type}\n"
1137 "taking arguments of types @var{arg_types} (a list) and\n"
1138 "behaving as a proxy to procedure @var{proc}. Thus\n"
1139 "@var{proc}'s arity, supported argument types, and return\n"
1140 "type should match @var{return_type} and @var{arg_types}.\n")
1141 #define FUNC_NAME s_scm_procedure_to_pointer
1143 SCM cif_pointer
, pointer
;
1146 void *closure
, *executable
;
1148 cif
= make_cif (return_type
, arg_types
, FUNC_NAME
);
1150 closure
= ffi_closure_alloc (sizeof (ffi_closure
), &executable
);
1151 err
= ffi_prep_closure_loc ((ffi_closure
*) closure
, cif
,
1152 invoke_closure
, SCM_UNPACK_POINTER (proc
),
1156 ffi_closure_free (closure
);
1157 SCM_MISC_ERROR ("`ffi_prep_closure_loc' failed", SCM_EOL
);
1160 /* CIF points to GC-managed memory and it should remain as long as
1161 POINTER (see below) is live. Wrap it in a Scheme pointer to then
1162 hold a weak reference on it. */
1163 cif_pointer
= scm_from_pointer (cif
, NULL
);
1165 if (closure
== executable
)
1167 pointer
= scm_from_pointer (executable
, ffi_closure_free
);
1168 register_weak_reference (pointer
,
1169 scm_list_2 (proc
, cif_pointer
));
1173 /* CLOSURE needs to be freed eventually. However, since
1174 `GC_all_interior_pointers' is disabled, we can't just register
1175 a finalizer for CLOSURE. Instead, we create a pointer object
1176 for CLOSURE, with a finalizer, and register it as a weak
1177 reference of POINTER. */
1180 pointer
= scm_from_pointer (executable
, NULL
);
1181 friend = scm_from_pointer (closure
, ffi_closure_free
);
1183 register_weak_reference (pointer
,
1184 scm_list_3 (proc
, cif_pointer
, friend));
1191 #endif /* FFI_CLOSURES */
1196 scm_init_foreign (void)
1198 #ifndef SCM_MAGIC_SNARFER
1199 #include "libguile/foreign.x"
1201 scm_define (sym_void
, scm_from_uint8 (SCM_FOREIGN_TYPE_VOID
));
1202 scm_define (sym_float
, scm_from_uint8 (SCM_FOREIGN_TYPE_FLOAT
));
1203 scm_define (sym_double
, scm_from_uint8 (SCM_FOREIGN_TYPE_DOUBLE
));
1204 scm_define (sym_uint8
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT8
));
1205 scm_define (sym_int8
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT8
));
1206 scm_define (sym_uint16
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT16
));
1207 scm_define (sym_int16
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT16
));
1208 scm_define (sym_uint32
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
));
1209 scm_define (sym_int32
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
));
1210 scm_define (sym_uint64
, scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
));
1211 scm_define (sym_int64
, scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
));
1213 scm_define (sym_short
,
1214 #if SIZEOF_SHORT == 8
1215 scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
)
1216 #elif SIZEOF_SHORT == 4
1217 scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
)
1218 #elif SIZEOF_SHORT == 2
1219 scm_from_uint8 (SCM_FOREIGN_TYPE_INT16
)
1221 # error unsupported sizeof (short)
1225 scm_define (sym_unsigned_short
,
1226 #if SIZEOF_SHORT == 8
1227 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1228 #elif SIZEOF_SHORT == 4
1229 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1230 #elif SIZEOF_SHORT == 2
1231 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT16
)
1233 # error unsupported sizeof (short)
1237 scm_define (sym_int
,
1239 scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
)
1240 #elif SIZEOF_INT == 4
1241 scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
)
1243 # error unsupported sizeof (int)
1247 scm_define (sym_unsigned_int
,
1248 #if SIZEOF_UNSIGNED_INT == 8
1249 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1250 #elif SIZEOF_UNSIGNED_INT == 4
1251 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1253 # error unsupported sizeof (unsigned int)
1257 scm_define (sym_long
,
1258 #if SIZEOF_LONG == 8
1259 scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
)
1260 #elif SIZEOF_LONG == 4
1261 scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
)
1263 # error unsupported sizeof (long)
1267 scm_define (sym_unsigned_long
,
1268 #if SIZEOF_UNSIGNED_LONG == 8
1269 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1270 #elif SIZEOF_UNSIGNED_LONG == 4
1271 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1273 # error unsupported sizeof (unsigned long)
1277 scm_define (sym_size_t
,
1278 #if SIZEOF_SIZE_T == 8
1279 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT64
)
1280 #elif SIZEOF_SIZE_T == 4
1281 scm_from_uint8 (SCM_FOREIGN_TYPE_UINT32
)
1283 # error unsupported sizeof (size_t)
1287 scm_define (sym_ssize_t
,
1288 #if SIZEOF_SIZE_T == 8
1289 scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
)
1290 #elif SIZEOF_SIZE_T == 4
1291 scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
)
1293 # error unsupported sizeof (ssize_t)
1297 scm_define (sym_ptrdiff_t
,
1298 #if SCM_SIZEOF_SCM_T_PTRDIFF == 8
1299 scm_from_uint8 (SCM_FOREIGN_TYPE_INT64
)
1300 #elif SCM_SIZEOF_SCM_T_PTRDIFF == 4
1301 scm_from_uint8 (SCM_FOREIGN_TYPE_INT32
)
1303 # error unsupported sizeof (scm_t_ptrdiff)
1307 null_pointer
= scm_cell (scm_tc7_pointer
, 0);
1308 scm_define (sym_null
, null_pointer
);
1312 scm_register_foreign (void)
1314 scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION
,
1316 (scm_t_extension_init_func
)scm_init_foreign
,
1318 pointer_weak_refs
= scm_c_make_weak_table (0, SCM_WEAK_TABLE_KIND_KEY
);