X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcode%2Fthread.lisp;h=3d1ecd4086c76206f96621797818c88c0c1c7a2a;hb=18dc0069cd514c976042766ab9a785c970fe1603;hp=4ef2e66f4f37ff0d1b08416baa798ae909312c86;hpb=60a7d6fe1a3005f89973181c065d2bfa8c974e55;p=sbcl.git diff --git a/src/code/thread.lisp b/src/code/thread.lisp index 4ef2e66..3d1ecd4 100644 --- a/src/code/thread.lisp +++ b/src/code/thread.lisp @@ -11,188 +11,316 @@ (in-package "SB!THREAD") +(eval-when (:compile-toplevel :load-toplevel :execute) + (sb!xc:proclaim '(sb!ext:always-bound *current-thread*))) + +(def!type thread-name () + 'simple-string) + +(def!struct (thread (:constructor %make-thread)) + #!+sb-doc + "Thread type. Do not rely on threads being structs as it may change +in future versions." + (name nil :type (or thread-name null)) + (%alive-p nil :type boolean) + (%ephemeral-p nil :type boolean) + (os-thread nil :type (or integer null)) + (interruptions nil :type list) + (result nil :type list) + (interruptions-lock + (make-mutex :name "thread interruptions lock") + :type mutex) + (result-lock + (make-mutex :name "thread result lock") + :type mutex) + waiting-for) + +(def!struct (foreign-thread + (:include thread) + (:conc-name "THREAD-")) + #!+sb-doc + "Type of native threads which are attached to the runtime as Lisp threads +temporarily.") + +#!+(and sb-safepoint-strictly (not win32)) +(def!struct (signal-handling-thread + (:include foreign-thread) + (:conc-name "THREAD-")) + #!+sb-doc + "Asynchronous signal handling thread." + (signal-number nil :type integer)) + (def!struct mutex #!+sb-doc "Mutex type." - (name nil :type (or null simple-string)) - (value nil) - #!+(and sb-lutex sb-thread) - (lutex (make-lutex))) + (name nil :type (or null thread-name)) + (%owner nil :type (or null thread)) + #!+(and sb-thread sb-futex) + (state 0 :type fixnum)) -(def!struct spinlock - #!+sb-doc +(defun mutex-value (mutex) + "Current owner of the mutex, NIL if the mutex is free. May return a +stale value, use MUTEX-OWNER instead." + (mutex-%owner mutex)) + +(defun holding-mutex-p (mutex) + "Test whether the current thread is holding MUTEX." + ;; This is about the only use for which a stale value of owner is + ;; sufficient. + (eq sb!thread:*current-thread* (mutex-%owner mutex))) + +(defsetf mutex-value set-mutex-value) + +(declaim (inline set-mutex-value)) +(defun set-mutex-value (mutex value) + (declare (ignore mutex value)) + (error "~S is no longer supported." '(setf mutex-value))) + +(define-compiler-macro set-mutex-value (&whole form mutex value) + (declare (ignore mutex value)) + (warn "~S is no longer supported, and will signal an error at runtime." + '(setf mutex-value)) + form) + +;;; SPINLOCK no longer exists as a type -- provided for backwards compatibility. + +(deftype spinlock () "Spinlock type." - (name nil :type (or null simple-string)) - (value nil)) + (deprecation-warning :early "1.0.53.11" 'spinlock 'mutex) + 'mutex) + +(define-deprecated-function :early "1.0.53.11" make-spinlock make-mutex (&key name) + (make-mutex :name name)) + +(define-deprecated-function :early "1.0.53.11" spinlock-name mutex-name (lock) + (mutex-name lock)) + +(define-deprecated-function :early "1.0.53.11" (setf spinlock-name) (setf mutex-name) (name lock) + (setf (mutex-name lock) name)) + +(define-deprecated-function :early "1.0.53.11" spinlock-value mutex-owner (lock) + (mutex-owner lock)) + +(define-deprecated-function :early "1.0.53.11" get-spinlock grab-mutex (lock) + (grab-mutex lock)) + +(define-deprecated-function :early "1.0.53.11" release-spinlock release-mutex (lock) + (release-mutex lock)) -(sb!xc:defmacro with-mutex ((mutex &key (value '*current-thread*) (wait-p t)) +(sb!xc:defmacro with-recursive-spinlock ((lock) &body body) + (deprecation-warning :early "1.0.53.11" 'with-recursive-spinlock 'with-recursive-lock) + `(with-recursive-lock (,lock) + ,@body)) + +(sb!xc:defmacro with-spinlock ((lock) &body body) + (deprecation-warning :early "1.0.53.11" 'with-spinlock 'with-mutex) + `(with-mutex (,lock) + ,@body)) + +(sb!xc:defmacro without-thread-waiting-for ((&key already-without-interrupts) &body body) + (with-unique-names (thread prev) + (let ((without (if already-without-interrupts + 'progn + 'without-interrupts)) + (with (if already-without-interrupts + 'progn + 'with-local-interrupts))) + `(let* ((,thread *current-thread*) + (,prev (progn + (barrier (:read)) + (thread-waiting-for ,thread)))) + (flet ((exec () ,@body)) + (if ,prev + (,without + (unwind-protect + (progn + (setf (thread-waiting-for ,thread) nil) + (barrier (:write)) + (,with (exec))) + ;; If we were waiting on a waitqueue, this becomes a bogus + ;; wakeup. + (when (mutex-p ,prev) + (setf (thread-waiting-for ,thread) ,prev) + (barrier (:write))))) + (exec))))))) + +(sb!xc:defmacro with-mutex ((mutex &key (wait-p t) timeout value) &body body) #!+sb-doc - "Acquire MUTEX for the dynamic scope of BODY, 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" + "Acquire MUTEX for the dynamic scope of BODY. If WAIT-P is true (the default), +and the MUTEX is not immediately available, sleep until it is available. + +If TIMEOUT is given, it specifies a relative timeout, in seconds, on how long +the system should try to acquire the lock in the contested case. + +If the mutex isn't acquired succesfully due to either WAIT-P or TIMEOUT, the +body is not executed, and WITH-MUTEX returns NIL. + +Otherwise body is executed with the mutex held by current thread, and +WITH-MUTEX returns the values of BODY. + +Historically WITH-MUTEX also accepted a VALUE argument, which when provided +was used as the new owner of the mutex instead of the current thread. This is +no longer supported: if VALUE is provided, it must be either NIL or the +current thread." `(dx-flet ((with-mutex-thunk () ,@body)) (call-with-mutex #'with-mutex-thunk ,mutex ,value - ,wait-p))) + ,wait-p + ,timeout))) -(sb!xc:defmacro with-system-mutex ((mutex &key without-gcing) &body body) +(sb!xc:defmacro with-system-mutex ((mutex + &key without-gcing allow-with-interrupts) + &body body) `(dx-flet ((with-system-mutex-thunk () ,@body)) - (call-with-system-mutex - #'with-system-mutex-thunk - ,mutex - ,without-gcing))) + (,(cond (without-gcing + 'call-with-system-mutex/without-gcing) + (allow-with-interrupts + 'call-with-system-mutex/allow-with-interrupts) + (t + 'call-with-system-mutex)) + #'with-system-mutex-thunk + ,mutex))) -(sb!xc:defmacro with-recursive-lock ((mutex) &body body) +(sb!xc:defmacro with-recursive-lock ((mutex &key (wait-p t) timeout) &body body) #!+sb-doc - "Acquires MUTEX for the dynamic scope of BODY. Within that scope -further recursive lock attempts for the same mutex succeed. It is -allowed to mix WITH-MUTEX and WITH-RECURSIVE-LOCK for the same mutex -provided the default value is used for the mutex." + "Acquire MUTEX for the dynamic scope of BODY. + +If WAIT-P is true (the default), and the MUTEX is not immediately available or +held by the current thread, sleep until it is available. + +If TIMEOUT is given, it specifies a relative timeout, in seconds, on how long +the system should try to acquire the lock in the contested case. + +If the mutex isn't acquired succesfully due to either WAIT-P or TIMEOUT, the +body is not executed, and WITH-RECURSIVE-LOCK returns NIL. + +Otherwise body is executed with the mutex held by current thread, and +WITH-RECURSIVE-LOCK returns the values of BODY. + +Unlike WITH-MUTEX, which signals an error on attempt to re-acquire an already +held mutex, WITH-RECURSIVE-LOCK allows recursive lock attempts to succeed." `(dx-flet ((with-recursive-lock-thunk () ,@body)) (call-with-recursive-lock #'with-recursive-lock-thunk - ,mutex))) - -(sb!xc:defmacro with-recursive-spinlock ((spinlock) &body body) - `(dx-flet ((with-recursive-spinlock-thunk () ,@body)) - (call-with-recursive-spinlock - #'with-recursive-spinlock-thunk - ,spinlock))) - -(sb!xc:defmacro with-recursive-system-spinlock ((spinlock &key without-gcing) - &body body) - `(dx-flet ((with-recursive-system-spinlock-thunk () ,@body)) - (call-with-recursive-system-spinlock - #'with-recursive-system-spinlock-thunk - ,spinlock - ,without-gcing))) - -(sb!xc:defmacro with-spinlock ((spinlock) &body body) - `(dx-flet ((with-spinlock-thunk () ,@body)) - (call-with-spinlock - #'with-spinlock-thunk - ,spinlock))) - -;;; KLUDGE: this separate implementation for (NOT SB-THREAD) is not -;;; strictly necessary; GET-MUTEX and RELEASE-MUTEX are implemented. -;;; However, there would be a (possibly slight) performance hit in -;;; using them. + ,mutex + ,wait-p + ,timeout))) + +(sb!xc:defmacro with-recursive-system-lock ((lock + &key without-gcing) + &body body) + `(dx-flet ((with-recursive-system-lock-thunk () ,@body)) + (,(cond (without-gcing + 'call-with-recursive-system-lock/without-gcing) + (t + 'call-with-recursive-system-lock)) + #'with-recursive-system-lock-thunk + ,lock))) + +(macrolet ((def (name &optional variant) + `(defun ,(if variant (symbolicate name "/" variant) name) + (function mutex) + (declare (function function)) + (flet ((%call-with-system-mutex () + (dx-let (got-it) + (unwind-protect + (when (setf got-it (grab-mutex mutex)) + (funcall function)) + (when got-it + (release-mutex mutex)))))) + (declare (inline %call-with-system-mutex)) + ,(ecase variant + (:without-gcing + `(without-gcing (%call-with-system-mutex))) + (:allow-with-interrupts + `(without-interrupts + (allow-with-interrupts (%call-with-system-mutex)))) + ((nil) + `(without-interrupts (%call-with-system-mutex)))))))) + (def call-with-system-mutex) + (def call-with-system-mutex :without-gcing) + (def call-with-system-mutex :allow-with-interrupts)) + #!-sb-thread (progn - (defun call-with-system-mutex (function mutex &optional without-gcing-p) - (declare (ignore mutex) - (function function)) - (if without-gcing-p - (without-gcing - (funcall function)) - (without-interrupts - (funcall function)))) - - (defun call-with-recursive-system-spinlock (function lock - &optional without-gcing-p) - (declare (ignore lock) - (function function)) - (if without-gcing-p - (without-gcing - (funcall function)) - (without-interrupts - (funcall function)))) - - (defun call-with-mutex (function mutex value waitp) - (declare (ignore mutex value waitp) + (defun call-with-mutex (function mutex value waitp timeout) + (declare (ignore mutex waitp timeout) (function function)) + (unless (or (null value) (eq *current-thread* value)) + (error "~S called with non-nil :VALUE that isn't the current thread." + 'with-mutex)) (funcall function)) - (defun call-with-recursive-lock (function mutex) - (declare (ignore mutex) (function function)) + (defun call-with-recursive-lock (function mutex waitp timeout) + (declare (ignore mutex waitp timeout) + (function function)) (funcall function)) - (defun call-with-spinlock (function spinlock) - (declare (ignore spinlock) (function function)) - (funcall function)) + (defun call-with-recursive-system-lock (function lock) + (declare (function function) (ignore lock)) + (without-interrupts + (funcall function))) - (defun call-with-recursive-spinlock (function spinlock) - (declare (ignore spinlock) (function function)) - (funcall function))) + (defun call-with-recursive-system-lock/without-gcing (function mutex) + (declare (function function) (ignore mutex)) + (without-gcing + (funcall function)))) #!+sb-thread +;;; KLUDGE: These need to use DX-LET, because the cleanup form that +;;; closes over GOT-IT causes a value-cell to be allocated for it -- +;;; and we prefer that to go on the stack since it can. (progn - (defun call-with-system-mutex (function mutex &optional without-gcing-p) + (defun call-with-mutex (function mutex value waitp timeout) (declare (function function)) - (flet ((%call-with-system-mutex () - (let (got-it) - (unwind-protect - (when (setf got-it (get-mutex mutex)) - (funcall function)) - (when got-it - (release-mutex mutex)))))) - (if without-gcing-p - (without-gcing - (%call-with-system-mutex)) - (without-interrupts - (%call-with-system-mutex))))) - - (defun call-with-recursive-system-spinlock (function lock &optional without-gcing-p) - (declare (function function)) - (flet ((%call-with-system-spinlock () - (let ((inner-lock-p (eq *current-thread* (spinlock-value lock))) - (got-it nil)) - (unwind-protect - (when (or inner-lock-p (setf got-it (get-spinlock lock))) - (funcall function)) - (when got-it - (release-spinlock lock)))))) - (if without-gcing-p - (without-gcing - (%call-with-system-spinlock)) - (without-interrupts - (%call-with-system-spinlock))))) - - (defun call-with-mutex (function mutex value waitp) - (declare (function function)) - (let ((got-it nil)) + (unless (or (null value) (eq *current-thread* value)) + (error "~S called with non-nil :VALUE that isn't the current thread." + 'with-mutex)) + (dx-let ((got-it nil)) (without-interrupts (unwind-protect (when (setq got-it (allow-with-interrupts - (get-mutex mutex value waitp))) + (grab-mutex mutex :waitp waitp + :timeout timeout))) (with-local-interrupts (funcall function))) (when got-it (release-mutex mutex)))))) - (defun call-with-recursive-lock (function mutex) + (defun call-with-recursive-lock (function mutex waitp timeout) (declare (function function)) - (let ((inner-lock-p (eq (mutex-value mutex) *current-thread*)) - (got-it nil)) + (dx-let ((inner-lock-p (eq (mutex-%owner mutex) *current-thread*)) + (got-it nil)) (without-interrupts (unwind-protect (when (or inner-lock-p (setf got-it (allow-with-interrupts - (get-mutex mutex)))) + (grab-mutex mutex :waitp waitp + :timeout timeout)))) (with-local-interrupts (funcall function))) (when got-it (release-mutex mutex)))))) - (defun call-with-spinlock (function spinlock) - (declare (function function)) - (let ((got-it nil)) - (without-interrupts - (unwind-protect - (when (setf got-it (allow-with-interrupts - (get-spinlock spinlock))) - (with-local-interrupts (funcall function))) - (when got-it - (release-spinlock spinlock)))))) - - (defun call-with-recursive-spinlock (function spinlock) - (declare (function function)) - (let ((inner-lock-p (eq (spinlock-value spinlock) *current-thread*)) - (got-it nil)) - (without-interrupts - (unwind-protect - (when (or inner-lock-p (setf got-it (allow-with-interrupts - (get-spinlock spinlock)))) - (with-local-interrupts (funcall function))) - (when got-it - (release-spinlock spinlock))))))) + (macrolet ((def (name &optional variant) + `(defun ,(if variant (symbolicate name "/" variant) name) + (function lock) + (declare (function function)) + (flet ((%call-with-recursive-system-lock () + (dx-let ((inner-lock-p + (eq *current-thread* (mutex-owner lock))) + (got-it nil)) + (unwind-protect + (when (or inner-lock-p + (setf got-it (grab-mutex lock))) + (funcall function)) + (when got-it + (release-mutex lock)))))) + (declare (inline %call-with-recursive-system-lock)) + ,(ecase variant + (:without-gcing + `(without-gcing (%call-with-recursive-system-lock))) + ((nil) + `(without-interrupts (%call-with-recursive-system-lock)))))))) + (def call-with-recursive-system-lock) + (def call-with-recursive-system-lock :without-gcing)))