xref: /freebsd/sys/kern/subr_trap.c (revision 145992504973bd16cf3518af9ba5ce185fefa82a)
1 /*-
2  * Copyright (C) 1994, David Greenman
3  * Copyright (c) 1990, 1993
4  *	The Regents of the University of California.  All rights reserved.
5  * Copyright (c) 2007 The FreeBSD Foundation
6  *
7  * This code is derived from software contributed to Berkeley by
8  * the University of Utah, and William Jolitz.
9  *
10  * Portions of this software were developed by A. Joseph Koshy under
11  * sponsorship from the FreeBSD Foundation and Google, Inc.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. All advertising materials mentioning features or use of this software
22  *    must display the following acknowledgement:
23  *	This product includes software developed by the University of
24  *	California, Berkeley and its contributors.
25  * 4. Neither the name of the University nor the names of its contributors
26  *    may be used to endorse or promote products derived from this software
27  *    without specific prior written permission.
28  *
29  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39  * SUCH DAMAGE.
40  *
41  *	from: @(#)trap.c	7.4 (Berkeley) 5/13/91
42  */
43 
44 #include <sys/cdefs.h>
45 __FBSDID("$FreeBSD$");
46 
47 #include "opt_hwpmc_hooks.h"
48 #include "opt_ktrace.h"
49 #include "opt_kdtrace.h"
50 #include "opt_sched.h"
51 
52 #include <sys/param.h>
53 #include <sys/bus.h>
54 #include <sys/capability.h>
55 #include <sys/kernel.h>
56 #include <sys/lock.h>
57 #include <sys/mutex.h>
58 #include <sys/pmckern.h>
59 #include <sys/proc.h>
60 #include <sys/ktr.h>
61 #include <sys/pioctl.h>
62 #include <sys/ptrace.h>
63 #include <sys/resourcevar.h>
64 #include <sys/sched.h>
65 #include <sys/signalvar.h>
66 #include <sys/syscall.h>
67 #include <sys/syscallsubr.h>
68 #include <sys/sysent.h>
69 #include <sys/systm.h>
70 #include <sys/vmmeter.h>
71 #ifdef KTRACE
72 #include <sys/uio.h>
73 #include <sys/ktrace.h>
74 #endif
75 #include <security/audit/audit.h>
76 
77 #include <machine/cpu.h>
78 
79 #ifdef VIMAGE
80 #include <net/vnet.h>
81 #endif
82 
83 #ifdef XEN
84 #include <vm/vm.h>
85 #include <vm/vm_param.h>
86 #include <vm/pmap.h>
87 #endif
88 
89 #ifdef	HWPMC_HOOKS
90 #include <sys/pmckern.h>
91 #endif
92 
93 #include <security/mac/mac_framework.h>
94 
95 /*
96  * Define the code needed before returning to user mode, for trap and
97  * syscall.
98  */
99 void
100 userret(struct thread *td, struct trapframe *frame)
101 {
102 	struct proc *p = td->td_proc;
103 
104 	CTR3(KTR_SYSC, "userret: thread %p (pid %d, %s)", td, p->p_pid,
105             td->td_name);
106 	KASSERT((p->p_flag & P_WEXIT) == 0,
107 	    ("Exiting process returns to usermode"));
108 #if 0
109 #ifdef DIAGNOSTIC
110 	/* Check that we called signotify() enough. */
111 	PROC_LOCK(p);
112 	thread_lock(td);
113 	if (SIGPENDING(td) && ((td->td_flags & TDF_NEEDSIGCHK) == 0 ||
114 	    (td->td_flags & TDF_ASTPENDING) == 0))
115 		printf("failed to set signal flags properly for ast()\n");
116 	thread_unlock(td);
117 	PROC_UNLOCK(p);
118 #endif
119 #endif
120 #ifdef KTRACE
121 	KTRUSERRET(td);
122 #endif
123 	/*
124 	 * If this thread tickled GEOM, we need to wait for the giggling to
125 	 * stop before we return to userland
126 	 */
127 	if (td->td_pflags & TDP_GEOM)
128 		g_waitidle();
129 
130 	/*
131 	 * Charge system time if profiling.
132 	 */
133 	if (p->p_flag & P_PROFIL)
134 		addupc_task(td, TRAPF_PC(frame), td->td_pticks * psratio);
135 	/*
136 	 * Let the scheduler adjust our priority etc.
137 	 */
138 	sched_userret(td);
139 #ifdef XEN
140 	PT_UPDATES_FLUSH();
141 #endif
142 
143 	/*
144 	 * Check for misbehavior.
145 	 */
146 	WITNESS_WARN(WARN_PANIC, NULL, "userret: returning");
147 	KASSERT(td->td_critnest == 0,
148 	    ("userret: Returning in a critical section"));
149 	KASSERT(td->td_locks == 0,
150 	    ("userret: Returning with %d locks held", td->td_locks));
151 	KASSERT((td->td_pflags & TDP_NOFAULTING) == 0,
152 	    ("userret: Returning with pagefaults disabled"));
153 	KASSERT((td->td_pflags & TDP_NOSLEEPING) == 0,
154 	    ("userret: Returning with sleep disabled"));
155 	KASSERT(td->td_pinned == 0,
156 	    ("userret: Returning with with pinned thread"));
157 	KASSERT(td->td_vp_reserv == 0,
158 	    ("userret: Returning while holding vnode reservation"));
159 #ifdef VIMAGE
160 	/* Unfortunately td_vnet_lpush needs VNET_DEBUG. */
161 	VNET_ASSERT(curvnet == NULL,
162 	    ("%s: Returning on td %p (pid %d, %s) with vnet %p set in %s",
163 	    __func__, td, p->p_pid, td->td_name, curvnet,
164 	    (td->td_vnet_lpush != NULL) ? td->td_vnet_lpush : "N/A"));
165 #endif
166 }
167 
168 /*
169  * Process an asynchronous software trap.
170  * This is relatively easy.
171  * This function will return with preemption disabled.
172  */
173 void
174 ast(struct trapframe *framep)
175 {
176 	struct thread *td;
177 	struct proc *p;
178 	int flags;
179 	int sig;
180 
181 	td = curthread;
182 	p = td->td_proc;
183 
184 	CTR3(KTR_SYSC, "ast: thread %p (pid %d, %s)", td, p->p_pid,
185             p->p_comm);
186 	KASSERT(TRAPF_USERMODE(framep), ("ast in kernel mode"));
187 	WITNESS_WARN(WARN_PANIC, NULL, "Returning to user mode");
188 	mtx_assert(&Giant, MA_NOTOWNED);
189 	THREAD_LOCK_ASSERT(td, MA_NOTOWNED);
190 	td->td_frame = framep;
191 	td->td_pticks = 0;
192 
193 	/*
194 	 * This updates the td_flag's for the checks below in one
195 	 * "atomic" operation with turning off the astpending flag.
196 	 * If another AST is triggered while we are handling the
197 	 * AST's saved in flags, the astpending flag will be set and
198 	 * ast() will be called again.
199 	 */
200 	thread_lock(td);
201 	flags = td->td_flags;
202 	td->td_flags &= ~(TDF_ASTPENDING | TDF_NEEDSIGCHK | TDF_NEEDSUSPCHK |
203 	    TDF_NEEDRESCHED | TDF_ALRMPEND | TDF_PROFPEND | TDF_MACPEND);
204 	thread_unlock(td);
205 	PCPU_INC(cnt.v_trap);
206 
207 	if (td->td_ucred != p->p_ucred)
208 		cred_update_thread(td);
209 	if (td->td_pflags & TDP_OWEUPC && p->p_flag & P_PROFIL) {
210 		addupc_task(td, td->td_profil_addr, td->td_profil_ticks);
211 		td->td_profil_ticks = 0;
212 		td->td_pflags &= ~TDP_OWEUPC;
213 	}
214 #ifdef HWPMC_HOOKS
215 	/* Handle Software PMC callchain capture. */
216 	if (PMC_IS_PENDING_CALLCHAIN(td))
217 		PMC_CALL_HOOK_UNLOCKED(td, PMC_FN_USER_CALLCHAIN_SOFT, (void *) framep);
218 #endif
219 	if (flags & TDF_ALRMPEND) {
220 		PROC_LOCK(p);
221 		kern_psignal(p, SIGVTALRM);
222 		PROC_UNLOCK(p);
223 	}
224 	if (flags & TDF_PROFPEND) {
225 		PROC_LOCK(p);
226 		kern_psignal(p, SIGPROF);
227 		PROC_UNLOCK(p);
228 	}
229 #ifdef MAC
230 	if (flags & TDF_MACPEND)
231 		mac_thread_userret(td);
232 #endif
233 	if (flags & TDF_NEEDRESCHED) {
234 #ifdef KTRACE
235 		if (KTRPOINT(td, KTR_CSW))
236 			ktrcsw(1, 1, __func__);
237 #endif
238 		thread_lock(td);
239 		sched_prio(td, td->td_user_pri);
240 		mi_switch(SW_INVOL | SWT_NEEDRESCHED, NULL);
241 		thread_unlock(td);
242 #ifdef KTRACE
243 		if (KTRPOINT(td, KTR_CSW))
244 			ktrcsw(0, 1, __func__);
245 #endif
246 	}
247 
248 	/*
249 	 * Check for signals. Unlocked reads of p_pendingcnt or
250 	 * p_siglist might cause process-directed signal to be handled
251 	 * later.
252 	 */
253 	if (flags & TDF_NEEDSIGCHK || p->p_pendingcnt > 0 ||
254 	    !SIGISEMPTY(p->p_siglist)) {
255 		PROC_LOCK(p);
256 		mtx_lock(&p->p_sigacts->ps_mtx);
257 		while ((sig = cursig(td, SIG_STOP_ALLOWED)) != 0)
258 			postsig(sig);
259 		mtx_unlock(&p->p_sigacts->ps_mtx);
260 		PROC_UNLOCK(p);
261 	}
262 	/*
263 	 * We need to check to see if we have to exit or wait due to a
264 	 * single threading requirement or some other STOP condition.
265 	 */
266 	if (flags & TDF_NEEDSUSPCHK) {
267 		PROC_LOCK(p);
268 		thread_suspend_check(0);
269 		PROC_UNLOCK(p);
270 	}
271 
272 	if (td->td_pflags & TDP_OLDMASK) {
273 		td->td_pflags &= ~TDP_OLDMASK;
274 		kern_sigprocmask(td, SIG_SETMASK, &td->td_oldsigmask, NULL, 0);
275 	}
276 
277 	userret(td, framep);
278 }
279 
280 const char *
281 syscallname(struct proc *p, u_int code)
282 {
283 	static const char unknown[] = "unknown";
284 	struct sysentvec *sv;
285 
286 	sv = p->p_sysent;
287 	if (sv->sv_syscallnames == NULL || code >= sv->sv_size)
288 		return (unknown);
289 	return (sv->sv_syscallnames[code]);
290 }
291