1.0.48.10: add deadlock detection to spinlocks and mutexes
[sbcl.git] / tests / threads.pure.lisp
index fbffaaa..6fcd67a 100644 (file)
                (values
                 (loop for r from 0 below n
                       collect
-                      (let ((r r))
-                        (sb-thread:make-thread (lambda ()
-                                                 (let ((sem semaphore))
-                                                   (dotimes (s i)
-                                                     (sb-thread:wait-on-semaphore sem))))
-                                               :name "reader")))
+                      (sb-thread:make-thread
+                       (lambda ()
+                         (let ((sem semaphore))
+                           (dotimes (s i)
+                             (sb-thread:wait-on-semaphore sem))))
+                       :name "reader"))
                 (* n i)))
              (make-writers (n readers i)
                (let ((j (* readers i)))
                     (let ((writers
                            (loop for w from 0 below n
                                  collect
-                                 (let ((w w))
-                                   (sb-thread:make-thread (lambda ()
-                                                            (let ((sem semaphore))
-                                                              (dotimes (s k)
-                                                                (sb-thread:signal-semaphore sem))))
-                                                          :name "writer")))))
+                                 (sb-thread:make-thread
+                                  (lambda ()
+                                    (let ((sem semaphore))
+                                      (dotimes (s k)
+                                        (sb-thread:signal-semaphore sem))))
+                                  :name "writer"))))
                       (assert (zerop rem))
                       writers)
                     (+ rem (* n k))))))
              (sb-ext:timeout ()
                :timeout)))))))
 
+;;;; Printing waitqueues
+
+#+sb-thread
+(with-test (:name :waitqueue-circle-print)
+  (let* ((*print-circle* nil)
+         (lock (sb-thread:make-mutex))
+         (wq (sb-thread:make-waitqueue)))
+    (sb-thread:with-recursive-lock (lock)
+      (sb-thread:condition-notify wq))
+    ;; Used to blow stack due to recursive structure.
+    (assert (princ-to-string wq))))
+
+;;;; SYMBOL-VALUE-IN-THREAD
+
+(with-test (:name symbol-value-in-thread.1)
+  (let ((* (cons t t)))
+    (assert (eq * (symbol-value-in-thread '* *current-thread*)))
+    (setf (symbol-value-in-thread '* *current-thread*) 123)
+    (assert (= 123 (symbol-value-in-thread '* *current-thread*)))
+    (assert (= 123 *))))
+
+#+sb-thread
+(with-test (:name symbol-value-in-thread.2)
+  (let* ((parent *current-thread*)
+         (semaphore (make-semaphore))
+         (child (make-thread (lambda ()
+                               (wait-on-semaphore semaphore)
+                               (let ((old (symbol-value-in-thread 'this-is-new parent)))
+                                 (setf (symbol-value-in-thread 'this-is-new parent) :from-child)
+                                 old)))))
+    (progv '(this-is-new) '(42)
+      (signal-semaphore semaphore)
+      (assert (= 42 (join-thread child)))
+      (assert (eq :from-child (symbol-value 'this-is-new))))))
+
+;;; Disabled on Darwin due to deadlocks caused by apparent OS specific deadlocks,
+;;; wich _appear_ to be caused by malloc() and free() not being thread safe: an
+;;; interrupted malloc in one thread can apparently block a free in another. There
+;;; are also some indications that pthread_mutex_lock is not re-entrant.
+#+(and sb-thread (not darwin))
+(with-test (:name symbol-value-in-thread.3)
+  (let* ((parent *current-thread*)
+         (semaphore (make-semaphore))
+         (running t)
+         (noise (make-thread (lambda ()
+                               (loop while running
+                                     do (setf * (make-array 1024))
+                                     ;; Busy-wait a bit so we don't TOTALLY flood the
+                                     ;; system with GCs: a GC occurring in the middle of
+                                     ;; S-V-I-T causes it to start over -- we want that
+                                     ;; to occur occasionally, but not _all_ the time.
+                                        (loop repeat (random 128)
+                                              do (setf ** *)))))))
+    (write-string "; ")
+    (dotimes (i 15000)
+      (when (zerop (mod i 200))
+        (write-char #\.)
+        (force-output))
+      (let* ((mom-mark (cons t t))
+             (kid-mark (cons t t))
+             (child (make-thread (lambda ()
+                                   (wait-on-semaphore semaphore)
+                                   (let ((old (symbol-value-in-thread 'this-is-new parent)))
+                                     (setf (symbol-value-in-thread 'this-is-new parent)
+                                           (make-array 24 :initial-element kid-mark))
+                                     old)))))
+        (progv '(this-is-new) (list (make-array 24 :initial-element mom-mark))
+          (signal-semaphore semaphore)
+          (assert (eq mom-mark (aref (join-thread child) 0)))
+          (assert (eq kid-mark (aref (symbol-value 'this-is-new) 0))))))
+    (setf running nil)
+    (join-thread noise)))
+
+#+sb-thread
+(with-test (:name symbol-value-in-thread.4)
+  (let* ((parent *current-thread*)
+         (semaphore (make-semaphore))
+         (child (make-thread (lambda ()
+                               (wait-on-semaphore semaphore)
+                               (symbol-value-in-thread 'this-is-new parent nil)))))
+    (signal-semaphore semaphore)
+    (assert (equal '(nil nil) (multiple-value-list (join-thread child))))))
+
+#+sb-thread
+(with-test (:name symbol-value-in-thread.5)
+  (let* ((parent *current-thread*)
+         (semaphore (make-semaphore))
+         (child (make-thread (lambda ()
+                               (wait-on-semaphore semaphore)
+                               (handler-case
+                                   (symbol-value-in-thread 'this-is-new parent)
+                                 (symbol-value-in-thread-error (e)
+                                   (list (thread-error-thread e)
+                                         (cell-error-name e)
+                                         (sb-thread::symbol-value-in-thread-error-info e))))))))
+    (signal-semaphore semaphore)
+    (assert (equal (list *current-thread* 'this-is-new (list :read :unbound-in-thread))
+                   (join-thread child)))))
+
+#+sb-thread
+(with-test (:name symbol-value-in-thread.6)
+  (let* ((parent *current-thread*)
+         (semaphore (make-semaphore))
+         (name (gensym))
+         (child (make-thread (lambda ()
+                               (wait-on-semaphore semaphore)
+                               (handler-case
+                                   (setf (symbol-value-in-thread name parent) t)
+                                 (symbol-value-in-thread-error (e)
+                                   (list (thread-error-thread e)
+                                         (cell-error-name e)
+                                         (sb-thread::symbol-value-in-thread-error-info e))))))))
+    (signal-semaphore semaphore)
+    (let ((res (join-thread child))
+          (want (list *current-thread* name (list :write :no-tls-value))))
+      (unless (equal res want)
+        (error "wanted ~S, got ~S" want res)))))
+
+#+sb-thread
+(with-test (:name symbol-value-in-thread.7)
+  (let ((child (make-thread (lambda ())))
+        (error-occurred nil))
+    (join-thread child)
+    (handler-case
+        (symbol-value-in-thread 'this-is-new child)
+      (symbol-value-in-thread-error (e)
+        (setf error-occurred t)
+        (assert (eq child (thread-error-thread e)))
+        (assert (eq 'this-is-new (cell-error-name e)))
+        (assert (equal (list :read :thread-dead)
+                       (sb-thread::symbol-value-in-thread-error-info e)))))
+    (assert error-occurred)))
+
+#+sb-thread
+(with-test (:name symbol-value-in-thread.8)
+  (let ((child (make-thread (lambda ())))
+        (error-occurred nil))
+    (join-thread child)
+    (handler-case
+        (setf (symbol-value-in-thread 'this-is-new child) t)
+      (symbol-value-in-thread-error (e)
+        (setf error-occurred t)
+        (assert (eq child (thread-error-thread e)))
+        (assert (eq 'this-is-new (cell-error-name e)))
+        (assert (equal (list :write :thread-dead)
+                       (sb-thread::symbol-value-in-thread-error-info e)))))
+    (assert error-occurred)))
+
+#+sb-thread
+(with-test (:name deadlock-detection.1)
+  (flet ((test (ma mb sa sb)
+           (lambda ()
+             (handler-case
+                 (sb-thread:with-mutex (ma)
+                   (sb-thread:signal-semaphore sa)
+                   (sb-thread:wait-on-semaphore sb)
+                   (sb-thread:with-mutex (mb)
+                     :ok))
+               (sb-thread:thread-deadlock (e)
+                 (princ e)
+                 :deadlock)))))
+    (let* ((m1 (sb-thread:make-mutex :name "M1"))
+           (m2 (sb-thread:make-mutex :name "M2"))
+           (s1 (sb-thread:make-semaphore :name "S1"))
+           (s2 (sb-thread:make-semaphore :name "S2"))
+           (t1 (sb-thread:make-thread (test m1 m2 s1 s2) :name "T1"))
+           (t2 (sb-thread:make-thread (test m2 m1 s2 s1) :name "T2")))
+      ;; One will deadlock, and the other will then complete normally
+      (let ((res (list (sb-thread:join-thread t1)
+                       (sb-thread:join-thread t2))))
+        (assert (or (equal '(:deadlock :ok) res)
+                    (equal '(:ok :deadlock) res)))))))
+
+(with-test (:name deadlock-detection.2)
+  (let* ((m1 (sb-thread:make-mutex :name "M1"))
+         (m2 (sb-thread:make-mutex :name "M2"))
+         (s1 (sb-thread:make-semaphore :name "S1"))
+         (s2 (sb-thread:make-semaphore :name "S2"))
+         (t1 (sb-thread:make-thread
+              (lambda ()
+                (sb-thread:with-mutex (m1)
+                  (sb-thread:signal-semaphore s1)
+                  (sb-thread:wait-on-semaphore s2)
+                  (sb-thread:with-mutex (m2)
+                    :ok)))
+              :name "T1")))
+    (prog (err)
+     :retry
+       (handler-bind ((sb-thread:thread-deadlock
+                       (lambda (e)
+                         (unless err
+                           ;; Make sure we can print the condition
+                           ;; while it's active
+                           (let ((*print-circle* nil))
+                             (setf err (princ-to-string e)))
+                           (go :retry)))))
+         (when err
+           (sleep 1))
+         (assert (eq :ok (sb-thread:with-mutex (m2)
+                           (unless err
+                             (sb-thread:signal-semaphore s2)
+                             (sb-thread:wait-on-semaphore s1)
+                             (sleep 1))
+                           (sb-thread:with-mutex (m1)
+                             :ok)))))
+       (assert (stringp err)))
+    (assert (eq :ok (sb-thread:join-thread t1)))))
+
+(with-test (:name deadlock-detection.3)
+  (let* ((m1 (sb-thread:make-mutex :name "M1"))
+         (m2 (sb-thread:make-mutex :name "M2"))
+         (s1 (sb-thread:make-semaphore :name "S1"))
+         (s2 (sb-thread:make-semaphore :name "S2"))
+         (t1 (sb-thread:make-thread
+              (lambda ()
+                (sb-thread:with-mutex (m1)
+                  (sb-thread:signal-semaphore s1)
+                  (sb-thread:wait-on-semaphore s2)
+                  (sb-thread:with-mutex (m2)
+                    :ok)))
+              :name "T1")))
+    ;; Currently we don't consider it a deadlock
+    ;; if there is a timeout in the chain.
+    (assert (eq :deadline
+                (handler-case
+                    (sb-thread:with-mutex (m2)
+                      (sb-thread:signal-semaphore s2)
+                      (sb-thread:wait-on-semaphore s1)
+                      (sleep 1)
+                      (sb-sys:with-deadline (:seconds 0.1)
+                        (sb-thread:with-mutex (m1)
+                          :ok)))
+                  (sb-sys:deadline-timeout ()
+                    :deadline))))
+    (assert (eq :ok (join-thread t1)))))