+enum micro_snapshot_flags {
+ kInterruptRecord = 0x1,
+ kTimerArmingRecord = 0x2,
+ kUserMode = 0x4, /* interrupted usermode, or armed by usermode */
+ kIORecord = 0x8,
+ kPMIRecord = 0x10,
+};
+
+/*
+ * Flags used in the following assortment of snapshots.
+ */
+enum generic_snapshot_flags {
+ kUser64_p = 0x1, /* Userspace uses 64 bit pointers */
+ kKernel64_p = 0x2 /* The kernel uses 64 bit pointers */
+};
+
+#define VM_PRESSURE_TIME_WINDOW 5 /* seconds */
+
+enum {
+ STACKSHOT_GET_DQ = 0x01,
+ STACKSHOT_SAVE_LOADINFO = 0x02,
+ STACKSHOT_GET_GLOBAL_MEM_STATS = 0x04,
+ STACKSHOT_SAVE_KEXT_LOADINFO = 0x08,
+ STACKSHOT_GET_MICROSTACKSHOT = 0x10,
+ STACKSHOT_GLOBAL_MICROSTACKSHOT_ENABLE = 0x20,
+ STACKSHOT_GLOBAL_MICROSTACKSHOT_DISABLE = 0x40,
+ STACKSHOT_SET_MICROSTACKSHOT_MARK = 0x80,
+ STACKSHOT_ACTIVE_KERNEL_THREADS_ONLY = 0x100,
+ STACKSHOT_GET_BOOT_PROFILE = 0x200,
+ STACKSHOT_SAVE_IMP_DONATION_PIDS = 0x2000,
+ STACKSHOT_SAVE_IN_KERNEL_BUFFER = 0x4000,
+ STACKSHOT_RETRIEVE_EXISTING_BUFFER = 0x8000,
+ STACKSHOT_KCDATA_FORMAT = 0x10000,
+ STACKSHOT_ENABLE_BT_FAULTING = 0x20000,
+ STACKSHOT_COLLECT_DELTA_SNAPSHOT = 0x40000,
+ /* Include the layout of the system shared cache */
+ STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT = 0x80000,
+ /*
+ * Kernel consumers of stackshot (via stack_snapshot_from_kernel) can ask
+ * that we try to take the stackshot lock, and fail if we don't get it.
+ */
+ STACKSHOT_TRYLOCK = 0x100000,
+ STACKSHOT_ENABLE_UUID_FAULTING = 0x200000,
+ STACKSHOT_FROM_PANIC = 0x400000,
+ STACKSHOT_NO_IO_STATS = 0x800000,
+ /* Report owners of and pointers to kernel objects that threads are blocked on */
+ STACKSHOT_THREAD_WAITINFO = 0x1000000,
+ STACKSHOT_THREAD_GROUP = 0x2000000,
+ STACKSHOT_SAVE_JETSAM_COALITIONS = 0x4000000,
+ STACKSHOT_INSTRS_CYCLES = 0x8000000,
+ STACKSHOT_ASID = 0x10000000,
+ STACKSHOT_PAGE_TABLES = 0x20000000,
+};
+
+#define STACKSHOT_THREAD_SNAPSHOT_MAGIC 0xfeedface
+#define STACKSHOT_TASK_SNAPSHOT_MAGIC 0xdecafbad
+#define STACKSHOT_MEM_AND_IO_SNAPSHOT_MAGIC 0xbfcabcde
+#define STACKSHOT_MICRO_SNAPSHOT_MAGIC 0x31c54011
+
+#define KF_INITIALIZED (0x1)
+#define KF_SERIAL_OVRD (0x2)
+#define KF_PMAPV_OVRD (0x4)
+#define KF_MATV_OVRD (0x8)
+#define KF_STACKSHOT_OVRD (0x10)
+#define KF_COMPRSV_OVRD (0x20)
+#define KF_INTERRUPT_MASKED_DEBUG_OVRD (0x40)
+#define KF_TRAPTRACE_OVRD (0x80)
+#define KF_IOTRACE_OVRD (0x100)
+
+boolean_t kern_feature_override(uint32_t fmask);
+
+#define EMBEDDED_PANIC_HEADER_OSVERSION_LEN 32
+
+/*
+ * Any updates to this header should be also updated in astris as it can not
+ * grab this header from the SDK.
+ *
+ * NOTE: DO NOT REMOVE OR CHANGE THE MEANING OF ANY FIELDS FROM THIS STRUCTURE.
+ * Any modifications should add new fields at the end, bump the version number
+ * and be done alongside astris and DumpPanic changes.
+ */
+struct embedded_panic_header {
+ uint32_t eph_magic; /* EMBEDDED_PANIC_MAGIC if valid */
+ uint32_t eph_crc; /* CRC of everything following the ph_crc in the header and the contents */
+ uint32_t eph_version; /* embedded_panic_header version */
+ uint64_t eph_panic_flags; /* Flags indicating any state or relevant details */
+ uint32_t eph_panic_log_offset; /* Offset of the beginning of the panic log from the beginning of the header */
+ uint32_t eph_panic_log_len; /* length of the panic log */
+ uint32_t eph_stackshot_offset; /* Offset of the beginning of the panic stackshot from the beginning of the header */
+ uint32_t eph_stackshot_len; /* length of the panic stackshot (0 if not valid ) */
+ uint32_t eph_other_log_offset; /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */
+ uint32_t eph_other_log_len; /* length of the other log */
+ union {
+ struct {
+ uint64_t eph_x86_power_state:8,
+ eph_x86_efi_boot_state:8,
+ eph_x86_system_state:8,
+ eph_x86_unused_bits:40;
+ }; // anonymous struct to group the bitfields together.
+ uint64_t eph_x86_do_not_use; /* Used for offsetof/sizeof when parsing header */
+ };
+ char eph_os_version[EMBEDDED_PANIC_HEADER_OSVERSION_LEN];
+ char eph_macos_version[EMBEDDED_PANIC_HEADER_OSVERSION_LEN];
+} __attribute__((packed));
+
+#define EMBEDDED_PANIC_HEADER_FLAG_COREDUMP_COMPLETE 0x01
+#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_SUCCEEDED 0x02
+#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_DEBUGGERSYNC 0x04
+#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR 0x08
+#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_INCOMPLETE 0x10
+#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_NESTED 0x20
+#define EMBEDDED_PANIC_HEADER_FLAG_NESTED_PANIC 0x40
+#define EMBEDDED_PANIC_HEADER_FLAG_BUTTON_RESET_PANIC 0x80
+#define EMBEDDED_PANIC_HEADER_FLAG_COPROC_INITIATED_PANIC 0x100
+#define EMBEDDED_PANIC_HEADER_FLAG_COREDUMP_FAILED 0x200
+
+#define EMBEDDED_PANIC_HEADER_CURRENT_VERSION 2
+#define EMBEDDED_PANIC_MAGIC 0x46554E4B /* FUNK */
+
+struct macos_panic_header {
+ uint32_t mph_magic; /* MACOS_PANIC_MAGIC if valid */
+ uint32_t mph_crc; /* CRC of everything following mph_crc in the header and the contents */
+ uint32_t mph_version; /* macos_panic_header version */
+ uint32_t mph_padding; /* unused */
+ uint64_t mph_panic_flags; /* Flags indicating any state or relevant details */
+ uint32_t mph_panic_log_offset; /* Offset of the panic log from the beginning of the header */
+ uint32_t mph_panic_log_len; /* length of the panic log */
+ uint32_t mph_stackshot_offset; /* Offset of the panic stackshot from the beginning of the header */
+ uint32_t mph_stackshot_len; /* length of the panic stackshot */
+ uint32_t mph_other_log_offset; /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */
+ uint32_t mph_other_log_len; /* length of the other log */
+ char mph_data[]; /* panic data -- DO NOT ACCESS THIS FIELD DIRECTLY. Use the offsets above relative to the beginning of the header */
+} __attribute__((packed));
+
+#define MACOS_PANIC_HEADER_CURRENT_VERSION 2
+#define MACOS_PANIC_MAGIC 0x44454544 /* DEED */
+
+#define MACOS_PANIC_HEADER_FLAG_NESTED_PANIC 0x01
+#define MACOS_PANIC_HEADER_FLAG_COPROC_INITIATED_PANIC 0x02
+#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_SUCCEEDED 0x04
+#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_DATA_COMPRESSED 0x08
+#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_DEBUGGERSYNC 0x10
+#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR 0x20
+#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_INCOMPLETE 0x40
+#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_NESTED 0x80
+#define MACOS_PANIC_HEADER_FLAG_COREDUMP_COMPLETE 0x100
+#define MACOS_PANIC_HEADER_FLAG_COREDUMP_FAILED 0x200
+#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_KERNEL_ONLY 0x400
+
+/*
+ * Any change to the below structure should mirror the structure defined in MacEFIFirmware
+ * (and vice versa)
+ */
+
+struct efi_aurr_panic_header {
+ uint32_t efi_aurr_magic;
+ uint32_t efi_aurr_crc;
+ uint32_t efi_aurr_version;
+ uint32_t efi_aurr_reset_cause;
+ uint32_t efi_aurr_reset_log_offset;
+ uint32_t efi_aurr_reset_log_len;
+ char efi_aurr_panic_data[];
+} __attribute__((packed));
+
+/*
+ * EXTENDED_/DEBUG_BUF_SIZE can't grow without updates to SMC and iBoot to store larger panic logs on co-processor systems
+ */
+#define EXTENDED_DEBUG_BUF_SIZE 0x0013ff80
+
+#define EFI_AURR_PANIC_STRING_MAX_LEN 112
+#define EFI_AURR_EXTENDED_LOG_SIZE (EXTENDED_DEBUG_BUF_SIZE - sizeof(struct efi_aurr_panic_header) - EFI_AURR_PANIC_STRING_MAX_LEN)
+
+struct efi_aurr_extended_panic_log {
+ char efi_aurr_extended_log_buf[EFI_AURR_EXTENDED_LOG_SIZE];
+ uint32_t efi_aurr_log_tail; /* Circular buffer indices */
+ uint32_t efi_aurr_log_head; /* ditto.. */
+} __attribute__((packed));
+
+#endif /* __APPLE_API_UNSTABLE */
+#endif /* __APPLE_API_PRIVATE */
+
+#ifdef KERNEL
+
+__BEGIN_DECLS
+
+__abortlike __printflike(1, 2)
+extern void panic(const char *string, ...);
+
+__END_DECLS
+
+#endif /* KERNEL */
+
+#ifdef KERNEL_PRIVATE
+#if DEBUG
+#ifndef DKPR
+#define DKPR 1
+#endif
+#endif
+
+#if DKPR
+/*
+ * For the DEBUG kernel, support the following:
+ * sysctl -w debug.kprint_syscall=<syscall_mask>
+ * sysctl -w debug.kprint_syscall_process=<p_comm>
+ * <syscall_mask> should be an OR of the masks below
+ * for UNIX, MACH, MDEP, or IPC. This debugging aid
+ * assumes the task/process is locked/wired and will
+ * not go away during evaluation. If no process is
+ * specified, all processes will be traced
+ */
+extern int debug_kprint_syscall;
+extern int debug_kprint_current_process(const char **namep);
+#define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) \
+ ( (debug_kprint_syscall & (mask)) && debug_kprint_current_process(namep) )
+#define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { \
+ const char *dks_name = NULL; \
+ if (DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, &dks_name)) { \
+ kprintf("[%s%s%p]" fmt, dks_name ? dks_name : "", \
+ dks_name ? "@" : "", current_thread(), args); \
+ } \
+ } while (0)
+#else /* !DEBUG */
+#define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) (0)
+#define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { } while (0) /* kprintf(fmt, args) */
+#endif /* !DEBUG */
+
+enum {
+ DEBUG_KPRINT_SYSCALL_UNIX_MASK = 1 << 0,
+ DEBUG_KPRINT_SYSCALL_MACH_MASK = 1 << 1,
+ DEBUG_KPRINT_SYSCALL_MDEP_MASK = 1 << 2,
+ DEBUG_KPRINT_SYSCALL_IPC_MASK = 1 << 3
+};
+
+#define DEBUG_KPRINT_SYSCALL_PREDICATE(mask) \
+ DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, NULL)
+#define DEBUG_KPRINT_SYSCALL_UNIX(fmt, args...) \
+ DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_UNIX_MASK,fmt,args)
+#define DEBUG_KPRINT_SYSCALL_MACH(fmt, args...) \
+ DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MACH_MASK,fmt,args)
+#define DEBUG_KPRINT_SYSCALL_MDEP(fmt, args...) \
+ DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MDEP_MASK,fmt,args)
+#define DEBUG_KPRINT_SYSCALL_IPC(fmt, args...) \
+ DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_IPC_MASK,fmt,args)
+
+/* Debug boot-args */
+#define DB_HALT 0x1
+//#define DB_PRT 0x2 -- obsolete
+#define DB_NMI 0x4
+#define DB_KPRT 0x8
+#define DB_KDB 0x10
+#define DB_ARP 0x40
+#define DB_KDP_BP_DIS 0x80
+//#define DB_LOG_PI_SCRN 0x100 -- obsolete
+#define DB_KDP_GETC_ENA 0x200
+
+#define DB_KERN_DUMP_ON_PANIC 0x400 /* Trigger core dump on panic*/
+#define DB_KERN_DUMP_ON_NMI 0x800 /* Trigger core dump on NMI */
+#define DB_DBG_POST_CORE 0x1000 /*Wait in debugger after NMI core */
+#define DB_PANICLOG_DUMP 0x2000 /* Send paniclog on panic,not core*/
+#define DB_REBOOT_POST_CORE 0x4000 /* Attempt to reboot after
+ * post-panic crashdump/paniclog
+ * dump.
+ */
+#define DB_NMI_BTN_ENA 0x8000 /* Enable button to directly trigger NMI */
+#define DB_PRT_KDEBUG 0x10000 /* kprintf KDEBUG traces */
+#define DB_DISABLE_LOCAL_CORE 0x20000 /* ignore local kernel core dump support */
+#define DB_DISABLE_GZIP_CORE 0x40000 /* don't gzip kernel core dumps */
+#define DB_DISABLE_CROSS_PANIC 0x80000 /* x86 only - don't trigger cross panics. Only
+ * necessary to enable x86 kernel debugging on
+ * configs with a dev-fused co-processor running
+ * release bridgeOS.
+ */
+#define DB_REBOOT_ALWAYS 0x100000 /* Don't wait for debugger connection */
+#define DB_DISABLE_STACKSHOT_TO_DISK 0x200000 /* Disable writing stackshot to local disk */
+
+/*
+ * Values for a 64-bit mask that's passed to the debugger.
+ */
+#define DEBUGGER_OPTION_NONE 0x0ULL
+#define DEBUGGER_OPTION_PANICLOGANDREBOOT 0x1ULL /* capture a panic log and then reboot immediately */
+#define DEBUGGER_OPTION_RECURPANIC_ENTRY 0x2ULL
+#define DEBUGGER_OPTION_RECURPANIC_PRELOG 0x4ULL
+#define DEBUGGER_OPTION_RECURPANIC_POSTLOG 0x8ULL
+#define DEBUGGER_OPTION_RECURPANIC_POSTCORE 0x10ULL
+#define DEBUGGER_OPTION_INITPROC_PANIC 0x20ULL
+#define DEBUGGER_OPTION_COPROC_INITIATED_PANIC 0x40ULL /* panic initiated by a co-processor */
+#define DEBUGGER_OPTION_SKIP_LOCAL_COREDUMP 0x80ULL /* don't try to save local coredumps for this panic */
+#define DEBUGGER_OPTION_ATTEMPTCOREDUMPANDREBOOT 0x100ULL /* attempt to save coredump. always reboot */
+#define DEBUGGER_INTERNAL_OPTION_THREAD_BACKTRACE 0x200ULL /* backtrace the specified thread in the paniclog (x86 only) */
+#define DEBUGGER_OPTION_PRINT_CPU_USAGE_PANICLOG 0x400ULL /* print extra CPU usage data in the panic log */
+#define DEBUGGER_OPTION_SKIP_PANICEND_CALLOUTS 0x800ULL /* (bridgeOS) skip the kPEPanicEnd callouts -- don't wait for x86 to finish sending panic data */
+
+#define DEBUGGER_INTERNAL_OPTIONS_MASK (DEBUGGER_INTERNAL_OPTION_THREAD_BACKTRACE)
projects / apple / xnu.git / blobdiff