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))
348 (w (make-semaphore)))
350 (let ((th (make-thread
353 (grab-mutex m :timeout 0.1)
354 (signal-semaphore w))))))
355 ;; Wait for it to -- otherwise the detect the deadlock chain
357 (wait-on-semaphore w)
358 (assert (null (join-thread th)))))))
360 (with-test (:name (:grab-mutex :timeout :acquisition-success))
362 (error "Mutex timeout not supported here.")
363 (let ((m (make-mutex))
366 (setq child (make-thread #'(lambda () (grab-mutex m :timeout 1.0))))
368 (assert (eq (join-thread child) 't))))
370 (with-test (:name (:grab-mutex :timeout+deadline))
372 (error "Mutex timeout not supported here.")
373 (let ((m (make-mutex))
374 (w (make-semaphore)))
376 (let ((th (make-thread #'(lambda ()
377 (sb-sys:with-deadline (:seconds 0.0)
379 (grab-mutex m :timeout 0.0)
380 (sb-sys:deadline-timeout ()
383 (wait-on-semaphore w)
384 (assert (eq (join-thread th) :deadline))))))
386 (with-test (:name (:grab-mutex :waitp+deadline))
388 (error "Mutex timeout not supported here.")
389 (let ((m (make-mutex)))
391 (assert (eq (join-thread
392 (make-thread #'(lambda ()
393 (sb-sys:with-deadline (:seconds 0.0)
395 (grab-mutex m :waitp nil)
396 (sb-sys:deadline-timeout ()
402 (defmacro raises-timeout-p (&body body)
403 `(handler-case (progn (progn ,@body) nil)
404 (sb-ext:timeout () t)))
406 (with-test (:name (:semaphore :wait-forever))
407 (let ((sem (make-semaphore :count 0)))
408 (assert (raises-timeout-p
409 (sb-ext:with-timeout 0.1
410 (wait-on-semaphore sem))))))
412 (with-test (:name (:semaphore :initial-count))
413 (let ((sem (make-semaphore :count 1)))
414 (sb-ext:with-timeout 0.1
415 (wait-on-semaphore sem))))
417 (with-test (:name (:semaphore :wait-then-signal))
418 (let ((sem (make-semaphore))
420 (make-thread (lambda ()
423 (signal-semaphore sem)))
424 (wait-on-semaphore sem)
425 (assert signalled-p)))
427 (with-test (:name (:semaphore :signal-then-wait))
428 (let ((sem (make-semaphore))
430 (make-thread (lambda ()
431 (signal-semaphore sem)
432 (setq signalled-p t)))
433 (loop until signalled-p)
434 (wait-on-semaphore sem)
435 (assert signalled-p)))
437 (defun test-semaphore-multiple-signals (wait-on-semaphore)
438 (let* ((sem (make-semaphore :count 5))
439 (threads (loop repeat 20 collecting
440 (make-thread (lambda ()
441 (funcall wait-on-semaphore sem))))))
442 (flet ((count-live-threads ()
443 (count-if #'thread-alive-p threads)))
445 (assert (= 15 (count-live-threads)))
446 (signal-semaphore sem 10)
448 (assert (= 5 (count-live-threads)))
449 (signal-semaphore sem 3)
451 (assert (= 2 (count-live-threads)))
452 (signal-semaphore sem 4)
454 (assert (= 0 (count-live-threads))))))
456 (with-test (:name (:semaphore :multiple-signals))
457 (test-semaphore-multiple-signals #'wait-on-semaphore))
459 (with-test (:name (:try-semaphore :trivial-fail))
460 (assert (eq (try-semaphore (make-semaphore :count 0)) 'nil)))
462 (with-test (:name (:try-semaphore :trivial-success))
463 (let ((sem (make-semaphore :count 1)))
464 (assert (try-semaphore sem))
465 (assert (zerop (semaphore-count sem)))))
467 (with-test (:name (:try-semaphore :trivial-fail :n>1))
468 (assert (eq (try-semaphore (make-semaphore :count 1) 2) 'nil)))
470 (with-test (:name (:try-semaphore :trivial-success :n>1))
471 (let ((sem (make-semaphore :count 10)))
472 (assert (try-semaphore sem 5))
473 (assert (try-semaphore sem 5))
474 (assert (zerop (semaphore-count sem)))))
476 (with-test (:name (:try-semaphore :emulate-wait-on-semaphore))
477 (flet ((busy-wait-on-semaphore (sem)
478 (loop until (try-semaphore sem) do (sleep 0.001))))
479 (test-semaphore-multiple-signals #'busy-wait-on-semaphore)))
481 ;;; Here we test that interrupting TRY-SEMAPHORE does not leave a
482 ;;; semaphore in a bad state.
483 (with-test (:name (:try-semaphore :interrupt-safe))
484 (flet ((make-threads (count fn)
485 (loop repeat count collect (make-thread fn)))
486 (kill-thread (thread)
487 (when (thread-alive-p thread)
488 (ignore-errors (terminate-thread thread))))
489 (count-live-threads (threads)
490 (count-if #'thread-alive-p threads)))
491 ;; WAITERS will already be waiting on the semaphore while
492 ;; threads-being-interrupted will perform TRY-SEMAPHORE on that
493 ;; semaphore, and MORE-WAITERS are new threads trying to wait on
494 ;; the semaphore during the interruption-fire.
495 (let* ((sem (make-semaphore :count 100))
496 (waiters (make-threads 20 #'(lambda ()
497 (wait-on-semaphore sem))))
498 (triers (make-threads 40 #'(lambda ()
499 (sleep (random 0.01))
500 (try-semaphore sem (1+ (random 5))))))
503 do (kill-thread (nth (random 40) triers))
504 collect (make-thread #'(lambda () (wait-on-semaphore sem)))
505 do (kill-thread (nth (random 40) triers)))))
507 ;; Now ensure that the waiting threads will all be waked up,
508 ;; i.e. that the semaphore is still working.
509 (loop repeat (+ (count-live-threads waiters)
510 (count-live-threads more-waiters))
511 do (signal-semaphore sem))
513 (assert (zerop (count-live-threads triers)))
514 (assert (zerop (count-live-threads waiters)))
515 (assert (zerop (count-live-threads more-waiters))))))
519 (format t "~&semaphore tests done~%")
521 (defun test-interrupt (function-to-interrupt &optional quit-p)
522 (let ((child (make-thread function-to-interrupt)))
523 ;;(format t "gdb ./src/runtime/sbcl ~A~%attach ~A~%" child child)
525 (format t "interrupting child ~A~%" child)
526 (interrupt-thread child
528 (format t "child pid ~A~%" *current-thread*)
529 (when quit-p (sb-ext:quit))))
533 ;; separate tests for (a) interrupting Lisp code, (b) C code, (c) a syscall,
534 ;; (d) waiting on a lock, (e) some code which we hope is likely to be
537 (with-test (:name (:interrupt-thread :more-basics))
538 (let ((child (test-interrupt (lambda () (loop)))))
539 (terminate-thread child)))
541 (with-test (:name (:interrupt-thread :interrupt-foreign-loop))
542 (test-interrupt #'loop-forever :quit))
544 (with-test (:name (:interrupt-thread :interrupt-sleep))
545 (let ((child (test-interrupt (lambda () (loop (sleep 2000))))))
546 (terminate-thread child)
547 (wait-for-threads (list child))))
549 (with-test (:name (:interrupt-thread :interrupt-mutex-acquisition))
550 (let ((lock (make-mutex :name "loctite"))
553 (setf child (test-interrupt
556 (assert (eql (mutex-value lock) *current-thread*)))
557 (assert (not (eql (mutex-value lock) *current-thread*)))
559 ;;hold onto lock for long enough that child can't get it immediately
561 (interrupt-thread child (lambda () (format t "l ~A~%" (mutex-value lock))))
562 (format t "parent releasing lock~%"))
563 (terminate-thread child)
564 (wait-for-threads (list child))))
566 (format t "~&locking test done~%")
568 (defun alloc-stuff () (copy-list '(1 2 3 4 5)))
570 (with-test (:name (:interrupt-thread :interrupt-consing-child))
571 (let ((thread (sb-thread:make-thread (lambda () (loop (alloc-stuff))))))
573 (loop repeat 4 collect
574 (sb-thread:make-thread
577 (sleep (random 0.1d0))
580 (sb-thread:interrupt-thread thread (lambda ()))))))))
581 (wait-for-threads killers)
582 (sb-thread:terminate-thread thread)
583 (wait-for-threads (list thread))))
586 (format t "~&multi interrupt test done~%")
588 #+(or x86 x86-64) ;; x86oid-only, see internal commentary.
589 (with-test (:name (:interrupt-thread :interrupt-consing-child :again))
590 (let ((c (make-thread (lambda () (loop (alloc-stuff))))))
591 ;; NB this only works on x86: other ports don't have a symbol for
592 ;; pseudo-atomic atomicity
594 (sleep (random 0.1d0))
597 (princ ".") (force-output)
598 (assert (thread-alive-p *current-thread*))
600 (not (logbitp 0 SB-KERNEL:*PSEUDO-ATOMIC-BITS*))))))
602 (wait-for-threads (list c))))
604 (format t "~&interrupt test done~%")
606 (defstruct counter (n 0 :type sb-vm:word))
607 (defvar *interrupt-counter* (make-counter))
609 (declaim (notinline check-interrupt-count))
610 (defun check-interrupt-count (i)
611 (declare (optimize (debug 1) (speed 1)))
612 ;; This used to lose if eflags were not restored after an interrupt.
613 (unless (typep i 'fixnum)
614 (error "!!!!!!!!!!!")))
616 (with-test (:name (:interrupt-thread :interrupt-ATOMIC-INCF))
617 (let ((c (make-thread
619 (handler-bind ((error #'(lambda (cond)
622 most-positive-fixnum))))
623 (loop (check-interrupt-count
624 (counter-n *interrupt-counter*))))))))
625 (let ((func (lambda ()
628 (sb-ext:atomic-incf (counter-n *interrupt-counter*)))))
629 (setf (counter-n *interrupt-counter*) 0)
631 (sleep (random 0.1d0))
632 (interrupt-thread c func))
633 (loop until (= (counter-n *interrupt-counter*) 100) do (sleep 0.1))
635 (wait-for-threads (list c)))))
637 (format t "~&interrupt count test done~%")
639 (defvar *runningp* nil)
641 (with-test (:name (:interrupt-thread :no-nesting))
642 (let ((thread (sb-thread:make-thread
646 (declare (special runningp))
648 (sb-thread:interrupt-thread thread
650 (let ((*runningp* t))
653 (sb-thread:interrupt-thread thread
655 (throw 'xxx *runningp*)))
656 (assert (not (sb-thread:join-thread thread)))))
658 (with-test (:name (:interrupt-thread :nesting))
659 (let ((thread (sb-thread:make-thread
663 (declare (special runningp))
665 (sb-thread:interrupt-thread thread
667 (let ((*runningp* t))
668 (sb-sys:with-interrupts
671 (sb-thread:interrupt-thread thread
673 (throw 'xxx *runningp*)))
674 (assert (sb-thread:join-thread thread))))
676 (with-test (:name (:two-threads-running-gc))
678 (make-thread (lambda ()
680 (sb-ext:gc) (princ "\\") (force-output))
682 (make-thread (lambda ()
685 (princ "/") (force-output))
688 (when (and a-done b-done) (return))
693 (defun waste (&optional (n 100000))
694 (loop repeat n do (make-string 16384)))
696 (with-test (:name (:one-thread-runs-gc-while-other-conses))
697 (loop for i below 100 do
700 (sb-thread:make-thread
708 (defparameter *aaa* nil)
709 (with-test (:name (:one-thread-runs-gc-while-other-conses :again))
710 (loop for i below 100 do
713 (sb-thread:make-thread
715 (let ((*aaa* (waste)))
717 (let ((*aaa* (waste)))
721 (format t "~&gc test done~%")
723 ;; this used to deadlock on session-lock
724 (with-test (:name (:no-session-deadlock))
725 (sb-thread:make-thread (lambda () (sb-ext:gc))))
727 (defun exercise-syscall (fn reference-errno)
728 (sb-thread:make-thread
732 (let ((errno (sb-unix::get-errno)))
733 (sleep (random 0.1d0))
734 (unless (eql errno reference-errno)
735 (format t "Got errno: ~A (~A) instead of ~A~%"
740 (sb-ext:quit :unix-status 1)))))))
742 ;; (nanosleep -1 0) does not fail on FreeBSD
743 (with-test (:name (:exercising-concurrent-syscalls))
745 (nanosleep-errno (progn
746 (sb-unix:nanosleep -1 0)
747 (sb-unix::get-errno)))
750 :if-does-not-exist nil)
751 (sb-unix::get-errno)))
755 (exercise-syscall (lambda () (sb-unix:nanosleep -1 0)) nanosleep-errno)
756 (exercise-syscall (lambda () (open "no-such-file"
757 :if-does-not-exist nil))
759 (sb-thread:make-thread (lambda () (loop (sb-ext:gc) (sleep 1)))))))
761 (princ "terminating threads")
762 (dolist (thread threads)
763 (sb-thread:terminate-thread thread))))
765 (format t "~&errno test done~%")
767 (with-test (:name (:terminate-thread-restart))
769 (let ((thread (sb-thread:make-thread (lambda () (sleep 0.1)))))
770 (sb-thread:interrupt-thread
773 (assert (find-restart 'sb-thread:terminate-thread)))))))
777 (format t "~&thread startup sigmask test done~%")
779 (with-test (:name (:debugger-no-hang-on-session-lock-if-interrupted))
780 (sb-debug::enable-debugger)
781 (let* ((main-thread *current-thread*)
783 (make-thread (lambda ()
785 (interrupt-thread main-thread
790 (interrupt-thread main-thread #'continue))
791 :name "interruptor")))
792 (with-session-lock (*session*)
794 (loop while (thread-alive-p interruptor-thread))))
796 (format t "~&session lock test done~%")
798 ;; expose thread creation races by exiting quickly
799 (with-test (:name (:no-thread-creation-race :light))
800 (sb-thread:make-thread (lambda ())))
802 (with-test (:name (:no-thread-creation-race :heavy))
805 (loop for i below 100 collect
806 (sb-thread:make-thread (lambda ()))))))
808 (format t "~&creation test done~%")
810 ;; interrupt handlers are per-thread with pthreads, make sure the
811 ;; handler installed in one thread is global
812 (with-test (:name (:global-interrupt-handler))
813 (sb-thread:make-thread
815 (sb-ext:run-program "sleep" '("1") :search t :wait nil))))
817 ;;;; Binding stack safety
819 (defparameter *x* nil)
820 (defparameter *n-gcs-requested* 0)
821 (defparameter *n-gcs-done* 0)
824 (defun make-something-big ()
825 (let ((x (make-string 32000)))
827 (let ((counter counter))
828 (sb-ext:finalize x (lambda () (format t " ~S" counter)
831 (defmacro wait-for-gc ()
833 (incf *n-gcs-requested*)
834 (loop while (< *n-gcs-done* *n-gcs-requested*))))
837 (loop until (< *n-gcs-done* *n-gcs-requested*))
843 (defun exercise-binding ()
845 (let ((*x* (make-something-big)))
847 ;; at this point the binding stack looks like this:
848 ;; NO-TLS-VALUE-MARKER, *x*, SOMETHING, *x*
851 ;; sig_stop_for_gc_handler binds FREE_INTERRUPT_CONTEXT_INDEX. By
852 ;; now SOMETHING is gc'ed and the binding stack looks like this: 0,
853 ;; 0, SOMETHING, 0 (because the symbol slots are zeroed on
854 ;; unbinding but values are not).
856 ;; bump bsp as if a BIND had just started
857 (incf sb-vm::*binding-stack-pointer* 2)
859 (decf sb-vm::*binding-stack-pointer* 2))))
861 (with-test (:name (:binding-stack-gc-safety))
865 (push (sb-thread:make-thread #'exercise-binding) threads)
866 (push (sb-thread:make-thread (lambda ()
872 (mapc #'sb-thread:terminate-thread threads))))
874 (format t "~&binding test done~%")
878 (defvar *errors* nil)
882 (format t "~&oops: ~A in ~S~%" e *current-thread*)
886 (with-test (:name (:unsynchronized-hash-table)
887 ;; FIXME: This test occasionally eats out craploads
888 ;; of heap instead of expected error early. Not 100%
889 ;; sure if it would finish as expected, but since it
890 ;; hits swap on my system I'm not likely to find out
891 ;; soon. Disabling for now. -- nikodemus
893 ;; We expect a (probable) error here: parellel readers and writers
894 ;; on a hash-table are not expected to work -- but we also don't
895 ;; expect this to corrupt the image.
896 (let* ((hash (make-hash-table))
898 (threads (list (sb-thread:make-thread
901 (handler-bind ((serious-condition 'oops))
903 ;;(princ "1") (force-output)
904 (setf (gethash (random 100) hash) 'h)))))
906 (sb-thread:make-thread
909 (handler-bind ((serious-condition 'oops))
911 ;;(princ "2") (force-output)
912 (remhash (random 100) hash)))))
914 (sb-thread:make-thread
917 (handler-bind ((serious-condition 'oops))
920 (sb-ext:gc :full t)))))
921 :name "collector"))))
924 (mapc #'sb-thread:terminate-thread threads))))
926 (format t "~&unsynchronized hash table test done~%")
928 (with-test (:name (:synchronized-hash-table))
929 (let* ((hash (make-hash-table :synchronized t))
931 (threads (list (sb-thread:make-thread
934 (handler-bind ((serious-condition 'oops))
936 ;;(princ "1") (force-output)
937 (setf (gethash (random 100) hash) 'h)))))
939 (sb-thread:make-thread
942 (handler-bind ((serious-condition 'oops))
944 ;;(princ "2") (force-output)
945 (remhash (random 100) hash)))))
947 (sb-thread:make-thread
950 (handler-bind ((serious-condition 'oops))
953 (sb-ext:gc :full t)))))
954 :name "collector"))))
957 (mapc #'sb-thread:terminate-thread threads))
958 (assert (not *errors*))))
960 (format t "~&synchronized hash table test done~%")
962 (with-test (:name (:hash-table-parallel-readers))
963 (let ((hash (make-hash-table))
966 do (setf (gethash (random 100) hash) 'xxx))
967 (let ((threads (list (sb-thread:make-thread
970 (handler-bind ((serious-condition 'oops))
972 until (eq t (gethash (random 100) hash))))))
974 (sb-thread:make-thread
977 (handler-bind ((serious-condition 'oops))
979 until (eq t (gethash (random 100) hash))))))
981 (sb-thread:make-thread
984 (handler-bind ((serious-condition 'oops))
986 until (eq t (gethash (random 100) hash))))))
988 (sb-thread:make-thread
991 (handler-bind ((serious-condition 'oops))
994 (sb-ext:gc :full t)))))
995 :name "collector"))))
998 (mapc #'sb-thread:terminate-thread threads))
999 (assert (not *errors*)))))
1001 (format t "~&multiple reader hash table test done~%")
1003 (with-test (:name (:hash-table-single-accessor-parallel-gc))
1004 (let ((hash (make-hash-table))
1006 (let ((threads (list (sb-thread:make-thread
1008 (handler-bind ((serious-condition 'oops))
1010 (let ((n (random 100)))
1011 (if (gethash n hash)
1013 (setf (gethash n hash) 'h))))))
1015 (sb-thread:make-thread
1017 (handler-bind ((serious-condition 'oops))
1019 (sleep (random 1.0))
1020 (sb-ext:gc :full t))))
1021 :name "collector"))))
1024 (mapc #'sb-thread:terminate-thread threads))
1025 (assert (not *errors*)))))
1027 (format t "~&single accessor hash table test~%")
1029 #| ;; a cll post from eric marsden
1031 | (setq *debugger-hook*
1032 | (lambda (condition old-debugger-hook)
1033 | (debug:backtrace 10)
1034 | (unix:unix-exit 2)))
1035 | #+live-dangerously
1036 | (mp::start-sigalrm-yield)
1037 | (flet ((roomy () (loop (with-output-to-string (*standard-output*) (room)))))
1038 | (mp:make-process #'roomy)
1039 | (mp:make-process #'roomy)))
1042 (with-test (:name (:condition-variable :notify-multiple))
1043 (flet ((tester (notify-fun)
1044 (let ((queue (make-waitqueue :name "queue"))
1045 (lock (make-mutex :name "lock"))
1050 (format t "condition-wait ~a~%" x)
1052 (condition-wait queue lock)
1053 (format t "woke up ~a~%" x)
1056 (let ((threads (loop for x from 1 to 10
1059 (sb-thread:make-thread (lambda ()
1063 (funcall notify-fun queue))
1065 (mapcar #'terminate-thread threads)
1066 ;; Check that all threads woke up at least once
1067 (assert (= (length (remove-duplicates data)) 10)))))))
1068 (tester (lambda (queue)
1069 (format t "~&(condition-notify queue 10)~%")
1071 (condition-notify queue 10)))
1072 (tester (lambda (queue)
1073 (format t "~&(condition-broadcast queue)~%")
1075 (condition-broadcast queue)))))
1077 (format t "waitqueue wakeup tests done~%")
1079 ;;; Make sure that a deadline handler is not invoked twice in a row in
1080 ;;; CONDITION-WAIT. See LP #512914 for a detailed explanation.
1082 #-sb-lutex ; See KLUDGE above: no deadlines for condition-wait+lutexes.
1083 (with-test (:name (:condition-wait :deadlines :LP-512914))
1084 (let ((n 2) ; was empirically enough to trigger the bug
1085 (mutex (sb-thread:make-mutex))
1086 (waitq (sb-thread:make-waitqueue))
1088 (deadline-handler-run-twice? nil))
1091 (sb-thread:make-thread
1094 ((sb-sys:deadline-timeout
1095 (let ((already? nil))
1098 (setq deadline-handler-run-twice? t))
1101 (sb-thread:condition-broadcast waitq)
1102 (sb-sys:defer-deadline 10.0 c)))))
1103 (sb-sys:with-deadline (:seconds 0.1)
1104 (sb-thread:with-mutex (mutex)
1105 (sb-thread:condition-wait waitq mutex))))))))
1106 (push child threads)))
1107 (mapc #'sb-thread:join-thread threads)
1108 (assert (not deadline-handler-run-twice?))))
1110 (with-test (:name (:condition-wait :signal-deadline-with-interrupts-enabled))
1112 (error "Bad Darwin")
1113 (let ((mutex (sb-thread:make-mutex))
1114 (waitq (sb-thread:make-waitqueue))
1117 (A-interrupts-enabled? :unknown)
1118 (B-interrupts-enabled? :unknown)
1121 ;; W.L.O.G., we assume that A is executed first...
1122 (setq A (sb-thread:make-thread
1125 ((sb-sys:deadline-timeout
1127 ;; We came here through the call to DECODE-TIMEOUT
1128 ;; in CONDITION-WAIT; hence both here are supposed
1129 ;; to evaluate to T.
1130 (setq A-holds? (sb-thread:holding-mutex-p mutex))
1131 (setq A-interrupts-enabled?
1132 sb-sys:*interrupts-enabled*)
1134 (sb-thread:condition-broadcast waitq)
1135 (sb-sys:defer-deadline 10.0 c))))
1136 (sb-sys:with-deadline (:seconds 0.1)
1137 (sb-thread:with-mutex (mutex)
1138 (sb-thread:condition-wait waitq mutex)))))))
1139 (setq B (sb-thread:make-thread
1143 ((sb-sys:deadline-timeout
1145 ;; We came here through the call to GET-MUTEX
1146 ;; in CONDITION-WAIT (contended case of
1147 ;; reaquiring the mutex) - so the former will
1148 ;; be NIL, but interrupts should still be enabled.
1149 (setq B-holds? (sb-thread:holding-mutex-p mutex))
1150 (setq B-interrupts-enabled?
1151 sb-sys:*interrupts-enabled*)
1153 (sb-thread:condition-broadcast waitq)
1154 (sb-sys:defer-deadline 10.0 c))))
1155 (sb-sys:with-deadline (:seconds 0.1)
1156 (sb-thread:with-mutex (mutex)
1157 (sb-thread:condition-wait waitq mutex)))))))
1158 (sb-thread:join-thread A)
1159 (sb-thread:join-thread B)
1160 (let ((A-result (list A-holds? A-interrupts-enabled?))
1161 (B-result (list B-holds? B-interrupts-enabled?)))
1162 ;; We also check some subtle behaviour w.r.t. whether a deadline
1163 ;; handler in CONDITION-WAIT got the mutex, or not. This is most
1164 ;; probably very internal behaviour (so user should not depend
1165 ;; on it) -- I added the testing here just to manifest current
1167 (cond ((equal A-result '(t t)) (assert (equal B-result '(nil t))))
1168 ((equal B-result '(t t)) (assert (equal A-result '(nil t))))
1169 (t (error "Failure: fall through."))))))
1171 (with-test (:name (:mutex :finalization))
1174 (setf a (make-mutex)))))
1176 (format t "mutex finalization test done~%")
1178 ;;; Check that INFO is thread-safe, at least when we're just doing reads.
1180 (let* ((symbols (loop repeat 10000 collect (gensym)))
1181 (functions (loop for (symbol . rest) on symbols
1182 for next = (car rest)
1183 for fun = (let ((next next))
1186 (funcall next (1- n))
1188 do (setf (symbol-function symbol) fun)
1190 (defun infodb-test ()
1191 (funcall (car functions) 9999)))
1193 (with-test (:name (:infodb :read))
1195 (threads (loop for i from 0 to 10
1196 collect (sb-thread:make-thread
1201 (let ((n (infodb-test)))
1204 (format t "N != 0 (~A)~%" n)
1205 (sb-ext:quit)))))))))
1206 (wait-for-threads threads)
1209 (format t "infodb test done~%")
1211 (with-test (:name (:backtrace))
1213 (error "Prone to crash on Darwin, cause unknown.")
1214 ;; Printing backtraces from several threads at once used to hang the
1215 ;; whole SBCL process (discovered by accident due to a timer.impure
1216 ;; test misbehaving). The cause was that packages weren't even
1217 ;; thread-safe for only doing FIND-SYMBOL, and while printing
1218 ;; backtraces a loot of symbol lookups need to be done due to
1220 (let* ((threads (loop repeat 10
1221 collect (sb-thread:make-thread
1224 (with-output-to-string (*debug-io*)
1225 (sb-debug::backtrace 10))))))))
1226 (wait-for-threads threads)))
1228 (format t "backtrace test done~%")
1230 (format t "~&starting gc deadlock test: WARNING: THIS TEST WILL HANG ON FAILURE!~%")
1232 (with-test (:name (:gc-deadlock))
1234 (error "Prone to hang on Darwin due to interrupt issues.")
1235 ;; Prior to 0.9.16.46 thread exit potentially deadlocked the
1236 ;; GC due to *all-threads-lock* and session lock. On earlier
1237 ;; versions and at least on one specific box this test is good enough
1238 ;; to catch that typically well before the 1500th iteration.
1245 (when (zerop (mod i 100))
1250 (sb-thread:make-thread
1252 (sleep (random 0.001)))
1253 :name (format nil "SLEEP-~D" i))
1254 (sb-thread:make-thread
1256 ;; KLUDGE: what we are doing here is explicit,
1257 ;; but the same can happen because of a regular
1258 ;; MAKE-THREAD or LIST-ALL-THREADS, and various
1259 ;; session functions.
1260 (sb-thread::with-all-threads-lock
1261 (sb-thread::with-session-lock (sb-thread::*session*)
1263 :name (format nil "GC-~D" i)))
1265 (format t "~%error creating thread ~D: ~A -- backing off for retry~%" i e)
1269 (format t "~&gc deadlock test done~%")
1271 (let ((count (make-array 8 :initial-element 0)))
1272 (defun closure-one ()
1273 (declare (optimize safety))
1274 (values (incf (aref count 0)) (incf (aref count 1))
1275 (incf (aref count 2)) (incf (aref count 3))
1276 (incf (aref count 4)) (incf (aref count 5))
1277 (incf (aref count 6)) (incf (aref count 7))))
1278 (defun no-optimizing-away-closure-one ()
1279 (setf count (make-array 8 :initial-element 0))))
1284 (let ((one (make-box))
1287 (defun closure-two ()
1288 (declare (optimize safety))
1289 (values (incf (box-count one)) (incf (box-count two)) (incf (box-count three))))
1290 (defun no-optimizing-away-closure-two ()
1291 (setf one (make-box)
1295 (with-test (:name (:funcallable-instances))
1296 ;; the funcallable-instance implementation used not to be threadsafe
1297 ;; against setting the funcallable-instance function to a closure
1298 ;; (because the code and lexenv were set separately).
1299 (let ((fun (sb-kernel:%make-funcallable-instance 0))
1301 (setf (sb-kernel:funcallable-instance-fun fun) #'closure-one)
1303 (loop (setf (sb-kernel:funcallable-instance-fun fun) #'closure-one)
1304 (setf (sb-kernel:funcallable-instance-fun fun) #'closure-two)))
1306 (handler-case (loop (funcall fun))
1307 (serious-condition (c) (setf condition c)))))
1308 (let ((changer (make-thread #'changer))
1309 (test (make-thread #'test)))
1312 ;; The two closures above are fairly carefully crafted
1313 ;; so that if given the wrong lexenv they will tend to
1314 ;; do some serious damage, but it is of course difficult
1315 ;; to predict where the various bits and pieces will be
1316 ;; allocated. Five seconds failed fairly reliably on
1317 ;; both my x86 and x86-64 systems. -- CSR, 2006-09-27.
1318 (sb-ext:with-timeout 5
1319 (wait-for-threads (list test)))
1320 (error "~@<test thread got condition:~2I~_~A~@:>" condition))
1322 (terminate-thread changer)
1323 (terminate-thread test)
1324 (wait-for-threads (list changer test))))))))
1326 (format t "~&funcallable-instance test done~%")
1328 (defun random-type (n)
1329 `(integer ,(random n) ,(+ n (random n))))
1331 (defun subtypep-hash-cache-test ()
1333 (let ((type1 (random-type 500))
1334 (type2 (random-type 500)))
1335 (let ((a (subtypep type1 type2)))
1337 (assert (eq (subtypep type1 type2) a))))))
1341 (with-test (:name (:hash-cache :subtypep))
1343 (sb-thread:make-thread #'subtypep-hash-cache-test)))
1344 (format t "hash-cache tests done~%")
1346 ;;;; BLACK BOX TESTS
1348 (in-package :cl-user)
1349 (use-package :test-util)
1350 (use-package "ASSERTOID")
1352 (format t "parallel defclass test -- WARNING, WILL HANG ON FAILURE!~%")
1353 (with-test (:name :parallel-defclass)
1354 (defclass test-1 () ((a :initform :orig-a)))
1355 (defclass test-2 () ((b :initform :orig-b)))
1356 (defclass test-3 (test-1 test-2) ((c :initform :orig-c)))
1358 (d1 (sb-thread:make-thread (lambda ()
1360 do (defclass test-1 () ((a :initform :new-a)))
1364 (d2 (sb-thread:make-thread (lambda ()
1366 do (defclass test-2 () ((b :initform :new-b)))
1370 (d3 (sb-thread:make-thread (lambda ()
1372 do (defclass test-3 (test-1 test-2) ((c :initform :new-c)))
1376 (i (sb-thread:make-thread (lambda ()
1378 do (let ((i (make-instance 'test-3)))
1379 (assert (member (slot-value i 'a) '(:orig-a :new-a)))
1380 (assert (member (slot-value i 'b) '(:orig-b :new-b)))
1381 (assert (member (slot-value i 'c) '(:orig-c :new-c))))
1385 (format t "~%sleeping!~%")
1387 (format t "~%stopping!~%")
1390 (sb-thread:join-thread th)
1391 (format t "~%joined ~S~%" (sb-thread:thread-name th)))
1392 (list d1 d2 d3 i))))
1393 (format t "parallel defclass test done~%")
1395 (with-test (:name (:deadlock-detection :interrupts))
1396 (let* ((m1 (sb-thread:make-mutex :name "M1"))
1397 (m2 (sb-thread:make-mutex :name "M2"))
1398 (t1 (sb-thread:make-thread
1400 (sb-thread:with-mutex (m1)
1404 (t2 (sb-thread:make-thread
1407 (sb-thread:with-mutex (m1 :wait-p t)
1412 (sb-thread:interrupt-thread t2 (lambda ()
1413 (sb-thread:with-mutex (m2 :wait-p t)
1416 (sb-thread:interrupt-thread t1 (lambda ()
1417 (sb-thread:with-mutex (m2 :wait-p t)
1419 ;; both threads should finish without a deadlock or deadlock
1421 (let ((res (list (sb-thread:join-thread t1)
1422 (sb-thread:join-thread t2))))
1423 (assert (equal '(:ok :ok) res)))))
1425 (with-test (:name (:deadlock-detection :gc))
1426 ;; To semi-reliably trigger the error (in SBCL's where)
1427 ;; it was present you had to run this for > 30 seconds,
1428 ;; but that's a bit long for a single test.
1429 (let* ((stop (+ 5 (get-universal-time)))
1430 (m1 (sb-thread:make-mutex :name "m1"))
1431 (t1 (sb-thread:make-thread
1433 (loop until (> (get-universal-time) stop)
1434 do (sb-thread:with-mutex (m1)
1435 (eval `(make-array 24))))
1437 (t2 (sb-thread:make-thread
1439 (loop until (> (get-universal-time) stop)
1440 do (sb-thread:with-mutex (m1)
1441 (eval `(make-array 24))))
1443 (let ((res (list (sb-thread:join-thread t1)
1444 (sb-thread:join-thread t2))))
1445 (assert (equal '(:ok :ok) res)))))