]> git.saurik.com Git - apple/xnu.git/blob - bsd/kern/mach_loader.h
xnu-1228.7.58.tar.gz
[apple/xnu.git] / bsd / kern / mach_loader.h
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 user_addr_t user_stack;
56 int thread_count;
57 unsigned int
58 /* boolean_t */ unixproc :1,
59 dynlinker :1,
60 customstack :1,
61 :0;
62 unsigned int csflags;
63 } load_result_t;
64
65 struct image_params;
66 load_return_t load_machfile(
67 struct image_params *imgp,
68 struct mach_header *header,
69 thread_t thread,
70 vm_map_t map,
71 load_result_t *result);
72
73 #define LOAD_SUCCESS 0
74 #define LOAD_BADARCH 1 /* CPU type/subtype not found */
75 #define LOAD_BADMACHO 2 /* malformed mach-o file */
76 #define LOAD_SHLIB 3 /* shlib version mismatch */
77 #define LOAD_FAILURE 4 /* Miscellaneous error */
78 #define LOAD_NOSPACE 5 /* No VM available */
79 #define LOAD_PROTECT 6 /* protection violation */
80 #define LOAD_RESOURCE 7 /* resource allocation failure */
81 #define LOAD_ENOENT 8 /* resource not found */
82 #define LOAD_IOERROR 9 /* IO error */
83
84 #endif /* _BSD_KERN_MACH_LOADER_H_ */