1 /* 2 * Copyright (c) 2000-2019 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 29 #ifndef _KERN_DEBUG_H_ 30 #define _KERN_DEBUG_H_ 31 32 #include <kern/kcdata.h> 33 34 #include <sys/cdefs.h> 35 #include <stdint.h> 36 #include <stdarg.h> 37 #include <uuid/uuid.h> 38 #include <mach/boolean.h> 39 #include <mach/kern_return.h> 40 #include <mach/vm_types.h> 41 42 #ifndef XNU_KERNEL_PRIVATE 43 #include <TargetConditionals.h> 44 #endif 45 46 __BEGIN_DECLS 47 48 #ifdef __APPLE_API_PRIVATE 49 #ifdef __APPLE_API_UNSTABLE 50 51 struct thread_snapshot { 52 uint32_t snapshot_magic; 53 uint32_t nkern_frames; 54 uint32_t nuser_frames; 55 uint64_t wait_event; 56 uint64_t continuation; 57 uint64_t thread_id; 58 uint64_t user_time; 59 uint64_t system_time; 60 int32_t state; 61 int32_t priority; /* static priority */ 62 int32_t sched_pri; /* scheduled (current) priority */ 63 int32_t sched_flags; /* scheduler flags */ 64 char ss_flags; 65 char ts_qos; /* effective qos */ 66 char ts_rqos; /* requested qos */ 67 char ts_rqos_override; /* requested qos override */ 68 char io_tier; 69 char _reserved[3]; /* pad for 4 byte alignement packing */ 70 71 /* 72 * I/O Statistics 73 * XXX: These fields must be together 74 */ 75 uint64_t disk_reads_count; 76 uint64_t disk_reads_size; 77 uint64_t disk_writes_count; 78 uint64_t disk_writes_size; 79 uint64_t io_priority_count[STACKSHOT_IO_NUM_PRIORITIES]; 80 uint64_t io_priority_size[STACKSHOT_IO_NUM_PRIORITIES]; 81 uint64_t paging_count; 82 uint64_t paging_size; 83 uint64_t non_paging_count; 84 uint64_t non_paging_size; 85 uint64_t data_count; 86 uint64_t data_size; 87 uint64_t metadata_count; 88 uint64_t metadata_size; 89 /* XXX: I/O Statistics end */ 90 91 uint64_t voucher_identifier; /* obfuscated voucher identifier */ 92 uint64_t total_syscalls; 93 char pth_name[STACKSHOT_MAX_THREAD_NAME_SIZE]; 94 } __attribute__((packed)); 95 96 /* old, non kcdata format */ 97 struct task_snapshot { 98 uint32_t snapshot_magic; 99 int32_t pid; 100 uint64_t uniqueid; 101 uint64_t user_time_in_terminated_threads; 102 uint64_t system_time_in_terminated_threads; 103 uint8_t shared_cache_identifier[16]; 104 uint64_t shared_cache_slide; 105 uint32_t nloadinfos; 106 int suspend_count; 107 int task_size; /* pages */ 108 int faults; /* number of page faults */ 109 int pageins; /* number of actual pageins */ 110 int cow_faults; /* number of copy-on-write faults */ 111 uint32_t ss_flags; 112 uint64_t p_start_sec; /* from the bsd proc struct */ 113 uint64_t p_start_usec; /* from the bsd proc struct */ 114 115 /* 116 * We restrict ourselves to a statically defined 117 * (current as of 2009) length for the 118 * p_comm string, due to scoping issues (osfmk/bsd and user/kernel 119 * binary compatibility). 120 */ 121 char p_comm[17]; 122 uint32_t was_throttled; 123 uint32_t did_throttle; 124 uint32_t latency_qos; 125 /* 126 * I/O Statistics 127 * XXX: These fields must be together. 128 */ 129 uint64_t disk_reads_count; 130 uint64_t disk_reads_size; 131 uint64_t disk_writes_count; 132 uint64_t disk_writes_size; 133 uint64_t io_priority_count[STACKSHOT_IO_NUM_PRIORITIES]; 134 uint64_t io_priority_size[STACKSHOT_IO_NUM_PRIORITIES]; 135 uint64_t paging_count; 136 uint64_t paging_size; 137 uint64_t non_paging_count; 138 uint64_t non_paging_size; 139 uint64_t data_count; 140 uint64_t data_size; 141 uint64_t metadata_count; 142 uint64_t metadata_size; 143 /* XXX: I/O Statistics end */ 144 145 uint32_t donating_pid_count; 146 } __attribute__ ((packed)); 147 148 149 150 struct micro_snapshot { 151 uint32_t snapshot_magic; 152 uint32_t ms_cpu; /* cpu number this snapshot was recorded on */ 153 uint64_t ms_time; /* time at sample (seconds) */ 154 uint64_t ms_time_microsecs; 155 uint8_t ms_flags; 156 uint16_t ms_opaque_flags; /* managed by external entity, e.g. fdrmicrod */ 157 } __attribute__ ((packed)); 158 159 160 /* 161 * mirrors the dyld_cache_header struct defined in dyld_cache_format.h from dyld source code 162 */ 163 struct _dyld_cache_header { 164 char magic[16]; // e.g. "dyld_v0 i386" 165 uint32_t mappingOffset; // file offset to first dyld_cache_mapping_info 166 uint32_t mappingCount; // number of dyld_cache_mapping_info entries 167 uint32_t imagesOffset; // file offset to first dyld_cache_image_info 168 uint32_t imagesCount; // number of dyld_cache_image_info entries 169 uint64_t dyldBaseAddress; // base address of dyld when cache was built 170 uint64_t codeSignatureOffset;// file offset of code signature blob 171 uint64_t codeSignatureSize; // size of code signature blob (zero means to end of file) 172 uint64_t slideInfoOffset; // file offset of kernel slid info 173 uint64_t slideInfoSize; // size of kernel slid info 174 uint64_t localSymbolsOffset; // file offset of where local symbols are stored 175 uint64_t localSymbolsSize; // size of local symbols information 176 uint8_t uuid[16]; // unique value for each shared cache file 177 uint64_t cacheType; // 0 for development, 1 for production 178 uint32_t branchPoolsOffset; // file offset to table of uint64_t pool addresses 179 uint32_t branchPoolsCount; // number of uint64_t entries 180 uint64_t accelerateInfoAddr; // (unslid) address of optimization info 181 uint64_t accelerateInfoSize; // size of optimization info 182 uint64_t imagesTextOffset; // file offset to first dyld_cache_image_text_info 183 uint64_t imagesTextCount; // number of dyld_cache_image_text_info entries 184 uint64_t dylibsImageGroupAddr;// (unslid) address of ImageGroup for dylibs in this cache 185 uint64_t dylibsImageGroupSize;// size of ImageGroup for dylibs in this cache 186 uint64_t otherImageGroupAddr;// (unslid) address of ImageGroup for other OS dylibs 187 uint64_t otherImageGroupSize;// size of oImageGroup for other OS dylibs 188 uint64_t progClosuresAddr; // (unslid) address of list of program launch closures 189 uint64_t progClosuresSize; // size of list of program launch closures 190 uint64_t progClosuresTrieAddr;// (unslid) address of trie of indexes into program launch closures 191 uint64_t progClosuresTrieSize;// size of trie of indexes into program launch closures 192 uint32_t platform; // platform number (macOS=1, etc) 193 uint32_t formatVersion : 8,// dyld3::closure::kFormatVersion 194 dylibsExpectedOnDisk : 1, // dyld should expect the dylib exists on disk and to compare inode/mtime to see if cache is valid 195 simulator : 1, // for simulator of specified platform 196 locallyBuiltCache : 1, // 0 for B&I built cache, 1 for locally built cache 197 padding : 21; // TBD 198 }; 199 200 /* 201 * mirrors the dyld_cache_image_text_info struct defined in dyld_cache_format.h from dyld source code 202 */ 203 struct _dyld_cache_image_text_info { 204 uuid_t uuid; 205 uint64_t loadAddress; // unslid address of start of __TEXT 206 uint32_t textSegmentSize; 207 uint32_t pathOffset; // offset from start of cache file 208 }; 209 210 211 enum micro_snapshot_flags { 212 kInterruptRecord = 0x1, 213 kTimerArmingRecord = 0x2, 214 kUserMode = 0x4, /* interrupted usermode, or armed by usermode */ 215 kIORecord = 0x8, 216 kPMIRecord = 0x10, 217 kMACFRecord = 0x20, /* armed by MACF policy */ 218 }; 219 220 /* 221 * Flags used in the following assortment of snapshots. 222 */ 223 enum generic_snapshot_flags { 224 kUser64_p = 0x1, /* Userspace uses 64 bit pointers */ 225 kKernel64_p = 0x2 /* The kernel uses 64 bit pointers */ 226 }; 227 228 #define VM_PRESSURE_TIME_WINDOW 5 /* seconds */ 229 230 __options_decl(stackshot_flags_t, uint64_t, { 231 STACKSHOT_GET_DQ = 0x01, 232 STACKSHOT_SAVE_LOADINFO = 0x02, 233 STACKSHOT_GET_GLOBAL_MEM_STATS = 0x04, 234 STACKSHOT_SAVE_KEXT_LOADINFO = 0x08, 235 /* 236 * 0x10, 0x20, 0x40 and 0x80 are reserved. 237 * 238 * See microstackshot_flags_t whose members used to be part of this 239 * declaration. 240 */ 241 STACKSHOT_ACTIVE_KERNEL_THREADS_ONLY = 0x100, 242 STACKSHOT_GET_BOOT_PROFILE = 0x200, 243 STACKSHOT_DO_COMPRESS = 0x400, 244 STACKSHOT_SAVE_IMP_DONATION_PIDS = 0x2000, 245 STACKSHOT_SAVE_IN_KERNEL_BUFFER = 0x4000, 246 STACKSHOT_RETRIEVE_EXISTING_BUFFER = 0x8000, 247 STACKSHOT_KCDATA_FORMAT = 0x10000, 248 STACKSHOT_ENABLE_BT_FAULTING = 0x20000, 249 STACKSHOT_COLLECT_DELTA_SNAPSHOT = 0x40000, 250 /* Include the layout of the system shared cache */ 251 STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT = 0x80000, 252 /* 253 * Kernel consumers of stackshot (via stack_snapshot_from_kernel) can ask 254 * that we try to take the stackshot lock, and fail if we don't get it. 255 */ 256 STACKSHOT_TRYLOCK = 0x100000, 257 STACKSHOT_ENABLE_UUID_FAULTING = 0x200000, 258 STACKSHOT_FROM_PANIC = 0x400000, 259 STACKSHOT_NO_IO_STATS = 0x800000, 260 /* Report owners of and pointers to kernel objects that threads are blocked on */ 261 STACKSHOT_THREAD_WAITINFO = 0x1000000, 262 STACKSHOT_THREAD_GROUP = 0x2000000, 263 STACKSHOT_SAVE_JETSAM_COALITIONS = 0x4000000, 264 STACKSHOT_INSTRS_CYCLES = 0x8000000, 265 STACKSHOT_ASID = 0x10000000, 266 STACKSHOT_PAGE_TABLES = 0x20000000, 267 STACKSHOT_DISABLE_LATENCY_INFO = 0x40000000, 268 }); // Note: Add any new flags to kcdata.py (stackshot_in_flags) 269 270 __options_decl(microstackshot_flags_t, uint32_t, { 271 STACKSHOT_GET_MICROSTACKSHOT = 0x10, 272 STACKSHOT_GLOBAL_MICROSTACKSHOT_ENABLE = 0x20, 273 STACKSHOT_GLOBAL_MICROSTACKSHOT_DISABLE = 0x40, 274 STACKSHOT_SET_MICROSTACKSHOT_MARK = 0x80, 275 }); 276 277 #define STACKSHOT_THREAD_SNAPSHOT_MAGIC 0xfeedface 278 #define STACKSHOT_TASK_SNAPSHOT_MAGIC 0xdecafbad 279 #define STACKSHOT_MEM_AND_IO_SNAPSHOT_MAGIC 0xbfcabcde 280 #define STACKSHOT_MICRO_SNAPSHOT_MAGIC 0x31c54011 281 282 #define STACKSHOT_PAGETABLES_MASK_ALL ~0 283 284 #define KF_INITIALIZED (0x1) 285 #define KF_SERIAL_OVRD (0x2) 286 #define KF_PMAPV_OVRD (0x4) 287 #define KF_MATV_OVRD (0x8) 288 #define KF_STACKSHOT_OVRD (0x10) 289 #define KF_COMPRSV_OVRD (0x20) 290 #define KF_INTERRUPT_MASKED_DEBUG_OVRD (0x40) 291 #define KF_TRAPTRACE_OVRD (0x80) 292 #define KF_IOTRACE_OVRD (0x100) 293 #define KF_INTERRUPT_MASKED_DEBUG_STACKSHOT_OVRD (0x200) 294 #define KF_INTERRUPT_MASKED_DEBUG_PMC_OVRD (0x400) 295 #define KF_RW_LOCK_DEBUG_OVRD (0x800) 296 #define KF_MADVISE_FREE_DEBUG_OVRD (0x1000) 297 298 boolean_t kern_feature_override(uint32_t fmask); 299 300 #define EMBEDDED_PANIC_HEADER_OSVERSION_LEN 32 301 302 /* 303 * Any updates to this header should be also updated in astris as it can not 304 * grab this header from the SDK. 305 * 306 * NOTE: DO NOT REMOVE OR CHANGE THE MEANING OF ANY FIELDS FROM THIS STRUCTURE. 307 * Any modifications should add new fields at the end, bump the version number 308 * and be done alongside astris and DumpPanic changes. 309 */ 310 struct embedded_panic_header { 311 uint32_t eph_magic; /* EMBEDDED_PANIC_MAGIC if valid */ 312 uint32_t eph_crc; /* CRC of everything following the ph_crc in the header and the contents */ 313 uint32_t eph_version; /* embedded_panic_header version */ 314 uint64_t eph_panic_flags; /* Flags indicating any state or relevant details */ 315 uint32_t eph_panic_log_offset; /* Offset of the beginning of the panic log from the beginning of the header */ 316 uint32_t eph_panic_log_len; /* length of the panic log */ 317 uint32_t eph_stackshot_offset; /* Offset of the beginning of the panic stackshot from the beginning of the header */ 318 uint32_t eph_stackshot_len; /* length of the panic stackshot (0 if not valid ) */ 319 uint32_t eph_other_log_offset; /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */ 320 uint32_t eph_other_log_len; /* length of the other log */ 321 union { 322 struct { 323 uint64_t eph_x86_power_state:8, 324 eph_x86_efi_boot_state:8, 325 eph_x86_system_state:8, 326 eph_x86_unused_bits:40; 327 }; // anonymous struct to group the bitfields together. 328 uint64_t eph_x86_do_not_use; /* Used for offsetof/sizeof when parsing header */ 329 }; 330 char eph_os_version[EMBEDDED_PANIC_HEADER_OSVERSION_LEN]; 331 char eph_macos_version[EMBEDDED_PANIC_HEADER_OSVERSION_LEN]; 332 } __attribute__((packed)); 333 334 #define EMBEDDED_PANIC_HEADER_FLAG_COREDUMP_COMPLETE 0x01 335 #define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_SUCCEEDED 0x02 336 #define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_DEBUGGERSYNC 0x04 337 #define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR 0x08 338 #define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_INCOMPLETE 0x10 339 #define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_NESTED 0x20 340 #define EMBEDDED_PANIC_HEADER_FLAG_NESTED_PANIC 0x40 341 #define EMBEDDED_PANIC_HEADER_FLAG_BUTTON_RESET_PANIC 0x80 342 #define EMBEDDED_PANIC_HEADER_FLAG_COPROC_INITIATED_PANIC 0x100 343 #define EMBEDDED_PANIC_HEADER_FLAG_COREDUMP_FAILED 0x200 344 #define EMBEDDED_PANIC_HEADER_FLAG_COMPRESS_FAILED 0x400 345 #define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_DATA_COMPRESSED 0x800 346 #define EMBEDDED_PANIC_HEADER_FLAG_ENCRYPTED_COREDUMP_SKIPPED 0x1000 347 348 #define EMBEDDED_PANIC_HEADER_CURRENT_VERSION 2 349 #define EMBEDDED_PANIC_MAGIC 0x46554E4B /* FUNK */ 350 351 struct macos_panic_header { 352 uint32_t mph_magic; /* MACOS_PANIC_MAGIC if valid */ 353 uint32_t mph_crc; /* CRC of everything following mph_crc in the header and the contents */ 354 uint32_t mph_version; /* macos_panic_header version */ 355 uint32_t mph_padding; /* unused */ 356 uint64_t mph_panic_flags; /* Flags indicating any state or relevant details */ 357 uint32_t mph_panic_log_offset; /* Offset of the panic log from the beginning of the header */ 358 uint32_t mph_panic_log_len; /* length of the panic log */ 359 uint32_t mph_stackshot_offset; /* Offset of the panic stackshot from the beginning of the header */ 360 uint32_t mph_stackshot_len; /* length of the panic stackshot */ 361 uint32_t mph_other_log_offset; /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */ 362 uint32_t mph_other_log_len; /* length of the other log */ 363 char mph_data[]; /* panic data -- DO NOT ACCESS THIS FIELD DIRECTLY. Use the offsets above relative to the beginning of the header */ 364 } __attribute__((packed)); 365 366 #define MACOS_PANIC_HEADER_CURRENT_VERSION 2 367 #define MACOS_PANIC_MAGIC 0x44454544 /* DEED */ 368 369 #define MACOS_PANIC_HEADER_FLAG_NESTED_PANIC 0x01 370 #define MACOS_PANIC_HEADER_FLAG_COPROC_INITIATED_PANIC 0x02 371 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_SUCCEEDED 0x04 372 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_DATA_COMPRESSED 0x08 373 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_DEBUGGERSYNC 0x10 374 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR 0x20 375 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_INCOMPLETE 0x40 376 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_NESTED 0x80 377 #define MACOS_PANIC_HEADER_FLAG_COREDUMP_COMPLETE 0x100 378 #define MACOS_PANIC_HEADER_FLAG_COREDUMP_FAILED 0x200 379 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_KERNEL_ONLY 0x400 380 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_COMPRESS 0x800 381 #define MACOS_PANIC_HEADER_FLAG_ENCRYPTED_COREDUMP_SKIPPED 0x1000 382 383 /* 384 * Any change to the below structure should mirror the structure defined in MacEFIFirmware 385 * (and vice versa) 386 */ 387 388 struct efi_aurr_panic_header { 389 uint32_t efi_aurr_magic; 390 uint32_t efi_aurr_crc; 391 uint32_t efi_aurr_version; 392 uint32_t efi_aurr_reset_cause; 393 uint32_t efi_aurr_reset_log_offset; 394 uint32_t efi_aurr_reset_log_len; 395 char efi_aurr_panic_data[]; 396 } __attribute__((packed)); 397 398 /* 399 * EXTENDED_/DEBUG_BUF_SIZE can't grow without updates to SMC and iBoot to store larger panic logs on co-processor systems 400 */ 401 #define EXTENDED_DEBUG_BUF_SIZE 0x0013ff80 402 403 #define EFI_AURR_PANIC_STRING_MAX_LEN 112 404 #define EFI_AURR_EXTENDED_LOG_SIZE (EXTENDED_DEBUG_BUF_SIZE - sizeof(struct efi_aurr_panic_header) - EFI_AURR_PANIC_STRING_MAX_LEN) 405 406 struct efi_aurr_extended_panic_log { 407 char efi_aurr_extended_log_buf[EFI_AURR_EXTENDED_LOG_SIZE]; 408 uint32_t efi_aurr_log_tail; /* Circular buffer indices */ 409 uint32_t efi_aurr_log_head; /* ditto.. */ 410 } __attribute__((packed)); 411 412 #endif /* __APPLE_API_UNSTABLE */ 413 #endif /* __APPLE_API_PRIVATE */ 414 415 #ifdef KERNEL 416 417 __abortlike __printflike(1, 2) 418 extern void panic(const char *string, ...); 419 420 #endif /* KERNEL */ 421 422 #ifdef KERNEL_PRIVATE 423 #if DEBUG 424 #ifndef DKPR 425 #define DKPR 1 426 #endif 427 #endif 428 429 #if DKPR 430 /* 431 * For the DEBUG kernel, support the following: 432 * sysctl -w debug.kprint_syscall=<syscall_mask> 433 * sysctl -w debug.kprint_syscall_process=<p_comm> 434 * <syscall_mask> should be an OR of the masks below 435 * for UNIX, MACH, MDEP, or IPC. This debugging aid 436 * assumes the task/process is locked/wired and will 437 * not go away during evaluation. If no process is 438 * specified, all processes will be traced 439 */ 440 extern int debug_kprint_syscall; 441 extern int debug_kprint_current_process(const char **namep); 442 #define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) \ 443 ( (debug_kprint_syscall & (mask)) && debug_kprint_current_process(namep) ) 444 #define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { \ 445 const char *dks_name = NULL; \ 446 if (DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, &dks_name)) { \ 447 kprintf("[%s%s%p]" fmt, dks_name ? dks_name : "", \ 448 dks_name ? "@" : "", current_thread(), args); \ 449 } \ 450 } while (0) 451 #else /* !DEBUG */ 452 #define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) (0) 453 #define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { } while (0) /* kprintf(fmt, args) */ 454 #endif /* !DEBUG */ 455 456 enum { 457 DEBUG_KPRINT_SYSCALL_UNIX_MASK = 1 << 0, 458 DEBUG_KPRINT_SYSCALL_MACH_MASK = 1 << 1, 459 DEBUG_KPRINT_SYSCALL_MDEP_MASK = 1 << 2, 460 DEBUG_KPRINT_SYSCALL_IPC_MASK = 1 << 3 461 }; 462 463 #define DEBUG_KPRINT_SYSCALL_PREDICATE(mask) \ 464 DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, NULL) 465 #define DEBUG_KPRINT_SYSCALL_UNIX(fmt, args...) \ 466 DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_UNIX_MASK,fmt,args) 467 #define DEBUG_KPRINT_SYSCALL_MACH(fmt, args...) \ 468 DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MACH_MASK,fmt,args) 469 #define DEBUG_KPRINT_SYSCALL_MDEP(fmt, args...) \ 470 DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MDEP_MASK,fmt,args) 471 #define DEBUG_KPRINT_SYSCALL_IPC(fmt, args...) \ 472 DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_IPC_MASK,fmt,args) 473 474 /* Debug boot-args */ 475 #define DB_HALT 0x1 476 //#define DB_PRT 0x2 -- obsolete 477 #define DB_NMI 0x4 478 #define DB_KPRT 0x8 479 #define DB_KDB 0x10 480 #define DB_ARP 0x40 481 #define DB_KDP_BP_DIS 0x80 482 //#define DB_LOG_PI_SCRN 0x100 -- obsolete 483 #define DB_KDP_GETC_ENA 0x200 484 485 #define DB_KERN_DUMP_ON_PANIC 0x400 /* Trigger core dump on panic*/ 486 #define DB_KERN_DUMP_ON_NMI 0x800 /* Trigger core dump on NMI */ 487 #define DB_DBG_POST_CORE 0x1000 /*Wait in debugger after NMI core */ 488 #define DB_PANICLOG_DUMP 0x2000 /* Send paniclog on panic,not core*/ 489 #define DB_REBOOT_POST_CORE 0x4000 /* Attempt to reboot after 490 * post-panic crashdump/paniclog 491 * dump. 492 */ 493 #define DB_NMI_BTN_ENA 0x8000 /* Enable button to directly trigger NMI */ 494 /* 0x10000 was DB_PRT_KDEBUG (kprintf kdebug events), feature removed */ 495 #define DB_DISABLE_LOCAL_CORE 0x20000 /* ignore local kernel core dump support */ 496 #define DB_DISABLE_GZIP_CORE 0x40000 /* don't gzip kernel core dumps */ 497 #define DB_DISABLE_CROSS_PANIC 0x80000 /* x86 only - don't trigger cross panics. Only 498 * necessary to enable x86 kernel debugging on 499 * configs with a dev-fused co-processor running 500 * release bridgeOS. 501 */ 502 #define DB_REBOOT_ALWAYS 0x100000 /* Don't wait for debugger connection */ 503 #define DB_DISABLE_STACKSHOT_TO_DISK 0x200000 /* Disable writing stackshot to local disk */ 504 505 /* 506 * Values for a 64-bit mask that's passed to the debugger. 507 */ 508 #define DEBUGGER_OPTION_NONE 0x0ULL 509 #define DEBUGGER_OPTION_PANICLOGANDREBOOT 0x1ULL /* capture a panic log and then reboot immediately */ 510 #define DEBUGGER_OPTION_RECURPANIC_ENTRY 0x2ULL 511 #define DEBUGGER_OPTION_RECURPANIC_PRELOG 0x4ULL 512 #define DEBUGGER_OPTION_RECURPANIC_POSTLOG 0x8ULL 513 #define DEBUGGER_OPTION_RECURPANIC_POSTCORE 0x10ULL 514 #define DEBUGGER_OPTION_INITPROC_PANIC 0x20ULL 515 #define DEBUGGER_OPTION_COPROC_INITIATED_PANIC 0x40ULL /* panic initiated by a co-processor */ 516 #define DEBUGGER_OPTION_SKIP_LOCAL_COREDUMP 0x80ULL /* don't try to save local coredumps for this panic */ 517 #define DEBUGGER_OPTION_ATTEMPTCOREDUMPANDREBOOT 0x100ULL /* attempt to save coredump. always reboot */ 518 #define DEBUGGER_INTERNAL_OPTION_THREAD_BACKTRACE 0x200ULL /* backtrace the specified thread in the paniclog (x86 only) */ 519 #define DEBUGGER_OPTION_PRINT_CPU_USAGE_PANICLOG 0x400ULL /* print extra CPU usage data in the panic log */ 520 #define DEBUGGER_OPTION_SKIP_PANICEND_CALLOUTS 0x800ULL /* (bridgeOS) skip the kPEPanicEnd callouts -- don't wait for x86 to finish sending panic data */ 521 522 #define DEBUGGER_INTERNAL_OPTIONS_MASK (DEBUGGER_INTERNAL_OPTION_THREAD_BACKTRACE) 523 524 #define __STRINGIFY(x) #x 525 #define LINE_NUMBER(x) __STRINGIFY(x) 526 #ifdef __FILE_NAME__ 527 #define PANIC_LOCATION __FILE_NAME__ ":" LINE_NUMBER(__LINE__) 528 #else 529 #define PANIC_LOCATION __FILE__ ":" LINE_NUMBER(__LINE__) 530 #define __FILE_NAME__ __FILE__ 531 #endif 532 533 #if XNU_KERNEL_PRIVATE 534 #define panic(ex, ...) ({ \ 535 __asm__("" ::: "memory"); \ 536 (panic)(ex " @%s:%d", ## __VA_ARGS__, __FILE_NAME__, __LINE__); \ 537 }) 538 #else 539 #define panic(ex, ...) ({ \ 540 __asm__("" ::: "memory"); \ 541 (panic)(#ex " @%s:%d", ## __VA_ARGS__, __FILE_NAME__, __LINE__); \ 542 }) 543 #endif 544 #define panic_plain(ex, ...) (panic)(ex, ## __VA_ARGS__) 545 546 struct task; 547 struct thread; 548 struct proc; 549 550 __abortlike __printflike(4, 5) 551 void panic_with_options(unsigned int reason, void *ctx, 552 uint64_t debugger_options_mask, const char *str, ...); 553 void Debugger(const char * message); 554 void populate_model_name(char *); 555 556 boolean_t panic_validate_ptr(void *ptr, vm_size_t size, const char *what); 557 558 boolean_t panic_get_thread_proc_task(struct thread *thread, struct task **task, struct proc **proc); 559 560 #define PANIC_VALIDATE_PTR(expr) \ 561 panic_validate_ptr(expr, sizeof(*(expr)), #expr) 562 563 564 #if defined(__arm__) || defined(__arm64__) 565 /* Note that producer_name and buf should never be de-allocated as we reference these during panic */ 566 void register_additional_panic_data_buffer(const char *producer_name, void *buf, int len); 567 #endif 568 569 unsigned panic_active(void); 570 571 #endif /* KERNEL_PRIVATE */ 572 573 #if XNU_KERNEL_PRIVATE 574 575 #if defined (__x86_64__) 576 struct thread; 577 578 __abortlike __printflike(5, 6) 579 void panic_with_thread_context(unsigned int reason, void *ctx, 580 uint64_t debugger_options_mask, struct thread* th, const char *str, ...); 581 #endif 582 583 /* limit the max size to a reasonable length */ 584 #define ADDITIONAL_PANIC_DATA_BUFFER_MAX_LEN 64 585 586 struct additional_panic_data_buffer { 587 const char *producer_name; 588 void *buf; 589 int len; 590 }; 591 592 extern struct additional_panic_data_buffer *panic_data_buffers; 593 594 boolean_t oslog_is_safe(void); 595 boolean_t debug_mode_active(void); 596 boolean_t stackshot_active(void); 597 void panic_stackshot_reset_state(void); 598 599 /* 600 * @function stack_snapshot_from_kernel 601 * 602 * @abstract Stackshot function for kernel consumers who have their own buffer. 603 * 604 * @param pid the PID to be traced or -1 for the whole system 605 * @param buf a pointer to the buffer where the stackshot should be written 606 * @param size the size of the buffer 607 * @param flags flags to be passed to the stackshot 608 * @param delta_since_timestamp start time for delta period 609 * @param pagetable_mask if pagetable dumping is set in flags, the mask of page table levels to dump 610 * @bytes_traced a pointer to be filled with the length of the stackshot 611 * 612 */ 613 kern_return_t 614 stack_snapshot_from_kernel(int pid, void *buf, uint32_t size, uint64_t flags, 615 uint64_t delta_since_timestamp, uint32_t pagetable_mask, unsigned *bytes_traced); 616 617 /* 618 * Returns whether on device corefiles are enabled based on the build 619 * and boot configuration. 620 */ 621 boolean_t on_device_corefile_enabled(void); 622 623 /* 624 * Returns whether panic stackshot to disk is enabled based on the build 625 * and boot configuration. 626 */ 627 boolean_t panic_stackshot_to_disk_enabled(void); 628 629 #if defined(__x86_64__) 630 extern char debug_buf[]; 631 extern boolean_t coprocessor_paniclog_flush; 632 extern boolean_t extended_debug_log_enabled; 633 #endif /* defined(__x86_64__) */ 634 635 extern char *debug_buf_base; 636 637 #if defined(XNU_TARGET_OS_BRIDGE) 638 extern uint64_t macos_panic_base; 639 extern unsigned int macos_panic_size; 640 #endif /* defined(XNU_TARGET_OS_BRIDGE) */ 641 642 extern char kernel_uuid_string[]; 643 extern char panic_disk_error_description[]; 644 extern size_t panic_disk_error_description_size; 645 646 extern unsigned char *kernel_uuid; 647 extern unsigned int debug_boot_arg; 648 extern int verbose_panic_flow_logging; 649 650 extern boolean_t kernelcache_uuid_valid; 651 extern uuid_t kernelcache_uuid; 652 extern uuid_string_t kernelcache_uuid_string; 653 654 extern boolean_t pageablekc_uuid_valid; 655 extern uuid_t pageablekc_uuid; 656 extern uuid_string_t pageablekc_uuid_string; 657 658 extern boolean_t auxkc_uuid_valid; 659 extern uuid_t auxkc_uuid; 660 extern uuid_string_t auxkc_uuid_string; 661 662 extern boolean_t doprnt_hide_pointers; 663 664 extern unsigned int halt_in_debugger; /* pending halt in debugger after boot */ 665 extern unsigned int current_debugger; 666 #define NO_CUR_DB 0x0 667 #define KDP_CUR_DB 0x1 668 669 extern unsigned int active_debugger; 670 extern unsigned int kernel_debugger_entry_count; 671 672 extern unsigned int panicDebugging; 673 674 extern const char *debugger_panic_str; 675 676 extern char *debug_buf_ptr; 677 extern unsigned int debug_buf_size; 678 679 extern void debug_log_init(void); 680 extern void debug_putc(char); 681 extern boolean_t debug_is_current_cpu_in_panic_state(void); 682 683 /* 684 * Initialize the physical carveout requested with the `phys_carveout_mb` 685 * boot-arg. This should only be called at kernel startup, when physically 686 * contiguous pages are plentiful. 687 */ 688 extern void phys_carveout_init(void); 689 690 /* 691 * Check whether a kernel virtual address points within the physical carveout. 692 */ 693 extern boolean_t debug_is_in_phys_carveout(vm_map_offset_t va); 694 extern boolean_t debug_is_in_phys_carveout_metadata(vm_map_offset_t va); 695 696 /* 697 * Check whether the physical carveout should be included in a coredump. 698 */ 699 extern boolean_t debug_can_coredump_phys_carveout(void); 700 701 extern vm_offset_t phys_carveout; 702 extern uintptr_t phys_carveout_pa; 703 extern size_t phys_carveout_size; 704 extern vm_offset_t phys_carveout_metadata; 705 extern uintptr_t phys_carveout_metadata_pa; 706 extern size_t phys_carveout_metadata_size; 707 708 extern boolean_t kernel_debugging_restricted(void); 709 710 #if defined (__x86_64__) 711 extern void extended_debug_log_init(void); 712 713 int packA(char *inbuf, uint32_t length, uint32_t buflen); 714 void unpackA(char *inbuf, uint32_t length); 715 716 #define PANIC_STACKSHOT_BUFSIZE (1024 * 1024) 717 718 extern uintptr_t panic_stackshot_buf; 719 extern size_t panic_stackshot_buf_len; 720 721 extern size_t panic_stackshot_len; 722 #endif /* defined (__x86_64__) */ 723 724 void SavePanicInfo(const char *message, void *panic_data, uint64_t panic_options); 725 void paniclog_flush(void); 726 void panic_display_zalloc(void); /* in zalloc.c */ 727 void panic_display_kernel_aslr(void); 728 void panic_display_hibb(void); 729 void panic_display_model_name(void); 730 void panic_display_kernel_uuid(void); 731 void panic_display_process_name(void); 732 void panic_print_symbol_name(vm_address_t search); 733 #if CONFIG_ECC_LOGGING 734 void panic_display_ecc_errors(void); 735 #endif /* CONFIG_ECC_LOGGING */ 736 void panic_display_compressor_stats(void); 737 738 /* 739 * @var not_in_kdp 740 * 741 * @abstract True if we're in normal kernel operation, False if we're in a 742 * single-core debugger context. 743 */ 744 extern unsigned int not_in_kdp; 745 746 #define DEBUGGER_NO_CPU -1 747 748 typedef enum { 749 DBOP_NONE, 750 DBOP_STACKSHOT, 751 DBOP_RESET_PGO_COUNTERS, 752 DBOP_PANIC, 753 DBOP_DEBUGGER, 754 DBOP_BREAKPOINT, 755 } debugger_op; 756 757 __printflike(3, 0) 758 kern_return_t DebuggerTrapWithState(debugger_op db_op, const char *db_message, const char *db_panic_str, va_list *db_panic_args, 759 uint64_t db_panic_options, void *db_panic_data_ptr, boolean_t db_proceed_on_sync_failure, unsigned long db_panic_caller); 760 void handle_debugger_trap(unsigned int exception, unsigned int code, unsigned int subcode, void *state); 761 762 void DebuggerWithContext(unsigned int reason, void *ctx, const char *message, uint64_t debugger_options_mask, unsigned long debugger_caller); 763 764 const char *sysctl_debug_get_preoslog(size_t *size); 765 void sysctl_debug_free_preoslog(void); 766 767 #if DEBUG || DEVELOPMENT 768 /* leak pointer scan definitions */ 769 770 enum{ 771 kInstanceFlagAddress = 0x01UL, 772 kInstanceFlagReferenced = 0x02UL, 773 kInstanceFlags = 0x03UL 774 }; 775 776 #define INSTANCE_GET(x) ((x) & ~kInstanceFlags) 777 #define INSTANCE_PUT(x) ((x) ^ ~kInstanceFlags) 778 779 typedef void (^leak_site_proc)(uint32_t siteCount, uint32_t elem_size, uint32_t btref); 780 781 extern kern_return_t 782 zone_leaks(const char * zoneName, uint32_t nameLen, leak_site_proc proc); 783 784 extern void 785 zone_leaks_scan(uintptr_t * instances, uint32_t count, uint32_t zoneSize, uint32_t * found); 786 787 #endif /* DEBUG || DEVELOPMENT */ 788 789 /* 790 * A callback that reads or writes data from a given offset into the corefile. It is understood that this 791 * callback should only be used from within the context where it is given. It should never be stored and 792 * reused later on. 793 */ 794 typedef kern_return_t (*IOCoreFileAccessCallback)(void *context, boolean_t write, uint64_t offset, int length, void *buffer); 795 796 /* 797 * A callback that receives temporary file-system access to the kernel corefile 798 * 799 * Parameters: 800 * - access: A function to call for reading/writing the kernel corefile. 801 * - access_context: The context that should be passed to the 'access' function. 802 * - recipient_context: The recipient-specific context. Can be anything. 803 */ 804 typedef kern_return_t (*IOCoreFileAccessRecipient)(IOCoreFileAccessCallback access, void *access_context, void *recipient_context); 805 806 /* 807 * Provides safe and temporary file-system access to the kernel corefile to the given recipient callback. 808 * It does so by opening the kernel corefile, then calling the 'recipient' callback, passing it an IOCoreFileAccessCallback 809 * function that it can use to read/write data, then closing the kernel corefile as soon as the recipient returns. 810 * 811 * Parameters: 812 * - recipient: A function to call, providing it access to the kernel corefile. 813 * - recipient_context: Recipient-specific context. Can be anything. 814 */ 815 extern kern_return_t 816 IOProvideCoreFileAccess(IOCoreFileAccessRecipient recipient, void *recipient_context); 817 818 struct kdp_core_encryption_key_descriptor { 819 uint64_t kcekd_format; 820 uint16_t kcekd_size; 821 void * kcekd_key; 822 }; 823 824 /* 825 * Registers a new kernel (and co-processor) coredump encryption key. The key format should be one of the 826 * supported "next" key formats in mach_debug_types.h. The recipient context pointer should point to a kdp_core_encryption_key_descriptor 827 * structure. 828 * 829 * Note that the given key pointer should be allocated using `kmem_alloc(kernel_map, <pointer>, <size>, VM_KERN_MEMORY_DIAG)` 830 * 831 * Note that upon successful completion, this function will adopt the given public key pointer 832 * and the caller should NOT release it. 833 */ 834 kern_return_t kdp_core_handle_new_encryption_key(IOCoreFileAccessCallback access_data, void *access_context, void *recipient_context); 835 836 /* 837 * Enum of allowed values for the 'lbr_support' boot-arg 838 */ 839 typedef enum { 840 LBR_ENABLED_NONE, 841 LBR_ENABLED_USERMODE, 842 LBR_ENABLED_KERNELMODE, 843 LBR_ENABLED_ALLMODES 844 } lbr_modes_t; 845 846 extern lbr_modes_t last_branch_enabled_modes; 847 848 #endif /* XNU_KERNEL_PRIVATE */ 849 850 __END_DECLS 851 852 #endif /* _KERN_DEBUG_H_ */ 853