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 __has_feature(coverage_sanitizer) && !(CONFIG_KCOV || defined(__BUILDING_XNU_LIBRARY__)) 35 # error "Coverage sanitizer enabled in compiler, but kernel is not configured for KCOV" 36 #endif 37 38 #if CONFIG_KCOV 39 40 #include <mach/mach_types.h> 41 42 /* Comparison type values */ 43 enum { 44 KCOV_CMP_CONST = 1, 45 KCOV_CMP_SIZE1 = 0, 46 KCOV_CMP_SIZE2 = 2, 47 KCOV_CMP_SIZE4 = 4, 48 KCOV_CMP_SIZE8 = 6, 49 50 KCOV_CMP_FUNC_MEMCMP = 32, 51 KCOV_CMP_FUNC_STRCMP = 34, 52 KCOV_CMP_FUNC_STRNCMP = 36, 53 KCOV_CMP_FUNC_STRBUFCMP = 38, 54 }; 55 56 #define KCOV_CMP_IS_FUNC(type) (type >= KCOV_CMP_FUNC_MEMCMP) 57 58 /* Forward declaration for types used in interfaces below. */ 59 typedef struct kcov_cpu_data kcov_cpu_data_t; 60 typedef struct kcov_thread_data kcov_thread_data_t; 61 62 63 __BEGIN_DECLS 64 65 /* osfmk exported */ 66 kcov_cpu_data_t *current_kcov_data(void); 67 kcov_cpu_data_t *cpu_kcov_data(int); 68 69 /* Init code */ 70 void kcov_init_thread(kcov_thread_data_t *); 71 void kcov_start_cpu(int cpuid); 72 73 /* helpers */ 74 void kcov_panic_disable(void); 75 76 /* per-thread */ 77 struct kcov_thread_data *kcov_get_thread_data(thread_t thread); 78 79 void kcov_enable(void); 80 void kcov_disable(void); 81 82 /* Comparison function tracing */ 83 void kcov_trace_cmp_func(void *caller_pc, uint32_t type, const void *s1, size_t s1len, const void *s2, size_t s2len, bool always_log); 84 85 /* 86 * SanitizerCoverage ABI 87 */ 88 void __sanitizer_cov_pcs_init(uintptr_t *start, uintptr_t *stop); 89 void __sanitizer_cov_trace_pc_guard(uint32_t *guard); 90 void __sanitizer_cov_trace_pc_guard_init(uint32_t *start, uint32_t *stop); 91 void __sanitizer_cov_trace_pc_indirect(void *callee); 92 void __sanitizer_cov_trace_pc(void); 93 void __sanitizer_cov_trace_cmp1(uint8_t arg1, uint8_t arg2); 94 void __sanitizer_cov_trace_cmp2(uint16_t arg1, uint16_t arg2); 95 void __sanitizer_cov_trace_cmp4(uint32_t arg1, uint32_t arg2); 96 void __sanitizer_cov_trace_cmp8(uint64_t arg1, uint64_t arg2); 97 void __sanitizer_cov_trace_const_cmp1(uint8_t arg1, uint8_t arg2); 98 void __sanitizer_cov_trace_const_cmp2(uint16_t arg1, uint16_t arg2); 99 void __sanitizer_cov_trace_const_cmp4(uint32_t arg1, uint32_t arg2); 100 void __sanitizer_cov_trace_const_cmp8(uint64_t arg1, uint64_t arg2); 101 void __sanitizer_cov_trace_switch(uint64_t val, uint64_t *cases); 102 103 __END_DECLS 104 105 #endif /* CONFIG_KCOV */ 106 107 #endif /* KERNEL_PRIVATE */ 108 109 #endif /* _KCOV_H_ */ 110