[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
		/* boolean_t */	unixproc	:1,
				needs_dynlinker : 1,
				dynlinker	:1,
				validentry	:1,
				has_pagezero    :1,
				using_lcmain	:1,
				is64bit         :1,
						:0;
	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;
} 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);

#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 */

#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@
1c79356b	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.
8f6c56a5	14	*
2d21ac55 A	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
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.
8f6c56a5	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	*/
	39
	40	#ifndef _BSD_KERN_MACH_LOADER_H_
	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 {
b0d623f7 A	53	user_addr_t mach_header;
b0d623f7 A	54	user_addr_t entry_point;
39037602 A	55
39037602 A	56	// The user stack pointer and addressable user stack size.
b0d623f7	57	user_addr_t user_stack;
316670eb	58	mach_vm_size_t user_stack_size;
39037602 A	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
b0d623f7 A	64	mach_vm_address_t all_image_info_addr;
	65	mach_vm_size_t all_image_info_size;
	66	int thread_count;
55e303ae	67	unsigned int
b0d623f7	68	/* boolean_t */ unixproc :1,
316670eb	69	needs_dynlinker : 1,
b0d623f7	70	dynlinker :1,
6d2010ae	71	validentry :1,
3e170ce0	72	has_pagezero :1,
c18c124e	73	using_lcmain :1,
39037602	74	is64bit :1,
b0d623f7 A	75	:0;
b0d623f7 A	76	unsigned int csflags;
490019cf	77	unsigned char uuid[16];
6d2010ae A	78	mach_vm_address_t min_vm_addr;
6d2010ae A	79	mach_vm_address_t max_vm_addr;
fe8ab488	80	unsigned int platform_binary;
04b8595b	81	off_t cs_end_offset;
490019cf A	82	void *threadstate;
490019cf A	83	size_t threadstate_sz;
1c79356b A	84	} load_result_t;
1c79356b A	85
91447636	86	struct image_params;
1c79356b	87	load_return_t load_machfile(
91447636	88	struct image_params *imgp,
1c79356b	89	struct mach_header *header,
2d21ac55	90	thread_t thread,
490019cf	91	vm_map_t *mapp,
91447636	92	load_result_t *result);
1c79356b A	93
	94	#define LOAD_SUCCESS 0
	95	#define LOAD_BADARCH 1 /* CPU type/subtype not found */
	96	#define LOAD_BADMACHO 2 /* malformed mach-o file */
	97	#define LOAD_SHLIB 3 /* shlib version mismatch */
	98	#define LOAD_FAILURE 4 /* Miscellaneous error */
	99	#define LOAD_NOSPACE 5 /* No VM available */
	100	#define LOAD_PROTECT 6 /* protection violation */
	101	#define LOAD_RESOURCE 7 /* resource allocation failure */
55e303ae A	102	#define LOAD_ENOENT 8 /* resource not found */
55e303ae A	103	#define LOAD_IOERROR 9 /* IO error */
fe8ab488	104	#define LOAD_DECRYPTFAIL 10 /* FP decrypt failure */
39037602	105	#define LOAD_BADMACHO_UPX 11 /* malformed mach-o file */
1c79356b A	106
1c79356b A	107	#endif /* _BSD_KERN_MACH_LOADER_H_ */