[apple/xnu.git] / osfmk / kern / debug.c

/*
 * Copyright (c) 2000-2016 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
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * 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,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * 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@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */

#include <mach_assert.h>
#include <mach_kdp.h>

#include <kern/cpu_number.h>
#include <kern/kalloc.h>
#include <kern/spl.h>
#include <kern/thread.h>
#include <kern/assert.h>
#include <kern/sched_prim.h>
#include <kern/misc_protos.h>
#include <kern/clock.h>
#include <kern/telemetry.h>
#include <kern/ecc.h>
#include <kern/kern_cdata.h>
#include <kern/zalloc.h>
#include <vm/vm_kern.h>
#include <vm/pmap.h>
#include <stdarg.h>
#if !(MACH_KDP && CONFIG_KDP_INTERACTIVE_DEBUGGING)
#include <kdp/kdp_udp.h>
#endif

#if defined(__i386__) || defined(__x86_64__)
#include <i386/cpu_threads.h>
#include <i386/pmCPU.h>
#endif

#include <IOKit/IOPlatformExpert.h>
#include <machine/pal_routines.h>

#include <sys/kdebug.h>
#include <libkern/OSKextLibPrivate.h>
#include <libkern/OSAtomic.h>
#include <libkern/kernel_mach_header.h>
#include <uuid/uuid.h>
#include <mach_debug/zone_info.h>

#include <os/log_private.h>

#if (defined(__arm64__) || defined(NAND_PANIC_DEVICE)) && !defined(LEGACY_PANIC_LOGS)
#include <pexpert/pexpert.h> /* For gPanicBase */
#endif


unsigned int    halt_in_debugger = 0;
unsigned int    switch_debugger = 0;
unsigned int    current_debugger = 0;
unsigned int    active_debugger = 0;
unsigned int    debug_mode=0;
unsigned int    disable_debug_output = TRUE;
unsigned int    systemLogDiags = FALSE;
unsigned int    panicDebugging = FALSE;
unsigned int    logPanicDataToScreen = FALSE;
unsigned int    kdebug_serial = FALSE;
boolean_t       lock_panic_mode = FALSE;

int mach_assert = 1;

const char              *panicstr = (char *) 0;
decl_simple_lock_data(,panic_lock)
int                     paniccpu;
volatile int            panicwait;
volatile unsigned int   nestedpanic= 0;
unsigned int            panic_is_inited = 0;
unsigned int            return_on_panic = 0;
unsigned long           panic_caller;

#define DEBUG_BUF_SIZE (3 * PAGE_SIZE)

/* debug_buf is directly linked with iBoot panic region for ARM64 targets */
#if (defined(__arm64__) || defined(NAND_PANIC_DEVICE)) && !defined(LEGACY_PANIC_LOGS)
char *debug_buf_addr = NULL;
char *debug_buf_ptr = NULL;
unsigned int debug_buf_size = 0;
#else
char debug_buf[DEBUG_BUF_SIZE];
__used char *debug_buf_addr = debug_buf;
char *debug_buf_ptr = debug_buf;
unsigned int debug_buf_size = sizeof(debug_buf);
#endif

char *debug_buf_stackshot_start;
char *debug_buf_stackshot_end;

static char model_name[64];
unsigned char *kernel_uuid;
/* uuid_string_t */ char kernel_uuid_string[37];

static spl_t panic_prologue(const char *str);
static void panic_epilogue(spl_t s);

struct pasc {
  unsigned a: 7;
  unsigned b: 7;
  unsigned c: 7;
  unsigned d: 7;
  unsigned e: 7;
  unsigned f: 7;
  unsigned g: 7;
  unsigned h: 7;
}  __attribute__((packed));

typedef struct pasc pasc_t;

/* Prevent CPP from breaking the definition below */
#ifdef CONFIG_NO_PANIC_STRINGS
#undef Assert
#endif

int kext_assertions_enable =
#if DEBUG || DEVELOPMENT
                        TRUE;
#else
                        FALSE;
#endif

void __attribute__((noinline))
Assert(
        const char      *file,
        int             line,
        const char      *expression
      )
{
        int saved_return_on_panic;

        if (!mach_assert) {
                kprintf("%s:%d non-fatal Assertion: %s", file, line, expression);
                return;
        }

        saved_return_on_panic = return_on_panic;

        /*
         * If we don't have a debugger configured, returning from an
         * assert is a bad, bad idea; there is no guarantee that we
         * didn't simply assert before we were able to restart the
         * platform.
         */
        if (current_debugger != NO_CUR_DB)
                return_on_panic = 1;

        panic_plain("%s:%d Assertion failed: %s", file, line, expression);

        return_on_panic = saved_return_on_panic;
}

/*
 *      Carefully use the panic_lock.  There's always a chance that
 *      somehow we'll call panic before getting to initialize the
 *      panic_lock -- in this case, we'll assume that the world is
 *      in uniprocessor mode and just avoid using the panic lock.
 */
#define PANIC_LOCK()                                                    \
MACRO_BEGIN                                                             \
        if (panic_is_inited)                                            \
                simple_lock(&panic_lock);                               \
MACRO_END

#define PANIC_UNLOCK()                                                  \
MACRO_BEGIN                                                             \
        if (panic_is_inited)                                            \
                simple_unlock(&panic_lock);                             \
MACRO_END

void
panic_init(void)
{
        unsigned long uuidlen = 0;
        void *uuid;

        uuid = getuuidfromheader(&_mh_execute_header, &uuidlen);
        if ((uuid != NULL) && (uuidlen == sizeof(uuid_t))) {
                kernel_uuid = uuid;
                uuid_unparse_upper(*(uuid_t *)uuid, kernel_uuid_string);
        }

        simple_lock_init(&panic_lock, 0);
        panic_is_inited = 1;
        panic_caller = 0;

        if (!PE_parse_boot_argn("assertions", &mach_assert, sizeof(mach_assert))) {
                mach_assert = 1;
        }
}

void
debug_log_init(void)
{
        if (debug_buf_size != 0)
                return;
#if (defined(__arm64__) || defined(NAND_PANIC_DEVICE)) && !defined(LEGACY_PANIC_LOGS)
        if (!gPanicBase) {
                printf("debug_log_init: Error!! gPanicBase is still not initialized\n");
                return;
        }
        /* Shift debug buf start location and size by 8 bytes for magic header and crc value */
        debug_buf_addr = (char*)gPanicBase + 8;
        debug_buf_ptr = debug_buf_addr;
        debug_buf_size = gPanicSize - 8;
#else
        debug_buf_addr = debug_buf;
        debug_buf_ptr = debug_buf;
        debug_buf_size = sizeof(debug_buf);
#endif
}

#if defined(__i386__) || defined(__x86_64__)
#define panic_stop()    pmCPUHalt(PM_HALT_PANIC)
#define panic_safe()    pmSafeMode(x86_lcpu(), PM_SAFE_FL_SAFE)
#define panic_normal()  pmSafeMode(x86_lcpu(), PM_SAFE_FL_NORMAL)
#else
#define panic_stop()    { while (1) ; }
#define panic_safe()
#define panic_normal()
#endif

/*
 * Prevent CPP from breaking the definition below,
 * since all clients get a #define to prepend line numbers
 */
#undef panic

void _consume_panic_args(int a __unused, ...)
{
    panic("panic");
}

extern unsigned int write_trace_on_panic;

static spl_t
panic_prologue(const char *str)
{
        spl_t   s;

        if (write_trace_on_panic && kdebug_enable) {
                if (get_preemption_level() == 0 && !ml_at_interrupt_context()) {
                        ml_set_interrupts_enabled(TRUE);
                        kdbg_dump_trace_to_file("/var/tmp/panic.trace");
                }
        }

        s = splhigh();
        disable_preemption();
        /* Locking code should relax some checks at panic time */
        lock_panic_mode = TRUE;

#if     defined(__i386__) || defined(__x86_64__)
        /* Attempt to display the unparsed panic string */
        const char *tstr = str;

        kprintf("Panic initiated, string: ");
        while (tstr && *tstr)
                kprintf("%c", *tstr++);
        kprintf("\n");
#endif

        panic_safe();

        if( logPanicDataToScreen )
                disable_debug_output = FALSE;
                
        debug_mode = TRUE;

restart:
        PANIC_LOCK();

        if (panicstr) {
                if (cpu_number() != paniccpu) {
                        PANIC_UNLOCK();
                        /*
                         * Wait until message has been printed to identify correct
                         * cpu that made the first panic.
                         */
                        while (panicwait)
                                continue;
                        goto restart;
            } else {
                        nestedpanic +=1;
                        PANIC_UNLOCK();
                        // Other cores will not be resumed on double panic
                        Debugger("double panic");
                        // a printf statement here was removed to avoid a panic-loop caused
                        // by a panic from printf
                        panic_stop();
                        /* NOTREACHED */
                }
        }
        panicstr = str;
        paniccpu = cpu_number();
        panicwait = 1;

        PANIC_UNLOCK();

        // halt other cores now in anticipation of the debugger call
        return(s);
}

#if DEVELOPMENT || DEBUG
static void
panic_epilogue(spl_t    s)
#else
#if !defined(__i386__) && !defined(__x86_64__)
__attribute__((noreturn))
#endif
static void
panic_epilogue(__unused spl_t   s)
#endif
{
        /*
         * Release panicstr so that we can handle normally other panics.
         */
        PANIC_LOCK();
        panicstr = (char *)0;
        PANIC_UNLOCK();

#if DEVELOPMENT || DEBUG
        if (return_on_panic) {
                // resume other cores as we are returning
                panic_normal();
                enable_preemption();
                splx(s);
                return;
        }
#endif
        kdb_printf("panic: We are hanging here...\n");
        panic_stop();
        /* NOTREACHED */
}

#if !DEVELOPMENT && !DEBUG && !defined(__i386__) && !defined(__x86_64__)
__attribute__((noreturn))
#endif
void
panic(const char *str, ...)
{
        va_list listp;
        spl_t   s;
        boolean_t       old_doprnt_hide_pointers = doprnt_hide_pointers;

#if defined (__x86_64__)
        plctrace_disable();
#endif
        /* panic_caller is initialized to 0.  If set, don't change it */
        if ( ! panic_caller )
                panic_caller = (unsigned long)(char *)__builtin_return_address(0);


        s = panic_prologue(str);

        /* Never hide pointers from panic logs. */
        doprnt_hide_pointers = FALSE;

        kdb_printf("panic(cpu %d caller 0x%lx): ", (unsigned) paniccpu, panic_caller);
        if (str) {
                va_start(listp, str);
                _doprnt(str, &listp, consdebug_putc, 0);
                va_end(listp);
        }
        kdb_printf("\n");

        /*
         * Release panicwait indicator so that other cpus may call Debugger().
         */
        panicwait = 0;
        Debugger("panic");

        doprnt_hide_pointers = old_doprnt_hide_pointers;

        panic_epilogue(s);
}

/*
 * panic_with_options: wraps the panic call in a way that allows us to pass
 *                      a bitmask of specific debugger options.
 */
#if !DEVELOPMENT && !DEBUG && !defined(__i386__) && !defined(__x86_64__)
__attribute__((noreturn))
#endif
void
panic_with_options(unsigned int reason, void *ctx, uint64_t debugger_options_mask, const char *str, ...)
{
        va_list listp;
        spl_t   s;


        /* panic_caller is initialized to 0.  If set, don't change it */
        if ( ! panic_caller )
                panic_caller = (unsigned long)(char *)__builtin_return_address(0);

        s = panic_prologue(str);
        kdb_printf("panic(cpu %d caller 0x%lx): ", (unsigned) paniccpu, panic_caller);
        if (str) {
                va_start(listp, str);
                _doprnt(str, &listp, consdebug_putc, 0);
                va_end(listp);
        }
        kdb_printf("\n");

        /*
         * Release panicwait indicator so that other cpus may call Debugger().
         */
        panicwait = 0;
        DebuggerWithContext(reason, ctx, "panic", debugger_options_mask);
        panic_epilogue(s);
}

#if !DEVELOPMENT && !DEBUG && !defined(__i386__) && !defined(__x86_64__)
__attribute__((noreturn))
#endif
void
panic_context(unsigned int reason, void *ctx, const char *str, ...)
{
        va_list listp;
        spl_t   s;


        /* panic_caller is initialized to 0.  If set, don't change it */
        if ( ! panic_caller )
                panic_caller = (unsigned long)(char *)__builtin_return_address(0);
        
        s = panic_prologue(str);
        kdb_printf("panic(cpu %d caller 0x%lx): ", (unsigned) paniccpu, panic_caller);
        if (str) {
                va_start(listp, str);
                _doprnt(str, &listp, consdebug_putc, 0);
                va_end(listp);
        }
        kdb_printf("\n");

        /*
         * Release panicwait indicator so that other cpus may call Debugger().
         */
        panicwait = 0;
        DebuggerWithContext(reason, ctx, "panic", DEBUGGER_OPTION_NONE);
        panic_epilogue(s);
}

__attribute__((noinline,not_tail_called))
void log(__unused int level, char *fmt, ...)
{
        void *caller = __builtin_return_address(0);
        va_list listp;
        va_list listp2;


#ifdef lint
        level++;
#endif /* lint */
#ifdef  MACH_BSD
        va_start(listp, fmt);
        va_copy(listp2, listp);

        disable_preemption();
        _doprnt(fmt, &listp, cons_putc_locked, 0);
        enable_preemption();

        va_end(listp);

        os_log_with_args(OS_LOG_DEFAULT, OS_LOG_TYPE_DEFAULT, fmt, listp2, caller);
        va_end(listp2);
#endif
}

/*
 * Skip appending log messages to the new logging infrastructure in contexts
 * where safety is uncertain. These contexts include:
 *   - When we're in the debugger
 *   - We're in a panic
 *   - Interrupts are disabled
 *   - Or Pre-emption is disabled
 * In all the above cases, it is potentially unsafe to log messages.
 */

boolean_t oslog_is_safe(void) {
        return (debug_mode == 0 &&
                not_in_kdp == 1 &&
                get_preemption_level() == 0 &&
                ml_get_interrupts_enabled() == TRUE);
}

void
debug_putc(char c)
{
        if ((debug_buf_size != 0) &&
                ((debug_buf_ptr-debug_buf_addr) < (int)debug_buf_size)) {
                *debug_buf_ptr=c;
                debug_buf_ptr++;
        }
}

/* In-place packing routines -- inefficient, but they're called at most once.
 * Assumes "buflen" is a multiple of 8.
 */

int packA(char *inbuf, uint32_t length, uint32_t buflen)
{
  unsigned int i, j = 0;
  pasc_t pack;
  
  length = MIN(((length + 7) & ~7), buflen);

  for (i = 0; i < length; i+=8)
    {
      pack.a = inbuf[i];
      pack.b = inbuf[i+1];
      pack.c = inbuf[i+2];
      pack.d = inbuf[i+3];
      pack.e = inbuf[i+4];
      pack.f = inbuf[i+5];
      pack.g = inbuf[i+6];
      pack.h = inbuf[i+7];
      bcopy ((char *) &pack, inbuf + j, 7);
      j += 7;
    }
  return j;
}

void unpackA(char *inbuf, uint32_t length)
{
        pasc_t packs;
        unsigned i = 0;
        length = (length * 8)/7;

        while (i < length) {
          packs = *(pasc_t *)&inbuf[i];
          bcopy(&inbuf[i+7], &inbuf[i+8], MAX(0, (int) (length - i - 8)));
          inbuf[i++] = packs.a;
          inbuf[i++] = packs.b;
          inbuf[i++] = packs.c;
          inbuf[i++] = packs.d;
          inbuf[i++] = packs.e;
          inbuf[i++] = packs.f;
          inbuf[i++] = packs.g;
          inbuf[i++] = packs.h;
        }
}

extern void *proc_name_address(void *p);

static void
panic_display_process_name(void) {
        /* because of scoping issues len(p_comm) from proc_t is hard coded here */
        char proc_name[17] = "Unknown";
        task_t ctask = 0;
        void *cbsd_info = 0;

        if (ml_nofault_copy((vm_offset_t)&current_thread()->task, (vm_offset_t) &ctask, sizeof(task_t)) == sizeof(task_t))
                if(ml_nofault_copy((vm_offset_t)&ctask->bsd_info, (vm_offset_t)&cbsd_info, sizeof(cbsd_info)) == sizeof(cbsd_info))
                        if (cbsd_info && (ml_nofault_copy((vm_offset_t) proc_name_address(cbsd_info), (vm_offset_t) &proc_name, sizeof(proc_name)) > 0))
                                proc_name[sizeof(proc_name) - 1] = '\0';
        kdb_printf("\nBSD process name corresponding to current thread: %s\n", proc_name);
}

unsigned        panic_active(void) {
        return ((panicstr != (char *) 0));
}

void populate_model_name(char *model_string) {
        strlcpy(model_name, model_string, sizeof(model_name));
}

void panic_display_model_name(void) {
        char tmp_model_name[sizeof(model_name)];

        if (ml_nofault_copy((vm_offset_t) &model_name, (vm_offset_t) &tmp_model_name, sizeof(model_name)) != sizeof(model_name))
                return;

        tmp_model_name[sizeof(tmp_model_name) - 1] = '\0';

        if (tmp_model_name[0] != 0)
                kdb_printf("System model name: %s\n", tmp_model_name);
}

void panic_display_kernel_uuid(void) {
        char tmp_kernel_uuid[sizeof(kernel_uuid_string)];

        if (ml_nofault_copy((vm_offset_t) &kernel_uuid_string, (vm_offset_t) &tmp_kernel_uuid, sizeof(kernel_uuid_string)) != sizeof(kernel_uuid_string))
                return;

        if (tmp_kernel_uuid[0] != '\0')
                kdb_printf("Kernel UUID: %s\n", tmp_kernel_uuid);
}

void panic_display_kernel_aslr(void) {
        if (vm_kernel_slide) {
                kdb_printf("Kernel slide:     0x%016lx\n", (unsigned long) vm_kernel_slide);
                kdb_printf("Kernel text base: %p\n", (void *) vm_kernel_stext);
        }
}

void panic_display_hibb(void) {
#if defined(__i386__) || defined (__x86_64__)
        kdb_printf("__HIB  text base: %p\n", (void *) vm_hib_base);
#endif
}

static void panic_display_uptime(void) {
        uint64_t        uptime;
        absolutetime_to_nanoseconds(mach_absolute_time(), &uptime);

        kdb_printf("\nSystem uptime in nanoseconds: %llu\n", uptime);
}

extern const char version[];
extern char osversion[];

static volatile uint32_t config_displayed = 0;

__private_extern__ void panic_display_system_configuration(void) {

        panic_display_process_name();
        if (OSCompareAndSwap(0, 1, &config_displayed)) {
                char buf[256];
                if (strlcpy(buf, PE_boot_args(), sizeof(buf)))
                        kdb_printf("Boot args: %s\n", buf);
                kdb_printf("\nMac OS version:\n%s\n",
                    (osversion[0] != 0) ? osversion : "Not yet set");
                kdb_printf("\nKernel version:\n%s\n",version);
                panic_display_kernel_uuid();
                panic_display_kernel_aslr();
                panic_display_hibb();
                panic_display_pal_info();
                panic_display_model_name();
                panic_display_uptime();
                panic_display_zprint();
#if CONFIG_ZLEAKS
                panic_display_ztrace();
#endif /* CONFIG_ZLEAKS */
                kext_dump_panic_lists(&kdb_log);
        }
}

extern unsigned int     stack_total;
extern unsigned long long stack_allocs;

#if defined(__i386__) || defined (__x86_64__)
extern unsigned int     inuse_ptepages_count;
extern long long alloc_ptepages_count;
#endif

extern boolean_t        panic_include_zprint;
extern vm_offset_t      panic_kext_memory_info;
extern vm_size_t        panic_kext_memory_size;

__private_extern__ void panic_display_zprint()
{
        if(panic_include_zprint == TRUE) {

                unsigned int    i;
                struct zone     zone_copy;

                kdb_printf("%-20s %10s %10s\n", "Zone Name", "Cur Size", "Free Size");
                for (i = 0; i < num_zones; i++) {
                        if(ml_nofault_copy((vm_offset_t)(&zone_array[i]), (vm_offset_t)&zone_copy, sizeof(struct zone)) == sizeof(struct zone)) {
                                if(zone_copy.cur_size > (1024*1024)) {
                                        kdb_printf("%-20s %10lu %10lu\n",zone_copy.zone_name, (uintptr_t)zone_copy.cur_size,(uintptr_t)(zone_copy.countfree * zone_copy.elem_size));
                                }
                        }               
                }

                kdb_printf("%-20s %10lu\n", "Kernel Stacks", (uintptr_t)(kernel_stack_size * stack_total));

#if defined(__i386__) || defined (__x86_64__)
                kdb_printf("%-20s %10lu\n", "PageTables",(uintptr_t)(PAGE_SIZE * inuse_ptepages_count));
#endif

                kdb_printf("%-20s %10lu\n", "Kalloc.Large", (uintptr_t)kalloc_large_total);
                if (panic_kext_memory_info) {
                        mach_memory_info_t *mem_info = (mach_memory_info_t *)panic_kext_memory_info;
                        kdb_printf("\n%-5s %10s\n", "Kmod", "Size");
                        for (i = 0; i < VM_KERN_MEMORY_COUNT + VM_KERN_COUNTER_COUNT; i++) {
                                if (((mem_info[i].flags & VM_KERN_SITE_TYPE) == VM_KERN_SITE_KMOD) && (mem_info[i].size > (1024 * 1024))) {
                                        kdb_printf("%-5lld %10lld\n", mem_info[i].site, mem_info[i].size);
                                }
                        }
                }
        }
}

#if CONFIG_ECC_LOGGING
__private_extern__ void panic_display_ecc_errors() 
{
        uint32_t count = ecc_log_get_correction_count();

        if (count > 0) {
                kdb_printf("ECC Corrections:%u\n", count);
        }
}
#endif /* CONFIG_ECC_LOGGING */

#if CONFIG_ZLEAKS
extern boolean_t        panic_include_ztrace;
extern struct ztrace* top_ztrace;
void panic_print_symbol_name(vm_address_t search);

/*
 * Prints the backtrace most suspected of being a leaker, if we paniced in the zone allocator.
 * top_ztrace and panic_include_ztrace comes from osfmk/kern/zalloc.c
 */
__private_extern__ void panic_display_ztrace(void)
{
        if(panic_include_ztrace == TRUE) {
                unsigned int i = 0;
                boolean_t keepsyms = FALSE;

                PE_parse_boot_argn("keepsyms", &keepsyms, sizeof (keepsyms));
                struct ztrace top_ztrace_copy;
                
                /* Make sure not to trip another panic if there's something wrong with memory */
                if(ml_nofault_copy((vm_offset_t)top_ztrace, (vm_offset_t)&top_ztrace_copy, sizeof(struct ztrace)) == sizeof(struct ztrace)) {
                        kdb_printf("\nBacktrace suspected of leaking: (outstanding bytes: %lu)\n", (uintptr_t)top_ztrace_copy.zt_size);
                        /* Print the backtrace addresses */
                        for (i = 0; (i < top_ztrace_copy.zt_depth && i < MAX_ZTRACE_DEPTH) ; i++) {
                                kdb_printf("%p ", top_ztrace_copy.zt_stack[i]);
                                if (keepsyms) {
                                        panic_print_symbol_name((vm_address_t)top_ztrace_copy.zt_stack[i]);
                                }
                                kdb_printf("\n");
                        }
                        /* Print any kexts in that backtrace, along with their link addresses so we can properly blame them */
                        kmod_panic_dump((vm_offset_t *)&top_ztrace_copy.zt_stack[0], top_ztrace_copy.zt_depth);
                }
                else {
                        kdb_printf("\nCan't access top_ztrace...\n");
                }
                kdb_printf("\n");
        }
}
#endif /* CONFIG_ZLEAKS */

#if ! (MACH_KDP && CONFIG_KDP_INTERACTIVE_DEBUGGING)
static struct kdp_ether_addr kdp_current_mac_address = {{0, 0, 0, 0, 0, 0}};

/* XXX ugly forward declares to stop warnings */
void *kdp_get_interface(void);
void kdp_set_ip_and_mac_addresses(struct kdp_in_addr *, struct kdp_ether_addr *);
void kdp_set_gateway_mac(void *);
void kdp_set_interface(void *);
void kdp_register_send_receive(void *, void *);
void kdp_unregister_send_receive(void *, void *);

int kdp_stack_snapshot_geterror(void);
uint32_t kdp_stack_snapshot_bytes_traced(void);

void *
kdp_get_interface( void)
{
        return(void *)0;
}

unsigned int
kdp_get_ip_address(void )
{ return 0; }

struct kdp_ether_addr
kdp_get_mac_addr(void)
{       
        return kdp_current_mac_address;
}

void
kdp_set_ip_and_mac_addresses(   
        __unused struct kdp_in_addr          *ipaddr,
        __unused struct kdp_ether_addr       *macaddr)
{}

void
kdp_set_gateway_mac(__unused void *gatewaymac)
{}

void
kdp_set_interface(__unused void *ifp)
{}

void
kdp_register_send_receive(__unused void *send, __unused void *receive)
{}

void
kdp_unregister_send_receive(__unused void *send, __unused void *receive)
{}

void kdp_register_link(__unused kdp_link_t link, __unused kdp_mode_t mode)
{}

void kdp_unregister_link(__unused kdp_link_t link, __unused kdp_mode_t mode)
{}

#endif

#if !CONFIG_TELEMETRY
int telemetry_gather(user_addr_t buffer __unused, uint32_t *length __unused, boolean_t mark __unused)
{
        return KERN_NOT_SUPPORTED;
}
#endif