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.
14 (in-package "SB-THREAD") ; this is white-box testing, really
16 (use-package :test-util)
18 (defun wait-for-threads (threads)
19 (loop while (some #'sb-thread:thread-alive-p threads) do (sleep 0.01)))
21 (assert (eql 1 (length (list-all-threads))))
23 (assert (eq *current-thread*
24 (find (thread-name *current-thread*) (list-all-threads)
25 :key #'thread-name :test #'equal)))
27 (assert (thread-alive-p *current-thread*))
30 (interrupt-thread *current-thread* (lambda () (setq a 1)))
33 (let ((spinlock (make-spinlock)))
34 (with-spinlock (spinlock)))
36 (let ((mutex (make-mutex)))
40 #-sb-thread (sb-ext:quit :unix-status 104)
42 (let ((old-threads (list-all-threads))
43 (thread (make-thread (lambda ()
44 (assert (find *current-thread* *all-threads*))
46 (new-threads (list-all-threads)))
47 (assert (thread-alive-p thread))
48 (assert (eq thread (first new-threads)))
49 (assert (= (1+ (length old-threads)) (length new-threads)))
51 (assert (not (thread-alive-p thread))))
53 ;;; We had appalling scaling properties for a while. Make sure they
55 (defun scaling-test (function &optional (nthreads 5))
56 "Execute FUNCTION with NTHREADS lurking to slow it down."
57 (let ((queue (sb-thread:make-waitqueue))
58 (mutex (sb-thread:make-mutex)))
59 ;; Start NTHREADS idle threads.
61 (sb-thread:make-thread (lambda ()
63 (sb-thread:condition-wait queue mutex))
65 (let ((start-time (get-internal-run-time)))
67 (prog1 (- (get-internal-run-time) start-time)
68 (sb-thread:condition-broadcast queue)))))
70 "A function that does work with the CPU."
71 (if (zerop n) 1 (* n (fact (1- n)))))
72 (let ((work (lambda () (fact 15000))))
73 (let ((zero (scaling-test work 0))
74 (four (scaling-test work 4)))
75 ;; a slightly weak assertion, but good enough for starters.
76 (assert (< four (* 1.5 zero)))))
78 ;;; For one of the interupt-thread tests, we want a foreign function
79 ;;; that does not make syscalls
81 (with-open-file (o "threads-foreign.c" :direction :output :if-exists :supersede)
82 (format o "void loop_forever() { while(1) ; }~%"))
84 #-sunos "cc" #+sunos "gcc"
85 (or #+(or linux freebsd sunos) '(#+x86-64 "-fPIC"
86 "-shared" "-o" "threads-foreign.so" "threads-foreign.c")
87 #+darwin '("-dynamiclib" "-o" "threads-foreign.so" "threads-foreign.c")
88 (error "Missing shared library compilation options for this platform"))
90 (sb-alien:load-shared-object "threads-foreign.so")
91 (sb-alien:define-alien-routine loop-forever sb-alien:void)
94 ;;; elementary "can we get a lock and release it again"
95 (let ((l (make-mutex :name "foo"))
97 (assert (eql (mutex-value l) nil) nil "1")
98 (sb-thread:get-mutex l)
99 (assert (eql (mutex-value l) p) nil "3")
100 (sb-thread:release-mutex l)
101 (assert (eql (mutex-value l) nil) nil "5"))
103 (labels ((ours-p (value)
104 (eq *current-thread* value)))
105 (let ((l (make-mutex :name "rec")))
106 (assert (eql (mutex-value l) nil) nil "1")
107 (sb-thread:with-recursive-lock (l)
108 (assert (ours-p (mutex-value l)) nil "3")
109 (sb-thread:with-recursive-lock (l)
110 (assert (ours-p (mutex-value l)) nil "4"))
111 (assert (ours-p (mutex-value l)) nil "5"))
112 (assert (eql (mutex-value l) nil) nil "6")))
114 (with-test (:name (:mutex :nesting-mutex-and-recursive-lock))
115 (let ((l (make-mutex :name "a mutex")))
117 (with-recursive-lock (l)))))
119 (let ((l (make-spinlock :name "spinlock")))
120 (assert (eql (spinlock-value l) 0) nil "1")
122 (assert (eql (spinlock-value l) 1) nil "2"))
123 (assert (eql (spinlock-value l) 0) nil "3"))
125 ;; test that SLEEP actually sleeps for at least the given time, even
126 ;; if interrupted by another thread exiting/a gc/anything
127 (let ((start-time (get-universal-time)))
128 (make-thread (lambda () (sleep 1) (sb-ext:gc :full t)))
130 (assert (>= (get-universal-time) (+ 5 start-time))))
133 (let ((queue (make-waitqueue :name "queue"))
134 (lock (make-mutex :name "lock"))
136 (labels ((in-new-thread ()
138 (assert (eql (mutex-value lock) *current-thread*))
139 (format t "~A got mutex~%" *current-thread*)
140 ;; now drop it and sleep
141 (condition-wait queue lock)
142 ;; after waking we should have the lock again
143 (assert (eql (mutex-value lock) *current-thread*))
146 (make-thread #'in-new-thread)
147 (sleep 2) ; give it a chance to start
148 ;; check the lock is free while it's asleep
149 (format t "parent thread ~A~%" *current-thread*)
150 (assert (eql (mutex-value lock) nil))
153 (condition-notify queue))
156 (let ((queue (make-waitqueue :name "queue"))
157 (lock (make-mutex :name "lock")))
158 (labels ((ours-p (value)
159 (eq *current-thread* value))
161 (with-recursive-lock (lock)
162 (assert (ours-p (mutex-value lock)))
163 (format t "~A got mutex~%" (mutex-value lock))
164 ;; now drop it and sleep
165 (condition-wait queue lock)
166 ;; after waking we should have the lock again
167 (format t "woken, ~A got mutex~%" (mutex-value lock))
168 (assert (ours-p (mutex-value lock))))))
169 (make-thread #'in-new-thread)
170 (sleep 2) ; give it a chance to start
171 ;; check the lock is free while it's asleep
172 (format t "parent thread ~A~%" *current-thread*)
173 (assert (eql (mutex-value lock) nil))
174 (with-recursive-lock (lock)
175 (condition-notify queue))
178 (let ((mutex (make-mutex :name "contended")))
180 (let ((me *current-thread*))
184 (assert (eql (mutex-value mutex) me)))
185 (assert (not (eql (mutex-value mutex) me))))
186 (format t "done ~A~%" *current-thread*))))
187 (let ((kid1 (make-thread #'run))
188 (kid2 (make-thread #'run)))
189 (format t "contention ~A ~A~%" kid1 kid2)
190 (wait-for-threads (list kid1 kid2)))))
194 (defmacro raises-timeout-p (&body body)
195 `(handler-case (progn (progn ,@body) nil)
196 (sb-ext:timeout () t)))
198 (with-test (:name (:semaphore :wait-forever))
199 (let ((sem (make-semaphore :count 0)))
200 (assert (raises-timeout-p
201 (sb-ext:with-timeout 0.1
202 (wait-on-semaphore sem))))))
204 (with-test (:name (:semaphore :initial-count))
205 (let ((sem (make-semaphore :count 1)))
206 (sb-ext:with-timeout 0.1
207 (wait-on-semaphore sem))))
209 (with-test (:name (:semaphore :wait-then-signal))
210 (let ((sem (make-semaphore))
212 (make-thread (lambda ()
215 (signal-semaphore sem)))
216 (wait-on-semaphore sem)
217 (assert signalled-p)))
219 (with-test (:name (:semaphore :signal-then-wait))
220 (let ((sem (make-semaphore))
222 (make-thread (lambda ()
223 (signal-semaphore sem)
224 (setq signalled-p t)))
225 (loop until signalled-p)
226 (wait-on-semaphore sem)
227 (assert signalled-p)))
229 (with-test (:name (:semaphore :multiple-signals))
230 (let* ((sem (make-semaphore :count 5))
231 (threads (loop repeat 20
232 collect (make-thread (lambda ()
233 (wait-on-semaphore sem))))))
234 (flet ((count-live-threads ()
235 (count-if #'thread-alive-p threads)))
237 (assert (= 15 (count-live-threads)))
238 (signal-semaphore sem 10)
240 (assert (= 5 (count-live-threads)))
241 (signal-semaphore sem 3)
243 (assert (= 2 (count-live-threads)))
244 (signal-semaphore sem 4)
246 (assert (= 0 (count-live-threads))))))
248 (format t "~&semaphore tests done~%")
250 (defun test-interrupt (function-to-interrupt &optional quit-p)
251 (let ((child (make-thread function-to-interrupt)))
252 ;;(format t "gdb ./src/runtime/sbcl ~A~%attach ~A~%" child child)
254 (format t "interrupting child ~A~%" child)
255 (interrupt-thread child
257 (format t "child pid ~A~%" *current-thread*)
258 (when quit-p (sb-ext:quit))))
262 ;; separate tests for (a) interrupting Lisp code, (b) C code, (c) a syscall,
263 ;; (d) waiting on a lock, (e) some code which we hope is likely to be
266 (let ((child (test-interrupt (lambda () (loop))))) (terminate-thread child))
268 (test-interrupt #'loop-forever :quit)
270 (let ((child (test-interrupt (lambda () (loop (sleep 2000))))))
271 (terminate-thread child)
272 (wait-for-threads (list child)))
274 (let ((lock (make-mutex :name "loctite"))
277 (setf child (test-interrupt
280 (assert (eql (mutex-value lock) *current-thread*)))
281 (assert (not (eql (mutex-value lock) *current-thread*)))
283 ;;hold onto lock for long enough that child can't get it immediately
285 (interrupt-thread child (lambda () (format t "l ~A~%" (mutex-value lock))))
286 (format t "parent releasing lock~%"))
287 (terminate-thread child)
288 (wait-for-threads (list child)))
290 (format t "~&locking test done~%")
292 (defun alloc-stuff () (copy-list '(1 2 3 4 5)))
295 (let ((thread (sb-thread:make-thread (lambda () (loop (alloc-stuff))))))
297 (loop repeat 4 collect
298 (sb-thread:make-thread
301 (sleep (random 0.1d0))
304 (sb-thread:interrupt-thread thread (lambda ()))))))))
305 (wait-for-threads killers)
306 (sb-thread:terminate-thread thread)
307 (wait-for-threads (list thread))))
310 (format t "~&multi interrupt test done~%")
312 (let ((c (make-thread (lambda () (loop (alloc-stuff))))))
313 ;; NB this only works on x86: other ports don't have a symbol for
314 ;; pseudo-atomic atomicity
316 (sleep (random 0.1d0))
319 (princ ".") (force-output)
320 (assert (thread-alive-p *current-thread*))
322 (not (logbitp 0 SB-KERNEL:*PSEUDO-ATOMIC-BITS*))))))
324 (wait-for-threads (list c)))
326 (format t "~&interrupt test done~%")
328 (defparameter *interrupt-count* 0)
330 (declaim (notinline check-interrupt-count))
331 (defun check-interrupt-count (i)
332 (declare (optimize (debug 1) (speed 1)))
333 ;; This used to lose if eflags were not restored after an interrupt.
334 (unless (typep i 'fixnum)
335 (error "!!!!!!!!!!!")))
337 (let ((c (make-thread
339 (handler-bind ((error #'(lambda (cond)
342 most-positive-fixnum))))
343 (loop (check-interrupt-count *interrupt-count*)))))))
344 (let ((func (lambda ()
347 (sb-impl::atomic-incf/symbol *interrupt-count*))))
348 (setq *interrupt-count* 0)
350 (sleep (random 0.1d0))
351 (interrupt-thread c func))
352 (loop until (= *interrupt-count* 100) do (sleep 0.1))
354 (wait-for-threads (list c))))
356 (format t "~&interrupt count test done~%")
359 (make-thread (lambda ()
361 (sb-ext:gc) (princ "\\") (force-output))
363 (make-thread (lambda ()
366 (princ "/") (force-output))
369 (when (and a-done b-done) (return))
374 (defun waste (&optional (n 100000))
375 (loop repeat n do (make-string 16384)))
377 (loop for i below 100 do
380 (sb-thread:make-thread
388 (defparameter *aaa* nil)
389 (loop for i below 100 do
392 (sb-thread:make-thread
394 (let ((*aaa* (waste)))
396 (let ((*aaa* (waste)))
400 (format t "~&gc test done~%")
402 ;; this used to deadlock on session-lock
403 (sb-thread:make-thread (lambda () (sb-ext:gc)))
404 ;; expose thread creation races by exiting quickly
405 (sb-thread:make-thread (lambda ()))
407 (defun exercise-syscall (fn reference-errno)
408 (sb-thread:make-thread
412 (let ((errno (sb-unix::get-errno)))
413 (sleep (random 0.1d0))
414 (unless (eql errno reference-errno)
415 (format t "Got errno: ~A (~A) instead of ~A~%"
420 (sb-ext:quit :unix-status 1)))))))
422 (let* ((nanosleep-errno (progn
423 (sb-unix:nanosleep -1 0)
424 (sb-unix::get-errno)))
427 :if-does-not-exist nil)
428 (sb-unix::get-errno)))
431 (exercise-syscall (lambda () (sb-unix:nanosleep -1 0)) nanosleep-errno)
432 (exercise-syscall (lambda () (open "no-such-file"
433 :if-does-not-exist nil))
435 (sb-thread:make-thread (lambda () (loop (sb-ext:gc) (sleep 1)))))))
437 (princ "terminating threads")
438 (dolist (thread threads)
439 (sb-thread:terminate-thread thread)))
441 (format t "~&errno test done~%")
444 (let ((thread (sb-thread:make-thread (lambda () (sleep 0.1)))))
445 (sb-thread:interrupt-thread
448 (assert (find-restart 'sb-thread:terminate-thread))))))
452 (format t "~&thread startup sigmask test done~%")
454 (sb-debug::enable-debugger)
455 (let* ((main-thread *current-thread*)
457 (make-thread (lambda ()
459 (interrupt-thread main-thread #'break)
461 (interrupt-thread main-thread #'continue)))))
462 (with-session-lock (*session*)
464 (loop while (thread-alive-p interruptor-thread)))
466 (format t "~&session lock test done~%")
470 (loop for i below 100 collect
471 (sb-thread:make-thread (lambda ())))))
473 (format t "~&creation test done~%")
475 ;; interrupt handlers are per-thread with pthreads, make sure the
476 ;; handler installed in one thread is global
477 (sb-thread:make-thread
479 (sb-ext:run-program "sleep" '("1") :search t :wait nil)))
481 ;;;; Binding stack safety
483 (defparameter *x* nil)
484 (defparameter *n-gcs-requested* 0)
485 (defparameter *n-gcs-done* 0)
488 (defun make-something-big ()
489 (let ((x (make-string 32000)))
491 (let ((counter counter))
492 (sb-ext:finalize x (lambda () (format t " ~S" counter)
495 (defmacro wait-for-gc ()
497 (incf *n-gcs-requested*)
498 (loop while (< *n-gcs-done* *n-gcs-requested*))))
501 (loop until (< *n-gcs-done* *n-gcs-requested*))
507 (defun exercise-binding ()
509 (let ((*x* (make-something-big)))
511 ;; at this point the binding stack looks like this:
512 ;; NO-TLS-VALUE-MARKER, *x*, SOMETHING, *x*
515 ;; sig_stop_for_gc_handler binds FREE_INTERRUPT_CONTEXT_INDEX. By
516 ;; now SOMETHING is gc'ed and the binding stack looks like this: 0,
517 ;; 0, SOMETHING, 0 (because the symbol slots are zeroed on
518 ;; unbinding but values are not).
520 ;; bump bsp as if a BIND had just started
521 (incf sb-vm::*binding-stack-pointer* 2)
523 (decf sb-vm::*binding-stack-pointer* 2))))
525 (with-test (:name (:binding-stack-gc-safety))
529 (push (sb-thread:make-thread #'exercise-binding) threads)
530 (push (sb-thread:make-thread (lambda ()
536 (mapc #'sb-thread:terminate-thread threads))))
538 (format t "~&binding test done~%")
540 ;; Try to corrupt the NEXT-VECTOR. Operations on a hash table with a
541 ;; cyclic NEXT-VECTOR can loop endlessly in a WITHOUT-GCING form
542 ;; causing the next gc hang SBCL.
543 (with-test (:name (:hash-table-thread-safety))
544 (let* ((hash (make-hash-table))
545 (threads (list (sb-thread:make-thread
548 ;;(princ "1") (force-output)
549 (setf (gethash (random 100) hash) 'h))))
550 (sb-thread:make-thread
553 ;;(princ "2") (force-output)
554 (remhash (random 100) hash))))
555 (sb-thread:make-thread
559 (sb-ext:gc :full t)))))))
562 (mapc #'sb-thread:terminate-thread threads))))
564 (format t "~&hash table test done~%")
565 #| ;; a cll post from eric marsden
567 | (setq *debugger-hook*
568 | (lambda (condition old-debugger-hook)
569 | (debug:backtrace 10)
570 | (unix:unix-exit 2)))
572 | (mp::start-sigalrm-yield)
573 | (flet ((roomy () (loop (with-output-to-string (*standard-output*) (room)))))
574 | (mp:make-process #'roomy)
575 | (mp:make-process #'roomy)))
578 (with-test (:name (:condition-variable :notify-multiple))
579 (flet ((tester (notify-fun)
580 (let ((queue (make-waitqueue :name "queue"))
581 (lock (make-mutex :name "lock"))
586 (format t "condition-wait ~a~%" x)
588 (condition-wait queue lock)
589 (format t "woke up ~a~%" x)
592 (let ((threads (loop for x from 1 to 10
595 (sb-thread:make-thread (lambda ()
599 (funcall notify-fun queue))
601 (mapcar #'terminate-thread threads)
602 ;; Check that all threads woke up at least once
603 (assert (= (length (remove-duplicates data)) 10)))))))
604 (tester (lambda (queue)
605 (format t "~&(condition-notify queue 10)~%")
607 (condition-notify queue 10)))
608 (tester (lambda (queue)
609 (format t "~&(condition-broadcast queue)~%")
611 (condition-broadcast queue)))))
613 (format t "waitqueue wakeup tests done~%")
615 (with-test (:name (:mutex :finalization))
618 (setf a (make-mutex)))))
620 (format t "mutex finalization test done~%")
622 ;;; Check that INFO is thread-safe, at least when we're just doing reads.
624 (let* ((symbols (loop repeat 10000 collect (gensym)))
625 (functions (loop for (symbol . rest) on symbols
626 for next = (car rest)
627 for fun = (let ((next next))
630 (funcall next (1- n))
632 do (setf (symbol-function symbol) fun)
634 (defun infodb-test ()
635 (funcall (car functions) 9999)))
637 (with-test (:name (:infodb :read))
639 (threads (loop for i from 0 to 10
640 collect (sb-thread:make-thread
646 (let ((n (infodb-test)))
649 (format t "N != 0 (~A)~%" n)
651 (wait-for-threads threads)
654 (format t "infodb test done~%")
656 (with-test (:name (:backtrace))
657 ;; Printing backtraces from several threads at once used to hang the
658 ;; whole SBCL process (discovered by accident due to a timer.impure
659 ;; test misbehaving). The cause was that packages weren't even
660 ;; thread-safe for only doing FIND-SYMBOL, and while printing
661 ;; backtraces a loot of symbol lookups need to be done due to
663 (let* ((threads (loop repeat 10
664 collect (sb-thread:make-thread
667 (with-output-to-string (*debug-io*)
668 (sb-debug::backtrace 10))))))))
669 (wait-for-threads threads)))
671 (format t "backtrace test done~%")
673 (format t "~&starting gc deadlock test: WARNING: THIS TEST WILL HANG ON FAILURE!~%")
675 (with-test (:name (:gc-deadlock))
676 ;; Prior to 0.9.16.46 thread exit potentially deadlocked the
677 ;; GC due to *all-threads-lock* and session lock. On earlier
678 ;; versions and at least on one specific box this test is good enough
679 ;; to catch that typically well before the 1500th iteration.
686 (when (zerop (mod i 100))
691 (sb-thread:make-thread
693 (sleep (random 0.001)))
694 :name (list :sleep i))
695 (sb-thread:make-thread
697 ;; KLUDGE: what we are doing here is explicit,
698 ;; but the same can happen because of a regular
699 ;; MAKE-THREAD or LIST-ALL-THREADS, and various
700 ;; session functions.
701 (sb-thread:with-mutex (sb-thread::*all-threads-lock*)
702 (sb-thread::with-session-lock (sb-thread::*session*)
706 (format t "~%error creating thread ~D: ~A -- backing off for retry~%" i e)
710 (format t "~&gc deadlock test done~%")
712 (let ((count (make-array 8 :initial-element 0)))
713 (defun closure-one ()
714 (declare (optimize safety))
715 (values (incf (aref count 0)) (incf (aref count 1))
716 (incf (aref count 2)) (incf (aref count 3))
717 (incf (aref count 4)) (incf (aref count 5))
718 (incf (aref count 6)) (incf (aref count 7))))
719 (defun no-optimizing-away-closure-one ()
720 (setf count (make-array 8 :initial-element 0))))
725 (let ((one (make-box))
728 (defun closure-two ()
729 (declare (optimize safety))
730 (values (incf (box-count one)) (incf (box-count two)) (incf (box-count three))))
731 (defun no-optimizing-away-closure-two ()
736 (with-test (:name (:funcallable-instances))
737 ;; the funcallable-instance implementation used not to be threadsafe
738 ;; against setting the funcallable-instance function to a closure
739 ;; (because the code and lexenv were set separately).
740 (let ((fun (sb-kernel:%make-funcallable-instance 0))
742 (setf (sb-kernel:funcallable-instance-fun fun) #'closure-one)
744 (loop (setf (sb-kernel:funcallable-instance-fun fun) #'closure-one)
745 (setf (sb-kernel:funcallable-instance-fun fun) #'closure-two)))
747 (handler-case (loop (funcall fun))
748 (serious-condition (c) (setf condition c)))))
749 (let ((changer (make-thread #'changer))
750 (test (make-thread #'test)))
753 ;; The two closures above are fairly carefully crafted
754 ;; so that if given the wrong lexenv they will tend to
755 ;; do some serious damage, but it is of course difficult
756 ;; to predict where the various bits and pieces will be
757 ;; allocated. Five seconds failed fairly reliably on
758 ;; both my x86 and x86-64 systems. -- CSR, 2006-09-27.
759 (sb-ext:with-timeout 5
760 (wait-for-threads (list test)))
761 (error "~@<test thread got condition:~2I~_~A~@:>" condition))
763 (terminate-thread changer)
764 (terminate-thread test)
765 (wait-for-threads (list changer test))))))))
767 (format t "~&funcallable-instance test done~%")