include/sys/exec.h

   1 /*      $NetBSD: exec.h,v 1.133 2011/03/04 22:25:32 joerg Exp $ */
   2
   3 /*-
   4  * Copyright (c) 1992, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)exec.h      8.4 (Berkeley) 2/19/95
  37  */
  38
  39 /*-
  40  * Copyright (c) 1993 Theo de Raadt.  All rights reserved.
  41  *
  42  * Redistribution and use in source and binary forms, with or without
  43  * modification, are permitted provided that the following conditions
  44  * are met:
  45  * 1. Redistributions of source code must retain the above copyright
  46  *    notice, this list of conditions and the following disclaimer.
  47  * 2. Redistributions in binary form must reproduce the above copyright
  48  *    notice, this list of conditions and the following disclaimer in the
  49  *    documentation and/or other materials provided with the distribution.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  52  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  53  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  54  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  55  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  56  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  60  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  */
  62
  63 /*-
  64  * Copyright (c) 1994 Christopher G. Demetriou
  65  *
  66  * Redistribution and use in source and binary forms, with or without
  67  * modification, are permitted provided that the following conditions
  68  * are met:
  69  * 1. Redistributions of source code must retain the above copyright
  70  *    notice, this list of conditions and the following disclaimer.
  71  * 2. Redistributions in binary form must reproduce the above copyright
  72  *    notice, this list of conditions and the following disclaimer in the
  73  *    documentation and/or other materials provided with the distribution.
  74  * 3. All advertising materials mentioning features or use of this software
  75  *    must display the following acknowledgement:
  76  *      This product includes software developed by the University of
  77  *      California, Berkeley and its contributors.
  78  * 4. Neither the name of the University nor the names of its contributors
  79  *    may be used to endorse or promote products derived from this software
  80  *    without specific prior written permission.
  81  *
  82  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  83  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  84  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  85  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  86  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  87  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  88  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  89  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  90  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  91  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  92  * SUCH DAMAGE.
  93  *
  94  *      @(#)exec.h      8.4 (Berkeley) 2/19/95
  95  */
  96
  97 #ifndef _SYS_EXEC_H_
  98 #define _SYS_EXEC_H_
  99
 100 struct pathbuf; /* from namei.h */
 101
 102
 103 /*
 104  * The following structure is found at the top of the user stack of each
 105  * user process. The ps program uses it to locate argv and environment
 106  * strings. Programs that wish ps to display other information may modify
 107  * it; normally ps_argvstr points to argv[0], and ps_nargvstr is the same
 108  * as the program's argc. The fields ps_envstr and ps_nenvstr are the
 109  * equivalent for the environment.
 110  */
 111 struct ps_strings {
 112         char    **ps_argvstr;   /* first of 0 or more argument strings */
 113         int     ps_nargvstr;    /* the number of argument strings */
 114         char    **ps_envstr;    /* first of 0 or more environment strings */
 115         int     ps_nenvstr;     /* the number of environment strings */
 116 };
 117
 118 #ifdef _KERNEL
 119 struct ps_strings32 {
 120         uint32_t        ps_argvstr;     /* first of 0 or more argument strings */
 121         int32_t         ps_nargvstr;    /* the number of argument strings */
 122         uint32_t        ps_envstr;      /* first of 0 or more environment strings */
 123         int32_t         ps_nenvstr;     /* the number of environment strings */
 124 };
 125 #endif
 126
 127 /*
 128  * the following structures allow execve() to put together processes
 129  * in a more extensible and cleaner way.
 130  *
 131  * the exec_package struct defines an executable being execve()'d.
 132  * it contains the header, the vmspace-building commands, the vnode
 133  * information, and the arguments associated with the newly-execve'd
 134  * process.
 135  *
 136  * the exec_vmcmd struct defines a command description to be used
 137  * in creating the new process's vmspace.
 138  */
 139
 140 #include <sys/uio.h>
 141
 142 struct lwp;
 143 struct proc;
 144 struct exec_package;
 145 struct vnode;
 146
 147 typedef int (*exec_makecmds_fcn)(struct lwp *, struct exec_package *);
 148
 149 struct execsw {
 150         u_int   es_hdrsz;               /* size of header for this format */
 151         exec_makecmds_fcn es_makecmds;  /* function to setup vmcmds */
 152         union {                         /* probe function */
 153                 int (*elf_probe_func)(struct lwp *,
 154                         struct exec_package *, void *, char *, vaddr_t *);
 155                 int (*ecoff_probe_func)(struct lwp *, struct exec_package *);
 156                 int (*mach_probe_func)(const char **);
 157         } u;
 158         struct  emul *es_emul;          /* os emulation */
 159         int     es_prio;                /* entry priority */
 160         int     es_arglen;              /* Extra argument size in words */
 161                                         /* Copy arguments on the new stack */
 162         int     (*es_copyargs)(struct lwp *, struct exec_package *,
 163                         struct ps_strings *, char **, void *);
 164                                         /* Set registers before execution */
 165         void    (*es_setregs)(struct lwp *, struct exec_package *, vaddr_t);
 166                                         /* Dump core */
 167         int     (*es_coredump)(struct lwp *, void *);
 168         int     (*es_setup_stack)(struct lwp *, struct exec_package *);
 169 };
 170
 171 #define EXECSW_PRIO_ANY         0x000   /* default, no preference */
 172 #define EXECSW_PRIO_FIRST       0x001   /* this should be among first */
 173 #define EXECSW_PRIO_LAST        0x002   /* this should be among last */
 174
 175 /* exec vmspace-creation command set; see below */
 176 struct exec_vmcmd_set {
 177         u_int   evs_cnt;
 178         u_int   evs_used;
 179         struct  exec_vmcmd *evs_cmds;
 180 };
 181
 182 #define EXEC_DEFAULT_VMCMD_SETSIZE      9       /* # of cmds in set to start */
 183
 184 struct exec_package {
 185         const char *ep_name;            /* file's name */
 186         const char *ep_kname;           /* kernel-side copy of file's name */
 187         char *ep_resolvedname;          /* fully resolved path from namei */
 188         void    *ep_hdr;                /* file's exec header */
 189         u_int   ep_hdrlen;              /* length of ep_hdr */
 190         u_int   ep_hdrvalid;            /* bytes of ep_hdr that are valid */
 191         struct  exec_vmcmd_set ep_vmcmds;  /* vmcmds used to build vmspace */
 192         struct  vnode *ep_vp;           /* executable's vnode */
 193         struct  vattr *ep_vap;          /* executable's attributes */
 194         vaddr_t ep_taddr;               /* process's text address */
 195         vsize_t ep_tsize;               /* size of process's text */
 196         vaddr_t ep_daddr;               /* process's data(+bss) address */
 197         vsize_t ep_dsize;               /* size of process's data(+bss) */
 198         vaddr_t ep_maxsaddr;            /* proc's max stack addr ("top") */
 199         vaddr_t ep_minsaddr;            /* proc's min stack addr ("bottom") */
 200         vsize_t ep_ssize;               /* size of process's stack */
 201         vaddr_t ep_entry;               /* process's entry point */
 202         vaddr_t ep_vm_minaddr;          /* bottom of process address space */
 203         vaddr_t ep_vm_maxaddr;          /* top of process address space */
 204         u_int   ep_flags;               /* flags; see below. */
 205         size_t  ep_fa_len;              /* byte size of ep_fa */
 206         struct exec_fakearg {
 207                 char *fa_arg;
 208                 size_t fa_len;
 209         } *ep_fa;                       /* a fake args vector for scripts */
 210         int     ep_fd;                  /* a file descriptor we're holding */
 211         void    *ep_emul_arg;           /* emulation argument */
 212         const struct    execsw *ep_esch;/* execsw entry */
 213         struct vnode *ep_emul_root;     /* base of emulation filesystem */
 214         struct vnode *ep_interp;        /* vnode of (elf) interpeter */
 215         uint32_t ep_pax_flags;          /* pax flags */
 216         char    *ep_path;               /* absolute path of executable */
 217 };
 218 #define EXEC_INDIR      0x0001          /* script handling already done */
 219 #define EXEC_HASFD      0x0002          /* holding a shell script */
 220 #define EXEC_HASARGL    0x0004          /* has fake args vector */
 221 #define EXEC_SKIPARG    0x0008          /* don't copy user-supplied argv[0] */
 222 #define EXEC_DESTR      0x0010          /* destructive ops performed */
 223 #define EXEC_32         0x0020          /* 32-bit binary emulation */
 224 #define EXEC_FORCEAUX   0x0040          /* always use ELF AUX vector */
 225
 226 struct exec_vmcmd {
 227         int     (*ev_proc)(struct lwp *, struct exec_vmcmd *);
 228                                 /* procedure to run for region of vmspace */
 229         vsize_t ev_len;         /* length of the segment to map */
 230         vaddr_t ev_addr;        /* address in the vmspace to place it at */
 231         struct  vnode *ev_vp;   /* vnode pointer for the file w/the data */
 232         vsize_t ev_offset;      /* offset in the file for the data */
 233         u_int   ev_prot;        /* protections for segment */
 234         int     ev_flags;
 235 #define VMCMD_RELATIVE  0x0001  /* ev_addr is relative to base entry */
 236 #define VMCMD_BASE      0x0002  /* marks a base entry */
 237 #define VMCMD_FIXED     0x0004  /* entry must be mapped at ev_addr */
 238 #define VMCMD_STACK     0x0008  /* entry is for a stack */
 239 };
 240
 241 #ifdef _KERNEL
 242 /*
 243  * funtions used either by execve() or the various CPU-dependent execve()
 244  * hooks.
 245  */
 246 void    kill_vmcmd              (struct exec_vmcmd **);
 247 int     exec_makecmds           (struct lwp *, struct exec_package *);
 248 int     exec_runcmds            (struct lwp *, struct exec_package *);
 249 void    vmcmdset_extend         (struct exec_vmcmd_set *);
 250 void    kill_vmcmds             (struct exec_vmcmd_set *);
 251 int     vmcmd_map_pagedvn       (struct lwp *, struct exec_vmcmd *);
 252 int     vmcmd_map_readvn        (struct lwp *, struct exec_vmcmd *);
 253 int     vmcmd_readvn            (struct lwp *, struct exec_vmcmd *);
 254 int     vmcmd_map_zero          (struct lwp *, struct exec_vmcmd *);
 255 int     copyargs                (struct lwp *, struct exec_package *,
 256                                     struct ps_strings *, char **, void *);
 257 int     copyin_psstrings        (struct proc *, struct ps_strings *);
 258 int     copy_procargs           (struct proc *, int, size_t *,
 259     int (*)(void *, const void *, size_t, size_t), void *);
 260 void    setregs                 (struct lwp *, struct exec_package *, vaddr_t);
 261 int     check_veriexec          (struct lwp *, struct vnode *,
 262                                      struct exec_package *, int);
 263 int     check_exec              (struct lwp *, struct exec_package *,
 264                                      struct pathbuf *);
 265 int     exec_init               (int);
 266 int     exec_read_from          (struct lwp *, struct vnode *, u_long off,
 267                                     void *, size_t);
 268 int     exec_setup_stack        (struct lwp *, struct exec_package *);
 269
 270 int     coredump_write          (void *, enum uio_seg, const void *, size_t);
 271 /*
 272  * Machine dependent functions
 273  */
 274 struct core;
 275 struct core32;
 276 int     cpu_coredump(struct lwp *, void *, struct core *);
 277 int     cpu_coredump32(struct lwp *, void *, struct core32 *);
 278
 279 int     exec_add(struct execsw *, int);
 280 int     exec_remove(struct execsw *, int);
 281
 282 void    new_vmcmd(struct exec_vmcmd_set *,
 283                     int (*)(struct lwp *, struct exec_vmcmd *),
 284                     vsize_t, vaddr_t, struct vnode *, u_long, u_int, int);
 285 #define NEW_VMCMD(evsp,lwp,len,addr,vp,offset,prot) \
 286         new_vmcmd(evsp,lwp,len,addr,vp,offset,prot,0)
 287 #define NEW_VMCMD2(evsp,lwp,len,addr,vp,offset,prot,flags) \
 288         new_vmcmd(evsp,lwp,len,addr,vp,offset,prot,flags)
 289
 290 typedef int (*execve_fetch_element_t)(char * const *, size_t, char **);
 291 int     execve1(struct lwp *, const char *, char * const *, char * const *,
 292     execve_fetch_element_t);
 293
 294 extern int      maxexec;
 295
 296 #endif /* _KERNEL */
 297
 298 #endif /* !_SYS_EXEC_H_ */