1 ;;;; miscellaneous tests of thread stuff
3 ;;;; This software is part of the SBCL system. See the README file for
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
10 ;;;; This software is in the public domain and is provided with
11 ;;;; absoluely no warranty. See the COPYING and CREDITS files for
12 ;;;; more information.
16 (in-package "SB-THREAD")
17 (use-package :test-util)
18 (use-package "ASSERTOID")
20 (setf sb-unix::*on-dangerous-wait* :error)
22 (defun wait-for-threads (threads)
23 (mapc (lambda (thread) (sb-thread:join-thread thread :default nil)) threads)
24 (assert (not (some #'sb-thread:thread-alive-p threads))))
26 (with-test (:name (:threads :trivia))
27 (assert (eql 1 (length (list-all-threads))))
29 (assert (eq *current-thread*
30 (find (thread-name *current-thread*) (list-all-threads)
31 :key #'thread-name :test #'equal)))
33 (assert (thread-alive-p *current-thread*)))
35 (with-test (:name (:with-mutex :basics))
36 (let ((mutex (make-mutex)))
40 (with-test (:name (:with-spinlock :basics))
41 (let ((spinlock (make-spinlock)))
42 (with-spinlock (spinlock))))
44 (sb-alien:define-alien-routine "check_deferrables_blocked_or_lose"
46 (where sb-alien:unsigned-long))
47 (sb-alien:define-alien-routine "check_deferrables_unblocked_or_lose"
49 (where sb-alien:unsigned-long))
51 (with-test (:name (:interrupt-thread :basics :no-unwinding))
53 (interrupt-thread *current-thread* (lambda () (setq a 1)))
56 (with-test (:name (:interrupt-thread :deferrables-blocked))
57 (sb-thread:interrupt-thread sb-thread:*current-thread*
59 (check-deferrables-blocked-or-lose 0))))
61 (with-test (:name (:interrupt-thread :deferrables-unblocked))
62 (sb-thread:interrupt-thread sb-thread:*current-thread*
65 (check-deferrables-unblocked-or-lose 0)))))
67 (with-test (:name (:interrupt-thread :nlx))
69 (sb-thread:interrupt-thread sb-thread:*current-thread*
71 (check-deferrables-blocked-or-lose 0)
73 (check-deferrables-unblocked-or-lose 0))
75 #-sb-thread (sb-ext:quit :unix-status 104)
77 ;;;; Now the real tests...
79 (with-test (:name (:interrupt-thread :deferrables-unblocked-by-spinlock))
80 (let ((spinlock (sb-thread::make-spinlock))
81 (thread (sb-thread:make-thread (lambda ()
83 (sb-thread::get-spinlock spinlock)
84 (sb-thread:interrupt-thread thread
86 (check-deferrables-blocked-or-lose 0)
87 (sb-thread::get-spinlock spinlock)
88 (check-deferrables-unblocked-or-lose 0)
91 (sb-thread::release-spinlock spinlock)))
95 (defmacro defincf (name accessor &rest args)
97 (let* ((old (,accessor x ,@args))
99 (loop until (eq old (sb-ext:compare-and-swap (,accessor x ,@args) old new))
100 do (setf old (,accessor x ,@args)
104 (defstruct cas-struct (slot 0))
106 (defincf incf-car car)
107 (defincf incf-cdr cdr)
108 (defincf incf-slot cas-struct-slot)
109 (defincf incf-symbol-value symbol-value)
110 (defincf incf-svref/1 svref 1)
111 (defincf incf-svref/0 svref 0)
113 (defmacro def-test-cas (name init incf op)
114 `(with-test (:name ,name)
121 collect (sb-thread:make-thread
124 do (sb-thread:thread-yield))
125 (loop repeat n do (,incf x)))))))
128 (sb-thread:join-thread th))
129 (assert (= (,op x) (* 10 n))))))
132 (def-test-cas test-cas-car (cons 0 nil) incf-car car)
133 (def-test-cas test-cas-cdr (cons nil 0) incf-cdr cdr)
134 (def-test-cas test-cas-slot (make-cas-struct) incf-slot cas-struct-slot)
135 (def-test-cas test-cas-value (let ((x '.x.))
138 incf-symbol-value symbol-value)
139 (def-test-cas test-cas-svref/0 (vector 0 nil) incf-svref/0 (lambda (x)
141 (def-test-cas test-cas-svref/1 (vector nil 0) incf-svref/1 (lambda (x)
143 (format t "~&compare-and-swap tests done~%")
145 (with-test (:name (:threads :more-trivia)))
146 (let ((old-threads (list-all-threads))
147 (thread (make-thread (lambda ()
148 (assert (find *current-thread* *all-threads*))
150 (new-threads (list-all-threads)))
151 (assert (thread-alive-p thread))
152 (assert (eq thread (first new-threads)))
153 (assert (= (1+ (length old-threads)) (length new-threads)))
155 (assert (not (thread-alive-p thread))))
157 (with-test (:name (:join-thread :nlx :default))
158 (let ((sym (gensym)))
159 (assert (eq sym (join-thread (make-thread (lambda () (sb-ext:quit)))
162 (with-test (:name (:join-thread :nlx :error))
163 (raises-error? (join-thread (make-thread (lambda () (sb-ext:quit))))
166 (with-test (:name (:join-thread :multiple-values))
167 (assert (equal '(1 2 3)
169 (join-thread (make-thread (lambda () (values 1 2 3))))))))
171 ;;; We had appalling scaling properties for a while. Make sure they
173 (defun scaling-test (function &optional (nthreads 5))
174 "Execute FUNCTION with NTHREADS lurking to slow it down."
175 (let ((queue (sb-thread:make-waitqueue))
176 (mutex (sb-thread:make-mutex)))
177 ;; Start NTHREADS idle threads.
178 (dotimes (i nthreads)
179 (sb-thread:make-thread (lambda ()
181 (sb-thread:condition-wait queue mutex))
183 (let ((start-time (get-internal-run-time)))
185 (prog1 (- (get-internal-run-time) start-time)
186 (sb-thread:condition-broadcast queue)))))
188 "A function that does work with the CPU."
189 (if (zerop n) 1 (* n (fact (1- n)))))
190 (let ((work (lambda () (fact 15000))))
191 (let ((zero (scaling-test work 0))
192 (four (scaling-test work 4)))
193 ;; a slightly weak assertion, but good enough for starters.
194 (assert (< four (* 1.5 zero)))))
196 ;;; For one of the interupt-thread tests, we want a foreign function
197 ;;; that does not make syscalls
199 (with-open-file (o "threads-foreign.c" :direction :output :if-exists :supersede)
200 (format o "void loop_forever() { while(1) ; }~%"))
201 (sb-ext:run-program "/bin/sh"
202 '("run-compiler.sh" "-sbcl-pic" "-sbcl-shared"
203 "-o" "threads-foreign.so" "threads-foreign.c")
204 :environment (test-util::test-env))
205 (sb-alien:load-shared-object (truename "threads-foreign.so"))
206 (sb-alien:define-alien-routine loop-forever sb-alien:void)
207 (delete-file "threads-foreign.c")
210 ;;; elementary "can we get a lock and release it again"
211 (with-test (:name (:mutex :basics))
212 (let ((l (make-mutex :name "foo"))
213 (p *current-thread*))
214 (assert (eql (mutex-value l) nil) nil "1")
215 (sb-thread:get-mutex l)
216 (assert (eql (mutex-value l) p) nil "3")
217 (sb-thread:release-mutex l)
218 (assert (eql (mutex-value l) nil) nil "5")))
220 (with-test (:name (:with-recursive-lock :basics))
221 (labels ((ours-p (value)
222 (eq *current-thread* value)))
223 (let ((l (make-mutex :name "rec")))
224 (assert (eql (mutex-value l) nil) nil "1")
225 (sb-thread:with-recursive-lock (l)
226 (assert (ours-p (mutex-value l)) nil "3")
227 (sb-thread:with-recursive-lock (l)
228 (assert (ours-p (mutex-value l)) nil "4"))
229 (assert (ours-p (mutex-value l)) nil "5"))
230 (assert (eql (mutex-value l) nil) nil "6"))))
232 (with-test (:name (:with-recursive-spinlock :basics))
233 (labels ((ours-p (value)
234 (eq *current-thread* value)))
235 (let ((l (make-spinlock :name "rec")))
236 (assert (eql (spinlock-value l) nil) nil "1")
237 (with-recursive-spinlock (l)
238 (assert (ours-p (spinlock-value l)) nil "3")
239 (with-recursive-spinlock (l)
240 (assert (ours-p (spinlock-value l)) nil "4"))
241 (assert (ours-p (spinlock-value l)) nil "5"))
242 (assert (eql (spinlock-value l) nil) nil "6"))))
244 (with-test (:name (:mutex :nesting-mutex-and-recursive-lock))
245 (let ((l (make-mutex :name "a mutex")))
247 (with-recursive-lock (l)))))
249 (with-test (:name (:spinlock :nesting-spinlock-and-recursive-spinlock))
250 (let ((l (make-spinlock :name "a spinlock")))
252 (with-recursive-spinlock (l)))))
254 (with-test (:name (:spinlock :more-basics))
255 (let ((l (make-spinlock :name "spinlock")))
256 (assert (eql (spinlock-value l) nil) ((spinlock-value l))
257 "spinlock not free (1)")
259 (assert (eql (spinlock-value l) *current-thread*) ((spinlock-value l))
260 "spinlock not taken"))
261 (assert (eql (spinlock-value l) nil) ((spinlock-value l))
262 "spinlock not free (2)")))
264 ;; test that SLEEP actually sleeps for at least the given time, even
265 ;; if interrupted by another thread exiting/a gc/anything
266 (with-test (:name (:sleep :continue-sleeping-after-interrupt))
267 (let ((start-time (get-universal-time)))
268 (make-thread (lambda () (sleep 1) (sb-ext:gc :full t)))
270 (assert (>= (get-universal-time) (+ 5 start-time)))))
273 (with-test (:name (:condition-wait :basics-1))
274 (let ((queue (make-waitqueue :name "queue"))
275 (lock (make-mutex :name "lock"))
277 (labels ((in-new-thread ()
279 (assert (eql (mutex-value lock) *current-thread*))
280 (format t "~A got mutex~%" *current-thread*)
281 ;; now drop it and sleep
282 (condition-wait queue lock)
283 ;; after waking we should have the lock again
284 (assert (eql (mutex-value lock) *current-thread*))
287 (make-thread #'in-new-thread)
288 (sleep 2) ; give it a chance to start
289 ;; check the lock is free while it's asleep
290 (format t "parent thread ~A~%" *current-thread*)
291 (assert (eql (mutex-value lock) nil))
294 (condition-notify queue))
297 (with-test (:name (:condition-wait :basics-2))
298 (let ((queue (make-waitqueue :name "queue"))
299 (lock (make-mutex :name "lock")))
300 (labels ((ours-p (value)
301 (eq *current-thread* value))
303 (with-recursive-lock (lock)
304 (assert (ours-p (mutex-value lock)))
305 (format t "~A got mutex~%" (mutex-value lock))
306 ;; now drop it and sleep
307 (condition-wait queue lock)
308 ;; after waking we should have the lock again
309 (format t "woken, ~A got mutex~%" (mutex-value lock))
310 (assert (ours-p (mutex-value lock))))))
311 (make-thread #'in-new-thread)
312 (sleep 2) ; give it a chance to start
313 ;; check the lock is free while it's asleep
314 (format t "parent thread ~A~%" *current-thread*)
315 (assert (eql (mutex-value lock) nil))
316 (with-recursive-lock (lock)
317 (condition-notify queue))
320 (with-test (:name (:mutex :contention))
321 (let ((mutex (make-mutex :name "contended")))
323 (let ((me *current-thread*))
327 (assert (eql (mutex-value mutex) me)))
328 (assert (not (eql (mutex-value mutex) me))))
329 (format t "done ~A~%" *current-thread*))))
330 (let ((kid1 (make-thread #'run))
331 (kid2 (make-thread #'run)))
332 (format t "contention ~A ~A~%" kid1 kid2)
333 (wait-for-threads (list kid1 kid2))))))
337 (with-test (:name (:grab-mutex :waitp nil))
338 (let ((m (make-mutex)))
340 (assert (null (join-thread (make-thread
342 (grab-mutex m :waitp nil)))))))))
344 (with-test (:name (:grab-mutex :timeout :acquisition-fail))
346 (error "Mutex timeout not supported here.")
347 (let ((m (make-mutex)))
349 (assert (null (join-thread (make-thread
351 (grab-mutex m :timeout 0.1)))))))))
353 (with-test (:name (:grab-mutex :timeout :acquisition-success))
355 (error "Mutex timeout not supported here.")
356 (let ((m (make-mutex))
359 (setq child (make-thread #'(lambda () (grab-mutex m :timeout 1.0))))
361 (assert (eq (join-thread child) 't))))
363 (with-test (:name (:grab-mutex :timeout+deadline))
365 (error "Mutex timeout not supported here.")
366 (let ((m (make-mutex)))
368 (assert (eq (join-thread
369 (make-thread #'(lambda ()
370 (sb-sys:with-deadline (:seconds 0.0)
372 (grab-mutex m :timeout 0.0)
373 (sb-sys:deadline-timeout ()
377 (with-test (:name (:grab-mutex :waitp+deadline))
379 (error "Mutex timeout not supported here.")
380 (let ((m (make-mutex)))
382 (assert (eq (join-thread
383 (make-thread #'(lambda ()
384 (sb-sys:with-deadline (:seconds 0.0)
386 (grab-mutex m :waitp nil)
387 (sb-sys:deadline-timeout ()
393 (defmacro raises-timeout-p (&body body)
394 `(handler-case (progn (progn ,@body) nil)
395 (sb-ext:timeout () t)))
397 (with-test (:name (:semaphore :wait-forever))
398 (let ((sem (make-semaphore :count 0)))
399 (assert (raises-timeout-p
400 (sb-ext:with-timeout 0.1
401 (wait-on-semaphore sem))))))
403 (with-test (:name (:semaphore :initial-count))
404 (let ((sem (make-semaphore :count 1)))
405 (sb-ext:with-timeout 0.1
406 (wait-on-semaphore sem))))
408 (with-test (:name (:semaphore :wait-then-signal))
409 (let ((sem (make-semaphore))
411 (make-thread (lambda ()
414 (signal-semaphore sem)))
415 (wait-on-semaphore sem)
416 (assert signalled-p)))
418 (with-test (:name (:semaphore :signal-then-wait))
419 (let ((sem (make-semaphore))
421 (make-thread (lambda ()
422 (signal-semaphore sem)
423 (setq signalled-p t)))
424 (loop until signalled-p)
425 (wait-on-semaphore sem)
426 (assert signalled-p)))
428 (defun test-semaphore-multiple-signals (wait-on-semaphore)
429 (let* ((sem (make-semaphore :count 5))
430 (threads (loop repeat 20 collecting
431 (make-thread (lambda ()
432 (funcall wait-on-semaphore sem))))))
433 (flet ((count-live-threads ()
434 (count-if #'thread-alive-p threads)))
436 (assert (= 15 (count-live-threads)))
437 (signal-semaphore sem 10)
439 (assert (= 5 (count-live-threads)))
440 (signal-semaphore sem 3)
442 (assert (= 2 (count-live-threads)))
443 (signal-semaphore sem 4)
445 (assert (= 0 (count-live-threads))))))
447 (with-test (:name (:semaphore :multiple-signals))
448 (test-semaphore-multiple-signals #'wait-on-semaphore))
450 (with-test (:name (:try-semaphore :trivial-fail))
451 (assert (eq (try-semaphore (make-semaphore :count 0)) 'nil)))
453 (with-test (:name (:try-semaphore :trivial-success))
454 (let ((sem (make-semaphore :count 1)))
455 (assert (try-semaphore sem))
456 (assert (zerop (semaphore-count sem)))))
458 (with-test (:name (:try-semaphore :trivial-fail :n>1))
459 (assert (eq (try-semaphore (make-semaphore :count 1) 2) 'nil)))
461 (with-test (:name (:try-semaphore :trivial-success :n>1))
462 (let ((sem (make-semaphore :count 10)))
463 (assert (try-semaphore sem 5))
464 (assert (try-semaphore sem 5))
465 (assert (zerop (semaphore-count sem)))))
467 (with-test (:name (:try-semaphore :emulate-wait-on-semaphore))
468 (flet ((busy-wait-on-semaphore (sem)
469 (loop until (try-semaphore sem) do (sleep 0.001))))
470 (test-semaphore-multiple-signals #'busy-wait-on-semaphore)))
472 ;;; Here we test that interrupting TRY-SEMAPHORE does not leave a
473 ;;; semaphore in a bad state.
474 (with-test (:name (:try-semaphore :interrupt-safe))
475 (flet ((make-threads (count fn)
476 (loop repeat count collect (make-thread fn)))
477 (kill-thread (thread)
478 (when (thread-alive-p thread)
479 (ignore-errors (terminate-thread thread))))
480 (count-live-threads (threads)
481 (count-if #'thread-alive-p threads)))
482 ;; WAITERS will already be waiting on the semaphore while
483 ;; threads-being-interrupted will perform TRY-SEMAPHORE on that
484 ;; semaphore, and MORE-WAITERS are new threads trying to wait on
485 ;; the semaphore during the interruption-fire.
486 (let* ((sem (make-semaphore :count 100))
487 (waiters (make-threads 20 #'(lambda ()
488 (wait-on-semaphore sem))))
489 (triers (make-threads 40 #'(lambda ()
490 (sleep (random 0.01))
491 (try-semaphore sem (1+ (random 5))))))
494 do (kill-thread (nth (random 40) triers))
495 collect (make-thread #'(lambda () (wait-on-semaphore sem)))
496 do (kill-thread (nth (random 40) triers)))))
498 ;; Now ensure that the waiting threads will all be waked up,
499 ;; i.e. that the semaphore is still working.
500 (loop repeat (+ (count-live-threads waiters)
501 (count-live-threads more-waiters))
502 do (signal-semaphore sem))
504 (assert (zerop (count-live-threads triers)))
505 (assert (zerop (count-live-threads waiters)))
506 (assert (zerop (count-live-threads more-waiters))))))
510 (format t "~&semaphore tests done~%")
512 (defun test-interrupt (function-to-interrupt &optional quit-p)
513 (let ((child (make-thread function-to-interrupt)))
514 ;;(format t "gdb ./src/runtime/sbcl ~A~%attach ~A~%" child child)
516 (format t "interrupting child ~A~%" child)
517 (interrupt-thread child
519 (format t "child pid ~A~%" *current-thread*)
520 (when quit-p (sb-ext:quit))))
524 ;; separate tests for (a) interrupting Lisp code, (b) C code, (c) a syscall,
525 ;; (d) waiting on a lock, (e) some code which we hope is likely to be
528 (with-test (:name (:interrupt-thread :more-basics))
529 (let ((child (test-interrupt (lambda () (loop)))))
530 (terminate-thread child)))
532 (with-test (:name (:interrupt-thread :interrupt-foreign-loop))
533 (test-interrupt #'loop-forever :quit))
535 (with-test (:name (:interrupt-thread :interrupt-sleep))
536 (let ((child (test-interrupt (lambda () (loop (sleep 2000))))))
537 (terminate-thread child)
538 (wait-for-threads (list child))))
540 (with-test (:name (:interrupt-thread :interrupt-mutex-acquisition))
541 (let ((lock (make-mutex :name "loctite"))
544 (setf child (test-interrupt
547 (assert (eql (mutex-value lock) *current-thread*)))
548 (assert (not (eql (mutex-value lock) *current-thread*)))
550 ;;hold onto lock for long enough that child can't get it immediately
552 (interrupt-thread child (lambda () (format t "l ~A~%" (mutex-value lock))))
553 (format t "parent releasing lock~%"))
554 (terminate-thread child)
555 (wait-for-threads (list child))))
557 (format t "~&locking test done~%")
559 (defun alloc-stuff () (copy-list '(1 2 3 4 5)))
561 (with-test (:name (:interrupt-thread :interrupt-consing-child))
562 (let ((thread (sb-thread:make-thread (lambda () (loop (alloc-stuff))))))
564 (loop repeat 4 collect
565 (sb-thread:make-thread
568 (sleep (random 0.1d0))
571 (sb-thread:interrupt-thread thread (lambda ()))))))))
572 (wait-for-threads killers)
573 (sb-thread:terminate-thread thread)
574 (wait-for-threads (list thread))))
577 (format t "~&multi interrupt test done~%")
579 #+(or x86 x86-64) ;; x86oid-only, see internal commentary.
580 (with-test (:name (:interrupt-thread :interrupt-consing-child :again))
581 (let ((c (make-thread (lambda () (loop (alloc-stuff))))))
582 ;; NB this only works on x86: other ports don't have a symbol for
583 ;; pseudo-atomic atomicity
585 (sleep (random 0.1d0))
588 (princ ".") (force-output)
589 (assert (thread-alive-p *current-thread*))
591 (not (logbitp 0 SB-KERNEL:*PSEUDO-ATOMIC-BITS*))))))
593 (wait-for-threads (list c))))
595 (format t "~&interrupt test done~%")
597 (defstruct counter (n 0 :type sb-vm:word))
598 (defvar *interrupt-counter* (make-counter))
600 (declaim (notinline check-interrupt-count))
601 (defun check-interrupt-count (i)
602 (declare (optimize (debug 1) (speed 1)))
603 ;; This used to lose if eflags were not restored after an interrupt.
604 (unless (typep i 'fixnum)
605 (error "!!!!!!!!!!!")))
607 (with-test (:name (:interrupt-thread :interrupt-ATOMIC-INCF))
608 (let ((c (make-thread
610 (handler-bind ((error #'(lambda (cond)
613 most-positive-fixnum))))
614 (loop (check-interrupt-count
615 (counter-n *interrupt-counter*))))))))
616 (let ((func (lambda ()
619 (sb-ext:atomic-incf (counter-n *interrupt-counter*)))))
620 (setf (counter-n *interrupt-counter*) 0)
622 (sleep (random 0.1d0))
623 (interrupt-thread c func))
624 (loop until (= (counter-n *interrupt-counter*) 100) do (sleep 0.1))
626 (wait-for-threads (list c)))))
628 (format t "~&interrupt count test done~%")
630 (defvar *runningp* nil)
632 (with-test (:name (:interrupt-thread :no-nesting))
633 (let ((thread (sb-thread:make-thread
637 (declare (special runningp))
639 (sb-thread:interrupt-thread thread
641 (let ((*runningp* t))
644 (sb-thread:interrupt-thread thread
646 (throw 'xxx *runningp*)))
647 (assert (not (sb-thread:join-thread thread)))))
649 (with-test (:name (:interrupt-thread :nesting))
650 (let ((thread (sb-thread:make-thread
654 (declare (special runningp))
656 (sb-thread:interrupt-thread thread
658 (let ((*runningp* t))
659 (sb-sys:with-interrupts
662 (sb-thread:interrupt-thread thread
664 (throw 'xxx *runningp*)))
665 (assert (sb-thread:join-thread thread))))
667 (with-test (:name (:two-threads-running-gc))
669 (make-thread (lambda ()
671 (sb-ext:gc) (princ "\\") (force-output))
673 (make-thread (lambda ()
676 (princ "/") (force-output))
679 (when (and a-done b-done) (return))
684 (defun waste (&optional (n 100000))
685 (loop repeat n do (make-string 16384)))
687 (with-test (:name (:one-thread-runs-gc-while-other-conses))
688 (loop for i below 100 do
691 (sb-thread:make-thread
699 (defparameter *aaa* nil)
700 (with-test (:name (:one-thread-runs-gc-while-other-conses :again))
701 (loop for i below 100 do
704 (sb-thread:make-thread
706 (let ((*aaa* (waste)))
708 (let ((*aaa* (waste)))
712 (format t "~&gc test done~%")
714 ;; this used to deadlock on session-lock
715 (with-test (:name (:no-session-deadlock))
716 (sb-thread:make-thread (lambda () (sb-ext:gc))))
718 (defun exercise-syscall (fn reference-errno)
719 (sb-thread:make-thread
723 (let ((errno (sb-unix::get-errno)))
724 (sleep (random 0.1d0))
725 (unless (eql errno reference-errno)
726 (format t "Got errno: ~A (~A) instead of ~A~%"
731 (sb-ext:quit :unix-status 1)))))))
733 ;; (nanosleep -1 0) does not fail on FreeBSD
734 (with-test (:name (:exercising-concurrent-syscalls))
736 (nanosleep-errno (progn
737 (sb-unix:nanosleep -1 0)
738 (sb-unix::get-errno)))
741 :if-does-not-exist nil)
742 (sb-unix::get-errno)))
746 (exercise-syscall (lambda () (sb-unix:nanosleep -1 0)) nanosleep-errno)
747 (exercise-syscall (lambda () (open "no-such-file"
748 :if-does-not-exist nil))
750 (sb-thread:make-thread (lambda () (loop (sb-ext:gc) (sleep 1)))))))
752 (princ "terminating threads")
753 (dolist (thread threads)
754 (sb-thread:terminate-thread thread))))
756 (format t "~&errno test done~%")
758 (with-test (:name (:terminate-thread-restart))
760 (let ((thread (sb-thread:make-thread (lambda () (sleep 0.1)))))
761 (sb-thread:interrupt-thread
764 (assert (find-restart 'sb-thread:terminate-thread)))))))
768 (format t "~&thread startup sigmask test done~%")
770 (with-test (:name (:debugger-no-hang-on-session-lock-if-interrupted))
771 (sb-debug::enable-debugger)
772 (let* ((main-thread *current-thread*)
774 (make-thread (lambda ()
776 (interrupt-thread main-thread
781 (interrupt-thread main-thread #'continue))
782 :name "interruptor")))
783 (with-session-lock (*session*)
785 (loop while (thread-alive-p interruptor-thread))))
787 (format t "~&session lock test done~%")
789 ;; expose thread creation races by exiting quickly
790 (with-test (:name (:no-thread-creation-race :light))
791 (sb-thread:make-thread (lambda ())))
793 (with-test (:name (:no-thread-creation-race :heavy))
796 (loop for i below 100 collect
797 (sb-thread:make-thread (lambda ()))))))
799 (format t "~&creation test done~%")
801 ;; interrupt handlers are per-thread with pthreads, make sure the
802 ;; handler installed in one thread is global
803 (with-test (:name (:global-interrupt-handler))
804 (sb-thread:make-thread
806 (sb-ext:run-program "sleep" '("1") :search t :wait nil))))
808 ;;;; Binding stack safety
810 (defparameter *x* nil)
811 (defparameter *n-gcs-requested* 0)
812 (defparameter *n-gcs-done* 0)
815 (defun make-something-big ()
816 (let ((x (make-string 32000)))
818 (let ((counter counter))
819 (sb-ext:finalize x (lambda () (format t " ~S" counter)
822 (defmacro wait-for-gc ()
824 (incf *n-gcs-requested*)
825 (loop while (< *n-gcs-done* *n-gcs-requested*))))
828 (loop until (< *n-gcs-done* *n-gcs-requested*))
834 (defun exercise-binding ()
836 (let ((*x* (make-something-big)))
838 ;; at this point the binding stack looks like this:
839 ;; NO-TLS-VALUE-MARKER, *x*, SOMETHING, *x*
842 ;; sig_stop_for_gc_handler binds FREE_INTERRUPT_CONTEXT_INDEX. By
843 ;; now SOMETHING is gc'ed and the binding stack looks like this: 0,
844 ;; 0, SOMETHING, 0 (because the symbol slots are zeroed on
845 ;; unbinding but values are not).
847 ;; bump bsp as if a BIND had just started
848 (incf sb-vm::*binding-stack-pointer* 2)
850 (decf sb-vm::*binding-stack-pointer* 2))))
852 (with-test (:name (:binding-stack-gc-safety))
856 (push (sb-thread:make-thread #'exercise-binding) threads)
857 (push (sb-thread:make-thread (lambda ()
863 (mapc #'sb-thread:terminate-thread threads))))
865 (format t "~&binding test done~%")
869 (defvar *errors* nil)
873 (format t "~&oops: ~A in ~S~%" e *current-thread*)
877 (with-test (:name (:unsynchronized-hash-table))
878 ;; We expect a (probable) error here: parellel readers and writers
879 ;; on a hash-table are not expected to work -- but we also don't
880 ;; expect this to corrupt the image.
881 (let* ((hash (make-hash-table))
883 (threads (list (sb-thread:make-thread
886 (handler-bind ((serious-condition 'oops))
888 ;;(princ "1") (force-output)
889 (setf (gethash (random 100) hash) 'h)))))
891 (sb-thread:make-thread
894 (handler-bind ((serious-condition 'oops))
896 ;;(princ "2") (force-output)
897 (remhash (random 100) hash)))))
899 (sb-thread:make-thread
902 (handler-bind ((serious-condition 'oops))
905 (sb-ext:gc :full t)))))
906 :name "collector"))))
909 (mapc #'sb-thread:terminate-thread threads))))
911 (format t "~&unsynchronized hash table test done~%")
913 (with-test (:name (:synchronized-hash-table))
914 (let* ((hash (make-hash-table :synchronized t))
916 (threads (list (sb-thread:make-thread
919 (handler-bind ((serious-condition 'oops))
921 ;;(princ "1") (force-output)
922 (setf (gethash (random 100) hash) 'h)))))
924 (sb-thread:make-thread
927 (handler-bind ((serious-condition 'oops))
929 ;;(princ "2") (force-output)
930 (remhash (random 100) hash)))))
932 (sb-thread:make-thread
935 (handler-bind ((serious-condition 'oops))
938 (sb-ext:gc :full t)))))
939 :name "collector"))))
942 (mapc #'sb-thread:terminate-thread threads))
943 (assert (not *errors*))))
945 (format t "~&synchronized hash table test done~%")
947 (with-test (:name (:hash-table-parallel-readers))
948 (let ((hash (make-hash-table))
951 do (setf (gethash (random 100) hash) 'xxx))
952 (let ((threads (list (sb-thread:make-thread
955 (handler-bind ((serious-condition 'oops))
957 until (eq t (gethash (random 100) hash))))))
959 (sb-thread:make-thread
962 (handler-bind ((serious-condition 'oops))
964 until (eq t (gethash (random 100) hash))))))
966 (sb-thread:make-thread
969 (handler-bind ((serious-condition 'oops))
971 until (eq t (gethash (random 100) hash))))))
973 (sb-thread:make-thread
976 (handler-bind ((serious-condition 'oops))
979 (sb-ext:gc :full t)))))
980 :name "collector"))))
983 (mapc #'sb-thread:terminate-thread threads))
984 (assert (not *errors*)))))
986 (format t "~&multiple reader hash table test done~%")
988 (with-test (:name (:hash-table-single-accessor-parallel-gc))
989 (let ((hash (make-hash-table))
991 (let ((threads (list (sb-thread:make-thread
993 (handler-bind ((serious-condition 'oops))
995 (let ((n (random 100)))
998 (setf (gethash n hash) 'h))))))
1000 (sb-thread:make-thread
1002 (handler-bind ((serious-condition 'oops))
1004 (sleep (random 1.0))
1005 (sb-ext:gc :full t))))
1006 :name "collector"))))
1009 (mapc #'sb-thread:terminate-thread threads))
1010 (assert (not *errors*)))))
1012 (format t "~&single accessor hash table test~%")
1014 #| ;; a cll post from eric marsden
1016 | (setq *debugger-hook*
1017 | (lambda (condition old-debugger-hook)
1018 | (debug:backtrace 10)
1019 | (unix:unix-exit 2)))
1020 | #+live-dangerously
1021 | (mp::start-sigalrm-yield)
1022 | (flet ((roomy () (loop (with-output-to-string (*standard-output*) (room)))))
1023 | (mp:make-process #'roomy)
1024 | (mp:make-process #'roomy)))
1027 (with-test (:name (:condition-variable :notify-multiple))
1028 (flet ((tester (notify-fun)
1029 (let ((queue (make-waitqueue :name "queue"))
1030 (lock (make-mutex :name "lock"))
1035 (format t "condition-wait ~a~%" x)
1037 (condition-wait queue lock)
1038 (format t "woke up ~a~%" x)
1041 (let ((threads (loop for x from 1 to 10
1044 (sb-thread:make-thread (lambda ()
1048 (funcall notify-fun queue))
1050 (mapcar #'terminate-thread threads)
1051 ;; Check that all threads woke up at least once
1052 (assert (= (length (remove-duplicates data)) 10)))))))
1053 (tester (lambda (queue)
1054 (format t "~&(condition-notify queue 10)~%")
1056 (condition-notify queue 10)))
1057 (tester (lambda (queue)
1058 (format t "~&(condition-broadcast queue)~%")
1060 (condition-broadcast queue)))))
1062 (format t "waitqueue wakeup tests done~%")
1064 ;;; Make sure that a deadline handler is not invoked twice in a row in
1065 ;;; CONDITION-WAIT. See LP #512914 for a detailed explanation.
1067 #-sb-lutex ; See KLUDGE above: no deadlines for condition-wait+lutexes.
1068 (with-test (:name (:condition-wait :deadlines :LP-512914))
1069 (let ((n 2) ; was empirically enough to trigger the bug
1070 (mutex (sb-thread:make-mutex))
1071 (waitq (sb-thread:make-waitqueue))
1073 (deadline-handler-run-twice? nil))
1076 (sb-thread:make-thread
1079 ((sb-sys:deadline-timeout
1080 (let ((already? nil))
1083 (setq deadline-handler-run-twice? t))
1086 (sb-thread:condition-broadcast waitq)
1087 (sb-sys:defer-deadline 10.0 c)))))
1088 (sb-sys:with-deadline (:seconds 0.1)
1089 (sb-thread:with-mutex (mutex)
1090 (sb-thread:condition-wait waitq mutex))))))))
1091 (push child threads)))
1092 (mapc #'sb-thread:join-thread threads)
1093 (assert (not deadline-handler-run-twice?))))
1095 (with-test (:name (:condition-wait :signal-deadline-with-interrupts-enabled))
1097 (error "Bad Darwin")
1098 (let ((mutex (sb-thread:make-mutex))
1099 (waitq (sb-thread:make-waitqueue))
1102 (A-interrupts-enabled? :unknown)
1103 (B-interrupts-enabled? :unknown)
1106 ;; W.L.O.G., we assume that A is executed first...
1107 (setq A (sb-thread:make-thread
1110 ((sb-sys:deadline-timeout
1112 ;; We came here through the call to DECODE-TIMEOUT
1113 ;; in CONDITION-WAIT; hence both here are supposed
1114 ;; to evaluate to T.
1115 (setq A-holds? (sb-thread:holding-mutex-p mutex))
1116 (setq A-interrupts-enabled?
1117 sb-sys:*interrupts-enabled*)
1119 (sb-thread:condition-broadcast waitq)
1120 (sb-sys:defer-deadline 10.0 c))))
1121 (sb-sys:with-deadline (:seconds 0.1)
1122 (sb-thread:with-mutex (mutex)
1123 (sb-thread:condition-wait waitq mutex)))))))
1124 (setq B (sb-thread:make-thread
1128 ((sb-sys:deadline-timeout
1130 ;; We came here through the call to GET-MUTEX
1131 ;; in CONDITION-WAIT (contended case of
1132 ;; reaquiring the mutex) - so the former will
1133 ;; be NIL, but interrupts should still be enabled.
1134 (setq B-holds? (sb-thread:holding-mutex-p mutex))
1135 (setq B-interrupts-enabled?
1136 sb-sys:*interrupts-enabled*)
1138 (sb-thread:condition-broadcast waitq)
1139 (sb-sys:defer-deadline 10.0 c))))
1140 (sb-sys:with-deadline (:seconds 0.1)
1141 (sb-thread:with-mutex (mutex)
1142 (sb-thread:condition-wait waitq mutex)))))))
1143 (sb-thread:join-thread A)
1144 (sb-thread:join-thread B)
1145 (let ((A-result (list A-holds? A-interrupts-enabled?))
1146 (B-result (list B-holds? B-interrupts-enabled?)))
1147 ;; We also check some subtle behaviour w.r.t. whether a deadline
1148 ;; handler in CONDITION-WAIT got the mutex, or not. This is most
1149 ;; probably very internal behaviour (so user should not depend
1150 ;; on it) -- I added the testing here just to manifest current
1152 (cond ((equal A-result '(t t)) (assert (equal B-result '(nil t))))
1153 ((equal B-result '(t t)) (assert (equal A-result '(nil t))))
1154 (t (error "Failure: fall through."))))))
1156 (with-test (:name (:mutex :finalization))
1159 (setf a (make-mutex)))))
1161 (format t "mutex finalization test done~%")
1163 ;;; Check that INFO is thread-safe, at least when we're just doing reads.
1165 (let* ((symbols (loop repeat 10000 collect (gensym)))
1166 (functions (loop for (symbol . rest) on symbols
1167 for next = (car rest)
1168 for fun = (let ((next next))
1171 (funcall next (1- n))
1173 do (setf (symbol-function symbol) fun)
1175 (defun infodb-test ()
1176 (funcall (car functions) 9999)))
1178 (with-test (:name (:infodb :read))
1180 (threads (loop for i from 0 to 10
1181 collect (sb-thread:make-thread
1186 (let ((n (infodb-test)))
1189 (format t "N != 0 (~A)~%" n)
1190 (sb-ext:quit)))))))))
1191 (wait-for-threads threads)
1194 (format t "infodb test done~%")
1196 (with-test (:name (:backtrace))
1198 (error "Prone to crash on Darwin, cause unknown.")
1199 ;; Printing backtraces from several threads at once used to hang the
1200 ;; whole SBCL process (discovered by accident due to a timer.impure
1201 ;; test misbehaving). The cause was that packages weren't even
1202 ;; thread-safe for only doing FIND-SYMBOL, and while printing
1203 ;; backtraces a loot of symbol lookups need to be done due to
1205 (let* ((threads (loop repeat 10
1206 collect (sb-thread:make-thread
1209 (with-output-to-string (*debug-io*)
1210 (sb-debug::backtrace 10))))))))
1211 (wait-for-threads threads)))
1213 (format t "backtrace test done~%")
1215 (format t "~&starting gc deadlock test: WARNING: THIS TEST WILL HANG ON FAILURE!~%")
1217 (with-test (:name (:gc-deadlock))
1219 (error "Prone to hang on Darwin due to interrupt issues.")
1220 ;; Prior to 0.9.16.46 thread exit potentially deadlocked the
1221 ;; GC due to *all-threads-lock* and session lock. On earlier
1222 ;; versions and at least on one specific box this test is good enough
1223 ;; to catch that typically well before the 1500th iteration.
1230 (when (zerop (mod i 100))
1235 (sb-thread:make-thread
1237 (sleep (random 0.001)))
1238 :name (format nil "SLEEP-~D" i))
1239 (sb-thread:make-thread
1241 ;; KLUDGE: what we are doing here is explicit,
1242 ;; but the same can happen because of a regular
1243 ;; MAKE-THREAD or LIST-ALL-THREADS, and various
1244 ;; session functions.
1245 (sb-thread::with-all-threads-lock
1246 (sb-thread::with-session-lock (sb-thread::*session*)
1248 :name (format nil "GC-~D" i)))
1250 (format t "~%error creating thread ~D: ~A -- backing off for retry~%" i e)
1254 (format t "~&gc deadlock test done~%")
1256 (let ((count (make-array 8 :initial-element 0)))
1257 (defun closure-one ()
1258 (declare (optimize safety))
1259 (values (incf (aref count 0)) (incf (aref count 1))
1260 (incf (aref count 2)) (incf (aref count 3))
1261 (incf (aref count 4)) (incf (aref count 5))
1262 (incf (aref count 6)) (incf (aref count 7))))
1263 (defun no-optimizing-away-closure-one ()
1264 (setf count (make-array 8 :initial-element 0))))
1269 (let ((one (make-box))
1272 (defun closure-two ()
1273 (declare (optimize safety))
1274 (values (incf (box-count one)) (incf (box-count two)) (incf (box-count three))))
1275 (defun no-optimizing-away-closure-two ()
1276 (setf one (make-box)
1280 (with-test (:name (:funcallable-instances))
1281 ;; the funcallable-instance implementation used not to be threadsafe
1282 ;; against setting the funcallable-instance function to a closure
1283 ;; (because the code and lexenv were set separately).
1284 (let ((fun (sb-kernel:%make-funcallable-instance 0))
1286 (setf (sb-kernel:funcallable-instance-fun fun) #'closure-one)
1288 (loop (setf (sb-kernel:funcallable-instance-fun fun) #'closure-one)
1289 (setf (sb-kernel:funcallable-instance-fun fun) #'closure-two)))
1291 (handler-case (loop (funcall fun))
1292 (serious-condition (c) (setf condition c)))))
1293 (let ((changer (make-thread #'changer))
1294 (test (make-thread #'test)))
1297 ;; The two closures above are fairly carefully crafted
1298 ;; so that if given the wrong lexenv they will tend to
1299 ;; do some serious damage, but it is of course difficult
1300 ;; to predict where the various bits and pieces will be
1301 ;; allocated. Five seconds failed fairly reliably on
1302 ;; both my x86 and x86-64 systems. -- CSR, 2006-09-27.
1303 (sb-ext:with-timeout 5
1304 (wait-for-threads (list test)))
1305 (error "~@<test thread got condition:~2I~_~A~@:>" condition))
1307 (terminate-thread changer)
1308 (terminate-thread test)
1309 (wait-for-threads (list changer test))))))))
1311 (format t "~&funcallable-instance test done~%")
1313 (defun random-type (n)
1314 `(integer ,(random n) ,(+ n (random n))))
1316 (defun subtypep-hash-cache-test ()
1318 (let ((type1 (random-type 500))
1319 (type2 (random-type 500)))
1320 (let ((a (subtypep type1 type2)))
1322 (assert (eq (subtypep type1 type2) a))))))
1326 (with-test (:name (:hash-cache :subtypep))
1328 (sb-thread:make-thread #'subtypep-hash-cache-test)))
1329 (format t "hash-cache tests done~%")
1331 ;;;; BLACK BOX TESTS
1333 (in-package :cl-user)
1334 (use-package :test-util)
1335 (use-package "ASSERTOID")
1337 (format t "parallel defclass test -- WARNING, WILL HANG ON FAILURE!~%")
1338 (with-test (:name :parallel-defclass)
1339 (defclass test-1 () ((a :initform :orig-a)))
1340 (defclass test-2 () ((b :initform :orig-b)))
1341 (defclass test-3 (test-1 test-2) ((c :initform :orig-c)))
1343 (d1 (sb-thread:make-thread (lambda ()
1345 do (defclass test-1 () ((a :initform :new-a)))
1349 (d2 (sb-thread:make-thread (lambda ()
1351 do (defclass test-2 () ((b :initform :new-b)))
1355 (d3 (sb-thread:make-thread (lambda ()
1357 do (defclass test-3 (test-1 test-2) ((c :initform :new-c)))
1361 (i (sb-thread:make-thread (lambda ()
1363 do (let ((i (make-instance 'test-3)))
1364 (assert (member (slot-value i 'a) '(:orig-a :new-a)))
1365 (assert (member (slot-value i 'b) '(:orig-b :new-b)))
1366 (assert (member (slot-value i 'c) '(:orig-c :new-c))))
1370 (format t "~%sleeping!~%")
1372 (format t "~%stopping!~%")
1375 (sb-thread:join-thread th)
1376 (format t "~%joined ~S~%" (sb-thread:thread-name th)))
1377 (list d1 d2 d3 i))))
1378 (format t "parallel defclass test done~%")