xref: /xnu-8020.140.41/bsd/sys/kdebug.h (revision 27b03b360a988dfd3dfdf34262bb0042026747cc)
1 /*
2  * Copyright (c) 2000-2019 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 BSD_SYS_KDEBUG_H
30 #define BSD_SYS_KDEBUG_H
31 
32 #include <sys/appleapiopts.h>
33 #include <sys/cdefs.h>
34 
35 __BEGIN_DECLS
36 
37 #ifdef __APPLE_API_UNSTABLE
38 
39 /*
40  * Kdebug is a kernel facility for tracing events occurring on a system.  User
41  * space processes should prefer os_signpost, instead.
42  *
43  * This header defines reserved debugids, which are 32-bit values that describe
44  * each event:
45  *
46  * +----------------+----------------+----------------------------+----+
47  * |   Class (8)    |  Subclass (8)  |          Code (14)         |Func|
48  * |                |                |                            |(2) |
49  * +----------------+----------------+----------------------------+----+
50  * \_________________________________/
51  *         ClassSubclass (CSC)
52  * \________________________________________________________________00_/
53  *                                 Eventid
54  * \___________________________________________________________________/
55  *                                 Debugid
56  *
57  * The eventid is a hierarchical ID, indicating which components an event is
58  * referring to.  The debugid includes an eventid and two function qualifier
59  * bits, to determine the structural significance of an event (whether it
60  * starts or ends an interval).
61  */
62 
63 #define KDBG_CLASS_MASK   (0xff000000)
64 #define KDBG_CLASS_OFFSET (24)
65 #define KDBG_CLASS_MAX    (0xff)
66 
67 #define KDBG_SUBCLASS_MASK   (0x00ff0000)
68 #define KDBG_SUBCLASS_OFFSET (16)
69 #define KDBG_SUBCLASS_MAX    (0xff)
70 
71 /* class and subclass mask */
72 #define KDBG_CSC_MASK   (0xffff0000)
73 #define KDBG_CSC_OFFSET (KDBG_SUBCLASS_OFFSET)
74 #define KDBG_CSC_MAX    (0xffff)
75 
76 #define KDBG_CODE_MASK   (0x0000fffc)
77 #define KDBG_CODE_OFFSET (2)
78 #define KDBG_CODE_MAX    (0x3fff)
79 
80 #define KDBG_EVENTID_MASK (0xfffffffc)
81 #define KDBG_FUNC_MASK    (0x00000003)
82 
83 /* Generate an eventid corresponding to Class, SubClass, and Code. */
84 #define KDBG_EVENTID(Class, SubClass, Code)                \
85 	(((unsigned)((Class)    &   0xff) << KDBG_CLASS_OFFSET)    | \
86 	 ((unsigned)((SubClass) &   0xff) << KDBG_SUBCLASS_OFFSET) | \
87 	 ((unsigned)((Code)     & 0x3fff) << KDBG_CODE_OFFSET))
88 /* Deprecated macro using old naming convention. */
89 #define KDBG_CODE(Class, SubClass, Code) \
90 	KDBG_EVENTID(Class, SubClass, Code)
91 
92 /* Extract pieces of the debug code. */
93 #define KDBG_EXTRACT_CLASS(Debugid) \
94 	((uint8_t)(((Debugid) & KDBG_CLASS_MASK) >> KDBG_CLASS_OFFSET))
95 #define KDBG_EXTRACT_SUBCLASS(Debugid) \
96 	((uint8_t)(((Debugid) & KDBG_SUBCLASS_MASK) >> KDBG_SUBCLASS_OFFSET))
97 #define KDBG_EXTRACT_CSC(Debugid) \
98 	((uint16_t)(((Debugid) & KDBG_CSC_MASK) >> KDBG_CSC_OFFSET))
99 #define KDBG_EXTRACT_CODE(Debugid) \
100 	((uint16_t)(((Debugid) & KDBG_CODE_MASK) >> KDBG_CODE_OFFSET))
101 #define KDBG_CLASS_ENCODE(Class, SubClass) KDBG_EVENTID(Class, SubClass, 0)
102 #define KDBG_CLASS_DECODE(Debugid) (Debugid & KDBG_CSC_MASK)
103 
104 /* function qualifiers  */
105 #define DBG_FUNC_START 1U
106 #define DBG_FUNC_END   2U
107 #define DBG_FUNC_NONE  0U
108 
109 /* The Kernel Debug Classes  */
110 
111 #define DBG_MACH        1
112 #define DBG_NETWORK     2
113 #define DBG_FSYSTEM     3
114 #define DBG_BSD         4
115 #define DBG_IOKIT       5
116 #define DBG_DRIVERS     6
117 #define DBG_TRACE       7
118 #define DBG_DLIL        8
119 #define DBG_PTHREAD     9
120 #define DBG_CORESTORAGE 10
121 #define DBG_CG          11
122 #define DBG_MONOTONIC   12
123 #define DBG_MISC        20
124 #define DBG_SECURITY    30
125 #define DBG_DYLD        31
126 #define DBG_QT          32
127 #define DBG_APPS        33
128 #define DBG_LAUNCHD     34
129 #define DBG_SILICON     35
130 #define DBG_PERF        37
131 #define DBG_IMPORTANCE  38
132 #define DBG_BANK        40
133 #define DBG_XPC         41
134 #define DBG_ATM         42
135 #define DBG_ARIADNE     43
136 #define DBG_DAEMON      44
137 #define DBG_ENERGYTRACE 45
138 #define DBG_DISPATCH    46
139 #define DBG_IMG         49
140 #define DBG_UMALLOC     51
141 #define DBG_TURNSTILE   53
142 #define DBG_AUDIO       54
143 
144 #define DBG_MIG         255
145 
146 /* **** The Kernel Debug Sub Classes for Mach (DBG_MACH) **** */
147 #define DBG_MACH_EXCP_KTRAP_x86 0x02 /* Kernel Traps on x86 */
148 #define DBG_MACH_EXCP_DFLT      0x03 /* deprecated name */
149 #define DBG_MACH_EXCP_SYNC_ARM  0x03 /* arm/arm64 synchronous exception */
150 #define DBG_MACH_EXCP_IFLT      0x04 /* deprecated name */
151 #define DBG_MACH_EXCP_SERR_ARM  0x04 /* arm/arm64 SError (async) exception */
152 #define DBG_MACH_EXCP_INTR      0x05 /* Interrupts */
153 #define DBG_MACH_EXCP_ALNG      0x06 /* Alignment Exception */
154 #define DBG_MACH_EXCP_UTRAP_x86 0x07 /* User Traps on x86 */
155 #define DBG_MACH_EXCP_FP        0x08 /* FP Unavail */
156 #define DBG_MACH_EXCP_DECI      0x09 /* Decrementer Interrupt */
157 #define DBG_MACH_CHUD           0x0A /* deprecated name */
158 #define DBG_MACH_SIGNPOST       0x0A /* kernel signposts */
159 #define DBG_MACH_EXCP_SC        0x0C /* System Calls */
160 #define DBG_MACH_EXCP_TRACE     0x0D /* Trace exception */
161 #define DBG_MACH_EXCP_EMUL      0x0E /* Instruction emulated */
162 #define DBG_MACH_IHDLR          0x10 /* Interrupt Handlers */
163 #define DBG_MACH_IPC            0x20 /* Inter Process Comm */
164 #define DBG_MACH_RESOURCE       0x25 /* tracing limits, etc */
165 #define DBG_MACH_VM             0x30 /* Virtual Memory */
166 #define DBG_MACH_LEAKS          0x31 /* alloc/free */
167 #define DBG_MACH_WORKINGSET     0x32 /* private subclass for working set related debugging */
168 #define DBG_MACH_SCHED          0x40 /* Scheduler */
169 #define DBG_MACH_MSGID_INVALID  0x50 /* Messages - invalid */
170 #define DBG_MACH_LOCKS          0x60 /* new lock APIs */
171 #define DBG_MACH_PMAP           0x70 /* pmap */
172 #define DBG_MACH_CLOCK          0x80 /* clock */
173 #define DBG_MACH_MP             0x90 /* MP related */
174 #define DBG_MACH_VM_PRESSURE    0xA0 /* Memory Pressure Events */
175 #define DBG_MACH_STACKSHOT      0xA1 /* Stackshot/Microstackshot subsystem */
176 #define DBG_MACH_SFI            0xA2 /* Selective Forced Idle (SFI) */
177 #define DBG_MACH_ENERGY_PERF    0xA3 /* Energy/performance resource stats */
178 #define DBG_MACH_SYSDIAGNOSE    0xA4 /* sysdiagnose */
179 #define DBG_MACH_ZALLOC         0xA5 /* Zone allocator */
180 #define DBG_MACH_THREAD_GROUP   0xA6 /* Thread groups */
181 #define DBG_MACH_COALITION      0xA7 /* Coalitions */
182 #define DBG_MACH_SHAREDREGION   0xA8 /* Shared region */
183 #define DBG_MACH_SCHED_CLUTCH   0xA9 /* Clutch scheduler */
184 #define DBG_MACH_IO             0xAA /* I/O */
185 #define DBG_MACH_WORKGROUP      0xAB /* Workgroup subsystem */
186 #define DBG_MACH_HV             0xAC /* Hypervisor subsystem */
187 #define DBG_MACH_KCOV           0xAD /* Kernel coverage sanitizer */
188 #define DBG_MACH_MACHDEP_EXCP_SC_x86 0xAE /* Machine Dependent System Calls on x86 */
189 #define DBG_MACH_MACHDEP_EXCP_SC_ARM 0xAF /* Machine Dependent System Calls on arm */
190 
191 /* Codes for DBG_MACH_IO */
192 #define DBC_MACH_IO_MMIO_READ           0x1
193 #define DBC_MACH_IO_MMIO_WRITE          0x2
194 #define DBC_MACH_IO_PHYS_READ           0x3
195 #define DBC_MACH_IO_PHYS_WRITE          0x4
196 #define DBC_MACH_IO_PORTIO_READ         0x5
197 #define DBC_MACH_IO_PORTIO_WRITE        0x6
198 
199 /* Interrupt type bits for DBG_MACH_EXCP_INTR */
200 #define DBG_INTR_TYPE_UNKNOWN   0x0     /* default/unknown interrupt */
201 #define DBG_INTR_TYPE_IPI       0x1     /* interprocessor interrupt */
202 #define DBG_INTR_TYPE_TIMER     0x2     /* timer interrupt */
203 #define DBG_INTR_TYPE_OTHER     0x3     /* other (usually external) interrupt */
204 #define DBG_INTR_TYPE_PMI       0x4     /* performance monitor interrupt */
205 
206 /* Codes for Scheduler (DBG_MACH_SCHED) */
207 #define MACH_SCHED              0x0     /* Scheduler */
208 #define MACH_STACK_ATTACH       0x1     /* stack_attach() */
209 #define MACH_STACK_HANDOFF      0x2     /* stack_handoff() */
210 #define MACH_CALL_CONT          0x3     /* call_continuation() */
211 #define MACH_CALLOUT            0x4     /* callouts */
212 #define MACH_STACK_DETACH       0x5
213 #define MACH_MAKE_RUNNABLE      0x6     /* make thread runnable */
214 #define MACH_PROMOTE            0x7     /* promoted due to resource (replaced by MACH_PROMOTED) */
215 #define MACH_DEMOTE             0x8     /* promotion undone (replaced by MACH_UNPROMOTED) */
216 #define MACH_IDLE               0x9     /* processor idling */
217 #define MACH_STACK_DEPTH        0xa     /* stack depth at switch */
218 #define MACH_MOVED              0xb     /* did not use original scheduling decision */
219 #define MACH_PSET_LOAD_AVERAGE  0xc
220 #define MACH_AMP_DEBUG          0xd
221 #define MACH_FAILSAFE           0xe     /* tripped fixed-pri/RT failsafe */
222 #define MACH_BLOCK              0xf     /* thread block */
223 #define MACH_WAIT               0x10    /* thread wait assertion */
224 #define MACH_GET_URGENCY        0x14    /* Urgency queried by platform */
225 #define MACH_URGENCY            0x15    /* Urgency (RT/BG/NORMAL) communicated
226 	                                 * to platform
227 	                                 */
228 #define MACH_REDISPATCH         0x16    /* "next thread" thread redispatched */
229 #define MACH_REMOTE_AST         0x17    /* AST signal issued to remote processor */
230 #define MACH_SCHED_CHOOSE_PROCESSOR     0x18    /* Result of choose_processor */
231 #define MACH_DEEP_IDLE          0x19    /* deep idle on master processor */
232 /* unused                       0x1a    was MACH_SCHED_DECAY_PRIORITY */
233 #define MACH_CPU_THROTTLE_DISABLE       0x1b    /* Global CPU Throttle Disable */
234 #define MACH_RW_PROMOTE            0x1c /* promoted due to RW lock promotion */
235 #define MACH_RW_DEMOTE             0x1d /* promotion due to RW lock undone */
236 #define MACH_SCHED_MAINTENANCE     0x1f /* periodic maintenance thread */
237 #define MACH_DISPATCH              0x20 /* context switch completed */
238 #define MACH_QUANTUM_HANDOFF       0x21 /* quantum handoff occurred */
239 #define MACH_MULTIQ_DEQUEUE        0x22 /* Result of multiq dequeue */
240 #define MACH_SCHED_THREAD_SWITCH   0x23 /* attempt direct context switch to hinted thread */
241 #define MACH_SCHED_SMT_BALANCE     0x24 /* SMT load balancing ASTs */
242 #define MACH_REMOTE_DEFERRED_AST   0x25 /* Deferred AST started against remote processor */
243 #define MACH_REMOTE_CANCEL_AST     0x26 /* Canceled deferred AST for remote processor */
244 #define MACH_SCHED_CHANGE_PRIORITY 0x27 /* thread sched priority changed */
245 #define MACH_SCHED_UPDATE_REC_CORES     0x28    /* Change to recommended processor bitmask */
246 #define MACH_STACK_WAIT            0x29 /* Thread could not be switched-to because of kernel stack shortage */
247 #define MACH_THREAD_BIND           0x2a /* Thread was bound (or unbound) to a processor */
248 #define MACH_WAITQ_PROMOTE         0x2b /* Thread promoted by waitq boost */
249 #define MACH_WAITQ_DEMOTE          0x2c /* Thread demoted from waitq boost */
250 #define MACH_SCHED_LOAD            0x2d /* load update */
251 #define MACH_REC_CORES_FAILSAFE    0x2e /* recommended processor failsafe kicked in */
252 #define MACH_SCHED_QUANTUM_EXPIRED 0x2f /* thread quantum expired */
253 #define MACH_EXEC_PROMOTE          0x30 /* Thread promoted by exec boost */
254 #define MACH_EXEC_DEMOTE           0x31 /* Thread demoted from exec boost */
255 #define MACH_AMP_SIGNAL_SPILL      0x32 /* AMP spill signal sent to cpuid */
256 #define MACH_AMP_STEAL             0x33 /* AMP thread stolen or spilled */
257 #define MACH_SCHED_LOAD_EFFECTIVE  0x34 /* Effective scheduler load */
258 /* unused  MACH_PROMOTED              0x35 was: thread promoted due to mutex priority promotion */
259 /* unused  MACH_UNPROMOTED            0x36 was: thread unpromoted due to mutex priority promotion */
260 /* unused  MACH_PROMOTED_UPDATE       0x37 was: thread already promoted, but promotion priority changed */
261 #define MACH_QUIESCENT_COUNTER     0x38 /* quiescent counter tick */
262 #define MACH_TURNSTILE_USER_CHANGE 0x39 /* base priority change because of turnstile */
263 #define MACH_AMP_RECOMMENDATION_CHANGE 0x3a /* Thread group recommendation change */
264 #define MACH_AMP_PERFCTL_POLICY_CHANGE 0x3b /* AMP policy for perfctl cluster recommendation */
265 #define MACH_TURNSTILE_KERNEL_CHANGE 0x40 /* sched priority change because of turnstile */
266 #define MACH_SCHED_WI_AUTO_JOIN      0x41 /* work interval auto join events */
267 #define MACH_SCHED_WI_DEFERRED_FINISH 0x42 /* work interval pending finish events for auto-join thread groups */
268 #define MACH_SET_RT_DEADLINE       0x43 /* set thread->realtime.deadline */
269 #define MACH_CANCEL_RT_DEADLINE    0x44 /* cancel thread->realtime.deadline */
270 #define MACH_RT_SIGNAL_SPILL       0x45 /* RT spill signal sent to cpuid */
271 #define MACH_RT_STEAL              0x46 /* RT thread stolen or spilled */
272 #define MACH_PENDING_AST_URGENT    0x47 /* CPU pending_AST_URGENT set/cleared */
273 #define MACH_SCHED_THREAD_SELECT   0x48 /* Result of thread_select */
274 #define MACH_SCHED_NEXT_PROCESSOR  0x49 /* Result of choose_next_rt_processor_for_IPI */
275 #define MACH_PSET_AVG_EXEC_TIME    0x50
276 #define MACH_SUSPEND_USERSPACE     0x51    /* userspace threads are suspended */
277 #define MACH_PREEMPTION_EXPIRED    0x52 /* preemption disable threshold crossed */
278 #define MACH_FLOOR_PROMOTE         0x53 /* promoted upon request */
279 #define MACH_FLOOR_DEMOTE          0x54 /* unpromoted upon request */
280 #define MACH_INT_MASKED_EXPIRED    0x55    /* interrupt masked threshold crossed */
281 #define MACH_INT_HANDLED_EXPIRED   0x56    /* interrupt handling threshold crossed */
282 
283 /* Codes for Clutch/Edge Scheduler (DBG_MACH_SCHED_CLUTCH) */
284 #define MACH_SCHED_CLUTCH_ROOT_BUCKET_STATE     0x0 /* __unused */
285 #define MACH_SCHED_CLUTCH_TG_BUCKET_STATE       0x1 /* __unused */
286 #define MACH_SCHED_CLUTCH_THREAD_SELECT         0x2 /* Thread selection events for Clutch scheduler */
287 #define MACH_SCHED_CLUTCH_THREAD_STATE          0x3 /* __unused */
288 #define MACH_SCHED_CLUTCH_TG_BUCKET_PRI         0x4 /* Clutch bucket priority update event */
289 /* Edge Scheduler Tracepoints */
290 #define MACH_SCHED_EDGE_CLUSTER_OVERLOAD        0x5 /* Cluster experienced overload; migrating threads to other clusters */
291 #define MACH_SCHED_EDGE_STEAL                   0x6 /* Per-cluster avg. thread execution time */
292 #define MACH_SCHED_EDGE_REBAL_RUNNABLE          0x7 /* Rebalance runnable threads on a foreign cluster */
293 #define MACH_SCHED_EDGE_REBAL_RUNNING           0x8 /* Rebalance running threads on a foreign cluster */
294 #define MACH_SCHED_EDGE_SHOULD_YIELD            0x9 /* Edge decisions for thread yield */
295 #define MACH_SCHED_CLUTCH_THR_COUNT             0xa /* Clutch scheduler runnable thread counts */
296 #define MACH_SCHED_EDGE_LOAD_AVG                0xb /* Per-cluster load average */
297 #define MACH_SCHED_EDGE_CLUSTER_SHARED_LOAD     0xc /* Per-cluster shared resource load */
298 #define MACH_SCHED_EDGE_RSRC_HEAVY_THREAD       0xd /* Resource heavy thread state */
299 #define MACH_SCHED_EDGE_SHARED_RSRC_MIGRATE     0xe /* Migrating a shared resource thread due to cluster load imbalance */
300 
301 /* Codes for workgroup interval subsystem (DBG_MACH_WORKGROUP) */
302 #define WORKGROUP_INTERVAL_CREATE               0x0 /* work interval creation */
303 #define WORKGROUP_INTERVAL_DESTROY              0x1 /* work interval destruction */
304 #define WORKGROUP_INTERVAL_CHANGE               0x2 /* thread work interval change */
305 #define WORKGROUP_INTERVAL_START                0x3 /* work interval start call */
306 #define WORKGROUP_INTERVAL_UPDATE               0x4 /* work interval update call */
307 #define WORKGROUP_INTERVAL_FINISH               0x5 /* work interval finish call */
308 
309 /* Codes for coverage sanitizer */
310 #define KCOV_STKSZ_THRESHOLD_ABOVE           0x0 /* thread stack is above threshold */
311 #define KCOV_STKSZ_THRESHOLD_BELOW           0x1 /* thread stack is below threshold */
312 #define KCOV_STKSZ_DELTA                     0X2 /* thread stack change is larger than delta. */
313 
314 /* Variants for MACH_MULTIQ_DEQUEUE */
315 #define MACH_MULTIQ_BOUND     1
316 #define MACH_MULTIQ_GROUP     2
317 #define MACH_MULTIQ_GLOBAL    3
318 
319 /* Arguments for vm_fault (DBG_MACH_VM) */
320 #define DBG_ZERO_FILL_FAULT           1
321 #define DBG_PAGEIN_FAULT              2
322 #define DBG_COW_FAULT                 3
323 #define DBG_CACHE_HIT_FAULT           4
324 #define DBG_NZF_PAGE_FAULT            5
325 #define DBG_GUARD_FAULT               6
326 #define DBG_PAGEINV_FAULT             7
327 #define DBG_PAGEIND_FAULT             8
328 #define DBG_COMPRESSOR_FAULT          9
329 #define DBG_COMPRESSOR_SWAPIN_FAULT  10
330 #define DBG_COR_FAULT                11
331 
332 /* Codes for IPC (DBG_MACH_IPC) */
333 #define MACH_TASK_SUSPEND                       0x0     /* Suspended a task */
334 #define MACH_TASK_RESUME                        0x1     /* Resumed a task */
335 #define MACH_THREAD_SET_VOUCHER                 0x2
336 #define MACH_IPC_MSG_SEND                       0x3     /* mach msg send, uniq msg info */
337 #define MACH_IPC_MSG_RECV                       0x4     /* mach_msg receive */
338 #define MACH_IPC_MSG_RECV_VOUCHER_REFUSED       0x5     /* mach_msg receive, voucher refused */
339 #define MACH_IPC_KMSG_FREE                      0x6     /* kernel free of kmsg data */
340 #define MACH_IPC_VOUCHER_CREATE                 0x7     /* Voucher added to global voucher hashtable */
341 #define MACH_IPC_VOUCHER_CREATE_ATTR_DATA       0x8     /* Attr data for newly created voucher */
342 #define MACH_IPC_VOUCHER_DESTROY                0x9     /* Voucher removed from global voucher hashtable */
343 #define MACH_IPC_KMSG_INFO                      0xa     /* Send/Receive info for a kmsg */
344 #define MACH_IPC_KMSG_LINK                      0xb     /* link a kernel kmsg pointer to user mach_msg_header_t */
345 #define MACH_IPC_PORT_ENTRY_MODIFY              0xc     /* A port space gained or lost a port right (reference) */
346 #define MACH_IPC_DESTROY_GUARDED_DESC           0xd     /* Unable to receive a guarded descriptor */
347 
348 /* Codes for thread groups (DBG_MACH_THREAD_GROUP) */
349 #define MACH_THREAD_GROUP_NEW           0x0
350 #define MACH_THREAD_GROUP_FREE          0x1
351 #define MACH_THREAD_GROUP_SET           0x2
352 #define MACH_THREAD_GROUP_NAME          0x3
353 #define MACH_THREAD_GROUP_NAME_FREE     0x4
354 #define MACH_THREAD_GROUP_FLAGS         0x5
355 #define MACH_THREAD_GROUP_BLOCK         0x6
356 #define MACH_THREAD_GROUP_PREADOPT      0x7
357 #define MACH_THREAD_GROUP_PREADOPT_NEXTTIME  0x8
358 #define MACH_THREAD_GROUP_PREADOPT_CLEAR 0x9
359 #define MACH_THREAD_GROUP_PREADOPT_NA 0xa
360 
361 /* Codes for coalitions (DBG_MACH_COALITION) */
362 #define MACH_COALITION_NEW                      0x0
363 #define MACH_COALITION_FREE                     0x1
364 #define MACH_COALITION_ADOPT                    0x2
365 #define MACH_COALITION_REMOVE                   0x3
366 #define MACH_COALITION_THREAD_GROUP_SET         0x4
367 
368 /* Codes for pmap (DBG_MACH_PMAP) */
369 #define PMAP__CREATE            0x0
370 #define PMAP__DESTROY           0x1
371 #define PMAP__PROTECT           0x2
372 #define PMAP__PAGE_PROTECT      0x3
373 #define PMAP__ENTER             0x4
374 #define PMAP__REMOVE            0x5
375 #define PMAP__NEST              0x6
376 #define PMAP__UNNEST            0x7
377 #define PMAP__FLUSH_TLBS        0x8
378 #define PMAP__UPDATE_INTERRUPT  0x9
379 #define PMAP__ATTRIBUTE_CLEAR   0xa
380 #define PMAP__REUSABLE          0xb     /* This appears to be unused */
381 #define PMAP__QUERY_RESIDENT    0xc
382 #define PMAP__FLUSH_KERN_TLBS   0xd
383 #define PMAP__FLUSH_DELAYED_TLBS        0xe
384 #define PMAP__FLUSH_TLBS_TO     0xf
385 #define PMAP__FLUSH_EPT         0x10
386 #define PMAP__FAST_FAULT        0x11
387 #define PMAP__SWITCH            0x12
388 #define PMAP__TTE               0x13
389 #define PMAP__SWITCH_USER_TTB   0x14
390 #define PMAP__UPDATE_CACHING    0x15
391 #define PMAP__ATTRIBUTE_CLEAR_RANGE 0x16
392 #define PMAP__CLEAR_USER_TTB    0x17
393 #define PMAP__IOMMU_INIT        0x18
394 #define PMAP__IOMMU_IOVMALLOC   0x19
395 #define PMAP__IOMMU_IOVMFREE    0x1a
396 #define PMAP__IOMMU_MAP         0x1b
397 #define PMAP__IOMMU_UNMAP       0x1c
398 #define PMAP__IOMMU_IOCTL       0x1d
399 #define PMAP__IOMMU_GRANT_PAGE  0x1e
400 
401 /* Codes for clock (DBG_MACH_CLOCK) */
402 #define MACH_EPOCH_CHANGE       0x0     /* wake epoch change */
403 #define MACH_BRIDGE_RCV_TS      0x1     /* receive timestamp pair from interrupt handler */
404 #define MACH_BRIDGE_REMOTE_TIME 0x2     /* calculate remote timestamp */
405 #define MACH_BRIDGE_RESET_TS    0x3     /* reset timestamp conversion parameters */
406 #define MACH_BRIDGE_TS_PARAMS   0x4     /* recompute timestamp conversion parameters */
407 #define MACH_BRIDGE_SKIP_TS     0x5     /* skip timestamp */
408 #define MACH_BRIDGE_TS_MISMATCH 0x6     /* mismatch between predicted and received remote timestamp */
409 #define MACH_BRIDGE_OBSV_RATE   0x7     /* out of range observed rates */
410 
411 /* Codes for Stackshot/Microstackshot (DBG_MACH_STACKSHOT) */
412 #define MICROSTACKSHOT_RECORD   0x0
413 #define MICROSTACKSHOT_GATHER   0x1
414 #define STACKSHOT_RECORD        0x2     /* START/END, syscall stackshot */
415 #define STACKSHOT_RECORD_SHORT  0x3     /* ran out of space inside stackshot, growing buffer */
416 #define STACKSHOT_KERN_RECORD   0x4     /* START/END, internal stackshot */
417 
418 /* Codes for sysdiagnose (DBG_MACH_SYSDIAGNOSE) */
419 #define SYSDIAGNOSE_NOTIFY_USER 0x0
420 #define SYSDIAGNOSE_FULL        0x1
421 #define SYSDIAGNOSE_STACKSHOT   0x2
422 #define SYSDIAGNOSE_TAILSPIN    0x3
423 
424 /* Codes for Selective Forced Idle (DBG_MACH_SFI) */
425 #define SFI_SET_WINDOW                  0x0
426 #define SFI_CANCEL_WINDOW               0x1
427 #define SFI_SET_CLASS_OFFTIME           0x2
428 #define SFI_CANCEL_CLASS_OFFTIME        0x3
429 #define SFI_THREAD_DEFER                0x4
430 #define SFI_OFF_TIMER                   0x5
431 #define SFI_ON_TIMER                    0x6
432 #define SFI_WAIT_CANCELED               0x7
433 #define SFI_PID_SET_MANAGED             0x8
434 #define SFI_PID_CLEAR_MANAGED           0x9
435 #define SFI_GLOBAL_DEFER                0xa
436 
437 /* Codes for Zone Allocator (DBG_MACH_ZALLOC) */
438 #define ZALLOC_ZCRAM                    0x0
439 
440 /* Codes for Mach resource management (DBG_MACH_RESOURCE) */
441 /* _K32A/B codes start at double the low nibble */
442 #define RMON_ENABLE_CPUUSAGE_MONITOR    0x001
443 #define RMON_CPUUSAGE_VIOLATED          0x002
444 #define RMON_CPUUSAGE_SUSPENDED         0x003
445 #define RMON_CPUUSAGE_VIOLATED_K32A     0x004
446 #define RMON_CPUUSAGE_VIOLATED_K32B     0x005
447 #define RMON_CPUUSAGE_RESUMED           0x006
448 #define RMON_DISABLE_CPUUSAGE_MONITOR   0x00f
449 
450 #define RMON_ENABLE_CPUWAKES_MONITOR    0x011
451 #define RMON_CPUWAKES_VIOLATED          0x012
452 #define RMON_CPUWAKES_VIOLATED_K32A     0x014
453 #define RMON_CPUWAKES_VIOLATED_K32B     0x015
454 #define RMON_DISABLE_CPUWAKES_MONITOR   0x01f
455 
456 #define RMON_ENABLE_IO_MONITOR          0x021
457 #define RMON_LOGWRITES_VIOLATED         0x022
458 #define RMON_PHYSWRITES_VIOLATED        0x023
459 #define RMON_LOGWRITES_VIOLATED_K32A    0x024
460 #define RMON_LOGWRITES_VIOLATED_K32B    0x025
461 #define RMON_DISABLE_IO_MONITOR         0x02f
462 
463 /* Codes for x86 Hypervisor (DBG_MACH_HV) */
464 #define HV_X86_ENTER                     0x00
465 #define HV_X86_ENTER_ERROR               0x01
466 #define HV_X86_TRAP_TASK                 0x02
467 #define HV_X86_TRAP_THREAD               0x03
468 #define HV_X86_INTERRUPT_INJECT          0x04
469 #define HV_X86_INTERRUPT_RECV            0x05
470 #define HV_X86_INTERRUPT_SEND            0x06
471 #define HV_X86_IPI_SEND                  0x07
472 #define HV_X86_NMI_INJECT                0x08
473 #define HV_X86_NMI_SEND                  0x09
474 #define HV_X86_LSC_HIT                   0x0a
475 #define HV_X86_LSC_INSERT                0x0b
476 #define HV_X86_LSC_INSERT_IMM32          0x0c
477 #define HV_X86_LSC_INVALID               0x0d
478 #define HV_X86_LSC_INVALIDATE            0x0e
479 #define HV_X86_LSC_MISS                  0x0f
480 #define HV_X86_TIMER_CANCEL              0x10
481 #define HV_X86_TIMER_FIRE                0x11
482 #define HV_X86_TIMER_SCHEDULE            0x12
483 #define HV_X86_APIC_ACCESS_EXIT          0x13
484 #define HV_X86_APIC_WRITE_EXIT           0x14
485 #define HV_X86_EPT_VIOLATION_EXIT        0x15
486 #define HV_X86_EXC_NMI_EXIT              0x16
487 #define HV_X86_HLT_EXIT                  0x17
488 #define HV_X86_IO_EXIT                   0x18
489 #define HV_X86_IRQ_EXIT                  0x19
490 #define HV_X86_IRQ_WND_EXIT              0x1a
491 #define HV_X86_MOV_DR_EXIT               0x1b
492 #define HV_X86_NMI_WND_EXIT              0x1c
493 #define HV_X86_RDMSR_EXIT                0x1d
494 #define HV_X86_RDPMC_EXIT                0x1e
495 #define HV_X86_TPR_THRESHOLD_EXIT        0x1f
496 #define HV_X86_VMX_TIMER_EXPIRED_EXIT    0x20
497 #define HV_X86_WRMSR_EXIT                0x21
498 #define HV_X86_VCPU_READ_APIC_TRAP       0x22
499 #define HV_X86_VCPU_READ_VMCS_TRAP       0x23
500 #define HV_X86_VCPU_RUN_TRAP             0x24
501 #define HV_X86_VCPU_RUN_UNTIL_TRAP       0x25
502 #define HV_X86_VCPU_WRITE_APIC_TRAP      0x26
503 #define HV_X86_VM_ADDRSPACE_CREATE_TRAP  0x27
504 #define HV_X86_VM_ADDRSPACE_DESTROY_TRAP 0x28
505 #define HV_X86_VM_INTR_MSI_TRAP          0x29
506 #define HV_X86_VM_MAP_TRAP               0x2a
507 #define HV_X86_VM_PROTECT_TRAP           0x2b
508 #define HV_X86_VM_UNMAP_TRAP             0x2c
509 #define HV_X86_TSC_OFFSET_SET            0x2d
510 
511 /* **** The Kernel Debug Sub Classes for Network (DBG_NETWORK) **** */
512 #define DBG_NETIP       1       /* Internet Protocol */
513 #define DBG_NETARP      2       /* Address Resolution Protocol */
514 #define DBG_NETUDP      3       /* User Datagram Protocol */
515 #define DBG_NETTCP      4       /* Transmission Control Protocol */
516 #define DBG_NETICMP     5       /* Internet Control Message Protocol */
517 #define DBG_NETIGMP     6       /* Internet Group Management Protocol */
518 #define DBG_NETRIP      7       /* Routing Information Protocol */
519 #define DBG_NETOSPF     8       /* Open Shortest Path First */
520 #define DBG_NETISIS     9       /* Intermediate System to Intermediate System */
521 #define DBG_NETSNMP     10      /* Simple Network Management Protocol */
522 #define DBG_NETSOCK     11      /* Socket Layer */
523 
524 /* For Apple talk */
525 #define DBG_NETAARP     100     /* Apple ARP */
526 #define DBG_NETDDP      101     /* Datagram Delivery Protocol */
527 #define DBG_NETNBP      102     /* Name Binding Protocol */
528 #define DBG_NETZIP      103     /* Zone Information Protocol */
529 #define DBG_NETADSP     104     /* Name Binding Protocol */
530 #define DBG_NETATP      105     /* Apple Transaction Protocol */
531 #define DBG_NETASP      106     /* Apple Session Protocol */
532 #define DBG_NETAFP      107     /* Apple Filing Protocol */
533 #define DBG_NETRTMP     108     /* Routing Table Maintenance Protocol */
534 #define DBG_NETAURP     109     /* Apple Update Routing Protocol */
535 
536 #define DBG_NETIPSEC    128     /* IPsec Protocol  */
537 #define DBG_NETVMNET    129     /* VMNet */
538 
539 /* **** The Kernel Debug Sub Classes for IOKIT (DBG_IOKIT) **** */
540 #define DBG_IOINTC                      0       /* Interrupt controller */
541 #define DBG_IOWORKLOOP                  1       /* Work from work loop */
542 #define DBG_IOINTES                     2       /* Interrupt event source */
543 #define DBG_IOCLKES                     3       /* Clock event source */
544 #define DBG_IOCMDQ                      4       /* Command queue latencies */
545 #define DBG_IOMCURS                     5       /* Memory Cursor */
546 #define DBG_IOMDESC                     6       /* Memory Descriptors */
547 #define DBG_IOPOWER                     7       /* Power Managerment */
548 #define DBG_IOSERVICE                   8       /* Matching etc. */
549 #define DBG_IOREGISTRY                  9       /* Registry */
550 
551 /* **** 9-32 reserved for internal IOKit usage **** */
552 
553 #define DBG_IOSTORAGE           32      /* Storage layers */
554 #define DBG_IONETWORK           33      /* Network layers */
555 #define DBG_IOKEYBOARD          34      /* Keyboard */
556 #define DBG_IOHID               35      /* HID Devices */
557 #define DBG_IOAUDIO             36      /* Audio */
558 #define DBG_IOSERIAL            37      /* Serial */
559 #define DBG_IOTTY               38      /* TTY layers */
560 #define DBG_IOSAM               39      /* SCSI Architecture Model layers */
561 #define DBG_IOPARALLELATA       40      /* Parallel ATA */
562 #define DBG_IOPARALLELSCSI      41      /* Parallel SCSI */
563 #define DBG_IOSATA              42      /* Serial-ATA */
564 #define DBG_IOSAS               43      /* SAS */
565 #define DBG_IOFIBRECHANNEL      44      /* FiberChannel */
566 #define DBG_IOUSB               45      /* USB */
567 #define DBG_IOBLUETOOTH         46      /* Bluetooth */
568 #define DBG_IOFIREWIRE          47      /* FireWire */
569 #define DBG_IOINFINIBAND        48      /* Infiniband */
570 #define DBG_IOCPUPM             49      /* CPU Power Management */
571 #define DBG_IOGRAPHICS          50      /* Graphics */
572 #define DBG_HIBERNATE           51      /* hibernation related events */
573 #define DBG_IOTHUNDERBOLT       52      /* Thunderbolt */
574 #define DBG_BOOTER              53      /* booter related events */
575 #define DBG_IOAUDIO2            54      /* Audio (extended) */
576 
577 #define DBG_IOSURFACEPA         64      /* IOSurface page mappings */
578 #define DBG_IOMDPA              65      /* IOMemoryDescriptor page mappings */
579 #define DBG_IODARTPA            66      /* DART page mappings */
580 /* **** 67-79 reserved for physical address mapping information **** */
581 
582 /* Backwards compatibility */
583 #define DBG_IOPOINTING          DBG_IOHID                       /* OBSOLETE: Use DBG_IOHID instead */
584 #define DBG_IODISK                      DBG_IOSTORAGE           /* OBSOLETE: Use DBG_IOSTORAGE instead */
585 
586 /* **** The Kernel Debug Sub Classes for Device Drivers (DBG_DRIVERS) **** */
587 #define DBG_DRVSTORAGE        1 /* Storage layers */
588 #define DBG_DRVNETWORK        2 /* Network layers */
589 #define DBG_DRVKEYBOARD       3 /* Keyboard */
590 #define DBG_DRVHID            4 /* HID Devices */
591 #define DBG_DRVAUDIO          5 /* Audio */
592 #define DBG_DRVSERIAL         7 /* Serial */
593 #define DBG_DRVSAM            8 /* SCSI Architecture Model layers */
594 #define DBG_DRVPARALLELATA    9 /* Parallel ATA */
595 #define DBG_DRVPARALLELSCSI  10 /* Parallel SCSI */
596 #define DBG_DRVSATA          11 /* Serial ATA */
597 #define DBG_DRVSAS           12 /* SAS */
598 #define DBG_DRVFIBRECHANNEL  13 /* FiberChannel */
599 #define DBG_DRVUSB           14 /* USB */
600 #define DBG_DRVBLUETOOTH     15 /* Bluetooth */
601 #define DBG_DRVFIREWIRE      16 /* FireWire */
602 #define DBG_DRVINFINIBAND    17 /* Infiniband */
603 #define DBG_DRVGRAPHICS      18 /* Graphics */
604 #define DBG_DRVSD            19 /* Secure Digital */
605 #define DBG_DRVNAND          20 /* NAND drivers and layers */
606 #define DBG_SSD              21 /* SSD */
607 #define DBG_DRVSPI           22 /* SPI */
608 #define DBG_DRVWLAN_802_11   23 /* WLAN 802.11 */
609 #define DBG_DRVSSM           24 /* System State Manager(AppleSSM) */
610 #define DBG_DRVSMC           25 /* System Management Controller */
611 #define DBG_DRVMACEFIMANAGER 26 /* Mac EFI Manager */
612 #define DBG_DRVANE           27 /* ANE */
613 #define DBG_DRVETHERNET      28 /* Ethernet */
614 #define DBG_DRVMCC           29 /* Memory Cache Controller */
615 #define DBG_DRVACCESSORY     30 /* Accessories */
616 #define DBG_SOCDIAGS         31 /* SoC Diagnostics */
617 
618 /* Backwards compatibility */
619 #define DBG_DRVPOINTING         DBG_DRVHID      /* OBSOLETE: Use DBG_DRVHID instead */
620 #define DBG_DRVDISK             DBG_DRVSTORAGE  /* OBSOLETE: Use DBG_DRVSTORAGE instead */
621 
622 /* **** The Kernel Debug Sub Classes for the DLIL Layer (DBG_DLIL) **** */
623 #define DBG_DLIL_STATIC 1       /* Static DLIL code */
624 #define DBG_DLIL_PR_MOD 2       /* DLIL Protocol Module */
625 #define DBG_DLIL_IF_MOD 3       /* DLIL Interface Module */
626 #define DBG_DLIL_PR_FLT 4       /* DLIL Protocol Filter */
627 #define DBG_DLIL_IF_FLT 5       /* DLIL Interface FIlter */
628 
629 /* The Kernel Debug Sub Classes for File System (DBG_FSYSTEM) */
630 #define DBG_FSRW      0x1     /* reads and writes to the filesystem */
631 #define DBG_DKRW      0x2     /* reads and writes to the disk */
632 #define DBG_FSVN      0x3     /* vnode operations (inc. locking/unlocking) */
633 #define DBG_FSLOOOKUP 0x4     /* namei and other lookup-related operations */
634 #define DBG_JOURNAL   0x5     /* journaling operations */
635 #define DBG_IOCTL     0x6     /* ioctl to the disk */
636 #define DBG_BOOTCACHE 0x7     /* bootcache operations */
637 #define DBG_HFS       0x8     /* HFS-specific events; see the hfs project */
638 #define DBG_APFS      0x9     /* APFS-specific events; see the apfs project */
639 #define DBG_SMB       0xA     /* SMB-specific events; see the smb project */
640 #define DBG_MOUNT     0xB     /* Mounting/unmounting operations */
641 #define DBG_EXFAT     0xE     /* ExFAT-specific events; see the exfat project */
642 #define DBG_MSDOS     0xF     /* FAT-specific events; see the msdosfs project */
643 #define DBG_ACFS      0x10    /* Xsan-specific events; see the XsanFS project */
644 #define DBG_THROTTLE  0x11    /* I/O Throttling events */
645 #define DBG_DECMP     0x12    /* Decmpfs-specific events */
646 #define DBG_VFS       0x13    /* VFS layer events */
647 #define DBG_LIVEFS    0x14    /* LiveFS events; see the UserFS project */
648 #define DBG_CONTENT_PROT 0xCF /* Content Protection Events: see bsd/sys/cprotect.h */
649 
650 /*
651  * For Kernel Debug Sub Class DBG_HFS, state bits for hfs_update event
652  */
653 #define DBG_HFS_UPDATE_ACCTIME   0x01
654 #define DBG_HFS_UPDATE_MODTIME   0x02
655 #define DBG_HFS_UPDATE_CHGTIME   0x04
656 #define DBG_HFS_UPDATE_MODIFIED  0x08
657 #define DBG_HFS_UPDATE_FORCE     0x10
658 #define DBG_HFS_UPDATE_DATEADDED 0x20
659 #define DBG_HFS_UPDATE_MINOR     0x40
660 #define DBG_HFS_UPDATE_SKIPPED   0x80
661 
662 /*
663  * Codes for Kernel Debug Sub Class DBG_VFS
664  */
665 #define DBG_VFS_IO_COMPRESSION_STATS 0x1000
666 
667 /* The Kernel Debug Sub Classes for BSD */
668 #define DBG_BSD_PROC              0x01 /* process/signals related */
669 #define DBG_BSD_MEMSTAT           0x02 /* memorystatus / jetsam operations */
670 #define DBG_BSD_KEVENT            0x03 /* kqueue / kevent related */
671 #define DBG_BSD_EXCP_SC           0x0C /* System Calls */
672 #define DBG_BSD_AIO               0x0D /* aio (POSIX async IO) */
673 #define DBG_BSD_SC_EXTENDED_INFO  0x0E /* System Calls, extended info */
674 #define DBG_BSD_SC_EXTENDED_INFO2 0x0F /* System Calls, extended info */
675 #define DBG_BSD_KDEBUG_TEST       0xFF /* for testing kdebug */
676 
677 /* The Codes for BSD subcode class DBG_BSD_PROC */
678 #define BSD_PROC_EXIT              1  /* process exit */
679 #define BSD_PROC_FRCEXIT           2  /* Kernel force termination */
680 #define BSD_PROC_EXEC              3  /* process spawn / exec */
681 #define BSD_PROC_EXITREASON_CREATE 4  /* exit reason creation */
682 #define BSD_PROC_EXITREASON_COMMIT 5  /* exit reason commited to a proc */
683 
684 /* Codes for BSD subcode class DBG_BSD_MEMSTAT */
685 #define BSD_MEMSTAT_SCAN             1  /* memorystatus thread awake */
686 #define BSD_MEMSTAT_JETSAM           2  /* LRU jetsam */
687 #define BSD_MEMSTAT_JETSAM_HIWAT     3  /* highwater jetsam */
688 #define BSD_MEMSTAT_FREEZE           4  /* freeze process */
689 #define BSD_MEMSTAT_FREEZE_SCAN      5  /* select a process to freeze and freeze it */
690 #define BSD_MEMSTAT_UPDATE           6  /* priority update */
691 #define BSD_MEMSTAT_IDLE_DEMOTE      7  /* idle demotion fired */
692 #define BSD_MEMSTAT_CLEAR_ERRORS     8  /* reset termination error state */
693 #define BSD_MEMSTAT_DIRTY_TRACK      9  /* track the process state */
694 #define BSD_MEMSTAT_DIRTY_SET       10  /* set the process state */
695 #define BSD_MEMSTAT_DIRTY_CLEAR     11  /* clear the process state */
696 #ifdef  PRIVATE
697 #define BSD_MEMSTAT_GRP_SET_PROP    12  /* set group properties */
698 #define BSD_MEMSTAT_DO_KILL         13  /* memorystatus kills */
699 #define BSD_MEMSTAT_CHANGE_PRIORITY 14  /* priority changed */
700 #endif /* PRIVATE */
701 #define BSD_MEMSTAT_FAST_JETSAM     15  /* Aggressive jetsam ("clear-the-deck") */
702 #define BSD_MEMSTAT_COMPACTOR_RUN   16  /* run VM compactor after process kill */
703 #define BSD_MEMSTAT_FREEZE_DISABLE  17  /* disable freeze and kill frozen processes */
704 #define BSD_MEMSTAT_RELAUNCH_FLAGS  18  /* flags representing jetsam behavior; based on launchd data */
705 
706 /* Codes for BSD subcode class DBG_BSD_KEVENT */
707 #define BSD_KEVENT_KQ_PROCESS_BEGIN   1
708 #define BSD_KEVENT_KQ_PROCESS_END     2
709 #define BSD_KEVENT_KQWQ_PROCESS_BEGIN 3
710 #define BSD_KEVENT_KQWQ_PROCESS_END   4
711 #define BSD_KEVENT_KQWQ_BIND          5
712 #define BSD_KEVENT_KQWQ_UNBIND        6
713 #define BSD_KEVENT_KQWQ_THREQUEST     7
714 #define BSD_KEVENT_KQWL_PROCESS_BEGIN 8
715 #define BSD_KEVENT_KQWL_PROCESS_END   9
716 #define BSD_KEVENT_KQWL_THREQUEST     10
717 #define BSD_KEVENT_KQWL_THADJUST      11
718 #define BSD_KEVENT_KQ_REGISTER        12
719 #define BSD_KEVENT_KQWQ_REGISTER      13
720 #define BSD_KEVENT_KQWL_REGISTER      14
721 #define BSD_KEVENT_KNOTE_ACTIVATE     15
722 #define BSD_KEVENT_KQ_PROCESS         16
723 #define BSD_KEVENT_KQWQ_PROCESS       17
724 #define BSD_KEVENT_KQWL_PROCESS       18
725 #define BSD_KEVENT_KQWL_BIND          19
726 #define BSD_KEVENT_KQWL_UNBIND        20
727 #define BSD_KEVENT_KNOTE_ENABLE       21
728 #define BSD_KEVENT_KNOTE_VANISHED     22
729 
730 /* The Kernel Debug Sub Classes for DBG_TRACE */
731 #define DBG_TRACE_DATA      0
732 #define DBG_TRACE_STRING    1
733 #define DBG_TRACE_INFO      2
734 
735 /* The Kernel Debug events: */
736 #define TRACE_DATA_NEWTHREAD            (TRACEDBG_CODE(DBG_TRACE_DATA, 1))
737 #define TRACE_DATA_EXEC                 (TRACEDBG_CODE(DBG_TRACE_DATA, 2))
738 #define TRACE_DATA_THREAD_TERMINATE     (TRACEDBG_CODE(DBG_TRACE_DATA, 3))
739 #define TRACE_DATA_THREAD_TERMINATE_PID (TRACEDBG_CODE(DBG_TRACE_DATA, 4))
740 #define TRACE_STRING_GLOBAL             (TRACEDBG_CODE(DBG_TRACE_STRING, 0))
741 #define TRACE_STRING_NEWTHREAD          (TRACEDBG_CODE(DBG_TRACE_STRING, 1))
742 #define TRACE_STRING_EXEC               (TRACEDBG_CODE(DBG_TRACE_STRING, 2))
743 #define TRACE_STRING_PROC_EXIT          (TRACEDBG_CODE(DBG_TRACE_STRING, 3))
744 #define TRACE_STRING_THREADNAME         (TRACEDBG_CODE(DBG_TRACE_STRING, 4))
745 #define TRACE_STRING_THREADNAME_PREV    (TRACEDBG_CODE(DBG_TRACE_STRING, 5))
746 #define TRACE_PANIC                     (TRACEDBG_CODE(DBG_TRACE_INFO, 0))
747 #define TRACE_TIMESTAMPS                (TRACEDBG_CODE(DBG_TRACE_INFO, 1))
748 #define TRACE_LOST_EVENTS               (TRACEDBG_CODE(DBG_TRACE_INFO, 2))
749 #define TRACE_WRITING_EVENTS            (TRACEDBG_CODE(DBG_TRACE_INFO, 3))
750 #define TRACE_INFO_STRING               (TRACEDBG_CODE(DBG_TRACE_INFO, 4))
751 #define TRACE_RETROGRADE_EVENTS         (TRACEDBG_CODE(DBG_TRACE_INFO, 5))
752 
753 /* The Kernel Debug Sub Classes for DBG_CORESTORAGE */
754 #define DBG_CS_IO       0
755 
756 /* The Kernel Debug Sub Classes for DBG_SECURITY */
757 #define DBG_SEC_KERNEL  0 /* raw entropy collected by the kernel */
758 #define DBG_SEC_SANDBOX 1
759 
760 /* Sub-class codes for CoreGraphics (DBG_CG) are defined in its component. */
761 
762 /* The Kernel Debug Sub Classes for DBG_MONOTONIC */
763 #define DBG_MT_INSTRS_CYCLES 1
764 #define DBG_MT_DEBUG 2
765 #define DBG_MT_RESOURCES_PROC_EXIT 3
766 #define DBG_MT_RESOURCES_THR_EXIT 4
767 #define DBG_MT_TMPTH 0xfe
768 #define DBG_MT_TMPCPU 0xff
769 
770 /* Kernel Debug events for the DBG_MT_RESOURCES_PROC_EXIT subclass */
771 #define DBG_MT_INSTRS_CYCLES_PROC_EXIT MTDBG_RESOURCES_ON_PROC_EXIT(0)
772 
773 /* Kernel Debug events for the DBG_MT_RESOURCES_THR_EXIT subclass */
774 #define DBG_MT_INSTRS_CYCLES_THR_EXIT  MTDBG_RESOURCES_ON_THR_EXIT(0)
775 
776 /* The Kernel Debug Sub Classes for DBG_MISC */
777 #define DBG_MISC_COREBRIGHTNESS 0x01
778 #define DBG_MISC_VIDEOENG       0x02
779 #define DBG_EVENT               0x10
780 #define DBG_MISC_INSTRUMENTS    0x11
781 #define DBG_MISC_INSTRUMENTSBT  0x12
782 #define DBG_MISC_LAYOUT         0x1a
783 #define DBG_BUFFER              0x20
784 
785 /* The Kernel Debug Sub Classes for DBG_DYLD */
786 #define DBG_DYLD_UUID (5)
787 
788 /* Kernel Debug codes for the DBG_DYLD_UUID subclass */
789 #define DBG_DYLD_UUID_MAP_A             (0)
790 #define DBG_DYLD_UUID_MAP_B             (1)
791 #define DBG_DYLD_UUID_MAP_32_A          (2)
792 #define DBG_DYLD_UUID_MAP_32_B          (3)
793 #define DBG_DYLD_UUID_MAP_32_C          (4)
794 #define DBG_DYLD_UUID_UNMAP_A           (5)
795 #define DBG_DYLD_UUID_UNMAP_B           (6)
796 #define DBG_DYLD_UUID_UNMAP_32_A        (7)
797 #define DBG_DYLD_UUID_UNMAP_32_B        (8)
798 #define DBG_DYLD_UUID_UNMAP_32_C        (9)
799 #define DBG_DYLD_UUID_SHARED_CACHE_A    (10)
800 #define DBG_DYLD_UUID_SHARED_CACHE_B    (11)
801 #define DBG_DYLD_UUID_SHARED_CACHE_32_A (12)
802 #define DBG_DYLD_UUID_SHARED_CACHE_32_B (13)
803 #define DBG_DYLD_UUID_SHARED_CACHE_32_C (14)
804 #define DBG_DYLD_AOT_UUID_MAP_A         (15)
805 #define DBG_DYLD_AOT_UUID_MAP_B         (16)
806 
807 /* The Kernel Debug modifiers for the DBG_DKRW sub class */
808 #define DKIO_DONE       0x01
809 #define DKIO_READ       0x02
810 #define DKIO_ASYNC      0x04
811 #define DKIO_META       0x08
812 #define DKIO_PAGING     0x10
813 #define DKIO_THROTTLE   0x20 /* Deprecated, still provided so fs_usage doesn't break */
814 #define DKIO_PASSIVE    0x40
815 #define DKIO_NOCACHE    0x80
816 #define DKIO_TIER_MASK  0xF00
817 #define DKIO_TIER_SHIFT 8
818 #define DKIO_TIER_UPGRADE 0x1000
819 
820 /* Kernel Debug Sub Classes for Applications (DBG_APPS) */
821 #define DBG_APP_LOGINWINDOW     0x03
822 #define DBG_APP_AUDIO           0x04
823 #define DBG_APP_SYSTEMUI        0x05
824 #define DBG_APP_SIGNPOST        0x0A
825 #define DBG_APP_APPKIT          0x0C
826 #define DBG_APP_UIKIT           0x0D
827 #define DBG_APP_DFR             0x0E
828 #define DBG_APP_LAYOUT          0x0F
829 #define DBG_APP_COREDATA        0x10
830 #define DBG_APP_SAMBA           0x80
831 #define DBG_APP_EOSSUPPORT      0x81
832 #define DBG_APP_MACEFIMANAGER   0x82
833 
834 /* Kernel Debug codes for Throttling (DBG_THROTTLE) */
835 #define OPEN_THROTTLE_WINDOW    0x1
836 #define PROCESS_THROTTLED       0x2
837 #define IO_THROTTLE_DISABLE     0x3
838 #define IO_TIER_UPL_MISMATCH    0x4
839 
840 /* Subclasses for MACH Importance Policies (DBG_IMPORTANCE) */
841 /* TODO: Split up boost and task policy? */
842 #define IMP_ASSERTION                       0x10    /* Task takes/drops a boost assertion */
843 #define IMP_BOOST                           0x11    /* Task boost level changed */
844 #define IMP_MSG                             0x12    /* boosting message sent by donating task on donating port */
845 #define IMP_WATCHPORT                       0x13    /* port marked as watchport, and boost was transferred to the watched task */
846 #define IMP_TASK_SUPPRESSION                0x17    /* Task changed suppression behaviors */
847 #define IMP_TASK_APPTYPE                    0x18    /* Task launched with apptype */
848 #define IMP_UPDATE                          0x19    /* Requested -> effective calculation */
849 #define IMP_USYNCH_QOS_OVERRIDE             0x1A    /* Userspace synchronization applied QoS override to resource owning thread */
850 #define IMP_DONOR_CHANGE                    0x1B    /* The iit_donor bit changed */
851 #define IMP_MAIN_THREAD_QOS                 0x1C    /* The task's main thread QoS was set */
852 #define IMP_SYNC_IPC_QOS                    0x1D    /* Sync IPC QOS override */
853 /* DBG_IMPORTANCE subclasses  0x20 - 0x3F are reserved for task policy flavors */
854 
855 /* thread and task attributes */
856 #define IMP_TASK_POLICY_DARWIN_BG           0x21
857 #define IMP_TASK_POLICY_IOPOL               0x22
858 #define IMP_TASK_POLICY_IO                  0x23
859 #define IMP_TASK_POLICY_PASSIVE_IO          0x24
860 
861 /* task only attributes */
862 #define IMP_TASK_POLICY_DARWIN_BG_IOPOL     0x27
863 /* unused, was IMP_TASK_POLICY_TAL          0x28 */
864 #define IMP_TASK_POLICY_BOOST               0x29
865 #define IMP_TASK_POLICY_ROLE                0x2A
866 /* unused                                   0x2B */
867 #define IMP_TASK_POLICY_TERMINATED          0x2C
868 #define IMP_TASK_POLICY_NEW_SOCKETS_BG      0x2D
869 #define IMP_TASK_POLICY_SUP_ACTIVE          0x2E
870 #define IMP_TASK_POLICY_LATENCY_QOS         0x2F
871 #define IMP_TASK_POLICY_THROUGH_QOS         0x30
872 #define IMP_TASK_POLICY_WATCHERS_BG         0x31
873 
874 #define IMP_TASK_POLICY_SFI_MANAGED         0x34
875 #define IMP_TASK_POLICY_ALL_SOCKETS_BG      0x37
876 
877 #define IMP_TASK_POLICY_BASE_LATENCY_AND_THROUGHPUT_QOS  0x39 /* latency as value1, throughput as value2 */
878 #define IMP_TASK_POLICY_OVERRIDE_LATENCY_AND_THROUGHPUT_QOS  0x3A /* latency as value1, throughput as value2 */
879 
880 /* thread only attributes */
881 #define IMP_TASK_POLICY_PIDBIND_BG          0x32
882 /* unused                                   0x33 */
883 /* reserved                                 0x35 */
884 #define IMP_TASK_POLICY_QOS_OVERRIDE        0x36
885 #define IMP_TASK_POLICY_QOS_AND_RELPRIO     0x38 /* QoS as value1, relative priority as value2 */
886 #define IMP_TASK_POLICY_QOS_WORKQ_OVERRIDE  0x3B
887 #define IMP_TASK_POLICY_QOS_PROMOTE         0x3C
888 #define IMP_TASK_POLICY_QOS_KEVENT_OVERRIDE 0x3D
889 #define IMP_TASK_POLICY_QOS_IPC_OVERRIDE    IMP_TASK_POLICY_QOS_KEVENT_OVERRIDE /* legacy name */
890 #define IMP_TASK_POLICY_QOS_SERVICER_OVERRIDE 0x3E
891 #define IMP_TASK_POLICY_IOTIER_KEVENT_OVERRIDE 0x3F
892 
893 /* Codes for IMP_ASSERTION */
894 #define IMP_HOLD                0x2     /* Task holds a boost assertion */
895 #define IMP_DROP                0x4     /* Task drops a boost assertion */
896 #define IMP_EXTERN              0x8     /* boost assertion moved from kernel to userspace responsibility (externalized) */
897 
898 /* Codes for IMP_BOOST */
899 #define IMP_BOOSTED             0x1
900 #define IMP_UNBOOSTED           0x2     /* Task drops a boost assertion */
901 
902 /* Codes for IMP_MSG */
903 #define IMP_MSG_SEND            0x1     /* boosting message sent by donating task on donating port */
904 #define IMP_MSG_DELV            0x2     /* boosting message delivered to task */
905 
906 /* Codes for IMP_UPDATE */
907 #define IMP_UPDATE_TASK_CREATE  0x1
908 
909 /* Codes for IMP_USYNCH_QOS_OVERRIDE */
910 #define IMP_USYNCH_ADD_OVERRIDE         0x0             /* add override for a contended resource */
911 #define IMP_USYNCH_REMOVE_OVERRIDE      0x1             /* remove override for a contended resource */
912 
913 /* Codes for IMP_DONOR_CHANGE */
914 #define IMP_DONOR_UPDATE_LIVE_DONOR_STATE       0x0
915 #define IMP_DONOR_INIT_DONOR_STATE              0x1
916 
917 /* Code for IMP_SYNC_IPC_QOS */
918 #define IMP_SYNC_IPC_QOS_APPLIED                0x0
919 #define IMP_SYNC_IPC_QOS_REMOVED                0x1
920 #define IMP_SYNC_IPC_QOS_OVERFLOW               0x2
921 #define IMP_SYNC_IPC_QOS_UNDERFLOW              0x3
922 
923 /* Subclasses for Turnstiles (DBG_TURNSTILE) */
924 #define TURNSTILE_HEAP_OPERATIONS               0x10
925 #define TURNSTILE_PRIORITY_OPERATIONS           0x20
926 #define TURNSTILE_FREELIST_OPERATIONS           0x30
927 
928 /* Codes for TURNSTILE_HEAP_OPERATIONS */
929 #define THREAD_ADDED_TO_TURNSTILE_WAITQ         0x1
930 #define THREAD_REMOVED_FROM_TURNSTILE_WAITQ     0x2
931 #define THREAD_MOVED_IN_TURNSTILE_WAITQ         0x3
932 #define TURNSTILE_ADDED_TO_TURNSTILE_HEAP       0x4
933 #define TURNSTILE_REMOVED_FROM_TURNSTILE_HEAP   0x5
934 #define TURNSTILE_MOVED_IN_TURNSTILE_HEAP       0x6
935 #define TURNSTILE_ADDED_TO_THREAD_HEAP          0x7
936 #define TURNSTILE_REMOVED_FROM_THREAD_HEAP      0x8
937 #define TURNSTILE_MOVED_IN_THREAD_HEAP          0x9
938 #define TURNSTILE_UPDATE_STOPPED_BY_LIMIT       0xa
939 #define THREAD_NOT_WAITING_ON_TURNSTILE         0xb
940 
941 /* Codes for TURNSTILE_PRIORITY_OPERATIONS */
942 #define TURNSTILE_PRIORITY_CHANGE               0x1
943 #define THREAD_USER_PROMOTION_CHANGE            0x2
944 
945 /* Codes for TURNSTILE_FREELIST_OPERATIONS */
946 #define TURNSTILE_PREPARE                       0x1
947 #define TURNSTILE_COMPLETE                      0x2
948 
949 /* Subclasses for MACH Bank Voucher Attribute Manager (DBG_BANK) */
950 #define BANK_ACCOUNT_INFO               0x10    /* Trace points related to bank account struct */
951 #define BANK_TASK_INFO                  0x11    /* Trace points related to bank task struct */
952 
953 /* Subclasses for MACH ATM Voucher Attribute Manager (ATM) */
954 #define ATM_SUBAID_INFO                 0x10
955 #define ATM_GETVALUE_INFO               0x20
956 #define ATM_UNREGISTER_INFO             0x30
957 
958 /* Codes for BANK_ACCOUNT_INFO */
959 #define BANK_SETTLE_CPU_TIME            0x1     /* Bank ledger(chit) rolled up to tasks. */
960 #define BANK_SECURE_ORIGINATOR_CHANGED  0x2     /* Secure Originator changed. */
961 #define BANK_SETTLE_ENERGY              0x3     /* Bank ledger(energy field) rolled up to tasks. */
962 
963 /* Codes for ATM_SUBAID_INFO */
964 #define ATM_MIN_CALLED                          0x1
965 #define ATM_LINK_LIST_TRIM                      0x2
966 
967 /* Codes for ATM_GETVALUE_INFO */
968 #define ATM_VALUE_REPLACED                      0x1
969 #define ATM_VALUE_ADDED                         0x2
970 
971 /* Codes for ATM_UNREGISTER_INFO */
972 #define ATM_VALUE_UNREGISTERED                  0x1
973 #define ATM_VALUE_DIFF_MAILBOX                  0x2
974 
975 /* Kernel Debug Sub Classes for daemons (DBG_DAEMON) */
976 #define DBG_DAEMON_COREDUET 0x1
977 #define DBG_DAEMON_POWERD   0x2
978 
979 /* Subclasses for the user space allocator */
980 #define DBG_UMALLOC_EXTERNAL                    0x1
981 #define DBG_UMALLOC_INTERNAL                    0x2
982 
983 /**********************************************************************/
984 
985 #define KDBG_MIGCODE(msgid) (((unsigned)DBG_MIG << KDBG_CLASS_OFFSET) | \
986 	                     ((unsigned)((msgid) & 0x3fffff) << KDBG_CODE_OFFSET))
987 
988 #define MACHDBG_CODE(SubClass, code) KDBG_CODE(DBG_MACH, SubClass, code)
989 #define NETDBG_CODE(SubClass, code) KDBG_CODE(DBG_NETWORK, SubClass, code)
990 #define FSDBG_CODE(SubClass, code) KDBG_CODE(DBG_FSYSTEM, SubClass, code)
991 #define BSDDBG_CODE(SubClass, code) KDBG_CODE(DBG_BSD, SubClass, code)
992 #define IOKDBG_CODE(SubClass, code) KDBG_CODE(DBG_IOKIT, SubClass, code)
993 #define DRVDBG_CODE(SubClass, code) KDBG_CODE(DBG_DRIVERS, SubClass, code)
994 #define TRACEDBG_CODE(SubClass, code) KDBG_CODE(DBG_TRACE, SubClass, code)
995 #define SILICONDBG_CODE(SubClass, code) KDBG_CODE(DBG_SILICON, SubClass, code)
996 #define MISCDBG_CODE(SubClass, code) KDBG_CODE(DBG_MISC, SubClass, code)
997 #define DLILDBG_CODE(SubClass, code) KDBG_CODE(DBG_DLIL, SubClass, code)
998 #define SECURITYDBG_CODE(SubClass, code) KDBG_CODE(DBG_SECURITY, SubClass, code)
999 #define DYLDDBG_CODE(SubClass, code) KDBG_CODE(DBG_DYLD, SubClass, code)
1000 #define QTDBG_CODE(SubClass, code) KDBG_CODE(DBG_QT, SubClass, code)
1001 #define APPSDBG_CODE(SubClass, code) KDBG_CODE(DBG_APPS, SubClass, code)
1002 #define ARIADNEDBG_CODE(SubClass, code) KDBG_CODE(DBG_ARIADNE, SubClass, code)
1003 #define DAEMONDBG_CODE(SubClass, code) KDBG_CODE(DBG_DAEMON, SubClass, code)
1004 #define CPUPM_CODE(code) IOKDBG_CODE(DBG_IOCPUPM, code)
1005 #define MTDBG_CODE(SubClass, code) KDBG_CODE(DBG_MONOTONIC, SubClass, code)
1006 #define MTDBG_RESOURCES_ON_PROC_EXIT(code) MTDBG_CODE(DBG_MT_RESOURCES_PROC_EXIT, code)
1007 #define MTDBG_RESOURCES_ON_THR_EXIT(code) MTDBG_CODE(DBG_MT_RESOURCES_THR_EXIT, code)
1008 
1009 #define KMEM_ALLOC_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 0)
1010 #define KMEM_ALLOC_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 1)
1011 #define KMEM_FREE_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 2)
1012 #define KMEM_FREE_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 3)
1013 #define ZALLOC_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 4)
1014 #define ZALLOC_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 5)
1015 #define ZFREE_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 6)
1016 #define ZFREE_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 7)
1017 
1018 #define PMAP_CODE(code) MACHDBG_CODE(DBG_MACH_PMAP, code)
1019 
1020 #define IMPORTANCE_CODE(SubClass, code) KDBG_CODE(DBG_IMPORTANCE, (SubClass), (code))
1021 #define BANK_CODE(SubClass, code) KDBG_CODE(DBG_BANK, (SubClass), (code))
1022 #define ATM_CODE(SubClass, code) KDBG_CODE(DBG_ATM, (SubClass), (code))
1023 #define TURNSTILE_CODE(SubClass, code) KDBG_CODE(DBG_TURNSTILE, (SubClass), (code))
1024 
1025 /* Kernel Debug Macros for specific daemons */
1026 #define COREDUETDBG_CODE(code) DAEMONDBG_CODE(DBG_DAEMON_COREDUET, code)
1027 #define POWERDDBG_CODE(code) DAEMONDBG_CODE(DBG_DAEMON_POWERD, code)
1028 
1029 /* VFS lookup events for serial traces */
1030 #define VFS_LOOKUP      (FSDBG_CODE(DBG_FSRW,36))
1031 #define VFS_LOOKUP_DONE (FSDBG_CODE(DBG_FSRW,39))
1032 
1033 #endif /* __APPLE_API_UNSTABLE */
1034 
1035 __END_DECLS
1036 
1037 #if defined(KERNEL) || defined(PRIVATE)
1038 #include <sys/kdebug_private.h>
1039 #endif /* defined(KERNEL) || defined(PRIVATE) */
1040 
1041 #ifdef KERNEL
1042 #include <sys/kdebug_kernel.h>
1043 #endif /* defined(KERNEL) */
1044 
1045 #endif /* !defined(BSD_SYS_KDEBUG_H) */
1046