Implementation sources

osfmk/kern/debug.h

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