Formerly hurd/hurd/signal.h.~9~
[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 <mutex.h>
40 #include <lock-intern.h>
41
42
43 /* Per-thread signal state.  */
44
45 struct hurd_sigstate
46   {
47     /* XXX should be in cthread variable (?) */
48     thread_t thread;
49     struct hurd_sigstate *next; /* Linked-list of thread sigstates.  */
50
51     struct mutex lock;          /* Locks the rest of this structure.  */
52     sigset_t blocked;
53     sigset_t pending;
54     struct sigaction actions[NSIG];
55     struct sigaltstack sigaltstack;
56     int sigcodes[NSIG];         /* Codes for pending signals.  */
57
58     int suspended;              /* If nonzero, sig_post signals `arrived'.  */
59 #ifdef noteven
60     struct condition arrived;
61 #endif
62
63 #if 0
64     int vforked;                /* Nonzero if this thread is a vfork child.  */
65     struct
66       {
67         process_t proc;
68         file_t ccdir, cwdir, crdir, auth;
69         mode_t umask;
70         int ctty_fstype;
71         fsid_t ctty_fsid;
72         ino_t ctty_fileid;
73         struct hurd_dtable *dtable;
74         jmp_buf continuation;
75       } *vfork_saved;
76 #endif
77
78     /* Not locked.  Used only by this thread,
79        or by signal thread with this thread suspended.  */
80     volatile mach_port_t intr_port; /* Port interruptible RPC was sent on.  */
81     volatile int intr_restart;  /* If nonzero, restart interrupted RPC.  */
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 \f
94 /* Thread listening on our message port; also called the "signal thread".  */
95
96 extern thread_t _hurd_msgport_thread;
97
98 /* Our message port.  We hold the receive right and _hurd_msgport_thread
99    listens for messages on it.  We also hold a send right, for convenience.  */
100
101 extern mach_port_t _hurd_msgport;
102
103
104 /* Thread to receive process-global signals.  */
105
106 extern thread_t _hurd_sigthread;
107
108
109 /* Resource limit on core file size.  Enforced by hurdsig.c.  */
110 extern int _hurd_core_limit;
111 \f
112 /* Translate a Mach exception into a signal (machine-dependent).  */
113
114 extern void _hurd_exception2signal (int exception, int code, int subcode,
115                                     int *signo, int *sigcode);
116
117
118 /* Make the thread described by SS take the signal described by SIGNO and
119    SIGCODE.  SS->lock is held on entry, and released before return.  */
120
121 extern void _hurd_internal_post_signal (struct hurd_sigstate *ss,
122                                         int signo, int sigcode);
123
124 /* Set up STATE to handle signal SIGNO by running HANDLER.  FLAGS is the
125    `sa_flags' member from `struct sigaction'.  If the SA_ONSTACK bit is
126    set, *ALTSTACK describes the alternate signal stack to use.  The handler
127    is passed SIGNO, SIGCODE, and the returned `struct sigcontext' (which
128    resides on the stack the handler will use, and which describes the state
129    of the thread encoded in STATE before running the handler).  */
130
131 extern struct sigcontext *_hurd_setup_sighandler (int flags,
132                                                   __sighandler_t handler,
133                                                   struct sigaltstack *altstack,
134                                                   int signo, int sigcode,
135                                                   void *state);
136
137 /* Function run by the signal thread to receive from the signal port.  */
138
139 extern void _hurd_msgport_receive (void);
140
141 /* Return nonzero if STATE indicates a thread that is blocked in a mach_msg
142    system call (machine-dependent).  */
143
144 extern int _hurd_thread_state_msging_p (void *state);
145
146 /* Start THREAD running FUNCTION (machine-dependent).  */
147
148 extern kern_return_t _hurd_start_sigthread (thread_t thread,
149                                             void (*function) (void));
150
151 /* Set up STATE with a thread state that, when resumed, is
152    like `longjmp (_hurd_sigthread_fault_env, 1)'.  */
153
154 extern void _hurd_initialize_fault_recovery_state (void *state);
155
156
157 /* Function run for SIGINFO when its action is SIG_DFL and the current
158    process is the session leader.  */
159
160 extern void _hurd_siginfo_handler (int);
161
162
163 #ifdef notyet
164
165 /* Perform interruptible RPC CALL on PORT.
166    The args in CALL should be constant or local variable refs.
167    They may be evaluated many times, and must not change.
168    PORT must not be deallocated before this RPC is finished.  */
169 #define HURD_EINTR_RPC(port, call) \
170   ({
171     error_t __err;
172     struct hurd_sigstate *__ss
173       = _hurd_thread_sigstate (__mach_thread_self ());
174     __mutex_unlock (&__ss->lock); /* Lock not needed.  */
175     /* If we get a signal and should return EINTR, the signal thread will
176        clear this.  The RPC might return EINTR when some other thread gets
177        a signal, in which case we want to restart our call.  */
178     __ss->intr_restart = 1;
179     /* This one needs to be last.  A signal can arrive before here,
180        and if intr_port were set before intr_restart is
181        initialized, the signal thread would get confused.  */
182     __ss->intr_port = (port);
183     /* A signal may arrive here, after intr_port is set,
184        but before the mach_msg system call.  The signal handler might do an
185        interruptible RPC, and clobber intr_port; then it would not be set
186        properly when we actually did send the RPC, and a later signal
187        wouldn't interrupt that RPC.  So, _hurd_run_sighandler saves
188        intr_port in the sigcontext, and sigreturn restores it.  */
189   __do_call:
190     switch (__err = (call))
191       {
192       case EINTR:               /* RPC went out and was interrupted.  */
193       case MACH_SEND_INTERRUPTED: /* RPC didn't get out.  */
194         if (__ss->intr_restart)
195           /* Restart the interrupted call.  */
196           goto __do_call;
197         /* FALLTHROUGH */
198       case MACH_RCV_PORT_DIED:
199         /* Server didn't respond to interrupt_operation,
200            so the signal thread destroyed the reply port.  */
201         __err = EINTR;
202         break;
203       }
204     __ss->intr_port = MACH_PORT_NULL;
205     __err;
206   })
207
208 #endif /* notyet */
209
210 /* Mask of signals that cannot be caught, blocked, or ignored.  */
211 #define _SIG_CANT_MASK  (__sigmask (SIGSTOP) | __sigmask (SIGKILL))
212
213 /* Do an RPC to a process's message port.
214
215    Each argument is an expression which returns an error code; each
216    expression may be evaluated several times.  FETCH_MSGPORT_EXPR should
217    fetch the appropriate message port and store it in the local variable
218    `msgport'.  FETCH_REFPORT_EXPR should fetch the appropriate message port
219    and store it in the local variable `refport' (if no reference port is
220    needed in the call, then FETCH_REFPORT_EXPR should be simply
221    KERN_SUCCESS or 0).  Both of these are assumed to create user
222    references, which this macro deallocates.  RPC_EXPR should perform the
223    desired RPC operation using `msgport' and `refport'.
224
225    The reason for the complexity is that a process's message port and
226    reference port may change between fetching those ports and completing an
227    RPC using them (usually they change only when a process execs).  The RPC
228    will fail with MACH_SEND_INVALID_DEST if the msgport dies before we can
229    send the RPC request; or with MIG_SERVER_DIED if the msgport was
230    destroyed after we sent the RPC request but before it was serviced.  In
231    either of these cases, we retry the entire operation, discarding the old
232    message and reference ports and fetch them anew.  */
233
234 #define HURD_MSGPORT_RPC(fetch_msgport_expr, fetch_refport_expr, rpc_expr)   \
235 ({                                                                            \
236     error_t __err;                                                            \
237     mach_port_t msgport, refport = MACH_PORT_NULL;                            \
238     do                                                                        \
239       {                                                                       \
240         /* Get the message port.  */                                          \
241         if (__err = (fetch_msgport_expr))                                     \
242           break;                                                              \
243         /* Get the reference port.  */                                        \
244         if (__err = (fetch_refport_expr))                                     \
245           {                                                                   \
246             /* Couldn't get it; deallocate MSGPORT and fail.  */              \
247             __mach_port_deallocate (__mach_task_self (), msgport);            \
248             break;                                                            \
249           }                                                                   \
250         __err = (rpc_expr);                                                   \
251         __mach_port_deallocate (__mach_task_self (), msgport);                \
252         if (refport != MACH_PORT_NULL)                                        \
253           __mach_port_deallocate (__mach_task_self (), refport);              \
254       } while (__err != MACH_SEND_INVALID_DEST &&                             \
255                __err != MIG_SERVER_DIED);                                     \
256     __err;                                                                    \
257 })
258 \f
259 /* Some other parts of the library need to preempt signals, to detect
260    errors that should not result in a POSIX signal.  For example, when
261    some mapped region of memory is used, an extraneous SIGSEGV might be
262    generated when the mapping server returns an error for a page fault.  */
263
264 struct hurd_signal_preempt
265   {
266     /* Function to examine a thread receiving a given signal.  The handler
267        is called even for blocked signals.  This function is run in the
268        signal thread, with THREAD's sigstate locked; it should be as simple
269        and robust as possible.  THREAD is the thread which is about to
270        receive the signal.  SIGNO and SIGCODE would be passed to the normal
271        handler.
272
273        If the return value is SIG_DFL, normal signal processing continues.
274        If it is SIG_IGN, the signal is ignored.
275        Any other value is used in place of the normal handler.  */
276     sighandler_t (*handler) (thread_t thread, int signo, int sigcode);
277     int first, last;            /* Range of sigcodes this handler wants.  */
278     struct hurd_signal_preempt *next; /* Next handler on the chain. */
279   };
280
281 extern struct hurd_signal_preempt *_hurd_signal_preempt[NSIG];
282 extern struct mutex _hurd_signal_preempt_lock;
283
284
285 #ifndef _EXTERN_INLINE
286 #define _EXTERN_INLINE extern __inline
287 #endif
288
289 /* Initialize PREEMPTER with the information given and stick it in the
290    chain of preempters for SIGNO.  */
291
292 _EXTERN_INLINE int
293 hurd_preempt_signals (struct hurd_signal_preempt *preempter,
294                       int signo, int first_code, int last_code,
295                       sighandler_t (*handler) (thread_t, int, int))
296 {
297   if (signo <= 0 || signo >= NSIG)
298     {
299       errno = EINVAL;
300       return -1;
301     }
302   preempter->first = first_code;
303   preempter->last = last_code;
304   preempter->handler = handler;
305   __mutex_lock (&_hurd_signal_preempt_lock);
306   preempter->next = _hurd_signal_preempt[signo];
307   _hurd_signal_preempt[signo] = preempter;
308   __mutex_unlock (&_hurd_signal_preempt_lock);
309   return 0;
310 }
311
312 /* Remove PREEMPTER from the chain for SIGNO.  */
313
314 _EXTERN_INLINE int
315 hurd_unpreempt_signals (struct hurd_signal_preempt *preempter, int signo)
316 {
317   struct hurd_signal_preempt *p, *lastp;
318   if (signo <= 0 || signo >= NSIG)
319     {
320       errno = EINVAL;
321       return -1;
322     }
323   __mutex_lock (&_hurd_signal_preempt_lock);
324   for (p = _hurd_signal_preempt[signo], lastp = NULL;
325        p != NULL; lastp = p, p = p->next)
326     if (p == preempter)
327       {
328         (lastp == NULL ? _hurd_signal_preempt[signo] : lastp->next) = p->next;
329         __mutex_unlock (&_hurd_signal_preempt_lock);
330         return 0;
331       }
332   _hurd_signal_preempt[signo] = preempter;
333   __mutex_unlock (&_hurd_signal_preempt_lock);
334   errno = ENOENT;
335   return -1;
336 }
337
338
339 #endif  /* hurd/signal.h */