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