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