tests/threads.impure.lisp

   1 ;;;; miscellaneous tests of thread stuff
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   6 ;;;; While most of SBCL is derived from the CMU CL system, the test
   7 ;;;; files (like this one) were written from scratch after the fork
   8 ;;;; from CMU CL.
   9 ;;;
  10 ;;;; This software is in the public domain and is provided with
  11 ;;;; absoluely no warranty. See the COPYING and CREDITS files for
  12 ;;;; more information.
  13
  14 ; WHITE-BOX TESTS
  15
  16 (in-package "SB-THREAD")
  17 (use-package :test-util)
  18 (use-package "ASSERTOID")
  19
  20 (setf sb-unix::*on-dangerous-wait* :error)
  21
  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))))
  25
  26 (with-test (:name (:threads :trivia))
  27   (assert (eql 1 (length (list-all-threads))))
  28
  29   (assert (eq *current-thread*
  30               (find (thread-name *current-thread*) (list-all-threads)
  31                     :key #'thread-name :test #'equal)))
  32
  33   (assert (thread-alive-p *current-thread*)))
  34
  35 (with-test (:name (:with-mutex :basics))
  36   (let ((mutex (make-mutex)))
  37     (with-mutex (mutex)
  38       mutex)))
  39
  40 (sb-alien:define-alien-routine "check_deferrables_blocked_or_lose"
  41     void
  42   (where sb-alien:unsigned-long))
  43 (sb-alien:define-alien-routine "check_deferrables_unblocked_or_lose"
  44     void
  45   (where sb-alien:unsigned-long))
  46
  47 (with-test (:name (:interrupt-thread :basics :no-unwinding))
  48   (let ((a 0))
  49     (interrupt-thread *current-thread* (lambda () (setq a 1)))
  50     (assert (eql a 1))))
  51
  52 (with-test (:name (:interrupt-thread :deferrables-blocked))
  53   (sb-thread:interrupt-thread sb-thread:*current-thread*
  54                               (lambda ()
  55                                 (check-deferrables-blocked-or-lose 0))))
  56
  57 (with-test (:name (:interrupt-thread :deferrables-unblocked))
  58   (sb-thread:interrupt-thread sb-thread:*current-thread*
  59                               (lambda ()
  60                                 (with-interrupts
  61                                   (check-deferrables-unblocked-or-lose 0)))))
  62
  63 (with-test (:name (:interrupt-thread :nlx))
  64   (catch 'xxx
  65     (sb-thread:interrupt-thread sb-thread:*current-thread*
  66                                 (lambda ()
  67                                   (check-deferrables-blocked-or-lose 0)
  68                                   (throw 'xxx nil))))
  69   (check-deferrables-unblocked-or-lose 0))
  70
  71 #-sb-thread (sb-ext:exit :code 104)
  72
  73 ;;;; Now the real tests...
  74
  75 (with-test (:name (:with-mutex :timeout))
  76   (let ((m (make-mutex)))
  77     (with-mutex (m)
  78       (assert (null (join-thread (make-thread
  79                                   (lambda ()
  80                                     (with-mutex (m :timeout 0.1)
  81                                       t)))))))
  82     (assert (join-thread (make-thread
  83                           (lambda ()
  84                             (with-mutex (m :timeout 0.1)
  85                               t)))))))
  86
  87 (with-test (:name (:interrupt-thread :deferrables-unblocked-by-lock))
  88   (let ((lock (sb-thread::make-mutex))
  89         (thread (make-join-thread (lambda ()
  90                                     (loop (sleep 1))))))
  91     (sb-thread::grab-mutex lock)
  92     (sb-thread:interrupt-thread thread
  93                                 (lambda ()
  94                                   (check-deferrables-blocked-or-lose 0)
  95                                   (sb-thread::grab-mutex lock)
  96                                   (check-deferrables-unblocked-or-lose 0)
  97                                   (sb-thread:abort-thread)))
  98     (sleep 3)
  99     (sb-thread::release-mutex lock)))
 100
 101 ;;; compare-and-swap
 102
 103 (defmacro defincf (name accessor &rest args)
 104   `(defun ,name (x)
 105      (let* ((old (,accessor x ,@args))
 106          (new (1+ old)))
 107     (loop until (eq old (sb-ext:compare-and-swap (,accessor x ,@args) old new))
 108        do (setf old (,accessor x ,@args)
 109                 new (1+ old)))
 110     new)))
 111
 112 (defstruct cas-struct (slot 0))
 113
 114 (defincf incf-car car)
 115 (defincf incf-cdr cdr)
 116 (defincf incf-slot cas-struct-slot)
 117 (defincf incf-symbol-value symbol-value)
 118 (defincf incf-svref/1 svref 1)
 119 (defincf incf-svref/0 svref 0)
 120
 121 (defmacro def-test-cas (name init incf op)
 122   `(with-test (:name ,name)
 123      (flet ((,name (n)
 124               (declare (fixnum n))
 125               (let* ((x ,init)
 126                      (run nil)
 127                      (threads
 128                       (loop repeat 10
 129                             collect (sb-thread:make-thread
 130                                      (lambda ()
 131                                        (loop until run
 132                                              do (sb-thread:thread-yield))
 133                                        (loop repeat n do (,incf x)))))))
 134                 (setf run t)
 135                 (dolist (th threads)
 136                   (sb-thread:join-thread th))
 137                 (assert (= (,op x) (* 10 n))))))
 138        (,name 200000))))
 139
 140 (def-test-cas test-cas-car (cons 0 nil) incf-car car)
 141 (def-test-cas test-cas-cdr (cons nil 0) incf-cdr cdr)
 142 (def-test-cas test-cas-slot (make-cas-struct) incf-slot cas-struct-slot)
 143 (def-test-cas test-cas-value (let ((x '.x.))
 144                                (set x 0)
 145                                x)
 146   incf-symbol-value symbol-value)
 147 (def-test-cas test-cas-svref/0 (vector 0 nil) incf-svref/0 (lambda (x)
 148                                                              (svref x 0)))
 149 (def-test-cas test-cas-svref/1 (vector nil 0) incf-svref/1 (lambda (x)
 150                                                              (svref x 1)))
 151 (format t "~&compare-and-swap tests done~%")
 152
 153 (with-test (:name (:threads :more-trivia)))
 154 (let ((old-threads (list-all-threads))
 155       (thread (make-thread (lambda ()
 156                              (assert (find *current-thread* *all-threads*))
 157                              (sleep 2))))
 158       (new-threads (list-all-threads)))
 159   (assert (thread-alive-p thread))
 160   (assert (eq thread (first new-threads)))
 161   (assert (= (1+ (length old-threads)) (length new-threads)))
 162   (sleep 3)
 163   (assert (not (thread-alive-p thread))))
 164
 165 (with-test (:name (:join-thread :nlx :default))
 166   (let ((sym (gensym)))
 167     (assert (eq sym (join-thread (make-thread (lambda () (sb-thread:abort-thread)))
 168                                  :default sym)))))
 169
 170 (with-test (:name (:join-thread :nlx :error))
 171   (raises-error? (join-thread (make-thread (lambda () (sb-thread:abort-thread))))
 172                  join-thread-error))
 173
 174 (with-test (:name (:join-thread :multiple-values))
 175   (assert (equal '(1 2 3)
 176                  (multiple-value-list
 177                   (join-thread (make-thread (lambda () (values 1 2 3))))))))
 178
 179 ;;; We had appalling scaling properties for a while.  Make sure they
 180 ;;; don't reappear.
 181 (defun scaling-test (function &optional (nthreads 5))
 182   "Execute FUNCTION with NTHREADS lurking to slow it down."
 183   (let ((queue (sb-thread:make-waitqueue))
 184         (mutex (sb-thread:make-mutex)))
 185     ;; Start NTHREADS idle threads.
 186     (dotimes (i nthreads)
 187       (make-join-thread (lambda ()
 188                           (with-mutex (mutex)
 189                             (sb-thread:condition-wait queue mutex))
 190                           (sb-thread:abort-thread))))
 191     (let ((start-time (get-internal-run-time)))
 192       (funcall function)
 193       (prog1 (- (get-internal-run-time) start-time)
 194         (sb-thread:condition-broadcast queue)))))
 195 (defun fact (n)
 196   "A function that does work with the CPU."
 197   (if (zerop n) 1 (* n (fact (1- n)))))
 198
 199 (with-test (:name :lurking-threads)
 200   (let ((work (lambda () (fact 15000))))
 201     (let ((zero (scaling-test work 0))
 202           (four (scaling-test work 4)))
 203       ;; a slightly weak assertion, but good enough for starters.
 204       (assert (< four (* 1.5 zero))))))
 205
 206 ;;; For one of the interupt-thread tests, we want a foreign function
 207 ;;; that does not make syscalls
 208
 209 #-win32
 210 (progn
 211   (with-open-file (o "threads-foreign.c" :direction :output :if-exists :supersede)
 212     (format o "void loop_forever() { while(1) ; }~%"))
 213   (sb-ext:run-program "/bin/sh"
 214                       '("run-compiler.sh" "-sbcl-pic" "-sbcl-shared"
 215                         "-o" "threads-foreign.so" "threads-foreign.c"))
 216   (sb-alien:load-shared-object (truename "threads-foreign.so"))
 217   (sb-alien:define-alien-routine loop-forever sb-alien:void)
 218   (delete-file "threads-foreign.c"))
 219
 220 ;;; elementary "can we get a lock and release it again"
 221 (with-test (:name (:mutex :basics))
 222   (let ((l (make-mutex :name "foo"))
 223         (p *current-thread*))
 224     (assert (eql (mutex-value l) nil) nil "1")
 225     (sb-thread:grab-mutex l)
 226     (assert (eql (mutex-value l) p) nil "3")
 227     (sb-thread:release-mutex l)
 228     (assert (eql (mutex-value l) nil) nil "5")))
 229
 230 (with-test (:name (:with-recursive-lock :basics))
 231   (labels ((ours-p (value)
 232              (eq *current-thread* value)))
 233     (let ((l (make-mutex :name "rec")))
 234       (assert (eql (mutex-value l) nil) nil "1")
 235       (sb-thread:with-recursive-lock (l)
 236         (assert (ours-p (mutex-value l)) nil "3")
 237         (sb-thread:with-recursive-lock (l)
 238           (assert (ours-p (mutex-value l)) nil "4"))
 239         (assert (ours-p (mutex-value l)) nil "5"))
 240       (assert (eql (mutex-value l) nil) nil "6"))))
 241
 242 (with-test (:name (:with-recursive-lock :wait-p))
 243   (let ((m (make-mutex)))
 244     (with-mutex (m)
 245       (assert (null (join-thread (make-thread
 246                                   (lambda ()
 247                                     (with-recursive-lock (m :wait-p nil)
 248                                       t)))))))
 249     (assert (join-thread (make-thread
 250                           (lambda ()
 251                             (with-recursive-lock (m :wait-p nil)
 252                               t)))))))
 253
 254 (with-test (:name (:with-recursive-lock :wait-p :recursive))
 255   (let ((m (make-mutex)))
 256     (assert (join-thread (make-thread
 257                           (lambda ()
 258                             (with-recursive-lock (m :wait-p nil)
 259                               (with-recursive-lock (m :wait-p nil)
 260                                 t))))))))
 261
 262 (with-test (:name (:with-recursive-lock :timeout))
 263   (let ((m (make-mutex)))
 264     (with-mutex (m)
 265       (assert (null (join-thread (make-thread
 266                                   (lambda ()
 267                                     (with-recursive-lock (m :timeout 0.1)
 268                                       t)))))))
 269     (assert (join-thread (make-thread
 270                           (lambda ()
 271                             (with-recursive-lock (m :timeout 0.1)
 272                               t)))))))
 273
 274 (with-test (:name (:with-recursive-lock :timeout :recursive))
 275   (let ((m (make-mutex)))
 276     (assert (join-thread (make-thread
 277                           (lambda ()
 278                             (with-recursive-lock (m :timeout 0.1)
 279                               (with-recursive-lock (m :timeout 0.1)
 280                                 t))))))))
 281
 282 (with-test (:name (:mutex :nesting-mutex-and-recursive-lock))
 283   (let ((l (make-mutex :name "a mutex")))
 284     (with-mutex (l)
 285       (with-recursive-lock (l)))))
 286
 287 ;; test that SLEEP actually sleeps for at least the given time, even
 288 ;; if interrupted by another thread exiting/a gc/anything
 289 (with-test (:name (:sleep :continue-sleeping-after-interrupt))
 290   (let ((start-time (get-universal-time)))
 291     (make-join-thread (lambda () (sleep 1) (sb-ext:gc :full t)))
 292     (sleep 5)
 293     (assert (>= (get-universal-time) (+ 5 start-time)))))
 294
 295
 296 (with-test (:name (:condition-wait :basics-1))
 297   (let ((queue (make-waitqueue :name "queue"))
 298         (lock (make-mutex :name "lock"))
 299         (n 0))
 300     (labels ((in-new-thread ()
 301                (with-mutex (lock)
 302                  (assert (eql (mutex-value lock) *current-thread*))
 303                  (format t "~A got mutex~%" *current-thread*)
 304                  ;; now drop it and sleep
 305                  (condition-wait queue lock)
 306                  ;; after waking we should have the lock again
 307                  (assert (eql (mutex-value lock) *current-thread*))
 308                  (assert (eql n 1))
 309                  (decf n))))
 310       (make-join-thread #'in-new-thread)
 311       (sleep 2)            ; give it  a chance to start
 312       ;; check the lock is free while it's asleep
 313       (format t "parent thread ~A~%" *current-thread*)
 314       (assert (eql (mutex-value lock) nil))
 315       (with-mutex (lock)
 316         (incf n)
 317         (condition-notify queue))
 318       (sleep 1))))
 319
 320 (with-test (:name (:condition-wait :basics-2))
 321   (let ((queue (make-waitqueue :name "queue"))
 322         (lock (make-mutex :name "lock")))
 323     (labels ((ours-p (value)
 324                (eq *current-thread* value))
 325              (in-new-thread ()
 326                (with-recursive-lock (lock)
 327                  (assert (ours-p (mutex-value lock)))
 328                  (format t "~A got mutex~%" (mutex-value lock))
 329                  ;; now drop it and sleep
 330                  (condition-wait queue lock)
 331                  ;; after waking we should have the lock again
 332                  (format t "woken, ~A got mutex~%" (mutex-value lock))
 333                  (assert (ours-p (mutex-value lock))))))
 334       (make-join-thread #'in-new-thread)
 335       (sleep 2)            ; give it  a chance to start
 336       ;; check the lock is free while it's asleep
 337       (format t "parent thread ~A~%" *current-thread*)
 338       (assert (eql (mutex-value lock) nil))
 339       (with-recursive-lock (lock)
 340         (condition-notify queue))
 341       (sleep 1))))
 342
 343 (with-test (:name (:mutex :contention))
 344   (let ((mutex (make-mutex :name "contended")))
 345     (labels ((run ()
 346                (let ((me *current-thread*))
 347                  (dotimes (i 100)
 348                    (with-mutex (mutex)
 349                      (sleep .03)
 350                      (assert (eql (mutex-value mutex) me)))
 351                    (assert (not (eql (mutex-value mutex) me))))
 352                  (format t "done ~A~%" *current-thread*))))
 353       (let ((kid1 (make-thread #'run))
 354             (kid2 (make-thread #'run)))
 355         (format t "contention ~A ~A~%" kid1 kid2)
 356         (wait-for-threads (list kid1 kid2))))))
 357
 358 ;;; GRAB-MUTEX
 359
 360 (with-test (:name (:grab-mutex :waitp nil))
 361   (let ((m (make-mutex)))
 362     (with-mutex (m)
 363       (assert (null (join-thread (make-thread
 364                                   #'(lambda ()
 365                                       (grab-mutex m :waitp nil)))))))))
 366
 367 (with-test (:name (:grab-mutex :timeout :acquisition-fail))
 368   (let ((m (make-mutex))
 369         (w (make-semaphore)))
 370     (with-mutex (m)
 371       (let ((th (make-thread
 372                  #'(lambda ()
 373                      (prog1
 374                          (grab-mutex m :timeout 0.1)
 375                        (signal-semaphore w))))))
 376         ;; Wait for it to -- otherwise the detect the deadlock chain
 377         ;; from JOIN-THREAD.
 378         (wait-on-semaphore w)
 379         (assert (null (join-thread th)))))))
 380
 381 (with-test (:name (:grab-mutex :timeout :acquisition-success))
 382   (let ((m (make-mutex))
 383         (child))
 384     (with-mutex (m)
 385       (setq child (make-thread #'(lambda () (grab-mutex m :timeout 1.0))))
 386       (sleep 0.2))
 387     (assert (eq (join-thread child) 't))))
 388
 389 (with-test (:name (:grab-mutex :timeout+deadline))
 390   (let ((m (make-mutex))
 391         (w (make-semaphore)))
 392     (with-mutex (m)
 393       (let ((th (make-thread #'(lambda ()
 394                                  (sb-sys:with-deadline (:seconds 0.0)
 395                                    (handler-case
 396                                        (grab-mutex m :timeout 0.0)
 397                                      (sb-sys:deadline-timeout ()
 398                                        (signal-semaphore w)
 399                                        :deadline)))))))
 400         (wait-on-semaphore w)
 401         (assert (eq (join-thread th) :deadline))))))
 402
 403 (with-test (:name (:grab-mutex :waitp+deadline))
 404   (let ((m (make-mutex)))
 405     (with-mutex (m)
 406       (assert (eq (join-thread
 407                    (make-thread #'(lambda ()
 408                                     (sb-sys:with-deadline (:seconds 0.0)
 409                                       (handler-case
 410                                           (grab-mutex m :waitp nil)
 411                                         (sb-sys:deadline-timeout ()
 412                                           :deadline))))))
 413                   'nil)))))
 414
 415 ;;; semaphores
 416
 417 (defmacro raises-timeout-p (&body body)
 418   `(handler-case (progn (progn ,@body) nil)
 419     (sb-ext:timeout () t)))
 420
 421 (with-test (:name (:semaphore :wait-forever))
 422   (let ((sem (make-semaphore :count 0)))
 423     (assert (raises-timeout-p
 424               (sb-ext:with-timeout 0.1
 425                 (wait-on-semaphore sem))))))
 426
 427 (with-test (:name (:semaphore :initial-count))
 428   (let ((sem (make-semaphore :count 1)))
 429     (sb-ext:with-timeout 0.1
 430       (wait-on-semaphore sem))))
 431
 432 (with-test (:name (:semaphore :wait-then-signal))
 433   (let ((sem (make-semaphore))
 434         (signalled-p nil))
 435     (make-join-thread (lambda ()
 436                         (sleep 0.1)
 437                         (setq signalled-p t)
 438                         (signal-semaphore sem)))
 439     (wait-on-semaphore sem)
 440     (assert signalled-p)))
 441
 442 (with-test (:name (:semaphore :signal-then-wait))
 443   (let ((sem (make-semaphore))
 444         (signalled-p nil))
 445     (make-join-thread (lambda ()
 446                         (signal-semaphore sem)
 447                         (setq signalled-p t)))
 448     (loop until signalled-p)
 449     (wait-on-semaphore sem)
 450     (assert signalled-p)))
 451
 452 (defun test-semaphore-multiple-signals (wait-on-semaphore)
 453   (let* ((sem (make-semaphore :count 5))
 454          (threads (loop repeat 20 collecting
 455                         (make-join-thread (lambda ()
 456                                             (funcall wait-on-semaphore sem))))))
 457     (flet ((count-live-threads ()
 458              (count-if #'thread-alive-p threads)))
 459       (sleep 0.5)
 460       (assert (= 15 (count-live-threads)))
 461       (signal-semaphore sem 10)
 462       (sleep 0.5)
 463       (assert (= 5 (count-live-threads)))
 464       (signal-semaphore sem 3)
 465       (sleep 0.5)
 466       (assert (= 2 (count-live-threads)))
 467       (signal-semaphore sem 4)
 468       (sleep 0.5)
 469       (assert (= 0 (count-live-threads))))))
 470
 471 (with-test (:name (:semaphore :multiple-signals))
 472   (test-semaphore-multiple-signals #'wait-on-semaphore))
 473
 474 (with-test (:name (:try-semaphore :trivial-fail))
 475   (assert (eq (try-semaphore (make-semaphore :count 0)) 'nil)))
 476
 477 (with-test (:name (:try-semaphore :trivial-success))
 478   (let ((sem (make-semaphore :count 1)))
 479     (assert (try-semaphore sem))
 480     (assert (zerop (semaphore-count sem)))))
 481
 482 (with-test (:name (:try-semaphore :trivial-fail :n>1))
 483   (assert (eq (try-semaphore (make-semaphore :count 1) 2) 'nil)))
 484
 485 (with-test (:name (:try-semaphore :trivial-success :n>1))
 486   (let ((sem (make-semaphore :count 10)))
 487     (assert (try-semaphore sem 5))
 488     (assert (try-semaphore sem 5))
 489     (assert (zerop (semaphore-count sem)))))
 490
 491 (with-test (:name (:try-semaphore :emulate-wait-on-semaphore))
 492   (flet ((busy-wait-on-semaphore (sem)
 493            (loop until (try-semaphore sem) do (sleep 0.001))))
 494     (test-semaphore-multiple-signals #'busy-wait-on-semaphore)))
 495
 496 ;;; Here we test that interrupting TRY-SEMAPHORE does not leave a
 497 ;;; semaphore in a bad state.
 498 (with-test (:name (:try-semaphore :interrupt-safe))
 499   (flet ((make-threads (count fn)
 500            (loop repeat count collect (make-thread fn)))
 501          (kill-thread (thread)
 502            (when (thread-alive-p thread)
 503              (ignore-errors (terminate-thread thread))))
 504          (count-live-threads (threads)
 505            (count-if #'thread-alive-p threads)))
 506     ;; WAITERS will already be waiting on the semaphore while
 507     ;; threads-being-interrupted will perform TRY-SEMAPHORE on that
 508     ;; semaphore, and MORE-WAITERS are new threads trying to wait on
 509     ;; the semaphore during the interruption-fire.
 510     (let* ((sem (make-semaphore :count 100))
 511            (waiters (make-threads 20 #'(lambda ()
 512                                          (wait-on-semaphore sem))))
 513            (triers  (make-threads 40 #'(lambda ()
 514                                          (sleep (random 0.01))
 515                                          (try-semaphore sem (1+ (random 5))))))
 516            (more-waiters
 517             (loop repeat 10
 518                   do (kill-thread (nth (random 40) triers))
 519                   collect (make-thread #'(lambda () (wait-on-semaphore sem)))
 520                   do (kill-thread (nth (random 40) triers)))))
 521       (sleep 0.5)
 522       ;; Now ensure that the waiting threads will all be waked up,
 523       ;; i.e. that the semaphore is still working.
 524       (loop repeat (+ (count-live-threads waiters)
 525                       (count-live-threads more-waiters))
 526             do (signal-semaphore sem))
 527       (sleep 0.5)
 528       (assert (zerop (count-live-threads triers)))
 529       (assert (zerop (count-live-threads waiters)))
 530       (assert (zerop (count-live-threads more-waiters))))))
 531
 532
 533
 534 (format t "~&semaphore tests done~%")
 535
 536 (defun test-interrupt (function-to-interrupt &optional quit-p)
 537   (let ((child  (make-kill-thread function-to-interrupt)))
 538     ;;(format t "gdb ./src/runtime/sbcl ~A~%attach ~A~%" child child)
 539     (sleep 2)
 540     (format t "interrupting child ~A~%" child)
 541     (interrupt-thread child
 542                       (lambda ()
 543                         (format t "child pid ~A~%" *current-thread*)
 544                         (when quit-p (abort-thread))))
 545     (sleep 1)
 546     child))
 547
 548 ;; separate tests for (a) interrupting Lisp code, (b) C code, (c) a syscall,
 549 ;; (d) waiting on a lock, (e) some code which we hope is likely to be
 550 ;; in pseudo-atomic
 551
 552 (with-test (:name (:interrupt-thread :more-basics))
 553   (let ((child (test-interrupt (lambda () (loop)))))
 554     (terminate-thread child)))
 555
 556 (with-test (:name (:interrupt-thread :interrupt-foreign-loop)
 557                   ;; This feature is explicitly unsupported on Win32.
 558                   :skipped-on :win32)
 559   (test-interrupt #'loop-forever :quit))
 560
 561 (with-test (:name (:interrupt-thread :interrupt-sleep))
 562   (let ((child (test-interrupt (lambda () (loop (sleep 2000))))))
 563     (terminate-thread child)
 564     (wait-for-threads (list child))))
 565
 566 (with-test (:name (:interrupt-thread :interrupt-mutex-acquisition))
 567   (let ((lock (make-mutex :name "loctite"))
 568         child)
 569     (with-mutex (lock)
 570       (setf child (test-interrupt
 571                    (lambda ()
 572                      (with-mutex (lock)
 573                        (assert (eql (mutex-value lock) *current-thread*)))
 574                      (assert (not (eql (mutex-value lock) *current-thread*)))
 575                      (sleep 10))))
 576       ;;hold onto lock for long enough that child can't get it immediately
 577       (sleep 5)
 578       (interrupt-thread child (lambda () (format t "l ~A~%" (mutex-value lock))))
 579       (format t "parent releasing lock~%"))
 580     (terminate-thread child)
 581     (wait-for-threads (list child))))
 582
 583 (format t "~&locking test done~%")
 584
 585 (defun alloc-stuff () (copy-list '(1 2 3 4 5)))
 586
 587 (with-test (:name (:interrupt-thread :interrupt-consing-child))
 588   (let ((thread (make-thread (lambda () (loop (alloc-stuff))))))
 589     (let ((killers
 590            (loop repeat 4 collect
 591                  (sb-thread:make-thread
 592                   (lambda ()
 593                     (loop repeat 25 do
 594                           (sleep (random 0.1d0))
 595                           (princ ".")
 596                           (force-output)
 597                           (sb-thread:interrupt-thread thread (lambda ()))))))))
 598       (wait-for-threads killers)
 599       (sb-thread:terminate-thread thread)
 600       (wait-for-threads (list thread))))
 601   (sb-ext:gc :full t))
 602
 603 (format t "~&multi interrupt test done~%")
 604
 605 #+(or x86 x86-64) ;; x86oid-only, see internal commentary.
 606 (with-test (:name (:interrupt-thread :interrupt-consing-child :again))
 607   (let ((c (make-thread (lambda () (loop (alloc-stuff))))))
 608     ;; NB this only works on x86: other ports don't have a symbol for
 609     ;; pseudo-atomic atomicity
 610     (dotimes (i 100)
 611       (sleep (random 0.1d0))
 612       (interrupt-thread c
 613                         (lambda ()
 614                           (princ ".") (force-output)
 615                           (assert (thread-alive-p *current-thread*))
 616                           (assert
 617                            (not (logbitp 0 SB-KERNEL:*PSEUDO-ATOMIC-BITS*))))))
 618     (terminate-thread c)
 619     (wait-for-threads (list c))))
 620
 621 (format t "~&interrupt test done~%")
 622
 623 (defstruct counter (n 0 :type sb-vm:word))
 624 (defvar *interrupt-counter* (make-counter))
 625
 626 (declaim (notinline check-interrupt-count))
 627 (defun check-interrupt-count (i)
 628   (declare (optimize (debug 1) (speed 1)))
 629   ;; This used to lose if eflags were not restored after an interrupt.
 630   (unless (typep i 'fixnum)
 631     (error "!!!!!!!!!!!")))
 632
 633 (with-test (:name (:interrupt-thread :interrupt-ATOMIC-INCF))
 634   (let ((c (make-thread
 635             (lambda ()
 636               (handler-bind ((error #'(lambda (cond)
 637                                         (princ cond)
 638                                         (sb-debug:backtrace
 639                                          most-positive-fixnum))))
 640                 (loop (check-interrupt-count
 641                        (counter-n *interrupt-counter*))))))))
 642     (let ((func (lambda ()
 643                   (princ ".")
 644                   (force-output)
 645                   (sb-ext:atomic-incf (counter-n *interrupt-counter*)))))
 646       (setf (counter-n *interrupt-counter*) 0)
 647       (dotimes (i 100)
 648         (sleep (random 0.1d0))
 649         (interrupt-thread c func))
 650       (loop until (= (counter-n *interrupt-counter*) 100) do (sleep 0.1))
 651       (terminate-thread c)
 652       (wait-for-threads (list c)))))
 653
 654 (format t "~&interrupt count test done~%")
 655
 656 (defvar *runningp* nil)
 657
 658 (with-test (:name (:interrupt-thread :no-nesting))
 659   (let ((thread (sb-thread:make-thread
 660                  (lambda ()
 661                    (catch 'xxx
 662                      (loop))))))
 663     (declare (special runningp))
 664     (sleep 0.2)
 665     (sb-thread:interrupt-thread thread
 666                                 (lambda ()
 667                                     (let ((*runningp* t))
 668                                       (sleep 1))))
 669     (sleep 0.2)
 670     (sb-thread:interrupt-thread thread
 671                                 (lambda ()
 672                                   (throw 'xxx *runningp*)))
 673     (assert (not (sb-thread:join-thread thread)))))
 674
 675 (with-test (:name (:interrupt-thread :nesting))
 676   (let ((thread (sb-thread:make-thread
 677                  (lambda ()
 678                    (catch 'xxx
 679                      (loop))))))
 680     (declare (special runningp))
 681     (sleep 0.2)
 682     (sb-thread:interrupt-thread thread
 683                                 (lambda ()
 684                                   (let ((*runningp* t))
 685                                     (sb-sys:with-interrupts
 686                                       (sleep 1)))))
 687     (sleep 0.2)
 688     (sb-thread:interrupt-thread thread
 689                                 (lambda ()
 690                                   (throw 'xxx *runningp*)))
 691     (assert (sb-thread:join-thread thread))))
 692
 693 (with-test (:name (:two-threads-running-gc))
 694   (let (a-done b-done)
 695     (make-join-thread (lambda ()
 696                         (dotimes (i 100)
 697                           (sb-ext:gc) (princ "\\") (force-output))
 698                         (setf a-done t)))
 699     (make-join-thread (lambda ()
 700                         (dotimes (i 25)
 701                           (sb-ext:gc :full t)
 702                           (princ "/") (force-output))
 703                         (setf b-done t)))
 704     (loop
 705       (when (and a-done b-done) (return))
 706       (sleep 1))))
 707
 708 (terpri)
 709
 710 (defun waste (&optional (n 100000))
 711   (loop repeat n do (make-string 16384)))
 712
 713 (with-test (:name (:one-thread-runs-gc-while-other-conses))
 714   (loop for i below 100 do
 715         (princ "!")
 716         (force-output)
 717         (make-join-thread
 718          #'(lambda ()
 719              (waste)))
 720         (waste)
 721         (sb-ext:gc)))
 722
 723 (terpri)
 724
 725 (defparameter *aaa* nil)
 726 (with-test (:name (:one-thread-runs-gc-while-other-conses :again))
 727   (loop for i below 100 do
 728         (princ "!")
 729         (force-output)
 730         (make-join-thread
 731          #'(lambda ()
 732              (let ((*aaa* (waste)))
 733                (waste))))
 734         (let ((*aaa* (waste)))
 735           (waste))
 736         (sb-ext:gc)))
 737
 738 (format t "~&gc test done~%")
 739
 740 ;; this used to deadlock on session-lock
 741 (with-test (:name (:no-session-deadlock))
 742   (make-join-thread (lambda () (sb-ext:gc))))
 743
 744 (defun exercise-syscall (fn reference-errno)
 745   (make-kill-thread
 746    (lambda ()
 747      (loop do
 748           (funcall fn)
 749           (let ((errno (sb-unix::get-errno)))
 750             (sleep (random 0.1d0))
 751             (unless (eql errno reference-errno)
 752               (format t "Got errno: ~A (~A) instead of ~A~%"
 753                       errno
 754                       (sb-unix::strerror)
 755                       reference-errno)
 756               (force-output)
 757               (abort-thread)))))))
 758
 759 ;; (nanosleep -1 0) does not fail on FreeBSD
 760 (with-test (:name (:exercising-concurrent-syscalls) :fails-on :win32)
 761   (let* (#-freebsd
 762          (nanosleep-errno (progn
 763                             (sb-unix:nanosleep -1 0)
 764                             (sb-unix::get-errno)))
 765          (open-errno (progn
 766                        (open "no-such-file"
 767                              :if-does-not-exist nil)
 768                        (sb-unix::get-errno)))
 769          (threads
 770           (list
 771            #-freebsd
 772            (exercise-syscall (lambda () (sb-unix:nanosleep -1 0)) nanosleep-errno)
 773            (exercise-syscall (lambda () (open "no-such-file"
 774                                               :if-does-not-exist nil))
 775                              open-errno)
 776            (make-join-thread (lambda () (loop (sb-ext:gc) (sleep 1)))))))
 777     (sleep 10)
 778     (princ "terminating threads")
 779     (dolist (thread threads)
 780       (sb-thread:terminate-thread thread))))
 781
 782 (format t "~&errno test done~%")
 783
 784 (with-test (:name :all-threads-have-abort-restart)
 785   (loop repeat 100 do
 786         (let ((thread (make-kill-thread (lambda () (sleep 0.1)))))
 787           (sb-thread:interrupt-thread
 788            thread
 789            (lambda ()
 790              (assert (find-restart 'abort)))))))
 791
 792 (sb-ext:gc :full t)
 793
 794 (format t "~&thread startup sigmask test done~%")
 795
 796 (with-test (:name (:debugger-no-hang-on-session-lock-if-interrupted)
 797                   :fails-on :win32)
 798   #+win32 (error "user would have to touch a key interactively to proceed")
 799   (sb-debug::enable-debugger)
 800   (let* ((main-thread *current-thread*)
 801          (interruptor-thread
 802           (make-thread (lambda ()
 803                          (sleep 2)
 804                          (interrupt-thread main-thread
 805                                            (lambda ()
 806                                              (with-interrupts
 807                                                (break))))
 808                          (sleep 2)
 809                          (interrupt-thread main-thread #'continue))
 810                        :name "interruptor")))
 811     (with-session-lock (*session*)
 812       (sleep 3))
 813     (loop while (thread-alive-p interruptor-thread))))
 814
 815 (format t "~&session lock test done~%")
 816
 817 ;; expose thread creation races by exiting quickly
 818 (with-test (:name (:no-thread-creation-race :light))
 819   (make-join-thread (lambda ())))
 820
 821 (with-test (:name (:no-thread-creation-race :heavy))
 822   (loop repeat 20 do
 823         (wait-for-threads
 824          (loop for i below 100 collect
 825                (sb-thread:make-thread (lambda ()))))))
 826
 827 (format t "~&creation test done~%")
 828
 829 ;; interrupt handlers are per-thread with pthreads, make sure the
 830 ;; handler installed in one thread is global
 831 (with-test (:name (:global-interrupt-handler))
 832   (make-join-thread
 833    (lambda ()
 834      (sb-ext:run-program "sleep" '("1") :search t :wait nil))))
 835
 836 ;;;; Binding stack safety
 837
 838 (defparameter *x* nil)
 839 (defparameter *n-gcs-requested* 0)
 840 (defparameter *n-gcs-done* 0)
 841
 842 (let ((counter 0))
 843   (defun make-something-big ()
 844     (let ((x (make-string 32000)))
 845       (incf counter)
 846       (let ((counter counter))
 847         (sb-ext:finalize x (lambda () (format t " ~S" counter)
 848                                    (force-output)))))))
 849
 850 (defmacro wait-for-gc ()
 851   `(progn
 852      (incf *n-gcs-requested*)
 853      (loop while (< *n-gcs-done* *n-gcs-requested*))))
 854
 855 (defun send-gc ()
 856   (loop until (< *n-gcs-done* *n-gcs-requested*))
 857   (format t "G")
 858   (force-output)
 859   (sb-ext:gc)
 860   (incf *n-gcs-done*))
 861
 862 #+(or x86 x86-64) ;the only platforms with a *binding-stack-pointer* variable
 863 (defun exercise-binding ()
 864   (loop
 865    (let ((*x* (make-something-big)))
 866      (let ((*x* 42))
 867        ;; at this point the binding stack looks like this:
 868        ;; NO-TLS-VALUE-MARKER, *x*, SOMETHING, *x*
 869        t))
 870    (wait-for-gc)
 871    ;; sig_stop_for_gc_handler binds FREE_INTERRUPT_CONTEXT_INDEX. By
 872    ;; now SOMETHING is gc'ed and the binding stack looks like this: 0,
 873    ;; 0, SOMETHING, 0 (because the symbol slots are zeroed on
 874    ;; unbinding but values are not).
 875    (let ((*x* nil)
 876          (binding-pointer-delta (ash 2 (- sb-vm:word-shift sb-vm:n-fixnum-tag-bits))))
 877      ;; bump bsp as if a BIND had just started
 878      (incf sb-vm::*binding-stack-pointer* binding-pointer-delta)
 879      (wait-for-gc)
 880      (decf sb-vm::*binding-stack-pointer* binding-pointer-delta))))
 881
 882 #+(or x86 x86-64) ;the only platforms with a *binding-stack-pointer* variable
 883 (with-test (:name (:binding-stack-gc-safety))
 884   (let (threads)
 885     (unwind-protect
 886          (progn
 887            (push (make-kill-thread #'exercise-binding) threads)
 888            (push (make-kill-thread (lambda ()
 889                                      (loop
 890                                       (sleep 0.1)
 891                                       (send-gc))))
 892                  threads)
 893            (sleep 4))
 894       (mapc #'sb-thread:terminate-thread threads))))
 895
 896 (with-test (:name :test-%thread-local-references)
 897   (let ((mysym (gensym))
 898         (fool1 (cons 1 2))
 899         (fool2 (cons 2 3)))
 900     (progv (list mysym) '(nil)
 901       (let* ((i (get-lisp-obj-address (sb-vm:symbol-tls-index mysym)))
 902              (j (+ i sb-vm:n-word-bytes)))
 903         (assert (eql (sap-ref-word (current-thread-sap) j)
 904                      sb-vm:no-tls-value-marker-widetag))
 905         (setf (sap-ref-lispobj (current-thread-sap) i) fool1
 906               (sap-ref-lispobj (current-thread-sap) j) fool2)
 907         ;; assert that my pointer arithmetic worked as expected
 908         (assert (eq (symbol-value mysym) fool1))
 909         ;; assert that FOOL1 is found by the TLS scan and that FOOL2 is not.
 910         (let ((list (%thread-local-references)))
 911           (assert (memq fool1 list))
 912           (assert (not (memq fool2 list))))
 913         ;; repair the TLS entry that was corrupted by the test
 914         (setf (sap-ref-word (current-thread-sap) j)
 915               sb-vm:no-tls-value-marker-widetag)))))
 916
 917 (format t "~&binding test done~%")
 918
 919 ;;; HASH TABLES
 920
 921 (defvar *errors* nil)
 922
 923 (defun oops (e)
 924   (setf *errors* e)
 925   (format t "~&oops: ~A in ~S~%" e *current-thread*)
 926   (sb-debug:backtrace)
 927   (catch 'done))
 928
 929 (with-test (:name (:unsynchronized-hash-table)
 930                   ;; FIXME: This test occasionally eats out craploads
 931                   ;; of heap instead of expected error early. Not 100%
 932                   ;; sure if it would finish as expected, but since it
 933                   ;; hits swap on my system I'm not likely to find out
 934                   ;; soon. Disabling for now. -- nikodemus
 935             :skipped-on :sbcl)
 936   ;; We expect a (probable) error here: parellel readers and writers
 937   ;; on a hash-table are not expected to work -- but we also don't
 938   ;; expect this to corrupt the image.
 939   (let* ((hash (make-hash-table))
 940          (*errors* nil)
 941          (threads (list (make-kill-thread
 942                          (lambda ()
 943                            (catch 'done
 944                              (handler-bind ((serious-condition 'oops))
 945                                (loop
 946                                  ;;(princ "1") (force-output)
 947                                  (setf (gethash (random 100) hash) 'h)))))
 948                          :name "writer")
 949                         (make-kill-thread
 950                          (lambda ()
 951                            (catch 'done
 952                              (handler-bind ((serious-condition 'oops))
 953                                (loop
 954                                  ;;(princ "2") (force-output)
 955                                  (remhash (random 100) hash)))))
 956                          :name "reader")
 957                         (make-kill-thread
 958                          (lambda ()
 959                            (catch 'done
 960                              (handler-bind ((serious-condition 'oops))
 961                                (loop
 962                                  (sleep (random 1.0))
 963                                  (sb-ext:gc :full t)))))
 964                          :name "collector"))))
 965     (unwind-protect
 966          (sleep 10)
 967       (mapc #'sb-thread:terminate-thread threads))))
 968
 969 (format t "~&unsynchronized hash table test done~%")
 970
 971 (with-test (:name (:synchronized-hash-table))
 972   (let* ((hash (make-hash-table :synchronized t))
 973          (*errors* nil)
 974          (threads (list (make-join-thread
 975                          (lambda ()
 976                            (catch 'done
 977                              (handler-bind ((serious-condition 'oops))
 978                                (loop
 979                                  ;;(princ "1") (force-output)
 980                                  (setf (gethash (random 100) hash) 'h)))))
 981                          :name "writer")
 982                         (make-join-thread
 983                          (lambda ()
 984                            (catch 'done
 985                              (handler-bind ((serious-condition 'oops))
 986                                (loop
 987                                  ;;(princ "2") (force-output)
 988                                  (remhash (random 100) hash)))))
 989                          :name "reader")
 990                         (make-join-thread
 991                          (lambda ()
 992                            (catch 'done
 993                              (handler-bind ((serious-condition 'oops))
 994                                (loop
 995                                  (sleep (random 1.0))
 996                                  (sb-ext:gc :full t)))))
 997                          :name "collector"))))
 998     (unwind-protect
 999          (sleep 10)
1000       (mapc #'sb-thread:terminate-thread threads))
1001     (assert (not *errors*))))
1002
1003 (format t "~&synchronized hash table test done~%")
1004
1005 (with-test (:name (:hash-table-parallel-readers))
1006   (let ((hash (make-hash-table))
1007         (*errors* nil))
1008     (loop repeat 50
1009           do (setf (gethash (random 100) hash) 'xxx))
1010     (let ((threads (list (make-kill-thread
1011                           (lambda ()
1012                             (catch 'done
1013                               (handler-bind ((serious-condition 'oops))
1014                                 (loop
1015                                       until (eq t (gethash (random 100) hash))))))
1016                           :name "reader 1")
1017                          (make-kill-thread
1018                           (lambda ()
1019                             (catch 'done
1020                               (handler-bind ((serious-condition 'oops))
1021                                 (loop
1022                                       until (eq t (gethash (random 100) hash))))))
1023                           :name "reader 2")
1024                          (make-kill-thread
1025                           (lambda ()
1026                             (catch 'done
1027                               (handler-bind ((serious-condition 'oops))
1028                                 (loop
1029                                       until (eq t (gethash (random 100) hash))))))
1030                           :name "reader 3")
1031                          (make-kill-thread
1032                           (lambda ()
1033                             (catch 'done
1034                               (handler-bind ((serious-condition 'oops))
1035                                (loop
1036                                  (sleep (random 1.0))
1037                                  (sb-ext:gc :full t)))))
1038                           :name "collector"))))
1039       (unwind-protect
1040            (sleep 10)
1041         (mapc #'sb-thread:terminate-thread threads))
1042       (assert (not *errors*)))))
1043
1044 (format t "~&multiple reader hash table test done~%")
1045
1046 (with-test (:name (:hash-table-single-accessor-parallel-gc))
1047   (let ((hash (make-hash-table))
1048         (*errors* nil))
1049     (let ((threads (list (make-kill-thread
1050                           (lambda ()
1051                             (handler-bind ((serious-condition 'oops))
1052                               (loop
1053                                 (let ((n (random 100)))
1054                                   (if (gethash n hash)
1055                                       (remhash n hash)
1056                                       (setf (gethash n hash) 'h))))))
1057                           :name "accessor")
1058                          (make-kill-thread
1059                           (lambda ()
1060                             (handler-bind ((serious-condition 'oops))
1061                               (loop
1062                                 (sleep (random 1.0))
1063                                 (sb-ext:gc :full t))))
1064                           :name "collector"))))
1065       (unwind-protect
1066            (sleep 10)
1067         (mapc #'sb-thread:terminate-thread threads))
1068       (assert (not *errors*)))))
1069
1070 (format t "~&single accessor hash table test~%")
1071
1072 #|  ;; a cll post from eric marsden
1073 | (defun crash ()
1074 |   (setq *debugger-hook*
1075 |         (lambda (condition old-debugger-hook)
1076 |           (debug:backtrace 10)
1077 |           (unix:unix-exit 2)))
1078 |   #+live-dangerously
1079 |   (mp::start-sigalrm-yield)
1080 |   (flet ((roomy () (loop (with-output-to-string (*standard-output*) (room)))))
1081 |     (mp:make-process #'roomy)
1082 |     (mp:make-process #'roomy)))
1083 |#
1084
1085 (with-test (:name (:condition-variable :notify-multiple))
1086   (flet ((tester (notify-fun)
1087            (let ((queue (make-waitqueue :name "queue"))
1088                  (lock (make-mutex :name "lock"))
1089                  (data nil))
1090              (labels ((test (x)
1091                         (loop
1092                            (with-mutex (lock)
1093                              (format t "condition-wait ~a~%" x)
1094                              (force-output)
1095                              (condition-wait queue lock)
1096                              (format t "woke up ~a~%" x)
1097                              (force-output)
1098                              (push x data)))))
1099                (let ((threads (loop for x from 1 to 10
1100                                     collect
1101                                     (let ((x x))
1102                                       (make-kill-thread (lambda ()
1103                                                           (test x)))))))
1104                  (sleep 5)
1105                  (with-mutex (lock)
1106                    (funcall notify-fun queue))
1107                  (sleep 5)
1108                  (mapcar #'terminate-thread threads)
1109                  ;; Check that all threads woke up at least once
1110                  (assert (= (length (remove-duplicates data)) 10)))))))
1111     (tester (lambda (queue)
1112               (format t "~&(condition-notify queue 10)~%")
1113               (force-output)
1114               (condition-notify queue 10)))
1115     (tester (lambda (queue)
1116               (format t "~&(condition-broadcast queue)~%")
1117               (force-output)
1118               (condition-broadcast queue)))))
1119
1120 (format t "waitqueue wakeup tests done~%")
1121
1122 ;;; Make sure that a deadline handler is not invoked twice in a row in
1123 ;;; CONDITION-WAIT. See LP #512914 for a detailed explanation.
1124 ;;;
1125 (with-test (:name (:condition-wait :deadlines :LP-512914))
1126   (let ((n 2)                      ; was empirically enough to trigger the bug
1127         (mutex (sb-thread:make-mutex))
1128         (waitq (sb-thread:make-waitqueue))
1129         (threads nil)
1130         (deadline-handler-run-twice? nil))
1131     (dotimes (i n)
1132       (let ((child
1133               (sb-thread:make-thread
1134                #'(lambda ()
1135                    (handler-bind
1136                        ((sb-sys:deadline-timeout
1137                           (let ((already? nil))
1138                             #'(lambda (c)
1139                                 (when already?
1140                                   (setq deadline-handler-run-twice? t))
1141                                 (setq already? t)
1142                                 (sleep 0.2)
1143                                 (sb-thread:condition-broadcast waitq)
1144                                 (sb-sys:defer-deadline 10.0 c)))))
1145                      (sb-sys:with-deadline (:seconds 0.1)
1146                        (sb-thread:with-mutex (mutex)
1147                          (sb-thread:condition-wait waitq mutex))))))))
1148         (push child threads)))
1149     (mapc #'sb-thread:join-thread threads)
1150     (assert (not deadline-handler-run-twice?))))
1151
1152 (with-test (:name (:condition-wait :signal-deadline-with-interrupts-enabled))
1153   (let ((mutex (sb-thread:make-mutex))
1154         (waitq (sb-thread:make-waitqueue))
1155         (A-holds? :unknown)
1156         (B-holds? :unknown)
1157         (A-interrupts-enabled? :unknown)
1158         (B-interrupts-enabled? :unknown)
1159         (A)
1160         (B))
1161     ;; W.L.O.G., we assume that A is executed first...
1162     (setq A (sb-thread:make-thread
1163              #'(lambda ()
1164                  (handler-bind
1165                      ((sb-sys:deadline-timeout
1166                        #'(lambda (c)
1167                            ;; We came here through the call to DECODE-TIMEOUT
1168                            ;; in CONDITION-WAIT; hence both here are supposed
1169                            ;; to evaluate to T.
1170                            (setq A-holds? (sb-thread:holding-mutex-p mutex))
1171                            (setq A-interrupts-enabled?
1172                                  sb-sys:*interrupts-enabled*)
1173                            (sleep 0.2)
1174                            (sb-thread:condition-broadcast waitq)
1175                            (sb-sys:defer-deadline 10.0 c))))
1176                    (sb-sys:with-deadline (:seconds 0.1)
1177                      (sb-thread:with-mutex (mutex)
1178                        (sb-thread:condition-wait waitq mutex)))))
1179              :name "A"))
1180     (setq B (sb-thread:make-thread
1181              #'(lambda ()
1182                  (thread-yield)
1183                  (handler-bind
1184                      ((sb-sys:deadline-timeout
1185                        #'(lambda (c)
1186                            ;; We came here through the call to DECODE-TIMEOUT
1187                            ;; in CONDITION-WAIT (contended case of
1188                            ;; reaquiring the mutex) - so the former will
1189                            ;; be NIL, but interrupts should still be enabled.
1190                            (setq B-holds? (sb-thread:holding-mutex-p mutex))
1191                            (setq B-interrupts-enabled?
1192                                  sb-sys:*interrupts-enabled*)
1193                            (sleep 0.2)
1194                            (sb-thread:condition-broadcast waitq)
1195                            (sb-sys:defer-deadline 10.0 c))))
1196                    (sb-sys:with-deadline (:seconds 0.1)
1197                      (sb-thread:with-mutex (mutex)
1198                        (sb-thread:condition-wait waitq mutex)))))
1199              :name "B"))
1200     (sb-thread:join-thread A)
1201     (sb-thread:join-thread B)
1202     (let ((A-result (list A-holds? A-interrupts-enabled?))
1203           (B-result (list B-holds? B-interrupts-enabled?)))
1204       ;; We also check some subtle behaviour w.r.t. whether a deadline
1205       ;; handler in CONDITION-WAIT got the mutex, or not. This is most
1206       ;; probably very internal behaviour (so user should not depend
1207       ;; on it) -- I added the testing here just to manifest current
1208       ;; behaviour.
1209       (cond ((equal A-result '(t t)) (assert (equal B-result '(nil t))))
1210             ((equal B-result '(t t)) (assert (equal A-result '(nil t))))
1211             (t
1212              (error "Failure: fell through wit A: ~S, B: ~S"
1213                     A-result
1214                     B-result))))))
1215
1216 (with-test (:name (:mutex :finalization))
1217   (let ((a nil))
1218     (dotimes (i 500000)
1219       (setf a (make-mutex)))))
1220
1221 (format t "mutex finalization test done~%")
1222
1223 (with-test (:name :backtrace)
1224   ;; Printing backtraces from several threads at once used to hang the
1225   ;; whole SBCL process (discovered by accident due to a timer.impure
1226   ;; test misbehaving). The cause was that packages weren't even
1227   ;; thread-safe for only doing FIND-SYMBOL, and while printing
1228   ;; backtraces a loot of symbol lookups need to be done due to
1229   ;; *PRINT-ESCAPE*.
1230   (let* ((threads (loop repeat 10
1231                         collect (sb-thread:make-thread
1232                                  (lambda ()
1233                                    (dotimes (i 1000)
1234                                      (with-output-to-string (*debug-io*)
1235                                        (sb-debug::backtrace 10))))))))
1236     (wait-for-threads threads)))
1237
1238 (format t "backtrace test done~%")
1239
1240 (format t "~&starting gc deadlock test: WARNING: THIS TEST WILL HANG ON FAILURE!~%")
1241
1242 (with-test (:name :gc-deadlock)
1243   ;; Prior to 0.9.16.46 thread exit potentially deadlocked the
1244   ;; GC due to *all-threads-lock* and session lock. On earlier
1245   ;; versions and at least on one specific box this test is good enough
1246   ;; to catch that typically well before the 1500th iteration.
1247   (loop
1248      with i = 0
1249      with n = 3000
1250      while (< i n)
1251      do
1252        (incf i)
1253        (when (zerop (mod i 100))
1254          (write-char #\.)
1255          (force-output))
1256        (handler-case
1257            (if (oddp i)
1258                (make-join-thread
1259                 (lambda ()
1260                   (sleep (random 0.001)))
1261                 :name (format nil "SLEEP-~D" i))
1262                (make-join-thread
1263                 (lambda ()
1264                   ;; KLUDGE: what we are doing here is explicit,
1265                   ;; but the same can happen because of a regular
1266                   ;; MAKE-THREAD or LIST-ALL-THREADS, and various
1267                   ;; session functions.
1268                   (sb-thread::with-all-threads-lock
1269                     (sb-thread::with-session-lock (sb-thread::*session*)
1270                       (sb-ext:gc))))
1271                 :name (format nil "GC-~D" i)))
1272          (error (e)
1273            (format t "~%error creating thread ~D: ~A -- backing off for retry~%" i e)
1274            (sleep 0.1)
1275            (incf i)))))
1276
1277 (format t "~&gc deadlock test done~%")
1278 \f
1279 (let ((count (make-array 8 :initial-element 0)))
1280   (defun closure-one ()
1281     (declare (optimize safety))
1282     (values (incf (aref count 0)) (incf (aref count 1))
1283             (incf (aref count 2)) (incf (aref count 3))
1284             (incf (aref count 4)) (incf (aref count 5))
1285             (incf (aref count 6)) (incf (aref count 7))))
1286   (defun no-optimizing-away-closure-one ()
1287     (setf count (make-array 8 :initial-element 0))))
1288
1289 (defstruct box
1290   (count 0))
1291
1292 (let ((one (make-box))
1293       (two (make-box))
1294       (three (make-box)))
1295   (defun closure-two ()
1296     (declare (optimize safety))
1297     (values (incf (box-count one)) (incf (box-count two)) (incf (box-count three))))
1298   (defun no-optimizing-away-closure-two ()
1299     (setf one (make-box)
1300           two (make-box)
1301           three (make-box))))
1302
1303 ;;; PowerPC safepoint builds occasionally hang or busy-loop (or
1304 ;;; sometimes run out of memory) in the following test.  For developers
1305 ;;; interested in debugging this combination of features, it might be
1306 ;;; fruitful to concentrate their efforts around this test...
1307
1308 (with-test (:name (:funcallable-instances)
1309                   :skipped-on '(and :sb-safepoint
1310                                     (not :c-stack-is-control-stack)))
1311   ;; the funcallable-instance implementation used not to be threadsafe
1312   ;; against setting the funcallable-instance function to a closure
1313   ;; (because the code and lexenv were set separately).
1314   (let ((fun (sb-kernel:%make-funcallable-instance 0))
1315         (condition nil))
1316     (setf (sb-kernel:funcallable-instance-fun fun) #'closure-one)
1317     (flet ((changer ()
1318              (loop (setf (sb-kernel:funcallable-instance-fun fun) #'closure-one)
1319                    (setf (sb-kernel:funcallable-instance-fun fun) #'closure-two)))
1320            (test ()
1321              (handler-case (loop (funcall fun))
1322                (serious-condition (c) (setf condition c)))))
1323       (let ((changer (make-thread #'changer))
1324             (test (make-thread #'test)))
1325         (handler-case
1326             (progn
1327               ;; The two closures above are fairly carefully crafted
1328               ;; so that if given the wrong lexenv they will tend to
1329               ;; do some serious damage, but it is of course difficult
1330               ;; to predict where the various bits and pieces will be
1331               ;; allocated.  Five seconds failed fairly reliably on
1332               ;; both my x86 and x86-64 systems.  -- CSR, 2006-09-27.
1333               (sb-ext:with-timeout 5
1334                 (wait-for-threads (list test)))
1335               (error "~@<test thread got condition:~2I~_~A~@:>" condition))
1336           (sb-ext:timeout ()
1337             (terminate-thread changer)
1338             (terminate-thread test)
1339             (wait-for-threads (list changer test))))))))
1340
1341 (format t "~&funcallable-instance test done~%")
1342
1343 (defun random-type (n)
1344   `(integer ,(random n) ,(+ n (random n))))
1345
1346 (defun subtypep-hash-cache-test ()
1347   (dotimes (i 10000)
1348     (let ((type1 (random-type 500))
1349           (type2 (random-type 500)))
1350       (let ((a (subtypep type1 type2)))
1351         (dotimes (i 100)
1352           (assert (eq (subtypep type1 type2) a))))))
1353   (format t "ok~%")
1354   (force-output))
1355
1356 (with-test (:name (:hash-cache :subtypep))
1357   (mapc #'join-thread
1358         (loop repeat 10
1359               collect (sb-thread:make-thread #'subtypep-hash-cache-test))))
1360 (format t "hash-cache tests done~%")
1361
1362 ;;;; BLACK BOX TESTS
1363
1364 (in-package :cl-user)
1365 (use-package :test-util)
1366 (use-package "ASSERTOID")
1367
1368 (format t "parallel defclass test -- WARNING, WILL HANG ON FAILURE!~%")
1369 (with-test (:name :parallel-defclass)
1370   (defclass test-1 () ((a :initform :orig-a)))
1371   (defclass test-2 () ((b :initform :orig-b)))
1372   (defclass test-3 (test-1 test-2) ((c :initform :orig-c)))
1373   ;; This test is more likely to pass on Windows with the FORCE-OUTPUT
1374   ;; calls disabled in the folloving code.  (As seen on a Server 2012
1375   ;; installation.)  Clearly, this sort of workaround in a test is
1376   ;; cheating, and might be hiding the underlying bug that the test is
1377   ;; exposing.  Let's review this later.
1378   (let* ((run t)
1379          (d1 (sb-thread:make-thread (lambda ()
1380                                       (loop while run
1381                                             do (defclass test-1 () ((a :initform :new-a)))
1382                                             (write-char #\1)
1383                                             #-win32 (force-output)))
1384                                     :name "d1"))
1385          (d2 (sb-thread:make-thread (lambda ()
1386                                       (loop while run
1387                                             do (defclass test-2 () ((b :initform :new-b)))
1388                                                (write-char #\2)
1389                                                #-win32 (force-output)))
1390                                     :name "d2"))
1391          (d3 (sb-thread:make-thread (lambda ()
1392                                       (loop while run
1393                                             do (defclass test-3 (test-1 test-2) ((c :initform :new-c)))
1394                                                (write-char #\3)
1395                                                #-win32 (force-output)))
1396                                     :name "d3"))
1397          (i (sb-thread:make-thread (lambda ()
1398                                      (loop while run
1399                                            do (let ((i (make-instance 'test-3)))
1400                                                 (assert (member (slot-value i 'a) '(:orig-a :new-a)))
1401                                                 (assert (member (slot-value i 'b) '(:orig-b :new-b)))
1402                                                 (assert (member (slot-value i 'c) '(:orig-c :new-c))))
1403                                               (write-char #\i)
1404                                               #-win32 (force-output)))
1405                                    :name "i")))
1406     (format t "~%sleeping!~%")
1407     (sleep 2.0)
1408     (format t "~%stopping!~%")
1409     (setf run nil)
1410     (mapc (lambda (th)
1411             (sb-thread:join-thread th)
1412             (format t "~%joined ~S~%" (sb-thread:thread-name th)))
1413           (list d1 d2 d3 i))
1414     (force-output)))
1415 (format t "parallel defclass test done~%")
1416
1417 (with-test (:name (:deadlock-detection :interrupts) :fails-on :win32)
1418   #+win32                               ;be more explicit than just :skipped-on
1419   (error "not attempting, because of deadlock error in background thread")
1420   (let* ((m1 (sb-thread:make-mutex :name "M1"))
1421          (m2 (sb-thread:make-mutex :name "M2"))
1422          (t1-can-go (sb-thread:make-semaphore :name "T1 can go"))
1423          (t2-can-go (sb-thread:make-semaphore :name "T2 can go"))
1424          (t1 (sb-thread:make-thread
1425               (lambda ()
1426                 (sb-thread:with-mutex (m1)
1427                   (sb-thread:wait-on-semaphore t1-can-go)
1428                   :ok1))
1429               :name "T1"))
1430          (t2 (sb-thread:make-thread
1431               (lambda ()
1432                 (sb-ext:wait-for (eq t1 (sb-thread:mutex-owner m1)))
1433                 (sb-thread:with-mutex (m1 :wait-p t)
1434                   (sb-thread:wait-on-semaphore t2-can-go)
1435                   :ok2))
1436               :name "T2")))
1437     (sb-ext:wait-for (eq m1 (sb-thread::thread-waiting-for t2)))
1438     (sb-thread:interrupt-thread t2 (lambda ()
1439                                      (sb-thread:with-mutex (m2 :wait-p t)
1440                                        (sb-ext:wait-for
1441                                         (eq m2 (sb-thread::thread-waiting-for t1)))
1442                                        (sb-thread:signal-semaphore t2-can-go))))
1443     (sb-ext:wait-for (eq t2 (sb-thread:mutex-owner m2)))
1444     (sb-thread:interrupt-thread t1 (lambda ()
1445                                      (sb-thread:with-mutex (m2 :wait-p t)
1446                                        (sb-thread:signal-semaphore t1-can-go))))
1447     ;; both threads should finish without a deadlock or deadlock
1448     ;; detection error
1449     (let ((res (list (sb-thread:join-thread t1)
1450                      (sb-thread:join-thread t2))))
1451       (assert (equal '(:ok1 :ok2) res)))))
1452
1453 (with-test (:name (:deadlock-detection :gc))
1454   ;; To semi-reliably trigger the error (in SBCL's where)
1455   ;; it was present you had to run this for > 30 seconds,
1456   ;; but that's a bit long for a single test.
1457   (let* ((stop (+ 5 (get-universal-time)))
1458          (m1 (sb-thread:make-mutex :name "m1"))
1459          (t1 (sb-thread:make-thread
1460               (lambda ()
1461                 (loop until (> (get-universal-time) stop)
1462                       do (sb-thread:with-mutex (m1)
1463                            (eval `(make-array 24))))
1464                 :ok)))
1465          (t2 (sb-thread:make-thread
1466               (lambda ()
1467                 (loop until (> (get-universal-time) stop)
1468                       do (sb-thread:with-mutex (m1)
1469                            (eval `(make-array 24))))
1470                 :ok))))
1471     (let ((res (list (sb-thread:join-thread t1)
1472                      (sb-thread:join-thread t2))))
1473       (assert (equal '(:ok :ok) res)))))
1474
1475 (with-test (:name :spinlock-api)
1476   (let* ((warned 0)
1477          (funs
1478            (handler-bind ((sb-int:early-deprecation-warning (lambda (_)
1479                                                               (declare (ignore _))
1480                                                               (incf warned))))
1481              (list (compile nil `(lambda (lock)
1482                                    (sb-thread::with-spinlock (lock)
1483                                      t)))
1484                    (compile nil `(lambda ()
1485                                    (sb-thread::make-spinlock :name "foo")))
1486                    (compile nil `(lambda (lock)
1487                                    (sb-thread::get-spinlock lock)))
1488                    (compile nil `(lambda (lock)
1489                                    (sb-thread::release-spinlock lock)))))))
1490     (assert (eql 4 warned))
1491     (handler-bind ((warning #'error))
1492       (destructuring-bind (with make get release) funs
1493         (let ((lock (funcall make)))
1494           (funcall get lock)
1495           (funcall release lock)
1496           (assert (eq t (funcall with lock))))))))
1497
1498 (with-test (:name :interrupt-io-unnamed-pipe)
1499   (let (result)
1500     (labels
1501         ((reader (fd)
1502            (let ((stream (sb-sys:make-fd-stream fd
1503                                                 :element-type :default
1504                                                 :serve-events nil)))
1505              (time
1506               (let ((ok (handler-case
1507                             (catch 'stop
1508                               (progn
1509                                 (read-char stream)
1510                                 (sleep 0.1)
1511                                 (sleep 0.1)
1512                                 (sleep 0.1)))
1513                           (error (c)
1514                             c))))
1515                 (setf result ok)
1516                 (progn
1517                   (format *trace-output* "~&=> ~A~%" ok)
1518                   (force-output *trace-output*))))
1519              (sleep 2)
1520              (ignore-errors (close stream))))
1521
1522          (writer ()
1523            (multiple-value-bind (read write)
1524                (sb-unix:unix-pipe)
1525              (let* ((reader (sb-thread:make-thread (lambda () (reader read))))
1526                     (stream (sb-sys:make-fd-stream write
1527                                                    :output t
1528                                                    :element-type :default
1529                                                    :serve-events nil))
1530                     (ok :ok))
1531                (sleep 1)
1532                (sb-thread:interrupt-thread reader (lambda ()
1533                                                     (print :throwing)
1534                                                     (force-output)
1535                                                     (throw 'stop ok)))
1536                (sleep 1)
1537                (setf ok :not-ok)
1538                (write-char #\x stream)
1539                (close stream)
1540                (sb-thread:join-thread reader)))))
1541       (writer))
1542     (assert (eq result :ok))))
1543
1544 (with-test (:name :thread-alloca)
1545   (sb-ext:run-program "sh"
1546                       '("run-compiler.sh" "-sbcl-pic" "-sbcl-shared"
1547                         "alloca.c" "-o" "alloca.so")
1548                       :search t)
1549   (load-shared-object (truename "alloca.so"))
1550
1551   (alien-funcall (extern-alien "alloca_test" (function void)))
1552   (sb-thread:join-thread
1553    (sb-thread:make-thread
1554     (lambda ()
1555       (alien-funcall (extern-alien "alloca_test" (function void)))))))
1556
1557 (with-test (:name :fp-mode-inheritance-threads)
1558   (flet ((test ()
1559            (let ((thread-fp-mode)
1560                  (fp-mode (dpb 0 sb-vm::float-sticky-bits (sb-vm:floating-point-modes))))
1561              (sb-thread:join-thread
1562               (sb-thread:make-thread
1563                (lambda ()
1564                  (setf thread-fp-mode
1565                        (dpb 0 sb-vm::float-sticky-bits (sb-vm:floating-point-modes))))))
1566              (assert (= fp-mode thread-fp-mode)))))
1567     (test)
1568     (sb-int:with-float-traps-masked (:divide-by-zero)
1569       (test))
1570     (setf (sb-vm:floating-point-modes)
1571           (dpb sb-vm:float-divide-by-zero-trap-bit
1572                sb-vm::float-traps-byte
1573                (sb-vm:floating-point-modes)))
1574     (test)))