Change sendfile() to use the new m_ext callback scheme for cleaning up after
[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.5 2003/11/09 02:22:37 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  * Type of a signal handling function.
117  *
118  * Language spec sez signal handlers take exactly one arg, even though we
119  * actually supply three.  Ugh!
120  *
121  * We don't try to hide the difference by leaving out the args because
122  * that would cause warnings about conformant programs.  Nonconformant
123  * programs can avoid the warnings by casting to (__sighandler_t *) or
124  * sig_t before calling signal() or assigning to sa_handler or sv_handler.
125  *
126  * The kernel should reverse the cast before calling the function.  It
127  * has no way to do this, but on most machines 1-arg and 3-arg functions
128  * have the same calling protocol so there is no problem in practice.
129  * A bit in sa_flags could be used to specify the number of args.
130  */
131 typedef void __sighandler_t (int);
132
133 #define SIG_DFL         ((__sighandler_t *)0)
134 #define SIG_IGN         ((__sighandler_t *)1)
135 #define SIG_ERR         ((__sighandler_t *)-1)
136
137 #if defined(_P1003_1B_VISIBLE) || defined(_KERNEL)
138 union sigval {
139         /* Members as suggested by Annex C of POSIX 1003.1b. */
140         int     sigval_int;
141         void    *sigval_ptr;
142 };
143
144 struct sigevent {
145         int     sigev_notify;           /* Notification type */
146         union {
147                 int     __sigev_signo;  /* Signal number */
148                 int     __sigev_notify_kqueue;
149         } __sigev_u;
150         union sigval sigev_value;       /* Signal value */
151 };
152 #define sigev_signo             __sigev_u.__sigev_signo
153 #define sigev_notify_kqueue     __sigev_u.__sigev_notify_kqueue
154
155 #define SIGEV_NONE      0               /* No async notification */
156 #define SIGEV_SIGNAL    1               /* Generate a queued signal */
157 #define SIGEV_KEVENT    3               /* Generate a kevent */
158
159 typedef struct __siginfo {
160         int     si_signo;               /* signal number */
161         int     si_errno;               /* errno association */
162         /*
163          * Cause of signal, one of the SI_ macros or signal-specific
164          * values, i.e. one of the FPE_... values for SIGFPE. This
165          * value is equivalent to the second argument to an old-style
166          * FreeBSD signal handler.
167          */
168         int     si_code;                /* signal code */
169         int     si_pid;                 /* sending process */
170         unsigned int si_uid;            /* sender's ruid */
171         int     si_status;              /* exit value */
172         void    *si_addr;               /* faulting instruction */
173         union sigval si_value;          /* signal value */
174         long    si_band;                /* band event for SIGPOLL */
175         int     __spare__[7];           /* gimme some slack */
176 } siginfo_t;
177 #endif /* _P1003_1B_VISIBLE */
178
179 typedef struct __sigset {
180         unsigned int    __bits[_SIG_WORDS];
181 } sigset_t;
182
183 /*
184  * XXX - there are some nasty dependencies on include file order. Now that
185  * sigset_t has been defined we can include the MD header.
186  */     
187 #include <machine/signal.h>     /* sig_atomic_t; trap codes; sigcontext */
188
189 #if !defined(_ANSI_SOURCE)
190
191 struct __siginfo;
192
193 /*
194  * Signal vector "template" used in sigaction call.
195  */
196 struct  sigaction {
197         union {
198                 void    (*__sa_handler) (int);
199                 void    (*__sa_sigaction) (int, struct __siginfo *,
200                                                void *);
201         } __sigaction_u;                /* signal handler */
202         int     sa_flags;               /* see signal options below */
203         sigset_t sa_mask;               /* signal mask to apply */
204 };
205
206 /* if SA_SIGINFO is set, sa_sigaction is to be used instead of sa_handler. */
207 #define sa_handler      __sigaction_u.__sa_handler
208
209 #define SA_NOCLDSTOP    0x0008  /* do not generate SIGCHLD on child stop */
210
211 #if !defined(_POSIX_SOURCE)
212
213 #define sa_sigaction    __sigaction_u.__sa_sigaction
214
215 #define SA_ONSTACK      0x0001  /* take signal on signal stack */
216 #define SA_RESTART      0x0002  /* restart system call on signal return */
217 #define SA_RESETHAND    0x0004  /* reset to SIG_DFL when taking signal */
218 #define SA_NODEFER      0x0010  /* don't mask the signal we're delivering */
219 #define SA_NOCLDWAIT    0x0020  /* don't keep zombies around */
220 #define SA_SIGINFO      0x0040  /* signal handler with SA_SIGINFO args */
221 #ifdef COMPAT_SUNOS
222 #define SA_USERTRAMP    0x0100  /* do not bounce off kernel's sigtramp */
223 #endif
224
225 #define NSIG            64      /* size of sigptbl */
226
227 /* POSIX 1003.1b required values. */
228 #define SI_USER         0x10001
229 #define SI_QUEUE        0x10002
230 #define SI_TIMER        0x10003
231 #define SI_ASYNCIO      0x10004
232 #define SI_MESGQ        0x10005
233
234 /* Additional FreeBSD values. */
235 #define SI_UNDEFINED    0
236
237 typedef void __siginfohandler_t (int, struct __siginfo *, void *);
238
239 typedef __sighandler_t  *sig_t; /* type of pointer to a signal function */
240
241 /*
242  * Structure used in sigaltstack call.
243  */
244 typedef struct sigaltstack {
245         char    *ss_sp;                 /* signal stack base */
246         __size_t ss_size;               /* signal stack length */
247         int     ss_flags;               /* SS_DISABLE and/or SS_ONSTACK */
248 } stack_t;
249
250 #define SS_ONSTACK      0x0001  /* take signal on alternate stack */
251 #define SS_DISABLE      0x0004  /* disable taking signals on alternate stack */
252 #define MINSIGSTKSZ     8192                    /* minimum allowable stack */
253 #define SIGSTKSZ        (MINSIGSTKSZ + 32768)   /* recommended stack size */
254
255 /* Have enough typedefs for this now.  XXX */
256 #include <sys/ucontext.h>
257
258 /*
259  * 4.3 compatibility:
260  * Signal vector "template" used in sigvec call.
261  */
262 struct  sigvec {
263         __sighandler_t *sv_handler;     /* signal handler */
264         int     sv_mask;                /* signal mask to apply */
265         int     sv_flags;               /* see signal options below */
266 };
267
268 #define SV_ONSTACK      SA_ONSTACK
269 #define SV_INTERRUPT    SA_RESTART      /* same bit, opposite sense */
270 #define SV_RESETHAND    SA_RESETHAND
271 #define SV_NODEFER      SA_NODEFER
272 #define SV_NOCLDSTOP    SA_NOCLDSTOP
273 #define SV_SIGINFO      SA_SIGINFO
274 #define sv_onstack sv_flags     /* isn't compatibility wonderful! */
275
276 /*
277  * Structure used in sigstack call.
278  */
279 struct  sigstack {
280         char    *ss_sp;                 /* signal stack pointer */
281         int     ss_onstack;             /* current status */
282 };
283
284 /*
285  * Macro for converting signal number to a mask suitable for
286  * sigblock().
287  */
288 #define sigmask(m)      (1 << ((m)-1))
289
290 #define BADSIG          SIG_ERR
291
292 #endif /* !_POSIX_SOURCE */
293
294 /*
295  * Flags for sigprocmask:
296  */
297 #define SIG_BLOCK       1       /* block specified signal set */
298 #define SIG_UNBLOCK     2       /* unblock specified signal set */
299 #define SIG_SETMASK     3       /* set specified signal set */
300
301 #endif /* !_ANSI_SOURCE */
302
303 /*
304  * For historical reasons; programs expect signal's return value to be
305  * defined by <sys/signal.h>.
306  */
307 __BEGIN_DECLS
308 __sighandler_t *signal (int, __sighandler_t *);
309 __END_DECLS
310
311 #endif  /* !_SYS_SIGNAL_H_ */