kernel - Refactor the lwkt_token code, making it faster
[dragonfly.git] / sys / sys / signal.h
1 /*
2  * Copyright (c) 1982, 1986, 1989, 1991, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the University of
21  *      California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *      @(#)signal.h    8.4 (Berkeley) 5/4/95
39  * $FreeBSD: src/sys/sys/signal.h,v 1.23.2.2 2001/04/19 01:38:35 alfred Exp $
40  * $DragonFly: src/sys/sys/signal.h,v 1.6 2007/01/14 07:59:08 dillon Exp $
41  */
42
43 #ifndef _SYS_SIGNAL_H_
44 #define _SYS_SIGNAL_H_
45
46 #ifndef _MACHINE_STDINT_H_
47 #include <machine/stdint.h>     /* for __ types */
48 #endif
49 #include <sys/cdefs.h>
50 #include <sys/_posix.h>
51
52 /*
53  * sigset_t macros.
54  */
55 #define _SIG_WORDS      4
56 #define _SIG_MAXSIG     128
57 #define _SIG_IDX(sig)   ((sig) - 1)
58 #define _SIG_WORD(sig)  (_SIG_IDX(sig) >> 5)
59 #define _SIG_BIT(sig)   (1 << (_SIG_IDX(sig) & 31))
60 #define _SIG_VALID(sig) ((sig) < _SIG_MAXSIG && (sig) > 0)
61
62 /*
63  * System defined signals.
64  */
65 #define SIGHUP          1       /* hangup */
66 #define SIGINT          2       /* interrupt */
67 #define SIGQUIT         3       /* quit */
68 #define SIGILL          4       /* illegal instr. (not reset when caught) */
69 #ifndef _POSIX_SOURCE
70 #define SIGTRAP         5       /* trace trap (not reset when caught) */
71 #endif
72 #define SIGABRT         6       /* abort() */
73 #ifndef _POSIX_SOURCE
74 #define SIGIOT          SIGABRT /* compatibility */
75 #define SIGEMT          7       /* EMT instruction */
76 #endif
77 #define SIGFPE          8       /* floating point exception */
78 #define SIGKILL         9       /* kill (cannot be caught or ignored) */
79 #ifndef _POSIX_SOURCE
80 #define SIGBUS          10      /* bus error */
81 #endif
82 #define SIGSEGV         11      /* segmentation violation */
83 #ifndef _POSIX_SOURCE
84 #define SIGSYS          12      /* non-existent system call invoked */
85 #endif
86 #define SIGPIPE         13      /* write on a pipe with no one to read it */
87 #define SIGALRM         14      /* alarm clock */
88 #define SIGTERM         15      /* software termination signal from kill */
89 #ifndef _POSIX_SOURCE
90 #define SIGURG          16      /* urgent condition on IO channel */
91 #endif
92 #define SIGSTOP         17      /* sendable stop signal not from tty */
93 #define SIGTSTP         18      /* stop signal from tty */
94 #define SIGCONT         19      /* continue a stopped process */
95 #define SIGCHLD         20      /* to parent on child stop or exit */
96 #define SIGTTIN         21      /* to readers pgrp upon background tty read */
97 #define SIGTTOU         22      /* like TTIN if (tp->t_local&LTOSTOP) */
98 #ifndef _POSIX_SOURCE
99 #define SIGIO           23      /* input/output possible signal */
100 #define SIGXCPU         24      /* exceeded CPU time limit */
101 #define SIGXFSZ         25      /* exceeded file size limit */
102 #define SIGVTALRM       26      /* virtual time alarm */
103 #define SIGPROF         27      /* profiling time alarm */
104 #define SIGWINCH        28      /* window size changes */
105 #define SIGINFO         29      /* information request */
106 #endif
107 #define SIGUSR1         30      /* user defined signal 1 */
108 #define SIGUSR2         31      /* user defined signal 2 */
109 #if __BSD_VISIBLE
110 #define SIGTHR          32      /* Thread interrupt (FreeBSD-5 reserved) */
111 #define SIGCKPT         33      /* checkpoint and continue */
112 #define SIGCKPTEXIT     34      /* checkpoint and exit */
113 #endif
114
115 /*
116  * si_code stuff
117  */
118 /* SIGILL */
119 #define ILL_ILLOPC      1       /* Illegal opcode                       */
120 #define ILL_ILLOPN      2       /* Illegal operand                      */
121 #define ILL_ILLADR      3       /* Illegal addressing mode              */
122 #define ILL_ILLTRP      4       /* Illegal trap                         */
123 #define ILL_PRVOPC      5       /* Privileged opcode                    */
124 #define ILL_PRVREG      6       /* Privileged register                  */
125 #define ILL_COPROC      7       /* Coprocessor error                    */
126 #define ILL_BADSTK      8       /* Internal stack error                 */
127
128 /* SIGFPE */
129 #define FPE_INTOVF      1       /* Integer overflow                     */
130 #define FPE_INTDIV      2       /* Integer divide by zero               */
131 #define FPE_FLTDIV      3       /* Floating point divide by zero        */
132 #define FPE_FLTOVF      4       /* Floating point overflow              */
133 #define FPE_FLTUND      5       /* Floating point underflow             */
134 #define FPE_FLTRES      6       /* Floating point inexact result        */
135 #define FPE_FLTINV      7       /* Invalid Floating point operation     */
136 #define FPE_FLTSUB      8       /* Subscript out of range               */
137
138 /* SIGSEGV */
139 #define SEGV_MAPERR     1       /* Address not mapped to object         */
140 #define SEGV_ACCERR     2       /* Invalid permissions for mapped object*/
141
142 /* SIGBUS */
143 #define BUS_ADRALN      1       /* Invalid address alignment            */
144 #define BUS_ADRERR      2       /* Non-existent physical address        */
145 #define BUS_OBJERR      3       /* Object specific hardware error       */
146
147 /* SIGTRAP */
148 #define TRAP_BRKPT      1       /* Process breakpoint                   */
149 #define TRAP_TRACE      2       /* Process trace trap                   */
150
151 /* SIGCHLD */
152 #define CLD_EXITED      1       /* Child has exited                     */
153 #define CLD_KILLED      2       /* Child has terminated abnormally but  */
154                                 /* did not create a core file           */
155 #define CLD_DUMPED      3       /* Child has terminated abnormally and  */
156                                 /* created a core file                  */
157 #define CLD_TRAPPED     4       /* Traced child has trapped             */
158 #define CLD_STOPPED     5       /* Child has stopped                    */
159 #define CLD_CONTINUED   6       /* Stopped child has continued          */
160
161 /* SIGPOLL */
162 #define POLL_IN         1       /* Data input available                 */
163 #define POLL_OUT        2       /* Output buffers available             */
164 #define POLL_MSG        3       /* Input message available              */
165 #define POLL_ERR        4       /* I/O Error                            */
166 #define POLL_PRI        5       /* High priority input available        */
167 #define POLL_HUP        6       /* Device disconnected                  */
168
169
170 /** si_code */
171 #define SI_USER         0       /* Sent by kill(2)                      */
172 #define SI_QUEUE        -1      /* Sent by the sigqueue(2)              */
173 #define SI_TIMER        -2      /* Generated by expiration of a timer   */
174                                 /* set by timer_settime(2)              */
175 #define SI_ASYNCIO      -3      /* Generated by completion of an        */
176                                 /* asynchronous I/O signal              */
177 #define SI_MESGQ        -4      /* Generated by arrival of a message on */
178                                 /* an empty message queue               */
179
180 /*-
181  * Type of a signal handling function.
182  *
183  * Language spec sez signal handlers take exactly one arg, even though we
184  * actually supply three.  Ugh!
185  *
186  * We don't try to hide the difference by leaving out the args because
187  * that would cause warnings about conformant programs.  Nonconformant
188  * programs can avoid the warnings by casting to (__sighandler_t *) or
189  * sig_t before calling signal() or assigning to sa_handler or sv_handler.
190  *
191  * The kernel should reverse the cast before calling the function.  It
192  * has no way to do this, but on most machines 1-arg and 3-arg functions
193  * have the same calling protocol so there is no problem in practice.
194  * A bit in sa_flags could be used to specify the number of args.
195  *
196  * SIG_EINTR causes system calls to interrupt but generates no signal
197  * delivery.  The caller is responsible for polling the event.
198  */
199 typedef void __sighandler_t (int);
200
201 #define SIG_DFL         ((__sighandler_t *)0)
202 #define SIG_IGN         ((__sighandler_t *)1)
203 #define SIG_ERR         ((__sighandler_t *)-1)
204
205 #if defined(_P1003_1B_VISIBLE) || defined(_KERNEL)
206 union sigval {
207         /* Members as suggested by Annex C of POSIX 1003.1b. */
208         int     sigval_int;
209         void    *sigval_ptr;
210 };
211
212 struct sigevent {
213         int     sigev_notify;           /* Notification type */
214         union {
215                 int     __sigev_signo;  /* Signal number */
216                 int     __sigev_notify_kqueue;
217         } __sigev_u;
218         union sigval sigev_value;       /* Signal value */
219 };
220 #define sigev_signo             __sigev_u.__sigev_signo
221 #define sigev_notify_kqueue     __sigev_u.__sigev_notify_kqueue
222
223 #define SIGEV_NONE      0               /* No async notification */
224 #define SIGEV_SIGNAL    1               /* Generate a queued signal */
225 #define SIGEV_KEVENT    3               /* Generate a kevent */
226
227 typedef struct __siginfo {
228         int     si_signo;               /* signal number */
229         int     si_errno;               /* errno association */
230         /*
231          * Cause of signal, one of the SI_ macros or signal-specific
232          * values, i.e. one of the FPE_... values for SIGFPE. This
233          * value is equivalent to the second argument to an old-style
234          * FreeBSD signal handler.
235          */
236         int     si_code;                /* signal code */
237         int     si_pid;                 /* sending process */
238         unsigned int si_uid;            /* sender's ruid */
239         int     si_status;              /* exit value */
240         void    *si_addr;               /* faulting instruction */
241         union sigval si_value;          /* signal value */
242         long    si_band;                /* band event for SIGPOLL */
243         int     __spare__[7];           /* gimme some slack */
244 } siginfo_t;
245 #endif /* _P1003_1B_VISIBLE */
246
247 typedef struct __sigset {
248         unsigned int    __bits[_SIG_WORDS];
249 } sigset_t;
250
251 /*
252  * XXX - there are some nasty dependencies on include file order. Now that
253  * sigset_t has been defined we can include the MD header.
254  */     
255 #include <machine/signal.h>     /* sig_atomic_t; trap codes; sigcontext */
256
257 #if !defined(_ANSI_SOURCE)
258
259 struct __siginfo;
260
261 /*
262  * Signal vector "template" used in sigaction call.
263  */
264 struct  sigaction {
265         union {
266                 void    (*__sa_handler) (int);
267                 void    (*__sa_sigaction) (int, struct __siginfo *, void *);
268                 int     *__sa_mailbox;
269         } __sigaction_u;                /* signal handler */
270         int     sa_flags;               /* see signal options below */
271         sigset_t sa_mask;               /* signal mask to apply */
272 };
273
274 /* if SA_SIGINFO is set, sa_sigaction is to be used instead of sa_handler. */
275 #define sa_handler      __sigaction_u.__sa_handler
276
277 #define SA_NOCLDSTOP    0x0008  /* do not generate SIGCHLD on child stop */
278
279 #if !defined(_POSIX_SOURCE)
280
281 #define sa_sigaction    __sigaction_u.__sa_sigaction
282 #define sa_mailbox      __sigaction_u.__sa_mailbox
283
284 #define SA_ONSTACK      0x0001  /* take signal on signal stack */
285 #define SA_RESTART      0x0002  /* restart system call on signal return */
286 #define SA_RESETHAND    0x0004  /* reset to SIG_DFL when taking signal */
287 #define SA_NODEFER      0x0010  /* don't mask the signal we're delivering */
288 #define SA_NOCLDWAIT    0x0020  /* don't keep zombies around */
289 #define SA_SIGINFO      0x0040  /* signal handler with SA_SIGINFO args */
290 #ifdef COMPAT_SUNOS
291 #define SA_USERTRAMP    0x0100  /* do not bounce off kernel's sigtramp */
292 #endif
293 #define SA_MAILBOX      0x1000  /* store to mailbox */
294
295 #define NSIG            64      /* size of sigptbl */
296
297 /* Additional FreeBSD values. */
298 #define SI_UNDEFINED    0
299
300 typedef void __siginfohandler_t (int, struct __siginfo *, void *);
301
302 typedef __sighandler_t  *sig_t; /* type of pointer to a signal function */
303
304 /*
305  * Structure used in sigaltstack call.
306  */
307 typedef struct sigaltstack {
308         char    *ss_sp;                 /* signal stack base */
309         __size_t ss_size;               /* signal stack length */
310         int     ss_flags;               /* SS_DISABLE and/or SS_ONSTACK */
311 } stack_t;
312
313 #define SS_ONSTACK      0x0001  /* take signal on alternate stack */
314 #define SS_DISABLE      0x0004  /* disable taking signals on alternate stack */
315 #define MINSIGSTKSZ     8192                    /* minimum allowable stack */
316 #define SIGSTKSZ        (MINSIGSTKSZ + 32768)   /* recommended stack size */
317
318 /* Have enough typedefs for this now.  XXX */
319 #include <sys/ucontext.h>
320
321 /*
322  * 4.3 compatibility:
323  * Signal vector "template" used in sigvec call.
324  */
325 struct  sigvec {
326         __sighandler_t *sv_handler;     /* signal handler */
327         int     sv_mask;                /* signal mask to apply */
328         int     sv_flags;               /* see signal options below */
329 };
330
331 #define SV_ONSTACK      SA_ONSTACK
332 #define SV_INTERRUPT    SA_RESTART      /* same bit, opposite sense */
333 #define SV_RESETHAND    SA_RESETHAND
334 #define SV_NODEFER      SA_NODEFER
335 #define SV_NOCLDSTOP    SA_NOCLDSTOP
336 #define SV_SIGINFO      SA_SIGINFO
337 #define sv_onstack sv_flags     /* isn't compatibility wonderful! */
338
339 /*
340  * Structure used in sigstack call.
341  */
342 struct  sigstack {
343         char    *ss_sp;                 /* signal stack pointer */
344         int     ss_onstack;             /* current status */
345 };
346
347 /*
348  * Macro for converting signal number to a mask suitable for
349  * sigblock().
350  */
351 #define sigmask(m)      (1 << ((m)-1))
352
353 #define BADSIG          SIG_ERR
354
355 #endif /* !_POSIX_SOURCE */
356
357 /*
358  * Flags for sigprocmask:
359  */
360 #define SIG_BLOCK       1       /* block specified signal set */
361 #define SIG_UNBLOCK     2       /* unblock specified signal set */
362 #define SIG_SETMASK     3       /* set specified signal set */
363
364 #endif /* !_ANSI_SOURCE */
365
366 /*
367  * For historical reasons; programs expect signal's return value to be
368  * defined by <sys/signal.h>.
369  */
370 __BEGIN_DECLS
371 __sighandler_t *signal (int, __sighandler_t *);
372 __END_DECLS
373
374 #endif  /* !_SYS_SIGNAL_H_ */