/* $OpenBSD: exec.h,v 1.24 2007/05/26 00:36:03 krw Exp $ */ /* $NetBSD: exec.h,v 1.59 1996/02/09 18:25:09 christos Exp $ */ /*- * Copyright (c) 1994 Christopher G. Demetriou * Copyright (c) 1993 Theo de Raadt * Copyright (c) 1992, 1993 * The Regents of the University of California. All rights reserved. * (c) UNIX System Laboratories, Inc. * All or some portions of this file are derived from material licensed * to the University of California by American Telephone and Telegraph * Co. or Unix System Laboratories, Inc. and are reproduced herein with * the permission of UNIX System Laboratories, Inc. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the University nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * * @(#)exec.h 8.3 (Berkeley) 1/21/94 */ #ifndef _SYS_EXEC_H_ #define _SYS_EXEC_H_ /* * The following structure is found at the top of the user stack of each * user process. The ps program uses it to locate argv and environment * strings. Programs that wish ps to display other information may modify * it; normally ps_argvstr points to argv[0], and ps_nargvstr is the same * as the program's argc. The fields ps_envstr and ps_nenvstr are the * equivalent for the environment. */ struct ps_strings { char **ps_argvstr; /* first of 0 or more argument strings */ int ps_nargvstr; /* the number of argument strings */ char **ps_envstr; /* first of 0 or more environment strings */ int ps_nenvstr; /* the number of environment strings */ }; /* * Address of ps_strings structure (in user space). */ #ifdef MACHINE_STACK_GROWS_UP #define PS_STRINGS ((struct ps_strings *)(USRSTACK)) #else #define PS_STRINGS \ ((struct ps_strings *)(USRSTACK - sizeof(struct ps_strings))) #endif /* * Below the PS_STRINGS and sigtramp, we may require a gap on the stack * (used to copyin/copyout various emulation data structures). */ #define STACKGAPLEN (2*1024) /* plenty enough for now */ #ifdef MACHINE_STACK_GROWS_UP #define STACKGAPBASE_UNALIGNED \ ((caddr_t)PS_STRINGS + sizeof(struct ps_strings)) #else #define STACKGAPBASE_UNALIGNED \ ((caddr_t)PS_STRINGS - STACKGAPLEN) #endif #define STACKGAPBASE \ ((caddr_t)ALIGN(STACKGAPBASE_UNALIGNED)) /* * the following structures allow execve() to put together processes * in a more extensible and cleaner way. * * the exec_package struct defines an executable being execve()'d. * it contains the header, the vmspace-building commands, the vnode * information, and the arguments associated with the newly-execve'd * process. * * the exec_vmcmd struct defines a command description to be used * in creating the new process's vmspace. */ struct proc; struct exec_package; typedef int (*exec_makecmds_fcn)(struct proc *, struct exec_package *); struct execsw { u_int es_hdrsz; /* size of header for this format */ exec_makecmds_fcn es_check; /* function to check exec format */ struct emul *es_emul; /* emulation */ }; struct exec_vmcmd { int (*ev_proc)(struct proc *p, struct exec_vmcmd *cmd); /* procedure to run for region of vmspace */ u_long ev_len; /* length of the segment to map */ u_long ev_addr; /* address in the vmspace to place it at */ struct vnode *ev_vp; /* vnode pointer for the file w/the data */ u_long ev_offset; /* offset in the file for the data */ u_int ev_prot; /* protections for segment */ int ev_flags; #define VMCMD_RELATIVE 0x0001 /* ev_addr is relative to base entry */ #define VMCMD_BASE 0x0002 /* marks a base entry */ }; #define EXEC_DEFAULT_VMCMD_SETSIZE 8 /* # of cmds in set to start */ /* exec vmspace-creation command set; see below */ struct exec_vmcmd_set { u_int evs_cnt; u_int evs_used; struct exec_vmcmd *evs_cmds; struct exec_vmcmd evs_start[EXEC_DEFAULT_VMCMD_SETSIZE]; }; struct exec_package { char *ep_name; /* file's name */ void *ep_hdr; /* file's exec header */ u_int ep_hdrlen; /* length of ep_hdr */ u_int ep_hdrvalid; /* bytes of ep_hdr that are valid */ struct nameidata *ep_ndp; /* namei data pointer for lookups */ struct exec_vmcmd_set ep_vmcmds; /* vmcmds used to build vmspace */ struct vnode *ep_vp; /* executable's vnode */ struct vattr *ep_vap; /* executable's attributes */ u_long ep_taddr; /* process's text address */ u_long ep_tsize; /* size of process's text */ u_long ep_daddr; /* process's data(+bss) address */ u_long ep_dsize; /* size of process's data(+bss) */ u_long ep_maxsaddr; /* proc's max stack addr ("top") */ u_long ep_minsaddr; /* proc's min stack addr ("bottom") */ u_long ep_ssize; /* size of process's stack */ u_long ep_entry; /* process's entry point */ u_int ep_flags; /* flags; see below. */ char **ep_fa; /* a fake args vector for scripts */ int ep_fd; /* a file descriptor we're holding */ struct emul *ep_emul; /* os emulation */ void *ep_emul_arg; /* emulation argument */ void *ep_emul_argp; /* emulation argument pointer */ char *ep_interp; /* name of interpreter if any */ u_long ep_interp_pos; /* interpreter load position */ }; #define EXEC_INDIR 0x0001 /* script handling already done */ #define EXEC_HASFD 0x0002 /* holding a shell script */ #define EXEC_HASARGL 0x0004 /* has fake args vector */ #define EXEC_SKIPARG 0x0008 /* don't copy user-supplied argv[0] */ #define EXEC_DESTR 0x0010 /* destructive ops performed */ #ifdef _KERNEL /* * functions used either by execve() or the various cpu-dependent execve() * hooks. */ int exec_makecmds(struct proc *, struct exec_package *); int exec_runcmds(struct proc *, struct exec_package *); void vmcmdset_extend(struct exec_vmcmd_set *); void kill_vmcmds(struct exec_vmcmd_set *evsp); int vmcmd_map_pagedvn(struct proc *, struct exec_vmcmd *); int vmcmd_map_readvn(struct proc *, struct exec_vmcmd *); int vmcmd_map_zero(struct proc *, struct exec_vmcmd *); void *copyargs(struct exec_package *, struct ps_strings *, void *, void *); void setregs(struct proc *, struct exec_package *, u_long, register_t *); int check_exec(struct proc *, struct exec_package *); int exec_setup_stack(struct proc *, struct exec_package *); int exec_process_vmcmds(struct proc *, struct exec_package *); #ifdef DEBUG void new_vmcmd(struct exec_vmcmd_set *evsp, int (*proc)(struct proc *p, struct exec_vmcmd *), u_long len, u_long addr, struct vnode *vp, u_long offset, u_int prot, int flags); #define NEW_VMCMD(evsp,proc,len,addr,vp,offset,prot) \ new_vmcmd(evsp,proc,len,addr,vp,offset,prot, 0); #define NEW_VMCMD2(evsp,proc,len,addr,vp,offset,prot,flags) \ new_vmcmd(evsp,proc,len,addr,vp,offset,prot,flags) #else /* DEBUG */ #define NEW_VMCMD(evsp,proc,len,addr,vp,offset,prot) \ NEW_VMCMD2(evsp,proc,len,addr,vp,offset,prot,0) #define NEW_VMCMD2(evsp,proc,len,addr,vp,offset,prot,flags) do { \ struct exec_vmcmd *vcp; \ if ((evsp)->evs_used >= (evsp)->evs_cnt) \ vmcmdset_extend(evsp); \ vcp = &(evsp)->evs_cmds[(evsp)->evs_used++]; \ vcp->ev_proc = (proc); \ vcp->ev_len = (len); \ vcp->ev_addr = (addr); \ if ((vcp->ev_vp = (vp)) != NULLVP) \ VREF(vp); \ vcp->ev_offset = (offset); \ vcp->ev_prot = (prot); \ vcp->ev_flags = (flags); \ } while (0) #endif /* DEBUG */ /* Initialize an empty vmcmd set */ #define VMCMDSET_INIT(vmc) do { \ (vmc)->evs_cnt = EXEC_DEFAULT_VMCMD_SETSIZE; \ (vmc)->evs_cmds = (vmc)->evs_start; \ (vmc)->evs_used = 0; \ } while (0) /* * Exec function switch: * * Note that each makecmds function is responsible for loading the * exec package with the necessary functions for any exec-type-specific * handling. * * Functions for specific exec types should be defined in their own * header file. */ extern struct execsw execsw[]; extern int nexecs; extern int exec_maxhdrsz; #endif /* _KERNEL */ #include #include #endif /* !_SYS_EXEC_H_ */