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 typedef unsigned long long malloc_type_id_t; 51 52 #if __PTRAUTH_INTRINSICS__ && __has_builtin(__builtin_ptrauth_string_discriminator) 53 #define LIBKERNEL_FUNCTION_PTRAUTH(f) \ 54 __ptrauth(ptrauth_key_function_pointer,1, \ 55 __builtin_ptrauth_string_discriminator("libkernel_functions_" # f) \ 56 ) f 57 #else 58 #define LIBKERNEL_FUNCTION_PTRAUTH(f) f 59 #endif 60 61 typedef const struct _libkernel_functions { 62 /* The following functions are included in version 1 of this structure */ 63 unsigned long version; 64 void* (*LIBKERNEL_FUNCTION_PTRAUTH(dlsym))(void*, const char*); 65 void* (*LIBKERNEL_FUNCTION_PTRAUTH(malloc))(size_t); 66 void(*LIBKERNEL_FUNCTION_PTRAUTH(free))(void*); 67 void* (*LIBKERNEL_FUNCTION_PTRAUTH(realloc))(void*, size_t); 68 void(*LIBKERNEL_FUNCTION_PTRAUTH(_pthread_exit_if_canceled))(int); 69 70 /* The following functions are included in version 2 of this structure */ 71 void *reserved1; 72 void *reserved2; 73 void *reserved3; 74 void *reserved4; 75 void *reserved5; 76 77 /* The following functions are included in version 3 of this structure */ 78 void(*LIBKERNEL_FUNCTION_PTRAUTH(pthread_clear_qos_tsd))(mach_port_t); 79 80 /* The following functions are included in version 4 of this structure */ 81 int(*LIBKERNEL_FUNCTION_PTRAUTH(pthread_current_stack_contains_np))(const void *, size_t); 82 83 /* The following functions are included in version 5 of this structure */ 84 void* (*LIBKERNEL_FUNCTION_PTRAUTH(malloc_type_malloc))(size_t, malloc_type_id_t); 85 void(*LIBKERNEL_FUNCTION_PTRAUTH(malloc_type_free))(void *, malloc_type_id_t); 86 void* (*LIBKERNEL_FUNCTION_PTRAUTH(malloc_type_realloc))(void *, size_t, malloc_type_id_t); 87 88 /* Subsequent versions must only add pointers! */ 89 } *_libkernel_functions_t; 90 91 typedef const struct _libkernel_string_functions { 92 /* The following functions are included in version 1 of this structure */ 93 unsigned long version; 94 void (*bzero)(void *s, size_t n); 95 void * (*memchr)(const void *s, int c, size_t n); 96 int (*memcmp)(const void *s1, const void *s2, size_t n); 97 void * (*memmove)(void *dst, const void *src, size_t n); 98 void * (*memccpy)(void *__restrict dst, const void *__restrict src, int c, size_t n); 99 void * (*memset)(void *b, int c, size_t len); 100 char * (*strchr)(const char *s, int c); 101 int (*strcmp)(const char *s1, const char *s2); 102 char * (*strcpy)(char * restrict dst, const char * restrict src); 103 size_t (*strlcat)(char * restrict dst, const char * restrict src, size_t maxlen); 104 size_t (*strlcpy)(char * restrict dst, const char * restrict src, size_t maxlen); 105 size_t (*strlen)(const char *str); 106 int (*strncmp)(const char *s1, const char *s2, size_t n); 107 char * (*strncpy)(char * restrict dst, const char * restrict src, size_t maxlen); 108 size_t (*strnlen)(const char *s, size_t maxlen); 109 char * (*strstr)(const char *s, const char *find); 110 /* Subsequent versions must only add pointers! */ 111 } *_libkernel_string_functions_t; 112 113 typedef const struct _libkernel_voucher_functions { 114 /* The following functions are included in version 1 of this structure */ 115 unsigned long version; 116 boolean_t (*voucher_mach_msg_set)(mach_msg_header_t*); 117 void (*voucher_mach_msg_clear)(mach_msg_header_t*); 118 voucher_mach_msg_state_t (*voucher_mach_msg_adopt)(mach_msg_header_t*); 119 void (*voucher_mach_msg_revert)(voucher_mach_msg_state_t); 120 121 /* version 2 is skipped */ 122 123 /* The following functions are included in version 3 of this structure */ 124 mach_msg_size_t (*voucher_mach_msg_fill_aux)(mach_msg_aux_header_t*, mach_msg_size_t); 125 126 /* Subsequent versions must only add pointers! */ 127 } *_libkernel_voucher_functions_t; 128 129 typedef struct _libkernel_late_init_config { 130 unsigned long version; 131 132 /* Version 1 fields */ 133 bool enable_system_version_compat; 134 135 /* Version 2 fields */ 136 bool enable_ios_version_compat; 137 138 /* Version 3 fields */ 139 bool enable_posix_spawn_filtering; 140 } *_libkernel_late_init_config_t; 141 142 struct ProgramVars; /* forward reference */ 143 144 void __libkernel_init(_libkernel_functions_t fns, const char *envp[], 145 const char *apple[], const struct ProgramVars *vars); 146 147 kern_return_t __libkernel_platform_init(_libkernel_string_functions_t fns); 148 149 kern_return_t __libkernel_voucher_init(_libkernel_voucher_functions_t fns); 150 151 void __libkernel_init_late(_libkernel_late_init_config_t config); 152 153 typedef struct _libkernel_init_after_boot_tasks_config { 154 unsigned long version; 155 156 /* Version 1 fields */ 157 bool enable_posix_spawn_filtering; 158 } *_libkernel_init_after_boot_tasks_config_t; 159 160 void __libkernel_init_after_boot_tasks( 161 _libkernel_init_after_boot_tasks_config_t config); 162 163 #endif // __LIBKERNEL_INIT_H 164