/*
- * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
+ * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
*
* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
- *
+ *
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* unlawful or unlicensed copies of an Apple operating system, or to
* circumvent, violate, or enable the circumvention or violation of, any
* terms of an Apple operating system software license agreement.
- *
+ *
* Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this file.
- *
+ *
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
- *
+ *
* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
-/* Copyright (c) 1997 Apple Computer, Inc. All rights reserved.
- *
- * kdebug.h - kernel_debug definitions
- *
+/*
+ * kdebug.h - kernel_debug definitions
*/
#ifndef BSD_SYS_KDEBUG_H
#include <sys/appleapiopts.h>
#include <sys/cdefs.h>
+
__BEGIN_DECLS
#ifdef __APPLE_API_UNSTABLE
#include <mach/clock_types.h>
#include <stdint.h>
-#if defined(KERNEL_BUILD)
-#include <kdebug.h>
-#endif /* KERNEL_BUILD */
+
+#ifndef KERNEL
+#include <Availability.h>
+#endif
+
+#ifdef XNU_KERNEL_PRIVATE
+#include <mach/branch_predicates.h> /* __improbable */
+#endif
/*
- * types of faults that vm_fault handles
- * and creates trace entries for
+ * Kdebug is a facility for tracing events occurring on a system.
+ *
+ * All events are tagged with a 32-bit debugid:
+ *
+ * +----------------+----------------+----------------------------+----+
+ * | Class (8) | Subclass (8) | Code (14) |Func|
+ * | | | |(2) |
+ * +----------------+----------------+----------------------------+----+
+ * \_________________________________/
+ * ClassSubclass (CSC)
+ * \________________________________________________________________00_/
+ * Eventid
+ * \___________________________________________________________________/
+ * Debugid
+ *
+ * The eventid is a hierarchical ID, indicating which components an event is
+ * referring to. The debugid includes an eventid and two function qualifier
+ * bits, to determine the structural significance of an event (whether it
+ * starts or ends an interval).
*/
-#define DBG_ZERO_FILL_FAULT 1
-#define DBG_PAGEIN_FAULT 2
-#define DBG_COW_FAULT 3
-#define DBG_CACHE_HIT_FAULT 4
-#define DBG_NZF_PAGE_FAULT 5
-#define DBG_GUARD_FAULT 6
-#define DBG_PAGEINV_FAULT 7
-#define DBG_PAGEIND_FAULT 8
+#define KDBG_CLASS_MASK (0xff000000)
+#define KDBG_CLASS_OFFSET (24)
+#define KDBG_CLASS_MAX (0xff)
+
+#define KDBG_SUBCLASS_MASK (0x00ff0000)
+#define KDBG_SUBCLASS_OFFSET (16)
+#define KDBG_SUBCLASS_MAX (0xff)
+
+/* class and subclass mask */
+#define KDBG_CSC_MASK (0xffff0000)
+#define KDBG_CSC_OFFSET (KDBG_SUBCLASS_OFFSET)
+#define KDBG_CSC_MAX (0xffff)
+
+#define KDBG_CODE_MASK (0x0000fffc)
+#define KDBG_CODE_OFFSET (2)
+#define KDBG_CODE_MAX (0x3fff)
+
+#define KDBG_EVENTID_MASK (0xfffffffc)
+#define KDBG_FUNC_MASK (0x00000003)
+
+/* Generate an eventid corresponding to Class, SubClass, and Code. */
+#define KDBG_EVENTID(Class, SubClass, Code) \
+ ((((Class) & 0xff) << KDBG_CLASS_OFFSET) | \
+ (((SubClass) & 0xff) << KDBG_SUBCLASS_OFFSET) | \
+ (((Code) & 0x3fff) << KDBG_CODE_OFFSET))
+/* Deprecated macro using old naming convention. */
+#define KDBG_CODE(Class, SubClass, Code) \
+ KDBG_EVENTID(Class, SubClass, Code)
+
+/* Extract pieces of the debug code. */
+#define KDBG_EXTRACT_CLASS(Debugid) \
+ ((uint8_t)(((Debugid) & KDBG_CLASS_MASK) >> KDBG_CLASS_OFFSET))
+#define KDBG_EXTRACT_SUBCLASS(Debugid) \
+ ((uint8_t)(((Debugid) & KDBG_SUBCLASS_MASK) >> KDBG_SUBCLASS_OFFSET))
+#define KDBG_EXTRACT_CSC(Debugid) \
+ ((uint16_t)(((Debugid) & KDBG_CSC_MASK) >> KDBG_CSC_OFFSET))
+#define KDBG_EXTRACT_CODE(Debugid) \
+ ((uint16_t)(((Debugid) & KDBG_CODE_MASK) >> KDBG_CODE_OFFSET))
+
+/* function qualifiers */
+#define DBG_FUNC_START 1
+#define DBG_FUNC_END 2
+#define DBG_FUNC_NONE 0
-/* The debug code consists of the following
-*
-* ----------------------------------------------------------------------
-*| | | |Func |
-*| Class (8) | SubClass (8) | Code (14) |Qual(2)|
-* ----------------------------------------------------------------------
-* The class specifies the higher level
-*/
+/*
+ * Definitions to support IOP tracing.
+ */
+
+#ifdef KERNEL_PRIVATE
+
+typedef enum {
+ /* Trace is now enabled; no arguments. */
+ KD_CALLBACK_KDEBUG_ENABLED,
+ /* Trace is now disabled; no arguments. */
+ KD_CALLBACK_KDEBUG_DISABLED,
+ /*
+ * Request the latest entries from the IOP and block until complete; no
+ * arguments.
+ */
+ KD_CALLBACK_SYNC_FLUSH,
+ /*
+ * The typefilter is enabled; a read-only pointer to the typefilter is
+ * provided, valid only while in the callback.
+ */
+ KD_CALLBACK_TYPEFILTER_CHANGED,
+} kd_callback_type;
+typedef void (*kd_callback_fn) (void* context, kd_callback_type reason, void* arg);
+
+struct kd_callback {
+ kd_callback_fn func;
+ void *context;
+ /* name of IOP, NUL-terminated */
+ char iop_name[8];
+};
+
+typedef struct kd_callback kd_callback_t;
+
+/*
+ * Registers an IOP for participation in tracing.
+ *
+ * The registered callback function will be called with the
+ * supplied context as the first argument, followed by a
+ * kd_callback_type and an associated void* argument.
+ *
+ * The return value is a nonzero coreid that shall be used in
+ * kernel_debug_enter() to refer to your IOP. If the allocation
+ * failed, then 0 will be returned.
+ *
+ * Caveats:
+ * Note that not all callback calls will indicate a change in
+ * state (e.g. disabling trace twice would send two disable
+ * notifications).
+ */
+extern int kernel_debug_register_callback(kd_callback_t callback);
-/* The Function qualifiers */
-#define DBG_FUNC_START 1
-#define DBG_FUNC_END 2
-#define DBG_FUNC_NONE 0
+extern void kernel_debug_enter(
+ uint32_t coreid,
+ uint32_t debugid,
+ uint64_t timestamp,
+ uintptr_t arg1,
+ uintptr_t arg2,
+ uintptr_t arg3,
+ uintptr_t arg4,
+ uintptr_t threadid
+ );
+#endif /* KERNEL_PRIVATE */
/* The Kernel Debug Classes */
-#define DBG_MACH 1
-#define DBG_NETWORK 2
-#define DBG_FSYSTEM 3
-#define DBG_BSD 4
-#define DBG_IOKIT 5
-#define DBG_DRIVERS 6
-#define DBG_TRACE 7
-#define DBG_DLIL 8
-#define DBG_SECURITY 9
-#define DBG_MISC 20
-#define DBG_DYLD 31
-#define DBG_QT 32
-#define DBG_APPS 33
-#define DBG_LAUNCHD 34
-#define DBG_MIG 255
+#define DBG_MACH 1
+#define DBG_NETWORK 2
+#define DBG_FSYSTEM 3
+#define DBG_BSD 4
+#define DBG_IOKIT 5
+#define DBG_DRIVERS 6
+#define DBG_TRACE 7
+#define DBG_DLIL 8
+#define DBG_WORKQUEUE 9
+#define DBG_CORESTORAGE 10
+#define DBG_CG 11
+#define DBG_MONOTONIC 12
+#define DBG_MISC 20
+#define DBG_SECURITY 30
+#define DBG_DYLD 31
+#define DBG_QT 32
+#define DBG_APPS 33
+#define DBG_LAUNCHD 34
+#define DBG_PERF 37
+#define DBG_IMPORTANCE 38
+#define DBG_BANK 40
+#define DBG_XPC 41
+#define DBG_ATM 42
+#define DBG_ARIADNE 43
+#define DBG_DAEMON 44
+#define DBG_ENERGYTRACE 45
+#define DBG_DISPATCH 46
+#define DBG_IMG 49
+#define DBG_UMALLOC 51
+
+
+#define DBG_MIG 255
+
+#ifdef PRIVATE
+
+/*
+ * Private kdebug userspace API
+ */
+#ifndef KERNEL
+#include <stdbool.h>
+
+/*
+ * OS components can use the full precision of the "code" field
+ * (Class, SubClass, Code) to inject events using kdebug_trace() by
+ * using:
+ *
+ * kdebug_trace(KDBG_CODE(DBG_XPC, 15, 1) | DBG_FUNC_NONE, 1, 2, 3, 4);
+ *
+ * These trace points can be included in production code, since they
+ * use reserved, non-overlapping ranges. The performance impact when
+ * kernel tracing is not enabled is minimal. Classes can be reserved
+ * by filing a Radar in xnu|all.
+ *
+ * 64-bit arguments may be truncated if the system is using a 32-bit
+ * kernel.
+ *
+ * On error, -1 will be returned and errno will indicate the error.
+ */
+extern int kdebug_trace(
+ uint32_t code,
+ uint64_t arg1,
+ uint64_t arg2,
+ uint64_t arg3,
+ uint64_t arg4)
+ __OSX_AVAILABLE(10.10.2) __IOS_AVAILABLE(8.2);
+
+/*!
+ * @function kdebug_trace_string
+ *
+ * @discussion
+ * This function emits strings to kdebug trace along with an ID and allows
+ * for previously-traced strings to be overwritten and invalidated.
+ *
+ * To start tracing a string and generate an ID to use to refer to it:
+ *
+ * string_id = kdebug_trace_string(debugid, 0, "string");
+ *
+ * To replace a string previously traced:
+ *
+ * string_id = kdebug_trace_string(debugid, string_id, "new string");
+ *
+ * To invalidate a string ID:
+ *
+ * string_id = kdebug_trace_string(debugid, string_id, NULL);
+ *
+ * To check for errors:
+ *
+ * if ((int64_t)string_id == -1) { perror("string error") }
+ *
+ * @param debugid
+ * The `debugid` to check if its enabled before tracing and include as
+ * an argument in the event containing the string.
+ *
+ * Some classes or subclasses are reserved for specific uses and are not
+ * allowed to be used with this function. No function qualifiers are
+ * allowed on `debugid`.
+ *
+ * @param str_id
+ * When 0, a new ID will be generated and returned if tracing is
+ * enabled.
+ *
+ * Otherwise `str_id` must contain an ID that was previously generated
+ * with this function. Clents should pass NULL in `str` if `str_id`
+ * is no longer in use. Otherwise, the string previously mapped to
+ * `str_id` will be overwritten with the contents of `str`.
+ *
+ * @param str
+ * A NUL-terminated 'C' string containing the characters that should be
+ * traced alongside `str_id`.
+ *
+ * If necessary, the string will be truncated at an
+ * implementation-defined length. The string must not be the empty
+ * string, but can be NULL if a valid `str_id` is provided.
+ *
+ * @return
+ * 0 if tracing is disabled or `debugid` is being filtered out of trace.
+ * It can also return (int64_t)-1 if an error occured. Otherwise,
+ * it returns the ID to use to refer to the string in future
+ * kdebug_trace(2) calls.
+ *
+ * The errors that can occur are:
+ *
+ * EINVAL
+ * There are function qualifiers on `debugid`, `str` is empty, or
+ * `str_id` was not generated by this function.
+ * EPERM
+ * The `debugid`'s class or subclass is reserved for internal use.
+ * EFAULT
+ * `str` is an invalid address or NULL when `str_id` is 0.
+ */
+extern uint64_t kdebug_trace_string(uint32_t debugid, uint64_t str_id,
+ const char *str)
+ __OSX_AVAILABLE(10.11) __IOS_AVAILABLE(9.0);
+
+/*
+ * Although the performance impact of kdebug_trace() when kernel
+ * tracing is not enabled is minimal, it may require the caller to
+ * perform an expensive calculation/summarization. This cost can be
+ * skipped by checking the kdebug_is_enabled() predicate:
+ *
+ * if (kdebug_is_enabled(KDBG_CODE(DBG_XPC, 15, 1))) {
+ * uint64_t arg1 = ...;
+ * uint64_t arg2 = ...;
+ * kdebug_trace(KDBG_CODE(DBG_XPC, 15, 1) | DBG_FUNC_NONE, arg1, arg2, 0, 0);
+ * }
+ *
+ * If tracing is enabled for the code at the time of the check, 1
+ * will be returned. Otherwise, 0 will be returned.
+ */
+extern bool kdebug_is_enabled(uint32_t code)
+ __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0)
+ __WATCHOS_AVAILABLE(3.0) __TVOS_AVAILABLE(10.0);
+
+/*
+ * Returns a pointer to the userspace typefilter, if one is available.
+ * May return NULL.
+ */
+extern void *kdebug_typefilter(void)
+ __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0)
+ __WATCHOS_AVAILABLE(3.0) __TVOS_AVAILABLE(10.0);
+
+#endif /* !KERNEL (Private kdebug userspace API) */
+#endif /* PRIVATE */
+
+#ifdef XNU_KERNEL_PRIVATE
+/* Used in early boot to log strings spanning only a single tracepoint. */
+extern void kernel_debug_string_early(const char *message);
+/* Used to trace strings within kdebug tracepoints on arbitrary eventids. */
+extern void kernel_debug_string_simple(uint32_t eventid, const char *str);
+/* Only used by ktrace to reset kdebug. ktrace_lock must be held. */
+extern void kdebug_reset(void);
+#endif /* XNU_KERNEL_PRIVATE */
/* **** The Kernel Debug Sub Classes for Mach (DBG_MACH) **** */
-#define DBG_MACH_EXCP_KTRAP_x86 0x02 /* Kernel Traps on x86 */
-#define DBG_MACH_EXCP_DFLT 0x03 /* Data Translation Fault */
-#define DBG_MACH_EXCP_IFLT 0x04 /* Inst Translation Fault */
-#define DBG_MACH_EXCP_INTR 0x05 /* Interrupts */
-#define DBG_MACH_EXCP_ALNG 0x06 /* Alignment Exception */
-#define DBG_MACH_EXCP_UTRAP_x86 0x07 /* User Traps on x86 */
-#define DBG_MACH_EXCP_FP 0x08 /* FP Unavail */
-#define DBG_MACH_EXCP_DECI 0x09 /* Decrementer Interrupt */
-#define DBG_MACH_CHUD 0x0A /* CHUD */
-#define DBG_MACH_EXCP_SC 0x0C /* System Calls */
-#define DBG_MACH_EXCP_TRACE 0x0D /* Trace exception */
-#define DBG_MACH_EXCP_EMUL 0x0E /* Instruction emulated */
-#define DBG_MACH_IHDLR 0x10 /* Interrupt Handlers */
-#define DBG_MACH_IPC 0x20 /* Inter Process Comm */
-#define DBG_MACH_VM 0x30 /* Virtual Memory */
-#define DBG_MACH_LEAKS 0x31 /* alloc/free */
-#define DBG_MACH_SCHED 0x40 /* Scheduler */
-#define DBG_MACH_MSGID_INVALID 0x50 /* Messages - invalid */
-#define DBG_MACH_LOCKS 0x60 /* new lock APIs */
-#define DBG_MACH_PMAP 0x70 /* pmap */
-
-/* Codes for Scheduler (DBG_MACH_SCHED) */
+#define DBG_MACH_EXCP_KTRAP_x86 0x02 /* Kernel Traps on x86 */
+#define DBG_MACH_EXCP_DFLT 0x03 /* Data Translation Fault */
+#define DBG_MACH_EXCP_IFLT 0x04 /* Inst Translation Fault */
+#define DBG_MACH_EXCP_INTR 0x05 /* Interrupts */
+#define DBG_MACH_EXCP_ALNG 0x06 /* Alignment Exception */
+#define DBG_MACH_EXCP_UTRAP_x86 0x07 /* User Traps on x86 */
+#define DBG_MACH_EXCP_FP 0x08 /* FP Unavail */
+#define DBG_MACH_EXCP_DECI 0x09 /* Decrementer Interrupt */
+#define DBG_MACH_CHUD 0x0A /* deprecated name */
+#define DBG_MACH_SIGNPOST 0x0A /* kernel signposts */
+#define DBG_MACH_EXCP_SC 0x0C /* System Calls */
+#define DBG_MACH_EXCP_TRACE 0x0D /* Trace exception */
+#define DBG_MACH_EXCP_EMUL 0x0E /* Instruction emulated */
+#define DBG_MACH_IHDLR 0x10 /* Interrupt Handlers */
+#define DBG_MACH_IPC 0x20 /* Inter Process Comm */
+#define DBG_MACH_RESOURCE 0x25 /* tracing limits, etc */
+#define DBG_MACH_VM 0x30 /* Virtual Memory */
+#define DBG_MACH_LEAKS 0x31 /* alloc/free */
+#define DBG_MACH_WORKINGSET 0x32 /* private subclass for working set related debugging */
+#define DBG_MACH_SCHED 0x40 /* Scheduler */
+#define DBG_MACH_MSGID_INVALID 0x50 /* Messages - invalid */
+#define DBG_MACH_LOCKS 0x60 /* new lock APIs */
+#define DBG_MACH_PMAP 0x70 /* pmap */
+#define DBG_MACH_CLOCK 0x80 /* clock */
+#define DBG_MACH_MP 0x90 /* MP related */
+#define DBG_MACH_VM_PRESSURE 0xA0 /* Memory Pressure Events */
+#define DBG_MACH_STACKSHOT 0xA1 /* Stackshot/Microstackshot subsystem */
+#define DBG_MACH_SFI 0xA2 /* Selective Forced Idle (SFI) */
+#define DBG_MACH_ENERGY_PERF 0xA3 /* Energy/performance resource stats */
+#define DBG_MACH_SYSDIAGNOSE 0xA4 /* sysdiagnose */
+#define DBG_MACH_ZALLOC 0xA5 /* Zone allocator */
+#define DBG_MACH_THREAD_GROUP 0xA6 /* Thread groups */
+#define DBG_MACH_COALITION 0xA7 /* Coalitions */
+
+/* Interrupt type bits for DBG_MACH_EXCP_INTR */
+#define DBG_INTR_TYPE_UNKNOWN 0x0 /* default/unknown interrupt */
+#define DBG_INTR_TYPE_IPI 0x1 /* interprocessor interrupt */
+#define DBG_INTR_TYPE_TIMER 0x2 /* timer interrupt */
+#define DBG_INTR_TYPE_OTHER 0x3 /* other (usually external) interrupt */
+
+/* Codes for Scheduler (DBG_MACH_SCHED) */
#define MACH_SCHED 0x0 /* Scheduler */
#define MACH_STACK_ATTACH 0x1 /* stack_attach() */
#define MACH_STACK_HANDOFF 0x2 /* stack_handoff() */
#define MACH_DEMOTE 0x8 /* promotion undone */
#define MACH_IDLE 0x9 /* processor idling */
#define MACH_STACK_DEPTH 0xa /* stack depth at switch */
-
-/* Codes for pmap (DBG_MACH_PMAP) */
+#define MACH_MOVED 0xb /* did not use original scheduling decision */
+#define MACH_PSET_LOAD_AVERAGE 0xc
+#define MACH_AMP_DEBUG 0xd
+#define MACH_FAILSAFE 0xe /* tripped fixed-pri/RT failsafe */
+#define MACH_BLOCK 0xf /* thread block */
+#define MACH_WAIT 0x10 /* thread wait assertion */
+#define MACH_GET_URGENCY 0x14 /* Urgency queried by platform */
+#define MACH_URGENCY 0x15 /* Urgency (RT/BG/NORMAL) communicated
+ * to platform
+ */
+#define MACH_REDISPATCH 0x16 /* "next thread" thread redispatched */
+#define MACH_REMOTE_AST 0x17 /* AST signal issued to remote processor */
+#define MACH_SCHED_CHOOSE_PROCESSOR 0x18 /* Result of choose_processor */
+#define MACH_DEEP_IDLE 0x19 /* deep idle on master processor */
+/* unused 0x1a was MACH_SCHED_DECAY_PRIORITY */
+#define MACH_CPU_THROTTLE_DISABLE 0x1b /* Global CPU Throttle Disable */
+#define MACH_RW_PROMOTE 0x1c /* promoted due to RW lock promotion */
+#define MACH_RW_DEMOTE 0x1d /* promotion due to RW lock undone */
+#define MACH_SCHED_MAINTENANCE 0x1f /* periodic maintenance thread */
+#define MACH_DISPATCH 0x20 /* context switch completed */
+#define MACH_QUANTUM_HANDOFF 0x21 /* quantum handoff occurred */
+#define MACH_MULTIQ_DEQUEUE 0x22 /* Result of multiq dequeue */
+#define MACH_SCHED_THREAD_SWITCH 0x23 /* attempt direct context switch to hinted thread */
+#define MACH_SCHED_SMT_BALANCE 0x24 /* SMT load balancing ASTs */
+#define MACH_REMOTE_DEFERRED_AST 0x25 /* Deferred AST started against remote processor */
+#define MACH_REMOTE_CANCEL_AST 0x26 /* Canceled deferred AST for remote processor */
+#define MACH_SCHED_CHANGE_PRIORITY 0x27 /* thread sched priority changed */
+#define MACH_SCHED_UPDATE_REC_CORES 0x28 /* Change to recommended processor bitmask */
+#define MACH_STACK_WAIT 0x29 /* Thread could not be switched-to because of kernel stack shortage */
+#define MACH_THREAD_BIND 0x2a /* Thread was bound (or unbound) to a processor */
+#define MACH_WAITQ_PROMOTE 0x2b /* Thread promoted by waitq boost */
+#define MACH_WAITQ_DEMOTE 0x2c /* Thread demoted from waitq boost */
+#define MACH_SCHED_LOAD 0x2d /* load update */
+#define MACH_REC_CORES_FAILSAFE 0x2e /* recommended processor failsafe kicked in */
+#define MACH_SCHED_QUANTUM_EXPIRED 0x2f /* thread quantum expired */
+#define MACH_EXEC_PROMOTE 0x30 /* Thread promoted by exec boost */
+#define MACH_EXEC_DEMOTE 0x31 /* Thread demoted from exec boost */
+#define MACH_AMP_SIGNAL_SPILL 0x32 /* AMP spill signal sent to cpuid */
+#define MACH_AMP_STEAL 0x33 /* AMP thread stolen or spilled */
+
+/* Variants for MACH_MULTIQ_DEQUEUE */
+#define MACH_MULTIQ_BOUND 1
+#define MACH_MULTIQ_GROUP 2
+#define MACH_MULTIQ_GLOBAL 3
+
+/* Arguments for vm_fault (DBG_MACH_VM) */
+#define DBG_ZERO_FILL_FAULT 1
+#define DBG_PAGEIN_FAULT 2
+#define DBG_COW_FAULT 3
+#define DBG_CACHE_HIT_FAULT 4
+#define DBG_NZF_PAGE_FAULT 5
+#define DBG_GUARD_FAULT 6
+#define DBG_PAGEINV_FAULT 7
+#define DBG_PAGEIND_FAULT 8
+#define DBG_COMPRESSOR_FAULT 9
+#define DBG_COMPRESSOR_SWAPIN_FAULT 10
+
+/* Codes for IPC (DBG_MACH_IPC) */
+#define MACH_TASK_SUSPEND 0x0 /* Suspended a task */
+#define MACH_TASK_RESUME 0x1 /* Resumed a task */
+#define MACH_THREAD_SET_VOUCHER 0x2
+#define MACH_IPC_MSG_SEND 0x3 /* mach msg send, uniq msg info */
+#define MACH_IPC_MSG_RECV 0x4 /* mach_msg receive */
+#define MACH_IPC_MSG_RECV_VOUCHER_REFUSED 0x5 /* mach_msg receive, voucher refused */
+#define MACH_IPC_KMSG_FREE 0x6 /* kernel free of kmsg data */
+#define MACH_IPC_VOUCHER_CREATE 0x7 /* Voucher added to global voucher hashtable */
+#define MACH_IPC_VOUCHER_CREATE_ATTR_DATA 0x8 /* Attr data for newly created voucher */
+#define MACH_IPC_VOUCHER_DESTROY 0x9 /* Voucher removed from global voucher hashtable */
+#define MACH_IPC_KMSG_INFO 0xa /* Send/Receive info for a kmsg */
+#define MACH_IPC_KMSG_LINK 0xb /* link a kernel kmsg pointer to user mach_msg_header_t */
+
+/* Codes for thread groups (DBG_MACH_THREAD_GROUP) */
+#define MACH_THREAD_GROUP_NEW 0x0
+#define MACH_THREAD_GROUP_FREE 0x1
+#define MACH_THREAD_GROUP_SET 0x2
+#define MACH_THREAD_GROUP_NAME 0x3
+#define MACH_THREAD_GROUP_NAME_FREE 0x4
+#define MACH_THREAD_GROUP_FLAGS 0x5
+
+/* Codes for coalitions (DBG_MACH_COALITION) */
+#define MACH_COALITION_NEW 0x0
+#define MACH_COALITION_FREE 0x1
+#define MACH_COALITION_ADOPT 0x2
+#define MACH_COALITION_REMOVE 0x3
+#define MACH_COALITION_THREAD_GROUP_SET 0x4
+
+/* Codes for pmap (DBG_MACH_PMAP) */
#define PMAP__CREATE 0x0
#define PMAP__DESTROY 0x1
#define PMAP__PROTECT 0x2
#define PMAP__FLUSH_TLBS 0x8
#define PMAP__UPDATE_INTERRUPT 0x9
#define PMAP__ATTRIBUTE_CLEAR 0xa
+#define PMAP__REUSABLE 0xb /* This appears to be unused */
+#define PMAP__QUERY_RESIDENT 0xc
+#define PMAP__FLUSH_KERN_TLBS 0xd
+#define PMAP__FLUSH_DELAYED_TLBS 0xe
+#define PMAP__FLUSH_TLBS_TO 0xf
+#define PMAP__FLUSH_EPT 0x10
+#define PMAP__FAST_FAULT 0x11
+
+/* Codes for clock (DBG_MACH_CLOCK) */
+#define MACH_EPOCH_CHANGE 0x0 /* wake epoch change */
+
+/* Codes for Stackshot/Microstackshot (DBG_MACH_STACKSHOT) */
+#define MICROSTACKSHOT_RECORD 0x0
+#define MICROSTACKSHOT_GATHER 0x1
+
+/* Codes for sysdiagnose (DBG_MACH_SYSDIAGNOSE) */
+#define SYSDIAGNOSE_NOTIFY_USER 0x0
+#define SYSDIAGNOSE_FULL 0x1
+#define SYSDIAGNOSE_STACKSHOT 0x2
+#define SYSDIAGNOSE_TAILSPIN 0x3
+
+/* Codes for Selective Forced Idle (DBG_MACH_SFI) */
+#define SFI_SET_WINDOW 0x0
+#define SFI_CANCEL_WINDOW 0x1
+#define SFI_SET_CLASS_OFFTIME 0x2
+#define SFI_CANCEL_CLASS_OFFTIME 0x3
+#define SFI_THREAD_DEFER 0x4
+#define SFI_OFF_TIMER 0x5
+#define SFI_ON_TIMER 0x6
+#define SFI_WAIT_CANCELED 0x7
+#define SFI_PID_SET_MANAGED 0x8
+#define SFI_PID_CLEAR_MANAGED 0x9
+#define SFI_GLOBAL_DEFER 0xa
+
+/* Codes for Zone Allocator (DBG_MACH_ZALLOC) */
+#define ZALLOC_ZCRAM 0x0
+
+/* Codes for Mach resource management (DBG_MACH_RESOURCE) */
+/* _K32A/B codes start at double the low nibble */
+#define RMON_ENABLE_CPUUSAGE_MONITOR 0x001
+#define RMON_CPUUSAGE_VIOLATED 0x002
+#define RMON_CPUUSAGE_SUSPENDED 0x003
+#define RMON_CPUUSAGE_VIOLATED_K32A 0x004
+#define RMON_CPUUSAGE_VIOLATED_K32B 0x005
+#define RMON_CPUUSAGE_RESUMED 0x006
+#define RMON_DISABLE_CPUUSAGE_MONITOR 0x00f
+
+#define RMON_ENABLE_CPUWAKES_MONITOR 0x011
+#define RMON_CPUWAKES_VIOLATED 0x012
+#define RMON_CPUWAKES_VIOLATED_K32A 0x014
+#define RMON_CPUWAKES_VIOLATED_K32B 0x015
+#define RMON_DISABLE_CPUWAKES_MONITOR 0x01f
+
+#define RMON_ENABLE_IO_MONITOR 0x021
+#define RMON_LOGWRITES_VIOLATED 0x022
+#define RMON_PHYSWRITES_VIOLATED 0x023
+#define RMON_LOGWRITES_VIOLATED_K32A 0x024
+#define RMON_LOGWRITES_VIOLATED_K32B 0x025
+#define RMON_DISABLE_IO_MONITOR 0x02f
/* **** The Kernel Debug Sub Classes for Network (DBG_NETWORK) **** */
#define DBG_NETIP 1 /* Internet Protocol */
#define DBG_NETAFP 107 /* Apple Filing Protocol */
#define DBG_NETRTMP 108 /* Routing Table Maintenance Protocol */
#define DBG_NETAURP 109 /* Apple Update Routing Protocol */
+
#define DBG_NETIPSEC 128 /* IPsec Protocol */
+#define DBG_NETVMNET 129 /* VMNet */
/* **** The Kernel Debug Sub Classes for IOKIT (DBG_IOKIT) **** */
-#define DBG_IOWORKLOOP 1 /* Work from work loop */
+#define DBG_IOINTC 0 /* Interrupt controller */
+#define DBG_IOWORKLOOP 1 /* Work from work loop */
#define DBG_IOINTES 2 /* Interrupt event source */
#define DBG_IOCLKES 3 /* Clock event source */
#define DBG_IOCMDQ 4 /* Command queue latencies */
#define DBG_IOMDESC 6 /* Memory Descriptors */
#define DBG_IOPOWER 7 /* Power Managerment */
#define DBG_IOSERVICE 8 /* Matching etc. */
+#define DBG_IOREGISTRY 9 /* Registry */
/* **** 9-32 reserved for internal IOKit usage **** */
#define DBG_IOSTORAGE 32 /* Storage layers */
#define DBG_IONETWORK 33 /* Network layers */
#define DBG_IOKEYBOARD 34 /* Keyboard */
-#define DBG_IOHID 35 /* HID Devices */
-#define DBG_IOAUDIO 36 /* Audio */
+#define DBG_IOHID 35 /* HID Devices */
+#define DBG_IOAUDIO 36 /* Audio */
#define DBG_IOSERIAL 37 /* Serial */
-#define DBG_IOTTY 38 /* TTY layers */
-#define DBG_IOSAM 39 /* SCSI Architecture Model layers */
-#define DBG_IOPARALLELATA 40 /* Parallel ATA */
+#define DBG_IOTTY 38 /* TTY layers */
+#define DBG_IOSAM 39 /* SCSI Architecture Model layers */
+#define DBG_IOPARALLELATA 40 /* Parallel ATA */
#define DBG_IOPARALLELSCSI 41 /* Parallel SCSI */
-#define DBG_IOSATA 42 /* Serial-ATA */
-#define DBG_IOSAS 43 /* SAS */
+#define DBG_IOSATA 42 /* Serial-ATA */
+#define DBG_IOSAS 43 /* SAS */
#define DBG_IOFIBRECHANNEL 44 /* FiberChannel */
-#define DBG_IOUSB 45 /* USB */
+#define DBG_IOUSB 45 /* USB */
#define DBG_IOBLUETOOTH 46 /* Bluetooth */
#define DBG_IOFIREWIRE 47 /* FireWire */
#define DBG_IOINFINIBAND 48 /* Infiniband */
-#define DBG_IOCPUPM 49 /* CPU Power Management */
+#define DBG_IOCPUPM 49 /* CPU Power Management */
#define DBG_IOGRAPHICS 50 /* Graphics */
+#define DBG_HIBERNATE 51 /* hibernation related events */
+#define DBG_IOTHUNDERBOLT 52 /* Thunderbolt */
+#define DBG_BOOTER 53 /* booter related events */
/* Backwards compatibility */
#define DBG_IOPOINTING DBG_IOHID /* OBSOLETE: Use DBG_IOHID instead */
#define DBG_IODISK DBG_IOSTORAGE /* OBSOLETE: Use DBG_IOSTORAGE instead */
/* **** The Kernel Debug Sub Classes for Device Drivers (DBG_DRIVERS) **** */
-#define DBG_DRVSTORAGE 1 /* Storage layers */
-#define DBG_DRVNETWORK 2 /* Network layers */
-#define DBG_DRVKEYBOARD 3 /* Keyboard */
-#define DBG_DRVHID 4 /* HID Devices */
-#define DBG_DRVAUDIO 5 /* Audio */
-#define DBG_DRVSERIAL 7 /* Serial */
-#define DBG_DRVSAM 8 /* SCSI Architecture Model layers */
-#define DBG_DRVPARALLELATA 9 /* Parallel ATA */
-#define DBG_DRVPARALLELSCSI 10 /* Parallel SCSI */
-#define DBG_DRVSATA 11 /* Serial ATA */
-#define DBG_DRVSAS 12 /* SAS */
-#define DBG_DRVFIBRECHANNEL 13 /* FiberChannel */
-#define DBG_DRVUSB 14 /* USB */
-#define DBG_DRVBLUETOOTH 15 /* Bluetooth */
-#define DBG_DRVFIREWIRE 16 /* FireWire */
-#define DBG_DRVINFINIBAND 17 /* Infiniband */
-#define DBG_DRVGRAPHICS 18 /* Graphics */
-#define DBG_DRVSD 19 /* Secure Digital */
+#define DBG_DRVSTORAGE 1 /* Storage layers */
+#define DBG_DRVNETWORK 2 /* Network layers */
+#define DBG_DRVKEYBOARD 3 /* Keyboard */
+#define DBG_DRVHID 4 /* HID Devices */
+#define DBG_DRVAUDIO 5 /* Audio */
+#define DBG_DRVSERIAL 7 /* Serial */
+#define DBG_DRVSAM 8 /* SCSI Architecture Model layers */
+#define DBG_DRVPARALLELATA 9 /* Parallel ATA */
+#define DBG_DRVPARALLELSCSI 10 /* Parallel SCSI */
+#define DBG_DRVSATA 11 /* Serial ATA */
+#define DBG_DRVSAS 12 /* SAS */
+#define DBG_DRVFIBRECHANNEL 13 /* FiberChannel */
+#define DBG_DRVUSB 14 /* USB */
+#define DBG_DRVBLUETOOTH 15 /* Bluetooth */
+#define DBG_DRVFIREWIRE 16 /* FireWire */
+#define DBG_DRVINFINIBAND 17 /* Infiniband */
+#define DBG_DRVGRAPHICS 18 /* Graphics */
+#define DBG_DRVSD 19 /* Secure Digital */
+#define DBG_DRVNAND 20 /* NAND drivers and layers */
+#define DBG_SSD 21 /* SSD */
+#define DBG_DRVSPI 22 /* SPI */
+#define DBG_DRVWLAN_802_11 23 /* WLAN 802.11 */
+#define DBG_DRVSSM 24 /* System State Manager(AppleSSM) */
+#define DBG_DRVSMC 25 /* System Management Controller */
+#define DBG_DRVMACEFIMANAGER 26 /* Mac EFI Manager */
/* Backwards compatibility */
-#define DBG_DRVPOINTING DBG_DRVHID /* OBSOLETE: Use DBG_DRVHID instead */
-#define DBG_DRVDISK DBG_DRVSTORAGE /* OBSOLETE: Use DBG_DRVSTORAGE instead */
+#define DBG_DRVPOINTING DBG_DRVHID /* OBSOLETE: Use DBG_DRVHID instead */
+#define DBG_DRVDISK DBG_DRVSTORAGE /* OBSOLETE: Use DBG_DRVSTORAGE instead */
/* **** The Kernel Debug Sub Classes for the DLIL Layer (DBG_DLIL) **** */
#define DBG_DLIL_STATIC 1 /* Static DLIL code */
#define DBG_DLIL_PR_FLT 4 /* DLIL Protocol Filter */
#define DBG_DLIL_IF_FLT 5 /* DLIL Interface FIlter */
-/* The Kernel Debug Sub Classes for File System */
-#define DBG_FSRW 1 /* reads and writes to the filesystem */
-#define DBG_DKRW 2 /* reads and writes to the disk */
-#define DBG_FSVN 3 /* vnode operations (inc. locking/unlocking) */
-#define DBG_FSLOOOKUP 4 /* namei and other lookup-related operations */
-#define DBG_JOURNAL 5 /* journaling operations */
-#define DBG_IOCTL 6 /* ioctl to the disk */
-#define DBG_BOOTCACHE 7 /* bootcache operations */
-/* The Kernel Debug Sub Classes for BSD */
-#define DBG_BSD_PROC 0x01 /* process/signals related */
-#define DBG_BSD_EXCP_SC 0x0C /* System Calls */
-#define DBG_BSD_AIO 0x0D /* aio (POSIX async IO) */
-#define DBG_BSD_SC_EXTENDED_INFO 0x0E /* System Calls, extended info */
-#define DBG_BSD_SC_EXTENDED_INFO2 0x0F /* System Calls, extended info */
+/* The Kernel Debug Sub Classes for File System (DBG_FSYSTEM) */
+#define DBG_FSRW 0x1 /* reads and writes to the filesystem */
+#define DBG_DKRW 0x2 /* reads and writes to the disk */
+#define DBG_FSVN 0x3 /* vnode operations (inc. locking/unlocking) */
+#define DBG_FSLOOOKUP 0x4 /* namei and other lookup-related operations */
+#define DBG_JOURNAL 0x5 /* journaling operations */
+#define DBG_IOCTL 0x6 /* ioctl to the disk */
+#define DBG_BOOTCACHE 0x7 /* bootcache operations */
+#define DBG_HFS 0x8 /* HFS-specific events; see the hfs project */
+#define DBG_APFS 0x9 /* APFS-specific events; see the apfs project */
+#define DBG_SMB 0xA /* SMB-specific events; see the smb project */
+#define DBG_MOUNT 0xB /* Mounting/unmounting operations */
+#define DBG_EXFAT 0xE /* ExFAT-specific events; see the exfat project */
+#define DBG_MSDOS 0xF /* FAT-specific events; see the msdosfs project */
+#define DBG_ACFS 0x10 /* Xsan-specific events; see the XsanFS project */
+#define DBG_THROTTLE 0x11 /* I/O Throttling events */
+#define DBG_CONTENT_PROT 0xCF /* Content Protection Events: see bsd/sys/cprotect.h */
+
+/*
+ * For Kernel Debug Sub Class DBG_HFS, state bits for hfs_update event
+ */
+#define DBG_HFS_UPDATE_ACCTIME 0x01
+#define DBG_HFS_UPDATE_MODTIME 0x02
+#define DBG_HFS_UPDATE_CHGTIME 0x04
+#define DBG_HFS_UPDATE_MODIFIED 0x08
+#define DBG_HFS_UPDATE_FORCE 0x10
+#define DBG_HFS_UPDATE_DATEADDED 0x20
+#define DBG_HFS_UPDATE_MINOR 0x40
+#define DBG_HFS_UPDATE_SKIPPED 0x80
+/* The Kernel Debug Sub Classes for BSD */
+#define DBG_BSD_PROC 0x01 /* process/signals related */
+#define DBG_BSD_MEMSTAT 0x02 /* memorystatus / jetsam operations */
+#define DBG_BSD_KEVENT 0x03 /* kqueue / kevent related */
+#define DBG_BSD_EXCP_SC 0x0C /* System Calls */
+#define DBG_BSD_AIO 0x0D /* aio (POSIX async IO) */
+#define DBG_BSD_SC_EXTENDED_INFO 0x0E /* System Calls, extended info */
+#define DBG_BSD_SC_EXTENDED_INFO2 0x0F /* System Calls, extended info */
+#define DBG_BSD_KDEBUG_TEST 0xFF /* for testing kdebug */
/* The Codes for BSD subcode class DBG_BSD_PROC */
-#define BSD_PROC_EXIT 1 /* process exit */
-#define BSD_PROC_FRCEXIT 2 /* Kernel force termination */
+#define BSD_PROC_EXIT 1 /* process exit */
+#define BSD_PROC_FRCEXIT 2 /* Kernel force termination */
+#define BSD_PROC_EXEC 3 /* process spawn / exec */
+#define BSD_PROC_EXITREASON_CREATE 4 /* exit reason creation */
+#define BSD_PROC_EXITREASON_COMMIT 5 /* exit reason commited to a proc */
+
+/* Codes for BSD subcode class DBG_BSD_MEMSTAT */
+#define BSD_MEMSTAT_SCAN 1 /* memorystatus thread awake */
+#define BSD_MEMSTAT_JETSAM 2 /* LRU jetsam */
+#define BSD_MEMSTAT_JETSAM_HIWAT 3 /* highwater jetsam */
+#define BSD_MEMSTAT_FREEZE 4 /* freeze process */
+#define BSD_MEMSTAT_LATENCY_COALESCE 5 /* delay imposed to coalesce jetsam reports */
+#define BSD_MEMSTAT_UPDATE 6 /* priority update */
+#define BSD_MEMSTAT_IDLE_DEMOTE 7 /* idle demotion fired */
+#define BSD_MEMSTAT_CLEAR_ERRORS 8 /* reset termination error state */
+#define BSD_MEMSTAT_DIRTY_TRACK 9 /* track the process state */
+#define BSD_MEMSTAT_DIRTY_SET 10 /* set the process state */
+#define BSD_MEMSTAT_DIRTY_CLEAR 11 /* clear the process state */
+#ifdef PRIVATE
+#define BSD_MEMSTAT_GRP_SET_PROP 12 /* set group properties */
+#define BSD_MEMSTAT_DO_KILL 13 /* memorystatus kills */
+#endif /* PRIVATE */
+
+/* Codes for BSD subcode class DBG_BSD_KEVENT */
+#define BSD_KEVENT_KQ_PROCESS_BEGIN 1
+#define BSD_KEVENT_KQ_PROCESS_END 2
+#define BSD_KEVENT_KQWQ_PROCESS_BEGIN 3
+#define BSD_KEVENT_KQWQ_PROCESS_END 4
+#define BSD_KEVENT_KQWQ_BIND 5
+#define BSD_KEVENT_KQWQ_UNBIND 6
+#define BSD_KEVENT_KQWQ_THREQUEST 7
+#define BSD_KEVENT_KQWL_PROCESS_BEGIN 8
+#define BSD_KEVENT_KQWL_PROCESS_END 9
+#define BSD_KEVENT_KQWL_THREQUEST 10
+#define BSD_KEVENT_KQWL_THADJUST 11
+#define BSD_KEVENT_KQ_REGISTER 12
+#define BSD_KEVENT_KQWQ_REGISTER 13
+#define BSD_KEVENT_KQWL_REGISTER 14
+#define BSD_KEVENT_KNOTE_ACTIVATE 15
+#define BSD_KEVENT_KQ_PROCESS 16
+#define BSD_KEVENT_KQWQ_PROCESS 17
+#define BSD_KEVENT_KQWL_PROCESS 18
+#define BSD_KEVENT_KQWL_BIND 19
+#define BSD_KEVENT_KQWL_UNBIND 20
+#define BSD_KEVENT_KNOTE_ENABLE 21
+
/* The Kernel Debug Sub Classes for DBG_TRACE */
#define DBG_TRACE_DATA 0
#define DBG_TRACE_STRING 1
#define DBG_TRACE_INFO 2
+/* The Kernel Debug events: */
+#define TRACE_DATA_NEWTHREAD (TRACEDBG_CODE(DBG_TRACE_DATA, 1))
+#define TRACE_DATA_EXEC (TRACEDBG_CODE(DBG_TRACE_DATA, 2))
+#define TRACE_DATA_THREAD_TERMINATE (TRACEDBG_CODE(DBG_TRACE_DATA, 3))
+#define TRACE_DATA_THREAD_TERMINATE_PID (TRACEDBG_CODE(DBG_TRACE_DATA, 4))
+#define TRACE_STRING_GLOBAL (TRACEDBG_CODE(DBG_TRACE_STRING, 0))
+#define TRACE_STRING_NEWTHREAD (TRACEDBG_CODE(DBG_TRACE_STRING, 1))
+#define TRACE_STRING_EXEC (TRACEDBG_CODE(DBG_TRACE_STRING, 2))
+#define TRACE_STRING_PROC_EXIT (TRACEDBG_CODE(DBG_TRACE_STRING, 3))
+#define TRACE_STRING_THREADNAME (TRACEDBG_CODE(DBG_TRACE_STRING, 4))
+#define TRACE_STRING_THREADNAME_PREV (TRACEDBG_CODE(DBG_TRACE_STRING, 5))
+#define TRACE_PANIC (TRACEDBG_CODE(DBG_TRACE_INFO, 0))
+#define TRACE_TIMESTAMPS (TRACEDBG_CODE(DBG_TRACE_INFO, 1))
+#define TRACE_LOST_EVENTS (TRACEDBG_CODE(DBG_TRACE_INFO, 2))
+#define TRACE_WRITING_EVENTS (TRACEDBG_CODE(DBG_TRACE_INFO, 3))
+#define TRACE_INFO_STRING (TRACEDBG_CODE(DBG_TRACE_INFO, 4))
+#define TRACE_RETROGRADE_EVENTS (TRACEDBG_CODE(DBG_TRACE_INFO, 5))
+
+/* The Kernel Debug Sub Classes for DBG_CORESTORAGE */
+#define DBG_CS_IO 0
+
+/* The Kernel Debug Sub Classes for DBG_SECURITY */
+#define DBG_SEC_KERNEL 0 /* raw entropy collected by the kernel */
+#define DBG_SEC_SANDBOX 1
+
+/* Sub-class codes for CoreGraphics (DBG_CG) are defined in its component. */
+
+/* The Kernel Debug Sub Classes for DBG_MONOTONIC */
+#define DBG_MT_INSTRS_CYCLES 1
+#define DBG_MT_TMPTH 0xfe
+#define DBG_MT_TMPCPU 0xff
+
/* The Kernel Debug Sub Classes for DBG_MISC */
#define DBG_EVENT 0x10
#define DBG_BUFFER 0x20
/* The Kernel Debug Sub Classes for DBG_DYLD */
-#define DBG_DYLD_STRING 5
+#define DBG_DYLD_UUID (5)
+
+/* Kernel Debug codes for the DBG_DYLD_UUID subclass */
+#define DBG_DYLD_UUID_MAP_A (0)
+#define DBG_DYLD_UUID_MAP_B (1)
+#define DBG_DYLD_UUID_MAP_32_A (2)
+#define DBG_DYLD_UUID_MAP_32_B (3)
+#define DBG_DYLD_UUID_MAP_32_C (4)
+#define DBG_DYLD_UUID_UNMAP_A (5)
+#define DBG_DYLD_UUID_UNMAP_B (6)
+#define DBG_DYLD_UUID_UNMAP_32_A (7)
+#define DBG_DYLD_UUID_UNMAP_32_B (8)
+#define DBG_DYLD_UUID_UNMAP_32_C (9)
+#define DBG_DYLD_UUID_SHARED_CACHE_A (10)
+#define DBG_DYLD_UUID_SHARED_CACHE_B (11)
+#define DBG_DYLD_UUID_SHARED_CACHE_32_A (12)
+#define DBG_DYLD_UUID_SHARED_CACHE_32_B (13)
+#define DBG_DYLD_UUID_SHARED_CACHE_32_C (14)
/* The Kernel Debug modifiers for the DBG_DKRW sub class */
#define DKIO_DONE 0x01
#define DKIO_ASYNC 0x04
#define DKIO_META 0x08
#define DKIO_PAGING 0x10
-
-/* Codes for Application Sub Classes */
-#define DBG_APP_SAMBA 128
-
+#define DKIO_THROTTLE 0x20 /* Deprecated, still provided so fs_usage doesn't break */
+#define DKIO_PASSIVE 0x40
+#define DKIO_NOCACHE 0x80
+#define DKIO_TIER_MASK 0xF00
+#define DKIO_TIER_SHIFT 8
+#define DKIO_TIER_UPGRADE 0x1000
+
+/* Kernel Debug Sub Classes for Applications (DBG_APPS) */
+#define DBG_APP_LOGINWINDOW 0x03
+#define DBG_APP_AUDIO 0x04
+#define DBG_APP_SYSTEMUI 0x05
+#define DBG_APP_SIGNPOST 0x0A
+#define DBG_APP_APPKIT 0x0C
+#define DBG_APP_DFR 0x0E
+#define DBG_APP_SAMBA 0x80
+#define DBG_APP_EOSSUPPORT 0x81
+#define DBG_APP_MACEFIMANAGER 0x82
+
+/* Kernel Debug codes for Throttling (DBG_THROTTLE) */
+#define OPEN_THROTTLE_WINDOW 0x1
+#define PROCESS_THROTTLED 0x2
+#define IO_THROTTLE_DISABLE 0x3
+#define IO_TIER_UPL_MISMATCH 0x4
+
+
+/* Subclasses for MACH Importance Policies (DBG_IMPORTANCE) */
+/* TODO: Split up boost and task policy? */
+#define IMP_ASSERTION 0x10 /* Task takes/drops a boost assertion */
+#define IMP_BOOST 0x11 /* Task boost level changed */
+#define IMP_MSG 0x12 /* boosting message sent by donating task on donating port */
+#define IMP_WATCHPORT 0x13 /* port marked as watchport, and boost was transferred to the watched task */
+#define IMP_TASK_SUPPRESSION 0x17 /* Task changed suppression behaviors */
+#define IMP_TASK_APPTYPE 0x18 /* Task launched with apptype */
+#define IMP_UPDATE 0x19 /* Requested -> effective calculation */
+#define IMP_USYNCH_QOS_OVERRIDE 0x1A /* Userspace synchronization applied QoS override to resource owning thread */
+#define IMP_DONOR_CHANGE 0x1B /* The iit_donor bit changed */
+#define IMP_MAIN_THREAD_QOS 0x1C /* The task's main thread QoS was set */
+#define IMP_SYNC_IPC_QOS 0x1D /* Sync IPC QOS override */
+/* DBG_IMPORTANCE subclasses 0x20 - 0x3F reserved for task policy flavors */
+
+/* Codes for IMP_ASSERTION */
+#define IMP_HOLD 0x2 /* Task holds a boost assertion */
+#define IMP_DROP 0x4 /* Task drops a boost assertion */
+#define IMP_EXTERN 0x8 /* boost assertion moved from kernel to userspace responsibility (externalized) */
+
+/* Codes for IMP_BOOST */
+#define IMP_BOOSTED 0x1
+#define IMP_UNBOOSTED 0x2 /* Task drops a boost assertion */
+
+/* Codes for IMP_MSG */
+#define IMP_MSG_SEND 0x1 /* boosting message sent by donating task on donating port */
+#define IMP_MSG_DELV 0x2 /* boosting message delivered to task */
+
+/* Codes for IMP_UPDATE */
+#define IMP_UPDATE_TASK_CREATE 0x1
+
+/* Codes for IMP_USYNCH_QOS_OVERRIDE */
+#define IMP_USYNCH_ADD_OVERRIDE 0x0 /* add override for a contended resource */
+#define IMP_USYNCH_REMOVE_OVERRIDE 0x1 /* remove override for a contended resource */
+
+/* Codes for IMP_DONOR_CHANGE */
+#define IMP_DONOR_UPDATE_LIVE_DONOR_STATE 0x0
+#define IMP_DONOR_INIT_DONOR_STATE 0x1
+
+/* Code for IMP_SYNC_IPC_QOS */
+#define IMP_SYNC_IPC_QOS_APPLIED 0x0
+#define IMP_SYNC_IPC_QOS_REMOVED 0x1
+#define IMP_SYNC_IPC_QOS_OVERFLOW 0x2
+#define IMP_SYNC_IPC_QOS_UNDERFLOW 0x3
+
+/* Subclasses for MACH Bank Voucher Attribute Manager (DBG_BANK) */
+#define BANK_ACCOUNT_INFO 0x10 /* Trace points related to bank account struct */
+#define BANK_TASK_INFO 0x11 /* Trace points related to bank task struct */
+
+/* Subclasses for MACH ATM Voucher Attribute Manager (ATM) */
+#define ATM_SUBAID_INFO 0x10
+#define ATM_GETVALUE_INFO 0x20
+#define ATM_UNREGISTER_INFO 0x30
+
+/* Codes for BANK_ACCOUNT_INFO */
+#define BANK_SETTLE_CPU_TIME 0x1 /* Bank ledger(chit) rolled up to tasks. */
+#define BANK_SECURE_ORIGINATOR_CHANGED 0x2 /* Secure Originator changed. */
+#define BANK_SETTLE_ENERGY 0x3 /* Bank ledger(energy field) rolled up to tasks. */
+
+/* Codes for ATM_SUBAID_INFO */
+#define ATM_MIN_CALLED 0x1
+#define ATM_LINK_LIST_TRIM 0x2
+
+/* Codes for ATM_GETVALUE_INFO */
+#define ATM_VALUE_REPLACED 0x1
+#define ATM_VALUE_ADDED 0x2
+
+/* Codes for ATM_UNREGISTER_INFO */
+#define ATM_VALUE_UNREGISTERED 0x1
+#define ATM_VALUE_DIFF_MAILBOX 0x2
+
+/* Kernel Debug Sub Classes for daemons (DBG_DAEMON) */
+#define DBG_DAEMON_COREDUET 0x1
+#define DBG_DAEMON_POWERD 0x2
+
+/* Subclasses for the user space allocator */
+#define DBG_UMALLOC_EXTERNAL 0x1
+#define DBG_UMALLOC_INTERNAL 0x2
/**********************************************************************/
-#define KDBG_CODE(Class, SubClass, code) (((Class & 0xff) << 24) | ((SubClass & 0xff) << 16) | ((code & 0x3fff) << 2))
-
-#define KDBG_MIGCODE(msgid) ((DBG_MIG << 24) | (((msgid) & 0x3fffff) << 2))
+#define KDBG_MIGCODE(msgid) ((DBG_MIG << KDBG_CLASS_OFFSET) | \
+ (((msgid) & 0x3fffff) << KDBG_CODE_OFFSET))
#define MACHDBG_CODE(SubClass, code) KDBG_CODE(DBG_MACH, SubClass, code)
#define NETDBG_CODE(SubClass, code) KDBG_CODE(DBG_NETWORK, SubClass, code)
#define DYLDDBG_CODE(SubClass,code) KDBG_CODE(DBG_DYLD, SubClass, code)
#define QTDBG_CODE(SubClass,code) KDBG_CODE(DBG_QT, SubClass, code)
#define APPSDBG_CODE(SubClass,code) KDBG_CODE(DBG_APPS, SubClass, code)
+#define ARIADNEDBG_CODE(SubClass, code) KDBG_CODE(DBG_ARIADNE, SubClass, code)
+#define DAEMONDBG_CODE(SubClass, code) KDBG_CODE(DBG_DAEMON, SubClass, code)
#define CPUPM_CODE(code) IOKDBG_CODE(DBG_IOCPUPM, code)
#define KMEM_ALLOC_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 0)
#define PMAP_CODE(code) MACHDBG_CODE(DBG_MACH_PMAP, code)
-/* Usage:
-* kernel_debug((KDBG_CODE(DBG_NETWORK, DNET_PROTOCOL, 51) | DBG_FUNC_START),
-* offset, 0, 0, 0,0)
-*
-* For ex,
-*
-* #include <sys/kdebug.h>
-*
-* #define DBG_NETIPINIT NETDBG_CODE(DBG_NETIP,1)
-*
-*
-* void
-* ip_init()
-* {
-* register struct protosw *pr;
-* register int i;
-*
-* KERNEL_DEBUG(DBG_NETIPINIT | DBG_FUNC_START, 0,0,0,0,0)
-* --------
-* KERNEL_DEBUG(DBG_NETIPINIT, 0,0,0,0,0)
-* --------
-* KERNEL_DEBUG(DBG_NETIPINIT | DBG_FUNC_END, 0,0,0,0,0)
-* }
-*
-*/
+#define IMPORTANCE_CODE(SubClass, code) KDBG_CODE(DBG_IMPORTANCE, (SubClass), (code))
+#define BANK_CODE(SubClass, code) KDBG_CODE(DBG_BANK, (SubClass), (code))
+#define ATM_CODE(SubClass, code) KDBG_CODE(DBG_ATM, (SubClass), (code))
+
+/* Kernel Debug Macros for specific daemons */
+#define COREDUETDBG_CODE(code) DAEMONDBG_CODE(DBG_DAEMON_COREDUET, code)
+#define POWERDDBG_CODE(code) DAEMONDBG_CODE(DBG_DAEMON_POWERD, code)
+
+/*
+ * To use kdebug in the kernel:
+ *
+ * #include <sys/kdebug.h>
+ *
+ * #define DBG_NETIPINIT NETDBG_CODE(DBG_NETIP, 1)
+ *
+ * void
+ * ip_init(void)
+ * {
+ * KDBG(DBG_NETIPINIT | DBG_FUNC_START, 1, 2, 3, 4);
+ * ...
+ * KDBG(DBG_NETIPINIT);
+ * ...
+ * KDBG(DBG_NETIPINIT | DBG_FUNC_END);
+ * }
+ */
+
+#ifdef KERNEL_PRIVATE
+
+/*
+ * The KDBG{,_DEBUG,_RELEASE,_FILTERED} macros are the preferred method of
+ * making tracepoints.
+ *
+ * Kernel pointers must be unslid or permuted using VM_KERNEL_UNSLIDE_OR_PERM.
+ * Do not trace any sensitive data.
+ */
+
+/*
+ * Traced on debug and development (and release OS X) kernels.
+ */
+#define KDBG(x, ...) KDBG_(, x, ## __VA_ARGS__, 4, 3, 2, 1, 0)
+
+/*
+ * Traced on debug and development (and release OS X) kernels if explicitly
+ * requested. Omitted from tracing without a typefilter.
+ */
+#define KDBG_FILTERED(x, ...) KDBG_(_FILTERED, x, ## __VA_ARGS__, 4, 3, 2, 1, 0)
+
+/*
+ * Traced on debug, development, and release kernels.
+ *
+ * Only use this tracepoint if the events are required for a shipping trace
+ * tool.
+ */
+#define KDBG_RELEASE(x, ...) KDBG_(_RELEASE, x, ## __VA_ARGS__, 4, 3, 2, 1, 0)
+
+/*
+ * Traced only on debug kernels.
+ */
+#define KDBG_DEBUG(x, ...) KDBG_(_DEBUG, x, ## __VA_ARGS__, 4, 3, 2, 1, 0)
+
+#define KDBG_(f, x, a, b, c, d, n, ...) KDBG##n(f, x, a, b, c, d)
+#define KDBG0(f, x, a, b, c, d) KERNEL_DEBUG_CONSTANT##f(x, 0, 0, 0, 0, 0)
+#define KDBG1(f, x, a, b, c, d) KERNEL_DEBUG_CONSTANT##f(x, a, 0, 0, 0, 0)
+#define KDBG2(f, x, a, b, c, d) KERNEL_DEBUG_CONSTANT##f(x, a, b, 0, 0, 0)
+#define KDBG3(f, x, a, b, c, d) KERNEL_DEBUG_CONSTANT##f(x, a, b, c, 0, 0)
+#define KDBG4(f, x, a, b, c, d) KERNEL_DEBUG_CONSTANT##f(x, a, b, c, d, 0)
+
+#endif /* defined(KERNEL_PRIVATE) */
extern unsigned int kdebug_enable;
-#define KDEBUG_ENABLE_TRACE 0x1
-#define KDEBUG_ENABLE_ENTROPY 0x2
-#define KDEBUG_ENABLE_CHUD 0x4
-#if (!defined(NO_KDEBUG))
+/*
+ * Bits used by kdebug_enable. These control which events are traced at
+ * runtime.
+ */
+#define KDEBUG_ENABLE_TRACE (1U << 0)
+#define KDEBUG_ENABLE_ENTROPY (1U << 1) /* obsolete */
+#define KDEBUG_ENABLE_CHUD (1U << 2) /* obsolete */
+#define KDEBUG_ENABLE_PPT (1U << 3)
+#define KDEBUG_ENABLE_SERIAL (1U << 4)
-#define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e) \
-do { \
- if (kdebug_enable) \
- kernel_debug(x,(uintptr_t)a,(uintptr_t)b,(uintptr_t)c, \
- (uintptr_t)d,(uintptr_t)e); \
-} while(0)
+#define KDEBUG_TRACE (KDEBUG_ENABLE_TRACE)
-#define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e) \
-do { \
- if (kdebug_enable) \
- kernel_debug1(x,(uintptr_t)a,(uintptr_t)b,(uintptr_t)c, \
- (uintptr_t)d,(uintptr_t)e); \
-} while(0)
+/*
+ * Specify KDEBUG_PPT to indicate that the event belongs to the limited PPT set.
+ * PPT is deprecated -- use a typefilter and the PPTDBG class instead.
+ */
+#define KDEBUG_PPT (KDEBUG_ENABLE_PPT)
+#define KDEBUG_COMMON (KDEBUG_ENABLE_TRACE | KDEBUG_ENABLE_PPT)
+
+/*
+ * The kernel debug configuration level. These values control which events are
+ * compiled in under different build configurations.
+ *
+ * Infer the supported kernel debug event level from config option. Use
+ * (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) as a guard to protect unaudited debug
+ * code.
+ */
+#define KDEBUG_LEVEL_NONE 0
+#define KDEBUG_LEVEL_IST 1
+#define KDEBUG_LEVEL_STANDARD 2
+#define KDEBUG_LEVEL_FULL 3
+
+#if NO_KDEBUG
+#define KDEBUG_LEVEL KDEBUG_LEVEL_NONE
+#elif IST_KDEBUG
+#define KDEBUG_LEVEL KDEBUG_LEVEL_IST
+ // currently configured for the iOS release kernel
+#elif KDEBUG
+#define KDEBUG_LEVEL KDEBUG_LEVEL_FULL
+#else
+#define KDEBUG_LEVEL KDEBUG_LEVEL_STANDARD
+/*
+ * Currently, all other kernel configurations (development, etc) build with
+ * KDEBUG_LEVEL_STANDARD. As a result, KERNEL_DEBUG_CONSTANT*() are on by
+ * default but KERNEL_DEBUG*() are not.
+ */
+#endif
+#ifdef XNU_KERNEL_PRIVATE
+#define KDBG_IMPROBABLE __improbable
#else
+#define KDBG_IMPROBABLE
+#endif
-#define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e)
-#define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e)
+/*
+ * KERNEL_DEBUG_CONSTANT_FILTERED events are omitted from tracing unless they
+ * are explicitly requested in the typefilter. They are not emitted when
+ * tracing without a typefilter.
+ */
+#if (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD)
+#define KERNEL_DEBUG_CONSTANT_FILTERED(x, a, b, c, d, ...) \
+ do { \
+ if (KDBG_IMPROBABLE(kdebug_enable & ~KDEBUG_ENABLE_PPT)) { \
+ kernel_debug_filtered((x), (uintptr_t)(a), (uintptr_t)(b), \
+ (uintptr_t)(c), (uintptr_t)(d)); \
+ } \
+ } while (0)
+#else /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) */
+#define KERNEL_DEBUG_CONSTANT_FILTERED(type, x, a, b, c, d, ...) do {} while (0)
+#endif /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) */
+
+#if (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD)
+#define KERNEL_DEBUG_CONSTANT(x, a, b, c, d, e) \
+ do { \
+ if (KDBG_IMPROBABLE(kdebug_enable & ~KDEBUG_ENABLE_PPT)) { \
+ kernel_debug((x), (uintptr_t)(a), (uintptr_t)(b), (uintptr_t)(c), \
+ (uintptr_t)(d),(uintptr_t)(e)); \
+ } \
+ } while (0)
+/*
+ * DO NOT USE THIS MACRO -- it breaks fundamental assumptions about ktrace and
+ * is only meant to be used by the pthread kext and other points in the kernel
+ * where the thread ID must be provided explicitly.
+ */
+#define KERNEL_DEBUG_CONSTANT1(x, a, b, c, d, e) \
+ do { \
+ if (KDBG_IMPROBABLE(kdebug_enable & ~KDEBUG_ENABLE_PPT)) { \
+ kernel_debug1((x), (uintptr_t)(a), (uintptr_t)(b), (uintptr_t)(c), \
+ (uintptr_t)(d), (uintptr_t)(e)); \
+ } \
+ } while (0)
+
+#define KERNEL_DEBUG_EARLY(x, a, b, c, d) \
+ do { \
+ kernel_debug_early((uint32_t)(x), (uintptr_t)(a), (uintptr_t)(b), \
+ (uintptr_t)(c), (uintptr_t)(d)); \
+ } while (0)
+#else /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) */
+#define KERNEL_DEBUG_CONSTANT(x, a, b, c, d, e) do {} while (0)
+#define KERNEL_DEBUG_CONSTANT1(x, a, b, c, d, e) do {} while (0)
+#define KERNEL_DEBUG_EARLY(x, a, b, c, d) do {} while (0)
+#endif /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) */
+
+/*
+ * KERNEL_DEBUG_CONSTANT_IST (in-system trace) events provide an audited subset
+ * of tracepoints for userland system tracing tools. This tracing level was
+ * created by 8857227 to protect fairplayd and other PT_DENY_ATTACH processes.
+ * It has two effects: only KERNEL_DEBUG_CONSTANT_IST() traces are emitted and
+ * any PT_DENY_ATTACH processes will only emit basic traces as defined by the
+ * kernel_debug_filter() routine.
+ */
+#define KERNEL_DEBUG_CONSTANT_RELEASE(x, a, b, c, d, e) \
+ KERNEL_DEBUG_CONSTANT_IST(~KDEBUG_ENABLE_PPT, x, a, b, c, d, 0)
+
+#if (KDEBUG_LEVEL >= KDEBUG_LEVEL_IST)
+#define KERNEL_DEBUG_CONSTANT_IST(type, x, a, b, c, d, e) \
+ do { \
+ if (KDBG_IMPROBABLE(kdebug_enable & (type))) { \
+ kernel_debug((x), (uintptr_t)(a), (uintptr_t)(b), (uintptr_t)(c), \
+ (uintptr_t)(d), 0); \
+ } \
+ } while (0)
+#define KERNEL_DEBUG_CONSTANT_IST1(x, a, b, c, d, e) \
+ do { \
+ if (KDBG_IMPROBABLE(kdebug_enable)) { \
+ kernel_debug1((x), (uintptr_t)(a), (uintptr_t)(b), (uintptr_t)(c), \
+ (uintptr_t)(d), (uintptr_t)(e)); \
+ } \
+ } while (0)
+#else /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_IST) */
+#define KERNEL_DEBUG_CONSTANT_IST(type, x, a, b, c, d, e) do {} while (0)
+#define KERNEL_DEBUG_CONSTANT_IST1(x, a, b, c, d, e) do {} while (0)
+#endif /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_IST) */
+
+#if NO_KDEBUG
#define __kdebug_constant_only __unused
#endif
+/*
+ * KERNEL_DEBUG events are only traced for DEBUG kernels.
+ */
+#define KERNEL_DEBUG_CONSTANT_DEBUG(x, a, b, c, d, e) \
+ KERNEL_DEBUG(x, a, b, c, d, e)
+
+#if (KDEBUG_LEVEL >= KDEBUG_LEVEL_FULL)
+#define __kdebug_only
+
+#define KERNEL_DEBUG(x, a, b, c, d, e) \
+ do { \
+ if (KDBG_IMPROBABLE(kdebug_enable & ~KDEBUG_ENABLE_PPT)) { \
+ kernel_debug((uint32_t)(x), (uintptr_t)(a), (uintptr_t)(b), \
+ (uintptr_t)(c), (uintptr_t)(d), (uintptr_t)(e)); \
+ } \
+ } while (0)
+
+/*
+ * DO NOT USE THIS MACRO -- see warning above for KERNEL_DEBUG_CONSTANT1.
+ */
+#define KERNEL_DEBUG1(x, a, b, c, d, e) \
+ do { \
+ if (KDBG_IMPROBABLE(kdebug_enable & ~KDEBUG_ENABLE_PPT)) { \
+ kernel_debug1((uint32_t)(x), (uintptr_t)(a), (uintptr_t)(b), \
+ (uintptr_t)(c), (uintptr_t)(d), (uintptr_t)(e)); \
+ } \
+ } while (0)
+
+#else /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_FULL) */
+#define __kdebug_only __unused
+
+#define KERNEL_DEBUG(x,a,b,c,d,e) do {} while (0)
+#define KERNEL_DEBUG1(x,a,b,c,d,e) do {} while (0)
+#endif /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_FULL) */
+
+
extern void kernel_debug(
uint32_t debugid,
uintptr_t arg1,
uintptr_t arg4,
uintptr_t arg5);
+extern void kernel_debug_filtered(
+ uint32_t debugid,
+ uintptr_t arg1,
+ uintptr_t arg2,
+ uintptr_t arg3,
+ uintptr_t arg4);
+
+extern void kernel_debug_early(
+ uint32_t debugid,
+ uintptr_t arg1,
+ uintptr_t arg2,
+ uintptr_t arg3,
+ uintptr_t arg4);
-#if (KDEBUG && (!defined(NO_KDEBUG)))
+/*
+ * EnergyTracing macros.
+ */
-#define KERNEL_DEBUG(x,a,b,c,d,e) \
+#if (KDEBUG_LEVEL >= KDEBUG_LEVEL_IST)
+// whether to bother calculating EnergyTracing inputs
+// could change in future to see if DBG_ENERGYTRACE is active
+#define ENTR_SHOULDTRACE kdebug_enable
+// encode logical EnergyTracing into 32/64 KDebug trace
+#define ENTR_KDTRACE(component, opcode, lifespan, id, quality, value) \
do { \
- if (kdebug_enable) \
- kernel_debug((uint32_t)x, (uintptr_t)a, (uintptr_t)b, \
- (uintptr_t)c, (uintptr_t)d, (uintptr_t)e); \
+ uint32_t kdcode__; \
+ uintptr_t highval__, lowval__, mask__ = 0xffffffff; \
+ kdcode__ = KDBG_CODE(DBG_ENERGYTRACE,component,opcode)|(lifespan); \
+ highval__ = ((value) >> 32) & mask__; \
+ lowval__ = (value) & mask__; \
+ ENTR_KDTRACEFUNC(kdcode__, id, quality, highval__, lowval__); \
} while(0)
-#define KERNEL_DEBUG1(x,a,b,c,d,e) \
+/*
+ Trace the association of two existing activations.
+
+ An association is traced as a modification to the parent activation.
+ In order to fit the sub-activation's component, activation code, and
+ activation ID into a kdebug tracepoint, the arguments that would hold
+ the value are left separate, and one stores the component and opcode
+ of the sub-activation, while the other stores the pointer-sized
+ activation ID.
+
+ arg2 arg3 arg4
+ +-----------------+ +~+----+----+--------+ +----------+
+ |kEnTrModAssociate| | | | | | | |
+ +-----------------+ +~+----+----+--------+ +----------+
+ 8-bits unused sub-activation ID
+ 8-bit sub-component
+ 16-bit sub-opcode
+
+*/
+#define kEnTrModAssociate (1 << 28)
+#define ENTR_KDASSOCIATE(par_comp, par_opcode, par_act_id, \
+ sub_comp, sub_opcode, sub_act_id) \
do { \
- if (kdebug_enable) \
- kernel_debug1((uint32_t)x, (uintptr_t)a, (uintptr_t)b, \
- (uintptr_t)c, (uintptr_t)d, (uintptr_t)e); \
+ unsigned sub_compcode = ((unsigned)sub_comp << 16) | sub_opcode; \
+ ENTR_KDTRACEFUNC(KDBG_CODE(DBG_ENERGYTRACE,par_comp,par_opcode), \
+ par_act_id, kEnTrModAssociate, sub_compcode, \
+ sub_act_id); \
} while(0)
-#define __kdebug_only
+#else /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_IST) */
-#else
+#define ENTR_SHOULDTRACE FALSE
+#define ENTR_KDTRACE(component, opcode, lifespan, id, quality, value) \
+ do {} while (0)
+#define ENTR_KDASSOCIATE(par_comp, par_opcode, par_act_id, \
+ sub_comp, sub_opcode, sub_act_id) \
+ do {} while (0)
-#define KERNEL_DEBUG(x,a,b,c,d,e) do {} while (0)
-#define KERNEL_DEBUG1(x,a,b,c,d,e) do {} while (0)
+#endif /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_IST) */
-#define __kdebug_only __unused
+#ifdef KERNEL_PRIVATE
+/*
+ * kernel_debug_string provides the same functionality as the
+ * kdebug_trace_string syscall as a KPI. str_id is an in/out
+ * parameter that, if it's pointing to a string ID of 0, will
+ * receive a generated ID. If it provides a value in str_id,
+ * then that will be used, instead.
+ *
+ * Returns an errno indicating the type of failure.
+ */
+extern int
+kernel_debug_string(uint32_t debugid, uint64_t *str_id, const char *str);
+
+/*
+ * kernel_debug_disable disables event logging, but leaves any buffers
+ * intact.
+ */
+extern void kernel_debug_disable(void);
#endif
+/*
+ * Bits set in the comm page for kdebug.
+ */
+#define KDEBUG_COMMPAGE_ENABLE_TRACE 0x1
+#define KDEBUG_COMMPAGE_ENABLE_TYPEFILTER 0x2 /* Forced to false if ENABLE_TRACE is 0 */
+
+// for EnergyTracing user space & clients
+#define kEnTrCompKernel 2
+
+/*
+ EnergyTracing opcodes
+
+ Activations use DBG_FUNC_START/END.
+ Events are DBG_FUNC_NONE.
+ */
+
+/* Socket reads and writes are uniquely identified by the (sanitized)
+ pointer to the socket struct in question. To associate this address
+ with the user space file descriptor, we have a socket activation with
+ the FD as its identifier and the socket struct pointer as its value.
+*/
+#define kEnTrActKernSocket 1
+#define kEnTrActKernSockRead 2
+#define kEnTrActKernSockWrite 3
+
+#define kEnTrActKernPoll 10
+#define kEnTrActKernSelect 11
+#define kEnTrActKernKQWait 12
+
+// events
+#define kEnTrEvUnblocked 256
+
+// EnergyTracing flags (the low-order 16 bits of 'quality')
+#define kEnTrFlagNonBlocking 1 << 0
+#define kEnTrFlagNoWork 1 << 1
+
+// and now the internal mechanism
#ifdef KERNEL_PRIVATE
+
+// 20452597 requests that the trace macros not take an argument it throws away
+#define KERNEL_DBG_IST_SANE(x, a, b, c, d) \
+ KERNEL_DEBUG_CONSTANT_IST(KDEBUG_TRACE, x, a, b, c, d, \
+ 0 /*__unused in kernel_debug()*/)
+#define ENTR_KDTRACEFUNC KERNEL_DBG_IST_SANE
+
+// value is int64_t, quality is uint32_t
+#define KERNEL_ENERGYTRACE(opcode, lifespan, id, quality, value) \
+ ENTR_KDTRACE(kEnTrCompKernel, opcode, lifespan, id, \
+ quality, value)
+#define KERNEL_ENTR_ASSOCIATE(par_opcode, par_act_id, sub_opcode, sub_act_id) \
+ ENTR_KDASSOCIATE(kEnTrCompKernel, par_opcode, par_act_id, \
+ kEnTrCompKernel, sub_opcode, sub_act_id)
+
+// end EnergyTracing
+
+
+#include <mach/boolean.h>
+
+#define NUMPARMS 23
+
struct proc;
-extern void kdbg_trace_data(struct proc *proc, long *arg_pid);
-extern void kdbg_trace_string(struct proc *proc, long *arg1, long *arg2, long *arg3, long *arg4);
+/*
+ * Returns false if the debugid is disabled by filters, and true if the
+ * debugid is allowed to be traced. A debugid may not be traced if the
+ * typefilter disables its class and subclass, it's outside a range
+ * check, or if it's not an allowed debugid in a value check. Trace
+ * system events bypass this check.
+ */
+boolean_t kdebug_debugid_enabled(uint32_t debugid);
+
+/*
+ * Returns true only if the debugid is explicitly enabled by filters. Returns
+ * false otherwise, including when no filters are active.
+ */
+boolean_t kdebug_debugid_explicitly_enabled(uint32_t debugid);
+
+uint32_t kdebug_commpage_state(void);
+void kdebug_lookup_gen_events(long *dbg_parms, int dbg_namelen, void *dp, boolean_t lookup);
+void kdbg_trace_data(struct proc *proc, long *arg_pid, long *arg_uniqueid);
+
+void kdbg_trace_string(struct proc *proc, long *arg1, long *arg2, long *arg3, long *arg4);
-extern void kdbg_dump_trace_to_file(const char *);
-void start_kern_tracing(unsigned int);
-#endif /* KERNEL_PRIVATE */
+void kdbg_dump_trace_to_file(const char *);
+void kdebug_init(unsigned int n_events, char *filterdesc, boolean_t wrapping);
+void kdebug_trace_start(unsigned int n_events, const char *filterdesc,
+ boolean_t wrapping, boolean_t at_wake);
+void kdebug_free_early_buf(void);
+struct task;
+boolean_t disable_wrap(uint32_t *old_slowcheck, uint32_t *old_flags);
+void enable_wrap(uint32_t old_slowcheck, boolean_t lostevents);
+void release_storage_unit(int cpu, uint32_t storage_unit);
+int allocate_storage_unit(int cpu);
+#define KDBG_CLASS_ENCODE(Class, SubClass) KDBG_EVENTID(Class, SubClass, 0)
+#define KDBG_CLASS_DECODE(Debugid) (Debugid & KDBG_CSC_MASK)
+#endif /* KERNEL_PRIVATE */
#endif /* __APPLE_API_UNSTABLE */
__END_DECLS
-
-#ifdef PRIVATE
+#ifdef PRIVATE
#ifdef __APPLE_API_PRIVATE
/*
* private kernel_debug definitions
*/
typedef struct {
- uint64_t timestamp;
- uintptr_t arg1;
- uintptr_t arg2;
- uintptr_t arg3;
- uintptr_t arg4;
- uintptr_t arg5; /* will hold current thread */
- uint32_t debugid;
+ uint64_t timestamp;
+ uintptr_t arg1;
+ uintptr_t arg2;
+ uintptr_t arg3;
+ uintptr_t arg4;
+ uintptr_t arg5; /* the thread ID */
+ uint32_t debugid;
#if defined(__LP64__)
- uint32_t cpuid;
- uintptr_t unused;
+ uint32_t cpuid;
+ uintptr_t unused;
#endif
} kd_buf;
#if !defined(__LP64__)
-#define KDBG_TIMESTAMP_MASK 0x00ffffffffffffffULL
-#define KDBG_CPU_MASK 0x0f00000000000000ULL
-#define KDBG_CPU_SHIFT 56
+#define KDBG_TIMESTAMP_MASK 0x00ffffffffffffffULL
+#define KDBG_CPU_MASK 0xff00000000000000ULL
+#define KDBG_CPU_SHIFT 56
static inline void
kdbg_set_cpu(kd_buf *kp, int cpu)
{
- kp->timestamp = (kp->timestamp & KDBG_TIMESTAMP_MASK) |
+ kp->timestamp = (kp->timestamp & KDBG_TIMESTAMP_MASK) |
(((uint64_t) cpu) << KDBG_CPU_SHIFT);
}
static inline int
return (int) (((kp)->timestamp & KDBG_CPU_MASK) >> KDBG_CPU_SHIFT);
}
static inline void
-kdbg_set_timestamp(kd_buf *kp, uint64_t time)
+kdbg_set_timestamp(kd_buf *kp, uint64_t thetime)
{
- kp->timestamp = time & KDBG_TIMESTAMP_MASK;
+ kp->timestamp = thetime & KDBG_TIMESTAMP_MASK;
}
static inline uint64_t
kdbg_get_timestamp(kd_buf *kp)
return kp->timestamp & KDBG_TIMESTAMP_MASK;
}
static inline void
-kdbg_set_timestamp_and_cpu(kd_buf *kp, uint64_t time, int cpu)
+kdbg_set_timestamp_and_cpu(kd_buf *kp, uint64_t thetime, int cpu)
{
- kp->timestamp = (time & KDBG_TIMESTAMP_MASK) |
+ kp->timestamp = (thetime & KDBG_TIMESTAMP_MASK) |
(((uint64_t) cpu) << KDBG_CPU_SHIFT);
}
#else
static inline void
kdbg_set_cpu(kd_buf *kp, int cpu)
{
- kp->cpuid = cpu;
+ kp->cpuid = (unsigned int)cpu;
}
static inline int
kdbg_get_cpu(kd_buf *kp)
{
- return kp->cpuid;
+ return (int)kp->cpuid;
}
static inline void
-kdbg_set_timestamp(kd_buf *kp, uint64_t time)
+kdbg_set_timestamp(kd_buf *kp, uint64_t thetime)
{
- kp->timestamp = time;
+ kp->timestamp = thetime;
}
static inline uint64_t
kdbg_get_timestamp(kd_buf *kp)
return kp->timestamp;
}
static inline void
-kdbg_set_timestamp_and_cpu(kd_buf *kp, uint64_t time, int cpu)
+kdbg_set_timestamp_and_cpu(kd_buf *kp, uint64_t thetime, int cpu)
{
- kdbg_set_timestamp(kp, time);
+ kdbg_set_timestamp(kp, thetime);
kdbg_set_cpu(kp, cpu);
}
#endif
-/* Debug Flags */
-#define KDBG_INIT 0x001
-#define KDBG_NOWRAP 0x002
-#define KDBG_FREERUN 0x004
-#define KDBG_WRAPPED 0x008
-#define KDBG_USERFLAGS (KDBG_FREERUN|KDBG_NOWRAP|KDBG_INIT)
-#define KDBG_PIDCHECK 0x010
-#define KDBG_MAPINIT 0x020
-#define KDBG_PIDEXCLUDE 0x040
-#define KDBG_LOCKINIT 0x080
-#define KDBG_LP64 0x100
+/*
+ * 2^16 bits (8 kilobytes), one for each possible class/subclass combination
+ */
+#define KDBG_TYPEFILTER_BITMAP_SIZE ((256 * 256) / 8)
+
+/*
+ * Bits for kd_ctrl_page.flags, KERN_KD{D,E}FLAGS.
+ */
+#define KDBG_INIT (1U << 0) /* obsolete */
+/* disable tracing when buffers are full */
+#define KDBG_NOWRAP (1U << 1)
+#define KDBG_FREERUN (1U << 2) /* obsolete */
+/* buffer has wrapped */
+#define KDBG_WRAPPED (1U << 3)
+/* flags that are allowed to be set by user space */
+#define KDBG_USERFLAGS (KDBG_FREERUN | KDBG_NOWRAP | KDBG_INIT)
+/* only include processes with kdebug bit set in proc */
+#define KDBG_PIDCHECK (1U << 4)
+/* thread map is initialized */
+#define KDBG_MAPINIT (1U << 5)
+/* exclude processes based on kdebug bit in proc */
+#define KDBG_PIDEXCLUDE (1U << 6)
+/* whether the kdebug locks are intialized */
+#define KDBG_LOCKINIT (1U << 7)
+/* word size of the kernel */
+#define KDBG_LP64 (1U << 8)
+
+/* bits for kd_ctrl_page.flags and kbufinfo_t.flags */
+
+/* only trace events within a range */
+#define KDBG_RANGECHECK 0x00100000U
+/* only trace at most 4 types of events, at the code granularity */
+#define KDBG_VALCHECK 0x00200000U
+/* check class and subclass against the typefilter */
+#define KDBG_TYPEFILTER_CHECK 0x00400000U
+/* kdebug trace buffers are initialized */
+#define KDBG_BUFINIT 0x80000000U
+
+/* bits for the type field of kd_regtype */
+#define KDBG_CLASSTYPE 0x10000
+#define KDBG_SUBCLSTYPE 0x20000
+#define KDBG_RANGETYPE 0x40000
+#define KDBG_TYPENONE 0x80000
+#define KDBG_CKTYPES 0xF0000
typedef struct {
- unsigned int type;
- unsigned int value1;
- unsigned int value2;
- unsigned int value3;
- unsigned int value4;
-
+ unsigned int type;
+ unsigned int value1;
+ unsigned int value2;
+ unsigned int value3;
+ unsigned int value4;
} kd_regtype;
-typedef struct
-{
- int nkdbufs;
- int nolog;
- int flags;
- int nkdthreads;
- int bufid;
+typedef struct {
+ /* number of events that can fit in the buffers */
+ int nkdbufs;
+ /* set if trace is disabled */
+ int nolog;
+ /* kd_ctrl_page.flags */
+ unsigned int flags;
+ /* number of threads in thread map */
+ int nkdthreads;
+ /* the owning pid */
+ int bufid;
} kbufinfo_t;
typedef struct {
- uintptr_t thread;
- int valid;
- char command[20];
+ /* the thread ID */
+ uintptr_t thread;
+ /* 0 for invalid, otherwise the PID (or 1 for kernel_task) */
+ int valid;
+ /* the name of the process owning the thread */
+ char command[20];
} kd_threadmap;
-#define KDBG_CLASSTYPE 0x10000
-#define KDBG_SUBCLSTYPE 0x20000
-#define KDBG_RANGETYPE 0x40000
-#define KDBG_TYPENONE 0x80000
-#define KDBG_CKTYPES 0xF0000
-
-#define KDBG_RANGECHECK 0x100000
-#define KDBG_VALCHECK 0x200000 /* Check up to 4 individual values */
-
-#define KDBG_BUFINIT 0x80000000
-
-/* Control operations */
-#define KDBG_EFLAGS 1
-#define KDBG_DFLAGS 2
-#define KDBG_ENABLE 3
-#define KDBG_SETNUMBUF 4
-#define KDBG_GETNUMBUF 5
-#define KDBG_SETUP 6
-#define KDBG_REMOVE 7
-#define KDBG_SETREGCODE 8
-#define KDBG_GETREGCODE 9
-#define KDBG_READTRACE 10
-#define KDBG_PIDTR 11
-#define KDBG_THRMAP 12
-#define KDBG_PIDEX 14
-#define KDBG_SETRTCDEC 15
-#define KDBG_KDGETENTROPY 16
-
-/* Minimum value allowed when setting decrementer ticks */
-#define KDBG_MINRTCDEC 2500
+typedef struct {
+ uint32_t version_no;
+ uint32_t cpu_count;
+} kd_cpumap_header;
+
+/* cpumap flags */
+#define KDBG_CPUMAP_IS_IOP 0x1
+
+typedef struct {
+ uint32_t cpu_id;
+ uint32_t flags;
+ char name[8];
+} kd_cpumap;
+
+/*
+ * TRACE file formats...
+ *
+ * RAW_VERSION0
+ *
+ * uint32_t #threadmaps
+ * kd_threadmap[]
+ * kd_buf[]
+ *
+ * RAW_VERSION1
+ *
+ * RAW_header, with version_no set to RAW_VERSION1
+ * kd_threadmap[]
+ * Empty space to pad alignment to the nearest page boundary.
+ * kd_buf[]
+ *
+ * RAW_VERSION1+
+ *
+ * RAW_header, with version_no set to RAW_VERSION1
+ * kd_threadmap[]
+ * kd_cpumap_header, with version_no set to RAW_VERSION1
+ * kd_cpumap[]
+ * Empty space to pad alignment to the nearest page boundary.
+ * kd_buf[]
+ *
+ * V1+ implementation details...
+ *
+ * It would have been nice to add the cpumap data "correctly", but there were
+ * several obstacles. Existing code attempts to parse both V1 and V0 files.
+ * Due to the fact that V0 has no versioning or header, the test looks like
+ * this:
+ *
+ * // Read header
+ * if (header.version_no != RAW_VERSION1) { // Assume V0 }
+ *
+ * If we add a VERSION2 file format, all existing code is going to treat that
+ * as a VERSION0 file when reading it, and crash terribly when trying to read
+ * RAW_VERSION2 threadmap entries.
+ *
+ * To differentiate between a V1 and V1+ file, read as V1 until you reach
+ * the padding bytes. Then:
+ *
+ * boolean_t is_v1plus = FALSE;
+ * if (padding_bytes >= sizeof(kd_cpumap_header)) {
+ * kd_cpumap_header header = // read header;
+ * if (header.version_no == RAW_VERSION1) {
+ * is_v1plus = TRUE;
+ * }
+ * }
+ *
+ */
+
+typedef struct {
+ int version_no;
+ int thread_count;
+ uint64_t TOD_secs;
+ uint32_t TOD_usecs;
+} RAW_header;
+
+// Version 3 header
+// The header chunk has the tag 0x00001000 which also serves as a magic word
+// that identifies the file as a version 3 trace file. The header payload is
+// a set of fixed fields followed by a variable number of sub-chunks:
+/*
+ ____________________________________________________________________________
+ | Offset | Size | Field |
+ ----------------------------------------------------------------------------
+ | 0 | 4 | Tag (0x00001000) |
+ | 4 | 4 | Sub-tag. Represents the version of the header. |
+ | 8 | 8 | Length of header payload (40+8x) |
+ | 16 | 8 | Time base info. Two 32-bit numbers, numer/denom, |
+ | | | for converting timestamps to nanoseconds. |
+ | 24 | 8 | Timestamp of trace start. |
+ | 32 | 8 | Wall time seconds since Unix epoch. |
+ | | | As returned by gettimeofday(). |
+ | 40 | 4 | Wall time microseconds. As returned by gettimeofday(). |
+ | 44 | 4 | Local time zone offset in minutes. ( " ) |
+ | 48 | 4 | Type of daylight savings time correction to apply. ( " ) |
+ | 52 | 4 | Flags. 1 = 64-bit. Remaining bits should be written |
+ | | | as 0 and ignored when reading. |
+ | 56 | 8x | Variable number of sub-chunks. None are required. |
+ | | | Ignore unknown chunks. |
+ ----------------------------------------------------------------------------
+*/
+// NOTE: The header sub-chunks are considered part of the header chunk,
+// so they must be included in the header chunk’s length field.
+// The CPU map is an optional sub-chunk of the header chunk. It provides
+// information about the CPUs that are referenced from the trace events.
+typedef struct {
+ uint32_t tag;
+ uint32_t sub_tag;
+ uint64_t length;
+ uint32_t timebase_numer;
+ uint32_t timebase_denom;
+ uint64_t timestamp;
+ uint64_t walltime_secs;
+ uint32_t walltime_usecs;
+ uint32_t timezone_minuteswest;
+ uint32_t timezone_dst;
+ uint32_t flags;
+} __attribute__((packed)) kd_header_v3;
+
+typedef struct {
+ uint32_t tag;
+ uint32_t sub_tag;
+ uint64_t length;
+} __attribute__((packed)) kd_chunk_header_v3;
+
+#define RAW_VERSION0 0x55aa0000
+#define RAW_VERSION1 0x55aa0101
+#define RAW_VERSION2 0x55aa0200 /* Only used by kperf and Instruments */
+#define RAW_VERSION3 0x00001000
+
+#define V3_CONFIG 0x00001b00
+#define V3_CPU_MAP 0x00001c00
+#define V3_THREAD_MAP 0x00001d00
+#define V3_RAW_EVENTS 0x00001e00
+#define V3_NULL_CHUNK 0x00002000
+
+// The current version of all kernel managed chunks is 1. The
+// V3_CURRENT_CHUNK_VERSION is added to ease the simple case
+// when most/all the kernel managed chunks have the same version.
+
+#define V3_CURRENT_CHUNK_VERSION 1
+#define V3_HEADER_VERSION V3_CURRENT_CHUNK_VERSION
+#define V3_CPUMAP_VERSION V3_CURRENT_CHUNK_VERSION
+#define V3_THRMAP_VERSION V3_CURRENT_CHUNK_VERSION
+#define V3_EVENT_DATA_VERSION V3_CURRENT_CHUNK_VERSION
+
+// Apis to support writing v3 chunks in the kernel
+int kdbg_write_v3_chunk_header_to_buffer(void *buffer, uint32_t tag, uint32_t sub_tag, uint64_t length);
+int kdbg_write_v3_chunk_to_fd(uint32_t tag, uint32_t sub_tag, uint64_t length, void *payload, uint64_t payload_size, int fd);
+
+/* VFS lookup events for serial traces */
+#define VFS_LOOKUP (FSDBG_CODE(DBG_FSRW,36))
+#define VFS_LOOKUP_DONE (FSDBG_CODE(DBG_FSRW,39))
+
+#if !CONFIG_EMBEDDED
+#if defined(XNU_KERNEL_PRIVATE) && (DEVELOPMENT || DEBUG)
+#define KDEBUG_MOJO_TRACE 1
+#endif
+#endif
#endif /* __APPLE_API_PRIVATE */
-#endif /* PRIVATE */
+#endif /* PRIVATE */
#endif /* !BSD_SYS_KDEBUG_H */
projects / apple / xnu.git / blobdiff