xref: /freebsd/sys/kern/subr_syscall.c (revision 6ae1554a5d9b318f8ad53ccc39fa5a961403da73)
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 && p->p_stops & S_PT_SCE) {
87 			PROC_LOCK(p);
88 			td->td_dbg_sc_code = sa->code;
89 			td->td_dbg_sc_narg = sa->narg;
90 			ptracestop((td), SIGTRAP);
91 			PROC_UNLOCK(p);
92 		}
93 		if (td->td_dbgflags & TDB_USERWR) {
94 			/*
95 			 * Reread syscall number and arguments if
96 			 * debugger modified registers or memory.
97 			 */
98 			error = (p->p_sysent->sv_fetch_syscall_args)(td, sa);
99 			PROC_LOCK(p);
100 			td->td_dbg_sc_code = sa->code;
101 			td->td_dbg_sc_narg = sa->narg;
102 			PROC_UNLOCK(p);
103 #ifdef KTRACE
104 			if (KTRPOINT(td, KTR_SYSCALL))
105 				ktrsyscall(sa->code, sa->narg, sa->args);
106 #endif
107 			if (error != 0)
108 				goto retval;
109 		}
110 
111 #ifdef CAPABILITY_MODE
112 		/*
113 		 * In capability mode, we only allow access to system calls
114 		 * flagged with SYF_CAPENABLED.
115 		 */
116 		if (IN_CAPABILITY_MODE(td) &&
117 		    !(sa->callp->sy_flags & SYF_CAPENABLED)) {
118 			error = ECAPMODE;
119 			goto retval;
120 		}
121 #endif
122 
123 		error = syscall_thread_enter(td, sa->callp);
124 		if (error != 0)
125 			goto retval;
126 
127 #ifdef KDTRACE_HOOKS
128 		/*
129 		 * If the systrace module has registered it's probe
130 		 * callback and if there is a probe active for the
131 		 * syscall 'entry', process the probe.
132 		 */
133 		if (systrace_probe_func != NULL && sa->callp->sy_entry != 0)
134 			(*systrace_probe_func)(sa->callp->sy_entry, sa->code,
135 			    sa->callp, sa->args, 0);
136 #endif
137 
138 		AUDIT_SYSCALL_ENTER(sa->code, td);
139 		error = (sa->callp->sy_call)(td, sa->args);
140 		AUDIT_SYSCALL_EXIT(error, td);
141 
142 		/* Save the latest error return value. */
143 		if ((td->td_pflags & TDP_NERRNO) == 0)
144 			td->td_errno = error;
145 
146 #ifdef KDTRACE_HOOKS
147 		/*
148 		 * If the systrace module has registered it's probe
149 		 * callback and if there is a probe active for the
150 		 * syscall 'return', process the probe.
151 		 */
152 		if (systrace_probe_func != NULL && sa->callp->sy_return != 0)
153 			(*systrace_probe_func)(sa->callp->sy_return, sa->code,
154 			    sa->callp, NULL, (error) ? -1 : td->td_retval[0]);
155 #endif
156 		syscall_thread_exit(td, sa->callp);
157 	}
158  retval:
159 	KTR_STOP4(KTR_SYSC, "syscall", syscallname(p, sa->code),
160 	    (uintptr_t)td, "pid:%d", td->td_proc->p_pid, "error:%d", error,
161 	    "retval0:%#lx", td->td_retval[0], "retval1:%#lx",
162 	    td->td_retval[1]);
163 	if (traced) {
164 		PROC_LOCK(p);
165 		td->td_dbgflags &= ~TDB_SCE;
166 		PROC_UNLOCK(p);
167 	}
168 	(p->p_sysent->sv_set_syscall_retval)(td, error);
169 	return (error);
170 }
171 
172 static inline void
173 syscallret(struct thread *td, int error, struct syscall_args *sa)
174 {
175 	struct proc *p, *p2;
176 	int traced;
177 
178 	p = td->td_proc;
179 
180 	/*
181 	 * Handle reschedule and other end-of-syscall issues
182 	 */
183 	userret(td, td->td_frame);
184 
185 #ifdef KTRACE
186 	if (KTRPOINT(td, KTR_SYSRET)) {
187 		ktrsysret(sa->code, (td->td_pflags & TDP_NERRNO) == 0 ?
188 		    error : td->td_errno, td->td_retval[0]);
189 	}
190 #endif
191 	td->td_pflags &= ~TDP_NERRNO;
192 
193 	if (p->p_flag & P_TRACED) {
194 		traced = 1;
195 		PROC_LOCK(p);
196 		td->td_dbgflags |= TDB_SCX;
197 		PROC_UNLOCK(p);
198 	} else
199 		traced = 0;
200 	/*
201 	 * This works because errno is findable through the
202 	 * register set.  If we ever support an emulation where this
203 	 * is not the case, this code will need to be revisited.
204 	 */
205 	STOPEVENT(p, S_SCX, sa->code);
206 	if (traced || (td->td_dbgflags & (TDB_EXEC | TDB_FORK)) != 0) {
207 		PROC_LOCK(p);
208 		/*
209 		 * If tracing the execed process, trap to the debugger
210 		 * so that breakpoints can be set before the program
211 		 * executes.  If debugger requested tracing of syscall
212 		 * returns, do it now too.
213 		 */
214 		if (traced &&
215 		    ((td->td_dbgflags & (TDB_FORK | TDB_EXEC)) != 0 ||
216 		    (p->p_stops & S_PT_SCX) != 0))
217 			ptracestop(td, SIGTRAP);
218 		td->td_dbgflags &= ~(TDB_SCX | TDB_EXEC | TDB_FORK);
219 		PROC_UNLOCK(p);
220 	}
221 
222 	if (td->td_pflags & TDP_RFPPWAIT) {
223 		/*
224 		 * Preserve synchronization semantics of vfork.  If
225 		 * waiting for child to exec or exit, fork set
226 		 * P_PPWAIT on child, and there we sleep on our proc
227 		 * (in case of exit).
228 		 *
229 		 * Do it after the ptracestop() above is finished, to
230 		 * not block our debugger until child execs or exits
231 		 * to finish vfork wait.
232 		 */
233 		td->td_pflags &= ~TDP_RFPPWAIT;
234 		p2 = td->td_rfppwait_p;
235 again:
236 		PROC_LOCK(p2);
237 		while (p2->p_flag & P_PPWAIT) {
238 			PROC_LOCK(p);
239 			if (thread_suspend_check_needed()) {
240 				PROC_UNLOCK(p2);
241 				thread_suspend_check(0);
242 				PROC_UNLOCK(p);
243 				goto again;
244 			} else {
245 				PROC_UNLOCK(p);
246 			}
247 			cv_timedwait(&p2->p_pwait, &p2->p_mtx, hz);
248 		}
249 		PROC_UNLOCK(p2);
250 	}
251 }
252