Initial revision
[sbcl.git] / src / code / target-signal.lisp
1 ;;;; code for 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
14 (file-comment
15   "$Header$")
16
17 ;;; These should probably be somewhere, but I don't know where.
18 (defconstant sig_dfl 0)
19 (defconstant sig_ign 1)
20 \f
21 ;;;; system calls that deal with signals
22
23 #!-sb-fluid (declaim (inline real-unix-kill))
24 (sb!alien:def-alien-routine ("kill" real-unix-kill) sb!c-call:int
25   (pid sb!c-call:int)
26   (signal sb!c-call:int))
27
28 (defun unix-kill (pid signal)
29   #!+sb-doc
30   "Unix-kill sends the signal signal to the process with process
31    id pid. Signal should be a valid signal number or a keyword of the
32    standard UNIX signal name."
33   (real-unix-kill pid (unix-signal-number signal)))
34
35 #!-sb-fluid (declaim (inline real-unix-killpg))
36 (sb!alien:def-alien-routine ("killpg" real-unix-killpg) sb!c-call:int
37   (pgrp sb!c-call:int)
38   (signal sb!c-call:int))
39
40 (defun unix-killpg (pgrp signal)
41   #!+sb-doc
42   "Unix-killpg sends the signal signal to the all the process in process
43   group PGRP. Signal should be a valid signal number or a keyword of
44   the standard UNIX signal name."
45   (real-unix-killpg pgrp (unix-signal-number signal)))
46
47 (sb!alien:def-alien-routine ("sigblock" unix-sigblock) sb!c-call:unsigned-long
48   #!+sb-doc
49   "Unix-sigblock cause the signals specified in mask to be
50    added to the set of signals currently being blocked from
51    delivery. The macro sigmask is provided to create masks."
52   (mask sb!c-call:unsigned-long))
53
54 (sb!alien:def-alien-routine ("sigpause" unix-sigpause) sb!c-call:void
55   #!+sb-doc
56   "Unix-sigpause sets the set of masked signals to its argument
57    and then waits for a signal to arrive, restoring the previous
58    mask upon its return."
59   (mask sb!c-call:unsigned-long))
60
61 (sb!alien:def-alien-routine ("sigsetmask" unix-sigsetmask)
62                             sb!c-call:unsigned-long
63   #!+sb-doc
64   "Unix-sigsetmask sets the current set of masked signals (those
65    begin blocked from delivery) to the argument. The macro sigmask
66    can be used to create the mask. The previous value of the signal
67    mask is returned."
68   (mask sb!c-call:unsigned-long))
69 \f
70 ;;;; C routines that actually do all the work of establishing signal handlers
71 (sb!alien:def-alien-routine ("install_handler" install-handler)
72                           sb!c-call:unsigned-long
73   (signal sb!c-call:int)
74   (handler sb!c-call:unsigned-long))
75 \f
76 ;;;; interface to enabling and disabling signal handlers
77
78 (defun enable-interrupt (signal handler)
79   (declare (type (or function (member :default :ignore)) handler))
80   (without-gcing
81    (let ((result (install-handler (unix-signal-number signal)
82                                   (case handler
83                                     (:default sig_dfl)
84                                     (:ignore sig_ign)
85                                     (t
86                                      (sb!kernel:get-lisp-obj-address
87                                       handler))))))
88      (cond ((= result sig_dfl) :default)
89            ((= result sig_ign) :ignore)
90            (t (the function (sb!kernel:make-lisp-obj result)))))))
91
92 (defun default-interrupt (signal)
93   (enable-interrupt signal :default))
94
95 (defun ignore-interrupt (signal)
96   (enable-interrupt signal :ignore))
97 \f
98 ;;;; default LISP signal handlers
99 ;;;;
100 ;;;; Most of these just call ERROR to report the presence of the signal.
101
102 (eval-when (:compile-toplevel :execute)
103   (sb!xc:defmacro define-signal-handler (name
104                                          what
105                                          &optional (function 'error))
106     `(defun ,name (signal info context)
107        (declare (ignore signal info))
108        (declare (type system-area-pointer context))
109        (/show "in Lisp-level signal handler" (sap-int context))
110        (,function ,(concatenate 'simple-string what " at #X~X")
111                   (with-alien ((context (* os-context-t) context))
112                     (sap-int (sb!vm:context-pc context)))))))
113
114 (define-signal-handler sigint-handler "interrupted" break)
115 (define-signal-handler sigill-handler "illegal instruction")
116 (define-signal-handler sigtrap-handler "breakpoint/trap")
117 (define-signal-handler sigiot-handler "SIGIOT")
118 #!-linux
119 (define-signal-handler sigemt-handler "SIGEMT")
120 (define-signal-handler sigbus-handler "bus error")
121 (define-signal-handler sigsegv-handler "segmentation violation")
122 #!-linux
123 (define-signal-handler sigsys-handler "bad argument to a system call")
124 (define-signal-handler sigpipe-handler "SIGPIPE")
125 (define-signal-handler sigalrm-handler "SIGALRM")
126
127 (defun sigquit-handler (signal code context)
128   (declare (ignore signal code context))
129   (throw 'sb!impl::top-level-catcher nil))
130
131 (defun sb!kernel:signal-cold-init-or-reinit ()
132   #!+sb-doc
133   "Enable all the default signals that Lisp knows how to deal with."
134   (enable-interrupt :sigint #'sigint-handler)
135   (enable-interrupt :sigquit #'sigquit-handler)
136   (enable-interrupt :sigill #'sigill-handler)
137   (enable-interrupt :sigtrap #'sigtrap-handler)
138   (enable-interrupt :sigiot #'sigiot-handler)
139   #!-linux
140   (enable-interrupt :sigemt #'sigemt-handler)
141   (enable-interrupt :sigfpe #'sb!vm:sigfpe-handler)
142   (enable-interrupt :sigbus #'sigbus-handler)
143   (enable-interrupt :sigsegv #'sigsegv-handler)
144   #!-linux
145   (enable-interrupt :sigsys #'sigsys-handler)
146   (enable-interrupt :sigpipe #'sigpipe-handler)
147   (enable-interrupt :sigalrm #'sigalrm-handler)
148   nil)
149 \f
150 ;;; stale code which I'm insufficiently motivated to test -- WHN 19990714
151 #|
152 ;;;; WITH-ENABLED-INTERRUPTS
153
154 (defmacro with-enabled-interrupts (interrupt-list &body body)
155   #!+sb-doc
156   "With-enabled-interrupts ({(interrupt function)}*) {form}*
157    Establish function as a handler for the Unix signal interrupt which
158    should be a number between 1 and 31 inclusive."
159   (let ((il (gensym))
160         (it (gensym)))
161     `(let ((,il NIL))
162        (unwind-protect
163            (progn
164              ,@(do* ((item interrupt-list (cdr item))
165                      (intr (caar item) (caar item))
166                      (ifcn (cadar item) (cadar item))
167                      (forms NIL))
168                     ((null item) (nreverse forms))
169                  (when (symbolp intr)
170                    (setq intr (symbol-value intr)))
171                  (push `(push `(,,intr ,(enable-interrupt ,intr ,ifcn)) ,il)
172                        forms))
173              ,@body)
174          (dolist (,it (nreverse ,il))
175            (enable-interrupt (car ,it) (cadr ,it)))))))
176 |#