xref: /freebsd/sys/kern/subr_syscall.c (revision 93e779a26c651610ac6e7986d67ecc9ed2cadcbf)
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) 2010 Konstantin Belousov <kib@freebsd.org>
6  *
7  * This code is derived from software contributed to Berkeley by
8  * the University of Utah, and William Jolitz.
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. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *	from: @(#)trap.c	7.4 (Berkeley) 5/13/91
39  */
40 
41 #include "opt_capsicum.h"
42 #include "opt_ktrace.h"
43 
44 __FBSDID("$FreeBSD$");
45 
46 #include <sys/capsicum.h>
47 #include <sys/ktr.h>
48 #ifdef KTRACE
49 #include <sys/uio.h>
50 #include <sys/ktrace.h>
51 #endif
52 #include <security/audit/audit.h>
53 
54 static inline int
55 syscallenter(struct thread *td, struct syscall_args *sa)
56 {
57 	struct proc *p;
58 	int error, traced;
59 
60 	PCPU_INC(cnt.v_syscall);
61 	p = td->td_proc;
62 
63 	td->td_pticks = 0;
64 	if (td->td_cowgen != p->p_cowgen)
65 		thread_cow_update(td);
66 	traced = (p->p_flag & P_TRACED) != 0;
67 	if (traced || td->td_dbgflags & TDB_USERWR) {
68 		PROC_LOCK(p);
69 		td->td_dbgflags &= ~TDB_USERWR;
70 		if (traced)
71 			td->td_dbgflags |= TDB_SCE;
72 		PROC_UNLOCK(p);
73 	}
74 	error = (p->p_sysent->sv_fetch_syscall_args)(td, sa);
75 #ifdef KTRACE
76 	if (KTRPOINT(td, KTR_SYSCALL))
77 		ktrsyscall(sa->code, sa->narg, sa->args);
78 #endif
79 	KTR_START4(KTR_SYSC, "syscall", syscallname(p, sa->code),
80 	    (uintptr_t)td, "pid:%d", td->td_proc->p_pid, "arg0:%p", sa->args[0],
81 	    "arg1:%p", sa->args[1], "arg2:%p", sa->args[2]);
82 
83 	if (error == 0) {
84 
85 		STOPEVENT(p, S_SCE, sa->narg);
86 		if (p->p_flag & P_TRACED) {
87 			PROC_LOCK(p);
88 			td->td_dbg_sc_code = sa->code;
89 			td->td_dbg_sc_narg = sa->narg;
90 			if (p->p_stops & S_PT_SCE)
91 				ptracestop((td), SIGTRAP);
92 			PROC_UNLOCK(p);
93 		}
94 		if (td->td_dbgflags & TDB_USERWR) {
95 			/*
96 			 * Reread syscall number and arguments if
97 			 * debugger modified registers or memory.
98 			 */
99 			error = (p->p_sysent->sv_fetch_syscall_args)(td, sa);
100 			PROC_LOCK(p);
101 			td->td_dbg_sc_code = sa->code;
102 			td->td_dbg_sc_narg = sa->narg;
103 			PROC_UNLOCK(p);
104 #ifdef KTRACE
105 			if (KTRPOINT(td, KTR_SYSCALL))
106 				ktrsyscall(sa->code, sa->narg, sa->args);
107 #endif
108 			if (error != 0)
109 				goto retval;
110 		}
111 
112 #ifdef CAPABILITY_MODE
113 		/*
114 		 * In capability mode, we only allow access to system calls
115 		 * flagged with SYF_CAPENABLED.
116 		 */
117 		if (IN_CAPABILITY_MODE(td) &&
118 		    !(sa->callp->sy_flags & SYF_CAPENABLED)) {
119 			error = ECAPMODE;
120 			goto retval;
121 		}
122 #endif
123 
124 		error = syscall_thread_enter(td, sa->callp);
125 		if (error != 0)
126 			goto retval;
127 
128 #ifdef KDTRACE_HOOKS
129 		/*
130 		 * If the systrace module has registered it's probe
131 		 * callback and if there is a probe active for the
132 		 * syscall 'entry', process the probe.
133 		 */
134 		if (systrace_probe_func != NULL && sa->callp->sy_entry != 0)
135 			(*systrace_probe_func)(sa->callp->sy_entry, sa->code,
136 			    sa->callp, sa->args, 0);
137 #endif
138 
139 		AUDIT_SYSCALL_ENTER(sa->code, td);
140 		error = (sa->callp->sy_call)(td, sa->args);
141 		AUDIT_SYSCALL_EXIT(error, td);
142 
143 		/* Save the latest error return value. */
144 		if ((td->td_pflags & TDP_NERRNO) == 0)
145 			td->td_errno = error;
146 
147 #ifdef KDTRACE_HOOKS
148 		/*
149 		 * If the systrace module has registered it's probe
150 		 * callback and if there is a probe active for the
151 		 * syscall 'return', process the probe.
152 		 */
153 		if (systrace_probe_func != NULL && sa->callp->sy_return != 0)
154 			(*systrace_probe_func)(sa->callp->sy_return, sa->code,
155 			    sa->callp, NULL, (error) ? -1 : td->td_retval[0]);
156 #endif
157 		syscall_thread_exit(td, sa->callp);
158 	}
159  retval:
160 	KTR_STOP4(KTR_SYSC, "syscall", syscallname(p, sa->code),
161 	    (uintptr_t)td, "pid:%d", td->td_proc->p_pid, "error:%d", error,
162 	    "retval0:%#lx", td->td_retval[0], "retval1:%#lx",
163 	    td->td_retval[1]);
164 	if (traced) {
165 		PROC_LOCK(p);
166 		td->td_dbgflags &= ~TDB_SCE;
167 		PROC_UNLOCK(p);
168 	}
169 	(p->p_sysent->sv_set_syscall_retval)(td, error);
170 	return (error);
171 }
172 
173 static inline void
174 syscallret(struct thread *td, int error, struct syscall_args *sa)
175 {
176 	struct proc *p, *p2;
177 	int traced;
178 
179 	KASSERT((td->td_pflags & TDP_FORKING) == 0,
180 	    ("fork() did not clear TDP_FORKING upon completion"));
181 
182 	p = td->td_proc;
183 
184 	/*
185 	 * Handle reschedule and other end-of-syscall issues
186 	 */
187 	userret(td, td->td_frame);
188 
189 #ifdef KTRACE
190 	if (KTRPOINT(td, KTR_SYSRET)) {
191 		ktrsysret(sa->code, (td->td_pflags & TDP_NERRNO) == 0 ?
192 		    error : td->td_errno, td->td_retval[0]);
193 	}
194 #endif
195 	td->td_pflags &= ~TDP_NERRNO;
196 
197 	if (p->p_flag & P_TRACED) {
198 		traced = 1;
199 		PROC_LOCK(p);
200 		td->td_dbgflags |= TDB_SCX;
201 		PROC_UNLOCK(p);
202 	} else
203 		traced = 0;
204 	/*
205 	 * This works because errno is findable through the
206 	 * register set.  If we ever support an emulation where this
207 	 * is not the case, this code will need to be revisited.
208 	 */
209 	STOPEVENT(p, S_SCX, sa->code);
210 	if (traced || (td->td_dbgflags & (TDB_EXEC | TDB_FORK)) != 0) {
211 		PROC_LOCK(p);
212 		/*
213 		 * If tracing the execed process, trap to the debugger
214 		 * so that breakpoints can be set before the program
215 		 * executes.  If debugger requested tracing of syscall
216 		 * returns, do it now too.
217 		 */
218 		if (traced &&
219 		    ((td->td_dbgflags & (TDB_FORK | TDB_EXEC)) != 0 ||
220 		    (p->p_stops & S_PT_SCX) != 0))
221 			ptracestop(td, SIGTRAP);
222 		td->td_dbgflags &= ~(TDB_SCX | TDB_EXEC | TDB_FORK);
223 		PROC_UNLOCK(p);
224 	}
225 
226 	if (td->td_pflags & TDP_RFPPWAIT) {
227 		/*
228 		 * Preserve synchronization semantics of vfork.  If
229 		 * waiting for child to exec or exit, fork set
230 		 * P_PPWAIT on child, and there we sleep on our proc
231 		 * (in case of exit).
232 		 *
233 		 * Do it after the ptracestop() above is finished, to
234 		 * not block our debugger until child execs or exits
235 		 * to finish vfork wait.
236 		 */
237 		td->td_pflags &= ~TDP_RFPPWAIT;
238 		p2 = td->td_rfppwait_p;
239 again:
240 		PROC_LOCK(p2);
241 		while (p2->p_flag & P_PPWAIT) {
242 			PROC_LOCK(p);
243 			if (thread_suspend_check_needed()) {
244 				PROC_UNLOCK(p2);
245 				thread_suspend_check(0);
246 				PROC_UNLOCK(p);
247 				goto again;
248 			} else {
249 				PROC_UNLOCK(p);
250 			}
251 			cv_timedwait(&p2->p_pwait, &p2->p_mtx, hz);
252 		}
253 		PROC_UNLOCK(p2);
254 	}
255 }
256