bsd/sys/imgact.h

   1 /*
   2  * Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * Copyright (c) 1993, David Greenman
  24  * All rights reserved.
  25  *
  26  * Redistribution and use in source and binary forms, with or without
  27  * modification, are permitted provided that the following conditions
  28  * are met:
  29  * 1. Redistributions of source code must retain the above copyright
  30  *    notice, this list of conditions and the following disclaimer.
  31  * 2. Redistributions in binary form must reproduce the above copyright
  32  *    notice, this list of conditions and the following disclaimer in the
  33  *    documentation and/or other materials provided with the distribution.
  34  * 3. All advertising materials mentioning features or use of this software
  35  *    must display the following acknowledgement:
  36  *      This product includes software developed by the University of
  37  *      California, Berkeley and its contributors.
  38  * 4. Neither the name of the University nor the names of its contributors
  39  *    may be used to endorse or promote products derived from this software
  40  *    without specific prior written permission.
  41  *
  42  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  46  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  * SUCH DAMAGE.
  53  */
  54 #ifndef _SYS_IMGACT_H_
  55 #define _SYS_IMGACT_H_
  56
  57 #define IMG_SHSIZE      512     /* largest shell interpreter, in bytes */
  58
  59 struct proc;
  60 struct nameidata;
  61
  62 struct image_params {
  63         user_addr_t     ip_user_fname;          /* argument */
  64         user_addr_t     ip_user_argv;           /* argument */
  65         user_addr_t     ip_user_envv;           /* argument */
  66         struct vnode    *ip_vp;                 /* file */
  67         struct vnode_attr       *ip_vattr;      /* run file attributes */
  68         struct vnode_attr       *ip_origvattr;  /* invocation file attributes */
  69         char            *ip_vdata;              /* file data (up to one page) */
  70         int             ip_flags;               /* image flags */
  71         int             ip_argc;                /* argument count */
  72         char            *ip_argv;               /* argument vector beginning */
  73         int             ip_envc;                /* environment count */
  74         char            *ip_strings;            /* base address for strings */
  75         char            *ip_strendp;            /* current end pointer */
  76         char            *ip_strendargvp;        /* end of argv/start of envp */
  77         int             ip_strspace;            /* remaining space */
  78         user_size_t     ip_arch_offset;         /* subfile offset in ip_vp */
  79         user_size_t     ip_arch_size;           /* subfile length in ip_vp */
  80         char            ip_interp_name[IMG_SHSIZE];     /* interpreter name */
  81
  82         /* Next two fields are for support of Classic... */
  83         char            *ip_p_comm;             /* optional alt p->p_comm */
  84         char            *ip_tws_cache_name;     /* task working set cache */
  85         struct vfs_context      *ip_vfs_context;        /* VFS context */
  86         struct nameidata *ip_ndp;               /* current nameidata */
  87         thread_t        ip_vfork_thread;        /* thread created, if vfork */
  88 };
  89
  90 /*
  91  * Image flags
  92  */
  93 #define IMGPF_NONE      0x00000000              /* No flags */
  94 #define IMGPF_INTERPRET 0x00000001              /* Interpreter invoked */
  95 #define IMGPF_RESERVED1 0x00000002              /* reserved */
  96 #define IMGPF_WAS_64BIT 0x00000004              /* exec from a 64Bit binary */
  97 #define IMGPF_IS_64BIT  0x00000008              /* exec to a 64Bit binary */
  98
  99 #endif  /* !_SYS_IMGACT */