a920f15da921d9e9314d1b4533154cd876db9753
[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 ;;; These should probably be somewhere, but I don't know where.
15 (defconstant sig_dfl 0)
16 (defconstant sig_ign 1)
17 \f
18 ;;;; system calls that deal with signals
19
20 #!-sb-fluid (declaim (inline real-unix-kill))
21 (sb!alien:define-alien-routine ("kill" real-unix-kill) sb!alien:int
22   (pid sb!alien:int)
23   (signal sb!alien:int))
24
25 ;;; Send the signal SIGNAL to the process with process id PID. SIGNAL
26 ;;; should be a valid signal number
27 (defun unix-kill (pid signal)
28   (real-unix-kill pid signal))
29
30 #!-sb-fluid (declaim (inline real-unix-killpg))
31 (sb!alien:define-alien-routine ("killpg" real-unix-killpg) sb!alien:int
32   (pgrp sb!alien:int)
33   (signal sb!alien:int))
34
35 ;;; Send the signal SIGNAL to the all the process in process group
36 ;;; PGRP. SIGNAL should be a valid signal number
37 (defun unix-killpg (pgrp signal)
38   (real-unix-killpg pgrp signal))
39
40 ;;; Reset the current set of masked signals (those being blocked from
41 ;;; delivery).
42 ;;;
43 ;;; (Note: CMU CL had a more general SIGSETMASK call and a SIGMASK
44 ;;; operator to create masks, but since we only ever reset to 0, we no
45 ;;; longer support it. If you need it, you can pull it out of the CMU
46 ;;; CL sources, or the old SBCL sources; but you might also consider
47 ;;; doing things the SBCL way and moving this kind of C-level work
48 ;;; down to C wrapper functions.)
49
50 ;;; When inappropriate build options are used, this also prints messages
51 ;;; listing the signals that were masked
52 (sb!alien:define-alien-routine "reset_signal_mask" sb!alien:void)
53 \f
54 ;;;; C routines that actually do all the work of establishing signal handlers
55 (sb!alien:define-alien-routine ("install_handler" install-handler)
56                                sb!alien:unsigned-long
57   (signal sb!alien:int)
58   (handler sb!alien:unsigned-long))
59
60 ;;;; interface to enabling and disabling signal handlers
61
62 (defun enable-interrupt (signal handler)
63   (declare (type (or function fixnum (member :default :ignore)) handler))
64   (without-gcing
65    (let ((result (install-handler signal
66                                   (case handler
67                                     (:default sig_dfl)
68                                     (:ignore sig_ign)
69                                     (t
70                                      (sb!kernel:get-lisp-obj-address
71                                       handler))))))
72      (cond ((= result sig_dfl) :default)
73            ((= result sig_ign) :ignore)
74            (t (the (or function fixnum) (sb!kernel:make-lisp-obj result)))))))
75
76 (defun default-interrupt (signal)
77   (enable-interrupt signal :default))
78
79 (defun ignore-interrupt (signal)
80   (enable-interrupt signal :ignore))
81 \f
82 ;;;; default LISP signal handlers
83 ;;;;
84 ;;;; Most of these just call ERROR to report the presence of the signal.
85
86 ;;; SIGINT is handled like BREAK, except that ANSI BREAK ignores
87 ;;; *DEBUGGER-HOOK*, but we want SIGINT's BREAK to respect it, so that
88 ;;; SIGINT in --disable-debugger mode will cleanly terminate the system
89 ;;; (by respecting the *DEBUGGER-HOOK* established in that mode).
90 (defun sigint-%break (format-string &rest format-arguments)
91   (apply #'%break 'sigint format-string format-arguments))
92
93 (eval-when (:compile-toplevel :execute)
94   (sb!xc:defmacro define-signal-handler (name
95                                          what
96                                          &optional (function 'error))
97     `(defun ,name (signal info context)
98        (declare (ignore signal info))
99        (declare (type system-area-pointer context))
100        (/show "in Lisp-level signal handler" (sap-int context))
101        (,function ,(concatenate 'simple-string what " at #X~X")
102                   (with-alien ((context (* os-context-t) context))
103                     (sap-int (sb!vm:context-pc context)))))))
104
105 (define-signal-handler sigint-handler "interrupted" sigint-%break)
106 (define-signal-handler sigill-handler "illegal instruction")
107 (define-signal-handler sigtrap-handler "breakpoint/trap")
108 (define-signal-handler sigiot-handler "SIGIOT")
109 #!-linux
110 (define-signal-handler sigemt-handler "SIGEMT")
111 (define-signal-handler sigbus-handler "bus error")
112 (define-signal-handler sigsegv-handler "segmentation violation")
113 #!-linux
114 (define-signal-handler sigsys-handler "bad argument to a system call")
115 (define-signal-handler sigpipe-handler "SIGPIPE")
116
117 (defun sigalrm-handler (signal info context)
118   (declare (ignore signal info context))
119   (declare (type system-area-pointer context))
120   (cerror "Continue" 'sb!ext::timeout))
121
122 (defun sigquit-handler (signal code context)
123   (declare (ignore signal code context))
124   (throw 'sb!impl::toplevel-catcher nil))
125
126 (defun sb!kernel:signal-cold-init-or-reinit ()
127   #!+sb-doc
128   "Enable all the default signals that Lisp knows how to deal with."
129   (enable-interrupt sigint #'sigint-handler)
130   (enable-interrupt sigquit #'sigquit-handler)
131   (enable-interrupt sigill #'sigill-handler)
132   (enable-interrupt sigtrap #'sigtrap-handler)
133   (enable-interrupt sigiot #'sigiot-handler)
134   #!-linux
135   (enable-interrupt sigemt #'sigemt-handler)
136   (enable-interrupt sigfpe #'sb!vm:sigfpe-handler)
137   (enable-interrupt sigbus #'sigbus-handler)
138   (enable-interrupt sigsegv #'sigsegv-handler)
139   #!-linux
140   (enable-interrupt sigsys #'sigsys-handler)
141   (enable-interrupt sigpipe #'sigpipe-handler)
142   (enable-interrupt sigalrm #'sigalrm-handler)
143   (values))
144 \f
145 ;;;; etc.
146
147 ;;; CMU CL comment:
148 ;;;   Magically converted by the compiler into a break instruction.
149 (defun receive-pending-interrupt ()
150   (receive-pending-interrupt))
151 \f
152 ;;; stale code which I'm insufficiently motivated to test -- WHN 19990714
153 #|
154 ;;;; WITH-ENABLED-INTERRUPTS
155
156 (defmacro with-enabled-interrupts (interrupt-list &body body)
157   #!+sb-doc
158   "With-enabled-interrupts ({(interrupt function)}*) {form}*
159    Establish function as a handler for the Unix signal interrupt which
160    should be a number between 1 and 31 inclusive."
161   (let ((il (gensym))
162         (it (gensym)))
163     `(let ((,il NIL))
164        (unwind-protect
165            (progn
166              ,@(do* ((item interrupt-list (cdr item))
167                      (intr (caar item) (caar item))
168                      (ifcn (cadar item) (cadar item))
169                      (forms NIL))
170                     ((null item) (nreverse forms))
171                  (when (symbolp intr)
172                    (setq intr (symbol-value intr)))
173                  (push `(push `(,,intr ,(enable-interrupt ,intr ,ifcn)) ,il)
174                        forms))
175              ,@body)
176          (dolist (,it (nreverse ,il))
177            (enable-interrupt (car ,it) (cadr ,it)))))))
178 |#