xref: /dragonfly/sys/kern/imgact_resident.c (revision 32efd857)
1 /*
2  * (MPSAFE)
3  *
4  * Copyright (c) 2003,2004 The DragonFly Project.  All rights reserved.
5  *
6  * This code is derived from software contributed to The DragonFly Project
7  * by Matthew Dillon <dillon@backplane.com>
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
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
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  * 3. Neither the name of The DragonFly Project nor the names of its
20  *    contributors may be used to endorse or promote products derived
21  *    from this software without specific, prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
27  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
31  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
33  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  */
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/sysmsg.h>
41 #include <sys/exec.h>
42 #include <sys/imgact.h>
43 #include <sys/mman.h>
44 #include <sys/proc.h>
45 #include <sys/priv.h>
46 #include <sys/resourcevar.h>
47 #include <sys/sysent.h>
48 #include <sys/stat.h>
49 #include <sys/vnode.h>
50 #include <sys/sysctl.h>
51 #include <sys/lock.h>
52 #include <sys/resident.h>
53 #include <sys/malloc.h>
54 
55 #include <vm/vm.h>
56 #include <vm/vm_param.h>
57 #include <vm/pmap.h>
58 #include <vm/vm_map.h>
59 #include <vm/vm_kern.h>
60 #include <vm/vm_extern.h>
61 
62 static int exec_res_id = 0;
63 
64 static TAILQ_HEAD(,vmresident) exec_res_list;
65 
66 static MALLOC_DEFINE(M_EXEC_RES, "vmresident", "resident execs");
67 
68 /* lockmgr lock for protecting the exec_res_list */
69 static struct lock exec_list_lock;
70 
71 static void
72 vm_resident_init(void *__dummy)
73 {
74 	lockinit(&exec_list_lock, "vmres", 0, 0);
75 	TAILQ_INIT(&exec_res_list);
76 }
77 SYSINIT(vmres, SI_BOOT1_LOCK, SI_ORDER_ANY, vm_resident_init, 0);
78 
79 static int
80 fill_xresident(struct vmresident *vr, struct xresident *in, struct thread *td)
81 {
82 	struct stat st;
83 	struct vnode *vrtmp;
84 	int error = 0;
85 
86 	vrtmp = vr->vr_vnode;
87 
88 	in->res_entry_addr = vr->vr_entry_addr;
89 	in->res_id = vr->vr_id;
90 	if (vrtmp) {
91 		char *freepath, *fullpath;
92 		error = vn_fullpath(td->td_proc, vrtmp, &fullpath, &freepath, 0);
93 		if (error != 0) {
94 			/* could not retrieve cached path, return zero'ed string */
95 			bzero(in->res_file, MAXPATHLEN);
96 			error = 0;
97 		} else {
98 			strlcpy(in->res_file, fullpath, sizeof(in->res_file));
99 			kfree(freepath, M_TEMP);
100 		}
101 
102 		/* indicate that we are using the vnode */
103 		error = vget(vrtmp, LK_EXCLUSIVE);
104 		if (error)
105 			goto done;
106 
107 		/* retrieve underlying stat information and release vnode */
108 		error = vn_stat(vrtmp, &st, td->td_ucred);
109 		vput(vrtmp);
110 		if (error)
111 			goto done;
112 
113 		in->res_stat = st;
114 	}
115 
116 done:
117 	if (error)
118 		kprintf("fill_xresident, error = %d\n", error);
119 	return (error);
120 }
121 
122 static int
123 sysctl_vm_resident(SYSCTL_HANDLER_ARGS)
124 {
125 	struct vmresident *vmres;
126 	struct thread *td;
127 	int error;
128 	int count;
129 
130 	/* only super-user should call this sysctl */
131 	td = req->td;
132 	if ((priv_check(td, PRIV_VM_RESIDENT)) != 0)
133 		return EPERM;
134 
135 	error = count = 0;
136 
137 	if (exec_res_id == 0)
138 	    return error;
139 
140 	/* client queried for number of resident binaries */
141 	if (!req->oldptr)
142 	    return SYSCTL_OUT(req, 0, exec_res_id);
143 
144 	lockmgr(&exec_list_lock, LK_SHARED);
145 
146 	TAILQ_FOREACH(vmres, &exec_res_list, vr_link) {
147 		struct xresident xres;
148 		error = fill_xresident(vmres, &xres, td);
149 		if (error != 0)
150 			break;
151 
152 		error = SYSCTL_OUT(req, (void *)&xres,
153 				sizeof(struct xresident));
154 		if (error != 0)
155 			break;
156 	}
157 	lockmgr(&exec_list_lock, LK_RELEASE);
158 
159 	return (error);
160 }
161 SYSCTL_PROC(_vm, OID_AUTO, resident, CTLTYPE_OPAQUE|CTLFLAG_RD, 0, 0,
162   sysctl_vm_resident, "S,xresident", "resident executables (sys/resident.h)");
163 
164 int
165 exec_resident_imgact(struct image_params *imgp)
166 {
167 	struct vmresident *vmres;
168 
169 	/*
170 	 * resident image activator
171 	 */
172 	lockmgr(&exec_list_lock, LK_SHARED);
173 	if ((vmres = imgp->vp->v_resident) == NULL) {
174 	    lockmgr(&exec_list_lock, LK_RELEASE);
175 	    return(-1);
176 	}
177 	atomic_add_int(&vmres->vr_refs, 1);
178 	lockmgr(&exec_list_lock, LK_RELEASE);
179 
180 	/*
181 	 * We want to exec the new vmspace without holding the lock to
182 	 * improve concurrency.
183 	 */
184 	exec_new_vmspace(imgp, vmres->vr_vmspace);
185 	imgp->resident = 1;
186 	imgp->interpreted = 0;
187 	imgp->proc->p_sysent = vmres->vr_sysent;
188 	imgp->entry_addr = vmres->vr_entry_addr;
189 	atomic_subtract_int(&vmres->vr_refs, 1);
190 
191 	return(0);
192 }
193 
194 /*
195  * exec_sys_register(entry)
196  *
197  * Register ourselves for resident execution.  Only root (i.e. a process with
198  * PRIV_VM_RESIDENT credentials) can do this.  This
199  * will snapshot the vmspace and cause future exec's of the specified binary
200  * to use the snapshot directly rather then load & relocate a new copy.
201  *
202  * MPALMOSTSAFE
203  */
204 int
205 sys_exec_sys_register(struct sysmsg *sysmsg,
206 		      const struct exec_sys_register_args *uap)
207 {
208     struct thread *td = curthread;
209     struct vmresident *vmres;
210     struct vnode *vp;
211     struct proc *p;
212     int error;
213 
214     p = td->td_proc;
215     error = priv_check_cred(td->td_ucred, PRIV_VM_RESIDENT, 0);
216     if (error)
217 	return(error);
218 
219     if ((vp = p->p_textvp) == NULL)
220 	return(ENOENT);
221 
222     lockmgr(&exec_list_lock, LK_EXCLUSIVE);
223 
224     if (vp->v_resident) {
225 	lockmgr(&exec_list_lock, LK_RELEASE);
226 	return(EEXIST);
227     }
228 
229     vhold(vp);
230     vmres = kmalloc(sizeof(*vmres), M_EXEC_RES, M_WAITOK | M_ZERO);
231     vmres->vr_vnode = vp;
232     vmres->vr_sysent = p->p_sysent;
233     vmres->vr_id = ++exec_res_id;
234     vmres->vr_entry_addr = (intptr_t)uap->entry;
235     vmres->vr_vmspace = vmspace_fork(p->p_vmspace, NULL, NULL); /* XXX order */
236     pmap_pinit2(vmspace_pmap(vmres->vr_vmspace));
237     vp->v_resident = vmres;
238 
239     TAILQ_INSERT_TAIL(&exec_res_list, vmres, vr_link);
240     lockmgr(&exec_list_lock, LK_RELEASE);
241 
242     return(0);
243 }
244 
245 /*
246  * exec_sys_unregister(id)
247  *
248  *	Unregister the specified id.  If an id of -1 is used unregister
249  *	the registration associated with the current process.  An id of -2
250  *	unregisters everything.
251  *
252  * MPALMOSTSAFE
253  */
254 int
255 sys_exec_sys_unregister(struct sysmsg *sysmsg,
256 			const struct exec_sys_unregister_args *uap)
257 {
258     struct thread *td = curthread;
259     struct vmresident *vmres;
260     struct proc *p;
261     int error;
262     int id;
263     int count;
264 
265     p = td->td_proc;
266     error = priv_check_cred(td->td_ucred, PRIV_VM_RESIDENT, 0);
267     if (error)
268 	return(error);
269 
270     /*
271      * If id is -1, unregister ourselves
272      */
273     lockmgr(&exec_list_lock, LK_EXCLUSIVE);
274 
275     if ((id = uap->id) == -1 && p->p_textvp && p->p_textvp->v_resident)
276 	id = p->p_textvp->v_resident->vr_id;
277 
278     /*
279      * Look for the registration
280      */
281     error = ENOENT;
282     count = 0;
283 
284 restart:
285     TAILQ_FOREACH(vmres, &exec_res_list, vr_link) {
286 	if (id == -2 || vmres->vr_id == id) {
287 	    /*
288 	     * Check race against exec
289 	     */
290 	    if (vmres->vr_refs) {
291 		lockmgr(&exec_list_lock, LK_RELEASE);
292 		tsleep(vmres, 0, "vmres", 1);
293 		lockmgr(&exec_list_lock, LK_EXCLUSIVE);
294 		goto restart;
295 	    }
296 
297 	    /*
298 	     * Remove it
299 	     */
300 	    TAILQ_REMOVE(&exec_res_list, vmres, vr_link);
301 	    if (vmres->vr_vnode) {
302 		vmres->vr_vnode->v_resident = NULL;
303 		vdrop(vmres->vr_vnode);
304 		vmres->vr_vnode = NULL;
305 	    }
306 	    if (vmres->vr_vmspace) {
307 		vmspace_rel(vmres->vr_vmspace);
308 		vmres->vr_vmspace = NULL;
309 	    }
310 	    kfree(vmres, M_EXEC_RES);
311 	    exec_res_id--;
312 	    error = 0;
313 	    ++count;
314 	    goto restart;
315 	}
316     }
317     lockmgr(&exec_list_lock, LK_RELEASE);
318 
319     if (error == 0)
320 	sysmsg->sysmsg_result = count;
321     return(error);
322 }
323 
324