xref: /xnu-11417.140.69/osfmk/kern/exception.h (revision 43a90889846e00bfb5cf1d255cdc0a701a1e05a4)
1 /*
2  * Copyright (c) 2000-2004 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  * @OSF_COPYRIGHT@
30  */
31 
32 #ifndef _KERN_EXCEPTION_H_
33 #define _KERN_EXCEPTION_H_
34 
35 #include <mach/mach_types.h>
36 #include <mach/thread_status.h>
37 #include <mach/exception_types.h>
38 #include <kern/kern_types.h>
39 #include <security/_label.h>
40 
41 /*
42  * Common storage for exception actions.
43  * There are arrays of these maintained at the activation, task, and host.
44  */
45 struct exception_action {
46 	struct ipc_port         * XNU_PTRAUTH_SIGNED_PTR("exception_action.port") port; /* exception port */
47 	thread_state_flavor_t   flavor;         /* state flavor to send */
48 	exception_behavior_t    behavior;       /* exception type to raise */
49 	boolean_t               privileged;     /* survives ipc_task_reset */
50 	boolean_t               hardened;       /* associated with the task's hardened_exception_action */
51 	struct label            *label;         /* MAC label associated with action */
52 };
53 struct hardened_exception_action {
54 	struct exception_action ea;
55 	uint32_t                signed_pc_key;
56 	exception_mask_t        exception;
57 };
58 
59 /* Initialize global state needed for exceptions. */
60 extern void exception_init(void);
61 
62 extern ipc_port_t exception_port_copy_send(ipc_port_t port);
63 
64 /* Make an up-call to a thread's exception server */
65 extern kern_return_t exception_triage(
66 	exception_type_t        exception,
67 	mach_exception_data_t   code,
68 	mach_msg_type_number_t  codeCnt);
69 
70 extern kern_return_t exception_triage_thread(
71 	exception_type_t        exception,
72 	mach_exception_data_t   code,
73 	mach_msg_type_number_t  codeCnt,
74 	thread_t                thread);
75 
76 #define BT_EXC_PORTS_COUNT 3
77 extern void exception_deliver_backtrace(
78 	kcdata_object_t bt_object,
79 	ipc_port_t      exc_ports[static BT_EXC_PORTS_COUNT],
80 	exception_type_t exception);
81 
82 /* Notify system performance monitor */
83 extern kern_return_t sys_perf_notify(thread_t thread, int pid);
84 
85 /* Notify crash reporter */
86 extern kern_return_t task_exception_notify(exception_type_t exception,
87     mach_exception_data_type_t code, mach_exception_data_type_t subcode, const bool fatal);
88 
89 #endif  /* _KERN_EXCEPTION_H_ */
90