1 ;;;; foreign.test --- FFI. -*- mode: scheme; coding: utf-8; -*-
3 ;;;; Copyright (C) 2010, 2011 Free Software Foundation, Inc.
5 ;;;; This library is free software; you can redistribute it and/or
6 ;;;; modify it under the terms of the GNU Lesser General Public
7 ;;;; License as published by the Free Software Foundation; either
8 ;;;; version 3 of the License, or (at your option) any later version.
10 ;;;; This library is distributed in the hope that it will be useful,
11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 ;;;; Lesser General Public License for more details.
15 ;;;; You should have received a copy of the GNU Lesser General Public
16 ;;;; License along with this library; if not, write to the Free Software
17 ;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 ;;; See also ../standalone/test-ffi for FFI tests.
23 (define-module (test-foreign)
24 #:use-module (system foreign)
25 #:use-module (rnrs bytevectors)
26 #:use-module (srfi srfi-1)
27 #:use-module (srfi srfi-26)
28 #:use-module (test-suite lib))
31 (with-test-prefix "null pointer"
34 (pointer? %null-pointer))
37 (= 0 (pointer-address %null-pointer)))
39 (pass-if "null pointer identity"
40 (eq? %null-pointer (make-pointer 0)))
42 (pass-if "null-pointer? %null-pointer"
43 (null-pointer? %null-pointer))
45 (pass-if-exception "pointer->bytevector %null-pointer"
46 exception:null-pointer-error
47 (pointer->bytevector %null-pointer 7)))
50 (with-test-prefix "make-pointer"
53 (pointer? (make-pointer 123)))
55 (pass-if "address preserved"
56 (= 123 (pointer-address (make-pointer 123))))
59 (equal? (make-pointer 123) (make-pointer 123)))
61 (pass-if "equal? modulo finalizer"
62 (let ((finalizer (dynamic-func "scm_is_pair" (dynamic-link))))
63 (equal? (make-pointer 123)
64 (make-pointer 123 finalizer))))
67 (not (equal? (make-pointer 123) (make-pointer 456)))))
70 (with-test-prefix "pointer<->scm"
73 (equal? (pointer->scm (scm->pointer #\newline))
76 (pass-if "non-immediates"
77 (equal? (pointer->scm (scm->pointer "Hello, world!"))
81 (define-wrapped-pointer-type foo
85 (format p "#<foo! ~a>" (pointer-address (unwrap-foo x)))))
87 (with-test-prefix "define-wrapped-pointer-type"
90 (foo? (wrap-foo %null-pointer)))
93 (let ((p (make-pointer 123)))
94 (eq? p (unwrap-foo (wrap-foo p)))))
97 (let ((p1 (make-pointer 123))
98 (p2 (make-pointer 123)))
103 (string=? "#<foo! 123>"
104 (with-output-to-string
106 (write (wrap-foo (make-pointer 123))))))))
109 (with-test-prefix "pointer<->bytevector"
112 (let ((bv #vu8(0 1 2 3 4 5 6 7)))
113 (equal? (pointer->bytevector (bytevector->pointer bv)
114 (bytevector-length bv))
117 (pass-if "pointer from bits"
118 (let* ((bytes (iota (sizeof '*)))
119 (bv (u8-list->bytevector bytes)))
121 (make-pointer (bytevector-uint-ref bv 0 (native-endianness)
123 (fold-right (lambda (byte address)
124 (+ byte (* 256 address)))
128 (pass-if "dereference-pointer"
129 (let* ((bytes (iota (sizeof '*)))
130 (bv (u8-list->bytevector bytes)))
132 (dereference-pointer (bytevector->pointer bv)))
133 (fold-right (lambda (byte address)
134 (+ byte (* 256 address)))
139 (with-test-prefix "pointer<->string"
142 (let ((s "hello, world"))
143 (string=? s (pointer->string (string->pointer s)))))
145 (pass-if "bijection [latin1]"
147 (let ((s "Szép jó napot!"))
148 (string=? s (pointer->string (string->pointer s)))))))
151 (with-test-prefix "pointer->procedure"
153 (pass-if-exception "object instead of pointer"
154 exception:wrong-type-arg
155 (let ((p (pointer->procedure '* %null-pointer '(*))))
159 (with-test-prefix "procedure->pointer"
162 ;; Bindings for libc's `qsort' function.
163 (pointer->procedure void
164 (dynamic-func "qsort" (dynamic-link))
165 (list '* size_t size_t '*)))
167 (define (dereference-pointer-to-byte ptr)
168 (let ((b (pointer->bytevector ptr 1)))
169 (bytevector-u8-ref b 0)))
172 '(7 1 127 3 5 4 77 2 9 0))
175 (if (defined? 'procedure->pointer)
179 (- (dereference-pointer-to-byte x)
180 (dereference-pointer-to-byte y))))
181 (ptr (procedure->pointer int cmp (list '* '*)))
182 (bv (u8-list->bytevector input)))
183 (qsort (bytevector->pointer bv) (bytevector-length bv) 1
184 (procedure->pointer int cmp (list '* '*)))
186 (equal? (bytevector->u8-list bv)
188 (throw 'unresolved)))
190 (pass-if-exception "qsort, wrong return type"
191 exception:wrong-type-arg
193 (if (defined? 'procedure->pointer)
194 (let* ((cmp (lambda (x y) #f)) ; wrong return type
195 (ptr (procedure->pointer int cmp (list '* '*)))
196 (bv (u8-list->bytevector input)))
197 (qsort (bytevector->pointer bv) (bytevector-length bv) 1
198 (procedure->pointer int cmp (list '* '*)))
200 (throw 'unresolved)))
202 (pass-if-exception "qsort, wrong arity"
203 exception:wrong-num-args
205 (if (defined? 'procedure->pointer)
206 (let* ((cmp (lambda (x y z) #f)) ; wrong arity
207 (ptr (procedure->pointer int cmp (list '* '*)))
208 (bv (u8-list->bytevector input)))
209 (qsort (bytevector->pointer bv) (bytevector-length bv) 1
210 (procedure->pointer int cmp (list '* '*)))
212 (throw 'unresolved)))
215 (if (defined? 'procedure->pointer)
216 (let* ((proc (lambda (x y z)
219 (args (list float int16 double))
220 (proc* (pointer->procedure ret
221 (procedure->pointer ret proc args)
223 (arg1 (map (cut / <> 2.0) (iota 123)))
224 (arg2 (iota 123 32000))
225 (arg3 (map (cut / <> 4.0) (iota 123 100 4))))
226 (equal? (map proc arg1 arg2 arg3)
227 (map proc* arg1 arg2 arg3)))
228 (throw 'unresolved)))
230 (pass-if "procedures returning void"
231 (if (defined? 'procedure->pointer)
233 (proc (lambda () (set! called? #t)))
234 (pointer (procedure->pointer void proc '()))
235 (proc* (pointer->procedure void pointer '())))
238 (throw 'unresolved))))
241 (with-test-prefix "structs"
243 (pass-if "sizeof { int8, double }"
244 (= (sizeof (list int8 double))
245 (+ (alignof double) (sizeof double))))
247 (pass-if "sizeof { short, int, long, pointer }"
248 (let ((layout (list short int long '*)))
250 (reduce + 0.0 (map sizeof layout)))))
252 (pass-if "alignof { int8, double, int8 }"
253 ;; alignment of the most strictly aligned component
254 (let ((layout (list int8 double int8)))
255 (= (alignof layout) (alignof double))))
257 (pass-if "parse-c-struct"
258 (let ((layout (list int64 uint8))
259 (data (list -300 43)))
260 (equal? (parse-c-struct (make-c-struct layout data)
264 (pass-if "alignment constraints honored"
265 (let ((layout (list int8 double))
266 (data (list -7 3.14)))
267 (equal? (parse-c-struct (make-c-struct layout data)
271 (pass-if "int8, pointer"
272 (let ((layout (list uint8 '*))
273 (data (list 222 (make-pointer 7777))))
274 (equal? (parse-c-struct (make-c-struct layout data)
278 (pass-if "unsigned-long, int8, size_t"
279 (let ((layout (list unsigned-long int8 size_t))
280 (data (list (expt 2 17) -128 (expt 2 18))))
281 (equal? (parse-c-struct (make-c-struct layout data)
285 (pass-if "long, int, pointer"
286 (let ((layout (list long int '*))
287 (data (list (- (expt 2 17)) -222 (make-pointer 777))))
288 (equal? (parse-c-struct (make-c-struct layout data)
292 (pass-if "int8, pointer, short, double"
293 (let ((layout (list int8 '* short double))
294 (data (list 77 %null-pointer -42 3.14)))
295 (equal? (parse-c-struct (make-c-struct layout data)
299 (pass-if "int8, { int8, double, int8 }, int16"
300 (let ((layout (list int8 (list int8 double int8) int16))
301 (data (list 77 (list 42 4.2 55) 88)))
302 (equal? (parse-c-struct (make-c-struct layout data)