X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/e5568f75972dfc723778653c11cb6b4dc825716a..bb59bff194111743b33cc36712410b5656329d3c:/bsd/sys/kdebug.h diff --git a/bsd/sys/kdebug.h b/bsd/sys/kdebug.h index 0f00781f6..af75e23a1 100644 --- a/bsd/sys/kdebug.h +++ b/bsd/sys/kdebug.h @@ -1,23 +1,29 @@ /* - * Copyright (c) 2000 Apple Computer, Inc. All rights reserved. + * Copyright (c) 2000-2014 Apple Inc. All rights reserved. * - * @APPLE_LICENSE_HEADER_START@ + * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * - * The contents of this file constitute Original Code as defined in and - * are subject to the Apple Public Source License Version 1.1 (the - * "License"). You may not use this file except in compliance with the - * License. Please obtain a copy of the License at - * http://www.apple.com/publicsource and read it before using this file. + * 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 + * compliance with the License. The rights granted to you under the License + * may not be used to create, or enable the creation or redistribution of, + * 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. * - * This Original Code and all software distributed under the License are - * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER + * 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, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the - * License for the specific language governing rights and limitations - * under the License. + * 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_LICENSE_HEADER_END@ + * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ /* Copyright (c) 1997 Apple Computer, Inc. All rights reserved. @@ -37,19 +43,67 @@ __BEGIN_DECLS #include #include -#if defined(KERNEL_BUILD) -#include -#endif /* KERNEL_BUILD */ + +#ifndef KERNEL +#include +#endif + +#ifdef XNU_KERNEL_PRIVATE +#include +#include +#endif + +#ifdef KERNEL_PRIVATE + +typedef enum +{ + KD_CALLBACK_KDEBUG_ENABLED, // Trace is now enabled. No arguments + KD_CALLBACK_KDEBUG_DISABLED, // Trace is now disabled. No arguments + KD_CALLBACK_SYNC_FLUSH, // Request the latest entries from the IOP, and block until complete. No arguments + KD_CALLBACK_TYPEFILTER_CHANGED, // Typefilter is enabled. A read-only pointer to the typefilter is provided, but is only valid while in the callback. +} 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; + char iop_name[8]; // null-terminated string with name of core. +}; + +typedef struct kd_callback kd_callback_t; /* - * types of faults that vm_fault handles - * and creates trace entries for + * 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). + * */ -#define DBG_ZERO_FILL_FAULT 1 -#define DBG_PAGEIN_FAULT 2 -#define DBG_COW_FAULT 3 -#define DBG_CACHE_HIT_FAULT 4 +extern int kernel_debug_register_callback(kd_callback_t callback); +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 debug code consists of the following * @@ -73,29 +127,77 @@ __BEGIN_DECLS #define DBG_BSD 4 #define DBG_IOKIT 5 #define DBG_DRIVERS 6 -#define DBG_TRACE 7 +#define DBG_TRACE 7 #define DBG_DLIL 8 +#define DBG_WORKQUEUE 9 +#define DBG_CORESTORAGE 10 +#define DBG_CG 11 #define DBG_MISC 20 -#define DBG_DYLD 31 -#define DBG_QT 32 +#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_MIG 255 +#ifdef PRIVATE +/* + * 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. + */ +#ifndef KERNEL +extern int kdebug_trace(uint32_t code, uint64_t arg1, uint64_t arg2, uint64_t arg3, uint64_t arg4) __OSX_AVAILABLE_STARTING(__MAC_10_10_2, __IPHONE_NA); +#endif +#endif /* 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_TRAP 0x07 /* Traps */ +#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 */ +/* #define unused 0x80 */ +#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 */ /* Codes for Scheduler (DBG_MACH_SCHED) */ #define MACH_SCHED 0x0 /* Scheduler */ @@ -105,10 +207,99 @@ __BEGIN_DECLS #define MACH_CALLOUT 0x4 /* callouts */ #define MACH_STACK_DETACH 0x5 #define MACH_MAKE_RUNNABLE 0x6 /* make thread runnable */ -#define MACH_PROMOTE 0x7 /* promoted due to resource */ -#define MACH_DEMOTE 0x8 /* promotion undone */ -#define MACH_PREBLOCK_MUTEX 0x9 /* preblocking on mutex */ +#define MACH_PROMOTE 0x7 /* promoted due to resource */ +#define MACH_DEMOTE 0x8 /* promotion undone */ +#define MACH_IDLE 0x9 /* processor idling */ +#define MACH_STACK_DEPTH 0xa /* stack depth at switch */ +#define MACH_MOVED 0xb /* did not use original scheduling decision */ +#define MACH_FAIRSHARE_ENTER 0xc /* move to fairshare band */ +#define MACH_FAIRSHARE_EXIT 0xd /* exit fairshare band */ +#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 */ +#define MACH_SCHED_DECAY_PRIORITY 0x1a /* timeshare thread priority decayed/restored */ +#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 */ + +/* 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 */ + +/* Codes for pmap (DBG_MACH_PMAP) */ +#define PMAP__CREATE 0x0 +#define PMAP__DESTROY 0x1 +#define PMAP__PROTECT 0x2 +#define PMAP__PAGE_PROTECT 0x3 +#define PMAP__ENTER 0x4 +#define PMAP__REMOVE 0x5 +#define PMAP__NEST 0x6 +#define PMAP__UNNEST 0x7 +#define PMAP__FLUSH_TLBS 0x8 +#define PMAP__UPDATE_INTERRUPT 0x9 +#define PMAP__ATTRIBUTE_CLEAR 0xa +#define PMAP__REUSABLE 0xb +#define PMAP__QUERY_RESIDENT 0xc +#define PMAP__FLUSH_KERN_TLBS 0xd +#define PMAP__FLUSH_DELAYED_TLBS 0xe +#define PMAP__FLUSH_TLBS_TO 0xf + +/* Codes for Stackshot/Microstackshot (DBG_MACH_STACKSHOT) */ +#define MICROSTACKSHOT_RECORD 0x0 +#define MICROSTACKSHOT_GATHER 0x1 + +/* 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 /* **** The Kernel Debug Sub Classes for Network (DBG_NETWORK) **** */ #define DBG_NETIP 1 /* Internet Protocol */ #define DBG_NETARP 2 /* Address Resolution Protocol */ @@ -133,36 +324,76 @@ __BEGIN_DECLS #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_IOSCSI 1 /* SCSI */ -#define DBG_IODISK 2 /* Disk layers */ -#define DBG_IONETWORK 3 /* Network layers */ -#define DBG_IOKEYBOARD 4 /* Keyboard */ -#define DBG_IOPOINTING 5 /* Pointing Devices */ -#define DBG_IOAUDIO 6 /* Audio */ -#define DBG_IOFLOPPY 7 /* Floppy */ -#define DBG_IOSERIAL 8 /* Serial */ -#define DBG_IOTTY 9 /* TTY layers */ -#define DBG_IOWORKLOOP 10 /* Work from work loop */ -#define DBG_IOINTES 11 /* Interrupt event source */ -#define DBG_IOCLKES 12 /* Clock event source */ -#define DBG_IOCMDQ 13 /* Command queue latencies */ -#define DBG_IOMCURS 14 /* Memory Cursor */ -#define DBG_IOMDESC 15 /* Memory Descriptors */ -#define DBG_IOPOWER 16 /* Power Managerment */ +#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_IOMCURS 5 /* Memory Cursor */ +#define DBG_IOMDESC 6 /* Memory Descriptors */ +#define DBG_IOPOWER 7 /* Power Managerment */ +#define DBG_IOSERVICE 8 /* Matching etc. */ + +/* **** 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_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_IOPARALLELSCSI 41 /* Parallel SCSI */ +#define DBG_IOSATA 42 /* Serial-ATA */ +#define DBG_IOSAS 43 /* SAS */ +#define DBG_IOFIBRECHANNEL 44 /* FiberChannel */ +#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_IOGRAPHICS 50 /* Graphics */ +#define DBG_HIBERNATE 51 /* hibernation related events */ +#define DBG_IOTHUNDERBOLT 52 /* Thunderbolt */ + + +/* 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_DRVSCSI 1 /* SCSI */ -#define DBG_DRVDISK 2 /* Disk layers */ -#define DBG_DRVNETWORK 3 /* Network layers */ -#define DBG_DRVKEYBOARD 4 /* Keyboard */ -#define DBG_DRVPOINTING 5 /* Pointing Devices */ -#define DBG_DRVAUDIO 6 /* Audio */ -#define DBG_DRVFLOPPY 7 /* Floppy */ -#define DBG_DRVSERIAL 8 /* Serial */ -#define DBG_DRVSPLT 9 +#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 */ + +/* Backwards compatibility */ +#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 */ @@ -171,20 +402,89 @@ __BEGIN_DECLS #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 */ +/* The Kernel Debug Sub Classes for File System (DBG_FSYSTEM) */ #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 */ +#define DBG_HFS 8 /* HFS-specific events; see bsd/hfs/hfs_kdebug.h */ +#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 /* The Kernel Debug Sub Classes for BSD */ -#define DBG_BSD_EXCP_SC 0x0C /* System Calls */ +#define DBG_BSD_PROC 0x01 /* process/signals related */ +#define DBG_BSD_MEMSTAT 0x02 /* memorystatus / jetsam operations */ +#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_INFO 0x0E /* System Calls, extended info */ +#define DBG_BSD_SC_EXTENDED_INFO2 0x0F /* System Calls, extended info */ + + +/* The Codes for BSD subcode class DBG_BSD_PROC */ +#define BSD_PROC_EXIT 1 /* process exit */ +#define BSD_PROC_FRCEXIT 2 /* Kernel force termination */ + +/* 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 */ /* 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_STRING_NEWTHREAD (TRACEDBG_CODE(DBG_TRACE_STRING, 1)) +#define TRACE_STRING_EXEC (TRACEDBG_CODE(DBG_TRACE_STRING, 2)) +#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)) + +/* 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 */ + +/* Sub-class codes for CoreGraphics (DBG_CG) are defined in its component. */ + +/* 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 @@ -195,6 +495,84 @@ __BEGIN_DECLS #define DKIO_ASYNC 0x04 #define DKIO_META 0x08 #define DKIO_PAGING 0x10 +#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 + +/* Kernel Debug Sub Classes for Applications (DBG_APPS) */ +#define DBG_APP_LOGINWINDOW 0x03 +#define DBG_APP_AUDIO 0x04 +#define DBG_APP_SAMBA 0x80 + +/* Kernel Debug codes for Throttling (DBG_THROTTLE) */ +#define OPEN_THROTTLE_WINDOW 0x1 +#define PROCESS_THROTTLED 0x2 +#define IO_THROTTLE_DISABLE 0x3 + + +/* 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 */ +/* 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 + +/* 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. */ + +/* Codes for ATM_SUBAID_INFO */ +#define ATM_MIN_CALLED 0x1 +#define ATM_MIN_LINK_LIST 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 /**********************************************************************/ @@ -211,8 +589,28 @@ __BEGIN_DECLS #define TRACEDBG_CODE(SubClass,code) KDBG_CODE(DBG_TRACE, SubClass, code) #define MISCDBG_CODE(SubClass,code) KDBG_CODE(DBG_MISC, SubClass, code) #define DLILDBG_CODE(SubClass,code) KDBG_CODE(DBG_DLIL, SubClass, code) +#define SECURITYDBG_CODE(SubClass,code) KDBG_CODE(DBG_SECURITY, 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 CPUPM_CODE(code) IOKDBG_CODE(DBG_IOCPUPM, code) + +#define KMEM_ALLOC_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 0) +#define KMEM_ALLOC_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 1) +#define KMEM_FREE_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 2) +#define KMEM_FREE_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 3) +#define ZALLOC_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 4) +#define ZALLOC_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 5) +#define ZFREE_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 6) +#define ZFREE_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 7) + +#define PMAP_CODE(code) MACHDBG_CODE(DBG_MACH_PMAP, code) + + +#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)) /* Usage: * kernel_debug((KDBG_CODE(DBG_NETWORK, DNET_PROTOCOL, 51) | DBG_FUNC_START), @@ -243,78 +641,308 @@ __BEGIN_DECLS extern unsigned int kdebug_enable; #define KDEBUG_ENABLE_TRACE 0x1 -#define KDEBUG_ENABLE_ENTROPY 0x2 +#define KDEBUG_ENABLE_ENTROPY 0x2 /* Obsolescent */ #define KDEBUG_ENABLE_CHUD 0x4 +#define KDEBUG_ENABLE_PPT 0x8 +#define KDEBUG_ENABLE_SERIAL 0x10 + +/* + * 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 -#define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e) \ -do { \ - if (kdebug_enable) \ - kernel_debug(x,a,b,c,d,e); \ +#if NO_KDEBUG +#define KDEBUG_LEVEL KDEBUG_LEVEL_NONE +#elif IST_KDEBUG +#define KDEBUG_LEVEL KDEBUG_LEVEL_IST +#elif KDEBUG +#define KDEBUG_LEVEL KDEBUG_LEVEL_FULL +#else +#define KDEBUG_LEVEL KDEBUG_LEVEL_STANDARD +#endif + +#if (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) +#ifdef XNU_KERNEL_PRIVATE +#define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e) \ +do { \ + if (__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) -#define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e) \ -do { \ - if (kdebug_enable) \ - kernel_debug1(x,a,b,c,d,e); \ +#define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e) \ +do { \ + if (__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) -extern void kernel_debug(unsigned int debugid, unsigned int arg1, unsigned int arg2, unsigned int arg3, unsigned int arg4, unsigned int arg5); +#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 /* XNU_KERNEL_PRIVATE */ +#define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e) \ +do { \ + if (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) -extern void kernel_debug1(unsigned int debugid, unsigned int arg1, unsigned int arg2, unsigned int arg3, unsigned int arg4, unsigned int arg5); +#define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e) \ +do { \ + if (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) +#endif /* XNU_KERNEL_PRIVATE */ +#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) */ -#if KDEBUG +/* + * Specify KDEBUG_PPT to indicate that the event belongs to the + * limited PPT set. + */ +#define KDEBUG_COMMON (KDEBUG_ENABLE_TRACE|KDEBUG_ENABLE_CHUD|KDEBUG_ENABLE_PPT) +#define KDEBUG_TRACE (KDEBUG_ENABLE_TRACE|KDEBUG_ENABLE_CHUD) +#define KDEBUG_PPT (KDEBUG_ENABLE_PPT) -#define KERNEL_DEBUG(x,a,b,c,d,e) \ -do { \ - if (kdebug_enable) \ - kernel_debug(x,a,b,c,d,e); \ +/* + * KERNEL_DEBUG_CONSTANT_IST events provide an audited subset of + * tracepoints for userland system tracing tools. + */ +#if (KDEBUG_LEVEL >= KDEBUG_LEVEL_IST) +#ifdef XNU_KERNEL_PRIVATE +#define KERNEL_DEBUG_CONSTANT_IST(type,x,a,b,c,d,e) \ +do { \ + if (__improbable(kdebug_enable & type)) \ + kernel_debug(x,(uintptr_t)a,(uintptr_t)b,(uintptr_t)c, \ + (uintptr_t)d,(uintptr_t)e); \ } while(0) +#else /* XNU_KERNEL_PRIVATE */ +#define KERNEL_DEBUG_CONSTANT_IST(type,x,a,b,c,d,e) \ +do { \ + if (kdebug_enable & type) \ + kernel_debug(x,(uintptr_t)a,(uintptr_t)b,(uintptr_t)c, \ + (uintptr_t)d,(uintptr_t)e); \ +} while(0) +#endif /* XNU_KERNEL_PRIVATE */ +#else /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_IST) */ +#define KERNEL_DEBUG_CONSTANT_IST(type,x,a,b,c,d,e) do { } while(0) +#endif /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_IST) */ + +#if NO_KDEBUG +#define __kdebug_constant_only __unused +#endif + +extern void kernel_debug( + uint32_t debugid, + uintptr_t arg1, + uintptr_t arg2, + uintptr_t arg3, + uintptr_t arg4, + uintptr_t arg5); + +extern void kernel_debug1( + uint32_t debugid, + uintptr_t arg1, + uintptr_t arg2, + uintptr_t arg3, + uintptr_t arg4, + uintptr_t arg5); -#define KERNEL_DEBUG1(x,a,b,c,d,e) \ -do { \ - if (kdebug_enable) \ - kernel_debug1(x,a,b,c,d,e); \ +extern void kernel_debug_early( + uint32_t debugid, + uintptr_t arg1, + uintptr_t arg2, + uintptr_t arg3, + uintptr_t arg4); + +extern void kernel_debug_string( + const char *message); + +#if (KDEBUG_LEVEL >= KDEBUG_LEVEL_FULL) +#ifdef XNU_KERNEL_PRIVATE +#define KERNEL_DEBUG(x,a,b,c,d,e) \ +do { \ + if (__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) -#else +#define KERNEL_DEBUG1(x,a,b,c,d,e) \ +do { \ + if (__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) + +#define __kdebug_only +#else /* !XNU_KERNEL_PRIVATE */ +#define KERNEL_DEBUG(x,a,b,c,d,e) \ +do { \ + if (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) -#define KERNEL_DEBUG(x,a,b,c,d,e) -#define KERNEL_DEBUG1(x,a,b,c,d,e) +#define KERNEL_DEBUG1(x,a,b,c,d,e) \ +do { \ + if (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) +#endif /* XNU_KERNEL_PRIVATE */ +#else /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_FULL) */ +#define KERNEL_DEBUG(x,a,b,c,d,e) do {} while (0) +#define KERNEL_DEBUG1(x,a,b,c,d,e) do {} while (0) + +#define __kdebug_only __unused +#endif /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_FULL) */ + +#ifdef KERNEL_PRIVATE +#include + +#define NUMPARMS 23 + +struct proc; + +extern void kdebug_lookup_gen_events(long *dbg_parms, int dbg_namelen, void *dp, boolean_t lookup); +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); + +extern void kdbg_dump_trace_to_file(const char *); +void start_kern_tracing(unsigned int, boolean_t); +void start_kern_tracing_with_typefilter(unsigned int, boolean_t, unsigned int); +struct task; +extern void kdbg_get_task_name(char*, int, struct task *task); +void 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) (((Class & 0xff) << 24) | ((SubClass & 0xff) << 16)) +#define KDBG_CLASS_DECODE(Debugid) (Debugid & 0xFFFF0000) + + +#endif /* KERNEL_PRIVATE */ -#endif #endif /* __APPLE_API_UNSTABLE */ __END_DECLS -#ifdef KERNEL_PRIVATE +#ifdef PRIVATE #ifdef __APPLE_API_PRIVATE /* * private kernel_debug definitions */ typedef struct { -uint64_t timestamp; -unsigned int arg1; -unsigned int arg2; -unsigned int arg3; -unsigned int arg4; -unsigned int arg5; /* will hold current thread */ -unsigned int debugid; + 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; +#if defined(__LP64__) + uint32_t cpuid; + uintptr_t unused; +#endif } kd_buf; -#define KDBG_THREAD_MASK 0x7fffffff -#define KDBG_CPU_MASK 0x80000000 +#if !defined(__LP64__) +#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) | + (((uint64_t) cpu) << KDBG_CPU_SHIFT); +} +static inline int +kdbg_get_cpu(kd_buf *kp) +{ + return (int) (((kp)->timestamp & KDBG_CPU_MASK) >> KDBG_CPU_SHIFT); +} +static inline void +kdbg_set_timestamp(kd_buf *kp, uint64_t thetime) +{ + 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 thetime, int cpu) +{ + kp->timestamp = (thetime & KDBG_TIMESTAMP_MASK) | + (((uint64_t) cpu) << KDBG_CPU_SHIFT); +} +#else +#define KDBG_TIMESTAMP_MASK 0xffffffffffffffffULL +static inline void +kdbg_set_cpu(kd_buf *kp, int cpu) +{ + kp->cpuid = cpu; +} +static inline int +kdbg_get_cpu(kd_buf *kp) +{ + return kp->cpuid; +} +static inline void +kdbg_set_timestamp(kd_buf *kp, uint64_t thetime) +{ + 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 thetime, int cpu) +{ + kdbg_set_timestamp(kp, thetime); + kdbg_set_cpu(kp, cpu); +} +#endif + +/* 2^16 bits (8 kilobytes), one for each possible class/subclass combination */ +#define KDBG_TYPEFILTER_BITMAP_SIZE ( (256 * 256) / 8 ) /* Debug Flags */ -#define KDBG_INIT 0x1 -#define KDBG_NOWRAP 0x2 -#define KDBG_FREERUN 0x4 -#define KDBG_WRAPPED 0x8 +#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 0x10 -#define KDBG_MAPINIT 0x20 -#define KDBG_PIDEXCLUDE 0x40 +#define KDBG_PIDCHECK 0x010 +#define KDBG_MAPINIT 0x020 +#define KDBG_PIDEXCLUDE 0x040 +#define KDBG_LOCKINIT 0x080 +#define KDBG_LP64 0x100 typedef struct { unsigned int type; @@ -327,20 +955,95 @@ typedef struct { typedef struct { - int nkdbufs; - int nolog; - int flags; - int nkdthreads; - int bufid; + int nkdbufs; + int nolog; + int flags; + int nkdthreads; + int bufid; } kbufinfo_t; -typedef struct -{ - unsigned int thread; - int valid; - char command[20]; +typedef struct { + uintptr_t thread; + int valid; + char command[20]; } kd_threadmap; +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; + +#define RAW_VERSION0 0x55aa0000 +#define RAW_VERSION1 0x55aa0101 + #define KDBG_CLASSTYPE 0x10000 #define KDBG_SUBCLSTYPE 0x20000 #define KDBG_RANGETYPE 0x40000 @@ -350,54 +1053,22 @@ typedef struct #define KDBG_RANGECHECK 0x100000 #define KDBG_VALCHECK 0x200000 /* Check up to 4 individual values */ -#define KDBG_BUFINIT 0x80000000 +#define KDBG_TYPEFILTER_CHECK ((uint32_t) 0x400000) /* Check class and subclass against a bitmap */ -/* 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 +#define KDBG_BUFINIT 0x80000000 /* Minimum value allowed when setting decrementer ticks */ #define KDBG_MINRTCDEC 2500 +/* VFS lookup events for serial traces */ +#define VFS_LOOKUP (FSDBG_CODE(DBG_FSRW,36)) +#define VFS_LOOKUP_DONE (FSDBG_CODE(DBG_FSRW,39)) -/* PCSAMPLES control operations */ -#define PCSAMPLE_DISABLE 1 -#define PCSAMPLE_SETNUMBUF 2 -#define PCSAMPLE_GETNUMBUF 3 -#define PCSAMPLE_SETUP 4 -#define PCSAMPLE_REMOVE 5 -#define PCSAMPLE_READBUF 6 -#define PCSAMPLE_SETREG 7 -#define PCSAMPLE_COMM 8 - -#define MAX_PCSAMPLES 1000000 /* Maximum number of pc's in a single buffer */ - - -extern unsigned int pcsample_enable; - -typedef struct -{ - int npcbufs; - int bufsize; - int enable; - unsigned long pcsample_beg; - unsigned long pcsample_end; -} pcinfo_t; +#if (DEVELOPMENT || DEBUG) +#define KDEBUG_MOJO_TRACE 1 +#endif #endif /* __APPLE_API_PRIVATE */ -#endif /* KERNEL_PRIVATE */ +#endif /* PRIVATE */ #endif /* !BSD_SYS_KDEBUG_H */