test-suite/tests/foreign.test

   1 ;;;; foreign.test --- FFI.           -*- mode: scheme; coding: utf-8; -*-
   2 ;;;;
   3 ;;;;    Copyright (C) 2010, 2011, 2012 Free Software Foundation, Inc.
   4 ;;;;
   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.
   9 ;;;;
  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.
  14 ;;;;
  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
  18
  19 ;;;
  20 ;;; See also ../standalone/test-ffi for FFI tests.
  21 ;;;
  22
  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))
  29
  30 \f
  31 (with-test-prefix "dynamic-pointer"
  32
  33   (pass-if-exception
  34    "error message"
  35    '(misc-error . "^Symbol not found")
  36    (dynamic-func "does_not_exist___" (dynamic-link))))
  37
  38 \f
  39 (with-test-prefix "null pointer"
  40
  41   (pass-if "pointer?"
  42     (pointer? %null-pointer))
  43
  44   (pass-if "zero"
  45     (= 0 (pointer-address %null-pointer)))
  46
  47   (pass-if "null pointer identity"
  48     (eq? %null-pointer (make-pointer 0)))
  49
  50   (pass-if "null-pointer? %null-pointer"
  51     (null-pointer? %null-pointer))
  52
  53   (pass-if-exception "pointer->bytevector %null-pointer"
  54     exception:null-pointer-error
  55     (pointer->bytevector %null-pointer 7)))
  56
  57 \f
  58 (with-test-prefix "make-pointer"
  59
  60   (pass-if "pointer?"
  61     (pointer? (make-pointer 123)))
  62
  63   (pass-if "address preserved"
  64     (= 123 (pointer-address (make-pointer 123))))
  65
  66   (pass-if "equal?"
  67     (equal? (make-pointer 123) (make-pointer 123)))
  68
  69   (pass-if "equal? modulo finalizer"
  70     (let ((finalizer (dynamic-func "scm_is_pair" (dynamic-link))))
  71       (equal? (make-pointer 123)
  72               (make-pointer 123 finalizer))))
  73
  74   (pass-if "equal? modulo finalizer (set-pointer-finalizer!)"
  75     (let ((finalizer (dynamic-func "scm_is_pair" (dynamic-link)))
  76           (ptr       (make-pointer 123)))
  77       (set-pointer-finalizer! ptr finalizer)
  78       (equal? (make-pointer 123) ptr)))
  79
  80   (pass-if "not equal?"
  81     (not (equal? (make-pointer 123) (make-pointer 456)))))
  82
  83 \f
  84 (with-test-prefix "pointer<->scm"
  85
  86   (pass-if "immediates"
  87     (equal? (pointer->scm (scm->pointer #\newline))
  88             #\newline))
  89
  90   (pass-if "non-immediates"
  91     (equal? (pointer->scm (scm->pointer "Hello, world!"))
  92             "Hello, world!")))
  93
  94 \f
  95 (define-wrapped-pointer-type foo
  96   foo?
  97   wrap-foo unwrap-foo
  98   (lambda (x p)
  99     (format p "#<foo! ~a>" (pointer-address (unwrap-foo x)))))
 100
 101 (with-test-prefix "define-wrapped-pointer-type"
 102
 103   (pass-if "foo?"
 104     (foo? (wrap-foo %null-pointer)))
 105
 106   (pass-if "unwrap-foo"
 107     (let ((p (make-pointer 123)))
 108       (eq? p (unwrap-foo (wrap-foo p)))))
 109
 110   (pass-if "identity"
 111     (let ((p1 (make-pointer 123))
 112           (p2 (make-pointer 123)))
 113       (eq? (wrap-foo p1)
 114            (wrap-foo p2))))
 115
 116   (pass-if "printer"
 117     (string=? "#<foo! 123>"
 118               (with-output-to-string
 119                 (lambda ()
 120                   (write (wrap-foo (make-pointer 123))))))))
 121
 122 \f
 123 (with-test-prefix "pointer<->bytevector"
 124
 125   (pass-if "bijection"
 126     (let ((bv #vu8(0 1 2 3 4 5 6 7)))
 127       (equal? (pointer->bytevector (bytevector->pointer bv)
 128                                    (bytevector-length bv))
 129               bv)))
 130
 131   (pass-if "pointer from bits"
 132     (let* ((bytes (iota (sizeof '*)))
 133            (bv    (u8-list->bytevector bytes))
 134            (fold  (case (native-endianness)
 135                     ((little) fold-right)
 136                     ((big)    fold)
 137                     (else     (error "unsupported endianness")))))
 138       (= (pointer-address
 139           (make-pointer (bytevector-uint-ref bv 0 (native-endianness)
 140                                              (sizeof '*))))
 141          (fold (lambda (byte address)
 142                  (+ byte (* 256 address)))
 143                0
 144                bytes))))
 145
 146   (pass-if "dereference-pointer"
 147     (let* ((bytes (iota (sizeof '*)))
 148            (bv    (u8-list->bytevector bytes))
 149            (fold  (case (native-endianness)
 150                     ((little) fold-right)
 151                     ((big)    fold)
 152                     (else     (error "unsupported endianness")))))
 153       (= (pointer-address
 154           (dereference-pointer (bytevector->pointer bv)))
 155          (fold (lambda (byte address)
 156                  (+ byte (* 256 address)))
 157                0
 158                bytes)))))
 159
 160 \f
 161 (with-test-prefix "pointer<->string"
 162
 163   (pass-if "bijection"
 164     (let ((s "hello, world"))
 165       (string=? s (pointer->string (string->pointer s)))))
 166
 167   (pass-if "bijection [latin1]"
 168     (with-latin1-locale
 169       (let ((s "Szép jó napot!"))
 170         (string=? s (pointer->string (string->pointer s))))))
 171
 172   (pass-if "bijection, utf-8"
 173     (let ((s "hello, world"))
 174       (string=? s (pointer->string (string->pointer s "utf-8")
 175                                    -1 "utf-8"))))
 176
 177   (pass-if "bijection, utf-8 [latin1]"
 178     (let ((s "Szép jó napot!"))
 179       (string=? s (pointer->string (string->pointer s "utf-8")
 180                                    -1 "utf-8")))))
 181
 182
 183 \f
 184 (with-test-prefix "pointer->procedure"
 185
 186   (pass-if-exception "object instead of pointer"
 187     exception:wrong-type-arg
 188     (let ((p (pointer->procedure '* %null-pointer '(*))))
 189       (p #t))))
 190
 191 \f
 192 (with-test-prefix "procedure->pointer"
 193
 194   (define qsort
 195     ;; Bindings for libc's `qsort' function.
 196     (pointer->procedure void
 197                         (dynamic-func "qsort" (dynamic-link))
 198                         (list '* size_t size_t '*)))
 199
 200   (define (dereference-pointer-to-byte ptr)
 201     (let ((b (pointer->bytevector ptr 1)))
 202       (bytevector-u8-ref b 0)))
 203
 204   (define input
 205     '(7 1 127 3 5 4 77 2 9 0))
 206
 207   (pass-if "qsort"
 208     (if (defined? 'procedure->pointer)
 209         (let* ((called? #f)
 210                (cmp     (lambda (x y)
 211                           (set! called? #t)
 212                           (- (dereference-pointer-to-byte x)
 213                              (dereference-pointer-to-byte y))))
 214                (ptr     (procedure->pointer int cmp (list '* '*)))
 215                (bv      (u8-list->bytevector input)))
 216           (qsort (bytevector->pointer bv) (bytevector-length bv) 1
 217                  (procedure->pointer int cmp (list '* '*)))
 218           (and called?
 219                (equal? (bytevector->u8-list bv)
 220                        (sort input <))))
 221         (throw 'unresolved)))
 222
 223   (pass-if-exception "qsort, wrong return type"
 224     exception:wrong-type-arg
 225
 226     (if (defined? 'procedure->pointer)
 227         (let* ((cmp     (lambda (x y) #f)) ; wrong return type
 228                (ptr     (procedure->pointer int cmp (list '* '*)))
 229                (bv      (u8-list->bytevector input)))
 230           (qsort (bytevector->pointer bv) (bytevector-length bv) 1
 231                  (procedure->pointer int cmp (list '* '*)))
 232           #f)
 233         (throw 'unresolved)))
 234
 235   (pass-if-exception "qsort, wrong arity"
 236     exception:wrong-num-args
 237
 238     (if (defined? 'procedure->pointer)
 239         (let* ((cmp     (lambda (x y z) #f)) ; wrong arity
 240                (ptr     (procedure->pointer int cmp (list '* '*)))
 241                (bv      (u8-list->bytevector input)))
 242           (qsort (bytevector->pointer bv) (bytevector-length bv) 1
 243                  (procedure->pointer int cmp (list '* '*)))
 244           #f)
 245         (throw 'unresolved)))
 246
 247   (pass-if "bijection"
 248     (if (defined? 'procedure->pointer)
 249         (let* ((proc  (lambda (x y z)
 250                         (+ x y z 0.0)))
 251                (ret   double)
 252                (args  (list float int16 double))
 253                (proc* (pointer->procedure ret
 254                                           (procedure->pointer ret proc args)
 255                                           args))
 256                (arg1  (map (cut / <> 2.0) (iota 123)))
 257                (arg2  (iota 123 32000))
 258                (arg3  (map (cut / <> 4.0) (iota 123 100 4))))
 259           (equal? (map proc arg1 arg2 arg3)
 260                   (map proc* arg1 arg2 arg3)))
 261         (throw 'unresolved)))
 262
 263   (pass-if "procedures returning a pointer"
 264     (if (defined? 'procedure->pointer)
 265         (let* ((called? #f)
 266                (proc    (lambda (i) (set! called? #t) (make-pointer i)))
 267                (pointer (procedure->pointer '* proc (list int)))
 268                (proc*   (pointer->procedure '* pointer (list int)))
 269                (result  (proc* 777)))
 270           (and called? (equal? result (make-pointer 777))))
 271         (throw 'unresolved)))
 272
 273   (pass-if "procedures returning void"
 274     (if (defined? 'procedure->pointer)
 275         (let* ((called? #f)
 276                (proc    (lambda () (set! called? #t)))
 277                (pointer (procedure->pointer void proc '()))
 278                (proc*   (pointer->procedure void pointer '())))
 279           (proc*)
 280           called?)
 281         (throw 'unresolved)))
 282
 283   (pass-if "procedure is retained"
 284     ;; The lambda passed to `procedure->pointer' must remain live.
 285     (if (defined? 'procedure->pointer)
 286         (let* ((ptr   (procedure->pointer int
 287                                           (lambda (x) (+ x 7))
 288                                           (list int)))
 289                (procs (unfold (cut >= <> 10000)
 290                               (lambda (i)
 291                                 (pointer->procedure int ptr (list int)))
 292                               1+
 293                               0)))
 294           (gc) (gc) (gc)
 295           (every (cut = <> 9)
 296                  (map (lambda (f) (f 2)) procs)))
 297         (throw 'unresolved))))
 298
 299 \f
 300 (with-test-prefix "structs"
 301
 302   (pass-if "sizeof { int8, double }"
 303     (= (sizeof (list int8 double))
 304        (+ (alignof double) (sizeof double))))
 305
 306   (pass-if "sizeof { short, int, long, pointer }"
 307     (let ((layout (list short int long '*)))
 308       (>= (sizeof layout)
 309           (reduce + 0.0 (map sizeof layout)))))
 310
 311   (pass-if "alignof { int8, double, int8 }"
 312     ;; alignment of the most strictly aligned component
 313     (let ((layout (list int8 double int8)))
 314       (= (alignof layout) (alignof double))))
 315
 316   (pass-if "parse-c-struct"
 317     (let ((layout (list int64 uint8))
 318           (data   (list -300 43)))
 319       (equal? (parse-c-struct (make-c-struct layout data)
 320                               layout)
 321               data)))
 322
 323   (pass-if "alignment constraints honored"
 324     (let ((layout (list int8 double))
 325           (data   (list -7 3.14)))
 326       (equal? (parse-c-struct (make-c-struct layout data)
 327                               layout)
 328               data)))
 329
 330   (pass-if "int8, pointer"
 331     (let ((layout (list uint8 '*))
 332           (data   (list 222 (make-pointer 7777))))
 333       (equal? (parse-c-struct (make-c-struct layout data)
 334                               layout)
 335               data)))
 336
 337   (pass-if "unsigned-long, int8, size_t"
 338     (let ((layout (list unsigned-long int8 size_t))
 339           (data   (list (expt 2 17) -128 (expt 2 18))))
 340       (equal? (parse-c-struct (make-c-struct layout data)
 341                               layout)
 342               data)))
 343
 344   (pass-if "long, int, pointer"
 345     (let ((layout (list long int '*))
 346           (data   (list (- (expt 2 17)) -222 (make-pointer 777))))
 347       (equal? (parse-c-struct (make-c-struct layout data)
 348                               layout)
 349               data)))
 350
 351   (pass-if "int8, pointer, short, double"
 352     (let ((layout (list int8 '* short double))
 353           (data   (list 77 %null-pointer -42 3.14)))
 354       (equal? (parse-c-struct (make-c-struct layout data)
 355                               layout)
 356               data)))
 357
 358   (pass-if "int8, { int8, double, int8 }, int16"
 359     (let ((layout (list int8 (list int8 double int8) int16))
 360           (data   (list 77 (list 42 4.2 55) 88)))
 361       (equal? (parse-c-struct (make-c-struct layout data)
 362                               layout)
 363               data))))