/*
- * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
+ * Copyright (c) 2000-2019 Apple Inc. All rights reserved.
*
* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
- *
+ *
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* unlawful or unlicensed copies of an Apple operating system, or to
* circumvent, violate, or enable the circumvention or violation of, any
* terms of an Apple operating system software license agreement.
- *
+ *
* Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this file.
- *
+ *
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
- *
+ *
* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
-#ifndef _KERN_DEBUG_H_
+#ifndef _KERN_DEBUG_H_
#define _KERN_DEBUG_H_
+#include <kern/kcdata.h>
+
#include <sys/cdefs.h>
#include <stdint.h>
+#include <stdarg.h>
+#include <uuid/uuid.h>
+#include <mach/boolean.h>
+#include <mach/kern_return.h>
+
+#ifndef XNU_KERNEL_PRIVATE
+#include <TargetConditionals.h>
+#endif
#ifdef __APPLE_API_PRIVATE
#ifdef __APPLE_API_UNSTABLE
struct thread_snapshot {
- uint32_t snapshot_magic;
- uint32_t nkern_frames;
- uint32_t nuser_frames;
- uint64_t wait_event;
- uint64_t continuation;
- uint64_t thread_id;
- int32_t state;
- char ss_flags;
-} __attribute__ ((packed));
-
+ uint32_t snapshot_magic;
+ uint32_t nkern_frames;
+ uint32_t nuser_frames;
+ uint64_t wait_event;
+ uint64_t continuation;
+ uint64_t thread_id;
+ uint64_t user_time;
+ uint64_t system_time;
+ int32_t state;
+ int32_t priority; /* static priority */
+ int32_t sched_pri; /* scheduled (current) priority */
+ int32_t sched_flags; /* scheduler flags */
+ char ss_flags;
+ char ts_qos; /* effective qos */
+ char ts_rqos; /* requested qos */
+ char ts_rqos_override; /* requested qos override */
+ char io_tier;
+ char _reserved[3]; /* pad for 4 byte alignement packing */
+
+ /*
+ * I/O Statistics
+ * XXX: These fields must be together
+ */
+ uint64_t disk_reads_count;
+ uint64_t disk_reads_size;
+ uint64_t disk_writes_count;
+ uint64_t disk_writes_size;
+ uint64_t io_priority_count[STACKSHOT_IO_NUM_PRIORITIES];
+ uint64_t io_priority_size[STACKSHOT_IO_NUM_PRIORITIES];
+ uint64_t paging_count;
+ uint64_t paging_size;
+ uint64_t non_paging_count;
+ uint64_t non_paging_size;
+ uint64_t data_count;
+ uint64_t data_size;
+ uint64_t metadata_count;
+ uint64_t metadata_size;
+ /* XXX: I/O Statistics end */
+
+ uint64_t voucher_identifier; /* obfuscated voucher identifier */
+ uint64_t total_syscalls;
+ char pth_name[STACKSHOT_MAX_THREAD_NAME_SIZE];
+} __attribute__((packed));
+
+/* old, non kcdata format */
struct task_snapshot {
- uint32_t snapshot_magic;
- int32_t pid;
- uint32_t nloadinfos;
- char ss_flags;
- /* We restrict ourselves to a statically defined
+ uint32_t snapshot_magic;
+ int32_t pid;
+ uint64_t uniqueid;
+ uint64_t user_time_in_terminated_threads;
+ uint64_t system_time_in_terminated_threads;
+ uint8_t shared_cache_identifier[16];
+ uint64_t shared_cache_slide;
+ uint32_t nloadinfos;
+ int suspend_count;
+ int task_size; /* pages */
+ int faults; /* number of page faults */
+ int pageins; /* number of actual pageins */
+ int cow_faults; /* number of copy-on-write faults */
+ uint32_t ss_flags;
+ uint64_t p_start_sec; /* from the bsd proc struct */
+ uint64_t p_start_usec; /* from the bsd proc struct */
+
+ /*
+ * We restrict ourselves to a statically defined
* (current as of 2009) length for the
* p_comm string, due to scoping issues (osfmk/bsd and user/kernel
* binary compatibility).
*/
- char p_comm[17];
+ char p_comm[17];
+ uint32_t was_throttled;
+ uint32_t did_throttle;
+ uint32_t latency_qos;
+ /*
+ * I/O Statistics
+ * XXX: These fields must be together.
+ */
+ uint64_t disk_reads_count;
+ uint64_t disk_reads_size;
+ uint64_t disk_writes_count;
+ uint64_t disk_writes_size;
+ uint64_t io_priority_count[STACKSHOT_IO_NUM_PRIORITIES];
+ uint64_t io_priority_size[STACKSHOT_IO_NUM_PRIORITIES];
+ uint64_t paging_count;
+ uint64_t paging_size;
+ uint64_t non_paging_count;
+ uint64_t non_paging_size;
+ uint64_t data_count;
+ uint64_t data_size;
+ uint64_t metadata_count;
+ uint64_t metadata_size;
+ /* XXX: I/O Statistics end */
+
+ uint32_t donating_pid_count;
} __attribute__ ((packed));
-enum {
- kUser64_p = 0x1,
- kKernel64_p = 0x2,
- kHasDispatchSerial = 0x4
-};
-enum {
- STACKSHOT_GET_DQ = 0x1,
- STACKSHOT_SAVE_LOADINFO = 0x2
+
+struct micro_snapshot {
+ uint32_t snapshot_magic;
+ uint32_t ms_cpu; /* cpu number this snapshot was recorded on */
+ uint64_t ms_time; /* time at sample (seconds) */
+ uint64_t ms_time_microsecs;
+ uint8_t ms_flags;
+ uint16_t ms_opaque_flags; /* managed by external entity, e.g. fdrmicrod */
+} __attribute__ ((packed));
+
+
+/*
+ * mirrors the dyld_cache_header struct defined in dyld_cache_format.h from dyld source code
+ */
+struct _dyld_cache_header {
+ char magic[16]; // e.g. "dyld_v0 i386"
+ uint32_t mappingOffset; // file offset to first dyld_cache_mapping_info
+ uint32_t mappingCount; // number of dyld_cache_mapping_info entries
+ uint32_t imagesOffset; // file offset to first dyld_cache_image_info
+ uint32_t imagesCount; // number of dyld_cache_image_info entries
+ uint64_t dyldBaseAddress; // base address of dyld when cache was built
+ uint64_t codeSignatureOffset;// file offset of code signature blob
+ uint64_t codeSignatureSize; // size of code signature blob (zero means to end of file)
+ uint64_t slideInfoOffset; // file offset of kernel slid info
+ uint64_t slideInfoSize; // size of kernel slid info
+ uint64_t localSymbolsOffset; // file offset of where local symbols are stored
+ uint64_t localSymbolsSize; // size of local symbols information
+ uint8_t uuid[16]; // unique value for each shared cache file
+ uint64_t cacheType; // 0 for development, 1 for production
+ uint32_t branchPoolsOffset; // file offset to table of uint64_t pool addresses
+ uint32_t branchPoolsCount; // number of uint64_t entries
+ uint64_t accelerateInfoAddr; // (unslid) address of optimization info
+ uint64_t accelerateInfoSize; // size of optimization info
+ uint64_t imagesTextOffset; // file offset to first dyld_cache_image_text_info
+ uint64_t imagesTextCount; // number of dyld_cache_image_text_info entries
+ uint64_t dylibsImageGroupAddr;// (unslid) address of ImageGroup for dylibs in this cache
+ uint64_t dylibsImageGroupSize;// size of ImageGroup for dylibs in this cache
+ uint64_t otherImageGroupAddr;// (unslid) address of ImageGroup for other OS dylibs
+ uint64_t otherImageGroupSize;// size of oImageGroup for other OS dylibs
+ uint64_t progClosuresAddr; // (unslid) address of list of program launch closures
+ uint64_t progClosuresSize; // size of list of program launch closures
+ uint64_t progClosuresTrieAddr;// (unslid) address of trie of indexes into program launch closures
+ uint64_t progClosuresTrieSize;// size of trie of indexes into program launch closures
+ uint32_t platform; // platform number (macOS=1, etc)
+ uint32_t formatVersion : 8,// dyld3::closure::kFormatVersion
+ dylibsExpectedOnDisk : 1, // dyld should expect the dylib exists on disk and to compare inode/mtime to see if cache is valid
+ simulator : 1, // for simulator of specified platform
+ locallyBuiltCache : 1, // 0 for B&I built cache, 1 for locally built cache
+ padding : 21; // TBD
};
-#define STACKSHOT_THREAD_SNAPSHOT_MAGIC 0xfeedface
-#define STACKSHOT_TASK_SNAPSHOT_MAGIC 0xdecafbad
+/*
+ * mirrors the dyld_cache_image_text_info struct defined in dyld_cache_format.h from dyld source code
+ */
+struct _dyld_cache_image_text_info {
+ uuid_t uuid;
+ uint64_t loadAddress; // unslid address of start of __TEXT
+ uint32_t textSegmentSize;
+ uint32_t pathOffset; // offset from start of cache file
+};
-#endif /* __APPLE_API_UNSTABLE */
-#endif /* __APPLE_API_PRIVATE */
-#ifdef KERNEL_PRIVATE
+enum micro_snapshot_flags {
+ kInterruptRecord = 0x1,
+ kTimerArmingRecord = 0x2,
+ kUserMode = 0x4, /* interrupted usermode, or armed by usermode */
+ kIORecord = 0x8,
+ kPMIRecord = 0x10,
+};
-extern unsigned int systemLogDiags;
-extern char debug_buf[];
-extern unsigned int debug_boot_arg;
+/*
+ * 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 */
+};
-#ifdef MACH_KERNEL_PRIVATE
+#define VM_PRESSURE_TIME_WINDOW 5 /* seconds */
-extern unsigned int halt_in_debugger;
+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,
+};
-extern unsigned int switch_debugger;
+#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
-extern unsigned int current_debugger;
-#define NO_CUR_DB 0x0
-#define KDP_CUR_DB 0x1
-#define KDB_CUR_DB 0x2
+#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)
-extern unsigned int active_debugger;
-extern unsigned int debug_mode;
-extern unsigned int disable_debug_output;
+boolean_t kern_feature_override(uint32_t fmask);
-extern unsigned int panicDebugging;
-extern unsigned int logPanicDataToScreen;
+#define EMBEDDED_PANIC_HEADER_OSVERSION_LEN 32
-extern int db_run_mode;
+/*
+ * 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
-/* modes the system may be running in */
+/*
+ * Any change to the below structure should mirror the structure defined in MacEFIFirmware
+ * (and vice versa)
+ */
-#define STEP_NONE 0
-#define STEP_ONCE 1
-#define STEP_RETURN 2
-#define STEP_CALLT 3
-#define STEP_CONTINUE 4
-#define STEP_INVISIBLE 5
-#define STEP_COUNT 6
-#define STEP_TRACE 7 /* Show all calls to functions and returns */
+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));
-extern const char *panicstr;
-extern volatile unsigned int nestedpanic;
-extern int unsigned long panic_caller;
+/*
+ * 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
-extern char *debug_buf_ptr;
-extern unsigned int debug_buf_size;
+#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)
-extern void debug_log_init(void);
-extern void debug_putc(char);
+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));
-extern void panic_init(void);
+#endif /* __APPLE_API_UNSTABLE */
+#endif /* __APPLE_API_PRIVATE */
-int packA(char *inbuf, uint32_t length, uint32_t buflen);
-void unpackA(char *inbuf, uint32_t length);
+#ifdef KERNEL
-void panic_display_system_configuration(void);
-void panic_display_zprint(void);
+__BEGIN_DECLS
-#endif /* MACH_KERNEL_PRIVATE */
+__abortlike __printflike(1, 2)
+extern void panic(const char *string, ...);
-#define DB_HALT 0x1
-#define DB_PRT 0x2
-#define DB_NMI 0x4
-#define DB_KPRT 0x8
-#define DB_KDB 0x10
-#define DB_SLOG 0x20
-#define DB_ARP 0x40
-#define DB_KDP_BP_DIS 0x80
-#define DB_LOG_PI_SCRN 0x100
-#define DB_KDP_GETC_ENA 0x200
+__END_DECLS
-#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.
- */
+#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=<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
*/
extern int debug_kprint_syscall;
extern int debug_kprint_current_process(const char **namep);
-#define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, 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); \
- } \
+#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)
+#define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { } while (0) /* kprintf(fmt, args) */
#endif /* !DEBUG */
enum {
DEBUG_KPRINT_SYSCALL_IPC_MASK = 1 << 3
};
-#define DEBUG_KPRINT_SYSCALL_PREDICATE(mask) \
+#define DEBUG_KPRINT_SYSCALL_PREDICATE(mask) \
DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, NULL)
-#define DEBUG_KPRINT_SYSCALL_UNIX(fmt, args...) \
+#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...) \
+#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...) \
+#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...) \
+#define DEBUG_KPRINT_SYSCALL_IPC(fmt, args...) \
DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_IPC_MASK,fmt,args)
-#endif /* KERNEL_PRIVATE */
+/* 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 */
-__BEGIN_DECLS
+/*
+ * 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)
-extern void panic(const char *string, ...) __printflike(1,2);
+__BEGIN_DECLS
-#if KERNEL_PRIVATE
-void _consume_panic_args(int, ...);
-#endif
+#define panic_plain(ex, ...) (panic)(ex, ## __VA_ARGS__)
-#if CONFIG_NO_PANIC_STRINGS
-#if KERNEL_PRIVATE
-#define panic_plain(x, ...) _consume_panic_args( 0, ## __VA_ARGS__ )
-#define panic(x, ...) _consume_panic_args( 0, ## __VA_ARGS__ )
-#else
-#define panic_plain(...) (panic)((char *)0)
-#define panic(...) (panic)((char *)0)
-#endif
-#else /* CONFIGS_NO_PANIC_STRINGS */
-#define panic_plain(ex, ...) \
- (panic)(ex, ## __VA_ARGS__)
#define __STRINGIFY(x) #x
#define LINE_NUMBER(x) __STRINGIFY(x)
#define PANIC_LOCATION __FILE__ ":" LINE_NUMBER(__LINE__)
-#define panic(ex, ...) \
- (panic)(# ex "@" PANIC_LOCATION, ## __VA_ARGS__)
-#endif /* CONFIGS_NO_PANIC_STRINGS */
-void populate_model_name(char *);
-unsigned panic_active(void);
+#if CONFIG_EMBEDDED
+#define panic(ex, ...) ({ \
+ __asm__("" ::: "memory"); \
+ (panic)(# ex, ## __VA_ARGS__); \
+ })
+#else
+#define panic(ex, ...) ({ \
+ __asm__("" ::: "memory"); \
+ (panic)(# ex "@" PANIC_LOCATION, ## __VA_ARGS__); \
+ })
+#endif
+
+__abortlike __printflike(4, 5)
+void panic_with_options(unsigned int reason, void *ctx,
+ uint64_t debugger_options_mask, const char *str, ...);
+void Debugger(const char * message);
+void populate_model_name(char *);
+
+#if !defined (__x86_64__)
+/* Note that producer_name and buf should never be de-allocated as we reference these during panic */
+void register_additional_panic_data_buffer(const char *producer_name, void *buf, int len);
+#endif
+
+unsigned panic_active(void);
+
__END_DECLS
-#endif /* _KERN_DEBUG_H_ */
+#endif /* KERNEL_PRIVATE */
+
+#if XNU_KERNEL_PRIVATE
+
+#if defined (__x86_64__)
+struct thread;
+
+__abortlike __printflike(5, 6)
+void panic_with_thread_context(unsigned int reason, void *ctx,
+ uint64_t debugger_options_mask, struct thread* th, const char *str, ...);
+#endif
+
+/* limit the max size to a reasonable length */
+#define ADDITIONAL_PANIC_DATA_BUFFER_MAX_LEN 64
+
+struct additional_panic_data_buffer {
+ const char *producer_name;
+ void *buf;
+ int len;
+};
+
+extern struct additional_panic_data_buffer *panic_data_buffers;
+
+boolean_t oslog_is_safe(void);
+boolean_t debug_mode_active(void);
+boolean_t stackshot_active(void);
+void panic_stackshot_reset_state(void);
+
+/*
+ * @function stack_snapshot_from_kernel
+ *
+ * @abstract Stackshot function for kernel consumers who have their own buffer.
+ *
+ * @param pid the PID to be traced or -1 for the whole system
+ * @param buf a pointer to the buffer where the stackshot should be written
+ * @param size the size of the buffer
+ * @param flags flags to be passed to the stackshot
+ * @param delta_since_timestamp start time for delta period
+ * @bytes_traced a pointer to be filled with the length of the stackshot
+ *
+ */
+#ifdef __cplusplus
+extern "C" {
+#endif
+kern_return_t
+stack_snapshot_from_kernel(int pid, void *buf, uint32_t size, uint32_t flags,
+ uint64_t delta_since_timestamp, unsigned *bytes_traced);
+
+/*
+ * Returns whether on device corefiles are enabled based on the build
+ * and boot configuration.
+ */
+boolean_t on_device_corefile_enabled(void);
+
+/*
+ * Returns whether panic stackshot to disk is enabled based on the build
+ * and boot configuration.
+ */
+boolean_t panic_stackshot_to_disk_enabled(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#if !CONFIG_EMBEDDED
+extern char debug_buf[];
+extern boolean_t coprocessor_paniclog_flush;
+extern boolean_t extended_debug_log_enabled;
+#endif /* !CONFIG_EMBEDDED */
+
+extern char *debug_buf_base;
+
+#if defined(XNU_TARGET_OS_BRIDGE)
+extern uint64_t macos_panic_base;
+extern unsigned int macos_panic_size;
+#endif /* defined(XNU_TARGET_OS_BRIDGE) */
+
+extern char kernel_uuid_string[];
+extern char panic_disk_error_description[];
+extern size_t panic_disk_error_description_size;
+
+extern unsigned char *kernel_uuid;
+extern unsigned int debug_boot_arg;
+#if DEVELOPMENT || DEBUG
+extern boolean_t debug_boot_arg_inited;
+#endif
+
+extern boolean_t kernelcache_uuid_valid;
+extern uuid_t kernelcache_uuid;
+extern uuid_string_t kernelcache_uuid_string;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+extern boolean_t doprnt_hide_pointers;
+
+#ifdef __cplusplus
+}
+#endif
+
+extern unsigned int halt_in_debugger; /* pending halt in debugger after boot */
+extern unsigned int current_debugger;
+#define NO_CUR_DB 0x0
+#define KDP_CUR_DB 0x1
+
+extern unsigned int active_debugger;
+extern unsigned int kernel_debugger_entry_count;
+
+extern unsigned int panicDebugging;
+extern unsigned int kdebug_serial;
+
+extern const char *debugger_panic_str;
+
+extern char *debug_buf_ptr;
+extern unsigned int debug_buf_size;
+
+extern void debug_log_init(void);
+extern void debug_putc(char);
+
+extern void panic_init(void);
+
+/*
+ * Initialize the physical carveout requested with the `phys_carveout_mb`
+ * boot-arg. This should only be called at kernel startup, when physically
+ * contiguous pages are plentiful.
+ */
+extern void phys_carveout_init(void);
+
+extern uintptr_t phys_carveout_pa;
+extern size_t phys_carveout_size;
+
+
+
+#if defined (__x86_64__)
+extern void extended_debug_log_init(void);
+
+int packA(char *inbuf, uint32_t length, uint32_t buflen);
+void unpackA(char *inbuf, uint32_t length);
+
+#define PANIC_STACKSHOT_BUFSIZE (1024 * 1024)
+
+extern uintptr_t panic_stackshot_buf;
+extern size_t panic_stackshot_buf_len;
+
+extern size_t panic_stackshot_len;
+#endif /* defined (__x86_64__) */
+
+void SavePanicInfo(const char *message, void *panic_data, uint64_t panic_options);
+void paniclog_flush(void);
+void panic_display_system_configuration(boolean_t launchd_exit);
+void panic_display_zprint(void);
+void panic_display_kernel_aslr(void);
+void panic_display_hibb(void);
+void panic_display_model_name(void);
+void panic_display_kernel_uuid(void);
+#if CONFIG_ZLEAKS
+void panic_display_ztrace(void);
+#endif /* CONFIG_ZLEAKS */
+#if CONFIG_ECC_LOGGING
+void panic_display_ecc_errors(void);
+#endif /* CONFIG_ECC_LOGGING */
+
+/*
+ * @var not_in_kdp
+ *
+ * @abstract True if we're in normal kernel operation, False if we're in a
+ * single-core debugger context.
+ */
+extern unsigned int not_in_kdp;
+
+#define DEBUGGER_NO_CPU -1
+
+typedef enum {
+ DBOP_NONE,
+ DBOP_STACKSHOT,
+ DBOP_RESET_PGO_COUNTERS,
+ DBOP_PANIC,
+ DBOP_DEBUGGER,
+ DBOP_BREAKPOINT,
+} debugger_op;
+
+kern_return_t DebuggerTrapWithState(debugger_op db_op, const char *db_message, const char *db_panic_str, va_list *db_panic_args,
+ uint64_t db_panic_options, void *db_panic_data_ptr, boolean_t db_proceed_on_sync_failure, unsigned long db_panic_caller);
+void handle_debugger_trap(unsigned int exception, unsigned int code, unsigned int subcode, void *state);
+
+void DebuggerWithContext(unsigned int reason, void *ctx, const char *message, uint64_t debugger_options_mask);
+
+#if DEBUG || DEVELOPMENT
+/* leak pointer scan definitions */
+
+enum{
+ kInstanceFlagAddress = 0x01UL,
+ kInstanceFlagReferenced = 0x02UL,
+ kInstanceFlags = 0x03UL
+};
+
+#define INSTANCE_GET(x) ((x) & ~kInstanceFlags)
+#define INSTANCE_PUT(x) ((x) ^ ~kInstanceFlags)
+
+typedef void (*leak_site_proc)(void * refCon, uint32_t siteCount, uint32_t zoneSize,
+ uintptr_t * backtrace, uint32_t btCount);
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+extern kern_return_t
+zone_leaks(const char * zoneName, uint32_t nameLen, leak_site_proc proc, void * refCon);
+
+extern void
+zone_leaks_scan(uintptr_t * instances, uint32_t count, uint32_t zoneSize, uint32_t * found);
+
+#ifdef __cplusplus
+}
+#endif
+
+extern boolean_t
+kdp_is_in_zone(void *addr, const char *zone_name);
+
+#endif /* DEBUG || DEVELOPMENT */
+#endif /* XNU_KERNEL_PRIVATE */
+
+#endif /* _KERN_DEBUG_H_ */
projects / apple / xnu.git / blobdiff