#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;
uint64_t user_time;
uint64_t system_time;
int32_t state;
int32_t priority;
int32_t sched_pri;
int32_t sched_flags;
char ss_flags;
char ts_qos;
char ts_rqos;
char ts_rqos_override;
char io_tier;
char _reserved[3];
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;
uint64_t voucher_identifier;
uint64_t total_syscalls;
char pth_name[STACKSHOT_MAX_THREAD_NAME_SIZE];
} __attribute__((packed));
struct task_snapshot {
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;
int faults;
int pageins;
int cow_faults;
uint32_t ss_flags;
uint64_t p_start_sec;
uint64_t p_start_usec;
char p_comm[17];
uint32_t was_throttled;
uint32_t did_throttle;
uint32_t latency_qos;
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;
uint32_t donating_pid_count;
} __attribute__ ((packed));
struct micro_snapshot {
uint32_t snapshot_magic;
uint32_t ms_cpu;
uint64_t ms_time;
uint64_t ms_time_microsecs;
uint8_t ms_flags;
uint16_t ms_opaque_flags;
} __attribute__ ((packed));
struct _dyld_cache_header
{
char magic[16]; uint32_t mappingOffset; uint32_t mappingCount; uint32_t imagesOffset; uint32_t imagesCount; uint64_t dyldBaseAddress; uint64_t codeSignatureOffset; uint64_t codeSignatureSize; uint64_t slideInfoOffset; uint64_t slideInfoSize; uint64_t localSymbolsOffset; uint64_t localSymbolsSize; uint8_t uuid[16]; };
enum micro_snapshot_flags {
kInterruptRecord = 0x1,
kTimerArmingRecord = 0x2,
kUserMode = 0x4,
kIORecord = 0x8,
};
enum generic_snapshot_flags {
kUser64_p = 0x1,
kKernel64_p = 0x2
};
#define VM_PRESSURE_TIME_WINDOW 5
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,
STACKSHOT_TAILSPIN = 0x80000,
STACKSHOT_TRYLOCK = 0x100000,
STACKSHOT_ENABLE_UUID_FAULTING = 0x200000,
STACKSHOT_FROM_PANIC = 0x400000,
STACKSHOT_NO_IO_STATS = 0x800000,
STACKSHOT_THREAD_WAITINFO = 0x1000000,
STACKSHOT_THREAD_GROUP = 0x2000000,
STACKSHOT_SAVE_JETSAM_COALITIONS = 0x4000000,
STACKSHOT_INSTRS_CYCLES = 0x8000000,
};
#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)
boolean_t kern_feature_override(uint32_t fmask);
struct embedded_panic_header {
uint32_t eph_magic;
uint32_t eph_crc;
uint32_t eph_version;
uint64_t eph_panic_flags;
uint32_t eph_panic_log_offset;
uint32_t eph_panic_log_len;
uint32_t eph_stackshot_offset;
uint32_t eph_stackshot_len;
uint32_t eph_other_log_offset;
uint32_t eph_other_log_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_CURRENT_VERSION 1
#define EMBEDDED_PANIC_MAGIC 0x46554E4B
struct macos_panic_header {
uint32_t mph_magic;
uint32_t mph_crc;
uint32_t mph_version;
uint32_t mph_padding;
uint64_t mph_panic_flags;
uint32_t mph_panic_log_offset;
uint32_t mph_panic_log_len;
char mph_data[];
} __attribute__((packed));
#define MACOS_PANIC_HEADER_CURRENT_VERSION 1
#define MACOS_PANIC_MAGIC 0x44454544
#define MACOS_PANIC_HEADER_FLAG_NESTED_PANIC 0x01
#define MACOS_PANIC_HEADER_FLAG_COPROC_INITIATED_PANIC 0x02
#endif
#endif
#ifdef KERNEL
__BEGIN_DECLS
extern void panic(const char *string, ...) __printflike(1,2);
__END_DECLS
#endif
#ifdef KERNEL_PRIVATE
#if DEBUG
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
#define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) (0)
#define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { } while (0)
#endif
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)
#define DB_HALT 0x1
#define DB_NMI 0x4
#define DB_KPRT 0x8
#define DB_KDB 0x10
#define DB_ARP 0x40
#define DB_KDP_BP_DIS 0x80
#define DB_KDP_GETC_ENA 0x200
#define DB_KERN_DUMP_ON_PANIC 0x400
#define DB_KERN_DUMP_ON_NMI 0x800
#define DB_DBG_POST_CORE 0x1000
#define DB_PANICLOG_DUMP 0x2000
#define DB_REBOOT_POST_CORE 0x4000
#define DB_NMI_BTN_ENA 0x8000
#define DB_PRT_KDEBUG 0x10000
#define DB_DISABLE_LOCAL_CORE 0x20000
#define DB_DISABLE_GZIP_CORE 0x40000
#define DEBUGGER_OPTION_NONE 0x0ULL
#define DEBUGGER_OPTION_PANICLOGANDREBOOT 0x1ULL
#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
#define DEBUGGER_OPTION_SKIP_LOCAL_COREDUMP 0x80ULL
__BEGIN_DECLS
#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__)
#if CONFIG_EMBEDDED
#define panic(ex, ...) (panic)(# ex, ## __VA_ARGS__)
#else
#define panic(ex, ...) (panic)(# ex "@" PANIC_LOCATION, ## __VA_ARGS__)
#endif
void panic_context(unsigned int reason, void *ctx, const char *string, ...);
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 *);
unsigned panic_active(void);
__END_DECLS
#endif
#if XNU_KERNEL_PRIVATE
boolean_t oslog_is_safe(void);
boolean_t debug_mode_active(void);
boolean_t stackshot_active(void);
#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);
#ifdef __cplusplus
}
#endif
#if !CONFIG_EMBEDDED
extern char debug_buf[];
extern boolean_t coprocessor_paniclog_flush;
#endif
extern char *debug_buf_base;
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;
#ifdef XNU_KERNEL_PRIVATE
#ifdef __cplusplus
extern "C" {
#endif
extern boolean_t doprnt_hide_pointers;
#ifdef __cplusplus
}
#endif
extern unsigned int halt_in_debugger;
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;
#if CONFIG_EMBEDDED
extern unsigned int debug_buf_size;
#else
extern const unsigned int debug_buf_size;
#endif
extern void debug_log_init(void);
extern void debug_putc(char);
extern void panic_init(void);
#if defined (__x86_64__)
int packA(char *inbuf, uint32_t length, uint32_t buflen);
void unpackA(char *inbuf, uint32_t length);
#if DEVELOPMENT || DEBUG
#define PANIC_STACKSHOT_BUFSIZE (1024 * 1024)
extern uintptr_t panic_stackshot_buf;
extern size_t panic_stackshot_len;
#endif
#endif
void SavePanicInfo(const char *message, 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
#if CONFIG_ECC_LOGGING
void panic_display_ecc_errors(void);
#endif
#endif
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, 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
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
#endif
#endif