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