1 /* 2 * Copyright (c) 2019 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 _REASON_H_ 30 #define _REASON_H_ 31 32 #include <stdint.h> 33 34 __BEGIN_DECLS 35 36 #ifdef KERNEL_PRIVATE 37 38 #include <kern/kern_cdata.h> 39 40 #ifdef XNU_KERNEL_PRIVATE 41 #include <os/refcnt.h> 42 #include <kern/locks.h> 43 44 typedef struct os_reason { 45 decl_lck_mtx_data(, osr_lock); 46 os_refcnt_t osr_refcount; 47 uint32_t osr_namespace; 48 uint64_t osr_code; 49 uint64_t osr_flags; 50 uint32_t osr_bufsize; 51 struct kcdata_descriptor osr_kcd_descriptor; 52 char *osr_kcd_buf; 53 } *os_reason_t; 54 55 #define OS_REASON_NULL ((os_reason_t) NULL) 56 57 /* We only include 800 bytes of the exit reason description to not blow through the panic buffer */ 58 #define LAUNCHD_PANIC_REASON_STRING_MAXLEN "800" 59 60 void os_reason_init(void); 61 62 os_reason_t build_userspace_exit_reason(uint32_t reason_namespace, uint64_t reason_code, user_addr_t payload, uint32_t payload_size, 63 user_addr_t reason_string, uint64_t reason_flags); 64 char *exit_reason_get_string_desc(os_reason_t exit_reason); 65 66 /* The blocking allocation is currently not exported to KEXTs */ 67 int os_reason_alloc_buffer(os_reason_t cur_reason, uint32_t osr_bufsize); 68 69 typedef struct _exception_info { 70 int os_reason; 71 int signal; 72 exception_type_t exception_type; 73 mach_exception_data_type_t mx_code; 74 mach_exception_data_type_t mx_subcode; 75 struct kt_info { 76 int kt_subsys; 77 uint32_t kt_error; 78 } kt_info; 79 } exception_info_t; 80 81 #define PX_FLAGS_NONE 0 82 /* think twice about userspace debugging experience before using PX_DEBUG_NO_HONOR */ 83 #define PX_DEBUG_NO_HONOR (1 << 0) /* force exit even when debugging */ 84 #define PX_KTRIAGE (1 << 1) /* leave a ktriage record */ 85 #define PX_PSIGNAL (1 << 2) /* send sig instead of forced exit */ 86 #define PX_NO_EXCEPTION_UTHREAD (1 << 3) /* do not set bsdthread exception */ 87 88 int exit_with_mach_exception(struct proc *p, exception_info_t exception, uint32_t flags); 89 #if CONFIG_EXCLAVES 90 int exit_with_exclave_exception(struct proc *p, exception_info_t exception, uint32_t flags); 91 #endif 92 void exit_with_mach_exception_using_ast(exception_info_t exception, uint32_t flags, bool fatal); 93 94 #else /* XNU_KERNEL_PRIVATE */ 95 96 typedef void * os_reason_t; 97 98 #endif /* XNU_KERNEL_PRIVATE */ 99 100 os_reason_t os_reason_create(uint32_t osr_namespace, uint64_t osr_code); 101 int os_reason_alloc_buffer_noblock(os_reason_t cur_reason, uint32_t osr_bufsize); 102 struct kcdata_descriptor * os_reason_get_kcdata_descriptor(os_reason_t cur_reason); 103 void os_reason_ref(os_reason_t cur_reason); 104 void os_reason_free(os_reason_t cur_reason); 105 void os_reason_set_flags(os_reason_t cur_reason, uint64_t flags); 106 void os_reason_set_description_data(os_reason_t cur_reason, uint32_t type, void *reason_data, uint32_t reason_data_len); 107 #endif /* KERNEL_PRIVATE */ 108 109 /* 110 * Reason namespaces. 111 */ 112 #define OS_REASON_INVALID 0 113 #define OS_REASON_JETSAM 1 114 #define OS_REASON_SIGNAL 2 115 #define OS_REASON_CODESIGNING 3 116 #define OS_REASON_HANGTRACER 4 117 #define OS_REASON_TEST 5 118 #define OS_REASON_DYLD 6 119 #define OS_REASON_LIBXPC 7 120 #define OS_REASON_OBJC 8 121 #define OS_REASON_EXEC 9 122 #define OS_REASON_SPRINGBOARD 10 123 #define OS_REASON_TCC 11 124 #define OS_REASON_REPORTCRASH 12 125 #define OS_REASON_COREANIMATION 13 126 #define OS_REASON_AGGREGATED 14 127 #define OS_REASON_RUNNINGBOARD 15 128 #define OS_REASON_ASSERTIOND OS_REASON_RUNNINGBOARD /* old name */ 129 #define OS_REASON_SKYWALK 16 130 #define OS_REASON_SETTINGS 17 131 #define OS_REASON_LIBSYSTEM 18 132 #define OS_REASON_FOUNDATION 19 133 #define OS_REASON_WATCHDOG 20 134 #define OS_REASON_METAL 21 135 #define OS_REASON_WATCHKIT 22 136 #define OS_REASON_GUARD 23 137 #define OS_REASON_ANALYTICS 24 138 #define OS_REASON_SANDBOX 25 139 #define OS_REASON_SECURITY 26 140 #define OS_REASON_ENDPOINTSECURITY 27 141 #define OS_REASON_PAC_EXCEPTION 28 142 #define OS_REASON_BLUETOOTH_CHIP 29 143 #define OS_REASON_PORT_SPACE 30 144 #define OS_REASON_WEBKIT 31 145 #define OS_REASON_BACKLIGHTSERVICES 32 146 #define OS_REASON_MEDIA 33 147 #define OS_REASON_ROSETTA 34 148 #define OS_REASON_LIBIGNITION 35 149 #define OS_REASON_BOOTMOUNT 36 150 151 152 #define OS_REASON_REALITYKIT 38 153 #define OS_REASON_AUDIO 39 154 #define OS_REASON_WAKEBOARD 40 155 #define OS_REASON_CORERC 41 156 #define OS_REASON_SELF_RESTRICT 42 157 #define OS_REASON_ARKIT 43 158 #define OS_REASON_CAMERA 44 159 #define OS_REASON_BACKBOARD 45 160 #define OS_REASON_POWEREXCEPTIONS 46 161 #define OS_REASON_SECINIT 47 162 163 /* 164 * Update whenever new OS_REASON namespaces are added. 165 */ 166 #define OS_REASON_MAX_VALID_NAMESPACE OS_REASON_SECINIT 167 168 #define OS_REASON_BUFFER_MAX_SIZE 5120 169 170 #define OS_REASON_FLAG_NO_CRASH_REPORT 0x1 /* Don't create a crash report */ 171 #define OS_REASON_FLAG_GENERATE_CRASH_REPORT 0x2 /* Create a crash report - the default for userspace requests */ 172 #define OS_REASON_FLAG_FROM_USERSPACE 0x4 /* Reason created from a userspace syscall */ 173 #define OS_REASON_FLAG_FAILED_DATA_COPYIN 0x8 /* We failed to copyin data from userspace */ 174 #define OS_REASON_FLAG_PAYLOAD_TRUNCATED 0x10 /* The payload was truncated because it was longer than allowed */ 175 #define OS_REASON_FLAG_BAD_PARAMS 0x20 /* Invalid parameters were passed involved with creating this reason */ 176 #define OS_REASON_FLAG_CONSISTENT_FAILURE 0x40 /* Whatever caused this reason to be created will happen again */ 177 #define OS_REASON_FLAG_ONE_TIME_FAILURE 0x80 /* Whatever caused this reason to be created was a one time issue */ 178 #define OS_REASON_FLAG_NO_CRASHED_TID 0x100 /* Don't include the TID that processed the exit in the crash report */ 179 #define OS_REASON_FLAG_ABORT 0x200 /* Reason created from abort_* rather than terminate_* */ 180 #define OS_REASON_FLAG_SHAREDREGION_FAULT 0x400 /* Fault happened within the shared cache region */ 181 #define OS_REASON_FLAG_CAPTURE_LOGS 0x800 /* The report generated for this reason should capture logs */ 182 #define OS_REASON_FLAG_SECURITY_SENSITIVE 0x1000 /* Mark as security sensitive for priority treatment */ 183 184 /* 185 * Set of flags that are allowed to be passed from userspace 186 */ 187 #define OS_REASON_FLAG_MASK_ALLOWED_FROM_USER (OS_REASON_FLAG_CONSISTENT_FAILURE | OS_REASON_FLAG_ONE_TIME_FAILURE | OS_REASON_FLAG_NO_CRASH_REPORT | OS_REASON_FLAG_ABORT | OS_REASON_FLAG_CAPTURE_LOGS | OS_REASON_FLAG_SECURITY_SENSITIVE) 188 189 /* 190 * Macros to encode the exit reason namespace and first 32 bits of code in exception code 191 * which is used by Report Crash as a hint. It should be only used as a hint since it 192 * loses higher 32 bits of exit reason code. 193 */ 194 #define ENCODE_OSR_NAMESPACE_TO_MACH_EXCEPTION_CODE(code, osr_namespace) \ 195 (code) = (code) | (((osr_namespace) & ((uint64_t)UINT32_MAX)) << 32) 196 #define ENCODE_OSR_CODE_TO_MACH_EXCEPTION_CODE(code, osr_code) \ 197 (code) = (code) | ((osr_code) & ((uint64_t)UINT32_MAX)) 198 199 #ifndef KERNEL 200 /* 201 * abort_with_reason: Used to exit the current process and pass along 202 * specific information about why it is being terminated. 203 * 204 * Inputs: args->reason_namespace - OS_REASON namespace specified for the reason 205 * args->reason_code - code in the specified namespace for the reason 206 * args->reason_string - additional string formatted information about the request 207 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above). 208 * 209 * Outputs: Does not return. 210 */ 211 void abort_with_reason(uint32_t reason_namespace, uint64_t reason_code, const char *reason_string, uint64_t reason_flags) 212 __attribute__((noreturn, cold)); 213 214 /* 215 * abort_with_payload: Used to exit the current process and pass along 216 * specific information about why it is being terminated. The payload pointer 217 * should point to structured data that can be interpreted by the consumer of 218 * exit reason information. 219 * 220 * Inputs: args->reason_namespace - OS_REASON namespace specified for the reason 221 * args->reason_code - code in the specified namespace for the reason 222 * args->payload - pointer to payload structure in user space 223 * args->payload_size - length of payload buffer (this will be truncated to EXIT_REASON_PAYLOAD_MAX_LEN) 224 * args->reason_string - additional string formatted information about the request 225 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above). 226 * 227 * Outputs: Does not return. 228 */ 229 void abort_with_payload(uint32_t reason_namespace, uint64_t reason_code, void *payload, uint32_t payload_size, const char *reason_string, 230 uint64_t reason_flags) __attribute__((noreturn, cold)); 231 232 /* 233 * terminate_with_reason: Used to terminate a specific process and pass along 234 * specific information about why it is being terminated. 235 * 236 * Inputs: args->pid - the PID of the process to be terminated 237 * args->reason_namespace - OS_REASON namespace specified for the reason 238 * args->reason_code - code in the specified namespace for the reason 239 * args->reason_string - additional string formatted information about the request 240 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above) 241 * 242 * Outputs: returns -1 and sets errno to EINVAL if the PID requested is the same as that of the calling process, invalid or the namespace provided is invalid. 243 * returns -1 and sets errno to ESRCH if we couldn't find a live process with the requested PID 244 * returns -1 and sets errno to EPERM if the caller is not privileged enough to kill the process with the requested PID 245 * returns 0 otherwise 246 */ 247 int terminate_with_reason(int pid, uint32_t reason_namespace, uint64_t reason_code, const char *reason_string, uint64_t reason_flags); 248 249 /* 250 * terminate_with_payload: Used to terminate a specific process and pass along 251 * specific information about why it is being terminated. The payload pointer 252 * should point to structured data that can be interpreted by the consumer of 253 * exit reason information. 254 * 255 * Inputs: args->pid - the PID of the process to be terminated. 256 * args->reason_namespace - OS_REASON namespace specified for the reason 257 * args->reason_code - code in the specified namespace for the reason 258 * args->payload - pointer to payload structure in user space 259 * args->payload_size - length of payload buffer (this will be truncated to EXIT_REASON_PAYLOAD_MAX_LEN) 260 * args->reason_string - additional string formatted information about the request 261 * args->reason_flags - options requested for how the process should be terminated (see OS_REASON_FLAG_* above) 262 * 263 * Outputs: returns -1 and sets errno to EINVAL if the PID requested is the same as that of the calling process, is invalid or the namespace provided is invalid. 264 * returns -1 and sets errno to ESRCH if we couldn't find a live process with the requested PID 265 * returns -1 and sets errno to EPERM if the caller is not privileged enough to kill the process with the requested PID 266 * returns 0 otherwise 267 */ 268 int terminate_with_payload(int pid, uint32_t reason_namespace, uint64_t reason_code, void *payload, uint32_t payload_size, 269 const char *reason_string, uint64_t reason_flags); 270 #endif /* KERNEL */ 271 272 /* 273 * codesigning exit reasons 274 */ 275 #define CODESIGNING_EXIT_REASON_TASKGATED_INVALID_SIG 1 276 #define CODESIGNING_EXIT_REASON_INVALID_PAGE 2 277 #define CODESIGNING_EXIT_REASON_TASK_ACCESS_PORT 3 278 #define CODESIGNING_EXIT_REASON_LAUNCH_CONSTRAINT_VIOLATION 4 279 /* 280 * exec path specific exit reasons 281 */ 282 #define EXEC_EXIT_REASON_BAD_MACHO 1 283 #define EXEC_EXIT_REASON_SUGID_FAILURE 2 284 #define EXEC_EXIT_REASON_ACTV_THREADSTATE 3 285 #define EXEC_EXIT_REASON_STACK_ALLOC 4 286 #define EXEC_EXIT_REASON_APPLE_STRING_INIT 5 287 #define EXEC_EXIT_REASON_COPYOUT_STRINGS 6 288 #define EXEC_EXIT_REASON_COPYOUT_DYNLINKER 7 289 #define EXEC_EXIT_REASON_SECURITY_POLICY 8 290 #define EXEC_EXIT_REASON_TASKGATED_OTHER 9 291 #define EXEC_EXIT_REASON_FAIRPLAY_DECRYPT 10 292 #define EXEC_EXIT_REASON_DECRYPT 11 293 #define EXEC_EXIT_REASON_UPX 12 294 #define EXEC_EXIT_REASON_NO32EXEC 13 295 #define EXEC_EXIT_REASON_WRONG_PLATFORM 14 296 #define EXEC_EXIT_REASON_MAIN_FD_ALLOC 15 297 #define EXEC_EXIT_REASON_COPYOUT_ROSETTA 16 298 #define EXEC_EXIT_REASON_SET_DYLD_INFO 17 299 #define EXEC_EXIT_REASON_MACHINE_THREAD 18 300 #define EXEC_EXIT_REASON_BAD_PSATTR 19 301 #define EXEC_EXIT_REASON_NOX86EXEC 20 302 #define EXEC_EXIT_REASON_MAP_EXEC_FAILURE 21 303 /* 304 * guard reasons 305 */ 306 #define GUARD_REASON_VNODE 1 307 #define GUARD_REASON_VIRT_MEMORY 2 308 #define GUARD_REASON_MACH_PORT 3 309 #define GUARD_REASON_EXCLAVES 4 310 #define GUARD_REASON_JIT 5 311 312 __END_DECLS 313 314 #endif /* _REASON_H_ */ 315