bsd/sys/imgact.h

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