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