xref: /xnu-11417.140.69/osfmk/arm64/bti_telemetry.h (revision 43a90889846e00bfb5cf1d255cdc0a701a1e05a4)
1 /*
2  * Copyright (c) 2022 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 _BTI_TELEMETRY_H_
30 #define _BTI_TELEMETRY_H_
31 #ifdef CONFIG_BTI_TELEMETRY
32 #include <mach/exception.h>
33 #include <mach/vm_types.h>
34 #include <mach/machine/thread_status.h>
35 
36 /**
37  * Wakes up the BTI exception telemetry subsystem. Call once per boot.
38  */
39 void
40 bti_telemetry_init(void);
41 
42 /**
43  *  Handle a BTI exception. Returns TRUE if handled and OK to return from the
44  *  exception, false otherwise.
45  */
46 bool
47 bti_telemetry_handle_exception(arm_saved_state_t *state);
48 
49 #endif /* CONFIG_BTI_TELEMETRY */
50 #endif /* _BTI_TELEMETRY_H_ */
51