1 /* 2 * Copyright (c) 2000-2007 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_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 License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 /* 29 * Copyright (C) 1992, NeXT, Inc. 30 * 31 * File: kern/mach_loader.h 32 * 33 * Mach object file loader API. 34 * 35 * HISTORY 36 * 24-Aug-92 Doug Mitchell at NeXT 37 * Created. 38 */ 39 40 #ifndef _BSD_KERN_MACH_LOADER_H_ 41 #define _BSD_KERN_MACH_LOADER_H_ 42 43 #include <mach/mach_types.h> 44 #include <mach-o/loader.h> 45 46 typedef int load_return_t; 47 48 /* 49 * Structure describing the result from calling load_machfile(), if that 50 * function returns LOAD_SUCCESS. 51 */ 52 typedef struct _load_result { 53 user_addr_t mach_header; 54 user_addr_t entry_point; 55 56 // The user stack pointer and addressable user stack size. 57 user_addr_t user_stack; 58 mach_vm_size_t user_stack_size; 59 60 // The allocation containing the stack and guard area. 61 user_addr_t user_stack_alloc; 62 mach_vm_size_t user_stack_alloc_size; 63 64 mach_vm_address_t all_image_info_addr; 65 mach_vm_size_t all_image_info_size; 66 67 int thread_count; 68 unsigned int 69 unixproc : 1, 70 needs_dynlinker : 1, 71 dynlinker : 1, 72 validentry : 1, 73 has_pagezero : 1, 74 using_lcmain : 1, 75 #if __arm64__ 76 legacy_footprint : 1, 77 #endif /* __arm64__ */ 78 is_64bit_addr : 1, 79 is_64bit_data : 1, 80 custom_stack : 1, 81 is_rosetta : 1; 82 unsigned int csflags; 83 unsigned char uuid[16]; 84 mach_vm_address_t min_vm_addr; 85 mach_vm_address_t max_vm_addr; 86 unsigned int platform_binary; 87 off_t cs_end_offset; 88 void *threadstate; 89 size_t threadstate_sz; 90 uint32_t ip_platform; 91 uint32_t lr_min_sdk; 92 uint32_t lr_sdk; 93 user_addr_t dynlinker_mach_header; 94 user_addr_t dynlinker_max_vm_addr; 95 int dynlinker_fd; 96 struct fileproc* dynlinker_fp; 97 } load_result_t; 98 99 struct image_params; 100 load_return_t load_machfile( 101 struct image_params *imgp, 102 struct mach_header *header, 103 thread_t thread, 104 vm_map_t *mapp, 105 load_result_t *result); 106 107 load_return_t 108 validate_potential_simulator_binary( 109 cpu_type_t exectype, 110 struct image_params *imgp, 111 off_t file_offset, 112 off_t macho_size); 113 114 #define LOAD_SUCCESS 0 115 #define LOAD_BADARCH 1 /* CPU type/subtype not found */ 116 #define LOAD_BADMACHO 2 /* malformed mach-o file */ 117 #define LOAD_SHLIB 3 /* shlib version mismatch */ 118 #define LOAD_FAILURE 4 /* Miscellaneous error */ 119 #define LOAD_NOSPACE 5 /* No VM available */ 120 #define LOAD_PROTECT 6 /* protection violation */ 121 #define LOAD_RESOURCE 7 /* resource allocation failure */ 122 #define LOAD_ENOENT 8 /* resource not found */ 123 #define LOAD_IOERROR 9 /* IO error */ 124 #define LOAD_DECRYPTFAIL 10 /* FP decrypt failure */ 125 #define LOAD_BADMACHO_UPX 11 /* malformed mach-o file */ 126 #define LOAD_BADARCH_X86 12 /* -no32exec boot-arg + attempted load of 32bit x86 binary */ 127 128 #endif /* _BSD_KERN_MACH_LOADER_H_ */ 129