1 /* 2 * Copyright (c) 2019 Apple Computer, 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 EXC_HELPERS_H 30 #define EXC_HELPERS_H 31 32 #include <mach/mach.h> 33 #include <mach/exception.h> 34 #include <stdbool.h> 35 #include <mach/thread_status.h> 36 37 /** 38 * Callback invoked by run_exception_handler() when a Mach exception is 39 * received. 40 * 41 * @param task the task causing the exception 42 * @param thread the task causing the exception 43 * @param type exception type received from the kernel 44 * @param codes exception codes received from the kernel 45 * 46 * @return how much the exception handler should advance the program 47 * counter, in bytes (in order to move past the code causing the 48 * exception) 49 */ 50 typedef size_t (*exc_handler_callback_t)(mach_port_t task, mach_port_t thread, 51 exception_type_t type, mach_exception_data_t codes); 52 53 typedef size_t (*exc_handler_protected_callback_t)(task_id_token_t token, uint64_t thread_d, 54 exception_type_t type, mach_exception_data_t codes); 55 56 typedef size_t (*exc_handler_state_protected_callback_t)(task_id_token_t token, uint64_t thread_d, 57 exception_type_t type, mach_exception_data_t codes, thread_state_t in_state, 58 mach_msg_type_number_t in_state_count, thread_state_t out_state, mach_msg_type_number_t *out_state_count); 59 60 typedef kern_return_t (*exc_handler_backtrace_callback_t)(kcdata_object_t kcdata_object, 61 exception_type_t type, mach_exception_data_t codes); 62 63 /** 64 * Allocates a Mach port and configures it to receive exception messages. 65 * 66 * @param exception_mask exception types that this Mach port should receive 67 * 68 * @return a newly-allocated and -configured Mach port 69 */ 70 mach_port_t 71 create_exception_port(exception_mask_t exception_mask); 72 73 mach_port_t 74 create_exception_port_behavior64(exception_mask_t exception_mask, exception_behavior_t behavior); 75 76 /** 77 * Handles one exception received on the provided Mach port, by running the 78 * provided callback. 79 * 80 * @param exc_port Mach port configured to receive exception messages 81 * @param callback callback to run when an exception is received 82 */ 83 void 84 run_exception_handler(mach_port_t exc_port, exc_handler_callback_t callback); 85 86 void 87 run_exception_handler_behavior64(mach_port_t exc_port, void *preferred_callback, void *callback, 88 exception_behavior_t behavior, bool run_once); 89 90 /** 91 * Handles every exception received on the provided Mach port, by running the 92 * provided callback. 93 * 94 * @param exc_port Mach port configured to receive exception messages 95 * @param callback callback to run when an exception is received 96 */ 97 void 98 repeat_exception_handler(mach_port_t exc_port, exc_handler_callback_t callback); 99 100 #endif /* EXC_HELPERS_H */ 101