1/*
2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
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
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
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
67#include <sys/appleapiopts.h>
68
69#ifdef BSD_KERNEL_PRIVATE
70
71#include <stdatomic.h>
72
73/*
74 * Kernel signal definitions and data structures,
75 * not exported to user programs.
76 */
77
78/*
79 * Process signal actions and state, needed only within the process
80 * (not necessarily resident).
81 */
82struct sigacts {
83 user_addr_t ps_sigact[NSIG]; /* disposition of signals */
84 user_addr_t ps_trampact[NSIG]; /* disposition of signals */
85 sigset_t ps_catchmask[NSIG]; /* signals to be blocked */
86 sigset_t ps_sigonstack; /* signals to take on sigstack */
87 sigset_t ps_sigintr; /* signals that interrupt syscalls */
88 sigset_t ps_sigreset; /* signals that reset when caught */
89 sigset_t ps_signodefer; /* signals not masked while handled */
90 sigset_t ps_siginfo; /* signals that want SA_SIGINFO args */
91 sigset_t ps_oldmask; /* saved mask from before sigpause */
92 user_addr_t ps_sigreturn_token; /* random token used to validate sigreturn arguments */
93 _Atomic uint32_t ps_sigreturn_validation; /* sigreturn argument validation state */
94 int ps_flags; /* signal flags, below */
95 struct kern_sigaltstack ps_sigstk; /* sp, length & flags */
96 int ps_sig; /* for core dump/debugger XXX */
97 int ps_code; /* for core dump/debugger XXX */
98 int ps_addr; /* for core dump/debugger XXX */
99};
100
101/* signal flags */
102#define SAS_OLDMASK 0x01 /* need to restore mask before pause */
103#define SAS_ALTSTACK 0x02 /* have alternate signal stack */
104
105/*
106 * Additional signal action values, used only temporarily/internally; these
107 * values should be non-intersecting with values defined in signal.h, e.g.:
108 * SIG_IGN, SIG_DFL, SIG_ERR, SIG_IGN.
109 */
110#define KERN_SIG_CATCH CAST_USER_ADDR_T(2)
111#define KERN_SIG_HOLD CAST_USER_ADDR_T(3)
112#define KERN_SIG_WAIT CAST_USER_ADDR_T(4)
113
114/* Values for ps_sigreturn_validation */
115#define PS_SIGRETURN_VALIDATION_DEFAULT 0x0u
116#define PS_SIGRETURN_VALIDATION_ENABLED 0x1u
117#define PS_SIGRETURN_VALIDATION_DISABLED 0x2u
118
119/*
120 * get signal action for process and signal; currently only for current process
121 */
122#define SIGACTION(p, sig) (p->p_sigacts->ps_sigact[(sig)])
123
124/*
125 * Check for per-process and per thread signals.
126 */
127#define SHOULDissignal(p,uthreadp) \
128 (((uthreadp)->uu_siglist) \
129 & ~((((uthreadp)->uu_sigmask) \
130 | (((p)->p_lflag & P_LTRACED) ? 0 : (p)->p_sigignore)) \
131 & ~sigcantmask))
132
133/*
134 * Check for signals and per-thread signals.
135 * Use in trap() and syscall() before
136 * exiting kernel.
137 */
138#define CHECK_SIGNALS(p, thread, uthreadp) \
139 (!thread_should_halt(thread) \
140 && (SHOULDissignal(p,uthreadp)))
141
142/*
143 * Signal properties and actions.
144 * The array below categorizes the signals and their default actions
145 * according to the following properties:
146 */
147#define SA_KILL 0x01 /* terminates process by default */
148#define SA_CORE 0x02 /* ditto and coredumps */
149#define SA_STOP 0x04 /* suspend process */
150#define SA_TTYSTOP 0x08 /* ditto, from tty */
151#define SA_IGNORE 0x10 /* ignore by default */
152#define SA_CONT 0x20 /* continue if suspended */
153#define SA_CANTMASK 0x40 /* non-maskable, catchable */
154
155#ifdef SIGPROP
156int sigprop[NSIG] = {
157 0, /* unused */
158 SA_KILL, /* SIGHUP */
159 SA_KILL, /* SIGINT */
160 SA_KILL|SA_CORE, /* SIGQUIT */
161 SA_KILL|SA_CORE, /* SIGILL */
162 SA_KILL|SA_CORE, /* SIGTRAP */
163 SA_KILL|SA_CORE, /* SIGABRT */
164 SA_KILL|SA_CORE, /* SIGEMT */
165 SA_KILL|SA_CORE, /* SIGFPE */
166 SA_KILL, /* SIGKILL */
167 SA_KILL|SA_CORE, /* SIGBUS */
168 SA_KILL|SA_CORE, /* SIGSEGV */
169 SA_KILL|SA_CORE, /* SIGSYS */
170 SA_KILL, /* SIGPIPE */
171 SA_KILL, /* SIGALRM */
172 SA_KILL, /* SIGTERM */
173 SA_IGNORE, /* SIGURG */
174 SA_STOP, /* SIGSTOP */
175 SA_STOP|SA_TTYSTOP, /* SIGTSTP */
176 SA_IGNORE|SA_CONT, /* SIGCONT */
177 SA_IGNORE, /* SIGCHLD */
178 SA_STOP|SA_TTYSTOP, /* SIGTTIN */
179 SA_STOP|SA_TTYSTOP, /* SIGTTOU */
180 SA_IGNORE, /* SIGIO */
181 SA_KILL, /* SIGXCPU */
182 SA_KILL, /* SIGXFSZ */
183 SA_KILL, /* SIGVTALRM */
184 SA_KILL, /* SIGPROF */
185 SA_IGNORE, /* SIGWINCH */
186 SA_IGNORE, /* SIGINFO */
187 SA_KILL, /* SIGUSR1 */
188 SA_KILL, /* SIGUSR2 */
189};
190
191#define contsigmask (sigmask(SIGCONT))
192#define stopsigmask (sigmask(SIGSTOP) | sigmask(SIGTSTP) | \
193 sigmask(SIGTTIN) | sigmask(SIGTTOU))
194
195#endif /* SIGPROP */
196
197#define sigcantmask (sigmask(SIGKILL) | sigmask(SIGSTOP))
198
199#define SIGRESTRICTMASK (sigmask(SIGILL) | sigmask(SIGTRAP) | sigmask(SIGABRT) | \
200 sigmask(SIGFPE) | sigmask(SIGBUS) | sigmask(SIGSEGV) | \
201 sigmask(SIGSYS))
202
203extern unsigned sigrestrict_arg;
204
205/*
206 * Machine-independent functions:
207 */
208
209void execsigs(struct proc *p, thread_t thread);
210void gsignal(int pgid, int sig);
211int issignal_locked(struct proc *p);
212int CURSIG(struct proc *p);
213int clear_procsiglist(struct proc *p, int bit, int in_signalstart);
214int set_procsigmask(struct proc *p, int bit);
215void postsig_locked(int sig);
216void siginit(struct proc *p);
217void trapsignal(struct proc *p, int sig, unsigned code);
218void pt_setrunnable(struct proc *p);
219int hassigprop(int sig, int prop);
220int setsigvec(proc_t, thread_t, int signum, struct __kern_sigaction *, boolean_t in_sigstart);
221
222struct os_reason;
223/*
224 * Machine-dependent functions:
225 */
226void sendsig(struct proc *, /*sig_t*/ user_addr_t action, int sig,
227 int returnmask, uint32_t code);
228
229void psignal(struct proc *p, int sig);
230void psignal_with_reason(struct proc *p, int sig, struct os_reason *signal_reason);
231void psignal_locked(struct proc *, int);
232void psignal_try_thread(proc_t, thread_t, int signum);
233void psignal_try_thread_with_reason(proc_t, thread_t, int, struct os_reason*);
234void psignal_thread_with_reason(proc_t, thread_t, int, struct os_reason*);
235void psignal_uthread(thread_t, int);
236void pgsignal(struct pgrp *pgrp, int sig, int checkctty);
237void tty_pgsignal(struct tty * tp, int sig, int checkctty);
238void threadsignal(thread_t sig_actthread, int signum,
239 mach_exception_code_t code, boolean_t set_exitreason);
240int thread_issignal(proc_t p, thread_t th, sigset_t mask);
241void psignal_vfork(struct proc *p, task_t new_task, thread_t thread,
242 int signum);
243void psignal_vfork_with_reason(proc_t p, task_t new_task, thread_t thread,
244 int signum, struct os_reason *signal_reason);
245void signal_setast(thread_t sig_actthread);
246void pgsigio(pid_t pgid, int signalnum);
247
248void sig_lock_to_exit(struct proc *p);
249int sig_try_locked(struct proc *p);
250
251#endif /* BSD_KERNEL_PRIVATE */
252
253
254#ifdef XNU_KERNEL_PRIVATE
255
256/* Functions exported to Mach as well */
257
258#define COREDUMP_IGNORE_ULIMIT 0x0001 /* Ignore the process's core file ulimit. */
259#define COREDUMP_FULLFSYNC 0x0002 /* Run F_FULLFSYNC on the core file's vnode */
260
261int coredump(struct proc *p, uint32_t reserve_mb, int coredump_flags);
262void set_thread_exit_reason(void *th, void *reason, boolean_t proc_locked);
263
264#endif /* XNU_KERNEL_PRIVATE */
265
266
267#endif /* !_SYS_SIGNALVAR_H_ */
268