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