5111404907d01ff0601542af8ab249f74f08c0e7
[sbcl.git] / tests / dynamic-extent.impure.lisp
1 ;;;; tests that dynamic-extent functionality works.
2
3 ;;;; This software is part of the SBCL system. See the README file for
4 ;;;; more information.
5 ;;;;
6 ;;;; While most of SBCL is derived from the CMU CL system, the test
7 ;;;; files (like this one) were written from scratch after the fork
8 ;;;; from CMU CL.
9 ;;;;
10 ;;;; This software is in the public domain and is provided with
11 ;;;; absolutely no warranty. See the COPYING and CREDITS files for
12 ;;;; more information.
13
14 (when (eq sb-ext:*evaluator-mode* :interpret)
15   (sb-ext:exit :code 104))
16
17 (load "compiler-test-util.lisp")
18 (use-package :ctu)
19
20 (setq sb-c::*check-consistency* t
21       sb-ext:*stack-allocate-dynamic-extent* t)
22
23 (defmacro defun-with-dx (name arglist &body body)
24   (let ((debug-name (sb-int:symbolicate name "-HIGH-DEBUG"))
25         (default-name (sb-int:symbolicate name "-DEFAULT")))
26     `(progn
27        (defun ,debug-name ,arglist
28          (declare (optimize debug))
29          ,@body)
30        (defun ,default-name ,arglist
31         ,@body)
32        (defun ,name (&rest args)
33          (apply #',debug-name args)
34          (apply #',default-name args)))))
35
36 (declaim (notinline opaque-identity))
37 (defun opaque-identity (x)
38   x)
39
40 ;;; &REST lists
41
42 (defun-with-dx dxlength (&rest rest)
43   (declare (dynamic-extent rest))
44   (length rest))
45
46 (with-test (:name (:dx-&rest :basics))
47   (assert (= (dxlength 1 2 3) 3))
48   (assert (= (dxlength t t t t t t) 6))
49   (assert (= (dxlength) 0)))
50
51 (defun callee (list)
52   (destructuring-bind (a b c d e f &rest g) list
53     (+ a b c d e f (length g))))
54
55 (defun-with-dx dxcaller (&rest rest)
56   (declare (dynamic-extent rest))
57   (callee rest))
58
59 (with-test (:name (:dx-&rest :pass-down-to-callee :tail-call))
60   (assert (= (dxcaller 1 2 3 4 5 6 7) 22)))
61
62 (defun-with-dx dxcaller-align-1 (x &rest rest)
63   (declare (dynamic-extent rest))
64   (+ x (callee rest)))
65
66 (with-test (:name (:dx-&rest :pass-down-to-callee :non-tail-call))
67   (assert (= (dxcaller-align-1 17 1 2 3 4 5 6 7) 39))
68   (assert (= (dxcaller-align-1 17 1 2 3 4 5 6 7 8) 40)))
69
70 ;;; %NIP-VALUES
71
72 (defun-with-dx test-nip-values ()
73   (flet ((bar (x &rest y)
74            (declare (dynamic-extent y))
75            (if (> x 0)
76                (values x (length y))
77                (values (car y)))))
78     (multiple-value-call #'values
79       (bar 1 2 3 4 5 6)
80       (bar -1 'a 'b))))
81
82 (with-test (:name (:nip-values))
83   (assert (equal (multiple-value-list (test-nip-values)) '(1 5 a))))
84
85 ;;; LET-variable substitution
86
87 (defun-with-dx test-let-var-subst1 (x)
88   (let ((y (list x (1- x))))
89     (opaque-identity :foo)
90     (let ((z (the list y)))
91       (declare (dynamic-extent z))
92       (length z))))
93
94 (with-test (:name (:let-variable-substitution))
95   (assert (eql (test-let-var-subst1 17) 2)))
96
97 (defun-with-dx test-let-var-subst2 (x)
98   (let ((y (list x (1- x))))
99     (declare (dynamic-extent y))
100     (opaque-identity :foo)
101     (let ((z (the list y)))
102       (length z))))
103
104 (with-test (:name (:let-variable-substitution-2))
105   (assert (eql (test-let-var-subst2 17) 2)))
106
107
108 ;;; DX propagation through LET-return.
109
110 (defun-with-dx test-lvar-subst (x)
111   (let ((y (list x (1- x))))
112     (declare (dynamic-extent y))
113     (second (let ((z (the list y)))
114               (opaque-identity :foo)
115               z))))
116
117 (with-test (:name (:dx-propagation-through-let-return))
118   (assert (eql (test-lvar-subst 11) 10)))
119
120 ;;; this code is incorrect, but the compiler should not fail
121 (defun-with-dx test-let-var-subst-incorrect (x)
122   (let ((y (list x (1- x))))
123     (opaque-identity :foo)
124     (let ((z (the list y)))
125       (declare (dynamic-extent z))
126       (opaque-identity :bar)
127       z)))
128 \f
129 ;;; alignment
130
131 (defvar *x*)
132 (defun-with-dx test-alignment-dx-list (form)
133   (multiple-value-prog1 (eval form)
134     (let ((l (list 1 2 3 4)))
135       (declare (dynamic-extent l))
136       (setq *x* (copy-list l)))))
137
138 (with-test (:name (:dx-list :alignment))
139   (dotimes (n 64)
140     (let* ((res (loop for i below n collect i))
141            (form `(values ,@res)))
142       (assert (equal (multiple-value-list (test-alignment-dx-list form)) res))
143       (assert (equal *x* '(1 2 3 4))))))
144
145 ;;; closure
146
147 (declaim (notinline true))
148 (defun true (x)
149   (declare (ignore x))
150   t)
151
152 (defun-with-dx dxclosure (x)
153   (flet ((f (y)
154            (+ y x)))
155     (declare (dynamic-extent #'f))
156     (true #'f)))
157
158 (with-test (:name (:dx-closure))
159   (assert (eq t (dxclosure 13))))
160
161 ;;; value-cells
162
163 (defun-with-dx dx-value-cell (x)
164   ;; Not implemented everywhere, yet.
165   #+(or x86 x86-64 mips hppa)
166   (let ((cell x))
167     (declare (sb-int:truly-dynamic-extent cell))
168     (flet ((f ()
169              (incf cell)))
170       (declare (dynamic-extent #'f))
171       (true #'f))))
172
173 ;;; CONS
174
175 (defun-with-dx cons-on-stack (x)
176   (let ((cons (cons x x)))
177     (declare (dynamic-extent cons))
178     (true cons)
179     nil))
180
181 ;;; MAKE-ARRAY
182
183 (defun force-make-array-on-stack (n)
184   (declare (optimize safety))
185   (let ((v (make-array (min n 1))))
186     (declare (sb-int:truly-dynamic-extent v))
187     (true v)
188     (true v)
189     nil))
190
191 (defun-with-dx make-array-on-stack-1 ()
192   (let ((v (make-array '(42) :element-type 'single-float)))
193     (declare (dynamic-extent v))
194     (true v)
195     (true v)
196     nil))
197
198 (defun-with-dx make-array-on-stack-2 (n x)
199   (declare (integer n))
200   (let ((v (make-array n :initial-contents x)))
201     (declare (sb-int:truly-dynamic-extent v))
202     (true v)
203     (true v)
204     nil))
205
206 (defun-with-dx make-array-on-stack-3 (x y z)
207   (let ((v (make-array 3
208                        :element-type 'fixnum :initial-contents (list x y z)
209                        :element-type t :initial-contents x)))
210     (declare (sb-int:truly-dynamic-extent v))
211     (true v)
212     (true v)
213     nil))
214
215 (defun-with-dx make-array-on-stack-4 ()
216   (let ((v (make-array 3 :initial-contents '(1 2 3))))
217     (declare (sb-int:truly-dynamic-extent v))
218     (true v)
219     (true v)
220     nil))
221
222 (defun-with-dx make-array-on-stack-5 ()
223   (let ((v (make-array 3 :initial-element 12 :element-type t)))
224     (declare (sb-int:truly-dynamic-extent v))
225     (true v)
226     (true v)
227     nil))
228
229 (defun-with-dx make-array-on-stack-6 ()
230   (let ((v (make-array 3 :initial-element 12 :element-type '(unsigned-byte 8))))
231     (declare (sb-int:truly-dynamic-extent v))
232     (true v)
233     (true v)
234     nil))
235
236 (defun-with-dx make-array-on-stack-7 ()
237   (let ((v (make-array 3 :initial-element 12 :element-type '(signed-byte 8))))
238     (declare (sb-int:truly-dynamic-extent v))
239     (true v)
240     (true v)
241     nil))
242
243 (defun-with-dx make-array-on-stack-8 ()
244   (let ((v (make-array 3 :initial-element 12 :element-type 'word)))
245     (declare (sb-int:truly-dynamic-extent v))
246     (true v)
247     (true v)
248     nil))
249
250 (defun-with-dx make-array-on-stack-9 ()
251   (let ((v (make-array 3 :initial-element 12.0 :element-type 'single-float)))
252     (declare (sb-int:truly-dynamic-extent v))
253     (true v)
254     (true v)
255     nil))
256
257 (defun-with-dx make-array-on-stack-10 ()
258   (let ((v (make-array 3 :initial-element 12.0d0 :element-type 'double-float)))
259     (declare (sb-int:truly-dynamic-extent v))
260     (true v)
261     (true v)
262     nil))
263
264 (defun-with-dx make-array-on-stack-11 ()
265   (let ((v (make-array (the integer (opaque-identity 3)) :initial-element 12.0d0 :element-type 'double-float)))
266     (declare (sb-int:truly-dynamic-extent v))
267     (true v)
268     (true v)
269     nil))
270
271 (defun-with-dx vector-on-stack (x y)
272   (let ((v (vector 1 x 2 y 3)))
273     (declare (sb-int:truly-dynamic-extent v))
274     (true v)
275     nil))
276
277 ;;; MAKE-STRUCTURE
278
279 (declaim (inline make-fp-struct-1))
280 (defstruct fp-struct-1
281   (s 0.0 :type single-float)
282   (d 0.0d0 :type double-float))
283
284 (defun-with-dx test-fp-struct-1.1 (s d)
285   (let ((fp (make-fp-struct-1 :s s)))
286     (declare (dynamic-extent fp))
287     (assert (eql s (fp-struct-1-s fp)))
288     (assert (eql 0.0d0 (fp-struct-1-d fp)))))
289
290 (defun-with-dx test-fp-struct-1.2 (s d)
291   (let ((fp (make-fp-struct-1 :d d)))
292     (declare (dynamic-extent fp))
293     (assert (eql 0.0 (fp-struct-1-s fp)))
294     (assert (eql d (fp-struct-1-d fp)))))
295
296 (defun-with-dx test-fp-struct-1.3 (s d)
297   (let ((fp (make-fp-struct-1 :d d :s s)))
298     (declare (dynamic-extent fp))
299     (assert (eql s (fp-struct-1-s fp)))
300     (assert (eql d (fp-struct-1-d fp)))))
301
302 (defun-with-dx test-fp-struct-1.4 (s d)
303   (let ((fp (make-fp-struct-1 :s s :d d)))
304     (declare (dynamic-extent fp))
305     (assert (eql s (fp-struct-1-s fp)))
306     (assert (eql d (fp-struct-1-d fp)))))
307
308 (with-test (:name (:test-fp-struct-1.1))
309   (test-fp-struct-1.1 123.456 876.243d0))
310 (with-test (:name (:test-fp-struct-1.2))
311   (test-fp-struct-1.2 123.456 876.243d0))
312 (with-test (:name (:test-fp-struct-1.3))
313   (test-fp-struct-1.3 123.456 876.243d0))
314 (with-test (:name (:test-fp-struct-1.4))
315   (test-fp-struct-1.4 123.456 876.243d0))
316
317 (declaim (inline make-fp-struct-2))
318 (defstruct fp-struct-2
319   (d 0.0d0 :type double-float)
320   (s 0.0 :type single-float))
321
322 (defun-with-dx test-fp-struct-2.1 (s d)
323   (let ((fp (make-fp-struct-2 :s s)))
324     (declare (dynamic-extent fp))
325     (assert (eql s (fp-struct-2-s fp)))
326     (assert (eql 0.0d0 (fp-struct-2-d fp)))))
327
328 (defun-with-dx test-fp-struct-2.2 (s d)
329   (let ((fp (make-fp-struct-2 :d d)))
330     (declare (dynamic-extent fp))
331     (assert (eql 0.0 (fp-struct-2-s fp)))
332     (assert (eql d (fp-struct-2-d fp)))))
333
334 (defun-with-dx test-fp-struct-2.3 (s d)
335   (let ((fp (make-fp-struct-2 :d d :s s)))
336     (declare (dynamic-extent fp))
337     (assert (eql s (fp-struct-2-s fp)))
338     (assert (eql d (fp-struct-2-d fp)))))
339
340 (defun-with-dx test-fp-struct-2.4 (s d)
341   (let ((fp (make-fp-struct-2 :s s :d d)))
342     (declare (dynamic-extent fp))
343     (assert (eql s (fp-struct-2-s fp)))
344     (assert (eql d (fp-struct-2-d fp)))))
345
346 (with-test (:name (:test-fp-struct-2.1))
347   (test-fp-struct-2.1 123.456 876.243d0))
348 (with-test (:name (:test-fp-struct-2.2))
349   (test-fp-struct-2.2 123.456 876.243d0))
350 (with-test (:name (:test-fp-struct-2.3))
351   (test-fp-struct-2.3 123.456 876.243d0))
352 (with-test (:name (:test-fp-struct-2.4))
353   (test-fp-struct-2.4 123.456 876.243d0))
354
355 (declaim (inline make-cfp-struct-1))
356 (defstruct cfp-struct-1
357   (s (complex 0.0) :type (complex single-float))
358   (d (complex 0.0d0) :type (complex double-float)))
359
360 (defun-with-dx test-cfp-struct-1.1 (s d)
361   (let ((cfp (make-cfp-struct-1 :s s)))
362     (declare (dynamic-extent cfp))
363     (assert (eql s (cfp-struct-1-s cfp)))
364     (assert (eql (complex 0.0d0) (cfp-struct-1-d cfp)))))
365
366 (defun-with-dx test-cfp-struct-1.2 (s d)
367   (let ((cfp (make-cfp-struct-1 :d d)))
368     (declare (dynamic-extent cfp))
369     (assert (eql (complex 0.0) (cfp-struct-1-s cfp)))
370     (assert (eql d (cfp-struct-1-d cfp)))))
371
372 (defun-with-dx test-cfp-struct-1.3 (s d)
373   (let ((cfp (make-cfp-struct-1 :d d :s s)))
374     (declare (dynamic-extent cfp))
375     (assert (eql s (cfp-struct-1-s cfp)))
376     (assert (eql d (cfp-struct-1-d cfp)))))
377
378 (defun-with-dx test-cfp-struct-1.4 (s d)
379   (let ((cfp (make-cfp-struct-1 :s s :d d)))
380     (declare (dynamic-extent cfp))
381     (assert (eql s (cfp-struct-1-s cfp)))
382     (assert (eql d (cfp-struct-1-d cfp)))))
383
384 (with-test (:name (:test-cfp-struct-1.1))
385   (test-cfp-struct-1.1 (complex 0.123 123.456) (complex 908132.41d0 876.243d0)))
386 (with-test (:name (:test-cfp-struct-1.2))
387   (test-cfp-struct-1.2 (complex 0.123 123.456) (complex 908132.41d0 876.243d0)))
388 (with-test (:name (:test-cfp-struct-1.3))
389   (test-cfp-struct-1.3 (complex 0.123 123.456) (complex 908132.41d0 876.243d0)))
390 (with-test (:name (:test-cfp-struct-1.4))
391   (test-cfp-struct-1.4 (complex 0.123 123.456) (complex 908132.41d0 876.243d0)))
392
393 (declaim (inline make-cfp-struct-2))
394 (defstruct cfp-struct-2
395   (d (complex 0.0d0) :type (complex double-float))
396   (s (complex 0.0) :type (complex single-float)))
397
398 (defun-with-dx test-cfp-struct-2.1 (s d)
399   (let ((cfp (make-cfp-struct-2 :s s)))
400     (declare (dynamic-extent cfp))
401     (assert (eql s (cfp-struct-2-s cfp)))
402     (assert (eql (complex 0.0d0) (cfp-struct-2-d cfp)))))
403
404 (defun-with-dx test-cfp-struct-2.2 (s d)
405   (let ((cfp (make-cfp-struct-2 :d d)))
406     (declare (dynamic-extent cfp))
407     (assert (eql (complex 0.0) (cfp-struct-2-s cfp)))
408     (assert (eql d (cfp-struct-2-d cfp)))))
409
410 (defun-with-dx test-cfp-struct-2.3 (s d)
411   (let ((cfp (make-cfp-struct-2 :d d :s s)))
412     (declare (dynamic-extent cfp))
413     (assert (eql s (cfp-struct-2-s cfp)))
414     (assert (eql d (cfp-struct-2-d cfp)))))
415
416 (defun-with-dx test-cfp-struct-2.4 (s d)
417   (let ((cfp (make-cfp-struct-2 :s s :d d)))
418     (declare (dynamic-extent cfp))
419     (assert (eql s (cfp-struct-2-s cfp)))
420     (assert (eql d (cfp-struct-2-d cfp)))))
421
422 (with-test (:name (:test-cfp-struct-2.1))
423   (test-cfp-struct-2.1 (complex 0.123 123.456) (complex 908132.41d0 876.243d0)))
424 (with-test (:name (:test-cfp-struct-2.2))
425   (test-cfp-struct-2.2 (complex 0.123 123.456) (complex 908132.41d0 876.243d0)))
426 (with-test (:name (:test-cfp-struct-2.3))
427   (test-cfp-struct-2.3 (complex 0.123 123.456) (complex 908132.41d0 876.243d0)))
428 (with-test (:name (:test-cfp-struct-2.4))
429   (test-cfp-struct-2.4 (complex 0.123 123.456) (complex 908132.41d0 876.243d0)))
430
431 (declaim (inline make-foo1 make-foo2 make-foo3))
432 (defstruct foo1 x)
433
434 (defun-with-dx make-foo1-on-stack (x)
435   (let ((foo (make-foo1 :x x)))
436     (declare (dynamic-extent foo))
437     (assert (eql x (foo1-x foo)))))
438
439 (defstruct foo2
440   (x 0.0 :type single-float)
441   (y 0.0d0 :type double-float)
442   a
443   b
444   c)
445
446 (defun-with-dx make-foo2-on-stack (x y)
447   (let ((foo (make-foo2 :y y :c 'c)))
448     (declare (dynamic-extent foo))
449     (assert (eql 0.0 (foo2-x foo)))
450     (assert (eql y (foo2-y foo)))
451     (assert (eql 'c (foo2-c foo)))
452     (assert (eql nil (foo2-b foo)))))
453
454 ;;; Check that constants work out as argument for all relevant
455 ;;; slot types.
456 (defstruct foo3
457   (a 0 :type t)
458   (b 1 :type fixnum)
459   (c 2 :type sb-vm:word)
460   (d 3.0 :type single-float)
461   (e 4.0d0 :type double-float))
462
463 (defun-with-dx make-foo3-on-stack ()
464   (let ((foo (make-foo3)))
465     (declare (dynamic-extent foo))
466     (assert (eql 0 (foo3-a foo)))
467     (assert (eql 1 (foo3-b foo)))
468     (assert (eql 2 (foo3-c foo)))
469     (assert (eql 3.0 (foo3-d foo)))
470     (assert (eql 4.0d0 (foo3-e foo)))))
471
472 ;;; Nested DX
473
474 (defun-with-dx nested-dx-lists ()
475   (let ((dx (list (list 1 2) (list 3 4))))
476     (declare (dynamic-extent dx))
477     (true dx)
478     nil))
479
480 (defun-with-dx nested-dx-conses ()
481   (let ((dx (cons 1 (cons 2 (cons 3 (cons (cons t t) nil))))))
482     (declare (dynamic-extent dx))
483     (true dx)
484     nil))
485
486 (defun-with-dx nested-dx-not-used (x)
487   (declare (list x))
488   (let ((l (setf (car x) (list x x x))))
489     (declare (dynamic-extent l))
490     (true l)
491     (true (length l))
492     nil))
493
494 (defun-with-dx nested-evil-dx-used (x)
495   (declare (list x))
496   (let ((l (list x x x)))
497     (declare (dynamic-extent l))
498     (unwind-protect
499          (progn
500            (setf (car x) l)
501            (true l))
502       (setf (car x) nil))
503     nil))
504
505 (defparameter *bar* nil)
506 (declaim (inline make-nested-bad make-nested-good))
507 (defstruct (nested (:constructor make-nested-bad (&key bar &aux (bar (setf *bar* bar))))
508                    (:constructor make-nested-good (&key bar)))
509   bar)
510
511 (defun-with-dx nested-good (y)
512   (let ((x (list (list (make-nested-good :bar (list (list (make-nested-good :bar (list y)))))))))
513     (declare (dynamic-extent x))
514     (true x)))
515
516 (defun-with-dx nested-bad (y)
517   (let ((x (list (list (make-nested-bad :bar (list (list (make-nested-bad :bar (list y)))))))))
518     (declare (dynamic-extent x))
519     (unless (equalp (caar x) (make-nested-good :bar *bar*))
520       (error "got ~S, wanted ~S" (caar x) (make-nested-good :bar *bar*)))
521     (caar x)))
522
523 (with-test (:name :conservative-nested-dx)
524   ;; NESTED-BAD should not stack-allocate :BAR due to the SETF.
525   (assert (equalp (nested-bad 42) (make-nested-good :bar *bar*)))
526   (assert (equalp *bar* (list (list (make-nested-bad :bar (list 42)))))))
527
528 ;;; multiple uses for dx lvar
529
530 (defun-with-dx multiple-dx-uses ()
531   (let ((dx (if (true t)
532                 (list 1 2 3)
533                 (list 2 3 4))))
534     (declare (dynamic-extent dx))
535     (true dx)
536     nil))
537
538 ;;; handler-case and handler-bind should use DX internally
539
540 (defun dx-handler-bind (x)
541   (handler-bind ((error
542                   #'(lambda (c)
543                       (break "OOPS: ~S caused ~S" x c)))
544                  ((and serious-condition (not error))
545                   #'(lambda (c)
546                       (break "OOPS2: ~S did ~S" x c))))
547     (/ 2 x)))
548
549 (defun dx-handler-case (x)
550   (assert (zerop (handler-case (/ 2 x)
551                    (error (c)
552                      (break "OOPS: ~S caused ~S" x c)
553                      -1)
554                    (:no-error (res)
555                      (1- res))))))
556
557 (defvar *a-cons* (cons nil nil))
558
559 (with-test (:name (:no-consing :dx-closures) :skipped-on '(not :stack-allocatable-closures))
560   (assert-no-consing (dxclosure 42)))
561
562 (with-test (:name (:no-consing :dx-lists) :skipped-on '(not :stack-allocatable-lists))
563   (assert-no-consing (dxlength 1 2 3))
564   (assert-no-consing (dxlength t t t t t t))
565   (assert-no-consing (dxlength))
566   (assert-no-consing (dxcaller 1 2 3 4 5 6 7))
567   (assert-no-consing (test-nip-values))
568   (assert-no-consing (test-let-var-subst2 17))
569   (assert-no-consing (test-lvar-subst 11))
570   (assert-no-consing (nested-dx-lists))
571   (assert-consing (nested-dx-not-used *a-cons*))
572   (assert-no-consing (nested-evil-dx-used *a-cons*))
573   (assert-no-consing (multiple-dx-uses)))
574
575 (with-test (:name (:no-consing :dx-value-cell))
576   (assert-no-consing (dx-value-cell 13)))
577
578 (with-test (:name (:no-consing :dx-fixed-objects) :skipped-on '(not :stack-allocatable-fixed-objects))
579   (assert-no-consing (cons-on-stack 42))
580   (assert-no-consing (make-foo1-on-stack 123))
581   (assert-no-consing (nested-good 42))
582   (assert-no-consing (nested-dx-conses))
583   (assert-no-consing (dx-handler-bind 2))
584   (assert-no-consing (dx-handler-case 2)))
585
586 (with-test (:name (:no-consing :dx-vectors) :skipped-on '(not :stack-allocatable-vectors))
587   (assert-no-consing (force-make-array-on-stack 128))
588   (assert-no-consing (make-array-on-stack-2 5 '(1 2.0 3 4.0 5)))
589   (assert-no-consing (make-array-on-stack-3 9 8 7))
590   (assert-no-consing (make-array-on-stack-4))
591   (assert-no-consing (make-array-on-stack-5))
592   (assert-no-consing (vector-on-stack :x :y)))
593
594 (with-test (:name (:no-consing :specialized-dx-vectors)
595             :fails-on :x86
596             :skipped-on `(not (and :stack-allocatable-vectors
597                                    :c-stack-is-control-stack)))
598   (assert-no-consing (make-array-on-stack-1))
599   (assert-no-consing (make-array-on-stack-6))
600   (assert-no-consing (make-array-on-stack-7))
601   (assert-no-consing (make-array-on-stack-8))
602   (assert-no-consing (make-array-on-stack-9))
603   (assert-no-consing (make-array-on-stack-10))
604   (assert-no-consing (make-array-on-stack-11)))
605
606 (with-test (:name (:no-consing :dx-raw-instances) :skipped-on '(or (not :raw-instance-init-vops)
607                                                                    (not (and :gencgc :c-stack-is-control-stack))))
608   (let (a b)
609     (setf a 1.24 b 1.23d0)
610     (assert-no-consing (make-foo2-on-stack a b)))
611     (assert-no-consing (make-foo3-on-stack)))
612
613 ;;; not really DX, but GETHASH and (SETF GETHASH) should not cons
614
615 (defvar *table* (make-hash-table))
616
617 (defun test-hash-table ()
618   (setf (gethash 5 *table*) 13)
619   (gethash 5 *table*))
620
621 ;; This fails on threaded PPC because the hash-table implementation
622 ;; uses recursive system locks, which cons (see below for test
623 ;; (:no-consing :lock), which also fails on threaded PPC).
624 ;;
625 ;; -- That may have been the situation in 2010 when the above comment
626 ;; was written, but AFAICT now, hash tables use WITH-PINNED-OBJECTS,
627 ;; which conses on PPC and SPARC when GENCGC is enabled.  So neither is
628 ;; this actually about threading, nor about PPC.  Yet since we are
629 ;; failing most of this file on SPARC anyway (for some tests even on
630 ;; cheneygc), I won't bother to mark this particular test as failing.
631 ;; It would be nice if someone could go through this file and figure it
632 ;; all out... --DFL
633 (with-test (:name (:no-consing :hash-tables) :fails-on '(and :ppc :sb-thread))
634   (assert-no-consing (test-hash-table)))
635
636 ;;; Both with-pinned-objects and without-gcing should not cons
637
638 (defun call-without-gcing (fun)
639   (sb-sys:without-gcing (funcall fun)))
640
641 (defun call-with-pinned-object (fun obj)
642   (sb-sys:with-pinned-objects (obj)
643     (funcall fun obj)))
644
645 (with-test (:name (:no-consing :without-gcing))
646   (assert-no-consing (call-without-gcing (lambda ()))))
647
648 (with-test (:name (:no-consing :with-pinned-objects))
649   (assert-no-consing (call-with-pinned-object #'identity 42)))
650
651 ;;; with-mutex should use DX and not cons
652
653 (defvar *mutex* (sb-thread::make-mutex :name "mutexlock"))
654
655 (defun test-mutex ()
656   (sb-thread:with-mutex (*mutex*)
657     (true *mutex*)))
658
659 (with-test (:name (:no-consing :mutex) :fails-on :ppc :skipped-on '(not :sb-thread))
660   (assert-no-consing (test-mutex)))
661 \f
662
663 ;;; Bugs found by Paul F. Dietz
664
665 (with-test (:name (:dx-bug-misc :pfdietz))
666   (assert
667    (eq
668     (funcall
669      (compile
670       nil
671       '(lambda (a b)
672         (declare (optimize (speed 2) (space 0) (safety 0)
673                   (debug 1) (compilation-speed 3)))
674         (let* ((v5 (cons b b)))
675           (declare (dynamic-extent v5))
676           a)))
677      'x 'y)
678     'x)))
679
680 ;;; bug reported by Svein Ove Aas
681 (defun svein-2005-ii-07 (x y)
682   (declare (optimize (speed 3) (space 2) (safety 0) (debug 0)))
683   (let ((args (list* y 1 2 x)))
684     (declare (dynamic-extent args))
685     (apply #'aref args)))
686
687 (with-test (:name (:dx-bugs-misc :svein-2005-ii-07))
688   (assert (eql
689            (svein-2005-ii-07
690             '(0)
691             #3A(((1 1 1) (1 1 1) (1 1 1))
692                 ((1 1 1) (1 1 1) (4 1 1))
693                 ((1 1 1) (1 1 1) (1 1 1))))
694            4)))
695
696 ;;; bug reported by Brian Downing: stack-allocated arrays were not
697 ;;; filled with zeroes.
698 (defun-with-dx bdowning-2005-iv-16 ()
699   (let ((a (make-array 11 :initial-element 0)))
700     (declare (dynamic-extent a))
701     (assert (every (lambda (x) (eql x 0)) a))))
702
703 (with-test (:name (:dx-bug-misc :bdowning-2005-iv-16))
704   #+(or hppa mips x86 x86-64)
705   (assert-no-consing (bdowning-2005-iv-16))
706   (bdowning-2005-iv-16))
707
708 (declaim (inline my-nconc))
709 (defun my-nconc (&rest lists)
710   (declare (dynamic-extent lists))
711   (apply #'nconc lists))
712 (defun-with-dx my-nconc-caller (a b c)
713   (let ((l1 (list a b c))
714         (l2 (list a b c)))
715     (my-nconc l1 l2)))
716 (with-test (:name :rest-stops-the-buck)
717   (let ((list1 (my-nconc-caller 1 2 3))
718         (list2 (my-nconc-caller 9 8 7)))
719     (assert (equal list1 '(1 2 3 1 2 3)))
720     (assert (equal list2 '(9 8 7 9 8 7)))))
721
722 (defun-with-dx let-converted-vars-dx-allocated-bug (x y z)
723   (let* ((a (list x y z))
724          (b (list x y z))
725          (c (list a b)))
726     (declare (dynamic-extent c))
727     (values (first c) (second c))))
728 (with-test (:name :let-converted-vars-dx-allocated-bug)
729   (multiple-value-bind (i j) (let-converted-vars-dx-allocated-bug 1 2 3)
730     (assert (and (equal i j)
731                  (equal i (list 1 2 3))))))
732
733 ;;; workaround for bug 419 -- real issue remains, but check that the
734 ;;; bandaid holds.
735 (defun-with-dx bug419 (x)
736   (multiple-value-call #'list
737     (eval '(values 1 2 3))
738     (let ((x x))
739       (declare (dynamic-extent x))
740       (flet ((mget (y)
741                (+ x y))
742              (mset (z)
743                (incf x z)))
744         (declare (dynamic-extent #'mget #'mset))
745         ((lambda (f g) (eval `(progn ,f ,g (values 4 5 6)))) #'mget #'mset)))))
746
747 (with-test (:name (:dx-bug-misc :bug419))
748   (assert (equal (bug419 42) '(1 2 3 4 5 6))))
749
750 ;;; Multiple DX arguments in a local function call
751 (defun test-dx-flet-test (fun n f1 f2 f3)
752   (let ((res (with-output-to-string (s)
753                (assert (eql n (ignore-errors (funcall fun s)))))))
754     (multiple-value-bind (x pos) (read-from-string res nil)
755       (assert (equalp f1 x))
756       (multiple-value-bind (y pos2) (read-from-string res nil nil :start pos)
757         (assert (equalp f2 y))
758         (assert (equalp f3 (read-from-string res nil nil :start pos2))))))
759   #+(or hppa mips x86 x86-64)
760   (assert-no-consing (assert (eql n (funcall fun nil))))
761   (assert (eql n (funcall fun nil))))
762
763 (macrolet ((def (n f1 f2 f3)
764              (let ((name (sb-pcl::format-symbol :cl-user "DX-FLET-TEST.~A" n)))
765                `(progn
766                   (defun-with-dx ,name (s)
767                     (flet ((f (x)
768                              (declare (dynamic-extent x))
769                              (when s
770                                (print x s)
771                                (finish-output s))
772                              nil))
773                       (f ,f1)
774                       (f ,f2)
775                       (f ,f3)
776                       ,n))
777                   (with-test (:name (:dx-flet-test ,n))
778                     (test-dx-flet-test #',name ,n ,f1 ,f2 ,f3))))))
779   (def 0 (list :one) (list :two) (list :three))
780   (def 1 (make-array 128) (list 1 2 3 4 5 6 7 8) (list 'list))
781   (def 2 (list 1) (list 2 3) (list 4 5 6 7)))
782
783 ;;; Test that unknown-values coming after a DX value won't mess up the
784 ;;; stack analysis
785 (defun test-update-uvl-live-sets (x y z)
786  (declare (optimize speed (safety 0)))
787  (flet ((bar (a b)
788           (declare (dynamic-extent a))
789           (eval `(list (length ',a) ',b))))
790    (list (bar x y)
791          (bar (list x y z)                  ; dx push
792               (list
793                (multiple-value-call 'list
794                  (eval '(values 1 2 3))     ; uv push
795                  (max y z)
796                )                            ; uv pop
797                14)
798          ))))
799
800 (with-test (:name (:update-uvl-live-sets))
801   (assert (equal '((0 4) (3 ((1 2 3 5) 14)))
802                  (test-update-uvl-live-sets #() 4 5))))
803
804 (with-test (:name :regression-1.0.23.38)
805   (compile nil '(lambda ()
806                  (flet ((make (x y)
807                           (let ((res (cons x x)))
808                             (setf (cdr res) y)
809                             res)))
810                    (declaim (inline make))
811                    (let ((z (make 1 2)))
812                      (declare (dynamic-extent z))
813                      (print z)
814                      t))))
815   (compile nil '(lambda ()
816                  (flet ((make (x y)
817                           (let ((res (cons x x)))
818                             (setf (cdr res) y)
819                             (if x res y))))
820                    (declaim (inline make))
821                    (let ((z (make 1 2)))
822                      (declare (dynamic-extent z))
823                      (print z)
824                      t)))))
825
826 ;;; On x86 and x86-64 upto 1.0.28.16 LENGTH and WORDS argument
827 ;;; tns to ALLOCATE-VECTOR-ON-STACK could be packed in the same
828 ;;; location, leading to all manner of badness. ...reproducing this
829 ;;; reliably is hard, but this it at least used to break on x86-64.
830 (defun length-and-words-packed-in-same-tn (m)
831   (declare (optimize speed (safety 0) (debug 0) (space 0)))
832   (let ((array (make-array (max 1 m) :element-type 'fixnum)))
833     (declare (dynamic-extent array))
834     (array-total-size array)))
835 (with-test (:name :length-and-words-packed-in-same-tn)
836   (assert (= 1 (length-and-words-packed-in-same-tn -3))))
837
838 (with-test (:name :handler-case-bogus-compiler-note :fails-on :ppc)
839   (handler-bind
840       ((compiler-note (lambda (note)
841                         (error "compiler issued note ~S during test" note))))
842     ;; Taken from SWANK, used to signal a bogus stack allocation
843     ;; failure note.
844     (compile nil
845              `(lambda (files fasl-dir load)
846                 (let ((needs-recompile nil))
847                   (dolist (src files)
848                     (let ((dest (binary-pathname src fasl-dir)))
849                       (handler-case
850                           (progn
851                             (when (or needs-recompile
852                                       (not (probe-file dest))
853                                       (file-newer-p src dest))
854                               (setq needs-recompile t)
855                               (ensure-directories-exist dest)
856                               (compile-file src :output-file dest :print nil :verbose t))
857                             (when load
858                               (load dest :verbose t)))
859                         (serious-condition (c)
860                           (handle-loadtime-error c dest))))))))))
861
862 (declaim (inline foovector barvector))
863 (defun foovector (x y z)
864   (let ((v (make-array 3)))
865     (setf (aref v 0) x
866           (aref v 1) y
867           (aref v 2) z)
868     v))
869 (defun barvector (x y z)
870   (make-array 3 :initial-contents (list x y z)))
871 (with-test (:name :dx-compiler-notes :fails-on :ppc)
872   (flet ((assert-notes (j lambda)
873            (let ((n 0))
874              (handler-bind ((compiler-note (lambda (c)
875                                              (declare (ignore c))
876                                              (incf n))))
877                (compile nil lambda)
878                (unless (= j n)
879                  (error "Wanted ~S notes, got ~S for~%   ~S"
880                         j n lambda))))))
881     ;; These ones should complain.
882     (assert-notes 1 `(lambda (x)
883                        (let ((v (make-array x)))
884                          (declare (dynamic-extent v))
885                          (length v))))
886     (assert-notes 2 `(lambda (x)
887                        (let ((y (if (plusp x)
888                                     (true x)
889                                     (true (- x)))))
890                          (declare (dynamic-extent y))
891                          (print y)
892                          nil)))
893     (assert-notes 1 `(lambda (x)
894                        (let ((y (foovector x x x)))
895                          (declare (sb-int:truly-dynamic-extent y))
896                          (print y)
897                          nil)))
898     ;; These ones should not complain.
899     (assert-notes 0 `(lambda (name)
900                        (with-alien
901                            ((posix-getenv (function c-string c-string)
902                                           :EXTERN "getenv"))
903                          (values
904                           (alien-funcall posix-getenv name)))))
905     (assert-notes 0 `(lambda (x)
906                        (let ((y (barvector x x x)))
907                          (declare (dynamic-extent y))
908                          (print y)
909                          nil)))
910     (assert-notes 0 `(lambda (list)
911                        (declare (optimize (space 0)))
912                        (sort list (lambda (x y) ; shut unrelated notes up
913                                     (< (truly-the fixnum x)
914                                        (truly-the fixnum y))))))
915     (assert-notes 0 `(lambda (other)
916                        #'(lambda (s c n)
917                            (ignore-errors (funcall other s c n)))))))
918
919 ;;; Stack allocating a value cell in HANDLER-CASE would blow up stack
920 ;;; in an unfortunate loop.
921 (defun handler-case-eating-stack ()
922   (let ((sp nil))
923     (do ((n 0 (logand most-positive-fixnum (1+ n))))
924         ((>= n 1024))
925      (multiple-value-bind (value error) (ignore-errors)
926        (when (and value error) nil))
927       (if sp
928           (assert (= sp (sb-c::%primitive sb-c:current-stack-pointer)))
929           (setf sp (sb-c::%primitive sb-c:current-stack-pointer))))))
930 (with-test (:name :handler-case-eating-stack :fails-on :ppc)
931   (assert-no-consing (handler-case-eating-stack)))
932
933 ;;; A nasty bug where RECHECK-DYNAMIC-EXTENT-LVARS thought something was going
934 ;;; to be stack allocated when it was not, leading to a bogus %NIP-VALUES.
935 ;;; Fixed by making RECHECK-DYNAMIC-EXTENT-LVARS deal properly with nested DX.
936 (deftype vec ()
937   `(simple-array single-float (3)))
938 (declaim (ftype (function (t t t) vec) vec))
939 (declaim (inline vec))
940 (defun vec (a b c)
941   (make-array 3 :element-type 'single-float :initial-contents (list a b c)))
942 (defun bad-boy (vec)
943   (declare (type vec vec))
944   (lambda (fun)
945     (let ((vec (vec (aref vec 0) (aref vec 1) (aref vec 2))))
946       (declare (dynamic-extent vec))
947       (funcall fun vec))))
948 (with-test (:name :recheck-nested-dx-bug :fails-on :ppc)
949   (assert (funcall (bad-boy (vec 1.0 2.0 3.3))
950                    (lambda (vec) (equalp vec (vec 1.0 2.0 3.3)))))
951   (flet ((foo (x) (declare (ignore x))))
952     (let ((bad-boy (bad-boy (vec 2.0 3.0 4.0))))
953       (assert-no-consing (funcall bad-boy #'foo)))))
954
955 (with-test (:name :bug-497321)
956   (flet ((test (lambda type)
957            (let ((n 0))
958              (handler-bind ((condition (lambda (c)
959                                          (incf n)
960                                          (unless (typep c type)
961                                            (error "wanted ~S for~%  ~S~%got ~S"
962                                                   type lambda (type-of c))))))
963                (compile nil lambda))
964              (assert (= n 1)))))
965     (test `(lambda () (declare (dynamic-extent #'bar)))
966           'style-warning)
967     (test `(lambda () (declare (dynamic-extent bar)))
968           'style-warning)
969     (test `(lambda (bar) (cons bar (lambda () (declare (dynamic-extent bar)))))
970           'sb-ext:compiler-note)
971     (test `(lambda ()
972              (flet ((bar () t))
973                (cons #'bar (lambda () (declare (dynamic-extent #'bar))))))
974           'sb-ext:compiler-note)))
975
976 (with-test (:name :bug-586105 :fails-on '(not (and :stack-allocatable-vectors
977                                                    :stack-allocatable-lists)))
978   (flet ((test (x)
979            (let ((vec (make-array 1 :initial-contents (list (list x)))))
980              (declare (dynamic-extent vec))
981              (assert (eql x (car (aref vec 0)))))))
982     (assert-no-consing (test 42))))
983 \f
984 (defun bug-681092 ()
985   (declare (optimize speed))
986   (let ((c 0))
987     (flet ((bar () c))
988       (declare (dynamic-extent #'bar))
989       (do () ((list) (bar))
990         (setf c 10)
991         (return (bar))))))
992 (with-test (:name :bug-681092)
993   (assert (= 10 (bug-681092))))
994
995 ;;;; &REST lists should stop DX propagation -- not required by ANSI,
996 ;;;; but required by sanity.
997
998 (declaim (inline rest-stops-dx))
999 (defun-with-dx rest-stops-dx (&rest args)
1000   (declare (dynamic-extent args))
1001   (apply #'opaque-identity args))
1002
1003 (defun-with-dx rest-stops-dx-ok ()
1004   (equal '(:foo) (rest-stops-dx (list :foo))))
1005
1006 (with-test (:name :rest-stops-dynamic-extent)
1007   (assert (rest-stops-dx-ok)))
1008
1009 ;;;; These tests aren't strictly speaking DX, but rather &REST -> &MORE
1010 ;;;; conversion.
1011 (with-test (:name :rest-to-more-conversion)
1012   (let ((f1 (compile nil `(lambda (f &rest args)
1013                             (apply f args)))))
1014     (assert-no-consing (assert (eql f1 (funcall f1 #'identity f1)))))
1015   (let ((f2 (compile nil `(lambda (f1 f2 &rest args)
1016                             (values (apply f1 args) (apply f2 args))))))
1017     (assert-no-consing (multiple-value-bind (a b)
1018                            (funcall f2 (lambda (x y z) (+ x y z)) (lambda (x y z) (- x y z))
1019                                     1 2 3)
1020                          (assert (and (eql 6 a) (eql -4 b))))))
1021   (let ((f3 (compile nil `(lambda (f &optional x &rest args)
1022                             (when x
1023                               (apply f x args))))))
1024     (assert-no-consing (assert (eql 42 (funcall f3
1025                                                 (lambda (a b c) (+ a b c))
1026                                                 11
1027                                                 10
1028                                                 21)))))
1029   (let ((f4 (compile nil `(lambda (f &optional x &rest args &key y &allow-other-keys)
1030                             (apply f y x args)))))
1031     (assert-no-consing (funcall f4 (lambda (y x yk y2 b c)
1032                                      (assert (eq y 'y))
1033                                      (assert (= x 2))
1034                                      (assert (eq :y yk))
1035                                      (assert (eq y2 'y))
1036                                      (assert (eq b 'b))
1037                                      (assert (eq c 'c)))
1038                                 2 :y 'y 'b 'c)))
1039   (let ((f5 (compile nil `(lambda (a b c &rest args)
1040                             (apply #'list* a b c args)))))
1041     (assert (equal '(1 2 3 4 5 6 7) (funcall f5 1 2 3 4 5 6 '(7)))))
1042   (let ((f6 (compile nil `(lambda (x y)
1043                             (declare (optimize speed))
1044                             (concatenate 'string x y)))))
1045     (assert (equal "foobar" (funcall f6 "foo" "bar"))))
1046   (let ((f7 (compile nil `(lambda (&rest args)
1047                             (lambda (f)
1048                               (apply f args))))))
1049     (assert (equal '(a b c d e f) (funcall (funcall f7 'a 'b 'c 'd 'e 'f) 'list))))
1050   (let ((f8 (compile nil `(lambda (&rest args)
1051                             (flet ((foo (f)
1052                                      (apply f args)))
1053                               #'foo)))))
1054     (assert (equal '(a b c d e f) (funcall (funcall f8 'a 'b 'c 'd 'e 'f) 'list))))
1055   (let ((f9 (compile nil `(lambda (f &rest args)
1056                             (flet ((foo (g)
1057                                      (apply g args)))
1058                               (declare (dynamic-extent #'foo))
1059                               (funcall f #'foo))))))
1060     (assert (equal '(a b c d e f)
1061                    (funcall f9 (lambda (f) (funcall f 'list)) 'a 'b 'c 'd 'e 'f))))
1062   (let ((f10 (compile nil `(lambda (f &rest args)
1063                             (flet ((foo (g)
1064                                      (apply g args)))
1065                               (funcall f #'foo))))))
1066     (assert (equal '(a b c d e f)
1067                    (funcall f10 (lambda (f) (funcall f 'list)) 'a 'b 'c 'd 'e 'f))))
1068   (let ((f11 (compile nil `(lambda (x y z)
1069                              (block out
1070                                (labels ((foo (x &rest rest)
1071                                           (apply (lambda (&rest rest2)
1072                                                    (return-from out (values-list rest2)))
1073                                                  x rest)))
1074                                 (if x
1075                                     (foo x y z)
1076                                     (foo y z x))))))))
1077     (multiple-value-bind (a b c) (funcall f11 1 2 3)
1078       (assert (eql a 1))
1079       (assert (eql b 2))
1080       (assert (eql c 3)))))
1081
1082 (defun opaque-funcall (function &rest arguments)
1083   (apply function arguments))
1084
1085 (with-test (:name :implicit-value-cells)
1086   (flet ((test-it (type input output)
1087            (let ((f (compile nil `(lambda (x)
1088                                     (declare (type ,type x))
1089                                     (flet ((inc ()
1090                                              (incf x)))
1091                                       (declare (dynamic-extent #'inc))
1092                                       (list (opaque-funcall #'inc) x))))))
1093              (assert (equal (funcall f input)
1094                             (list output output))))))
1095     (let ((width sb-vm:n-word-bits))
1096       (test-it t (1- most-positive-fixnum) most-positive-fixnum)
1097       (test-it `(unsigned-byte ,(1- width)) (ash 1 (- width 2)) (1+ (ash 1 (- width 2))))
1098       (test-it `(signed-byte ,width) (ash -1 (- width 2)) (1+ (ash -1 (- width 2))))
1099       (test-it `(unsigned-byte ,width) (ash 1 (1- width)) (1+ (ash 1 (1- width))))
1100       (test-it 'single-float 3f0 4f0)
1101       (test-it 'double-float 3d0 4d0)
1102       (test-it '(complex single-float) #c(3f0 4f0) #c(4f0 4f0))
1103       (test-it '(complex double-float) #c(3d0 4d0) #c(4d0 4d0)))))
1104
1105 (with-test (:name :sap-implicit-value-cells)
1106   (let ((f (compile nil `(lambda (x)
1107                            (declare (type system-area-pointer x))
1108                            (flet ((inc ()
1109                                     (setf x (sb-sys:sap+ x 16))))
1110                              (declare (dynamic-extent #'inc))
1111                              (list (opaque-funcall #'inc) x)))))
1112         (width sb-vm:n-machine-word-bits))
1113     (assert (every (lambda (x)
1114                      (sb-sys:sap= x (sb-sys:int-sap (+ 16 (ash 1 (1- width))))))
1115                    (funcall f (sb-sys:int-sap (ash 1 (1- width))))))))
1116
1117 (with-test (:name :&more-bounds)
1118   ;; lp#1154946
1119   (assert (not (funcall (compile nil '(lambda (&rest args) (car args))))))
1120   (assert (not (funcall (compile nil '(lambda (&rest args) (nth 6 args))))))
1121   (assert (not (funcall (compile nil '(lambda (&rest args) (elt args 10))))))
1122   (assert (not (funcall (compile nil '(lambda (&rest args) (cadr args))))))
1123   (assert (not (funcall (compile nil '(lambda (&rest args) (third args)))))))