xref: /dragonfly/sys/sys/signal.h (revision c6f73aab)
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  */
41 
42 #ifndef	_SYS_SIGNAL_H_
43 #define	_SYS_SIGNAL_H_
44 
45 #include <sys/cdefs.h>
46 #include <machine/stdint.h>	/* for __ types */
47 
48 /*
49  * sigset_t macros.
50  */
51 #define	_SIG_WORDS	4
52 #define	_SIG_MAXSIG	128
53 #define	_SIG_IDX(sig)	((sig) - 1)
54 #define	_SIG_WORD(sig)	(_SIG_IDX(sig) >> 5)
55 #define	_SIG_BIT(sig)	(1 << (_SIG_IDX(sig) & 31))
56 #define	_SIG_VALID(sig)	((sig) < _SIG_MAXSIG && (sig) > 0)
57 
58 /*
59  * System defined signals.
60  */
61 #if __POSIX_VISIBLE || __XSI_VISIBLE
62 #define	SIGHUP		1	/* hangup */
63 #endif
64 #define	SIGINT		2	/* interrupt */
65 #if __POSIX_VISIBLE || __XSI_VISIBLE
66 #define	SIGQUIT		3	/* quit */
67 #endif
68 #define	SIGILL		4	/* illegal instr. (not reset when caught) */
69 #if __XSI_VISIBLE
70 #define	SIGTRAP		5	/* trace trap (not reset when caught) */
71 #endif
72 #define	SIGABRT		6	/* abort() */
73 #if __BSD_VISIBLE
74 #define	SIGIOT		SIGABRT	/* compatibility */
75 #define	SIGEMT		7	/* EMT instruction */
76 #endif
77 #define	SIGFPE		8	/* floating point exception */
78 #if __POSIX_VISIBLE || __XSI_VISIBLE
79 #define	SIGKILL		9	/* kill (cannot be caught or ignored) */
80 #endif
81 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
82 #define	SIGBUS		10	/* bus error */
83 #endif
84 #define	SIGSEGV		11	/* segmentation violation */
85 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
86 #define	SIGSYS		12	/* non-existent system call invoked */
87 #endif
88 #if __POSIX_VISIBLE || __XSI_VISIBLE
89 #define	SIGPIPE		13	/* write on a pipe with no one to read it */
90 #define	SIGALRM		14	/* alarm clock */
91 #endif
92 #define	SIGTERM		15	/* software termination signal from kill */
93 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
94 #define	SIGURG		16	/* urgent condition on IO channel */
95 #endif
96 #if __POSIX_VISIBLE || __XSI_VISIBLE
97 #define	SIGSTOP		17	/* sendable stop signal not from tty */
98 #define	SIGTSTP		18	/* stop signal from tty */
99 #define	SIGCONT		19	/* continue a stopped process */
100 #define	SIGCHLD		20	/* to parent on child stop or exit */
101 #define	SIGTTIN		21	/* to readers pgrp upon background tty read */
102 #define	SIGTTOU		22	/* like TTIN if (tp->t_local&LTOSTOP) */
103 #endif
104 #if __BSD_VISIBLE
105 #define	SIGIO		23	/* input/output possible signal */
106 #endif
107 #if __XSI_VISIBLE
108 #define	SIGXCPU		24	/* exceeded CPU time limit */
109 #define	SIGXFSZ		25	/* exceeded file size limit */
110 #define	SIGVTALRM	26	/* virtual time alarm */
111 #define	SIGPROF		27	/* profiling time alarm */
112 #endif
113 #if __BSD_VISIBLE
114 #define	SIGWINCH	28	/* window size changes */
115 #define	SIGINFO		29	/* information request */
116 #endif
117 #if __POSIX_VISIBLE || __XSI_VISIBLE
118 #define	SIGUSR1		30	/* user defined signal 1 */
119 #define	SIGUSR2		31	/* user defined signal 2 */
120 #endif
121 #if __BSD_VISIBLE
122 #define SIGTHR          32      /* Thread interrupt (FreeBSD-5 reserved) */
123 #define SIGCKPT         33      /* checkpoint and continue */
124 #define SIGCKPTEXIT     34      /* checkpoint and exit */
125 #endif
126 
127 #if __POSIX_VISIBLE >= 199309 || __XSI_VISIBLE
128 /*
129  * si_code stuff
130  */
131 /* SIGILL */
132 #define	ILL_ILLOPC	1	/* Illegal opcode			*/
133 #define	ILL_ILLOPN	2	/* Illegal operand			*/
134 #define	ILL_ILLADR	3	/* Illegal addressing mode		*/
135 #define	ILL_ILLTRP	4	/* Illegal trap				*/
136 #define	ILL_PRVOPC	5	/* Privileged opcode			*/
137 #define	ILL_PRVREG	6	/* Privileged register			*/
138 #define	ILL_COPROC	7	/* Coprocessor error			*/
139 #define	ILL_BADSTK	8	/* Internal stack error			*/
140 
141 /* SIGFPE */
142 #define	FPE_INTOVF	1	/* Integer overflow			*/
143 #define	FPE_INTDIV	2	/* Integer divide by zero		*/
144 #define	FPE_FLTDIV	3	/* Floating point divide by zero	*/
145 #define	FPE_FLTOVF	4	/* Floating point overflow		*/
146 #define	FPE_FLTUND	5	/* Floating point underflow		*/
147 #define	FPE_FLTRES	6	/* Floating point inexact result	*/
148 #define	FPE_FLTINV	7	/* Invalid Floating point operation	*/
149 #define	FPE_FLTSUB	8	/* Subscript out of range		*/
150 
151 /* SIGSEGV */
152 #define	SEGV_MAPERR	1	/* Address not mapped to object		*/
153 #define	SEGV_ACCERR	2	/* Invalid permissions for mapped object*/
154 
155 /* SIGBUS */
156 #define	BUS_ADRALN	1	/* Invalid address alignment		*/
157 #define	BUS_ADRERR	2	/* Non-existent physical address	*/
158 #define	BUS_OBJERR	3	/* Object specific hardware error	*/
159 
160 /* SIGTRAP */
161 #define	TRAP_BRKPT	1	/* Process breakpoint			*/
162 #define	TRAP_TRACE	2	/* Process trace trap			*/
163 
164 /* SIGCHLD */
165 #define	CLD_EXITED	1	/* Child has exited			*/
166 #define	CLD_KILLED	2	/* Child has terminated abnormally but	*/
167 				/* did not create a core file		*/
168 #define	CLD_DUMPED	3	/* Child has terminated abnormally and	*/
169 				/* created a core file			*/
170 #define	CLD_TRAPPED	4	/* Traced child has trapped		*/
171 #define	CLD_STOPPED	5	/* Child has stopped			*/
172 #define	CLD_CONTINUED	6	/* Stopped child has continued		*/
173 
174 /* SIGPOLL */
175 #define	POLL_IN		1	/* Data input available			*/
176 #define	POLL_OUT	2	/* Output buffers available		*/
177 #define	POLL_MSG	3	/* Input message available		*/
178 #define	POLL_ERR	4	/* I/O Error				*/
179 #define	POLL_PRI	5	/* High priority input available	*/
180 #define	POLL_HUP	6	/* Device disconnected			*/
181 #endif	/* __POSIX_VISIBLE >= 199309 || __XSI_VISIBLE */
182 
183 
184 #if __POSIX_VISIBLE || __XSI_VISIBLE
185 /** si_code */
186 #define	SI_USER		0	/* Sent by kill(2)			*/
187 #define	SI_QUEUE	-1	/* Sent by the sigqueue(2)		*/
188 #define	SI_TIMER	-2	/* Generated by expiration of a timer	*/
189 				/* set by timer_settime(2)		*/
190 #define	SI_ASYNCIO	-3	/* Generated by completion of an	*/
191 				/* asynchronous I/O signal		*/
192 #define	SI_MESGQ	-4	/* Generated by arrival of a message on	*/
193 				/* an empty message queue		*/
194 #endif
195 
196 /*-
197  * Type of a signal handling function.
198  *
199  * Language spec sez signal handlers take exactly one arg, even though we
200  * actually supply three.  Ugh!
201  *
202  * We don't try to hide the difference by leaving out the args because
203  * that would cause warnings about conformant programs.  Nonconformant
204  * programs can avoid the warnings by casting to (__sighandler_t *) or
205  * sig_t before calling signal() or assigning to sa_handler or sv_handler.
206  *
207  * The kernel should reverse the cast before calling the function.  It
208  * has no way to do this, but on most machines 1-arg and 3-arg functions
209  * have the same calling protocol so there is no problem in practice.
210  * A bit in sa_flags could be used to specify the number of args.
211  *
212  * SIG_EINTR causes system calls to interrupt but generates no signal
213  * delivery.  The caller is responsible for polling the event.
214  */
215 typedef void __sighandler_t (int);
216 
217 #define	SIG_DFL		((__sighandler_t *)0)
218 #define	SIG_IGN		((__sighandler_t *)1)
219 #define	SIG_ERR		((__sighandler_t *)-1)
220 
221 #if __POSIX_VISIBLE >= 199309 || __XSI_VISIBLE >= 500
222 union sigval {
223 	/* Members as suggested by SuSv2 and IEEE Std 1003.1 */
224 	int     sival_int;
225 	void	*sival_ptr;
226 	/* Leave old members for backward compatibility */
227 	int     sigval_int;
228 	void    *sigval_ptr;
229 
230 };
231 #endif
232 
233 #if __POSIX_VISIBLE >= 199309
234 struct sigevent {
235 	int	sigev_notify;		/* Notification type */
236 	union {
237 		int	__sigev_signo;	/* Signal number */
238 		int	__sigev_notify_kqueue;
239 		void	*__sigev_notify_attributes;
240 	} __sigev_u;
241 	union sigval sigev_value;	/* Signal value */
242 	void (*sigev_notify_function)(union sigval);
243 };
244 #define sigev_signo		__sigev_u.__sigev_signo
245 #define sigev_notify_attributes	__sigev_u.__sigev_notify_attributes
246 #if __BSD_VISIBLE
247 #define sigev_notify_kqueue	__sigev_u.__sigev_notify_kqueue
248 #endif
249 
250 #define	SIGEV_NONE	0		/* No async notification */
251 #define	SIGEV_SIGNAL	1		/* Generate a queued signal */
252 #define SIGEV_THREAD	2		/* Call back in a pthread */
253 #if __BSD_VISIBLE
254 #define SIGEV_KEVENT	3		/* Generate a kevent */
255 #endif
256 #endif /* __POSIX_VISIBLE >= 199309 */
257 
258 #if __POSIX_VISIBLE >= 199309 || __XSI_VISIBLE
259 typedef struct __siginfo {
260 	int	si_signo;		/* signal number */
261 	int	si_errno;		/* errno association */
262 	/*
263 	 * Cause of signal, one of the SI_ macros or signal-specific
264 	 * values, i.e. one of the FPE_... values for SIGFPE. This
265 	 * value is equivalent to the second argument to an old-style
266 	 * FreeBSD signal handler.
267 	 */
268 	int	si_code;		/* signal code */
269 	int	si_pid;			/* sending process */
270 	unsigned int si_uid;		/* sender's ruid */
271 	int	si_status;		/* exit value */
272 	void	*si_addr;		/* faulting instruction */
273 	union sigval si_value;		/* signal value */
274 	long	si_band;		/* band event for SIGPOLL */
275 	int	__spare__[7];		/* gimme some slack */
276 } siginfo_t;
277 #endif /* __POSIX_VISIBLE >= 199309 || __XSI_VISIBLE */
278 
279 /* #if __POSIX_VISIBLE || __XSI_VISIBLE */
280 typedef struct __sigset {
281 	unsigned int	__bits[_SIG_WORDS];
282 } sigset_t;
283 /* #endif */
284 
285 /*
286  * XXX - there are some nasty dependencies on include file order. Now that
287  * sigset_t has been defined we can include the MD header.
288  */
289 #include <machine/signal.h>     /* sig_atomic_t; trap codes; sigcontext */
290 
291 #if __POSIX_VISIBLE || __XSI_VISIBLE
292 struct __siginfo;
293 
294 /*
295  * Signal vector "template" used in sigaction call.
296  */
297 struct	sigaction {
298 	union {
299 		void    (*__sa_handler) (int);
300 		void    (*__sa_sigaction) (int, struct __siginfo *, void *);
301 	} __sigaction_u;		/* signal handler */
302 	int	sa_flags;		/* see signal options below */
303 	sigset_t sa_mask;		/* signal mask to apply */
304 };
305 
306 /* if SA_SIGINFO is set, sa_sigaction is to be used instead of sa_handler. */
307 #define	sa_handler	__sigaction_u.__sa_handler
308 
309 #define SA_NOCLDSTOP	0x0008	/* do not generate SIGCHLD on child stop */
310 #endif /* __POSIX_VISIBLE || __XSI_VISIBLE */
311 
312 #if __XSI_VISIBLE
313 #define	sa_sigaction	__sigaction_u.__sa_sigaction
314 #endif
315 
316 #if __XSI_VISIBLE
317 #define SA_ONSTACK	0x0001	/* take signal on signal stack */
318 #define SA_RESTART	0x0002	/* restart system call on signal return */
319 #define	SA_RESETHAND	0x0004	/* reset to SIG_DFL when taking signal */
320 #define	SA_NODEFER	0x0010	/* don't mask the signal we're delivering */
321 #define	SA_NOCLDWAIT	0x0020	/* don't keep zombies around */
322 #define	SA_SIGINFO	0x0040	/* signal handler with SA_SIGINFO args */
323 #endif
324 
325 #if __BSD_VISIBLE
326 #define NSIG		64	/* size of sigptbl */
327 
328 /* Additional FreeBSD values. */
329 #define SI_UNDEFINED	0
330 
331 typedef void __siginfohandler_t (int, struct __siginfo *, void *);
332 
333 #endif
334 
335 /* XXX this should really be under __BSD_VISIBLE */
336 typedef	__sighandler_t	*sig_t;	/* type of pointer to a signal function */
337 
338 /* #if __XSI_VISIBLE */
339 /*
340  * Structure used in sigaltstack call.
341  */
342 #if __BSD_VISIBLE
343 typedef	struct sigaltstack {
344 #else
345 typedef	struct {
346 #endif
347 	char	*ss_sp;			/* signal stack base */
348 	__size_t ss_size;		/* signal stack length */
349 	int	ss_flags;		/* SS_DISABLE and/or SS_ONSTACK */
350 } stack_t;
351 
352 #define	SS_ONSTACK	0x0001	/* take signal on alternate stack */
353 #define	SS_DISABLE	0x0004	/* disable taking signals on alternate stack */
354 #define	MINSIGSTKSZ	8192			/* minimum allowable stack */
355 #define	SIGSTKSZ	(MINSIGSTKSZ + 32768)	/* recommended stack size */
356 /* #endif */
357 
358 /* Have enough typedefs for this now.  XXX */
359 #include <sys/ucontext.h>
360 
361 #if __BSD_VISIBLE
362 /*
363  * 4.3 compatibility:
364  * Signal vector "template" used in sigvec call.
365  */
366 struct	sigvec {
367 	__sighandler_t *sv_handler;	/* signal handler */
368 	int	sv_mask;		/* signal mask to apply */
369 	int	sv_flags;		/* see signal options below */
370 };
371 
372 #define SV_ONSTACK	SA_ONSTACK
373 #define SV_INTERRUPT	SA_RESTART	/* same bit, opposite sense */
374 #define SV_RESETHAND	SA_RESETHAND
375 #define SV_NODEFER	SA_NODEFER
376 #define SV_NOCLDSTOP	SA_NOCLDSTOP
377 #define SV_SIGINFO	SA_SIGINFO
378 #define sv_onstack sv_flags	/* isn't compatibility wonderful! */
379 #endif
380 
381 #if __XSI_VISIBLE
382 /*
383  * Structure used in sigstack call.
384  */
385 struct	sigstack {
386 	char	*ss_sp;			/* signal stack pointer */
387 	int	ss_onstack;		/* current status */
388 };
389 #endif
390 
391 #if __BSD_VISIBLE || __POSIX_VISIBLE > 0 && __POSIX_VISIBLE <= 200112
392 /*
393  * Macro for converting signal number to a mask suitable for
394  * sigblock().
395  */
396 #define sigmask(m)	(1 << ((m)-1))
397 #endif
398 
399 #if __BSD_VISIBLE
400 #define	BADSIG		SIG_ERR
401 #endif
402 
403 #if __POSIX_VISIBLE || __XSI_VISIBLE
404 /*
405  * Flags for sigprocmask:
406  */
407 #define	SIG_BLOCK	1	/* block specified signal set */
408 #define	SIG_UNBLOCK	2	/* unblock specified signal set */
409 #define	SIG_SETMASK	3	/* set specified signal set */
410 #endif
411 
412 /*
413  * For historical reasons; programs expect signal's return value to be
414  * defined by <sys/signal.h>.
415  */
416 __BEGIN_DECLS
417 __sighandler_t *signal (int, __sighandler_t *);
418 __END_DECLS
419 
420 #endif	/* !_SYS_SIGNAL_H_ */
421