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