xref: /freebsd/sys/compat/linux/linux_emul.c (revision d72a078647de20e31ab09295e671f1b8b4ad89b2)
1 /*-
2  * Copyright (c) 2006 Roman Divacky
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer
10  *    in this position and unchanged.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include "opt_compat.h"
33 
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/imgact.h>
37 #include <sys/lock.h>
38 #include <sys/malloc.h>
39 #include <sys/mutex.h>
40 #include <sys/sx.h>
41 #include <sys/proc.h>
42 #include <sys/syscallsubr.h>
43 #include <sys/sysproto.h>
44 #include <sys/unistd.h>
45 
46 #include <compat/linux/linux_emul.h>
47 #include <compat/linux/linux_futex.h>
48 
49 #ifdef COMPAT_LINUX32
50 #include <machine/../linux32/linux.h>
51 #include <machine/../linux32/linux32_proto.h>
52 #else
53 #include <machine/../linux/linux.h>
54 #include <machine/../linux/linux_proto.h>
55 #endif
56 
57 struct sx emul_shared_lock;
58 struct sx emul_lock;
59 
60 /* this returns locked reference to the emuldata entry (if found) */
61 struct linux_emuldata *
62 em_find(struct proc *p, int locked)
63 {
64 	struct linux_emuldata *em;
65 
66 	if (locked == EMUL_UNLOCKED)
67    		EMUL_LOCK(&emul_lock);
68 
69 	em = p->p_emuldata;
70 
71 	if (em == NULL && locked == EMUL_UNLOCKED)
72 	   	EMUL_UNLOCK(&emul_lock);
73 
74 	return (em);
75 }
76 
77 int
78 linux_proc_init(struct thread *td, pid_t child, int flags)
79 {
80 	struct linux_emuldata *em, *p_em;
81 	struct proc *p;
82 
83 	if (child != 0) {
84 	   	/* non-exec call */
85 		em = malloc(sizeof *em, M_LINUX, M_WAITOK | M_ZERO);
86 		em->pid = child;
87 		if (flags & CLONE_VM) {
88 		   	/* handled later in the code */
89 		} else {
90 		   	struct linux_emuldata_shared *s;
91 
92 			s = malloc(sizeof *s, M_LINUX, M_WAITOK | M_ZERO);
93 			em->shared = s;
94 			s->refs = 1;
95 			s->group_pid = child;
96 
97 			LIST_INIT(&s->threads);
98 		}
99 		p = pfind(child);
100 		if (p == NULL)
101 		   	panic("process not found in proc_init\n");
102 		p->p_emuldata = em;
103 		PROC_UNLOCK(p);
104 		EMUL_LOCK(&emul_lock);
105 	} else {
106 		/* lookup the old one */
107 		em = em_find(td->td_proc, EMUL_UNLOCKED);
108 		KASSERT(em != NULL, ("proc_init: emuldata not found in exec case.\n"));
109 	}
110 
111 	em->child_clear_tid = NULL;
112 	em->child_set_tid = NULL;
113 
114 	/*
115 	 * allocate the shared struct only in clone()/fork cases
116 	 * in the case of clone() td = calling proc and child = pid of
117 	 * the newly created proc
118 	 */
119 	if (child != 0) {
120    	   	if (flags & CLONE_VM) {
121    		   	/* lookup the parent */
122 		   	p_em = em_find(td->td_proc, EMUL_LOCKED);
123 			KASSERT(p_em != NULL, ("proc_init: parent emuldata not found for CLONE_VM\n"));
124 			em->shared = p_em->shared;
125 			em->shared->refs++;
126 		} else {
127 		   	/* handled earlier to avoid malloc(M_WAITOK) with rwlock held */
128 		}
129 	}
130 
131 
132 	if (child != 0) {
133 		EMUL_UNLOCK(&emul_lock);
134 	   	EMUL_SHARED_WLOCK(&emul_shared_lock);
135    	   	LIST_INSERT_HEAD(&em->shared->threads, em, threads);
136 	   	EMUL_SHARED_WUNLOCK(&emul_shared_lock);
137 
138 		p = pfind(child);
139 		/* we might have a sleeping linux_schedtail */
140 		wakeup(&p->p_emuldata);
141 		PROC_UNLOCK(p);
142 	} else
143 	   	EMUL_UNLOCK(&emul_lock);
144 
145    	return (0);
146 }
147 
148 void
149 linux_proc_exit(void *arg __unused, struct proc *p)
150 {
151    	struct linux_emuldata *em;
152 	int error;
153 	struct thread *td = FIRST_THREAD_IN_PROC(p);
154 	int *child_clear_tid;
155 
156 	if (__predict_true(p->p_sysent != &elf_linux_sysvec))
157 	   	return;
158 
159 	/* find the emuldata */
160 	em = em_find(p, EMUL_UNLOCKED);
161 
162 	KASSERT(em != NULL, ("proc_exit: emuldata not found.\n"));
163 
164 	child_clear_tid = em->child_clear_tid;
165 
166 	EMUL_UNLOCK(&emul_lock);
167 
168 	EMUL_SHARED_WLOCK(&emul_shared_lock);
169 	LIST_REMOVE(em, threads);
170 
171 	PROC_LOCK(p);
172 	p->p_emuldata = NULL;
173 	PROC_UNLOCK(p);
174 
175 	em->shared->refs--;
176 	if (em->shared->refs == 0)
177 		free(em->shared, M_LINUX);
178 	EMUL_SHARED_WUNLOCK(&emul_shared_lock);
179 
180 	if (child_clear_tid != NULL) {
181 	   	struct linux_sys_futex_args cup;
182 		int null = 0;
183 
184 		error = copyout(&null, child_clear_tid, sizeof(null));
185 		if (error)
186 		   	return;
187 
188 		/* futexes stuff */
189 		cup.uaddr = child_clear_tid;
190 		cup.op = LINUX_FUTEX_WAKE;
191 		cup.val = 0x7fffffff; /* Awake everyone */
192 		cup.timeout = NULL;
193 		cup.uaddr2 = NULL;
194 		cup.val3 = 0;
195 		error = linux_sys_futex(FIRST_THREAD_IN_PROC(p), &cup);
196 		/*
197 		 * this cannot happen at the moment and if this happens
198 		 * it probably mean there is a userspace bug
199 		 */
200 		if (error)
201 		   	printf(LMSG("futex stuff in proc_exit failed.\n"));
202 	}
203 
204 	/* clean the stuff up */
205 	free(em, M_LINUX);
206 }
207 
208 /*
209  * This is used in a case of transition from FreeBSD binary execing to linux binary
210  * in this case we create linux emuldata proc entry with the pid of the currently running
211  * process.
212  */
213 void linux_proc_exec(void *arg __unused, struct proc *p, struct image_params *imgp)
214 {
215    	if (__predict_false(imgp->sysent == &elf_linux_sysvec
216 		 && p->p_sysent != &elf_linux_sysvec))
217 	   	linux_proc_init(FIRST_THREAD_IN_PROC(p), p->p_pid, 0);
218 	if (__predict_false(imgp->sysent != &elf_linux_sysvec
219 		 && p->p_sysent == &elf_linux_sysvec)) {
220 	   	struct linux_emuldata *em;
221 
222 		em = em_find(p, EMUL_UNLOCKED);
223 
224 		KASSERT(em != NULL, ("proc_exec: emuldata not found.\n"));
225 
226 		EMUL_UNLOCK(&emul_lock);
227 
228 		EMUL_SHARED_WLOCK(&emul_shared_lock);
229 		LIST_REMOVE(em, threads);
230 
231 		PROC_LOCK(p);
232 		p->p_emuldata = NULL;
233 		PROC_UNLOCK(p);
234 
235 		em->shared->refs--;
236 		if (em->shared->refs == 0)
237 		   	free(em->shared, M_LINUX);
238 		EMUL_SHARED_WUNLOCK(&emul_shared_lock);
239 
240 		free(em, M_LINUX);
241 	}
242 }
243 
244 extern int hz;		/* in subr_param.c */
245 
246 void
247 linux_schedtail(void *arg __unused, struct proc *p)
248 {
249 	struct linux_emuldata *em;
250 	int error = 0;
251 	int *child_set_tid;
252 
253 	if (p->p_sysent != &elf_linux_sysvec)
254 	   	return;
255 
256 retry:
257 	/* find the emuldata */
258 	em = em_find(p, EMUL_UNLOCKED);
259 
260 	if (em == NULL) {
261 	   	/*
262 		 * We might have been called before proc_init for this process so
263 		 * tsleep and be woken up by it. We use p->p_emuldata for this
264 		 */
265 
266 	   	error = tsleep(&p->p_emuldata, PLOCK, "linux_schedtail", hz);
267 		if (error == 0)
268 		   	goto retry;
269 	   	panic("no emuldata found for userreting process.\n");
270 	}
271 	child_set_tid = em->child_set_tid;
272 	EMUL_UNLOCK(&emul_lock);
273 
274 	if (child_set_tid != NULL)
275 	   	error = copyout(&p->p_pid, (int *) child_set_tid, sizeof(p->p_pid));
276 
277 	return;
278 }
279 
280 int
281 linux_set_tid_address(struct thread *td, struct linux_set_tid_address_args *args)
282 {
283    	struct linux_emuldata *em;
284 
285 #ifdef DEBUG
286 	if (ldebug(set_tid_address))
287 		printf(ARGS(set_tid_address, "%p"), args->tidptr);
288 #endif
289 
290 	 /* find the emuldata */
291 	em = em_find(td->td_proc, EMUL_UNLOCKED);
292 
293 	KASSERT(em != NULL, ("set_tid_address: emuldata not found.\n"));
294 
295 	em->child_clear_tid = args->tidptr;
296 	td->td_retval[0] = td->td_proc->p_pid;
297 
298 	EMUL_UNLOCK(&emul_lock);
299 	return 0;
300 }
301