bsd/kern/mach_loader.h

   1 /*
   2  * Copyright (c) 2006 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) 1992, NeXT, Inc.
  32  *
  33  *      File:   kern/mach_loader.h
  34  *
  35  *      Mach object file loader API.
  36  *
  37  * HISTORY
  38  *  24-Aug-92   Doug Mitchell at NeXT
  39  *      Created.
  40  */
  41
  42 #ifndef _BSD_KERN_MACH_LOADER_H_
  43 #define _BSD_KERN_MACH_LOADER_H_
  44
  45 #include <mach/mach_types.h>
  46 #include <mach-o/loader.h>
  47
  48 typedef int load_return_t;
  49
  50 /*
  51  * Structure describing the result from calling load_machfile(), if that
  52  * function returns LOAD_SUCCESS.
  53  */
  54 typedef struct _load_result {
  55         user_addr_t     mach_header;
  56         user_addr_t     entry_point;
  57         user_addr_t     user_stack;
  58         int             thread_count;
  59         unsigned int
  60         /* boolean_t */ unixproc        :1,
  61                         dynlinker       :1,
  62                         customstack     :1,
  63                                         :0;
  64 } load_result_t;
  65
  66 struct image_params;
  67 load_return_t load_machfile(
  68         struct image_params     *imgp,
  69         struct mach_header      *header,
  70         thread_t                thr_act,
  71         vm_map_t                map,
  72         boolean_t               clean_regions,
  73         load_result_t           *result);
  74
  75 #define LOAD_SUCCESS            0
  76 #define LOAD_BADARCH            1       /* CPU type/subtype not found */
  77 #define LOAD_BADMACHO           2       /* malformed mach-o file */
  78 #define LOAD_SHLIB              3       /* shlib version mismatch */
  79 #define LOAD_FAILURE            4       /* Miscellaneous error */
  80 #define LOAD_NOSPACE            5       /* No VM available */
  81 #define LOAD_PROTECT            6       /* protection violation */
  82 #define LOAD_RESOURCE           7       /* resource allocation failure */
  83 #define LOAD_ENOENT             8       /* resource not found */
  84 #define LOAD_IOERROR            9       /* IO error */
  85
  86 #endif  /* _BSD_KERN_MACH_LOADER_H_ */