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