1.0.5.9: experimental semi-synchronous deadlines
[sbcl.git] / src / code / target-thread.lisp
index 42ad3dc..995847e 100644 (file)
@@ -19,7 +19,7 @@
 ;;; set the doc here because in early-thread FDOCUMENTATION is not
 ;;; available, yet
 #!+sb-doc
-(setf (sb!kernel:fdocumentation '*current-thread* 'variable)
+(setf (fdocumentation '*current-thread* 'variable)
       "Bound in each thread to the thread itself.")
 
 (defstruct (thread (:constructor %make-thread))
@@ -35,7 +35,7 @@ in future versions."
   (result-lock (make-mutex :name "thread result lock")))
 
 #!+sb-doc
-(setf (sb!kernel:fdocumentation 'thread-name 'function)
+(setf (fdocumentation 'thread-name 'function)
       "The name of the thread. Setfable.")
 
 (def!method print-object ((thread thread) stream)
@@ -143,7 +143,7 @@ in future versions."
     (defmacro with-lutex-address ((name lutex) &body body)
       `(let ((,name ,lutex))
          (with-pinned-objects (,name)
-           (let ((,name (sb!kernel:get-lisp-obj-address ,name)))
+           (let ((,name (get-lisp-obj-address ,name)))
              ,@body))))
 
     (defun make-lutex ()
@@ -163,7 +163,8 @@ in future versions."
     (declaim (inline futex-wait futex-wake))
 
     (sb!alien:define-alien-routine "futex_wait"
-        int (word unsigned-long) (old-value unsigned-long))
+        int (word unsigned-long) (old-value unsigned-long)
+        (to-sec long) (to-usec unsigned-long))
 
     (sb!alien:define-alien-routine "futex_wake"
         int (word unsigned-long) (n unsigned-long))))
@@ -182,103 +183,102 @@ in future versions."
   (sb!vm::current-thread-offset-sap n))
 
 ;;;; spinlocks
+#!+sb-thread
+(define-structure-slot-compare-and-swap
+    compare-and-swap-spinlock-value
+    :structure spinlock
+    :slot value)
 
 (declaim (inline get-spinlock release-spinlock))
 
-;;; The bare 2 here and below are offsets of the slots in the struct.
-;;; There ought to be some better way to get these numbers
 (defun get-spinlock (spinlock)
   (declare (optimize (speed 3) (safety 0))
            #!-sb-thread
-           (ignore spinlock new-value))
+           (ignore spinlock))
   ;; %instance-set-conditional can test for 0 (which is a fixnum) and
   ;; store any value
   #!+sb-thread
   (loop until
-        (eql (sb!vm::%instance-set-conditional spinlock 2 0 1) 0)))
+       (eql 0 (compare-and-swap-spinlock-value spinlock 0 1)))
+  t)
 
 (defun release-spinlock (spinlock)
   (declare (optimize (speed 3) (safety 0))
            #!-sb-thread (ignore spinlock))
   ;; %instance-set-conditional cannot compare arbitrary objects
-  ;; meaningfully, so
-  ;; (sb!vm::%instance-set-conditional spinlock 2 our-value 0)
+  ;; meaningfully, so (compare-and-swap-spinlock-value our-value 0)
   ;; does not work for bignum thread ids.
   #!+sb-thread
-  (sb!vm::%instance-set spinlock 2 0))
-
-(defmacro with-spinlock ((spinlock) &body body)
-  (sb!int:with-unique-names (lock got-it)
-    `(let ((,lock ,spinlock)
-           (,got-it nil))
-      (unwind-protect
-           (progn
-             (setf ,got-it (get-spinlock ,lock))
-             (locally ,@body))
-        (when ,got-it
-          (release-spinlock ,lock))))))
+  (setf (spinlock-value spinlock) 0)
+  nil)
 
 ;;;; mutexes
 
 #!+sb-doc
-(setf (sb!kernel:fdocumentation 'make-mutex 'function)
+(setf (fdocumentation 'make-mutex 'function)
       "Create a mutex."
-      (sb!kernel:fdocumentation 'mutex-name 'function)
+      (fdocumentation 'mutex-name 'function)
       "The name of the mutex. Setfable."
-      (sb!kernel:fdocumentation 'mutex-value 'function)
+      (fdocumentation 'mutex-value 'function)
       "The value of the mutex. NIL if the mutex is free. Setfable.")
 
 #!+(and sb-thread (not sb-lutex))
 (progn
-  (declaim (inline mutex-value-address))
-  (defun mutex-value-address (mutex)
-    (declare (optimize (speed 3)))
-    (sb!ext:truly-the
-     sb!vm:word
-     (+ (sb!kernel:get-lisp-obj-address mutex)
-        (- (* 3 sb!vm:n-word-bytes) sb!vm:instance-pointer-lowtag)))))
-
-(defun get-mutex (mutex &optional (new-value *current-thread*) (wait-p t))
+  (define-structure-slot-addressor mutex-value-address
+      :structure mutex
+      :slot value)
+  (define-structure-slot-compare-and-swap
+      compare-and-swap-mutex-value
+      :structure mutex
+      :slot value))
+
+(defun get-mutex (mutex &optional (new-value *current-thread*) (waitp t))
   #!+sb-doc
   "Acquire MUTEX, setting it to NEW-VALUE or some suitable default
-value if NIL.  If WAIT-P is non-NIL and the mutex is in use, sleep
-until it is available"
+value if NIL. If WAITP is non-NIL and the mutex is in use, sleep
+until it is available."
   (declare (type mutex mutex) (optimize (speed 3)))
   (/show0 "Entering GET-MUTEX")
   (unless new-value
     (setq new-value *current-thread*))
   #!-sb-thread
-  (let ((old-value (mutex-value mutex)))
-    (when (and old-value wait-p)
-      (error "In unithread mode, mutex ~S was requested with WAIT-P ~S and ~
+  (let ((old (mutex-value mutex)))
+    (when (and old waitp)
+      (error "In unithread mode, mutex ~S was requested with WAITP ~S and ~
               new-value ~S, but has already been acquired (with value ~S)."
-             mutex wait-p new-value old-value))
+             mutex waitp new-value old))
     (setf (mutex-value mutex) new-value)
     t)
   #!+sb-thread
-  (progn
-    (when (eql new-value (mutex-value mutex))
-      (warn "recursive lock attempt ~S~%" mutex)
-      (format *debug-io* "Thread: ~A~%" *current-thread*)
-      (sb!debug:backtrace most-positive-fixnum *debug-io*)
-      (force-output *debug-io*))
-    #!+sb-lutex
-    (when (zerop (with-lutex-address (lutex (mutex-lutex mutex))
-                   (if wait-p
-                       (%lutex-lock lutex)
-                       (%lutex-trylock lutex))))
-      (setf (mutex-value mutex) new-value))
-    #!-sb-lutex
-    (let (old)
-      (loop
-         (unless
-             (setf old (sb!vm::%instance-set-conditional mutex 2 nil
-                                                         new-value))
-           (return t))
-         (unless wait-p (return nil))
-         (with-pinned-objects (mutex old)
-           (futex-wait (mutex-value-address mutex)
-                       (sb!kernel:get-lisp-obj-address old)))))))
+  (when (eql new-value (mutex-value mutex))
+    (warn "recursive lock attempt ~S~%" mutex)
+    (format *debug-io* "Thread: ~A~%" *current-thread*)
+    (sb!debug:backtrace most-positive-fixnum *debug-io*)
+    (force-output *debug-io*))
+  ;; FIXME: Lutexes do not currently support deadlines, as at least
+  ;; on Darwin pthread_foo_timedbar functions are not supported:
+  ;; this means that we probably need to use the Carbon multiprocessing
+  ;; functions on Darwin.
+  #!+sb-lutex
+  (when (zerop (with-lutex-address (lutex (mutex-lutex mutex))
+                 (if waitp
+                     (%lutex-lock lutex)
+                     (%lutex-trylock lutex))))
+    (setf (mutex-value mutex) new-value))
+  #!-sb-lutex
+  (let (old)
+    (when (and (setf old (compare-and-exchange-mutex-value mutex nil new-value))
+               waitp)
+      (loop while old
+            do (multiple-value-bind (to-sec to-usec) (decode-timeout nil)
+                 (when (= 1 (with-pinned-objects (mutex old)
+                              (futex-wait (mutex-value-address mutex)
+                                          (get-lisp-obj-address old)
+                                          (or to-sec -1)
+                                          (or to-usec 0))))
+                   (signal-deadline)))
+            (setf old (compare-and-exchange-mutex-value mutex nil new-value))))
+    (not old)))
 
 (defun release-mutex (mutex)
   #!+sb-doc
@@ -312,18 +312,13 @@ this mutex."
   (%make-waitqueue :name name))
 
 #!+sb-doc
-(setf (sb!kernel:fdocumentation 'waitqueue-name 'function)
+(setf (fdocumentation 'waitqueue-name 'function)
       "The name of the waitqueue. Setfable.")
 
 #!+(and sb-thread (not sb-lutex))
-(progn
-  (declaim (inline waitqueue-data-address))
-  (defun waitqueue-data-address (waitqueue)
-    (declare (optimize (speed 3)))
-    (sb!ext:truly-the
-     sb!vm:word
-     (+ (sb!kernel:get-lisp-obj-address waitqueue)
-        (- (* 3 sb!vm:n-word-bytes) sb!vm:instance-pointer-lowtag)))))
+(define-structure-slot-addressor waitqueue-data-address
+    :structure waitqueue
+    :slot data)
 
 (defun condition-wait (queue mutex)
   #!+sb-doc
@@ -354,10 +349,15 @@ time we reacquire MUTEX and return to the caller."
            ;; manages to grab MUTEX and call CONDITION-NOTIFY during
            ;; this comment, it will change queue->data, and so
            ;; futex-wait returns immediately instead of sleeping.
-           ;; Ergo, no lost wakeup
-           (with-pinned-objects (queue me)
-             (futex-wait (waitqueue-data-address queue)
-                         (sb!kernel:get-lisp-obj-address me))))
+           ;; Ergo, no lost wakeup. We may get spurious wakeups,
+           ;; but that's ok.
+           (multiple-value-bind (to-sec to-usec) (decode-timeout nil)
+             (when (= 1 (with-pinned-objects (queue me)
+                          (futex-wait (waitqueue-data-address queue)
+                                      (get-lisp-obj-address me)
+                                      (or to-sec -1) ;; our way if saying "no timeout"
+                                      (or to-usec 0))))
+               (signal-deadline))))
       ;; If we are interrupted while waiting, we should do these things
       ;; before returning.  Ideally, in the case of an unhandled signal,
       ;; we should do them before entering the debugger, but this is
@@ -413,7 +413,7 @@ time we reacquire MUTEX and return to the caller."
   "Create a semaphore with the supplied COUNT."
   (%make-semaphore :name name :count count))
 
-(setf (sb!kernel:fdocumentation 'semaphore-name 'function)
+(setf (fdocumentation 'semaphore-name 'function)
       "The name of the semaphore. Setfable.")
 
 (defun wait-on-semaphore (sem)
@@ -500,7 +500,7 @@ this semaphore, then N of them is woken up."
     (when *session*
       (%delete-thread-from-session thread *session*)))
   #!+sb-lutex
-  (when (thread-interruptions-lock thread)
+  (without-gcing
     (/show0 "FREEING MUTEX LUTEX")
     (with-lutex-address (lutex (mutex-lutex (thread-interruptions-lock thread)))
       (%lutex-destroy lutex))))
@@ -632,9 +632,9 @@ around and can be retrieved by JOIN-THREAD."
             ;; least accessible to users to secure their own libraries.
             ;;   --njf, 2006-07-15
             (let ((*current-thread* thread)
-                  (sb!kernel::*restart-clusters* nil)
-                  (sb!kernel::*handler-clusters* nil)
-                  (sb!kernel::*condition-restarts* nil)
+                  (*restart-clusters* nil)
+                  (*handler-clusters* nil)
+                  (*condition-restarts* nil)
                   (sb!impl::*step-out* nil)
                   ;; internal printer variables
                   (sb!impl::*previous-case* nil)
@@ -678,7 +678,7 @@ around and can be retrieved by JOIN-THREAD."
     (with-pinned-objects (initial-function)
       (let ((os-thread
              (%create-thread
-              (sb!kernel:get-lisp-obj-address initial-function))))
+              (get-lisp-obj-address initial-function))))
         (when (zerop os-thread)
           (error "Can't create a new thread"))
         (wait-on-semaphore setup-sem)
@@ -694,7 +694,7 @@ around and can be retrieved by JOIN-THREAD."
                      (join-thread-error-thread c)))))
 
 #!+sb-doc
-(setf (sb!kernel:fdocumentation 'join-thread-error-thread 'function)
+(setf (fdocumentation 'join-thread-error-thread 'function)
       "The thread that we failed to join.")
 
 (defun join-thread (thread &key (default nil defaultp))
@@ -724,7 +724,7 @@ return DEFAULT if given or else signal JOIN-THREAD-ERROR."
                      (interrupt-thread-error-thread c)))))
 
 #!+sb-doc
-(setf (sb!kernel:fdocumentation 'interrupt-thread-error-thread 'function)
+(setf (fdocumentation 'interrupt-thread-error-thread 'function)
       "The thread that was not interrupted.")
 
 (defmacro with-interruptions-lock ((thread) &body body)
@@ -804,7 +804,7 @@ SB-EXT:QUIT - the usual cleanup forms will be evaluated"
                                (* sb!vm:n-word-bytes index))))
     (if (eql tl-val sb!vm::no-tls-value-marker-widetag)
         (sb!vm::symbol-global-value symbol)
-        (sb!kernel:make-lisp-obj tl-val))))
+        (make-lisp-obj tl-val))))
 
 (defun sb!vm::locked-symbol-global-value-add (symbol-name delta)
   (sb!vm::locked-symbol-global-value-add symbol-name delta))
@@ -812,11 +812,11 @@ SB-EXT:QUIT - the usual cleanup forms will be evaluated"
 ;;; Stepping
 
 (defun thread-stepping ()
-  (sb!kernel:make-lisp-obj
+  (make-lisp-obj
    (sap-ref-word (current-thread-sap)
                  (* sb!vm::thread-stepping-slot sb!vm:n-word-bytes))))
 
 (defun (setf thread-stepping) (value)
   (setf (sap-ref-word (current-thread-sap)
                       (* sb!vm::thread-stepping-slot sb!vm:n-word-bytes))
-        (sb!kernel:get-lisp-obj-address value)))
+        (get-lisp-obj-address value)))