1 /*
2 * Copyright (c) 2012-2013 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 _KERNEL_TELEMETRY_H_
30 #define _KERNEL_TELEMETRY_H_
31
32 #include <stdint.h>
33 #include <sys/cdefs.h>
34 #include <mach/mach_types.h>
35 #include <kern/thread.h>
36
37 __BEGIN_DECLS
38
39 #define TELEMETRY_CMD_TIMER_EVENT 1
40 #define TELEMETRY_CMD_VOUCHER_NAME 2
41 #define TELEMETRY_CMD_VOUCHER_STAIN TELEMETRY_CMD_VOUCHER_NAME
42
43 enum telemetry_pmi {
44 TELEMETRY_PMI_NONE,
45 TELEMETRY_PMI_INSTRS,
46 TELEMETRY_PMI_CYCLES,
47 };
48 #define TELEMETRY_CMD_PMI_SETUP 3
49
50 #if XNU_KERNEL_PRIVATE
51
52 __options_decl(kernel_brk_options_t, uint32_t, {
53 /* Recoverability */
54 KERNEL_BRK_UNRECOVERABLE = 0x00,
55 KERNEL_BRK_RECOVERABLE = 0x01,
56
57 /* Telemetry collection mode */
58 KERNEL_BRK_CORE_ANALYTICS = 0x10,
59 KERNEL_BRK_SIMULATED_PANIC = 0x20, /* Future */
60 });
61
62 #define KERNEL_BRK_TELEMETRY_OPTIONS 0xf0
63
64 __enum_decl(kernel_brk_type_t, uint32_t, {
65 KERNEL_BRK_TYPE_KASAN, /* <Unrecoverable> KASan violation traps */
66 KERNEL_BRK_TYPE_PTRAUTH, /* <Unrecoverable> Pointer Auth failure traps */
67 KERNEL_BRK_TYPE_CLANG, /* <Unrecoverable> Clang sanitizer traps */
68 KERNEL_BRK_TYPE_LIBCXX, /* <Unrecoverable> Libc++ abort trap*/
69 KERNEL_BRK_TYPE_TELEMETRY, /* <Rerecoverable> Soft telemetry collection traps */
70
71 KERNEL_BRK_TYPE_TEST, /* Development only */
72 });
73
74 enum kernel_brk_trap_comment {
75 /* CLANG (reserved) : [0x0000 ~ 0x00FF] <Intel only> */
76 CLANG_TRAPS_X86_START = 0x0000,
77 CLANG_BOUND_CHK_TRAP_X86 = 0x0019, /* bound check fatal trap */
78 CLANG_TRAPS_X86_END = 0x00FF,
79
80 /* LIBCXX : [0x0800 ~ 0x0800] */
81 LIBCXX_TRAPS_START = 0x0800,
82 LIBCXX_ABORT_TRAP = 0x0800, /* libcxx abort() in libcxx_support/stdlib.h */
83 LIBCXX_TRAPS_END = 0x0800,
84
85 /* KASAN (kasan-tbi.h) : [0x0900 ~ 0x093F] <ARM only> */
86
87 /* CLANG (reserved) : [0x5500 ~ 0x56FF] <ARM only> */
88 CLANG_TRAPS_ARM_START = 0x5500,
89 CLANG_BOUND_CHK_TRAP_ARM = 0x5519, /* bound check fatal trap */
90 CLANG_TRAPS_ARM_END = 0X55FF,
91
92 /* PTRAUTH (sleh.c) : [0xC470 ~ 0xC473] <ARM only> */
93
94 /* TELEMETRY : [0xFF00 ~ 0xFFFE] */
95 TELEMETRY_TRAPS_START = 0xFF00,
96 UBSAN_SIGNED_OVERFLOW_TRAP = 0xFF00, /* ubsan minimal signed overflow*/
97 CLANG_BOUND_CHK_SOFT_TRAP = 0xFF19, /* ml_bound_chk_soft_trap */
98 TELEMETRY_TRAPS_END = 0xFFFE,
99
100 /* TEST */
101 TEST_RECOVERABLE_SOFT_TRAP = 0xFFFF, /* development only */
102 };
103
104 typedef struct kernel_brk_descriptor {
105 kernel_brk_type_t type;
106 uint16_t base;
107 uint16_t max;
108 kernel_brk_options_t options;
109
110 void (*handle_breakpoint)(void *states, uint16_t comment);
111 } *kernel_brk_descriptor_t;
112
113 extern struct kernel_brk_descriptor brk_descriptors[]
114 __SECTION_START_SYM("__DATA_CONST", "__brk_desc");
115
116 extern struct kernel_brk_descriptor brk_descriptors_end[]
117 __SECTION_END_SYM("__DATA_CONST", "__brk_desc");
118
119 #define KERNEL_BRK_DESCRIPTOR_DEFINE(name, ...) \
120 __PLACE_IN_SECTION("__DATA_CONST,__brk_desc") \
121 static const struct kernel_brk_descriptor name = { __VA_ARGS__ };
122
123 const static inline struct kernel_brk_descriptor *
find_brk_descriptor_by_comment(uint16_t comment)124 find_brk_descriptor_by_comment(uint16_t comment)
125 {
126 for (kernel_brk_descriptor_t des = brk_descriptors; des < brk_descriptors_end; des++) {
127 if (comment >= des->base && comment <= des->max) {
128 return des;
129 }
130 }
131
132 return NULL;
133 }
134
135 extern void telemetry_kernel_brk(
136 kernel_brk_type_t type,
137 kernel_brk_options_t options,
138 void *state,
139 uint16_t comment);
140
141 /* boolean_t must be used since variable is loaded from assembly. */
142 extern volatile boolean_t telemetry_needs_record;
143
144 extern void telemetry_init(void);
145
146 extern void compute_telemetry(void *);
147
148 extern void telemetry_ast(thread_t thread, uint32_t reasons);
149
150 extern int telemetry_gather(user_addr_t buffer, uint32_t *length, bool mark);
151
152 /* boolean_t must be used since this function is called from assembly. */
153 extern void telemetry_mark_curthread(boolean_t interrupted_userspace,
154 boolean_t pmi);
155
156 extern void telemetry_task_ctl(task_t task, uint32_t reason, int enable_disable);
157 extern void telemetry_task_ctl_locked(task_t task, uint32_t reason, int enable_disable);
158 extern void telemetry_global_ctl(int enable_disable);
159
160 extern int telemetry_timer_event(uint64_t deadline, uint64_t interval, uint64_t leeway);
161 extern int telemetry_pmi_setup(enum telemetry_pmi pmi_type, uint64_t interval);
162
163 #if CONFIG_MACF
164 extern int telemetry_macf_mark_curthread(void);
165 #endif
166
167 extern void bootprofile_init(void);
168 extern void bootprofile_wake_from_sleep(void);
169 extern void bootprofile_get(void **buffer, uint32_t *length);
170 extern int bootprofile_gather(user_addr_t buffer, uint32_t *length);
171
172 #endif /* XNU_KERNEL_PRIVATE */
173
174 __END_DECLS
175
176 #endif /* _KERNEL_TELEMETRY_H_ */
177