xref: /xnu-8792.81.2/san/coverage/kcov.h (revision 19c3b8c28c31cb8130e034cfb5df6bf9ba342d90)
1 /*
2  * Copyright (c) 2021 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 _KCOV_H_
30 #define _KCOV_H_
31 
32 #if KERNEL_PRIVATE
33 
34 #if !CONFIG_KCOV && __has_feature(coverage_sanitizer)
35 # error "Coverage sanitizer enabled in compiler, but kernel is not configured for KCOV"
36 #endif
37 
38 #if CONFIG_KCOV
39 
40 /* Forward declaration for types used in interfaces below. */
41 typedef struct kcov_cpu_data kcov_cpu_data_t;
42 typedef struct kcov_thread_data kcov_thread_data_t;
43 
44 
45 __BEGIN_DECLS
46 
47 /* osfmk exported */
48 kcov_cpu_data_t *current_kcov_data(void);
49 kcov_cpu_data_t *cpu_kcov_data(int);
50 
51 /* Init code */
52 void kcov_init_thread(kcov_thread_data_t *);
53 void kcov_start_cpu(int cpuid);
54 
55 /* helpers */
56 void kcov_panic_disable(void);
57 
58 /* per-thread */
59 struct kcov_thread_data *kcov_get_thread_data(thread_t);
60 
61 void kcov_enable(void);
62 void kcov_disable(void);
63 
64 /*
65  * SanitizerCoverage ABI
66  */
67 void __sanitizer_cov_pcs_init(uintptr_t *start, uintptr_t *stop);
68 void __sanitizer_cov_trace_pc_guard(uint32_t *guard);
69 void __sanitizer_cov_trace_pc_guard_init(uint32_t *start, uint32_t *stop);
70 void __sanitizer_cov_trace_pc_indirect(void *callee);
71 void __sanitizer_cov_trace_pc(void);
72 
73 __END_DECLS
74 
75 #endif /* CONFIG_KCOV */
76 
77 #endif /* KERNEL_PRIVATE */
78 
79 #endif /* _KCOV_H_ */
80