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