(_hurd_priority_which_map): Declare it.
[kopensolaris-gnu/glibc.git] / hurd / hurd / signal.h
1 /* Implementing POSIX.1 signals under the Hurd.
2 Copyright (C) 1993, 1994 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with the GNU C Library; see the file COPYING.LIB.  If
17 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
18 Cambridge, MA 02139, USA.  */
19
20 #ifndef _HURD_SIGNAL_H
21
22 #define _HURD_SIGNAL_H  1
23 #include <features.h>
24 /* Make sure <signal.h> is going to define NSIG.  */
25 #ifndef __USE_GNU
26 #error "Must have `_GNU_SOURCE' feature test macro to use this file"
27 #endif
28
29 #define __need_NULL
30 #include <stddef.h>
31
32 #include <mach/mach_types.h>
33 #include <mach/port.h>
34 #include <mach/message.h>
35 #include <hurd/hurd_types.h>
36 #include <signal.h>
37 #include <errno.h>
38
39 #include <cthreads.h>           /* For `struct mutex'.  */
40 #include <lock-intern.h>
41 #include <hurd/threadvar.h>     /* We cache sigstate in a threadvar.  */
42
43
44 /* Per-thread signal state.  */
45
46 struct hurd_sigstate
47   {
48     /* This mutex locks most of the rest of this structure.  It also acts
49        as a critical section lock for the thread (see below).  */
50     struct mutex lock;
51     int critical_section;
52
53     /* XXX This should perhaps instead be something that identifies
54        cthreads multiplexed on a single kernel thread.  */
55     thread_t thread;
56     struct hurd_sigstate *next; /* Linked-list of thread sigstates.  */
57
58     sigset_t blocked;
59     sigset_t pending;
60     struct sigaction actions[NSIG];
61     struct sigaltstack sigaltstack;
62     struct
63       {
64         /* For each signal that may be pending, the
65            sigcode and error code to deliver it with.  */
66         int code, error;
67       } pending_data[NSIG];
68
69     /* If `suspended' is set when this thread gets a signal,
70        the signal thread sends an empty message to it.  */
71     mach_port_t suspended;
72
73     /* Not locked.  Used only by this thread, or by the signal thread with
74        this thread suspended.  */
75     volatile mach_port_t intr_port; /* Port interruptible RPC was sent on.  */
76
77     /* If this is not null, the thread is in sigreturn awaiting delivery of
78        pending signals.  This context (the machine-dependent portions only)
79        will be passed to sigreturn after running the handler for a pending
80        signal, instead of examining the thread state.  */
81     struct sigcontext *context;
82   };
83
84 /* Linked list of states of all threads whose state has been asked for.  */
85
86 extern struct hurd_sigstate *_hurd_sigstates;
87
88 extern struct mutex _hurd_siglock; /* Locks _hurd_sigstates.  */
89
90 /* Get the sigstate of a given thread, taking its lock.  */
91
92 extern struct hurd_sigstate *_hurd_thread_sigstate (thread_t);
93
94 /* Get the sigstate of the current thread, taking its lock.
95    This uses a per-thread variable to optimize the lookup.  */
96
97 _EXTERN_INLINE struct hurd_sigstate *
98 _hurd_self_sigstate_unlocked (void)
99 {
100   struct hurd_sigstate **location =
101     (void *) __hurd_threadvar_location (_HURD_THREADVAR_SIGSTATE);
102   if (! *location)
103     {
104       *location = _hurd_thread_sigstate (__mach_thread_self ());
105       __mutex_unlock (&(*location)->lock);
106     }
107   return *location;
108 }
109
110 _EXTERN_INLINE struct hurd_sigstate *
111 _hurd_self_sigstate (void)
112 {
113   struct hurd_sigstate **location =
114     (void *) __hurd_threadvar_location (_HURD_THREADVAR_SIGSTATE);
115   if (*location)
116     __mutex_lock (&(*location)->lock);
117   else
118     *location = _hurd_thread_sigstate (__mach_thread_self ());
119   return *location;
120 }
121 \f
122 /* Critical sections.
123
124    A critical section is a section of code which cannot safely be interrupted
125    to run a signal handler; for example, code that holds any lock cannot be
126    interrupted lest the signal handler try to take the same lock and
127    deadlock result.  Before entering a critical section, a thread must make
128    sure it holds its own sigstate lock.  The thread sets the
129    `critical_section' flag (which is not itself locked) to indicate the
130    lock is already held by the same thread.  Subroutines which contain
131    critical sections of their own then test this flag; if it is set, they
132    don't try to acquire the sigstate lock again, to avoid deadlock.  */
133
134 _EXTERN_INLINE void *
135 _hurd_critical_section_lock (void)
136 {
137   struct hurd_sigstate **location =
138     (void *) __hurd_threadvar_location (_HURD_THREADVAR_SIGSTATE);
139   struct hurd_sigstate *ss = *location;
140   if (ss == NULL)
141     /* The thread variable is unset; this must be the first time we've
142        asked for it.  In this case, the critical section flag cannot
143        possible already be set.  Look up our sigstate structure the slow
144        way; this locks the sigstate lock.  */
145     ss = *location = _hurd_thread_sigstate (__mach_thread_self ());
146   else
147     {
148       if (ss->critical_section)
149         /* Some caller higher up has already acquired the critical section
150            lock.  We need do nothing.  The null pointer we return will
151            make _hurd_critical_section_unlock (below) be a no-op.  */
152         return NULL;
153       /* Acquire the sigstate lock to prevent any signal from arriving.  */
154       __mutex_lock (&ss->lock);
155     }
156   /* Set the critical section flag so no later call will try to
157      take the sigstate lock while we already have it locked.  */
158   ss->critical_section = 1;
159   /* Return our sigstate pointer; this will be passed to
160      _hurd_critical_section_unlock to clear the critical section flag. */
161   return ss;
162 }
163
164 _EXTERN_INLINE void
165 _hurd_critical_section_unlock (void *our_lock)
166 {
167   if (our_lock == NULL)
168     /* The critical section lock was held when we began.  Do nothing.  */
169     return;
170   else
171     {
172       /* It was us who acquired the critical section lock.  Clear the
173          critical section flag and unlock the sigstate lock.  */
174       struct hurd_sigstate *ss = our_lock;
175       ss->critical_section = 0;
176       __mutex_unlock (&ss->lock);
177     }
178 }
179
180 /* Convenient macros for simple uses of critical sections.
181    These two must be used as a pair at the same C scoping level.  */
182
183 #define HURD_CRITICAL_BEGIN \
184   { void *__hurd_critical__ = _hurd_critical_section_lock ()
185 #define HURD_CRITICAL_END \
186       _hurd_critical_section_unlock (__hurd_critical__); } while (0)
187 \f
188 /* Thread listening on our message port; also called the "signal thread".  */
189
190 extern thread_t _hurd_msgport_thread;
191
192 /* Our message port.  We hold the receive right and _hurd_msgport_thread
193    listens for messages on it.  We also hold a send right, for convenience.  */
194
195 extern mach_port_t _hurd_msgport;
196
197
198 /* Thread to receive process-global signals.  */
199
200 extern thread_t _hurd_sigthread;
201
202
203 /* Resource limit on core file size.  Enforced by hurdsig.c.  */
204 extern int _hurd_core_limit;
205 \f
206 /* Initialize the signal code, and start the signal thread.  */
207
208 extern void _hurdsig_init (void);
209
210 /* Initialize proc server-assisted fault recovery for the signal thread.  */
211
212 extern void _hurdsig_fault_init (void);
213
214 /* Raise a signal as described by SIGNO, SIGCODE and SIGERROR, on the
215    thread whose sigstate SS points to.  If SS is a null pointer, this
216    instead affects the calling thread.  */
217
218 extern void _hurd_raise_signal (struct hurd_sigstate *ss,
219                                 int signo, int sigcode, int sigerror);
220
221 /* Translate a Mach exception into a signal (machine-dependent).  */
222
223 extern void _hurd_exception2signal (int exception, int code, int subcode,
224                                     int *signo, int *sigcode, int *error);
225
226
227 /* Make the thread described by SS take the signal described by SIGNO and
228    SIGCODE.  When the signal can be considered delivered, sends a sig_post
229    reply message on REPLY_PORT indicating success.  SS->lock is held on
230    entry, and released before return.  */
231
232 extern void _hurd_internal_post_signal (struct hurd_sigstate *ss,
233                                         int signo, int sigcode, int error,
234                                         mach_port_t reply_port,
235                                         mach_msg_type_name_t reply_port_type);
236
237 /* Set up STATE and SS to handle signal SIGNO by running HANDLER.  If
238    RPC_WAIT is nonzero, the thread needs to wait for a pending RPC to
239    finish before running the signal handler.  The handler is passed SIGNO,
240    SIGCODE, and the returned `struct sigcontext' (which resides on the
241    stack the handler will use, and which describes the state of the thread
242    encoded in STATE before running the handler).  */
243
244 struct machine_thread_all_state;
245 extern struct sigcontext *
246 _hurd_setup_sighandler (struct hurd_sigstate *ss, __sighandler_t handler,
247                         int signo, int sigcode,
248                         int rpc_wait, struct machine_thread_all_state *state);
249
250 /* Function run by the signal thread to receive from the signal port.  */
251
252 extern void _hurd_msgport_receive (void);
253
254 /* STATE describes a thread that had intr_port set (meaning it was inside
255    HURD_EINTR_RPC), after it has been thread_abort'd.  It it looks to have
256    just completed a mach_msg_trap system call that returned
257    MACH_RCV_INTERRUPTED, return nonzero and set *PORT to the receive right
258    being waited on.  */
259
260 extern int _hurdsig_rcv_interrupted_p (struct machine_thread_all_state *state,
261                                        mach_port_t *port);
262
263 /* Set up STATE with a thread state that, when resumed, is
264    like `longjmp (_hurd_sigthread_fault_env, 1)'.  */
265
266 extern void _hurd_initialize_fault_recovery_state (void *state);
267
268
269 /* Function run for SIGINFO when its action is SIG_DFL and the current
270    process is the session leader.  */
271
272 extern void _hurd_siginfo_handler (int);
273
274
275 /* Perform interruptible RPC CALL on PORT.
276    The call should use 
277    The args in CALL should be constant or local variable refs.
278    They may be evaluated many times, and must not change.
279    PORT must not be deallocated before this RPC is finished.  */
280 #define HURD_EINTR_RPC(port, call)                                            \
281   ({                                                                          \
282     __label__ __do_call;        /* Give this label block scope.  */           \
283     error_t __err;                                                            \
284     struct hurd_sigstate *__ss = _hurd_self_sigstate_unlocked ();             \
285     __do_call:                                                                \
286     /* Tell the signal thread that we are doing an interruptible RPC on       \
287        this port.  If we get a signal and should return EINTR, the signal     \
288        thread will set this variable to MACH_PORT_NULL.  The RPC might        \
289        return EINTR when some other thread gets a signal, in which case we    \
290        want to restart our call.  */                                          \
291     __ss->intr_port = (port);                                                 \
292     /* A signal may arrive here, after intr_port is set, but before the       \
293        mach_msg system call.  The signal handler might do an interruptible    \
294        RPC, and clobber intr_port; then it would not be set properly when     \
295        we actually did send the RPC, and a later signal wouldn't interrupt    \
296        that RPC.  So, _hurd_setup_sighandler saves intr_port in the           \
297        sigcontext, and sigreturn restores it.  */                             \
298     switch (__err = (call))                                                   \
299       {                                                                       \
300       case EINTR:               /* RPC went out and was interrupted.  */      \
301       case MACH_SEND_INTERRUPTED: /* RPC didn't get out.  */                  \
302         if (__ss->intr_port != MACH_PORT_NULL)                                \
303           /* If this signal was for us and it should interrupt calls, the     \
304              signal thread will have cleared SS->intr_port.  Since it's not   \
305              cleared, the signal was for another thread, or SA_RESTART is     \
306              set.  Restart the interrupted call.  */                          \
307           goto __do_call;                                                     \
308         /* FALLTHROUGH */                                                     \
309       case MACH_RCV_PORT_DIED:                                                \
310         /* Server didn't respond to interrupt_operation,                      \
311            so the signal thread destroyed the reply port.  */                 \
312         __err = EINTR;                                                        \
313         break;                                                                \
314       default:                  /* Quiet -Wswitch-enum.  */                   \
315       }                                                                       \
316     __ss->intr_port = MACH_PORT_NULL;                                         \
317     __err;                                                                    \
318   })                                                                          \
319
320
321 /* Mask of signals that cannot be caught, blocked, or ignored.  */
322 #define _SIG_CANT_MASK  (__sigmask (SIGSTOP) | __sigmask (SIGKILL))
323
324 /* Do an RPC to a process's message port.
325
326    Each argument is an expression which returns an error code; each
327    expression may be evaluated several times.  FETCH_MSGPORT_EXPR should
328    fetch the appropriate message port and store it in the local variable
329    `msgport'.  FETCH_REFPORT_EXPR should fetch the appropriate message port
330    and store it in the local variable `refport' (if no reference port is
331    needed in the call, then FETCH_REFPORT_EXPR should be simply
332    KERN_SUCCESS or 0).  Both of these are assumed to create user
333    references, which this macro deallocates.  RPC_EXPR should perform the
334    desired RPC operation using `msgport' and `refport'.
335
336    The reason for the complexity is that a process's message port and
337    reference port may change between fetching those ports and completing an
338    RPC using them (usually they change only when a process execs).  The RPC
339    will fail with MACH_SEND_INVALID_DEST if the msgport dies before we can
340    send the RPC request; or with MIG_SERVER_DIED if the msgport was
341    destroyed after we sent the RPC request but before it was serviced.  In
342    either of these cases, we retry the entire operation, discarding the old
343    message and reference ports and fetch them anew.  */
344
345 #define HURD_MSGPORT_RPC(fetch_msgport_expr, fetch_refport_expr, rpc_expr)   \
346 ({                                                                            \
347     error_t __err;                                                            \
348     mach_port_t msgport, refport = MACH_PORT_NULL;                            \
349     do                                                                        \
350       {                                                                       \
351         /* Get the message port.  */                                          \
352         if (__err = (fetch_msgport_expr))                                     \
353           break;                                                              \
354         /* Get the reference port.  */                                        \
355         if (__err = (fetch_refport_expr))                                     \
356           {                                                                   \
357             /* Couldn't get it; deallocate MSGPORT and fail.  */              \
358             __mach_port_deallocate (__mach_task_self (), msgport);            \
359             break;                                                            \
360           }                                                                   \
361         __err = (rpc_expr);                                                   \
362         __mach_port_deallocate (__mach_task_self (), msgport);                \
363         if (refport != MACH_PORT_NULL)                                        \
364           __mach_port_deallocate (__mach_task_self (), refport);              \
365       } while (__err == MACH_SEND_INVALID_DEST ||                             \
366                __err == MIG_SERVER_DIED);                                     \
367     __err;                                                                    \
368 })
369 \f
370 /* Some other parts of the library need to preempt signals, to detect
371    errors that should not result in a POSIX signal.  For example, when
372    some mapped region of memory is used, an extraneous SIGSEGV might be
373    generated when the mapping server returns an error for a page fault.  */
374
375 struct hurd_signal_preempt
376   {
377     /* Function to examine a thread receiving a given signal.  The handler
378        is called even for blocked signals.  This function is run in the
379        signal thread, with THREAD's sigstate locked; it should be as simple
380        and robust as possible.  THREAD is the thread which is about to
381        receive the signal.  SIGNO and SIGCODE would be passed to the normal
382        handler.
383
384        If the return value is SIG_DFL, normal signal processing continues.
385        If it is SIG_IGN, the signal is ignored.
386        Any other value is used in place of the normal handler.  */
387     sighandler_t (*handler) (thread_t thread, int signo, int sigcode);
388     int first, last;            /* Range of sigcodes this handler wants.  */
389     struct hurd_signal_preempt *next; /* Next handler on the chain. */
390   };
391
392 extern struct hurd_signal_preempt *_hurd_signal_preempt[NSIG];
393 extern struct mutex _hurd_signal_preempt_lock;
394
395
396 #endif  /* hurd/signal.h */