[apple/xnu.git] / bsd / kern / mach_loader.h

/*
 * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 *	Copyright (C) 1992, NeXT, Inc.
 *
 *	File:	kern/mach_loader.h
 *
 *	Mach object file loader API.
 *
 * HISTORY
 *  24-Aug-92	Doug Mitchell at NeXT
 *	Created.
 */

#ifndef _BSD_KERN_MACH_LOADER_H_
#define _BSD_KERN_MACH_LOADER_H_

#include <mach/mach_types.h>
#include <mach-o/loader.h>

typedef int load_return_t;

/*
 * Structure describing the result from calling load_machfile(), if that
 * function returns LOAD_SUCCESS.
 */
typedef struct _load_result {
	user_addr_t             mach_header;
	user_addr_t             entry_point;

	// The user stack pointer and addressable user stack size.
	user_addr_t             user_stack;
	mach_vm_size_t          user_stack_size;

	// The allocation containing the stack and guard area.
	user_addr_t             user_stack_alloc;
	mach_vm_size_t          user_stack_alloc_size;

	mach_vm_address_t       all_image_info_addr;
	mach_vm_size_t          all_image_info_size;

	int                     thread_count;
	unsigned int
	    unixproc                : 1,
	    needs_dynlinker         : 1,
	    dynlinker               : 1,
	    validentry              : 1,
	    has_pagezero            : 1,
	    using_lcmain            : 1,
#if __arm64__
	    legacy_footprint        : 1,
#endif /* __arm64__ */
	is_64bit_addr           : 1,
	    is_64bit_data           : 1,
	    custom_stack            : 1,
	    is_cambria              : 1;
	unsigned int            csflags;
	unsigned char           uuid[16];
	mach_vm_address_t       min_vm_addr;
	mach_vm_address_t       max_vm_addr;
	unsigned int            platform_binary;
	off_t                   cs_end_offset;
	void                    *threadstate;
	size_t                  threadstate_sz;
	uint32_t                ip_platform;
	uint32_t                lr_min_sdk;
	uint32_t                lr_sdk;
	user_addr_t             dynlinker_mach_header;
	user_addr_t             dynlinker_max_vm_addr;
	int                     dynlinker_fd;
} load_result_t;

struct image_params;
load_return_t load_machfile(
	struct image_params     *imgp,
	struct mach_header      *header,
	thread_t                thread,
	vm_map_t                *mapp,
	load_result_t           *result);

load_return_t
validate_potential_simulator_binary(
	cpu_type_t               exectype,
	struct image_params      *imgp,
	off_t                    file_offset,
	off_t                    macho_size);

#define LOAD_SUCCESS            0
#define LOAD_BADARCH            1       /* CPU type/subtype not found */
#define LOAD_BADMACHO           2       /* malformed mach-o file */
#define LOAD_SHLIB              3       /* shlib version mismatch */
#define LOAD_FAILURE            4       /* Miscellaneous error */
#define LOAD_NOSPACE            5       /* No VM available */
#define LOAD_PROTECT            6       /* protection violation */
#define LOAD_RESOURCE           7       /* resource allocation failure */
#define LOAD_ENOENT             8       /* resource not found */
#define LOAD_IOERROR            9       /* IO error */
#define LOAD_DECRYPTFAIL        10      /* FP decrypt failure */
#define LOAD_BADMACHO_UPX       11      /* malformed mach-o file */
#define LOAD_BADARCH_X86        12      /* -no32exec boot-arg + attempted load of 32bit x86 binary */

#endif  /* _BSD_KERN_MACH_LOADER_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2007 Apple Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
0a7de745	5	*
2d21ac55 A	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.
0a7de745	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
2d21ac55 A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
0a7de745	17	*
2d21ac55 A	18	* The Original Code and all software distributed under the License are
2d21ac55 A	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
0a7de745	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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	*/
0a7de745 A	39
0a7de745 A	40	#ifndef _BSD_KERN_MACH_LOADER_H_
1c79356b A	41	#define _BSD_KERN_MACH_LOADER_H_
	42
	43	#include <mach/mach_types.h>
1c79356b A	44	#include <mach-o/loader.h>
	45
	46	typedef int load_return_t;
	47
91447636 A	48	/*
	49	* Structure describing the result from calling load_machfile(), if that
	50	* function returns LOAD_SUCCESS.
	51	*/
1c79356b	52	typedef struct _load_result {
0a7de745 A	53	user_addr_t mach_header;
0a7de745 A	54	user_addr_t entry_point;
39037602 A	55
39037602 A	56	// The user stack pointer and addressable user stack size.
0a7de745 A	57	user_addr_t user_stack;
0a7de745 A	58	mach_vm_size_t user_stack_size;
39037602 A	59
39037602 A	60	// The allocation containing the stack and guard area.
0a7de745 A	61	user_addr_t user_stack_alloc;
0a7de745 A	62	mach_vm_size_t user_stack_alloc_size;
39037602	63
0a7de745 A	64	mach_vm_address_t all_image_info_addr;
0a7de745 A	65	mach_vm_size_t all_image_info_size;
a39ff7e2	66
0a7de745	67	int thread_count;
55e303ae	68	unsigned int
0a7de745 A	69	unixproc : 1,
	70	needs_dynlinker : 1,
	71	dynlinker : 1,
	72	validentry : 1,
	73	has_pagezero : 1,
	74	using_lcmain : 1,
d9a64523	75	#if __arm64__
0a7de745	76	legacy_footprint : 1,
d9a64523	77	#endif /* __arm64__ */
0a7de745 A	78	is_64bit_addr : 1,
0a7de745 A	79	is_64bit_data : 1,
f427ee49 A	80	custom_stack : 1,
f427ee49 A	81	is_cambria : 1;
0a7de745 A	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;
cb323159	90	uint32_t ip_platform;
f427ee49	91	uint32_t lr_min_sdk;
cb323159	92	uint32_t lr_sdk;
f427ee49 A	93	user_addr_t dynlinker_mach_header;
	94	user_addr_t dynlinker_max_vm_addr;
	95	int dynlinker_fd;
1c79356b A	96	} load_result_t;
1c79356b A	97
91447636	98	struct image_params;
1c79356b	99	load_return_t load_machfile(
0a7de745 A	100	struct image_params *imgp,
	101	struct mach_header *header,
	102	thread_t thread,
	103	vm_map_t *mapp,
	104	load_result_t *result);
1c79356b	105
cb323159 A	106	load_return_t
	107	validate_potential_simulator_binary(
	108	cpu_type_t exectype,
	109	struct image_params *imgp,
	110	off_t file_offset,
	111	off_t macho_size);
	112
0a7de745 A	113	#define LOAD_SUCCESS 0
	114	#define LOAD_BADARCH 1 /* CPU type/subtype not found */
	115	#define LOAD_BADMACHO 2 /* malformed mach-o file */
	116	#define LOAD_SHLIB 3 /* shlib version mismatch */
	117	#define LOAD_FAILURE 4 /* Miscellaneous error */
	118	#define LOAD_NOSPACE 5 /* No VM available */
	119	#define LOAD_PROTECT 6 /* protection violation */
	120	#define LOAD_RESOURCE 7 /* resource allocation failure */
	121	#define LOAD_ENOENT 8 /* resource not found */
	122	#define LOAD_IOERROR 9 /* IO error */
	123	#define LOAD_DECRYPTFAIL 10 /* FP decrypt failure */
	124	#define LOAD_BADMACHO_UPX 11 /* malformed mach-o file */
	125	#define LOAD_BADARCH_X86 12 /* -no32exec boot-arg + attempted load of 32bit x86 binary */
1c79356b	126
0a7de745	127	#endif /* _BSD_KERN_MACH_LOADER_H_ */