Formerly hurd/hurd/signal.h.~17~
[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
42
43 /* Per-thread signal state.  */
44
45 struct hurd_sigstate
46   {
47     /* This mutex locks most of the rest of this structure.  It also acts
48        as a critical section lock for the thread (see below).  */
49     struct mutex lock;
50     int critical_section;
51
52     /* XXX This should perhaps instead be something that identifies
53        cthreads multiplexed on a single kernel thread.  */
54     thread_t thread;
55     struct hurd_sigstate *next; /* Linked-list of thread sigstates.  */
56
57     sigset_t blocked;
58     sigset_t pending;
59     struct sigaction actions[NSIG];
60     struct sigaltstack sigaltstack;
61     int sigcodes[NSIG];         /* Codes for pending signals.  */
62
63     /* If `suspended' is set when this thread gets a signal,
64        the signal thread clears it and then signals `arrived'.  */
65     int suspended;
66 #ifdef noteven
67     struct condition arrived;
68 #endif
69
70     /* Not locked.  Used only by this thread, or by the signal thread with
71        this thread suspended.  */
72     volatile mach_port_t intr_port; /* Port interruptible RPC was sent on.  */
73     volatile int intr_restart;  /* If nonzero, restart interrupted RPC.  */
74   };
75
76 /* Linked list of states of all threads whose state has been asked for.  */
77
78 extern struct hurd_sigstate *_hurd_sigstates;
79
80 extern struct mutex _hurd_siglock; /* Locks _hurd_sigstates.  */
81
82 /* Get the sigstate of a given thread, taking its lock.  */
83
84 extern struct hurd_sigstate *_hurd_thread_sigstate (thread_t);
85
86 /* Get the sigstate of the current thread, taking its lock.
87    This uses a per-thread variable to optimize the lookup.  */
88
89 #include <hurd/threadvar.h>
90 _EXTERN_INLINE struct hurd_sigstate *
91 _hurd_self_sigstate (void)
92 {
93   struct hurd_sigstate **location =
94     (void *) __hurd_threadvar_location (_HURD_THREADVAR_SIGSTATE);
95   if (*location)
96     __mutex_lock (&(*location)->lock);
97   else
98     *location = _hurd_thread_sigstate (__mach_thread_self ()); /* cproc_self */
99   return *location;
100 }
101 \f
102 /* Critical sections.
103
104    A critical section is a section of code which cannot safely be interrupted
105    to run a signal handler; for example, code that holds any lock cannot be
106    interrupted lest the signal handler try to take the same lock and
107    deadlock result.  Before entering a critical section, a thread must make
108    sure it holds its own sigstate lock.  The thread sets the
109    `critical_section' flag (which is not itself locked) to indicate the
110    lock is already held by the same thread.  Subroutines which contain
111    critical sections of their own then test this flag; if it is set, they
112    don't try to acquire the sigstate lock again, to avoid deadlock.  */
113
114 _EXTERN_INLINE void *
115 _hurd_critical_section_lock (void)
116 {
117   struct hurd_sigstate **location =
118     (void *) __hurd_threadvar_location (_HURD_THREADVAR_SIGSTATE);
119   struct hurd_sigstate *ss = *location;
120   if (ss == NULL)
121     /* The thread variable is unset; this must be the first time we've
122        asked for it.  In this case, the critical section flag cannot
123        possible already be set.  Look up our sigstate structure the slow
124        way; this locks the sigstate lock.  */
125     ss = *location = _hurd_thread_sigstate (__mach_thread_self ());
126   else
127     {
128       if (ss->critical_section)
129         /* Some caller higher up has already acquired the critical section
130            lock.  We need do nothing.  The null pointer we return will
131            make _hurd_critical_section_unlock (below) be a no-op.  */
132         return NULL;
133       /* Acquire the sigstate lock to prevent any signal from arriving.  */
134       __mutex_lock (&ss->lock);
135     }
136   /* Set the critical section flag so no later call will try to
137      take the sigstate lock while we already have it locked.  */
138   ss->critical_section = 1;
139   /* Return  */
140   return ss;
141 }
142
143 _EXTERN_INLINE void
144 _hurd_critical_section_unlock (void *our_lock)
145 {
146   if (our_lock == NULL)
147     /* The critical section lock was held when we began.  Do nothing.  */
148     return;
149   else
150     {
151       /* It was us who acquired the critical section lock.  Clear the
152          critical section flag and unlock the sigstate lock.  */
153       struct hurd_sigstate *ss = our_lock;
154       ss->critical_section = 0;
155       __mutex_unlock (&ss->lock);
156     }
157 }
158
159 /* Convenient macros for simple uses of critical sections.
160    These two must be used as a pair at the same C scoping level.  */
161
162 #define HURD_CRITICAL_BEGIN \
163   { void *__hurd_critical__ = _hurd_critical_section_lock ()
164 #define HURD_CRITICAL_END \
165       _hurd_critical_section_unlock (__hurd_critical__); } while (0)
166 \f
167 /* Thread listening on our message port; also called the "signal thread".  */
168
169 extern thread_t _hurd_msgport_thread;
170
171 /* Our message port.  We hold the receive right and _hurd_msgport_thread
172    listens for messages on it.  We also hold a send right, for convenience.  */
173
174 extern mach_port_t _hurd_msgport;
175
176
177 /* Thread to receive process-global signals.  */
178
179 extern thread_t _hurd_sigthread;
180
181
182 /* Resource limit on core file size.  Enforced by hurdsig.c.  */
183 extern int _hurd_core_limit;
184 \f
185 /* Initialize the signal code, and start the signal thread.  */
186
187 extern void _hurdsig_init (void);
188
189 /* Initialize proc server-assisted fault recovery for the signal thread.  */
190
191 extern void _hurdsig_fault_init (void);
192
193 /* Raise a signal as described by SIGNO and SIGCODE, on the thread whose
194    sigstate SS points to.  If SS is a null pointer, this instead affects
195    the calling thread.  */
196
197 extern void _hurd_raise_signal (struct hurd_sigstate *ss,
198                                 int signo, int sigcode);
199
200 /* Translate a Mach exception into a signal (machine-dependent).  */
201
202 extern void _hurd_exception2signal (int exception, int code, int subcode,
203                                     int *signo, int *sigcode);
204
205
206 /* Make the thread described by SS take the signal described by SIGNO and
207    SIGCODE.  When the signal can be considered delivered, sends a sig_post
208    reply message on REPLY_PORT indicating success.  SS->lock is held on
209    entry, and released before return.  */
210
211 extern void _hurd_internal_post_signal (struct hurd_sigstate *ss,
212                                         int signo, int sigcode,
213                                         mach_port_t reply_port,
214                                         mach_msg_type_name_t reply_port_type);
215
216 /* Set up STATE to handle signal SIGNO by running HANDLER.  FLAGS is the
217    `sa_flags' member from `struct sigaction'.  If the SA_ONSTACK bit is
218    set, *ALTSTACK describes the alternate signal stack to use.  The handler
219    is passed SIGNO, SIGCODE, and the returned `struct sigcontext' (which
220    resides on the stack the handler will use, and which describes the state
221    of the thread encoded in STATE before running the handler).  */
222
223 extern struct sigcontext *_hurd_setup_sighandler (int flags,
224                                                   __sighandler_t handler,
225                                                   struct sigaltstack *altstack,
226                                                   int signo, int sigcode,
227                                                   void *state);
228
229 /* Function run by the signal thread to receive from the signal port.  */
230
231 extern void _hurd_msgport_receive (void);
232
233 /* Return nonzero if STATE indicates a thread that is blocked in a mach_msg
234    system call (machine-dependent).  If returning nonzero, set *PORT to
235    the receive right that the thread is blocked on.  */
236
237 extern int _hurd_thread_state_msging_p (void *state, mach_port_t *port);
238
239 /* Set up STATE with a thread state that, when resumed, is
240    like `longjmp (_hurd_sigthread_fault_env, 1)'.  */
241
242 extern void _hurd_initialize_fault_recovery_state (void *state);
243
244
245 /* Function run for SIGINFO when its action is SIG_DFL and the current
246    process is the session leader.  */
247
248 extern void _hurd_siginfo_handler (int);
249
250
251 #ifdef notyet
252
253 /* Perform interruptible RPC CALL on PORT.
254    The args in CALL should be constant or local variable refs.
255    They may be evaluated many times, and must not change.
256    PORT must not be deallocated before this RPC is finished.  */
257 #define HURD_EINTR_RPC(port, call) \
258   ({
259     error_t __err;
260     struct hurd_sigstate *__ss = _hurd_self_sigstate ();
261     __mutex_unlock (&__ss->lock); /* Lock not needed.  */
262     /* If we get a signal and should return EINTR, the signal thread will
263        clear this.  The RPC might return EINTR when some other thread gets
264        a signal, in which case we want to restart our call.  */
265     __ss->intr_restart = 1;
266     /* This one needs to be last.  A signal can arrive before here,
267        and if intr_port were set before intr_restart is
268        initialized, the signal thread would get confused.  */
269     __ss->intr_port = (port);
270     /* A signal may arrive here, after intr_port is set,
271        but before the mach_msg system call.  The signal handler might do an
272        interruptible RPC, and clobber intr_port; then it would not be set
273        properly when we actually did send the RPC, and a later signal
274        wouldn't interrupt that RPC.  So, _hurd_run_sighandler saves
275        intr_port in the sigcontext, and sigreturn restores it.  */
276   __do_call:
277     switch (__err = (call))
278       {
279       case EINTR:               /* RPC went out and was interrupted.  */
280       case MACH_SEND_INTERRUPTED: /* RPC didn't get out.  */
281         if (__ss->intr_restart)
282           /* Restart the interrupted call.  */
283           goto __do_call;
284         /* FALLTHROUGH */
285       case MACH_RCV_PORT_DIED:
286         /* Server didn't respond to interrupt_operation,
287            so the signal thread destroyed the reply port.  */
288         __err = EINTR;
289         break;
290       }
291     __ss->intr_port = MACH_PORT_NULL;
292     __err;
293   })
294
295 #endif /* notyet */
296
297 /* Mask of signals that cannot be caught, blocked, or ignored.  */
298 #define _SIG_CANT_MASK  (__sigmask (SIGSTOP) | __sigmask (SIGKILL))
299
300 /* Do an RPC to a process's message port.
301
302    Each argument is an expression which returns an error code; each
303    expression may be evaluated several times.  FETCH_MSGPORT_EXPR should
304    fetch the appropriate message port and store it in the local variable
305    `msgport'.  FETCH_REFPORT_EXPR should fetch the appropriate message port
306    and store it in the local variable `refport' (if no reference port is
307    needed in the call, then FETCH_REFPORT_EXPR should be simply
308    KERN_SUCCESS or 0).  Both of these are assumed to create user
309    references, which this macro deallocates.  RPC_EXPR should perform the
310    desired RPC operation using `msgport' and `refport'.
311
312    The reason for the complexity is that a process's message port and
313    reference port may change between fetching those ports and completing an
314    RPC using them (usually they change only when a process execs).  The RPC
315    will fail with MACH_SEND_INVALID_DEST if the msgport dies before we can
316    send the RPC request; or with MIG_SERVER_DIED if the msgport was
317    destroyed after we sent the RPC request but before it was serviced.  In
318    either of these cases, we retry the entire operation, discarding the old
319    message and reference ports and fetch them anew.  */
320
321 #define HURD_MSGPORT_RPC(fetch_msgport_expr, fetch_refport_expr, rpc_expr)   \
322 ({                                                                            \
323     error_t __err;                                                            \
324     mach_port_t msgport, refport = MACH_PORT_NULL;                            \
325     do                                                                        \
326       {                                                                       \
327         /* Get the message port.  */                                          \
328         if (__err = (fetch_msgport_expr))                                     \
329           break;                                                              \
330         /* Get the reference port.  */                                        \
331         if (__err = (fetch_refport_expr))                                     \
332           {                                                                   \
333             /* Couldn't get it; deallocate MSGPORT and fail.  */              \
334             __mach_port_deallocate (__mach_task_self (), msgport);            \
335             break;                                                            \
336           }                                                                   \
337         __err = (rpc_expr);                                                   \
338         __mach_port_deallocate (__mach_task_self (), msgport);                \
339         if (refport != MACH_PORT_NULL)                                        \
340           __mach_port_deallocate (__mach_task_self (), refport);              \
341       } while (__err == MACH_SEND_INVALID_DEST ||                             \
342                __err == MIG_SERVER_DIED);                                     \
343     __err;                                                                    \
344 })
345 \f
346 /* Some other parts of the library need to preempt signals, to detect
347    errors that should not result in a POSIX signal.  For example, when
348    some mapped region of memory is used, an extraneous SIGSEGV might be
349    generated when the mapping server returns an error for a page fault.  */
350
351 struct hurd_signal_preempt
352   {
353     /* Function to examine a thread receiving a given signal.  The handler
354        is called even for blocked signals.  This function is run in the
355        signal thread, with THREAD's sigstate locked; it should be as simple
356        and robust as possible.  THREAD is the thread which is about to
357        receive the signal.  SIGNO and SIGCODE would be passed to the normal
358        handler.
359
360        If the return value is SIG_DFL, normal signal processing continues.
361        If it is SIG_IGN, the signal is ignored.
362        Any other value is used in place of the normal handler.  */
363     sighandler_t (*handler) (thread_t thread, int signo, int sigcode);
364     int first, last;            /* Range of sigcodes this handler wants.  */
365     struct hurd_signal_preempt *next; /* Next handler on the chain. */
366   };
367
368 extern struct hurd_signal_preempt *_hurd_signal_preempt[NSIG];
369 extern struct mutex _hurd_signal_preempt_lock;
370
371
372 #endif  /* hurd/signal.h */