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