Extend NSIG to 64 and introduce a registration function for the checkpointing
[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.4 2003/10/13 18:12:07 dillon Exp $
41  */
42
43 #ifndef _SYS_SIGNAL_H_
44 #define _SYS_SIGNAL_H_
45
46 #include <sys/cdefs.h>
47 #include <sys/_posix.h>
48
49 /*
50  * sigset_t macros.
51  */
52 #define _SIG_WORDS      4
53 #define _SIG_MAXSIG     128
54 #define _SIG_IDX(sig)   ((sig) - 1)
55 #define _SIG_WORD(sig)  (_SIG_IDX(sig) >> 5)
56 #define _SIG_BIT(sig)   (1 << (_SIG_IDX(sig) & 31))
57 #define _SIG_VALID(sig) ((sig) < _SIG_MAXSIG && (sig) > 0)
58
59 /*
60  * System defined signals.
61  */
62 #define SIGHUP          1       /* hangup */
63 #define SIGINT          2       /* interrupt */
64 #define SIGQUIT         3       /* quit */
65 #define SIGILL          4       /* illegal instr. (not reset when caught) */
66 #ifndef _POSIX_SOURCE
67 #define SIGTRAP         5       /* trace trap (not reset when caught) */
68 #endif
69 #define SIGABRT         6       /* abort() */
70 #ifndef _POSIX_SOURCE
71 #define SIGIOT          SIGABRT /* compatibility */
72 #define SIGEMT          7       /* EMT instruction */
73 #endif
74 #define SIGFPE          8       /* floating point exception */
75 #define SIGKILL         9       /* kill (cannot be caught or ignored) */
76 #ifndef _POSIX_SOURCE
77 #define SIGBUS          10      /* bus error */
78 #endif
79 #define SIGSEGV         11      /* segmentation violation */
80 #ifndef _POSIX_SOURCE
81 #define SIGSYS          12      /* non-existent system call invoked */
82 #endif
83 #define SIGPIPE         13      /* write on a pipe with no one to read it */
84 #define SIGALRM         14      /* alarm clock */
85 #define SIGTERM         15      /* software termination signal from kill */
86 #ifndef _POSIX_SOURCE
87 #define SIGURG          16      /* urgent condition on IO channel */
88 #endif
89 #define SIGSTOP         17      /* sendable stop signal not from tty */
90 #define SIGTSTP         18      /* stop signal from tty */
91 #define SIGCONT         19      /* continue a stopped process */
92 #define SIGCHLD         20      /* to parent on child stop or exit */
93 #define SIGTTIN         21      /* to readers pgrp upon background tty read */
94 #define SIGTTOU         22      /* like TTIN if (tp->t_local&LTOSTOP) */
95 #ifndef _POSIX_SOURCE
96 #define SIGIO           23      /* input/output possible signal */
97 #define SIGXCPU         24      /* exceeded CPU time limit */
98 #define SIGXFSZ         25      /* exceeded file size limit */
99 #define SIGVTALRM       26      /* virtual time alarm */
100 #define SIGPROF         27      /* profiling time alarm */
101 #define SIGWINCH        28      /* window size changes */
102 #define SIGINFO         29      /* information request */
103 #endif
104 #define SIGUSR1         30      /* user defined signal 1 */
105 #define SIGUSR2         31      /* user defined signal 2 */
106 #if __BSD_VISIBLE
107 #define SIGTHR          32      /* Thread interrupt (FreeBSD-5 reserved) */
108 #define SIGCKPT         33      /* checkpoint and continue */
109 #define SIGCKPTEXIT     34      /* checkpoint and exit */
110 #endif
111
112 /*-
113  * Type of a signal handling function.
114  *
115  * Language spec sez signal handlers take exactly one arg, even though we
116  * actually supply three.  Ugh!
117  *
118  * We don't try to hide the difference by leaving out the args because
119  * that would cause warnings about conformant programs.  Nonconformant
120  * programs can avoid the warnings by casting to (__sighandler_t *) or
121  * sig_t before calling signal() or assigning to sa_handler or sv_handler.
122  *
123  * The kernel should reverse the cast before calling the function.  It
124  * has no way to do this, but on most machines 1-arg and 3-arg functions
125  * have the same calling protocol so there is no problem in practice.
126  * A bit in sa_flags could be used to specify the number of args.
127  */
128 typedef void __sighandler_t (int);
129
130 #define SIG_DFL         ((__sighandler_t *)0)
131 #define SIG_IGN         ((__sighandler_t *)1)
132 #define SIG_ERR         ((__sighandler_t *)-1)
133
134 #if defined(_P1003_1B_VISIBLE) || defined(_KERNEL)
135 union sigval {
136         /* Members as suggested by Annex C of POSIX 1003.1b. */
137         int     sigval_int;
138         void    *sigval_ptr;
139 };
140
141 struct sigevent {
142         int     sigev_notify;           /* Notification type */
143         union {
144                 int     __sigev_signo;  /* Signal number */
145                 int     __sigev_notify_kqueue;
146         } __sigev_u;
147         union sigval sigev_value;       /* Signal value */
148 };
149 #define sigev_signo             __sigev_u.__sigev_signo
150 #define sigev_notify_kqueue     __sigev_u.__sigev_notify_kqueue
151
152 #define SIGEV_NONE      0               /* No async notification */
153 #define SIGEV_SIGNAL    1               /* Generate a queued signal */
154 #define SIGEV_KEVENT    3               /* Generate a kevent */
155
156 typedef struct __siginfo {
157         int     si_signo;               /* signal number */
158         int     si_errno;               /* errno association */
159         /*
160          * Cause of signal, one of the SI_ macros or signal-specific
161          * values, i.e. one of the FPE_... values for SIGFPE. This
162          * value is equivalent to the second argument to an old-style
163          * FreeBSD signal handler.
164          */
165         int     si_code;                /* signal code */
166         int     si_pid;                 /* sending process */
167         unsigned int si_uid;            /* sender's ruid */
168         int     si_status;              /* exit value */
169         void    *si_addr;               /* faulting instruction */
170         union sigval si_value;          /* signal value */
171         long    si_band;                /* band event for SIGPOLL */
172         int     __spare__[7];           /* gimme some slack */
173 } siginfo_t;
174 #endif /* _P1003_1B_VISIBLE */
175
176 typedef struct __sigset {
177         unsigned int    __bits[_SIG_WORDS];
178 } sigset_t;
179
180 /*
181  * XXX - there are some nasty dependencies on include file order. Now that
182  * sigset_t has been defined we can include the MD header.
183  */     
184 #include <machine/signal.h>     /* sig_atomic_t; trap codes; sigcontext */
185
186 #if !defined(_ANSI_SOURCE)
187
188 struct __siginfo;
189
190 /*
191  * Signal vector "template" used in sigaction call.
192  */
193 struct  sigaction {
194         union {
195                 void    (*__sa_handler) (int);
196                 void    (*__sa_sigaction) (int, struct __siginfo *,
197                                                void *);
198         } __sigaction_u;                /* signal handler */
199         int     sa_flags;               /* see signal options below */
200         sigset_t sa_mask;               /* signal mask to apply */
201 };
202
203 /* if SA_SIGINFO is set, sa_sigaction is to be used instead of sa_handler. */
204 #define sa_handler      __sigaction_u.__sa_handler
205
206 #define SA_NOCLDSTOP    0x0008  /* do not generate SIGCHLD on child stop */
207
208 #if !defined(_POSIX_SOURCE)
209
210 #define sa_sigaction    __sigaction_u.__sa_sigaction
211
212 #define SA_ONSTACK      0x0001  /* take signal on signal stack */
213 #define SA_RESTART      0x0002  /* restart system call on signal return */
214 #define SA_RESETHAND    0x0004  /* reset to SIG_DFL when taking signal */
215 #define SA_NODEFER      0x0010  /* don't mask the signal we're delivering */
216 #define SA_NOCLDWAIT    0x0020  /* don't keep zombies around */
217 #define SA_SIGINFO      0x0040  /* signal handler with SA_SIGINFO args */
218 #ifdef COMPAT_SUNOS
219 #define SA_USERTRAMP    0x0100  /* do not bounce off kernel's sigtramp */
220 #endif
221
222 #define NSIG            64      /* size of sigptbl */
223
224 /* POSIX 1003.1b required values. */
225 #define SI_USER         0x10001
226 #define SI_QUEUE        0x10002
227 #define SI_TIMER        0x10003
228 #define SI_ASYNCIO      0x10004
229 #define SI_MESGQ        0x10005
230
231 /* Additional FreeBSD values. */
232 #define SI_UNDEFINED    0
233
234 typedef void __siginfohandler_t (int, struct __siginfo *, void *);
235
236 typedef __sighandler_t  *sig_t; /* type of pointer to a signal function */
237
238 #ifdef  _BSD_SIZE_T_
239 typedef _BSD_SIZE_T_    size_t;
240 #undef  _BSD_SIZE_T_
241 #endif
242
243 /*
244  * Structure used in sigaltstack call.
245  */
246 typedef struct sigaltstack {
247         char    *ss_sp;                 /* signal stack base */
248         size_t  ss_size;                /* signal stack length */
249         int     ss_flags;               /* SS_DISABLE and/or SS_ONSTACK */
250 } stack_t;
251
252 #define SS_ONSTACK      0x0001  /* take signal on alternate stack */
253 #define SS_DISABLE      0x0004  /* disable taking signals on alternate stack */
254 #define MINSIGSTKSZ     8192                    /* minimum allowable stack */
255 #define SIGSTKSZ        (MINSIGSTKSZ + 32768)   /* recommended stack size */
256
257 /* Have enough typedefs for this now.  XXX */
258 #include <sys/ucontext.h>
259
260 /*
261  * 4.3 compatibility:
262  * Signal vector "template" used in sigvec call.
263  */
264 struct  sigvec {
265         __sighandler_t *sv_handler;     /* signal handler */
266         int     sv_mask;                /* signal mask to apply */
267         int     sv_flags;               /* see signal options below */
268 };
269
270 #define SV_ONSTACK      SA_ONSTACK
271 #define SV_INTERRUPT    SA_RESTART      /* same bit, opposite sense */
272 #define SV_RESETHAND    SA_RESETHAND
273 #define SV_NODEFER      SA_NODEFER
274 #define SV_NOCLDSTOP    SA_NOCLDSTOP
275 #define SV_SIGINFO      SA_SIGINFO
276 #define sv_onstack sv_flags     /* isn't compatibility wonderful! */
277
278 /*
279  * Structure used in sigstack call.
280  */
281 struct  sigstack {
282         char    *ss_sp;                 /* signal stack pointer */
283         int     ss_onstack;             /* current status */
284 };
285
286 /*
287  * Macro for converting signal number to a mask suitable for
288  * sigblock().
289  */
290 #define sigmask(m)      (1 << ((m)-1))
291
292 #define BADSIG          SIG_ERR
293
294 #endif /* !_POSIX_SOURCE */
295
296 /*
297  * Flags for sigprocmask:
298  */
299 #define SIG_BLOCK       1       /* block specified signal set */
300 #define SIG_UNBLOCK     2       /* unblock specified signal set */
301 #define SIG_SETMASK     3       /* set specified signal set */
302
303 #endif /* !_ANSI_SOURCE */
304
305 /*
306  * For historical reasons; programs expect signal's return value to be
307  * defined by <sys/signal.h>.
308  */
309 __BEGIN_DECLS
310 __sighandler_t *signal (int, __sighandler_t *);
311 __END_DECLS
312
313 #endif  /* !_SYS_SIGNAL_H_ */