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
43enum 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/* these show up in telemetry, do not renumber */
65__enum_decl(kernel_brk_type_t, uint32_t, {
66 KERNEL_BRK_TYPE_KASAN = 0, /* <unrecoverable> KASan violation traps */
67 KERNEL_BRK_TYPE_PTRAUTH = 1, /* <unrecoverable> Pointer Auth failure traps */
68 KERNEL_BRK_TYPE_CLANG = 2, /* <unrecoverable> Clang sanitizer traps */
69 KERNEL_BRK_TYPE_LIBCXX = 3, /* <unrecoverable> Libc++ abort trap*/
70 KERNEL_BRK_TYPE_TELEMETRY = 4, /* < recoverable> Soft telemetry collection traps */
71 KERNEL_BRK_TYPE_XNU = 5, /* <??recoverable> XNU defined traps */
72
73 KERNEL_BRK_TYPE_TEST = ~0u, /* Development only */
74});
75
76enum kernel_brk_trap_comment {
77 /* CLANG (reserved) : [0x0000 ~ 0x00FF] <Intel only> */
78 CLANG_X86_TRAP_START = 0x0000,
79 CLANG_X86_TRAP_BOUND_CHK = 0x0019, /* bound check fatal trap */
80 CLANG_X86_TRAP_END = 0x00FF,
81
82 /* LIBCXX : [0x0800 ~ 0x0800] */
83 LIBCXX_TRAP_START = 0x0800,
84 LIBCXX_TRAP_ABORT = 0x0800, /* libcxx abort() in libcxx_support/stdlib.h */
85 LIBCXX_TRAP_END = 0x0800,
86
87 /* KASAN (kasan-tbi.h) : [0x0900 ~ 0x093F] <ARM only> */
88
89 /* CLANG (reserved) : [0x5500 ~ 0x55FF] <ARM only> */
90 CLANG_ARM_TRAP_START = 0x5500,
91 CLANG_ARM_TRAP_BOUND_CHK = 0x5519, /* bound check fatal trap */
92 CLANG_ARM_TRAP_END = 0x55FF,
93
94 /* Software defined : [0xB000 ~ 0xBFFF] */
95 XNU_HARD_TRAP_START = 0xB000,
96 XNU_HARD_TRAP_STRING_CHK = 0xBFFE, /* read traps in string.h */
97 XNU_HARD_TRAP_END = 0xBFFF,
98
99 /* PTRAUTH (sleh.c) : [0xC470 ~ 0xC473] <ARM only> */
100
101 /* TELEMETRY : [0xFF00 ~ 0xFFFE] */
102 XNU_SOFT_TRAP_START = 0xFF00,
103 UBSAN_SOFT_TRAP_SIGNED_OF = 0xFF00, /* ubsan minimal signed overflow*/
104 CLANG_SOFT_TRAP_BOUND_CHK = 0xFF19, /* ml_bound_chk_soft_trap */
105 XNU_SOFT_TRAP_STRING_CHK = 0xFFFE, /* read traps in string.h */
106 XNU_SOFT_TRAP_END = 0xFFFE,
107
108 /* TEST */
109 TEST_RECOVERABLE_SOFT_TRAP = 0xFFFF, /* development only */
110};
111
112typedef struct kernel_brk_descriptor {
113 kernel_brk_type_t type;
114 uint16_t base;
115 uint16_t max;
116 kernel_brk_options_t options;
117
118 void (*handle_breakpoint)(void *states, uint16_t comment);
119} *kernel_brk_descriptor_t;
120
121extern struct kernel_brk_descriptor brk_descriptors[]
122__SECTION_START_SYM("__DATA_CONST", "__brk_desc");
123
124extern struct kernel_brk_descriptor brk_descriptors_end[]
125__SECTION_END_SYM("__DATA_CONST", "__brk_desc");
126
127#define KERNEL_BRK_DESCRIPTOR_DEFINE(name, ...) \
128__PLACE_IN_SECTION("__DATA_CONST,__brk_desc") \
129static const struct kernel_brk_descriptor name = { __VA_ARGS__ };
130
131const static inline struct kernel_brk_descriptor *
132find_brk_descriptor_by_comment(uint16_t comment)
133{
134 for (kernel_brk_descriptor_t des = brk_descriptors; des < brk_descriptors_end; des++) {
135 if (comment >= des->base && comment <= des->max) {
136 return des;
137 }
138 }
139
140 return NULL;
141}
142
143extern void telemetry_kernel_brk(
144 kernel_brk_type_t type,
145 kernel_brk_options_t options,
146 void *state,
147 uint16_t comment);
148
149/* implemented in OSKextLib.cpp */
150extern void telemetry_backtrace_add_kexts(
151 char *buf,
152 size_t buflen,
153 uintptr_t *frames,
154 uint32_t framecnt);
155
156/* boolean_t must be used since variable is loaded from assembly. */
157extern volatile boolean_t telemetry_needs_record;
158
159extern void telemetry_init(void);
160
161extern void compute_telemetry(void *);
162
163extern void telemetry_ast(thread_t thread, uint32_t reasons);
164
165extern int telemetry_gather(user_addr_t buffer, uint32_t *length, bool mark);
166
167/* boolean_t must be used since this function is called from assembly. */
168extern void telemetry_mark_curthread(boolean_t interrupted_userspace,
169 boolean_t pmi);
170
171extern void telemetry_task_ctl(task_t task, uint32_t reason, int enable_disable);
172extern void telemetry_task_ctl_locked(task_t task, uint32_t reason, int enable_disable);
173extern void telemetry_global_ctl(int enable_disable);
174
175extern int telemetry_timer_event(uint64_t deadline, uint64_t interval, uint64_t leeway);
176extern int telemetry_pmi_setup(enum telemetry_pmi pmi_type, uint64_t interval);
177
178#if CONFIG_MACF
179extern int telemetry_macf_mark_curthread(void);
180#endif
181
182extern void bootprofile_init(void);
183extern void bootprofile_wake_from_sleep(void);
184extern void bootprofile_get(void **buffer, uint32_t *length);
185extern int bootprofile_gather(user_addr_t buffer, uint32_t *length);
186
187#endif /* XNU_KERNEL_PRIVATE */
188
189__END_DECLS
190
191#endif /* _KERNEL_TELEMETRY_H_ */
192