xref: /freebsd/sys/sys/signal.h (revision d93a896e)
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$
36  */
37 
38 #ifndef _SYS_SIGNAL_H_
39 #define	_SYS_SIGNAL_H_
40 
41 #include <sys/cdefs.h>
42 #include <sys/_types.h>
43 #include <sys/_sigset.h>
44 
45 #include <machine/_limits.h>	/* __MINSIGSTKSZ */
46 #include <machine/signal.h>	/* sig_atomic_t; trap codes; sigcontext */
47 
48 #if __POSIX_VISIBLE >= 200809
49 
50 #include <sys/_pthreadtypes.h>
51 #include <sys/_timespec.h>
52 
53 #ifndef _SIZE_T_DECLARED
54 typedef	__size_t	size_t;
55 #define	_SIZE_T_DECLARED
56 #endif
57 
58 #ifndef _UID_T_DECLARED
59 typedef	__uid_t		uid_t;
60 #define	_UID_T_DECLARED
61 #endif
62 
63 #endif /* __POSIX_VISIBLE >= 200809 */
64 
65 /*
66  * System defined signals.
67  */
68 #if __POSIX_VISIBLE || __XSI_VISIBLE
69 #define	SIGHUP		1	/* hangup */
70 #endif
71 #define	SIGINT		2	/* interrupt */
72 #if __POSIX_VISIBLE || __XSI_VISIBLE
73 #define	SIGQUIT		3	/* quit */
74 #endif
75 #define	SIGILL		4	/* illegal instr. (not reset when caught) */
76 #if __XSI_VISIBLE
77 #define	SIGTRAP		5	/* trace trap (not reset when caught) */
78 #endif
79 #define	SIGABRT		6	/* abort() */
80 #if __BSD_VISIBLE
81 #define	SIGIOT		SIGABRT	/* compatibility */
82 #define	SIGEMT		7	/* EMT instruction */
83 #endif
84 #define	SIGFPE		8	/* floating point exception */
85 #if __POSIX_VISIBLE || __XSI_VISIBLE
86 #define	SIGKILL		9	/* kill (cannot be caught or ignored) */
87 #endif
88 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
89 #define	SIGBUS		10	/* bus error */
90 #endif
91 #define	SIGSEGV		11	/* segmentation violation */
92 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
93 #define	SIGSYS		12	/* non-existent system call invoked */
94 #endif
95 #if __POSIX_VISIBLE || __XSI_VISIBLE
96 #define	SIGPIPE		13	/* write on a pipe with no one to read it */
97 #define	SIGALRM		14	/* alarm clock */
98 #endif
99 #define	SIGTERM		15	/* software termination signal from kill */
100 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
101 #define	SIGURG		16	/* urgent condition on IO channel */
102 #endif
103 #if __POSIX_VISIBLE || __XSI_VISIBLE
104 #define	SIGSTOP		17	/* sendable stop signal not from tty */
105 #define	SIGTSTP		18	/* stop signal from tty */
106 #define	SIGCONT		19	/* continue a stopped process */
107 #define	SIGCHLD		20	/* to parent on child stop or exit */
108 #define	SIGTTIN		21	/* to readers pgrp upon background tty read */
109 #define	SIGTTOU		22	/* like TTIN if (tp->t_local&LTOSTOP) */
110 #endif
111 #if __BSD_VISIBLE
112 #define	SIGIO		23	/* input/output possible signal */
113 #endif
114 #if __XSI_VISIBLE
115 #define	SIGXCPU		24	/* exceeded CPU time limit */
116 #define	SIGXFSZ		25	/* exceeded file size limit */
117 #define	SIGVTALRM	26	/* virtual time alarm */
118 #define	SIGPROF		27	/* profiling time alarm */
119 #endif
120 #if __BSD_VISIBLE
121 #define	SIGWINCH	28	/* window size changes */
122 #define	SIGINFO		29	/* information request */
123 #endif
124 #if __POSIX_VISIBLE || __XSI_VISIBLE
125 #define	SIGUSR1		30	/* user defined signal 1 */
126 #define	SIGUSR2		31	/* user defined signal 2 */
127 #endif
128 #if __BSD_VISIBLE
129 #define	SIGTHR		32	/* reserved by thread library. */
130 #define	SIGLWP		SIGTHR
131 #define	SIGLIBRT	33	/* reserved by real-time library. */
132 #endif
133 
134 #define	SIGRTMIN	65
135 #define	SIGRTMAX	126
136 
137 #define	SIG_DFL		((__sighandler_t *)0)
138 #define	SIG_IGN		((__sighandler_t *)1)
139 #define	SIG_ERR		((__sighandler_t *)-1)
140 /* #define	SIG_CATCH	((__sighandler_t *)2) See signalvar.h */
141 #define SIG_HOLD        ((__sighandler_t *)3)
142 
143 /*
144  * Type of a signal handling function.
145  *
146  * Language spec sez signal handlers take exactly one arg, even though we
147  * actually supply three.  Ugh!
148  *
149  * We don't try to hide the difference by leaving out the args because
150  * that would cause warnings about conformant programs.  Nonconformant
151  * programs can avoid the warnings by casting to (__sighandler_t *) or
152  * sig_t before calling signal() or assigning to sa_handler or sv_handler.
153  *
154  * The kernel should reverse the cast before calling the function.  It
155  * has no way to do this, but on most machines 1-arg and 3-arg functions
156  * have the same calling protocol so there is no problem in practice.
157  * A bit in sa_flags could be used to specify the number of args.
158  */
159 typedef	void __sighandler_t(int);
160 
161 #if __POSIX_VISIBLE || __XSI_VISIBLE
162 #ifndef _SIGSET_T_DECLARED
163 #define	_SIGSET_T_DECLARED
164 typedef	__sigset_t	sigset_t;
165 #endif
166 #endif
167 
168 #if __POSIX_VISIBLE >= 199309 || __XSI_VISIBLE >= 500
169 union sigval {
170 	/* Members as suggested by Annex C of POSIX 1003.1b. */
171 	int	sival_int;
172 	void	*sival_ptr;
173 	/* 6.0 compatibility */
174 	int     sigval_int;
175 	void    *sigval_ptr;
176 };
177 
178 #if defined(_WANT_LWPINFO32) || (defined(_KERNEL) && defined(__LP64__))
179 union sigval32 {
180 	int	sival_int;
181 	uint32_t sival_ptr;
182 	/* 6.0 compatibility */
183 	int	sigval_int;
184 	uint32_t sigval_ptr;
185 };
186 #endif
187 #endif
188 
189 #if __POSIX_VISIBLE >= 199309
190 
191 struct pthread_attr;
192 
193 struct sigevent {
194 	int	sigev_notify;		/* Notification type */
195 	int	sigev_signo;		/* Signal number */
196 	union sigval sigev_value;	/* Signal value */
197 	union {
198 		__lwpid_t	_threadid;
199 		struct {
200 			void (*_function)(union sigval);
201 			struct pthread_attr **_attribute;
202 		} _sigev_thread;
203 		unsigned short _kevent_flags;
204 		long __spare__[8];
205 	} _sigev_un;
206 };
207 
208 #if __BSD_VISIBLE
209 #define	sigev_notify_kqueue		sigev_signo
210 #define	sigev_notify_kevent_flags	_sigev_un._kevent_flags
211 #define	sigev_notify_thread_id		_sigev_un._threadid
212 #endif
213 #define	sigev_notify_function		_sigev_un._sigev_thread._function
214 #define	sigev_notify_attributes		_sigev_un._sigev_thread._attribute
215 
216 #define	SIGEV_NONE	0		/* No async notification. */
217 #define	SIGEV_SIGNAL	1		/* Generate a queued signal. */
218 #define	SIGEV_THREAD	2		/* Call back from another pthread. */
219 #if __BSD_VISIBLE
220 #define	SIGEV_KEVENT	3		/* Generate a kevent. */
221 #define	SIGEV_THREAD_ID	4		/* Send signal to a kernel thread. */
222 #endif
223 
224 #endif /* __POSIX_VISIBLE >= 199309 */
225 
226 #if __POSIX_VISIBLE >= 199309 || __XSI_VISIBLE
227 typedef	struct __siginfo {
228 	int	si_signo;		/* signal number */
229 	int	si_errno;		/* errno association */
230 	/*
231 	 * Cause of signal, one of the SI_ macros or signal-specific
232 	 * values, i.e. one of the FPE_... values for SIGFPE.  This
233 	 * value is equivalent to the second argument to an old-style
234 	 * FreeBSD signal handler.
235 	 */
236 	int	si_code;		/* signal code */
237 	__pid_t	si_pid;			/* sending process */
238 	__uid_t	si_uid;			/* sender's ruid */
239 	int	si_status;		/* exit value */
240 	void	*si_addr;		/* faulting instruction */
241 	union sigval si_value;		/* signal value */
242 	union	{
243 		struct {
244 			int	_trapno;/* machine specific trap code */
245 		} _fault;
246 		struct {
247 			int	_timerid;
248 			int	_overrun;
249 		} _timer;
250 		struct {
251 			int	_mqd;
252 		} _mesgq;
253 		struct {
254 			long	_band;		/* band event for SIGPOLL */
255 		} _poll;			/* was this ever used ? */
256 		struct {
257 			long	__spare1__;
258 			int	__spare2__[7];
259 		} __spare__;
260 	} _reason;
261 } siginfo_t;
262 
263 #define si_trapno	_reason._fault._trapno
264 #define si_timerid	_reason._timer._timerid
265 #define si_overrun	_reason._timer._overrun
266 #define si_mqd		_reason._mesgq._mqd
267 #define si_band		_reason._poll._band
268 
269 #if defined(_WANT_LWPINFO32) || (defined(_KERNEL) && defined(__LP64__))
270 struct siginfo32 {
271 	int	si_signo;		/* signal number */
272 	int	si_errno;		/* errno association */
273 	int	si_code;		/* signal code */
274 	__pid_t	si_pid;			/* sending process */
275 	__uid_t	si_uid;			/* sender's ruid */
276 	int	si_status;		/* exit value */
277 	uint32_t si_addr;		/* faulting instruction */
278 	union sigval32 si_value;	/* signal value */
279 	union	{
280 		struct {
281 			int	_trapno;/* machine specific trap code */
282 		} _fault;
283 		struct {
284 			int	_timerid;
285 			int	_overrun;
286 		} _timer;
287 		struct {
288 			int	_mqd;
289 		} _mesgq;
290 		struct {
291 			int32_t	_band;		/* band event for SIGPOLL */
292 		} _poll;			/* was this ever used ? */
293 		struct {
294 			int32_t	__spare1__;
295 			int	__spare2__[7];
296 		} __spare__;
297 	} _reason;
298 };
299 #endif
300 
301 /** si_code **/
302 /* codes for SIGILL */
303 #define ILL_ILLOPC 	1	/* Illegal opcode.			*/
304 #define ILL_ILLOPN 	2	/* Illegal operand.			*/
305 #define ILL_ILLADR 	3	/* Illegal addressing mode.		*/
306 #define ILL_ILLTRP 	4	/* Illegal trap.			*/
307 #define ILL_PRVOPC 	5	/* Privileged opcode.			*/
308 #define ILL_PRVREG 	6	/* Privileged register.			*/
309 #define ILL_COPROC 	7	/* Coprocessor error.			*/
310 #define ILL_BADSTK 	8	/* Internal stack error.		*/
311 
312 /* codes for SIGBUS */
313 #define BUS_ADRALN	1	/* Invalid address alignment.		*/
314 #define BUS_ADRERR	2	/* Nonexistent physical address.	*/
315 #define BUS_OBJERR	3	/* Object-specific hardware error.	*/
316 
317 /* codes for SIGSEGV */
318 #define SEGV_MAPERR	1	/* Address not mapped to object.	*/
319 #define SEGV_ACCERR	2	/* Invalid permissions for mapped	*/
320 				/* object.				*/
321 
322 /* codes for SIGFPE */
323 #define FPE_INTOVF	1	/* Integer overflow.			*/
324 #define FPE_INTDIV	2	/* Integer divide by zero.		*/
325 #define FPE_FLTDIV	3	/* Floating point divide by zero.	*/
326 #define FPE_FLTOVF	4	/* Floating point overflow.		*/
327 #define FPE_FLTUND	5	/* Floating point underflow.		*/
328 #define FPE_FLTRES	6	/* Floating point inexact result.	*/
329 #define FPE_FLTINV	7	/* Invalid floating point operation.	*/
330 #define FPE_FLTSUB	8	/* Subscript out of range.		*/
331 
332 /* codes for SIGTRAP */
333 #define TRAP_BRKPT	1	/* Process breakpoint.			*/
334 #define TRAP_TRACE	2	/* Process trace trap.			*/
335 #define	TRAP_DTRACE	3	/* DTrace induced trap.			*/
336 #define	TRAP_CAP	4	/* Capabilities protective trap.	*/
337 
338 /* codes for SIGCHLD */
339 #define CLD_EXITED	1	/* Child has exited			*/
340 #define CLD_KILLED	2	/* Child has terminated abnormally but	*/
341 				/* did not create a core file		*/
342 #define CLD_DUMPED	3	/* Child has terminated abnormally and	*/
343 				/* created a core file			*/
344 #define CLD_TRAPPED	4	/* Traced child has trapped		*/
345 #define CLD_STOPPED	5	/* Child has stopped			*/
346 #define CLD_CONTINUED	6	/* Stopped child has continued		*/
347 
348 /* codes for SIGPOLL */
349 #define POLL_IN		1	/* Data input available			*/
350 #define POLL_OUT	2	/* Output buffers available		*/
351 #define POLL_MSG	3	/* Input message available		*/
352 #define POLL_ERR	4	/* I/O Error				*/
353 #define POLL_PRI	5	/* High priority input available	*/
354 #define POLL_HUP	6	/* Device disconnected			*/
355 
356 #endif
357 
358 #if __POSIX_VISIBLE || __XSI_VISIBLE
359 struct __siginfo;
360 
361 /*
362  * Signal vector "template" used in sigaction call.
363  */
364 struct sigaction {
365 	union {
366 		void    (*__sa_handler)(int);
367 		void    (*__sa_sigaction)(int, struct __siginfo *, void *);
368 	} __sigaction_u;		/* signal handler */
369 	int	sa_flags;		/* see signal options below */
370 	sigset_t sa_mask;		/* signal mask to apply */
371 };
372 
373 #define	sa_handler	__sigaction_u.__sa_handler
374 #endif
375 
376 #if __XSI_VISIBLE
377 /* If SA_SIGINFO is set, sa_sigaction must be used instead of sa_handler. */
378 #define	sa_sigaction	__sigaction_u.__sa_sigaction
379 #endif
380 
381 #if __POSIX_VISIBLE || __XSI_VISIBLE
382 #define	SA_NOCLDSTOP	0x0008	/* do not generate SIGCHLD on child stop */
383 #endif /* __POSIX_VISIBLE || __XSI_VISIBLE */
384 
385 #if __XSI_VISIBLE
386 #define	SA_ONSTACK	0x0001	/* take signal on signal stack */
387 #define	SA_RESTART	0x0002	/* restart system call on signal return */
388 #define	SA_RESETHAND	0x0004	/* reset to SIG_DFL when taking signal */
389 #define	SA_NODEFER	0x0010	/* don't mask the signal we're delivering */
390 #define	SA_NOCLDWAIT	0x0020	/* don't keep zombies around */
391 #define	SA_SIGINFO	0x0040	/* signal handler with SA_SIGINFO args */
392 #endif
393 
394 #if __BSD_VISIBLE
395 #define	NSIG		32	/* number of old signals (counting 0) */
396 #endif
397 
398 #if __POSIX_VISIBLE || __XSI_VISIBLE
399 #define	SI_NOINFO	0		/* No signal info besides si_signo. */
400 #define	SI_USER		0x10001		/* Signal sent by kill(). */
401 #define	SI_QUEUE	0x10002		/* Signal sent by the sigqueue(). */
402 #define	SI_TIMER	0x10003		/* Signal generated by expiration of */
403 					/* a timer set by timer_settime(). */
404 #define	SI_ASYNCIO	0x10004		/* Signal generated by completion of */
405 					/* an asynchronous I/O request.*/
406 #define	SI_MESGQ	0x10005		/* Signal generated by arrival of a */
407 					/* message on an empty message queue. */
408 #define	SI_KERNEL	0x10006
409 #define	SI_LWP		0x10007		/* Signal sent by thr_kill */
410 #endif
411 #if __BSD_VISIBLE
412 #define	SI_UNDEFINED	0
413 #endif
414 
415 #if __BSD_VISIBLE
416 typedef	__sighandler_t	*sig_t;	/* type of pointer to a signal function */
417 typedef	void __siginfohandler_t(int, struct __siginfo *, void *);
418 #endif
419 
420 #if __XSI_VISIBLE
421 #if __BSD_VISIBLE
422 #define	__stack_t sigaltstack
423 #endif
424 typedef	struct __stack_t stack_t;
425 
426 #define	SS_ONSTACK	0x0001	/* take signal on alternate stack */
427 #define	SS_DISABLE	0x0004	/* disable taking signals on alternate stack */
428 #define	MINSIGSTKSZ	__MINSIGSTKSZ		/* minimum stack size */
429 #define	SIGSTKSZ	(MINSIGSTKSZ + 32768)	/* recommended stack size */
430 #endif
431 
432 /*
433  * Structure used in sigaltstack call.  Its definition is always
434  * needed for __ucontext.  If __BSD_VISIBLE is defined, the structure
435  * tag is actually sigaltstack.
436  */
437 struct __stack_t {
438 	void	*ss_sp;			/* signal stack base */
439 	__size_t ss_size;		/* signal stack length */
440 	int	ss_flags;		/* SS_DISABLE and/or SS_ONSTACK */
441 };
442 
443 #if __BSD_VISIBLE
444 /*
445  * 4.3 compatibility:
446  * Signal vector "template" used in sigvec call.
447  */
448 struct sigvec {
449 	__sighandler_t *sv_handler;	/* signal handler */
450 	int	sv_mask;		/* signal mask to apply */
451 	int	sv_flags;		/* see signal options below */
452 };
453 
454 #define	SV_ONSTACK	SA_ONSTACK
455 #define	SV_INTERRUPT	SA_RESTART	/* same bit, opposite sense */
456 #define	SV_RESETHAND	SA_RESETHAND
457 #define	SV_NODEFER	SA_NODEFER
458 #define	SV_NOCLDSTOP	SA_NOCLDSTOP
459 #define	SV_SIGINFO	SA_SIGINFO
460 #define	sv_onstack	sv_flags	/* isn't compatibility wonderful! */
461 #endif
462 
463 /* Keep this in one place only */
464 #if defined(_KERNEL) && defined(COMPAT_43) && \
465     !defined(__i386__)
466 struct osigcontext {
467 	int _not_used;
468 };
469 #endif
470 
471 #if __XSI_VISIBLE
472 /*
473  * Structure used in sigstack call.
474  */
475 struct sigstack {
476 	void	*ss_sp;			/* signal stack pointer */
477 	int	ss_onstack;		/* current status */
478 };
479 #endif
480 
481 #if __BSD_VISIBLE || __POSIX_VISIBLE > 0 && __POSIX_VISIBLE <= 200112
482 /*
483  * Macro for converting signal number to a mask suitable for
484  * sigblock().
485  */
486 #define	sigmask(m)	(1 << ((m)-1))
487 #endif
488 
489 #if __BSD_VISIBLE
490 #define	BADSIG		SIG_ERR
491 #endif
492 
493 #if __POSIX_VISIBLE || __XSI_VISIBLE
494 /*
495  * Flags for sigprocmask:
496  */
497 #define	SIG_BLOCK	1	/* block specified signal set */
498 #define	SIG_UNBLOCK	2	/* unblock specified signal set */
499 #define	SIG_SETMASK	3	/* set specified signal set */
500 #endif
501 
502 /*
503  * For historical reasons; programs expect signal's return value to be
504  * defined by <sys/signal.h>.
505  */
506 __BEGIN_DECLS
507 __sighandler_t *signal(int, __sighandler_t *);
508 __END_DECLS
509 
510 #endif /* !_SYS_SIGNAL_H_ */
511