X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/04b8595b18b1b41ac7a206e4b3d51a635f8413d7..d26ffc64f583ab2d29df48f13518685602bc8832:/osfmk/kern/debug.h diff --git a/osfmk/kern/debug.h b/osfmk/kern/debug.h index 407d4b4f2..860824c04 100644 --- a/osfmk/kern/debug.h +++ b/osfmk/kern/debug.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2000-2007 Apple Inc. All rights reserved. + * Copyright (c) 2000-2016 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * @@ -29,9 +29,14 @@ #ifndef _KERN_DEBUG_H_ #define _KERN_DEBUG_H_ +#include + #include #include +#include #include +#include +#include #ifndef XNU_KERNEL_PRIVATE #include @@ -40,11 +45,6 @@ #ifdef __APPLE_API_PRIVATE #ifdef __APPLE_API_UNSTABLE -/* This value must always match IO_NUM_PRIORITIES defined in thread_info.h */ -#define STACKSHOT_IO_NUM_PRIORITIES 4 -/* This value must always match MAXTHREADNAMESIZE used in bsd */ -#define STACKSHOT_MAX_THREAD_NAME_SIZE 64 - struct thread_snapshot { uint32_t snapshot_magic; uint32_t nkern_frames; @@ -59,8 +59,11 @@ struct thread_snapshot { int32_t sched_pri; /* scheduled (current) priority */ int32_t sched_flags; /* scheduler flags */ char ss_flags; - char ts_qos; + 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 @@ -86,11 +89,12 @@ struct thread_snapshot { uint64_t total_syscalls; char pth_name[STACKSHOT_MAX_THREAD_NAME_SIZE]; -} __attribute__ ((packed)); +} __attribute__((packed)); +/* old, non kcdata format */ struct task_snapshot { - uint32_t snapshot_magic; - int32_t pid; + uint32_t snapshot_magic; + int32_t pid; uint64_t uniqueid; uint64_t user_time_in_terminated_threads; uint64_t system_time_in_terminated_threads; @@ -140,6 +144,8 @@ struct task_snapshot { } __attribute__ ((packed)); + + struct micro_snapshot { uint32_t snapshot_magic; uint32_t ms_cpu; /* cpu number this snapshot was recorded on */ @@ -149,34 +155,7 @@ struct micro_snapshot { uint16_t ms_opaque_flags; /* managed by external entity, e.g. fdrmicrod */ } __attribute__ ((packed)); -struct mem_and_io_snapshot { - uint32_t snapshot_magic; - uint32_t free_pages; - uint32_t active_pages; - uint32_t inactive_pages; - uint32_t purgeable_pages; - uint32_t wired_pages; - uint32_t speculative_pages; - uint32_t throttled_pages; - uint32_t filebacked_pages; - uint32_t compressions; - uint32_t decompressions; - uint32_t compressor_size; - int busy_buffer_count; - uint32_t pages_wanted; - uint32_t pages_reclaimed; - uint8_t pages_wanted_reclaimed_valid; // did mach_vm_pressure_monitor succeed? -} __attribute__((packed)); - -struct stack_snapshot_frame32 { - uint32_t lr; - uint32_t sp; -}; -struct stack_snapshot_frame64 { - uint64_t lr; - uint64_t sp; -}; struct _dyld_cache_header { @@ -195,20 +174,12 @@ struct _dyld_cache_header uint8_t uuid[16]; // unique value for each shared cache file }; -struct dyld_uuid_info_32 { - uint32_t imageLoadAddress; /* base address image is mapped at */ - uuid_t imageUUID; -}; - -struct dyld_uuid_info_64 { - uint64_t imageLoadAddress; /* base address image is mapped at */ - uuid_t imageUUID; -}; enum micro_snapshot_flags { kInterruptRecord = 0x1, kTimerArmingRecord = 0x2, - kUserMode = 0x4, /* interrupted usermode, or armed by usermode */ + kUserMode = 0x4, /* interrupted usermode, or armed by usermode */ + kIORecord = 0x8, }; /* @@ -219,153 +190,168 @@ enum generic_snapshot_flags { kKernel64_p = 0x2 }; - enum task_snapshot_flags { - kTaskRsrcFlagged = 0x4, // In the EXC_RESOURCE danger zone? - kTerminatedSnapshot = 0x8, - kPidSuspended = 0x10, // true for suspended task - kFrozen = 0x20, // true for hibernated task (along with pidsuspended) - kTaskDarwinBG = 0x40, - kTaskExtDarwinBG = 0x80, - kTaskVisVisible = 0x100, - kTaskVisNonvisible = 0x200, - kTaskIsForeground = 0x400, - kTaskIsBoosted = 0x800, - kTaskIsSuppressed = 0x1000, - kTaskIsTimerThrottled = 0x2000, /* deprecated */ - kTaskIsImpDonor = 0x4000, - kTaskIsLiveImpDonor = 0x8000 - }; - -enum thread_snapshot_flags { - kHasDispatchSerial = 0x4, - kStacksPCOnly = 0x8, /* Stack traces have no frame pointers. */ - kThreadDarwinBG = 0x10, /* Thread is darwinbg */ - kThreadIOPassive = 0x20, /* Thread uses passive IO */ - kThreadSuspended = 0x40 /* Thread is supsended */ -}; - #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_SAVE_KERNEL_FRAMES_ONLY = 0x100, - STACKSHOT_GET_BOOT_PROFILE = 0x200, - STACKSHOT_GET_WINDOWED_MICROSTACKSHOTS = 0x400, - STACKSHOT_WINDOWED_MICROSTACKSHOTS_ENABLE = 0x800, - STACKSHOT_WINDOWED_MICROSTACKSHOTS_DISABLE = 0x1000, - STACKSHOT_SAVE_IMP_DONATION_PIDS = 0x2000 + 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 flips on several features aimed at minimizing the size + * of stackshots. It is meant to be used only by the tailspin daemon. Its + * behavior may be changed at any time to suit the needs of the tailspin + * daemon. Seriously, if you are not the tailspin daemon, don't use this + * flag. If you need these features, ask us to add a stable SPI for what + * you need. That being said, the features it turns on are: + * + * minimize_uuids: If the set of loaded dylibs or kexts has not changed in + * the delta period, do then not report them. + * + * iostats: do not include io statistics. + * + * trace_fp: do not include the frame pointers in stack traces. + * + * minimize_nonrunnables: Do not report detailed information about threads + * which were not runnable in the delta period. + */ + STACKSHOT_TAILSPIN = 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, }; -#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 - -#endif /* __APPLE_API_UNSTABLE */ -#endif /* __APPLE_API_PRIVATE */ - -#ifdef KERNEL_PRIVATE - -extern unsigned int systemLogDiags; -#if (!defined(__arm64__) && !defined(NAND_PANIC_DEVICE)) || defined(LEGACY_PANIC_LOGS) -extern char debug_buf[]; -#endif -extern char *debug_buf_addr; -extern unsigned int debug_boot_arg; -extern unsigned char *kernel_uuid; -extern char kernel_uuid_string[]; - -#ifdef MACH_KERNEL_PRIVATE +#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 halt_in_debugger; - -extern unsigned int switch_debugger; - -extern unsigned int current_debugger; -#define NO_CUR_DB 0x0 -#define KDP_CUR_DB 0x1 -#define KDB_CUR_DB 0x2 - -extern unsigned int active_debugger; -extern unsigned int debug_mode; -extern unsigned int disable_debug_output; - -extern unsigned int panicDebugging; -extern unsigned int logPanicDataToScreen; -extern unsigned int kdebug_serial; +#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) -extern int db_run_mode; +boolean_t kern_feature_override(uint32_t fmask); -/* modes the system may be running in */ - -#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 */ +/* + * 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 */ + }; +} __attribute__((packed)); -extern const char *panicstr; -extern volatile unsigned int nestedpanic; -extern int unsigned long panic_caller; +#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)); -extern char *debug_buf_ptr; -extern unsigned int debug_buf_size; +#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 -extern void debug_log_init(void); -extern void debug_putc(char); +#endif /* __APPLE_API_UNSTABLE */ +#endif /* __APPLE_API_PRIVATE */ -extern void panic_init(void); +#ifdef KERNEL -int packA(char *inbuf, uint32_t length, uint32_t buflen); -void unpackA(char *inbuf, uint32_t length); +__BEGIN_DECLS -void panic_display_system_configuration(void); -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 */ -#endif /* MACH_KERNEL_PRIVATE */ +extern void panic(const char *string, ...) __printflike(1,2); -#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. - */ -#define DB_NMI_BTN_ENA 0x8000 /* Enable button to directly trigger NMI */ -#define DB_PRT_KDEBUG 0x10000 /* kprintf KDEBUG traces */ +#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= @@ -410,44 +396,241 @@ enum { #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 -#ifdef KERNEL +#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 */ -__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 */ -extern void panic(const char *string, ...) __printflike(1,2); +__BEGIN_DECLS -#if KERNEL_PRIVATE -void _consume_panic_args(int, ...); -void panic_context(unsigned int reason, void *ctx, const char *string, ...); -#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 */ -#ifdef KERNEL_PRIVATE -void populate_model_name(char *); -unsigned panic_active(void); +#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 /* KERNEL */ +#endif /* KERNEL_PRIVATE */ + +#if XNU_KERNEL_PRIVATE + +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); +#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; + +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 + +#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); + +#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); + +#if DEVELOPMENT || DEBUG +#define PANIC_STACKSHOT_BUFSIZE (1024 * 1024) + +extern uintptr_t panic_stackshot_buf; +extern size_t panic_stackshot_len; +#endif /* DEVELOPMENT || DEBUG */ +#endif /* defined (__x86_64__) */ + +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 /* 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, 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_ */