40408579b4fa0a577b0a0afca536995f4a11d958
[sbcl.git] / src / code / signal.lisp
1 ;;;; handling UNIX signals
2
3 ;;;; This software is part of the SBCL system. See the README file for
4 ;;;; more information.
5 ;;;;
6 ;;;; This software is derived from the CMU CL system, which was
7 ;;;; written at Carnegie Mellon University and released into the
8 ;;;; public domain. The software is in the public domain and is
9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
10 ;;;; files for more information.
11
12 (in-package "SB!UNIX")
13 \f
14 ;;;; macros for dynamically enabling and disabling signal handling
15
16 ;;; Notes on how the without-interrupts/with-interrupts stuff works:
17 ;;;
18 ;;; Before invoking the supplied handler for any of the signals that
19 ;;; can be blocked, the C interrupt support code checks to see whether
20 ;;; *interrupts-enabled* has been bound to NIL. If so, it saves the
21 ;;; signal number and the value of the signal mask (from the signal
22 ;;; context), sets the signal mask to block all blockable signals,
23 ;;; sets *interrupt-pending* and returns without handling the signal.
24 ;;;
25 ;;; When we drop out the without interrupts, we check to see whether
26 ;;; *INTERRUPT-PENDING* has been set. If so, we call
27 ;;; RECEIVE-PENDING-INTERRUPT, which generates a SIGTRAP. The C code
28 ;;; invokes the handler for the saved signal instead of the SIGTRAP
29 ;;; after replacing the signal mask in the signal context with the
30 ;;; saved value. When that hander returns, the original signal mask is
31 ;;; installed, allowing any other pending signals to be handled.
32 ;;;
33 ;;; This means that the cost of WITHOUT-INTERRUPTS is just a special
34 ;;; binding in the case when no signals are delivered (the normal
35 ;;; case). It's only when a signal is actually delivered that we use
36 ;;; any system calls, and by then the cost of the extra system calls
37 ;;; are lost in the noise when compared with the cost of delivering
38 ;;; the signal in the first place.
39 ;;;
40 ;;; The conditional bindings done by this code here are worth the
41 ;;; trouble as binding is more expensive then read & test -- so
42 ;;;  (if *foo*
43 ;;;      (foo)
44 ;;;      (let ((*foo* t))
45 ;;;        (foo)))
46 ;;; is faster then
47 ;;;  (let ((*foo* t))
48 ;;;    (foo))
49 ;;; provided that the first branch is true "often enough".
50
51 (defvar *interrupts-enabled* t)
52 (defvar *interrupt-pending* nil)
53 (defvar *allow-with-interrupts* t)
54
55 (sb!xc:defmacro without-interrupts (&body body)
56   #!+sb-doc
57   "Executes BODY with all deferrable interrupts disabled. Deferrable
58 interrupts arriving during execution of the BODY take effect after BODY has
59 been executed.
60
61 Deferrable interrupts include most blockable POSIX signals, and
62 SB-THREAD:INTERRUPT-THREAD. Does not interfere with garbage collection, and
63 unlike in many traditional Lisps using userspace threads, in SBCL
64 WITHOUT-INTERRUPTS does not inhibit scheduling of other threads.
65
66 Binds ALLOW-WITH-INTERRUPTS and WITH-LOCAL-INTERRUPTS as a local macros.
67
68 ALLOW-WITH-INTERRUPTS allows the WITH-INTERRUPTS to take effect during the
69 dynamic scope of its body, unless there is an outer WITHOUT-INTERRUPTS without
70 a corresponding ALLOW-WITH-INTERRUPTS.
71
72 WITH-LOCAL-INTERRUPTS executes its body with interrupts enabled provided that
73 for there is an ALLOW-WITH-INTERRUPTS for every WITHOUT-INTERRUPTS surrounding
74 the current one. WITH-LOCAL-INTERRUPTS is equivalent to:
75
76   (allow-with-interrupts (with-interrupts ...))
77
78 Care must be taken not to let either ALLOW-WITH-INTERRUPTS or
79 WITH-LOCAL-INTERRUPTS appear in a function that escapes from inside the
80 WITHOUT-INTERRUPTS in:
81
82   (without-interrupts
83     ;; The body of the lambda would be executed with WITH-INTERRUPTS allowed
84     ;; regardless of the interrupt policy in effect when it is called.
85     (lambda () (allow-with-interrupts ...)))
86
87   (without-interrupts
88     ;; The body of the lambda would be executed with interrupts enabled
89     ;; regardless of the interrupt policy in effect when it is called.
90     (lambda () (with-local-interrupts ...)))
91 "
92   (with-unique-names (outer-allow-with-interrupts without-interrupts-body)
93     `(flet ((,without-interrupts-body ()
94               (declare (disable-package-locks allow-with-interrupts
95                                               with-local-interrupts))
96               (macrolet
97                   ((allow-with-interrupts
98                      (&body allow-forms)
99                      `(let ((*allow-with-interrupts*
100                              ,',outer-allow-with-interrupts))
101                         ,@allow-forms))
102                    (with-local-interrupts
103                      (&body with-forms)
104                      `(let ((*allow-with-interrupts*
105                              ,',outer-allow-with-interrupts)
106                             (*interrupts-enabled*
107                              ,',outer-allow-with-interrupts))
108                         (when (and ,',outer-allow-with-interrupts
109                                    *interrupt-pending*)
110                           (receive-pending-interrupt))
111                         (locally ,@with-forms))))
112                 (let ((*interrupts-enabled* nil)
113                       (,outer-allow-with-interrupts *allow-with-interrupts*)
114                       (*allow-with-interrupts* nil))
115                   (declare (ignorable ,outer-allow-with-interrupts))
116                   (declare (enable-package-locks allow-with-interrupts
117                                                  with-local-interrupts))
118                   ,@body))))
119        (if *interrupts-enabled*
120            (unwind-protect
121                 (,without-interrupts-body)
122              ;; If we were interrupted in the protected section,
123              ;; then the interrupts are still blocked and it remains
124              ;; so until the pending interrupt is handled.
125              ;;
126              ;; If we were not interrupted in the protected section,
127              ;; but here, then even if the interrupt handler enters
128              ;; another WITHOUT-INTERRUPTS, the pending interrupt will be
129              ;; handled immediately upon exit from said
130              ;; WITHOUT-INTERRUPTS, so it is as if nothing has happened.
131              (when *interrupt-pending*
132                (receive-pending-interrupt)))
133            (,without-interrupts-body)))))
134
135 (sb!xc:defmacro with-interrupts (&body body)
136   #!+sb-doc
137   "Executes BODY with deferrable interrupts conditionally enabled. If there
138 are pending interrupts they take effect prior to executing BODY.
139
140 As interrupts are normally allowed WITH-INTERRUPTS only makes sense if there
141 is an outer WITHOUT-INTERRUPTS with a corresponding ALLOW-WITH-INTERRUPTS:
142 interrupts are not enabled if any outer WITHOUT-INTERRUPTS is not accompanied
143 by ALLOW-WITH-INTERRUPTS."
144   (with-unique-names (allowp enablep)
145     ;; We could manage without ENABLEP here, but that would require
146     ;; taking extra care not to ever have *ALLOW-WITH-INTERRUPTS* NIL
147     ;; and *INTERRUPTS-ENABLED* T -- instead of risking future breakage
148     ;; we take the tiny hit here.
149     `(let* ((,allowp *allow-with-interrupts*)
150             (,enablep *interrupts-enabled*)
151             (*interrupts-enabled* (or ,enablep ,allowp)))
152        (when (and (and ,allowp (not ,enablep)) *interrupt-pending*)
153          (receive-pending-interrupt))
154        (locally ,@body))))
155
156 (defmacro allow-with-interrupts (&body body)
157   (declare (ignore body))
158   (error "~S is valid only inside ~S."
159          'allow-with-interrupts 'without-interrupts))
160
161 (defmacro with-local-interrupts (&body body)
162   (declare (ignore body))
163   (error "~S is valid only inside ~S."
164          'with-local-interrupts 'without-interrupts))
165
166 ;;; A low-level operation that assumes that *INTERRUPTS-ENABLED* is false,
167 ;;; and *ALLOW-WITH-INTERRUPTS* is true.
168 (defun %check-interrupts ()
169   ;; Here we check for pending interrupts first, because reading a special
170   ;; is faster then binding it!
171   (when *interrupt-pending*
172     (let ((*interrupts-enabled* t))
173       (receive-pending-interrupt))))