xref: /dragonfly/sys/sys/signal.h (revision 335b9e93)
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/_siginfo.h>
44 #include <sys/_sigset.h>
45 #include <machine/stdint.h>
46 
47 #ifndef _PID_T_DECLARED
48 typedef	__pid_t		pid_t;
49 #define	_PID_T_DECLARED
50 #endif
51 
52 #ifndef _SIZE_T_DECLARED
53 typedef	__size_t	size_t;
54 #define	_SIZE_T_DECLARED
55 #endif
56 
57 #ifndef _UID_T_DECLARED
58 typedef	__uint32_t	uid_t;
59 #define	_UID_T_DECLARED
60 #endif
61 
62 /*
63  * sigset_t macros.
64  */
65 #define	_SIG_MAXSIG	128
66 #define	_SIG_IDX(sig)	((sig) - 1)
67 #define	_SIG_WORD(sig)	(_SIG_IDX(sig) >> 5)
68 #define	_SIG_BIT(sig)	(1 << (_SIG_IDX(sig) & 31))
69 #define	_SIG_VALID(sig)	((sig) < _SIG_MAXSIG && (sig) > 0)
70 
71 /*
72  * System defined signals.
73  */
74 #if __POSIX_VISIBLE
75 #define	SIGHUP		1	/* hangup */
76 #endif
77 #define	SIGINT		2	/* interrupt */
78 #if __POSIX_VISIBLE
79 #define	SIGQUIT		3	/* quit */
80 #endif
81 #define	SIGILL		4	/* illegal instr. (not reset when caught) */
82 #if __XSI_VISIBLE
83 #define	SIGTRAP		5	/* trace trap (not reset when caught) */
84 #endif
85 #define	SIGABRT		6	/* abort() */
86 #if __BSD_VISIBLE
87 #define	SIGIOT		SIGABRT	/* compatibility */
88 #define	SIGEMT		7	/* EMT instruction */
89 #endif
90 #define	SIGFPE		8	/* floating point exception */
91 #if __POSIX_VISIBLE
92 #define	SIGKILL		9	/* kill (cannot be caught or ignored) */
93 #endif
94 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
95 #define	SIGBUS		10	/* bus error */
96 #endif
97 #define	SIGSEGV		11	/* segmentation violation */
98 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
99 #define	SIGSYS		12	/* non-existent system call invoked */
100 #endif
101 #if __POSIX_VISIBLE
102 #define	SIGPIPE		13	/* write on a pipe with no one to read it */
103 #define	SIGALRM		14	/* alarm clock */
104 #endif
105 #define	SIGTERM		15	/* software termination signal from kill */
106 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
107 #define	SIGURG		16	/* urgent condition on IO channel */
108 #endif
109 #if __POSIX_VISIBLE
110 #define	SIGSTOP		17	/* sendable stop signal not from tty */
111 #define	SIGTSTP		18	/* stop signal from tty */
112 #define	SIGCONT		19	/* continue a stopped process */
113 #define	SIGCHLD		20	/* to parent on child stop or exit */
114 #define	SIGTTIN		21	/* to readers pgrp upon background tty read */
115 #define	SIGTTOU		22	/* like TTIN if (tp->t_local&LTOSTOP) */
116 #endif
117 #if __BSD_VISIBLE
118 #define	SIGIO		23	/* input/output possible signal */
119 #endif
120 #if __XSI_VISIBLE
121 #define	SIGXCPU		24	/* exceeded CPU time limit */
122 #define	SIGXFSZ		25	/* exceeded file size limit */
123 #define	SIGVTALRM	26	/* virtual time alarm */
124 #define	SIGPROF		27	/* profiling time alarm */
125 #endif
126 #if __BSD_VISIBLE
127 #define	SIGWINCH	28	/* window size changes */
128 #define	SIGINFO		29	/* information request */
129 #endif
130 #if __POSIX_VISIBLE
131 #define	SIGUSR1		30	/* user defined signal 1 */
132 #define	SIGUSR2		31	/* user defined signal 2 */
133 #endif
134 #if __BSD_VISIBLE
135 #define	SIGTHR		32	/* Thread interrupt (FreeBSD-5 reserved) */
136 #define	SIGCKPT		33	/* checkpoint and continue */
137 #define	SIGCKPTEXIT	34	/* checkpoint and exit */
138 #endif
139 
140 /*-
141  * Type of a signal handling function.
142  *
143  * Language spec sez signal handlers take exactly one arg, even though we
144  * actually supply three.  Ugh!
145  *
146  * We don't try to hide the difference by leaving out the args because
147  * that would cause warnings about conformant programs.  Nonconformant
148  * programs can avoid the warnings by casting to (__sighandler_t *) or
149  * sig_t before calling signal() or assigning to sa_handler or sv_handler.
150  *
151  * The kernel should reverse the cast before calling the function.  It
152  * has no way to do this, but on most machines 1-arg and 3-arg functions
153  * have the same calling protocol so there is no problem in practice.
154  * A bit in sa_flags could be used to specify the number of args.
155  *
156  * SIG_EINTR causes system calls to interrupt but generates no signal
157  * delivery.  The caller is responsible for polling the event.
158  */
159 typedef	void __sighandler_t (int);
160 
161 #define	SIG_DFL		((__sighandler_t *)0)
162 #define	SIG_IGN		((__sighandler_t *)1)
163 #define	SIG_ERR		((__sighandler_t *)-1)
164 
165 #if __POSIX_VISIBLE >= 199309
166 struct sigevent {
167 	int	sigev_notify;		/* Notification type */
168 	union {
169 		int	__sigev_signo;	/* Signal number */
170 		int	__sigev_notify_kqueue;
171 		pthread_attr_t *__sigev_notify_attributes;
172 	} __sigev_u;
173 	union sigval sigev_value;	/* Signal value */
174 	void (*sigev_notify_function)(union sigval);
175 };
176 #define	sigev_signo		__sigev_u.__sigev_signo
177 #define	sigev_notify_attributes	__sigev_u.__sigev_notify_attributes
178 #if __BSD_VISIBLE
179 #define	sigev_notify_kqueue	__sigev_u.__sigev_notify_kqueue
180 #endif
181 
182 #define	SIGEV_NONE	0		/* No async notification */
183 #define	SIGEV_SIGNAL	1		/* Generate a queued signal */
184 #define	SIGEV_THREAD	2		/* Call back in a pthread */
185 #if __BSD_VISIBLE
186 #define	SIGEV_KEVENT	3		/* Generate a kevent */
187 #endif
188 #endif /* __POSIX_VISIBLE >= 199309 */
189 
190 #ifndef _SIGSET_T_DECLARED
191 typedef	struct __sigset	sigset_t;
192 #define	_SIGSET_T_DECLARED
193 #endif
194 
195 /*
196  * XXX - there are some nasty dependencies on include file order. Now that
197  * sigset_t has been defined we can include the MD header.
198  */
199 #include <machine/signal.h>     /* sig_atomic_t; trap codes; sigcontext */
200 
201 #if __POSIX_VISIBLE
202 struct __siginfo;
203 
204 /*
205  * Signal vector "template" used in sigaction call.
206  */
207 struct	sigaction {
208 	union {
209 		void    (*__sa_handler) (int);
210 		void    (*__sa_sigaction) (int, struct __siginfo *, void *);
211 	} __sigaction_u;		/* signal handler */
212 	int	sa_flags;		/* see signal options below */
213 	sigset_t sa_mask;		/* signal mask to apply */
214 };
215 
216 /* if SA_SIGINFO is set, sa_sigaction is to be used instead of sa_handler. */
217 #define	sa_handler	__sigaction_u.__sa_handler
218 
219 #define	SA_NOCLDSTOP	0x0008	/* do not generate SIGCHLD on child stop */
220 #endif /* __POSIX_VISIBLE */
221 
222 #if __XSI_VISIBLE
223 #define	sa_sigaction	__sigaction_u.__sa_sigaction
224 #endif
225 
226 #if __XSI_VISIBLE
227 #define	SA_ONSTACK	0x0001	/* take signal on signal stack */
228 #define	SA_RESTART	0x0002	/* restart system call on signal return */
229 #define	SA_RESETHAND	0x0004	/* reset to SIG_DFL when taking signal */
230 #define	SA_NODEFER	0x0010	/* don't mask the signal we're delivering */
231 #define	SA_NOCLDWAIT	0x0020	/* don't keep zombies around */
232 #define	SA_SIGINFO	0x0040	/* signal handler with SA_SIGINFO args */
233 #endif
234 
235 #if __BSD_VISIBLE
236 #define	NSIG		64	/* size of sigptbl */
237 
238 /* Additional FreeBSD values. */
239 #define	SI_UNDEFINED	0
240 
241 typedef	void __siginfohandler_t (int, siginfo_t *, void *);
242 
243 #endif
244 
245 /* XXX this should really be under __BSD_VISIBLE */
246 typedef	__sighandler_t	*sig_t;	/* type of pointer to a signal function */
247 
248 /* #if __XSI_VISIBLE */
249 /*
250  * Structure used in sigaltstack call.
251  */
252 #if __BSD_VISIBLE
253 typedef	struct sigaltstack {
254 #else
255 typedef	struct {
256 #endif
257 	void	*ss_sp;			/* signal stack base */
258 	size_t	ss_size;		/* signal stack length */
259 	int	ss_flags;		/* SS_DISABLE and/or SS_ONSTACK */
260 } stack_t;
261 
262 #define	SS_ONSTACK	0x0001	/* take signal on alternate stack */
263 #define	SS_DISABLE	0x0004	/* disable taking signals on alternate stack */
264 #define	MINSIGSTKSZ	8192			/* minimum allowable stack */
265 #define	SIGSTKSZ	(MINSIGSTKSZ + 32768)	/* recommended stack size */
266 /* #endif */
267 
268 /* Have enough typedefs for this now.  XXX */
269 #include <sys/ucontext.h>
270 
271 #if __BSD_VISIBLE
272 /*
273  * 4.3 compatibility:
274  * Signal vector "template" used in sigvec call.
275  */
276 struct	sigvec {
277 	__sighandler_t *sv_handler;	/* signal handler */
278 	int	sv_mask;		/* signal mask to apply */
279 	int	sv_flags;		/* see signal options below */
280 };
281 
282 #define	SV_ONSTACK	SA_ONSTACK
283 #define	SV_INTERRUPT	SA_RESTART	/* same bit, opposite sense */
284 #define	SV_RESETHAND	SA_RESETHAND
285 #define	SV_NODEFER	SA_NODEFER
286 #define	SV_NOCLDSTOP	SA_NOCLDSTOP
287 #define	SV_SIGINFO	SA_SIGINFO
288 #define	sv_onstack sv_flags	/* isn't compatibility wonderful! */
289 #endif
290 
291 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200809)
292 /*
293  * Macro for converting signal number to a mask suitable for
294  * sigblock().
295  */
296 #define	sigmask(m)	(1 << ((m)-1))
297 #endif
298 
299 #if __BSD_VISIBLE
300 #define	BADSIG		SIG_ERR
301 #endif
302 
303 #if __POSIX_VISIBLE
304 /*
305  * Flags for sigprocmask:
306  */
307 #define	SIG_BLOCK	1	/* block specified signal set */
308 #define	SIG_UNBLOCK	2	/* unblock specified signal set */
309 #define	SIG_SETMASK	3	/* set specified signal set */
310 #endif
311 
312 /*
313  * For historical reasons; programs expect signal's return value to be
314  * defined by <sys/signal.h>.
315  */
316 __BEGIN_DECLS
317 __sighandler_t *signal(int, __sighandler_t *);
318 #if __BSD_VISIBLE
319 int sigblockall(void);
320 int sigunblockall(void);
321 #endif
322 __END_DECLS
323 
324 #endif	/* !_SYS_SIGNAL_H_ */
325