kernel - add DEBUG_LOCKS_LATENCY option
[dragonfly.git] / sys / kern / kern_exec.c
1 /*
2  * Copyright (c) 1993, David Greenman
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  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/kern/kern_exec.c,v 1.107.2.15 2002/07/30 15:40:46 nectar Exp $
27  */
28
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/sysproto.h>
32 #include <sys/kernel.h>
33 #include <sys/mount.h>
34 #include <sys/filedesc.h>
35 #include <sys/fcntl.h>
36 #include <sys/acct.h>
37 #include <sys/exec.h>
38 #include <sys/imgact.h>
39 #include <sys/imgact_elf.h>
40 #include <sys/kern_syscall.h>
41 #include <sys/wait.h>
42 #include <sys/malloc.h>
43 #include <sys/proc.h>
44 #include <sys/priv.h>
45 #include <sys/ktrace.h>
46 #include <sys/signalvar.h>
47 #include <sys/pioctl.h>
48 #include <sys/nlookup.h>
49 #include <sys/sysent.h>
50 #include <sys/shm.h>
51 #include <sys/sysctl.h>
52 #include <sys/vnode.h>
53 #include <sys/vmmeter.h>
54 #include <sys/libkern.h>
55
56 #include <cpu/lwbuf.h>
57
58 #include <vm/vm.h>
59 #include <vm/vm_param.h>
60 #include <sys/lock.h>
61 #include <vm/pmap.h>
62 #include <vm/vm_page.h>
63 #include <vm/vm_map.h>
64 #include <vm/vm_kern.h>
65 #include <vm/vm_extern.h>
66 #include <vm/vm_object.h>
67 #include <vm/vnode_pager.h>
68 #include <vm/vm_pager.h>
69
70 #include <sys/user.h>
71 #include <sys/reg.h>
72
73 #include <sys/refcount.h>
74 #include <sys/thread2.h>
75 #include <sys/mplock2.h>
76
77 MALLOC_DEFINE(M_PARGS, "proc-args", "Process arguments");
78 MALLOC_DEFINE(M_EXECARGS, "exec-args", "Exec arguments");
79
80 static register_t *exec_copyout_strings (struct image_params *);
81
82 /* XXX This should be vm_size_t. */
83 static u_long ps_strings = PS_STRINGS;
84 SYSCTL_ULONG(_kern, KERN_PS_STRINGS, ps_strings, CTLFLAG_RD, &ps_strings, 0, "");
85
86 /* XXX This should be vm_size_t. */
87 static u_long usrstack = USRSTACK;
88 SYSCTL_ULONG(_kern, KERN_USRSTACK, usrstack, CTLFLAG_RD, &usrstack, 0, "");
89
90 u_long ps_arg_cache_limit = PAGE_SIZE / 16;
91 SYSCTL_LONG(_kern, OID_AUTO, ps_arg_cache_limit, CTLFLAG_RW, 
92     &ps_arg_cache_limit, 0, "");
93
94 int ps_argsopen = 1;
95 SYSCTL_INT(_kern, OID_AUTO, ps_argsopen, CTLFLAG_RW, &ps_argsopen, 0, "");
96
97 static int ktrace_suid = 0;
98 SYSCTL_INT(_kern, OID_AUTO, ktrace_suid, CTLFLAG_RW, &ktrace_suid, 0, "");
99
100 void print_execve_args(struct image_args *args);
101 int debug_execve_args = 0;
102 SYSCTL_INT(_kern, OID_AUTO, debug_execve_args, CTLFLAG_RW, &debug_execve_args,
103     0, "");
104
105 /*
106  * Exec arguments object cache
107  */
108 static struct objcache *exec_objcache;
109
110 static
111 void
112 exec_objcache_init(void *arg __unused)
113 {
114         int cluster_limit;
115         size_t limsize;
116
117         /*
118          * Maximum number of concurrent execs.  This can be limiting on
119          * systems with a lot of cpu cores but it also eats a significant
120          * amount of memory.
121          */
122         cluster_limit = 16;
123         limsize = kmem_lim_size();
124         if (limsize > 7 * 1024)
125                 cluster_limit *= 2;
126         if (limsize > 15 * 1024)
127                 cluster_limit *= 2;
128
129         exec_objcache = objcache_create_mbacked(
130                                         M_EXECARGS, PATH_MAX + ARG_MAX,
131                                         &cluster_limit, 8,
132                                         NULL, NULL, NULL);
133 }
134 SYSINIT(exec_objcache, SI_BOOT2_MACHDEP, SI_ORDER_ANY, exec_objcache_init, 0);
135
136 /*
137  * stackgap_random specifies if the stackgap should have a random size added
138  * to it.  It must be a power of 2.  If non-zero, the stack gap will be 
139  * calculated as: ALIGN(karc4random() & (stackgap_random - 1)).
140  */
141 static int stackgap_random = 1024;
142 static int
143 sysctl_kern_stackgap(SYSCTL_HANDLER_ARGS)
144 {
145         int error, new_val;
146         new_val = stackgap_random;
147         error = sysctl_handle_int(oidp, &new_val, 0, req);
148         if (error != 0 || req->newptr == NULL)
149                 return (error);
150         if ((new_val < 0) || (new_val > 16 * PAGE_SIZE) || ! powerof2(new_val))
151                 return (EINVAL);
152         stackgap_random = new_val;
153
154         return(0);
155 }
156
157 SYSCTL_PROC(_kern, OID_AUTO, stackgap_random, CTLFLAG_RW|CTLTYPE_UINT, 
158         0, 0, sysctl_kern_stackgap, "IU", "Max random stack gap (power of 2)");
159         
160 void
161 print_execve_args(struct image_args *args)
162 {
163         char *cp;
164         int ndx;
165
166         cp = args->begin_argv;
167         for (ndx = 0; ndx < args->argc; ndx++) {
168                 kprintf("\targv[%d]: %s\n", ndx, cp);
169                 while (*cp++ != '\0');
170         }
171         for (ndx = 0; ndx < args->envc; ndx++) {
172                 kprintf("\tenvv[%d]: %s\n", ndx, cp);
173                 while (*cp++ != '\0');
174         }
175 }
176
177 /*
178  * Each of the items is a pointer to a `const struct execsw', hence the
179  * double pointer here.
180  */
181 static const struct execsw **execsw;
182
183 /*
184  * Replace current vmspace with a new binary.
185  * Returns 0 on success, > 0 on recoverable error (use as errno).
186  * Returns -1 on lethal error which demands killing of the current
187  * process!
188  */
189 int
190 kern_execve(struct nlookupdata *nd, struct image_args *args)
191 {
192         struct thread *td = curthread;
193         struct lwp *lp = td->td_lwp;
194         struct proc *p = td->td_proc;
195         struct vnode *ovp;
196         register_t *stack_base;
197         struct pargs *pa;
198         struct sigacts *ops;
199         struct sigacts *nps;
200         int error, len, i;
201         struct image_params image_params, *imgp;
202         struct vattr attr;
203         int (*img_first) (struct image_params *);
204
205         if (debug_execve_args) {
206                 kprintf("%s()\n", __func__);
207                 print_execve_args(args);
208         }
209
210         KKASSERT(p);
211         lwkt_gettoken(&p->p_token);
212         imgp = &image_params;
213
214         /*
215          * NOTE: P_INEXEC is handled by exec_new_vmspace() now.  We make
216          * no modifications to the process at all until we get there.
217          *
218          * Note that multiple threads may be trying to exec at the same
219          * time.  exec_new_vmspace() handles that too.
220          */
221
222         /*
223          * Initialize part of the common data
224          */
225         imgp->proc = p;
226         imgp->args = args;
227         imgp->attr = &attr;
228         imgp->entry_addr = 0;
229         imgp->resident = 0;
230         imgp->vmspace_destroyed = 0;
231         imgp->interpreted = 0;
232         imgp->interpreter_name[0] = 0;
233         imgp->auxargs = NULL;
234         imgp->vp = NULL;
235         imgp->firstpage = NULL;
236         imgp->ps_strings = 0;
237         imgp->execpath = imgp->freepath = NULL;
238         imgp->execpathp = 0;
239         imgp->image_header = NULL;
240
241 interpret:
242
243         /*
244          * Translate the file name to a vnode.  Unlock the cache entry to
245          * improve parallelism for programs exec'd in parallel.
246          */
247         if ((error = nlookup(nd)) != 0)
248                 goto exec_fail;
249         error = cache_vget(&nd->nl_nch, nd->nl_cred, LK_EXCLUSIVE, &imgp->vp);
250         KKASSERT(nd->nl_flags & NLC_NCPISLOCKED);
251         nd->nl_flags &= ~NLC_NCPISLOCKED;
252         cache_unlock(&nd->nl_nch);
253         if (error)
254                 goto exec_fail;
255
256         /*
257          * Check file permissions (also 'opens' file).
258          * Include also the top level mount in the check.
259          */
260         error = exec_check_permissions(imgp, nd->nl_nch.mount);
261         if (error) {
262                 vn_unlock(imgp->vp);
263                 goto exec_fail_dealloc;
264         }
265
266         error = exec_map_first_page(imgp);
267         vn_unlock(imgp->vp);
268         if (error)
269                 goto exec_fail_dealloc;
270
271         imgp->proc->p_osrel = 0;
272
273         if (debug_execve_args && imgp->interpreted) {
274                 kprintf("    target is interpreted -- recursive pass\n");
275                 kprintf("    interpreter: %s\n", imgp->interpreter_name);
276                 print_execve_args(args);
277         }
278
279         /*
280          *      If the current process has a special image activator it
281          *      wants to try first, call it.   For example, emulating shell 
282          *      scripts differently.
283          */
284         error = -1;
285         if ((img_first = imgp->proc->p_sysent->sv_imgact_try) != NULL)
286                 error = img_first(imgp);
287
288         /*
289          *      If the vnode has a registered vmspace, exec the vmspace
290          */
291         if (error == -1 && imgp->vp->v_resident) {
292                 error = exec_resident_imgact(imgp);
293         }
294
295         /*
296          *      Loop through the list of image activators, calling each one.
297          *      An activator returns -1 if there is no match, 0 on success,
298          *      and an error otherwise.
299          */
300         for (i = 0; error == -1 && execsw[i]; ++i) {
301                 if (execsw[i]->ex_imgact == NULL ||
302                     execsw[i]->ex_imgact == img_first) {
303                         continue;
304                 }
305                 error = (*execsw[i]->ex_imgact)(imgp);
306         }
307
308         if (error) {
309                 if (error == -1)
310                         error = ENOEXEC;
311                 goto exec_fail_dealloc;
312         }
313
314         /*
315          * Special interpreter operation, cleanup and loop up to try to
316          * activate the interpreter.
317          */
318         if (imgp->interpreted) {
319                 exec_unmap_first_page(imgp);
320                 nlookup_done(nd);
321                 vrele(imgp->vp);
322                 imgp->vp = NULL;
323                 error = nlookup_init(nd, imgp->interpreter_name, UIO_SYSSPACE,
324                                         NLC_FOLLOW);
325                 if (error)
326                         goto exec_fail;
327                 goto interpret;
328         }
329
330         /*
331          * Do the best to calculate the full path to the image file
332          */
333         if (imgp->auxargs != NULL &&
334            ((args->fname != NULL && args->fname[0] == '/') ||
335             vn_fullpath(imgp->proc,
336                         imgp->vp,
337                         &imgp->execpath,
338                         &imgp->freepath,
339                         0) != 0))
340                 imgp->execpath = args->fname;
341
342         /*
343          * Copy out strings (args and env) and initialize stack base
344          */
345         stack_base = exec_copyout_strings(imgp);
346         p->p_vmspace->vm_minsaddr = (char *)stack_base;
347
348         /*
349          * If custom stack fixup routine present for this process
350          * let it do the stack setup.  If we are running a resident
351          * image there is no auxinfo or other image activator context
352          * so don't try to add fixups to the stack.
353          *
354          * Else stuff argument count as first item on stack
355          */
356         if (p->p_sysent->sv_fixup && imgp->resident == 0)
357                 (*p->p_sysent->sv_fixup)(&stack_base, imgp);
358         else
359                 suword(--stack_base, imgp->args->argc);
360
361         /*
362          * For security and other reasons, the file descriptor table cannot
363          * be shared after an exec.
364          */
365         if (p->p_fd->fd_refcnt > 1) {
366                 struct filedesc *tmp;
367
368                 error = fdcopy(p, &tmp);
369                 if (error != 0)
370                         goto exec_fail;
371                 fdfree(p, tmp);
372         }
373
374         /*
375          * For security and other reasons, signal handlers cannot
376          * be shared after an exec. The new proces gets a copy of the old
377          * handlers. In execsigs(), the new process will have its signals
378          * reset.
379          */
380         ops = p->p_sigacts;
381         if (ops->ps_refcnt > 1) {
382                 nps = kmalloc(sizeof(*nps), M_SUBPROC, M_WAITOK);
383                 bcopy(ops, nps, sizeof(*nps));
384                 refcount_init(&nps->ps_refcnt, 1);
385                 p->p_sigacts = nps;
386                 if (refcount_release(&ops->ps_refcnt)) {
387                         kfree(ops, M_SUBPROC);
388                         ops = NULL;
389                 }
390         }
391
392         /*
393          * For security and other reasons virtual kernels cannot be
394          * inherited by an exec.  This also allows a virtual kernel
395          * to fork/exec unrelated applications.
396          */
397         if (p->p_vkernel)
398                 vkernel_exit(p);
399
400         /* Stop profiling */
401         stopprofclock(p);
402
403         /* close files on exec */
404         fdcloseexec(p);
405
406         /* reset caught signals */
407         execsigs(p);
408
409         /* name this process - nameiexec(p, ndp) */
410         len = min(nd->nl_nch.ncp->nc_nlen, MAXCOMLEN);
411         bcopy(nd->nl_nch.ncp->nc_name, p->p_comm, len);
412         p->p_comm[len] = 0;
413         bcopy(p->p_comm, lp->lwp_thread->td_comm, MAXCOMLEN+1);
414
415         /*
416          * mark as execed, wakeup the process that vforked (if any) and tell
417          * it that it now has its own resources back
418          */
419         p->p_flags |= P_EXEC;
420         if (p->p_pptr && (p->p_flags & P_PPWAIT)) {
421                 p->p_flags &= ~P_PPWAIT;
422                 wakeup((caddr_t)p->p_pptr);
423         }
424
425         /*
426          * Implement image setuid/setgid.
427          *
428          * Don't honor setuid/setgid if the filesystem prohibits it or if
429          * the process is being traced.
430          */
431         if ((((attr.va_mode & VSUID) && p->p_ucred->cr_uid != attr.va_uid) ||
432              ((attr.va_mode & VSGID) && p->p_ucred->cr_gid != attr.va_gid)) &&
433             (imgp->vp->v_mount->mnt_flag & MNT_NOSUID) == 0 &&
434             (p->p_flags & P_TRACED) == 0) {
435                 /*
436                  * Turn off syscall tracing for set-id programs, except for
437                  * root.  Record any set-id flags first to make sure that
438                  * we do not regain any tracing during a possible block.
439                  */
440                 setsugid();
441                 if (p->p_tracenode && ktrace_suid == 0 &&
442                     priv_check(td, PRIV_ROOT) != 0) {
443                         ktrdestroy(&p->p_tracenode);
444                         p->p_traceflag = 0;
445                 }
446                 /* Close any file descriptors 0..2 that reference procfs */
447                 setugidsafety(p);
448                 /* Make sure file descriptors 0..2 are in use. */
449                 error = fdcheckstd(lp);
450                 if (error != 0)
451                         goto exec_fail_dealloc;
452                 /*
453                  * Set the new credentials.
454                  */
455                 cratom(&p->p_ucred);
456                 if (attr.va_mode & VSUID)
457                         change_euid(attr.va_uid);
458                 if (attr.va_mode & VSGID)
459                         p->p_ucred->cr_gid = attr.va_gid;
460
461                 /*
462                  * Clear local varsym variables
463                  */
464                 varsymset_clean(&p->p_varsymset);
465         } else {
466                 if (p->p_ucred->cr_uid == p->p_ucred->cr_ruid &&
467                     p->p_ucred->cr_gid == p->p_ucred->cr_rgid)
468                         p->p_flags &= ~P_SUGID;
469         }
470
471         /*
472          * Implement correct POSIX saved-id behavior.
473          */
474         if (p->p_ucred->cr_svuid != p->p_ucred->cr_uid ||
475             p->p_ucred->cr_svgid != p->p_ucred->cr_gid) {
476                 cratom(&p->p_ucred);
477                 p->p_ucred->cr_svuid = p->p_ucred->cr_uid;
478                 p->p_ucred->cr_svgid = p->p_ucred->cr_gid;
479         }
480
481         /*
482          * Store the vp for use in procfs.  Be sure to keep p_textvp
483          * consistent if we block during the switch-over.
484          */
485         ovp = p->p_textvp;
486         vref(imgp->vp);                 /* ref new vp */
487         p->p_textvp = imgp->vp;
488         if (ovp)                        /* release old vp */
489                 vrele(ovp);
490
491         /* Release old namecache handle to text file */
492         if (p->p_textnch.ncp)
493                 cache_drop(&p->p_textnch);
494
495         if (nd->nl_nch.mount)
496                 cache_copy(&nd->nl_nch, &p->p_textnch);
497
498         /*
499          * Notify others that we exec'd, and clear the P_INEXEC flag
500          * as we're now a bona fide freshly-execed process.
501          */
502         KNOTE(&p->p_klist, NOTE_EXEC);
503         p->p_flags &= ~P_INEXEC;
504
505         /*
506          * If tracing the process, trap to debugger so breakpoints
507          *      can be set before the program executes.
508          */
509         STOPEVENT(p, S_EXEC, 0);
510
511         if (p->p_flags & P_TRACED)
512                 ksignal(p, SIGTRAP);
513
514         /* clear "fork but no exec" flag, as we _are_ execing */
515         p->p_acflag &= ~AFORK;
516
517         /* Set values passed into the program in registers. */
518         exec_setregs(imgp->entry_addr, (u_long)(uintptr_t)stack_base,
519                      imgp->ps_strings);
520
521         /* Set the access time on the vnode */
522         vn_mark_atime(imgp->vp, td);
523
524         /*
525          * Free any previous argument cache
526          */
527         pa = p->p_args;
528         p->p_args = NULL;
529         if (pa && refcount_release(&pa->ar_ref)) {
530                 kfree(pa, M_PARGS);
531                 pa = NULL;
532         }
533
534         /*
535          * Cache arguments if they fit inside our allowance
536          */
537         i = imgp->args->begin_envv - imgp->args->begin_argv;
538         if (sizeof(struct pargs) + i <= ps_arg_cache_limit) {
539                 pa = kmalloc(sizeof(struct pargs) + i, M_PARGS, M_WAITOK);
540                 refcount_init(&pa->ar_ref, 1);
541                 pa->ar_length = i;
542                 bcopy(imgp->args->begin_argv, pa->ar_args, i);
543                 KKASSERT(p->p_args == NULL);
544                 p->p_args = pa;
545         }
546
547 exec_fail_dealloc:
548
549         /*
550          * free various allocated resources
551          */
552         if (imgp->firstpage)
553                 exec_unmap_first_page(imgp);
554
555         if (imgp->vp) {
556                 vrele(imgp->vp);
557                 imgp->vp = NULL;
558         }
559
560         if (imgp->freepath)
561                 kfree(imgp->freepath, M_TEMP);
562
563         if (error == 0) {
564                 ++mycpu->gd_cnt.v_exec;
565                 lwkt_reltoken(&p->p_token);
566                 return (0);
567         }
568
569 exec_fail:
570         /*
571          * we're done here, clear P_INEXEC if we were the ones that
572          * set it.  Otherwise if vmspace_destroyed is still set we
573          * raced another thread and that thread is responsible for
574          * clearing it.
575          */
576         if (imgp->vmspace_destroyed & 2)
577                 p->p_flags &= ~P_INEXEC;
578         lwkt_reltoken(&p->p_token);
579         if (imgp->vmspace_destroyed) {
580                 /*
581                  * Sorry, no more process anymore. exit gracefully.
582                  * However we can't die right here, because our
583                  * caller might have to clean up, so indicate a
584                  * lethal error by returning -1.
585                  */
586                 return(-1);
587         } else {
588                 return(error);
589         }
590 }
591
592 /*
593  * execve() system call.
594  */
595 int
596 sys_execve(struct execve_args *uap)
597 {
598         struct nlookupdata nd;
599         struct image_args args;
600         int error;
601
602         bzero(&args, sizeof(args));
603
604         error = nlookup_init(&nd, uap->fname, UIO_USERSPACE, NLC_FOLLOW);
605         if (error == 0) {
606                 error = exec_copyin_args(&args, uap->fname, PATH_USERSPACE,
607                                         uap->argv, uap->envv);
608         }
609         if (error == 0)
610                 error = kern_execve(&nd, &args);
611         nlookup_done(&nd);
612         exec_free_args(&args);
613
614         if (error < 0) {
615                 /* We hit a lethal error condition.  Let's die now. */
616                 exit1(W_EXITCODE(0, SIGABRT));
617                 /* NOTREACHED */
618         }
619
620         /*
621          * The syscall result is returned in registers to the new program.
622          * Linux will register %edx as an atexit function and we must be
623          * sure to set it to 0.  XXX
624          */
625         if (error == 0)
626                 uap->sysmsg_result64 = 0;
627
628         return (error);
629 }
630
631 int
632 exec_map_page(struct image_params *imgp, vm_pindex_t pageno,
633               struct lwbuf **plwb, const char **pdata)
634 {
635         int rv;
636         vm_page_t ma;
637         vm_page_t m;
638         vm_object_t object;
639
640         /*
641          * The file has to be mappable.
642          */
643         if ((object = imgp->vp->v_object) == NULL)
644                 return (EIO);
645
646         if (pageno >= object->size)
647                 return (EIO);
648
649         vm_object_hold(object);
650         m = vm_page_grab(object, pageno, VM_ALLOC_NORMAL | VM_ALLOC_RETRY);
651         while ((m->valid & VM_PAGE_BITS_ALL) != VM_PAGE_BITS_ALL) {
652                 ma = m;
653
654                 /*
655                  * get_pages unbusies all the requested pages except the
656                  * primary page (at index 0 in this case).  The primary
657                  * page may have been wired during the pagein (e.g. by
658                  * the buffer cache) so vnode_pager_freepage() must be
659                  * used to properly release it.
660                  */
661                 rv = vm_pager_get_page(object, &ma, 1);
662                 m = vm_page_lookup(object, pageno);
663
664                 if (rv != VM_PAGER_OK || m == NULL || m->valid == 0) {
665                         if (m) {
666                                 vm_page_protect(m, VM_PROT_NONE);
667                                 vnode_pager_freepage(m);
668                         }
669                         return EIO;
670                 }
671         }
672         vm_page_hold(m);
673         vm_page_wakeup(m);      /* unbusy the page */
674         vm_object_drop(object);
675
676         *plwb = lwbuf_alloc(m, *plwb);
677         *pdata = (void *)lwbuf_kva(*plwb);
678
679         return (0);
680 }
681
682 /*
683  * Map the first page of an executable image.
684  *
685  * NOTE: If the mapping fails we have to NULL-out firstpage which may
686  *       still be pointing to our supplied lwp structure.
687  */
688 int
689 exec_map_first_page(struct image_params *imgp)
690 {
691         int err;
692
693         if (imgp->firstpage)
694                 exec_unmap_first_page(imgp);
695
696         imgp->firstpage = &imgp->firstpage_cache;
697         err = exec_map_page(imgp, 0, &imgp->firstpage, &imgp->image_header);
698
699         if (err) {
700                 imgp->firstpage = NULL;
701                 return err;
702         }
703
704         return 0;
705 }
706
707 void
708 exec_unmap_page(struct lwbuf *lwb)
709 {
710         vm_page_t m;
711
712         crit_enter();
713         if (lwb != NULL) {
714                 m = lwbuf_page(lwb);
715                 lwbuf_free(lwb);
716                 vm_page_unhold(m);
717         }
718         crit_exit();
719 }
720
721 void
722 exec_unmap_first_page(struct image_params *imgp)
723 {
724         exec_unmap_page(imgp->firstpage);
725         imgp->firstpage = NULL;
726         imgp->image_header = NULL;
727 }
728
729 /*
730  * Destroy old address space, and allocate a new stack
731  *      The new stack is only SGROWSIZ large because it is grown
732  *      automatically in trap.c.
733  *
734  * This is the point of no return.
735  */
736 int
737 exec_new_vmspace(struct image_params *imgp, struct vmspace *vmcopy)
738 {
739         struct vmspace *vmspace = imgp->proc->p_vmspace;
740         vm_offset_t stack_addr = USRSTACK - maxssiz;
741         struct proc *p;
742         vm_map_t map;
743         int error;
744
745         /*
746          * Indicate that we cannot gracefully error out any more, kill
747          * any other threads present, and set P_INEXEC to indicate that
748          * we are now messing with the process structure proper.
749          *
750          * If killalllwps() races return an error which coupled with
751          * vmspace_destroyed will cause us to exit.  This is what we
752          * want since another thread is patiently waiting for us to exit
753          * in that case.
754          */
755         p = curproc;
756         imgp->vmspace_destroyed = 1;
757
758         if (curthread->td_proc->p_nthreads > 1) {
759                 error = killalllwps(1);
760                 if (error)
761                         return (error);
762         }
763         imgp->vmspace_destroyed |= 2;   /* we are responsible for P_INEXEC */
764         p->p_flags |= P_INEXEC;
765
766         /*
767          * After setting P_INEXEC wait for any remaining references to
768          * the process (p) to go away.
769          *
770          * In particular, a vfork/exec sequence will replace p->p_vmspace
771          * and we must interlock anyone trying to access the space (aka
772          * procfs or sys_process.c calling procfs_domem()).
773          *
774          * If P_PPWAIT is set the parent vfork()'d and has a PHOLD() on us.
775          */
776         PSTALL(p, "exec1", ((p->p_flags & P_PPWAIT) ? 1 : 0));
777
778         /*
779          * Blow away entire process VM, if address space not shared,
780          * otherwise, create a new VM space so that other threads are
781          * not disrupted.  If we are execing a resident vmspace we
782          * create a duplicate of it and remap the stack.
783          */
784         map = &vmspace->vm_map;
785         if (vmcopy) {
786                 vmspace_exec(imgp->proc, vmcopy);
787                 vmspace = imgp->proc->p_vmspace;
788                 pmap_remove_pages(vmspace_pmap(vmspace), stack_addr, USRSTACK);
789                 map = &vmspace->vm_map;
790         } else if (vmspace->vm_sysref.refcnt == 1) {
791                 shmexit(vmspace);
792                 if (vmspace->vm_upcalls)
793                         upc_release(vmspace, ONLY_LWP_IN_PROC(imgp->proc));
794                 pmap_remove_pages(vmspace_pmap(vmspace),
795                                   0, VM_MAX_USER_ADDRESS);
796                 vm_map_remove(map, 0, VM_MAX_USER_ADDRESS);
797         } else {
798                 vmspace_exec(imgp->proc, NULL);
799                 vmspace = imgp->proc->p_vmspace;
800                 map = &vmspace->vm_map;
801         }
802
803         /* Allocate a new stack */
804         error = vm_map_stack(&vmspace->vm_map, stack_addr, (vm_size_t)maxssiz,
805                              0, VM_PROT_ALL, VM_PROT_ALL, 0);
806         if (error)
807                 return (error);
808
809         /* vm_ssize and vm_maxsaddr are somewhat antiquated concepts in the
810          * VM_STACK case, but they are still used to monitor the size of the
811          * process stack so we can check the stack rlimit.
812          */
813         vmspace->vm_ssize = sgrowsiz >> PAGE_SHIFT;
814         vmspace->vm_maxsaddr = (char *)USRSTACK - maxssiz;
815
816         return(0);
817 }
818
819 /*
820  * Copy out argument and environment strings from the old process
821  *      address space into the temporary string buffer.
822  */
823 int
824 exec_copyin_args(struct image_args *args, char *fname,
825                 enum exec_path_segflg segflg, char **argv, char **envv)
826 {
827         char    *argp, *envp;
828         int     error = 0;
829         size_t  length;
830
831         args->buf = objcache_get(exec_objcache, M_WAITOK);
832         if (args->buf == NULL)
833                 return (ENOMEM);
834         args->begin_argv = args->buf;
835         args->endp = args->begin_argv;
836         args->space = ARG_MAX;
837
838         args->fname = args->buf + ARG_MAX;
839
840         /*
841          * Copy the file name.
842          */
843         if (segflg == PATH_SYSSPACE) {
844                 error = copystr(fname, args->fname, PATH_MAX, &length);
845         } else if (segflg == PATH_USERSPACE) {
846                 error = copyinstr(fname, args->fname, PATH_MAX, &length);
847         }
848
849         /*
850          * Extract argument strings.  argv may not be NULL.  The argv
851          * array is terminated by a NULL entry.  We special-case the
852          * situation where argv[0] is NULL by passing { filename, NULL }
853          * to the new program to guarentee that the interpreter knows what
854          * file to open in case we exec an interpreted file.   Note that
855          * a NULL argv[0] terminates the argv[] array.
856          *
857          * XXX the special-casing of argv[0] is historical and needs to be
858          * revisited.
859          */
860         if (argv == NULL)
861                 error = EFAULT;
862         if (error == 0) {
863                 while ((argp = (caddr_t)(intptr_t)fuword(argv++)) != NULL) {
864                         if (argp == (caddr_t)-1) {
865                                 error = EFAULT;
866                                 break;
867                         }
868                         error = copyinstr(argp, args->endp,
869                                             args->space, &length);
870                         if (error) {
871                                 if (error == ENAMETOOLONG)
872                                         error = E2BIG;
873                                 break;
874                         }
875                         args->space -= length;
876                         args->endp += length;
877                         args->argc++;
878                 }
879                 if (args->argc == 0 && error == 0) {
880                         length = strlen(args->fname) + 1;
881                         if (length > args->space) {
882                                 error = E2BIG;
883                         } else {
884                                 bcopy(args->fname, args->endp, length);
885                                 args->space -= length;
886                                 args->endp += length;
887                                 args->argc++;
888                         }
889                 }
890         }       
891
892         args->begin_envv = args->endp;
893
894         /*
895          * extract environment strings.  envv may be NULL.
896          */
897         if (envv && error == 0) {
898                 while ((envp = (caddr_t) (intptr_t) fuword(envv++))) {
899                         if (envp == (caddr_t) -1) {
900                                 error = EFAULT;
901                                 break;
902                         }
903                         error = copyinstr(envp, args->endp, args->space,
904                             &length);
905                         if (error) {
906                                 if (error == ENAMETOOLONG)
907                                         error = E2BIG;
908                                 break;
909                         }
910                         args->space -= length;
911                         args->endp += length;
912                         args->envc++;
913                 }
914         }
915         return (error);
916 }
917
918 void
919 exec_free_args(struct image_args *args)
920 {
921         if (args->buf) {
922                 objcache_put(exec_objcache, args->buf);
923                 args->buf = NULL;
924         }
925 }
926
927 /*
928  * Copy strings out to the new process address space, constructing
929  *      new arg and env vector tables. Return a pointer to the base
930  *      so that it can be used as the initial stack pointer.
931  */
932 register_t *
933 exec_copyout_strings(struct image_params *imgp)
934 {
935         int argc, envc, sgap;
936         char **vectp;
937         char *stringp, *destp;
938         register_t *stack_base;
939         struct ps_strings *arginfo;
940         size_t execpath_len;
941         int szsigcode;
942
943         /*
944          * Calculate string base and vector table pointers.
945          * Also deal with signal trampoline code for this exec type.
946          */
947         if (imgp->execpath != NULL && imgp->auxargs != NULL)
948                 execpath_len = strlen(imgp->execpath) + 1;
949         else
950                 execpath_len = 0;
951         arginfo = (struct ps_strings *)PS_STRINGS;
952         szsigcode = *(imgp->proc->p_sysent->sv_szsigcode);
953         if (stackgap_random != 0)
954                 sgap = ALIGN(karc4random() & (stackgap_random - 1));
955         else
956                 sgap = 0;
957         destp = (caddr_t)arginfo - szsigcode - SPARE_USRSPACE - sgap -
958             roundup(execpath_len, sizeof(char *)) -
959             roundup((ARG_MAX - imgp->args->space), sizeof(char *));
960
961         /*
962          * install sigcode
963          */
964         if (szsigcode)
965                 copyout(imgp->proc->p_sysent->sv_sigcode,
966                     ((caddr_t)arginfo - szsigcode), szsigcode);
967
968         /*
969          * Copy the image path for the rtld
970          */
971         if (execpath_len != 0) {
972                 imgp->execpathp = (uintptr_t)arginfo
973                                   - szsigcode
974                                   - execpath_len;
975                 copyout(imgp->execpath, (void *)imgp->execpathp, execpath_len);
976         }
977
978         /*
979          * If we have a valid auxargs ptr, prepare some room
980          * on the stack.
981          *
982          * The '+ 2' is for the null pointers at the end of each of the
983          * arg and env vector sets, and 'AT_COUNT*2' is room for the
984          * ELF Auxargs data.
985          */
986         if (imgp->auxargs) {
987                 vectp = (char **)(destp - (imgp->args->argc +
988                         imgp->args->envc + 2 + (AT_COUNT * 2) + execpath_len) *
989                         sizeof(char*));
990         } else {
991                 vectp = (char **)(destp - (imgp->args->argc +
992                         imgp->args->envc + 2) * sizeof(char*));
993         }
994
995         /*
996          * NOTE: don't bother aligning the stack here for GCC 2.x, it will
997          * be done in crt1.o.  Note that GCC 3.x aligns the stack in main.
998          */
999
1000         /*
1001          * vectp also becomes our initial stack base
1002          */
1003         stack_base = (register_t *)vectp;
1004
1005         stringp = imgp->args->begin_argv;
1006         argc = imgp->args->argc;
1007         envc = imgp->args->envc;
1008
1009         /*
1010          * Copy out strings - arguments and environment.
1011          */
1012         copyout(stringp, destp, ARG_MAX - imgp->args->space);
1013
1014         /*
1015          * Fill in "ps_strings" struct for ps, w, etc.
1016          */
1017         suword(&arginfo->ps_argvstr, (long)(intptr_t)vectp);
1018         suword(&arginfo->ps_nargvstr, argc);
1019
1020         /*
1021          * Fill in argument portion of vector table.
1022          */
1023         for (; argc > 0; --argc) {
1024                 suword(vectp++, (long)(intptr_t)destp);
1025                 while (*stringp++ != 0)
1026                         destp++;
1027                 destp++;
1028         }
1029
1030         /* a null vector table pointer separates the argp's from the envp's */
1031         suword(vectp++, 0);
1032
1033         suword(&arginfo->ps_envstr, (long)(intptr_t)vectp);
1034         suword(&arginfo->ps_nenvstr, envc);
1035
1036         /*
1037          * Fill in environment portion of vector table.
1038          */
1039         for (; envc > 0; --envc) {
1040                 suword(vectp++, (long)(intptr_t)destp);
1041                 while (*stringp++ != 0)
1042                         destp++;
1043                 destp++;
1044         }
1045
1046         /* end of vector table is a null pointer */
1047         suword(vectp, 0);
1048
1049         return (stack_base);
1050 }
1051
1052 /*
1053  * Check permissions of file to execute.
1054  *      Return 0 for success or error code on failure.
1055  */
1056 int
1057 exec_check_permissions(struct image_params *imgp, struct mount *topmnt)
1058 {
1059         struct proc *p = imgp->proc;
1060         struct vnode *vp = imgp->vp;
1061         struct vattr *attr = imgp->attr;
1062         int error;
1063
1064         /* Get file attributes */
1065         error = VOP_GETATTR(vp, attr);
1066         if (error)
1067                 return (error);
1068
1069         /*
1070          * 1) Check if file execution is disabled for the filesystem that this
1071          *      file resides on.
1072          * 2) Insure that at least one execute bit is on - otherwise root
1073          *      will always succeed, and we don't want to happen unless the
1074          *      file really is executable.
1075          * 3) Insure that the file is a regular file.
1076          */
1077         if ((vp->v_mount->mnt_flag & MNT_NOEXEC) ||
1078             ((topmnt != NULL) && (topmnt->mnt_flag & MNT_NOEXEC)) ||
1079             ((attr->va_mode & 0111) == 0) ||
1080             (attr->va_type != VREG)) {
1081                 return (EACCES);
1082         }
1083
1084         /*
1085          * Zero length files can't be exec'd
1086          */
1087         if (attr->va_size == 0)
1088                 return (ENOEXEC);
1089
1090         /*
1091          *  Check for execute permission to file based on current credentials.
1092          */
1093         error = VOP_EACCESS(vp, VEXEC, p->p_ucred);
1094         if (error)
1095                 return (error);
1096
1097         /*
1098          * Check number of open-for-writes on the file and deny execution
1099          * if there are any.
1100          */
1101         if (vp->v_writecount)
1102                 return (ETXTBSY);
1103
1104         /*
1105          * Call filesystem specific open routine, which allows us to read,
1106          * write, and mmap the file.  Without the VOP_OPEN we can only
1107          * stat the file.
1108          */
1109         error = VOP_OPEN(vp, FREAD, p->p_ucred, NULL);
1110         if (error)
1111                 return (error);
1112
1113         return (0);
1114 }
1115
1116 /*
1117  * Exec handler registration
1118  */
1119 int
1120 exec_register(const struct execsw *execsw_arg)
1121 {
1122         const struct execsw **es, **xs, **newexecsw;
1123         int count = 2;  /* New slot and trailing NULL */
1124
1125         if (execsw)
1126                 for (es = execsw; *es; es++)
1127                         count++;
1128         newexecsw = kmalloc(count * sizeof(*es), M_TEMP, M_WAITOK);
1129         xs = newexecsw;
1130         if (execsw)
1131                 for (es = execsw; *es; es++)
1132                         *xs++ = *es;
1133         *xs++ = execsw_arg;
1134         *xs = NULL;
1135         if (execsw)
1136                 kfree(execsw, M_TEMP);
1137         execsw = newexecsw;
1138         return 0;
1139 }
1140
1141 int
1142 exec_unregister(const struct execsw *execsw_arg)
1143 {
1144         const struct execsw **es, **xs, **newexecsw;
1145         int count = 1;
1146
1147         if (execsw == NULL)
1148                 panic("unregister with no handlers left?");
1149
1150         for (es = execsw; *es; es++) {
1151                 if (*es == execsw_arg)
1152                         break;
1153         }
1154         if (*es == NULL)
1155                 return ENOENT;
1156         for (es = execsw; *es; es++)
1157                 if (*es != execsw_arg)
1158                         count++;
1159         newexecsw = kmalloc(count * sizeof(*es), M_TEMP, M_WAITOK);
1160         xs = newexecsw;
1161         for (es = execsw; *es; es++)
1162                 if (*es != execsw_arg)
1163                         *xs++ = *es;
1164         *xs = NULL;
1165         if (execsw)
1166                 kfree(execsw, M_TEMP);
1167         execsw = newexecsw;
1168         return 0;
1169 }