1.0.17.4: support for dynamic-extent structures
[sbcl.git] / tests / dynamic-extent.impure.lisp
index 942be0d..10677ac 100644 (file)
@@ -6,11 +6,14 @@
 ;;;; While most of SBCL is derived from the CMU CL system, the test
 ;;;; files (like this one) were written from scratch after the fork
 ;;;; from CMU CL.
-;;;; 
+;;;;
 ;;;; This software is in the public domain and is provided with
 ;;;; absolutely no warranty. See the COPYING and CREDITS files for
 ;;;; more information.
 
+(when (eq sb-ext:*evaluator-mode* :interpret)
+  (sb-ext:quit :unix-status 104))
+
 (setq sb-c::*check-consistency* t)
 
 (defmacro defun-with-dx (name arglist &body body)
 (defun-with-dx dxcaller (&rest rest)
   (declare (dynamic-extent rest))
   (callee rest))
-
 (assert (= (dxcaller 1 2 3 4 5 6 7) 22))
 
+(defun-with-dx dxcaller-align-1 (x &rest rest)
+  (declare (dynamic-extent rest))
+  (+ x (callee rest)))
+(assert (= (dxcaller-align-1 17 1 2 3 4 5 6 7) 39))
+(assert (= (dxcaller-align-1 17 1 2 3 4 5 6 7 8) 40))
+
 ;;; %NIP-VALUES
 (defun-with-dx test-nip-values ()
   (flet ((bar (x &rest y)
       (opaque-identity :bar)
       z)))
 \f
+;;; alignment
+(defvar *x*)
+(defun-with-dx test-alignment-dx-list (form)
+  (multiple-value-prog1 (eval form)
+    (let ((l (list 1 2 3 4)))
+      (declare (dynamic-extent l))
+      (setq *x* (copy-list l)))))
+(dotimes (n 64)
+  (let* ((res (loop for i below n collect i))
+         (form `(values ,@res)))
+    (assert (equal (multiple-value-list (test-alignment-dx-list form)) res))
+    (assert (equal *x* '(1 2 3 4)))))
+
+;;; closure
+
+(declaim (notinline true))
+(defun true (x)
+  (declare (ignore x))
+  t)
+
+(defun-with-dx dxclosure (x)
+  (flet ((f (y)
+           (+ y x)))
+    (declare (dynamic-extent #'f))
+    (true #'f)))
+
+(assert (eq t (dxclosure 13)))
+
+;;; value-cells
+
+(defun-with-dx dx-value-cell (x)
+  (declare (optimize sb-c::stack-allocate-value-cells))
+  ;; Not implemented everywhere, yet.
+  #+(or x86 x86-64 mips)
+  (let ((cell x))
+    (declare (dynamic-extent cell))
+    (flet ((f ()
+             (incf cell)))
+      (declare (dynamic-extent #'f))
+      (true #'f))))
+
+;;; CONS
+
+(defun-with-dx cons-on-stack (x)
+  (let ((cons (cons x x)))
+    (declare (dynamic-extent cons))
+    (true cons)
+    nil))
+
+;;; MAKE-ARRAY
+
+(defun-with-dx make-array-on-stack ()
+  (let ((v (make-array '(42) :element-type 'single-float)))
+    (declare (dynamic-extent v))
+    (true v)
+    nil))
+
+;;; MAKE-STRUCTURE
+
+(declaim (inline make-fp-struct-1))
+(defstruct fp-struct-1
+  (s 0.0 :type single-float)
+  (d 0.0d0 :type double-float))
+
+(defun-with-dx test-fp-struct-1.1 (s d)
+  (let ((fp (make-fp-struct-1 :s s)))
+    (declare (dynamic-extent fp))
+    (assert (eql s (fp-struct-1-s fp)))
+    (assert (eql 0.0d0 (fp-struct-1-d fp)))))
+
+(defun-with-dx test-fp-struct-1.2 (s d)
+  (let ((fp (make-fp-struct-1 :d d)))
+    (declare (dynamic-extent fp))
+    (assert (eql 0.0 (fp-struct-1-s fp)))
+    (assert (eql d (fp-struct-1-d fp)))))
+
+(defun-with-dx test-fp-struct-1.3 (s d)
+  (let ((fp (make-fp-struct-1 :d d :s s)))
+    (declare (dynamic-extent fp))
+    (assert (eql s (fp-struct-1-s fp)))
+    (assert (eql d (fp-struct-1-d fp)))))
+
+(defun-with-dx test-fp-struct-1.4 (s d)
+  (let ((fp (make-fp-struct-1 :s s :d d)))
+    (declare (dynamic-extent fp))
+    (assert (eql s (fp-struct-1-s fp)))
+    (assert (eql d (fp-struct-1-d fp)))))
+
+(test-fp-struct-1.1 123.456 876.243d0)
+(test-fp-struct-1.2 123.456 876.243d0)
+(test-fp-struct-1.3 123.456 876.243d0)
+(test-fp-struct-1.4 123.456 876.243d0)
+
+(declaim (inline make-fp-struct-2))
+(defstruct fp-struct-2
+  (d 0.0d0 :type double-float)
+  (s 0.0 :type single-float))
+
+(defun-with-dx test-fp-struct-2.1 (s d)
+  (let ((fp (make-fp-struct-2 :s s)))
+    (declare (dynamic-extent fp))
+    (assert (eql s (fp-struct-2-s fp)))
+    (assert (eql 0.0d0 (fp-struct-2-d fp)))))
+
+(defun-with-dx test-fp-struct-2.2 (s d)
+  (let ((fp (make-fp-struct-2 :d d)))
+    (declare (dynamic-extent fp))
+    (assert (eql 0.0 (fp-struct-2-s fp)))
+    (assert (eql d (fp-struct-2-d fp)))))
+
+(defun-with-dx test-fp-struct-2.3 (s d)
+  (let ((fp (make-fp-struct-2 :d d :s s)))
+    (declare (dynamic-extent fp))
+    (assert (eql s (fp-struct-2-s fp)))
+    (assert (eql d (fp-struct-2-d fp)))))
+
+(defun-with-dx test-fp-struct-2.4 (s d)
+  (let ((fp (make-fp-struct-2 :s s :d d)))
+    (declare (dynamic-extent fp))
+    (assert (eql s (fp-struct-2-s fp)))
+    (assert (eql d (fp-struct-2-d fp)))))
+
+(test-fp-struct-2.1 123.456 876.243d0)
+(test-fp-struct-2.2 123.456 876.243d0)
+(test-fp-struct-2.3 123.456 876.243d0)
+(test-fp-struct-2.4 123.456 876.243d0)
+
+(declaim (inline make-cfp-struct-1))
+(defstruct cfp-struct-1
+  (s (complex 0.0) :type (complex single-float))
+  (d (complex 0.0d0) :type (complex double-float)))
+
+(defun-with-dx test-cfp-struct-1.1 (s d)
+  (let ((cfp (make-cfp-struct-1 :s s)))
+    (declare (dynamic-extent cfp))
+    (assert (eql s (cfp-struct-1-s cfp)))
+    (assert (eql (complex 0.0d0) (cfp-struct-1-d cfp)))))
+
+(defun-with-dx test-cfp-struct-1.2 (s d)
+  (let ((cfp (make-cfp-struct-1 :d d)))
+    (declare (dynamic-extent cfp))
+    (assert (eql (complex 0.0) (cfp-struct-1-s cfp)))
+    (assert (eql d (cfp-struct-1-d cfp)))))
+
+(defun-with-dx test-cfp-struct-1.3 (s d)
+  (let ((cfp (make-cfp-struct-1 :d d :s s)))
+    (declare (dynamic-extent cfp))
+    (assert (eql s (cfp-struct-1-s cfp)))
+    (assert (eql d (cfp-struct-1-d cfp)))))
+
+(defun-with-dx test-cfp-struct-1.4 (s d)
+  (let ((cfp (make-cfp-struct-1 :s s :d d)))
+    (declare (dynamic-extent cfp))
+    (assert (eql s (cfp-struct-1-s cfp)))
+    (assert (eql d (cfp-struct-1-d cfp)))))
+
+(test-cfp-struct-1.1 (complex 0.123 123.456) (complex 908132.41d0 876.243d0))
+(test-cfp-struct-1.2 (complex 0.123 123.456) (complex 908132.41d0 876.243d0))
+(test-cfp-struct-1.3 (complex 0.123 123.456) (complex 908132.41d0 876.243d0))
+(test-cfp-struct-1.4 (complex 0.123 123.456) (complex 908132.41d0 876.243d0))
+
+(declaim (inline make-cfp-struct-2))
+(defstruct cfp-struct-2
+  (d (complex 0.0d0) :type (complex double-float))
+  (s (complex 0.0) :type (complex single-float)))
+
+(defun-with-dx test-cfp-struct-2.1 (s d)
+  (let ((cfp (make-cfp-struct-2 :s s)))
+    (declare (dynamic-extent cfp))
+    (assert (eql s (cfp-struct-2-s cfp)))
+    (assert (eql (complex 0.0d0) (cfp-struct-2-d cfp)))))
+
+(defun-with-dx test-cfp-struct-2.2 (s d)
+  (let ((cfp (make-cfp-struct-2 :d d)))
+    (declare (dynamic-extent cfp))
+    (assert (eql (complex 0.0) (cfp-struct-2-s cfp)))
+    (assert (eql d (cfp-struct-2-d cfp)))))
+
+(defun-with-dx test-cfp-struct-2.3 (s d)
+  (let ((cfp (make-cfp-struct-2 :d d :s s)))
+    (declare (dynamic-extent cfp))
+    (assert (eql s (cfp-struct-2-s cfp)))
+    (assert (eql d (cfp-struct-2-d cfp)))))
+
+(defun-with-dx test-cfp-struct-2.4 (s d)
+  (let ((cfp (make-cfp-struct-2 :s s :d d)))
+    (declare (dynamic-extent cfp))
+    (assert (eql s (cfp-struct-2-s cfp)))
+    (assert (eql d (cfp-struct-2-d cfp)))))
+
+(test-cfp-struct-2.1 (complex 0.123 123.456) (complex 908132.41d0 876.243d0))
+(test-cfp-struct-2.2 (complex 0.123 123.456) (complex 908132.41d0 876.243d0))
+(test-cfp-struct-2.3 (complex 0.123 123.456) (complex 908132.41d0 876.243d0))
+(test-cfp-struct-2.4 (complex 0.123 123.456) (complex 908132.41d0 876.243d0))
+
+(declaim (inline make-foo1 make-foo2 make-foo3))
+(defstruct foo1 x)
+
+(defun-with-dx make-foo1-on-stack (x)
+  (let ((foo (make-foo1 :x x)))
+    (declare (dynamic-extent foo))
+    (assert (eql x (foo1-x foo)))))
+
+(defstruct foo2
+  (x 0.0 :type single-float)
+  (y 0.0d0 :type double-float)
+  a
+  b
+  c)
+
+(defmacro assert-eql (expected got)
+  `(let ((exp ,expected)
+         (got ,got))
+     (unless (eql exp got)
+       (error "Expected ~S, got ~S!" exp got))))
+
+(defun-with-dx make-foo2-on-stack (x y)
+  (let ((foo (make-foo2 :y y :c 'c)))
+    (declare (dynamic-extent foo))
+    (assert-eql 0.0 (foo2-x foo))
+    (assert-eql y (foo2-y foo))
+    (assert-eql 'c (foo2-c foo))
+    (assert-eql nil (foo2-b foo))))
+
+;;; Check that constants work out as argument for all relevant
+;;; slot types.
+(defstruct foo3
+  (a 0 :type t)
+  (b 1 :type fixnum)
+  (c 2 :type sb-vm:word)
+  (d 3.0 :type single-float)
+  (e 4.0d0 :type double-float))
+(defun-with-dx make-foo3-on-stack ()
+  (let ((foo (make-foo3)))
+    (declare (dynamic-extent foo))
+    (assert (eql 0 (foo3-a foo)))
+    (assert (eql 1 (foo3-b foo)))
+    (assert (eql 2 (foo3-c foo)))
+    (assert (eql 3.0 (foo3-d foo)))
+    (assert (eql 4.0d0 (foo3-e foo)))))
+
+;;; Nested DX
+
+(defun-with-dx nested-dx-lists ()
+  (let ((dx (list (list 1 2) (list 3 4))))
+    (declare (dynamic-extent dx))
+    (true dx)
+    nil))
+
+(defun-with-dx nested-dx-conses ()
+  (let ((dx (cons 1 (cons 2 (cons 3 (cons (cons t t) nil))))))
+    (declare (dynamic-extent dx))
+    (true dx)
+    nil))
+
+(defun-with-dx nested-dx-not-used (x)
+  (declare (list x))
+  (let ((l (setf (car x) (list x x x))))
+    (declare (dynamic-extent l))
+    (true l)
+    (true (length l))
+    nil))
+
+(defun-with-dx nested-evil-dx-used (x)
+  (declare (list x))
+  (let ((l (list x x x)))
+    (declare (dynamic-extent l))
+    (unwind-protect
+         (progn
+           (setf (car x) l)
+           (true l))
+      (setf (car x) nil))
+    nil))
+
+;;; multiple uses for dx lvar
+
+(defun-with-dx multiple-dx-uses ()
+  (let ((dx (if (true t)
+                (list 1 2 3)
+                (list 2 3 4))))
+    (declare (dynamic-extent dx))
+    (true dx)
+    nil))
+
+;;; with-spinlock should use DX and not cons
+
+(defvar *slock* (sb-thread::make-spinlock :name "slocklock"))
+
+(defun test-spinlock ()
+  (sb-thread::with-spinlock (*slock*)
+    (true *slock*)))
+
+;;; not really DX, but GETHASH and (SETF GETHASH) should not cons
+
+(defvar *table* (make-hash-table))
+
+(defun test-hash-table ()
+  (setf (gethash 5 *table*) 13)
+  (gethash 5 *table*))
+\f
 (defmacro assert-no-consing (form &optional times)
-  `(%assert-no-consing (lambda () ,form ,times)))
+  `(%assert-no-consing (lambda () ,form) ,times))
 (defun %assert-no-consing (thunk &optional times)
   (let ((before (get-bytes-consed))
         (times (or times 10000)))
       (funcall thunk))
     (assert (< (- (get-bytes-consed) before) times))))
 
-#+x86
+(defmacro assert-consing (form &optional times)
+  `(%assert-consing (lambda () ,form) ,times))
+(defun %assert-consing (thunk &optional times)
+  (let ((before (get-bytes-consed))
+        (times (or times 10000)))
+    (declare (type (integer 1 *) times))
+    (dotimes (i times)
+      (funcall thunk))
+    (assert (not (< (- (get-bytes-consed) before) times)))))
+
+(defvar *a-cons* (cons nil nil))
+
+#+(or x86 x86-64 alpha ppc sparc mips)
 (progn
+  (assert-no-consing (dxclosure 42))
   (assert-no-consing (dxlength 1 2 3))
   (assert-no-consing (dxlength t t t t t t))
   (assert-no-consing (dxlength))
   (assert-no-consing (test-let-var-subst1 17))
   (assert-no-consing (test-let-var-subst2 17))
   (assert-no-consing (test-lvar-subst 11))
-  )
+  (assert-no-consing (dx-value-cell 13))
+  (assert-no-consing (cons-on-stack 42))
+  (assert-no-consing (make-array-on-stack))
+  (assert-no-consing (make-foo1-on-stack 123))
+  (#+raw-instance-init-vops assert-no-consing
+   #-raw-instance-init-vops progn
+   (make-foo2-on-stack 1.24 1.23d0))
+  (#+raw-instance-init-vops assert-no-consing
+   #-raw-instance-init-vops progn
+   (make-foo3-on-stack))
+  (assert-no-consing (nested-dx-conses))
+  (assert-no-consing (nested-dx-lists))
+  (assert-consing (nested-dx-not-used *a-cons*))
+  (assert-no-consing (nested-evil-dx-used *a-cons*))
+  (assert-no-consing (multiple-dx-uses))
+  ;; Not strictly DX..
+  (assert-no-consing (test-hash-table))
+  #+sb-thread
+  (assert-no-consing (test-spinlock)))
 
 \f
 ;;; Bugs found by Paul F. Dietz
               ((1 1 1) (1 1 1) (1 1 1))))
          4))
 
+;;; bug reported by Brian Downing: stack-allocated arrays were not
+;;; filled with zeroes.
+(defun-with-dx bdowning-2005-iv-16 ()
+  (let ((a (make-array 11 :initial-element 0)))
+    (declare (dynamic-extent a))
+    (assert (every (lambda (x) (eql x 0)) a))))
+(assert-no-consing (bdowning-2005-iv-16))
+
+
+(defun-with-dx let-converted-vars-dx-allocated-bug (x y z)
+  (let* ((a (list x y z))
+         (b (list x y z))
+         (c (list a b)))
+    (declare (dynamic-extent c))
+    (values (first c) (second c))))
+(multiple-value-bind (i j) (let-converted-vars-dx-allocated-bug 1 2 3)
+  (assert (and (equal i j)
+               (equal i (list 1 2 3)))))
+
+;;; workaround for bug 419 -- real issue remains, but check that the
+;;; bandaid holds.
+(defun-with-dx bug419 (x)
+  (multiple-value-call #'list
+    (eval '(values 1 2 3))
+    (let ((x x))
+      (declare (dynamic-extent x))
+      (flet ((mget (y)
+               (+ x y))
+             (mset (z)
+               (incf x z)))
+        (declare (dynamic-extent #'mget #'mset))
+        ((lambda (f g) (eval `(progn ,f ,g (values 4 5 6)))) #'mget #'mset)))))
+(assert (equal (bug419 42) '(1 2 3 4 5 6)))
 \f
-(sb-ext:quit :unix-status 104)