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