xref: /xnu-8792.41.9/libsyscall/wrappers/_libkernel_init.h (revision 5c2921b07a2480ab43ec66f5b9e41cb872bc554f)
1 /*
2  * Copyright (c) 2010-2014 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 #ifndef __LIBKERNEL_INIT_H
30 #define __LIBKERNEL_INIT_H
31 
32 #include <stdbool.h>
33 #include <sys/types.h>
34 #include <mach/mach.h>
35 #include <mach/message.h>
36 #include <mach/mach_types.h>
37 
38 #ifndef __OS_VOUCHER_PRIVATE__
39 // We cannot include the actual os/voucher_private.h definition of voucher_t
40 // here, as that also marks the voucher_XXX functions as exported, which causes
41 // a compile error when we attempt to mark them hidden in the .c file.
42 //
43 // The Libsystem init.c file does include os/voucher_private.h though, as well
44 // as this file, and this typedef causes an error if it is unguarded.
45 struct voucher_s;
46 typedef struct voucher_s *voucher_t;
47 #endif
48 
49 typedef const struct _libkernel_functions {
50 	/* The following functions are included in version 1 of this structure */
51 	unsigned long version;
52 	void* (*dlsym)(void*, const char*);
53 	void* (*malloc)(size_t);
54 	void  (*free)(void*);
55 	void* (*realloc)(void*, size_t);
56 	void  (*_pthread_exit_if_canceled)(int);
57 
58 	/* The following functions are included in version 2 of this structure */
59 	void *reserved1;
60 	void *reserved2;
61 	void *reserved3;
62 	void *reserved4;
63 	void *reserved5;
64 
65 	/* The following functions are included in version 3 of this structure */
66 	void (*pthread_clear_qos_tsd)(mach_port_t);
67 
68 	/* The following functions are included in version 4 of this structure */
69 	int (*pthread_current_stack_contains_np)(const void *, size_t);
70 
71 	/* Subsequent versions must only add pointers! */
72 } *_libkernel_functions_t;
73 
74 typedef const struct _libkernel_string_functions {
75 	/* The following functions are included in version 1 of this structure */
76 	unsigned long version;
77 	void (*bzero)(void *s, size_t n);
78 	void * (*memchr)(const void *s, int c, size_t n);
79 	int (*memcmp)(const void *s1, const void *s2, size_t n);
80 	void * (*memmove)(void *dst, const void *src, size_t n);
81 	void * (*memccpy)(void *__restrict dst, const void *__restrict src, int c, size_t n);
82 	void * (*memset)(void *b, int c, size_t len);
83 	char * (*strchr)(const char *s, int c);
84 	int (*strcmp)(const char *s1, const char *s2);
85 	char * (*strcpy)(char * restrict dst, const char * restrict src);
86 	size_t (*strlcat)(char * restrict dst, const char * restrict src, size_t maxlen);
87 	size_t (*strlcpy)(char * restrict dst, const char * restrict src, size_t maxlen);
88 	size_t (*strlen)(const char *str);
89 	int (*strncmp)(const char *s1, const char *s2, size_t n);
90 	char * (*strncpy)(char * restrict dst, const char * restrict src, size_t maxlen);
91 	size_t (*strnlen)(const char *s, size_t maxlen);
92 	char * (*strstr)(const char *s, const char *find);
93 	/* Subsequent versions must only add pointers! */
94 } *_libkernel_string_functions_t;
95 
96 typedef const struct _libkernel_voucher_functions {
97 	/* The following functions are included in version 1 of this structure */
98 	unsigned long version;
99 	boolean_t (*voucher_mach_msg_set)(mach_msg_header_t*);
100 	void (*voucher_mach_msg_clear)(mach_msg_header_t*);
101 	voucher_mach_msg_state_t (*voucher_mach_msg_adopt)(mach_msg_header_t*);
102 	void (*voucher_mach_msg_revert)(voucher_mach_msg_state_t);
103 
104 	/* version 2 is skipped */
105 
106 	/* The following functions are included in version 3 of this structure */
107 	mach_msg_size_t (*voucher_mach_msg_fill_aux)(mach_msg_aux_header_t*, mach_msg_size_t);
108 
109 	/* Subsequent versions must only add pointers! */
110 } *_libkernel_voucher_functions_t;
111 
112 typedef struct _libkernel_late_init_config {
113 	unsigned long version;
114 
115 	/* Version 1 fields */
116 	bool enable_system_version_compat;
117 
118 	/* Version 2 fields */
119 	bool enable_ios_version_compat;
120 
121 	/* Version 3 fields */
122 	bool enable_posix_spawn_filtering;
123 } *_libkernel_late_init_config_t;
124 
125 struct ProgramVars; /* forward reference */
126 
127 void __libkernel_init(_libkernel_functions_t fns, const char *envp[],
128     const char *apple[], const struct ProgramVars *vars);
129 
130 kern_return_t __libkernel_platform_init(_libkernel_string_functions_t fns);
131 
132 kern_return_t __libkernel_voucher_init(_libkernel_voucher_functions_t fns);
133 
134 void __libkernel_init_late(_libkernel_late_init_config_t config);
135 
136 typedef struct _libkernel_init_after_boot_tasks_config {
137 	unsigned long version;
138 
139 	/* Version 1 fields */
140 	bool enable_posix_spawn_filtering;
141 } *_libkernel_init_after_boot_tasks_config_t;
142 
143 void __libkernel_init_after_boot_tasks(
144 	_libkernel_init_after_boot_tasks_config_t config);
145 
146 #endif // __LIBKERNEL_INIT_H
147