bsd/kern/mach_loader.h

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