[apple/xnu.git] / bsd / sys / signalvar.h

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1991, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)signalvar.h	8.3 (Berkeley) 1/4/94
 */

#ifndef	_SYS_SIGNALVAR_H_		/* tmp for user.h */
#define	_SYS_SIGNALVAR_H_

#include <sys/appleapiopts.h>

#ifdef BSD_KERNEL_PRIVATE
/*
 * Kernel signal definitions and data structures,
 * not exported to user programs.
 */

/*
 * Process signal actions and state, needed only within the process
 * (not necessarily resident).
 */
struct	sigacts {
	user_addr_t	ps_sigact[NSIG];	/* disposition of signals */
	user_addr_t 	ps_trampact[NSIG];	/* disposition of signals */
	sigset_t ps_catchmask[NSIG];	/* signals to be blocked */
	sigset_t ps_sigonstack;		/* signals to take on sigstack */
	sigset_t ps_sigintr;		/* signals that interrupt syscalls */
	sigset_t ps_sigreset;		/* signals that reset when caught */
	sigset_t ps_signodefer;		/* signals not masked while handled */
	sigset_t ps_siginfo;		/* signals that want SA_SIGINFO args */
	sigset_t ps_oldmask;		/* saved mask from before sigpause */
	int	ps_flags;		/* signal flags, below */
	struct user_sigaltstack ps_sigstk;	/* sp, length & flags */
	int	ps_sig;			/* for core dump/debugger XXX */
	int	ps_code;		/* for core dump/debugger XXX */
	int	ps_addr;		/* for core dump/debugger XXX */
	sigset_t ps_usertramp;		/* SunOS compat; libc sigtramp XXX */
	sigset_t ps_64regset;		/* signals that want SA_EXSIGINFO args */
};

/* signal flags */
#define	SAS_OLDMASK	0x01		/* need to restore mask before pause */
#define	SAS_ALTSTACK	0x02		/* have alternate signal stack */

/*
 * Additional signal action values, used only temporarily/internally; these
 * values should be non-intersecting with values defined in signal.h, e.g.:
 * SIG_IGN, SIG_DFL, SIG_ERR, SIG_IGN.
 */
#define	KERN_SIG_CATCH	(void (*)(int))2
#define	KERN_SIG_HOLD	(void (*)(int))3
#define	KERN_SIG_WAIT	(void (*)(int))4

#define pgsigio(pgid, sig, notused) \
	{ \
	struct proc *p; \
	if (pgid < 0) \
		gsignal(-(pgid), sig);\
	else if (pgid > 0 && (p = pfind(pgid)) != 0) \
		psignal(p, sig); \
}

/*
 * get signal action for process and signal; currently only for current process
 */
#define SIGACTION(p, sig)	(p->p_sigacts->ps_sigact[(sig)])

/*
 *	Check for per-process and per thread signals.
 */
#define SHOULDissignal(p,uthreadp) \
	 (((uthreadp)->uu_siglist)	\
	  & ~((((uthreadp)->uu_sigmask) \
	       | (((p)->p_flag & P_TRACED) ? 0 : (p)->p_sigignore)) \
	      & ~sigcantmask))

/*
 *	Check for signals and per-thread signals.  
 *  Use in trap() and syscall() before
 *	exiting kernel.
 */
#define	CHECK_SIGNALS(p, thread, uthreadp)	\
	(!thread_should_halt(thread)	\
	 && (SHOULDissignal(p,uthreadp)))

/*
 * Signal properties and actions.
 * The array below categorizes the signals and their default actions
 * according to the following properties:
 */
#define	SA_KILL		0x01		/* terminates process by default */
#define	SA_CORE		0x02		/* ditto and coredumps */
#define	SA_STOP		0x04		/* suspend process */
#define	SA_TTYSTOP	0x08		/* ditto, from tty */
#define	SA_IGNORE	0x10		/* ignore by default */
#define	SA_CONT		0x20		/* continue if suspended */
#define	SA_CANTMASK	0x40		/* non-maskable, catchable */

#ifdef	SIGPROP
int sigprop[NSIG + 1] = {
	0,			/* unused */
	SA_KILL,		/* SIGHUP */
	SA_KILL,		/* SIGINT */
	SA_KILL|SA_CORE,	/* SIGQUIT */
	SA_KILL|SA_CORE,	/* SIGILL */
	SA_KILL|SA_CORE,	/* SIGTRAP */
	SA_KILL|SA_CORE,	/* SIGABRT */
	SA_KILL|SA_CORE,	/* SIGEMT */
	SA_KILL|SA_CORE,	/* SIGFPE */
	SA_KILL,		/* SIGKILL */
	SA_KILL|SA_CORE,	/* SIGBUS */
	SA_KILL|SA_CORE,	/* SIGSEGV */
	SA_KILL|SA_CORE,	/* SIGSYS */
	SA_KILL,		/* SIGPIPE */
	SA_KILL,		/* SIGALRM */
	SA_KILL,		/* SIGTERM */
	SA_IGNORE,		/* SIGURG */
	SA_STOP,		/* SIGSTOP */
	SA_STOP|SA_TTYSTOP,	/* SIGTSTP */
	SA_IGNORE|SA_CONT,	/* SIGCONT */
	SA_IGNORE,		/* SIGCHLD */
	SA_STOP|SA_TTYSTOP,	/* SIGTTIN */
	SA_STOP|SA_TTYSTOP,	/* SIGTTOU */
	SA_IGNORE,		/* SIGIO */
	SA_KILL,		/* SIGXCPU */
	SA_KILL,		/* SIGXFSZ */
	SA_KILL,		/* SIGVTALRM */
	SA_KILL,		/* SIGPROF */
	SA_IGNORE,		/* SIGWINCH  */
	SA_IGNORE,		/* SIGINFO */
	SA_KILL,		/* SIGUSR1 */
	SA_KILL,		/* SIGUSR2 */
};

#define	contsigmask	(sigmask(SIGCONT))
#define	stopsigmask	(sigmask(SIGSTOP) | sigmask(SIGTSTP) | \
			    sigmask(SIGTTIN) | sigmask(SIGTTOU))

#endif /* SIGPROP */

#define	sigcantmask	(sigmask(SIGKILL) | sigmask(SIGSTOP))

/*
 * Machine-independent functions:
 */
int	signal_lock(struct proc *);
int	signal_unlock(struct proc *);
int	coredump(struct proc *p);
void	execsigs(struct proc *p, thread_t thread);
void	gsignal(int pgid, int sig);
int	issignal(struct proc *p);
int	CURSIG(struct proc *p);
int clear_procsiglist(struct proc *p, int bit);
int clear_procsigmask(struct proc *p, int bit);
int set_procsigmask(struct proc *p, int bit);
void	tty_pgsignal(struct pgrp *pgrp, int sig);
void	postsig(int sig);
void	siginit(struct proc *p);
void	trapsignal(struct proc *p, int sig, unsigned code);
void	pt_setrunnable(struct proc *p);

/*
 * Machine-dependent functions:
 */
void	sendsig(struct proc *, /*sig_t*/ user_addr_t  action, int sig,
	int returnmask, u_long code);

void	psignal(struct proc *p, int sig);
void	pgsignal(struct pgrp *pgrp, int sig, int checkctty);
void	threadsignal(thread_t sig_actthread, int signum, u_long code);
int	thread_issignal(proc_t p, thread_t th, sigset_t mask);
void	psignal_vfork(struct proc *p, task_t new_task, thread_t thr_act,
		int signum);
void	psignal_vtalarm(struct proc *);
void	psignal_xcpu(struct proc *);
void	psignal_sigprof(struct proc *);
void	psignal_lock(struct proc *, int, int);
void	signal_setast(thread_t sig_actthread);

/* XXX not really very "inline"... */
__inline__ void sig_lock_to_exit(struct proc *p);
__inline__ int sig_try_locked(struct proc *p);

#endif	/* BSD_KERNEL_PRIVATE */

#endif	/* !_SYS_SIGNALVAR_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
8f6c56a5 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	29	/*
	30	* Copyright (c) 1991, 1993
	31	* The Regents of the University of California. All rights reserved.
	32	*
	33	* Redistribution and use in source and binary forms, with or without
	34	* modification, are permitted provided that the following conditions
	35	* are met:
	36	* 1. Redistributions of source code must retain the above copyright
	37	* notice, this list of conditions and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. All advertising materials mentioning features or use of this software
	42	* must display the following acknowledgement:
	43	* This product includes software developed by the University of
	44	* California, Berkeley and its contributors.
	45	* 4. Neither the name of the University nor the names of its contributors
	46	* may be used to endorse or promote products derived from this software
	47	* without specific prior written permission.
	48	*
	49	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	50	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	51	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	52	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	53	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	54	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	55	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	56	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	57	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	58	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	59	* SUCH DAMAGE.
	60	*
	61	* @(#)signalvar.h 8.3 (Berkeley) 1/4/94
	62	*/
	63
	64	#ifndef _SYS_SIGNALVAR_H_ /* tmp for user.h */
	65	#define _SYS_SIGNALVAR_H_
	66
9bccf70c A	67	#include <sys/appleapiopts.h>
9bccf70c A	68
91447636	69	#ifdef BSD_KERNEL_PRIVATE
1c79356b A	70	/*
	71	* Kernel signal definitions and data structures,
	72	* not exported to user programs.
	73	*/
	74
	75	/*
	76	* Process signal actions and state, needed only within the process
	77	* (not necessarily resident).
	78	*/
	79	struct sigacts {
91447636 A	80	user_addr_t ps_sigact[NSIG]; /* disposition of signals */
91447636 A	81	user_addr_t ps_trampact[NSIG]; /* disposition of signals */
1c79356b A	82	sigset_t ps_catchmask[NSIG]; /* signals to be blocked */
	83	sigset_t ps_sigonstack; /* signals to take on sigstack */
	84	sigset_t ps_sigintr; /* signals that interrupt syscalls */
9bccf70c A	85	sigset_t ps_sigreset; /* signals that reset when caught */
	86	sigset_t ps_signodefer; /* signals not masked while handled */
	87	sigset_t ps_siginfo; /* signals that want SA_SIGINFO args */
1c79356b A	88	sigset_t ps_oldmask; /* saved mask from before sigpause */
1c79356b A	89	int ps_flags; /* signal flags, below */
91447636	90	struct user_sigaltstack ps_sigstk; /* sp, length & flags */
1c79356b A	91	int ps_sig; /* for core dump/debugger XXX */
	92	int ps_code; /* for core dump/debugger XXX */
	93	int ps_addr; /* for core dump/debugger XXX */
	94	sigset_t ps_usertramp; /* SunOS compat; libc sigtramp XXX */
55e303ae	95	sigset_t ps_64regset; /* signals that want SA_EXSIGINFO args */
1c79356b A	96	};
	97
	98	/* signal flags */
	99	#define SAS_OLDMASK 0x01 /* need to restore mask before pause */
	100	#define SAS_ALTSTACK 0x02 /* have alternate signal stack */
	101
91447636 A	102	/*
	103	* Additional signal action values, used only temporarily/internally; these
	104	* values should be non-intersecting with values defined in signal.h, e.g.:
	105	* SIG_IGN, SIG_DFL, SIG_ERR, SIG_IGN.
	106	*/
	107	#define KERN_SIG_CATCH (void (*)(int))2
	108	#define KERN_SIG_HOLD (void (*)(int))3
	109	#define KERN_SIG_WAIT (void (*)(int))4
1c79356b A	110
	111	#define pgsigio(pgid, sig, notused) \
	112	{ \
	113	struct proc *p; \
	114	if (pgid < 0) \
	115	gsignal(-(pgid), sig);\
	116	else if (pgid > 0 && (p = pfind(pgid)) != 0) \
	117	psignal(p, sig); \
	118	}
	119
1c79356b A	120	/*
	121	* get signal action for process and signal; currently only for current process
	122	*/
	123	#define SIGACTION(p, sig) (p->p_sigacts->ps_sigact[(sig)])
	124
1c79356b A	125	/*
	126	* Check for per-process and per thread signals.
	127	*/
	128	#define SHOULDissignal(p,uthreadp) \
9bccf70c A	129	(((uthreadp)->uu_siglist) \
9bccf70c A	130	& ~((((uthreadp)->uu_sigmask) \
1c79356b A	131	\| (((p)->p_flag & P_TRACED) ? 0 : (p)->p_sigignore)) \
	132	& ~sigcantmask))
	133
	134	/*
	135	* Check for signals and per-thread signals.
	136	* Use in trap() and syscall() before
	137	* exiting kernel.
	138	*/
	139	#define CHECK_SIGNALS(p, thread, uthreadp) \
	140	(!thread_should_halt(thread) \
	141	&& (SHOULDissignal(p,uthreadp)))
	142
1c79356b A	143	/*
	144	* Signal properties and actions.
	145	* The array below categorizes the signals and their default actions
	146	* according to the following properties:
	147	*/
	148	#define SA_KILL 0x01 /* terminates process by default */
	149	#define SA_CORE 0x02 /* ditto and coredumps */
	150	#define SA_STOP 0x04 /* suspend process */
	151	#define SA_TTYSTOP 0x08 /* ditto, from tty */
	152	#define SA_IGNORE 0x10 /* ignore by default */
	153	#define SA_CONT 0x20 /* continue if suspended */
	154	#define SA_CANTMASK 0x40 /* non-maskable, catchable */
	155
	156	#ifdef SIGPROP
	157	int sigprop[NSIG + 1] = {
	158	0, /* unused */
	159	SA_KILL, /* SIGHUP */
	160	SA_KILL, /* SIGINT */
	161	SA_KILL\|SA_CORE, /* SIGQUIT */
	162	SA_KILL\|SA_CORE, /* SIGILL */
	163	SA_KILL\|SA_CORE, /* SIGTRAP */
	164	SA_KILL\|SA_CORE, /* SIGABRT */
	165	SA_KILL\|SA_CORE, /* SIGEMT */
	166	SA_KILL\|SA_CORE, /* SIGFPE */
	167	SA_KILL, /* SIGKILL */
	168	SA_KILL\|SA_CORE, /* SIGBUS */
	169	SA_KILL\|SA_CORE, /* SIGSEGV */
	170	SA_KILL\|SA_CORE, /* SIGSYS */
	171	SA_KILL, /* SIGPIPE */
	172	SA_KILL, /* SIGALRM */
	173	SA_KILL, /* SIGTERM */
	174	SA_IGNORE, /* SIGURG */
	175	SA_STOP, /* SIGSTOP */
	176	SA_STOP\|SA_TTYSTOP, /* SIGTSTP */
	177	SA_IGNORE\|SA_CONT, /* SIGCONT */
	178	SA_IGNORE, /* SIGCHLD */
	179	SA_STOP\|SA_TTYSTOP, /* SIGTTIN */
	180	SA_STOP\|SA_TTYSTOP, /* SIGTTOU */
	181	SA_IGNORE, /* SIGIO */
	182	SA_KILL, /* SIGXCPU */
	183	SA_KILL, /* SIGXFSZ */
	184	SA_KILL, /* SIGVTALRM */
	185	SA_KILL, /* SIGPROF */
	186	SA_IGNORE, /* SIGWINCH */
	187	SA_IGNORE, /* SIGINFO */
	188	SA_KILL, /* SIGUSR1 */
	189	SA_KILL, /* SIGUSR2 */
	190	};
	191
	192	#define contsigmask (sigmask(SIGCONT))
	193	#define stopsigmask (sigmask(SIGSTOP) \| sigmask(SIGTSTP) \| \
	194	sigmask(SIGTTIN) \| sigmask(SIGTTOU))
	195
	196	#endif /* SIGPROP */
	197
	198	#define sigcantmask (sigmask(SIGKILL) \| sigmask(SIGSTOP))
	199
1c79356b A	200	/*
	201	* Machine-independent functions:
	202	*/
91447636 A	203	int signal_lock(struct proc *);
	204	int signal_unlock(struct proc *);
	205	int coredump(struct proc *p);
	206	void execsigs(struct proc *p, thread_t thread);
	207	void gsignal(int pgid, int sig);
	208	int issignal(struct proc *p);
	209	int CURSIG(struct proc *p);
	210	int clear_procsiglist(struct proc *p, int bit);
	211	int clear_procsigmask(struct proc *p, int bit);
	212	int set_procsigmask(struct proc *p, int bit);
	213	void tty_pgsignal(struct pgrp *pgrp, int sig);
	214	void postsig(int sig);
	215	void siginit(struct proc *p);
	216	void trapsignal(struct proc *p, int sig, unsigned code);
	217	void pt_setrunnable(struct proc *p);
1c79356b A	218
	219	/*
	220	* Machine-dependent functions:
	221	*/
91447636 A	222	void sendsig(struct proc , /sig_t*/ user_addr_t action, int sig,
	223	int returnmask, u_long code);
	224
	225	void psignal(struct proc *p, int sig);
	226	void pgsignal(struct pgrp *pgrp, int sig, int checkctty);
	227	void threadsignal(thread_t sig_actthread, int signum, u_long code);
	228	int thread_issignal(proc_t p, thread_t th, sigset_t mask);
	229	void psignal_vfork(struct proc *p, task_t new_task, thread_t thr_act,
	230	int signum);
	231	void psignal_vtalarm(struct proc *);
	232	void psignal_xcpu(struct proc *);
	233	void psignal_sigprof(struct proc *);
	234	void psignal_lock(struct proc *, int, int);
	235	void signal_setast(thread_t sig_actthread);
	236
	237	/* XXX not really very "inline"... */
	238	__inline__ void sig_lock_to_exit(struct proc *p);
	239	__inline__ int sig_try_locked(struct proc *p);
	240
	241	#endif /* BSD_KERNEL_PRIVATE */
9bccf70c	242
1c79356b	243	#endif /* !_SYS_SIGNALVAR_H_ */