bsd/sys/kdebug.h

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