[mirror_qemu.git] / dump / win_dump.c

/*
 * Windows crashdump (target specific implementations)
 *
 * Copyright (c) 2018 Virtuozzo International GmbH
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 *
 */

#include "qemu/osdep.h"
#include "sysemu/dump.h"
#include "qapi/error.h"
#include "qapi/qmp/qerror.h"
#include "exec/cpu-defs.h"
#include "hw/core/cpu.h"
#include "qemu/win_dump_defs.h"
#include "win_dump.h"
#include "cpu.h"

#if defined(TARGET_X86_64)

bool win_dump_available(Error **errp)
{
    return true;
}

static size_t win_dump_ptr_size(bool x64)
{
    return x64 ? sizeof(uint64_t) : sizeof(uint32_t);
}

#define _WIN_DUMP_FIELD(f) (x64 ? h->x64.f : h->x32.f)
#define WIN_DUMP_FIELD(field) _WIN_DUMP_FIELD(field)

#define _WIN_DUMP_FIELD_PTR(f) (x64 ? (void *)&h->x64.f : (void *)&h->x32.f)
#define WIN_DUMP_FIELD_PTR(field) _WIN_DUMP_FIELD_PTR(field)

#define _WIN_DUMP_FIELD_SIZE(f) (x64 ? sizeof(h->x64.f) : sizeof(h->x32.f))
#define WIN_DUMP_FIELD_SIZE(field) _WIN_DUMP_FIELD_SIZE(field)

static size_t win_dump_ctx_size(bool x64)
{
    return x64 ? sizeof(WinContext64) : sizeof(WinContext32);
}

static size_t write_run(uint64_t base_page, uint64_t page_count,
        int fd, Error **errp)
{
    void *buf;
    uint64_t addr = base_page << TARGET_PAGE_BITS;
    uint64_t size = page_count << TARGET_PAGE_BITS;
    uint64_t len, l;
    size_t total = 0;

    while (size) {
        len = size;

        buf = cpu_physical_memory_map(addr, &len, false);
        if (!buf) {
            error_setg(errp, "win-dump: failed to map physical range"
                             " 0x%016" PRIx64 "-0x%016" PRIx64, addr, addr + size - 1);
            return 0;
        }

        l = qemu_write_full(fd, buf, len);
        cpu_physical_memory_unmap(buf, addr, false, len);
        if (l != len) {
            error_setg(errp, QERR_IO_ERROR);
            return 0;
        }

        addr += l;
        size -= l;
        total += l;
    }

    return total;
}

static void write_runs(DumpState *s, WinDumpHeader *h, bool x64, Error **errp)
{
    uint64_t BasePage, PageCount;
    Error *local_err = NULL;
    int i;

    for (i = 0; i < WIN_DUMP_FIELD(PhysicalMemoryBlock.NumberOfRuns); i++) {
        BasePage = WIN_DUMP_FIELD(PhysicalMemoryBlock.Run[i].BasePage);
        PageCount = WIN_DUMP_FIELD(PhysicalMemoryBlock.Run[i].PageCount);
        s->written_size += write_run(BasePage, PageCount, s->fd, &local_err);
        if (local_err) {
            error_propagate(errp, local_err);
            return;
        }
    }
}

static int cpu_read_ptr(bool x64, CPUState *cpu, uint64_t addr, uint64_t *ptr)
{
    int ret;
    uint32_t ptr32;
    uint64_t ptr64;

    ret = cpu_memory_rw_debug(cpu, addr, x64 ? (void *)&ptr64 : (void *)&ptr32,
            win_dump_ptr_size(x64), 0);

    *ptr = x64 ? ptr64 : ptr32;

    return ret;
}

static void patch_mm_pfn_database(WinDumpHeader *h, bool x64, Error **errp)
{
    if (cpu_memory_rw_debug(first_cpu,
            WIN_DUMP_FIELD(KdDebuggerDataBlock) + KDBG_MM_PFN_DATABASE_OFFSET,
            WIN_DUMP_FIELD_PTR(PfnDatabase),
            WIN_DUMP_FIELD_SIZE(PfnDatabase), 0)) {
        error_setg(errp, "win-dump: failed to read MmPfnDatabase");
        return;
    }
}

static void patch_bugcheck_data(WinDumpHeader *h, bool x64, Error **errp)
{
    uint64_t KiBugcheckData;

    if (cpu_read_ptr(x64, first_cpu,
            WIN_DUMP_FIELD(KdDebuggerDataBlock) + KDBG_KI_BUGCHECK_DATA_OFFSET,
            &KiBugcheckData)) {
        error_setg(errp, "win-dump: failed to read KiBugcheckData");
        return;
    }

    if (cpu_memory_rw_debug(first_cpu, KiBugcheckData,
            WIN_DUMP_FIELD(BugcheckData),
            WIN_DUMP_FIELD_SIZE(BugcheckData), 0)) {
        error_setg(errp, "win-dump: failed to read bugcheck data");
        return;
    }

    /*
     * If BugcheckCode wasn't saved, we consider guest OS as alive.
     */

    if (!WIN_DUMP_FIELD(BugcheckCode)) {
        *(uint32_t *)WIN_DUMP_FIELD_PTR(BugcheckCode) = LIVE_SYSTEM_DUMP;
    }
}

/*
 * This routine tries to correct mistakes in crashdump header.
 */
static void patch_header(WinDumpHeader *h, bool x64)
{
    Error *local_err = NULL;

    if (x64) {
        h->x64.RequiredDumpSpace = sizeof(WinDumpHeader64) +
            (h->x64.PhysicalMemoryBlock.NumberOfPages << TARGET_PAGE_BITS);
        h->x64.PhysicalMemoryBlock.unused = 0;
        h->x64.unused1 = 0;
    } else {
        h->x32.RequiredDumpSpace = sizeof(WinDumpHeader32) +
            (h->x32.PhysicalMemoryBlock.NumberOfPages << TARGET_PAGE_BITS);
    }

    patch_mm_pfn_database(h, x64, &local_err);
    if (local_err) {
        warn_report_err(local_err);
        local_err = NULL;
    }
    patch_bugcheck_data(h, x64, &local_err);
    if (local_err) {
        warn_report_err(local_err);
    }
}

static bool check_header(WinDumpHeader *h, bool *x64, Error **errp)
{
    const char Signature[] = "PAGE";

    if (memcmp(h->Signature, Signature, sizeof(h->Signature))) {
        error_setg(errp, "win-dump: invalid header, expected '%.4s',"
                         " got '%.4s'", Signature, h->Signature);
        return false;
    }

    if (!memcmp(h->ValidDump, "DUMP", sizeof(h->ValidDump))) {
        *x64 = false;
    } else if (!memcmp(h->ValidDump, "DU64", sizeof(h->ValidDump))) {
        *x64 = true;
    } else {
        error_setg(errp, "win-dump: invalid header, expected 'DUMP' or 'DU64',"
                   " got '%.4s'", h->ValidDump);
        return false;
    }

    return true;
}

static void check_kdbg(WinDumpHeader *h, bool x64, Error **errp)
{
    const char OwnerTag[] = "KDBG";
    char read_OwnerTag[4];
    uint64_t KdDebuggerDataBlock = WIN_DUMP_FIELD(KdDebuggerDataBlock);
    bool try_fallback = true;

try_again:
    if (cpu_memory_rw_debug(first_cpu,
            KdDebuggerDataBlock + KDBG_OWNER_TAG_OFFSET,
            (uint8_t *)&read_OwnerTag, sizeof(read_OwnerTag), 0)) {
        error_setg(errp, "win-dump: failed to read OwnerTag");
        return;
    }

    if (memcmp(read_OwnerTag, OwnerTag, sizeof(read_OwnerTag))) {
        if (try_fallback) {
            /*
             * If attempt to use original KDBG failed
             * (most likely because of its encryption),
             * we try to use KDBG obtained by guest driver.
             */

            KdDebuggerDataBlock = WIN_DUMP_FIELD(BugcheckParameter1);
            try_fallback = false;
            goto try_again;
        } else {
            error_setg(errp, "win-dump: invalid KDBG OwnerTag,"
                             " expected '%.4s', got '%.4s'",
                             OwnerTag, read_OwnerTag);
            return;
        }
    }

    if (x64) {
        h->x64.KdDebuggerDataBlock = KdDebuggerDataBlock;
    } else {
        h->x32.KdDebuggerDataBlock = KdDebuggerDataBlock;
    }
}

struct saved_context {
    WinContext ctx;
    uint64_t addr;
};

static void patch_and_save_context(WinDumpHeader *h, bool x64,
                                   struct saved_context *saved_ctx,
                                   Error **errp)
{
    uint64_t KdDebuggerDataBlock = WIN_DUMP_FIELD(KdDebuggerDataBlock);
    uint64_t KiProcessorBlock;
    uint16_t OffsetPrcbContext;
    CPUState *cpu;
    int i = 0;

    if (cpu_read_ptr(x64, first_cpu,
            KdDebuggerDataBlock + KDBG_KI_PROCESSOR_BLOCK_OFFSET,
            &KiProcessorBlock)) {
        error_setg(errp, "win-dump: failed to read KiProcessorBlock");
        return;
    }

    if (cpu_memory_rw_debug(first_cpu,
            KdDebuggerDataBlock + KDBG_OFFSET_PRCB_CONTEXT_OFFSET,
            (uint8_t *)&OffsetPrcbContext, sizeof(OffsetPrcbContext), 0)) {
        error_setg(errp, "win-dump: failed to read OffsetPrcbContext");
        return;
    }

    CPU_FOREACH(cpu) {
        X86CPU *x86_cpu = X86_CPU(cpu);
        CPUX86State *env = &x86_cpu->env;
        uint64_t Prcb;
        uint64_t Context;
        WinContext ctx;

        if (i >= WIN_DUMP_FIELD(NumberProcessors)) {
            warn_report("win-dump: number of QEMU CPUs is bigger than"
                        " NumberProcessors (%u) in guest Windows",
                        WIN_DUMP_FIELD(NumberProcessors));
            return;
        }

        if (cpu_read_ptr(x64, first_cpu,
                KiProcessorBlock + i * win_dump_ptr_size(x64),
                &Prcb)) {
            error_setg(errp, "win-dump: failed to read"
                             " CPU #%d PRCB location", i);
            return;
        }

        if (cpu_read_ptr(x64, first_cpu,
                Prcb + OffsetPrcbContext,
                &Context)) {
            error_setg(errp, "win-dump: failed to read"
                             " CPU #%d ContextFrame location", i);
            return;
        }

        saved_ctx[i].addr = Context;

        if (x64) {
            ctx.x64 = (WinContext64){
                .ContextFlags = WIN_CTX64_ALL,
                .MxCsr = env->mxcsr,

                .SegEs = env->segs[0].selector,
                .SegCs = env->segs[1].selector,
                .SegSs = env->segs[2].selector,
                .SegDs = env->segs[3].selector,
                .SegFs = env->segs[4].selector,
                .SegGs = env->segs[5].selector,
                .EFlags = cpu_compute_eflags(env),

                .Dr0 = env->dr[0],
                .Dr1 = env->dr[1],
                .Dr2 = env->dr[2],
                .Dr3 = env->dr[3],
                .Dr6 = env->dr[6],
                .Dr7 = env->dr[7],

                .Rax = env->regs[R_EAX],
                .Rbx = env->regs[R_EBX],
                .Rcx = env->regs[R_ECX],
                .Rdx = env->regs[R_EDX],
                .Rsp = env->regs[R_ESP],
                .Rbp = env->regs[R_EBP],
                .Rsi = env->regs[R_ESI],
                .Rdi = env->regs[R_EDI],
                .R8  = env->regs[8],
                .R9  = env->regs[9],
                .R10 = env->regs[10],
                .R11 = env->regs[11],
                .R12 = env->regs[12],
                .R13 = env->regs[13],
                .R14 = env->regs[14],
                .R15 = env->regs[15],

                .Rip = env->eip,
                .FltSave = {
                    .MxCsr = env->mxcsr,
                },
            };
        } else {
            ctx.x32 = (WinContext32){
                .ContextFlags = WIN_CTX32_FULL | WIN_CTX_DBG,

                .SegEs = env->segs[0].selector,
                .SegCs = env->segs[1].selector,
                .SegSs = env->segs[2].selector,
                .SegDs = env->segs[3].selector,
                .SegFs = env->segs[4].selector,
                .SegGs = env->segs[5].selector,
                .EFlags = cpu_compute_eflags(env),

                .Dr0 = env->dr[0],
                .Dr1 = env->dr[1],
                .Dr2 = env->dr[2],
                .Dr3 = env->dr[3],
                .Dr6 = env->dr[6],
                .Dr7 = env->dr[7],

                .Eax = env->regs[R_EAX],
                .Ebx = env->regs[R_EBX],
                .Ecx = env->regs[R_ECX],
                .Edx = env->regs[R_EDX],
                .Esp = env->regs[R_ESP],
                .Ebp = env->regs[R_EBP],
                .Esi = env->regs[R_ESI],
                .Edi = env->regs[R_EDI],

                .Eip = env->eip,
            };
        }

        if (cpu_memory_rw_debug(first_cpu, Context,
                &saved_ctx[i].ctx, win_dump_ctx_size(x64), 0)) {
            error_setg(errp, "win-dump: failed to save CPU #%d context", i);
            return;
        }

        if (cpu_memory_rw_debug(first_cpu, Context,
                &ctx, win_dump_ctx_size(x64), 1)) {
            error_setg(errp, "win-dump: failed to write CPU #%d context", i);
            return;
        }

        i++;
    }
}

static void restore_context(WinDumpHeader *h, bool x64,
                            struct saved_context *saved_ctx)
{
    int i;

    for (i = 0; i < WIN_DUMP_FIELD(NumberProcessors); i++) {
        if (cpu_memory_rw_debug(first_cpu, saved_ctx[i].addr,
                &saved_ctx[i].ctx, win_dump_ctx_size(x64), 1)) {
            warn_report("win-dump: failed to restore CPU #%d context", i);
        }
    }
}

void create_win_dump(DumpState *s, Error **errp)
{
    WinDumpHeader *h = (void *)(s->guest_note + VMCOREINFO_ELF_NOTE_HDR_SIZE);
    X86CPU *first_x86_cpu = X86_CPU(first_cpu);
    uint64_t saved_cr3 = first_x86_cpu->env.cr[3];
    struct saved_context *saved_ctx = NULL;
    Error *local_err = NULL;
    bool x64 = true;
    size_t hdr_size;

    if (s->guest_note_size != VMCOREINFO_WIN_DUMP_NOTE_SIZE32 &&
            s->guest_note_size != VMCOREINFO_WIN_DUMP_NOTE_SIZE64) {
        error_setg(errp, "win-dump: invalid vmcoreinfo note size");
        return;
    }

    if (!check_header(h, &x64, &local_err)) {
        error_propagate(errp, local_err);
        return;
    }

    hdr_size = x64 ? sizeof(WinDumpHeader64) : sizeof(WinDumpHeader32);

    /*
     * Further access to kernel structures by virtual addresses
     * should be made from system context.
     */

    first_x86_cpu->env.cr[3] = WIN_DUMP_FIELD(DirectoryTableBase);

    check_kdbg(h, x64, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        goto out_cr3;
    }

    patch_header(h, x64);

    saved_ctx = g_new(struct saved_context, WIN_DUMP_FIELD(NumberProcessors));

    /*
     * Always patch context because there is no way
     * to determine if the system-saved context is valid
     */

    patch_and_save_context(h, x64, saved_ctx, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        goto out_free;
    }

    s->total_size = WIN_DUMP_FIELD(RequiredDumpSpace);

    s->written_size = qemu_write_full(s->fd, h, hdr_size);
    if (s->written_size != hdr_size) {
        error_setg(errp, QERR_IO_ERROR);
        goto out_restore;
    }

    write_runs(s, h, x64, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        goto out_restore;
    }

out_restore:
    restore_context(h, x64, saved_ctx);
out_free:
    g_free(saved_ctx);
out_cr3:
    first_x86_cpu->env.cr[3] = saved_cr3;

    return;
}

#else /* !TARGET_X86_64 */

bool win_dump_available(Error **errp)
{
    error_setg(errp, "Windows dump is only available for x86-64");

    return false;
}

void create_win_dump(DumpState *s, Error **errp)
{
    win_dump_available(errp);
}

#endif
Commit	Line	Data
2da91b54	1	/*
ac978771	2	* Windows crashdump (target specific implementations)
2da91b54 VP	3	*
	4	* Copyright (c) 2018 Virtuozzo International GmbH
	5	*
	6	* This work is licensed under the terms of the GNU GPL, version 2 or later.
	7	* See the COPYING file in the top-level directory.
	8	*
	9	*/
	10
	11	#include "qemu/osdep.h"
2da91b54	12	#include "sysemu/dump.h"
2da91b54 VP	13	#include "qapi/error.h"
2da91b54 VP	14	#include "qapi/qmp/qerror.h"
ac978771 PMD	15	#include "exec/cpu-defs.h"
	16	#include "hw/core/cpu.h"
	17	#include "qemu/win_dump_defs.h"
2da91b54	18	#include "win_dump.h"
ac978771	19	#include "cpu.h"
2da91b54	20
efc3146a PMD	21	#if defined(TARGET_X86_64)
	22
	23	bool win_dump_available(Error **errp)
	24	{
	25	return true;
	26	}
	27
f5daa829 VP	28	static size_t win_dump_ptr_size(bool x64)
	29	{
	30	return x64 ? sizeof(uint64_t) : sizeof(uint32_t);
	31	}
fb21efe9	32
f5daa829	33	#define _WIN_DUMP_FIELD(f) (x64 ? h->x64.f : h->x32.f)
fb21efe9 VP	34	#define WIN_DUMP_FIELD(field) _WIN_DUMP_FIELD(field)
fb21efe9 VP	35
f5daa829	36	#define _WIN_DUMP_FIELD_PTR(f) (x64 ? (void )&h->x64.f : (void )&h->x32.f)
fb21efe9 VP	37	#define WIN_DUMP_FIELD_PTR(field) _WIN_DUMP_FIELD_PTR(field)
fb21efe9 VP	38
f5daa829	39	#define _WIN_DUMP_FIELD_SIZE(f) (x64 ? sizeof(h->x64.f) : sizeof(h->x32.f))
fb21efe9 VP	40	#define WIN_DUMP_FIELD_SIZE(field) _WIN_DUMP_FIELD_SIZE(field)
fb21efe9 VP	41
f5daa829 VP	42	static size_t win_dump_ctx_size(bool x64)
	43	{
	44	return x64 ? sizeof(WinContext64) : sizeof(WinContext32);
	45	}
fb21efe9 VP	46
	47	static size_t write_run(uint64_t base_page, uint64_t page_count,
	48	int fd, Error **errp)
2da91b54 VP	49	{
2da91b54 VP	50	void *buf;
fb21efe9 VP	51	uint64_t addr = base_page << TARGET_PAGE_BITS;
fb21efe9 VP	52	uint64_t size = page_count << TARGET_PAGE_BITS;
7184de64 VP	53	uint64_t len, l;
7184de64 VP	54	size_t total = 0;
2da91b54	55
7184de64 VP	56	while (size) {
7184de64 VP	57	len = size;
2da91b54	58
7184de64 VP	59	buf = cpu_physical_memory_map(addr, &len, false);
	60	if (!buf) {
	61	error_setg(errp, "win-dump: failed to map physical range"
	62	" 0x%016" PRIx64 "-0x%016" PRIx64, addr, addr + size - 1);
	63	return 0;
	64	}
2da91b54	65
7184de64 VP	66	l = qemu_write_full(fd, buf, len);
	67	cpu_physical_memory_unmap(buf, addr, false, len);
	68	if (l != len) {
	69	error_setg(errp, QERR_IO_ERROR);
	70	return 0;
	71	}
	72
	73	addr += l;
	74	size -= l;
	75	total += l;
	76	}
2da91b54	77
7184de64	78	return total;
2da91b54 VP	79	}
2da91b54 VP	80
f5daa829	81	static void write_runs(DumpState s, WinDumpHeader h, bool x64, Error **errp)
2da91b54	82	{
fb21efe9	83	uint64_t BasePage, PageCount;
2da91b54 VP	84	Error *local_err = NULL;
	85	int i;
	86
fb21efe9 VP	87	for (i = 0; i < WIN_DUMP_FIELD(PhysicalMemoryBlock.NumberOfRuns); i++) {
	88	BasePage = WIN_DUMP_FIELD(PhysicalMemoryBlock.Run[i].BasePage);
	89	PageCount = WIN_DUMP_FIELD(PhysicalMemoryBlock.Run[i].PageCount);
	90	s->written_size += write_run(BasePage, PageCount, s->fd, &local_err);
2da91b54 VP	91	if (local_err) {
	92	error_propagate(errp, local_err);
	93	return;
	94	}
	95	}
	96	}
	97
f5daa829	98	static int cpu_read_ptr(bool x64, CPUState cpu, uint64_t addr, uint64_t ptr)
fb21efe9 VP	99	{
fb21efe9 VP	100	int ret;
f5daa829	101	uint32_t ptr32;
fb21efe9 VP	102	uint64_t ptr64;
fb21efe9 VP	103
f5daa829 VP	104	ret = cpu_memory_rw_debug(cpu, addr, x64 ? (void )&ptr64 : (void )&ptr32,
f5daa829 VP	105	win_dump_ptr_size(x64), 0);
fb21efe9	106
f5daa829	107	*ptr = x64 ? ptr64 : ptr32;
fb21efe9 VP	108
	109	return ret;
	110	}
	111
f5daa829	112	static void patch_mm_pfn_database(WinDumpHeader h, bool x64, Error *errp)
2da91b54 VP	113	{
2da91b54 VP	114	if (cpu_memory_rw_debug(first_cpu,
f5daa829	115	WIN_DUMP_FIELD(KdDebuggerDataBlock) + KDBG_MM_PFN_DATABASE_OFFSET,
fb21efe9 VP	116	WIN_DUMP_FIELD_PTR(PfnDatabase),
fb21efe9 VP	117	WIN_DUMP_FIELD_SIZE(PfnDatabase), 0)) {
2da91b54 VP	118	error_setg(errp, "win-dump: failed to read MmPfnDatabase");
	119	return;
	120	}
	121	}
	122
f5daa829	123	static void patch_bugcheck_data(WinDumpHeader h, bool x64, Error *errp)
2da91b54 VP	124	{
	125	uint64_t KiBugcheckData;
	126
f5daa829 VP	127	if (cpu_read_ptr(x64, first_cpu,
f5daa829 VP	128	WIN_DUMP_FIELD(KdDebuggerDataBlock) + KDBG_KI_BUGCHECK_DATA_OFFSET,
fb21efe9	129	&KiBugcheckData)) {
2da91b54 VP	130	error_setg(errp, "win-dump: failed to read KiBugcheckData");
	131	return;
	132	}
	133
fb21efe9 VP	134	if (cpu_memory_rw_debug(first_cpu, KiBugcheckData,
	135	WIN_DUMP_FIELD(BugcheckData),
	136	WIN_DUMP_FIELD_SIZE(BugcheckData), 0)) {
2da91b54 VP	137	error_setg(errp, "win-dump: failed to read bugcheck data");
	138	return;
	139	}
2ad9b50f VP	140
	141	/*
	142	* If BugcheckCode wasn't saved, we consider guest OS as alive.
	143	*/
	144
fb21efe9 VP	145	if (!WIN_DUMP_FIELD(BugcheckCode)) {
fb21efe9 VP	146	(uint32_t )WIN_DUMP_FIELD_PTR(BugcheckCode) = LIVE_SYSTEM_DUMP;
2ad9b50f	147	}
2da91b54 VP	148	}
	149
	150	/*
	151	* This routine tries to correct mistakes in crashdump header.
	152	*/
f5daa829	153	static void patch_header(WinDumpHeader *h, bool x64)
2da91b54 VP	154	{
	155	Error *local_err = NULL;
	156
f5daa829 VP	157	if (x64) {
	158	h->x64.RequiredDumpSpace = sizeof(WinDumpHeader64) +
	159	(h->x64.PhysicalMemoryBlock.NumberOfPages << TARGET_PAGE_BITS);
	160	h->x64.PhysicalMemoryBlock.unused = 0;
	161	h->x64.unused1 = 0;
	162	} else {
	163	h->x32.RequiredDumpSpace = sizeof(WinDumpHeader32) +
	164	(h->x32.PhysicalMemoryBlock.NumberOfPages << TARGET_PAGE_BITS);
	165	}
2da91b54	166
f5daa829	167	patch_mm_pfn_database(h, x64, &local_err);
2da91b54 VP	168	if (local_err) {
	169	warn_report_err(local_err);
	170	local_err = NULL;
	171	}
f5daa829	172	patch_bugcheck_data(h, x64, &local_err);
2da91b54 VP	173	if (local_err) {
	174	warn_report_err(local_err);
	175	}
	176	}
	177
f5daa829	178	static bool check_header(WinDumpHeader h, bool x64, Error **errp)
2da91b54 VP	179	{
2da91b54 VP	180	const char Signature[] = "PAGE";
2da91b54 VP	181
	182	if (memcmp(h->Signature, Signature, sizeof(h->Signature))) {
	183	error_setg(errp, "win-dump: invalid header, expected '%.4s',"
	184	" got '%.4s'", Signature, h->Signature);
f5daa829	185	return false;
2da91b54 VP	186	}
2da91b54 VP	187
f5daa829 VP	188	if (!memcmp(h->ValidDump, "DUMP", sizeof(h->ValidDump))) {
	189	*x64 = false;
	190	} else if (!memcmp(h->ValidDump, "DU64", sizeof(h->ValidDump))) {
	191	*x64 = true;
	192	} else {
	193	error_setg(errp, "win-dump: invalid header, expected 'DUMP' or 'DU64',"
	194	" got '%.4s'", h->ValidDump);
	195	return false;
2da91b54	196	}
f5daa829 VP	197
f5daa829 VP	198	return true;
2da91b54 VP	199	}
2da91b54 VP	200
f5daa829	201	static void check_kdbg(WinDumpHeader h, bool x64, Error *errp)
2da91b54 VP	202	{
	203	const char OwnerTag[] = "KDBG";
	204	char read_OwnerTag[4];
fb21efe9	205	uint64_t KdDebuggerDataBlock = WIN_DUMP_FIELD(KdDebuggerDataBlock);
2ababfcc	206	bool try_fallback = true;
2da91b54	207
2ababfcc	208	try_again:
2da91b54	209	if (cpu_memory_rw_debug(first_cpu,
f5daa829	210	KdDebuggerDataBlock + KDBG_OWNER_TAG_OFFSET,
2da91b54 VP	211	(uint8_t *)&read_OwnerTag, sizeof(read_OwnerTag), 0)) {
	212	error_setg(errp, "win-dump: failed to read OwnerTag");
	213	return;
	214	}
	215
	216	if (memcmp(read_OwnerTag, OwnerTag, sizeof(read_OwnerTag))) {
2ababfcc VP	217	if (try_fallback) {
	218	/*
	219	* If attempt to use original KDBG failed
	220	* (most likely because of its encryption),
	221	* we try to use KDBG obtained by guest driver.
	222	*/
	223
fb21efe9	224	KdDebuggerDataBlock = WIN_DUMP_FIELD(BugcheckParameter1);
2ababfcc VP	225	try_fallback = false;
	226	goto try_again;
	227	} else {
	228	error_setg(errp, "win-dump: invalid KDBG OwnerTag,"
	229	" expected '%.4s', got '%.4s'",
	230	OwnerTag, read_OwnerTag);
	231	return;
	232	}
2da91b54	233	}
2ababfcc	234
f5daa829 VP	235	if (x64) {
	236	h->x64.KdDebuggerDataBlock = KdDebuggerDataBlock;
	237	} else {
	238	h->x32.KdDebuggerDataBlock = KdDebuggerDataBlock;
	239	}
2da91b54 VP	240	}
2da91b54 VP	241
2ad9b50f	242	struct saved_context {
f5daa829	243	WinContext ctx;
2ad9b50f VP	244	uint64_t addr;
	245	};
	246
f5daa829	247	static void patch_and_save_context(WinDumpHeader *h, bool x64,
2ad9b50f VP	248	struct saved_context *saved_ctx,
	249	Error **errp)
	250	{
fb21efe9	251	uint64_t KdDebuggerDataBlock = WIN_DUMP_FIELD(KdDebuggerDataBlock);
2ad9b50f VP	252	uint64_t KiProcessorBlock;
	253	uint16_t OffsetPrcbContext;
	254	CPUState *cpu;
	255	int i = 0;
	256
f5daa829 VP	257	if (cpu_read_ptr(x64, first_cpu,
f5daa829 VP	258	KdDebuggerDataBlock + KDBG_KI_PROCESSOR_BLOCK_OFFSET,
fb21efe9	259	&KiProcessorBlock)) {
2ad9b50f VP	260	error_setg(errp, "win-dump: failed to read KiProcessorBlock");
	261	return;
	262	}
	263
	264	if (cpu_memory_rw_debug(first_cpu,
f5daa829	265	KdDebuggerDataBlock + KDBG_OFFSET_PRCB_CONTEXT_OFFSET,
2ad9b50f VP	266	(uint8_t *)&OffsetPrcbContext, sizeof(OffsetPrcbContext), 0)) {
	267	error_setg(errp, "win-dump: failed to read OffsetPrcbContext");
	268	return;
	269	}
	270
	271	CPU_FOREACH(cpu) {
	272	X86CPU *x86_cpu = X86_CPU(cpu);
	273	CPUX86State *env = &x86_cpu->env;
	274	uint64_t Prcb;
	275	uint64_t Context;
f5daa829	276	WinContext ctx;
2ad9b50f	277
e38c24cb VP	278	if (i >= WIN_DUMP_FIELD(NumberProcessors)) {
	279	warn_report("win-dump: number of QEMU CPUs is bigger than"
	280	" NumberProcessors (%u) in guest Windows",
	281	WIN_DUMP_FIELD(NumberProcessors));
	282	return;
	283	}
	284
f5daa829 VP	285	if (cpu_read_ptr(x64, first_cpu,
f5daa829 VP	286	KiProcessorBlock + i * win_dump_ptr_size(x64),
fb21efe9	287	&Prcb)) {
2ad9b50f VP	288	error_setg(errp, "win-dump: failed to read"
	289	" CPU #%d PRCB location", i);
	290	return;
	291	}
	292
f5daa829	293	if (cpu_read_ptr(x64, first_cpu,
2ad9b50f	294	Prcb + OffsetPrcbContext,
fb21efe9	295	&Context)) {
2ad9b50f VP	296	error_setg(errp, "win-dump: failed to read"
	297	" CPU #%d ContextFrame location", i);
	298	return;
	299	}
	300
	301	saved_ctx[i].addr = Context;
	302
f5daa829 VP	303	if (x64) {
	304	ctx.x64 = (WinContext64){
	305	.ContextFlags = WIN_CTX64_ALL,
2ad9b50f	306	.MxCsr = env->mxcsr,
f5daa829 VP	307
	308	.SegEs = env->segs[0].selector,
	309	.SegCs = env->segs[1].selector,
	310	.SegSs = env->segs[2].selector,
	311	.SegDs = env->segs[3].selector,
	312	.SegFs = env->segs[4].selector,
	313	.SegGs = env->segs[5].selector,
	314	.EFlags = cpu_compute_eflags(env),
	315
	316	.Dr0 = env->dr[0],
	317	.Dr1 = env->dr[1],
	318	.Dr2 = env->dr[2],
	319	.Dr3 = env->dr[3],
	320	.Dr6 = env->dr[6],
	321	.Dr7 = env->dr[7],
	322
	323	.Rax = env->regs[R_EAX],
	324	.Rbx = env->regs[R_EBX],
	325	.Rcx = env->regs[R_ECX],
	326	.Rdx = env->regs[R_EDX],
	327	.Rsp = env->regs[R_ESP],
	328	.Rbp = env->regs[R_EBP],
	329	.Rsi = env->regs[R_ESI],
	330	.Rdi = env->regs[R_EDI],
	331	.R8 = env->regs[8],
	332	.R9 = env->regs[9],
	333	.R10 = env->regs[10],
	334	.R11 = env->regs[11],
	335	.R12 = env->regs[12],
	336	.R13 = env->regs[13],
	337	.R14 = env->regs[14],
	338	.R15 = env->regs[15],
	339
	340	.Rip = env->eip,
	341	.FltSave = {
	342	.MxCsr = env->mxcsr,
	343	},
	344	};
	345	} else {
	346	ctx.x32 = (WinContext32){
	347	.ContextFlags = WIN_CTX32_FULL \| WIN_CTX_DBG,
	348
	349	.SegEs = env->segs[0].selector,
	350	.SegCs = env->segs[1].selector,
	351	.SegSs = env->segs[2].selector,
	352	.SegDs = env->segs[3].selector,
	353	.SegFs = env->segs[4].selector,
	354	.SegGs = env->segs[5].selector,
	355	.EFlags = cpu_compute_eflags(env),
	356
	357	.Dr0 = env->dr[0],
	358	.Dr1 = env->dr[1],
	359	.Dr2 = env->dr[2],
	360	.Dr3 = env->dr[3],
	361	.Dr6 = env->dr[6],
	362	.Dr7 = env->dr[7],
	363
	364	.Eax = env->regs[R_EAX],
	365	.Ebx = env->regs[R_EBX],
	366	.Ecx = env->regs[R_ECX],
	367	.Edx = env->regs[R_EDX],
	368	.Esp = env->regs[R_ESP],
	369	.Ebp = env->regs[R_EBP],
	370	.Esi = env->regs[R_ESI],
371	.Edi = env->regs[R_EDI],
372
373	.Eip = env->eip,
374	};
375	}
2ad9b50f VP	376
2ad9b50f VP	377	if (cpu_memory_rw_debug(first_cpu, Context,
f5daa829	378	&saved_ctx[i].ctx, win_dump_ctx_size(x64), 0)) {
2ad9b50f VP	379	error_setg(errp, "win-dump: failed to save CPU #%d context", i);
	380	return;
	381	}
	382
	383	if (cpu_memory_rw_debug(first_cpu, Context,
f5daa829	384	&ctx, win_dump_ctx_size(x64), 1)) {
2ad9b50f VP	385	error_setg(errp, "win-dump: failed to write CPU #%d context", i);
	386	return;
	387	}
	388
	389	i++;
	390	}
	391	}
	392
f5daa829	393	static void restore_context(WinDumpHeader *h, bool x64,
2ad9b50f VP	394	struct saved_context *saved_ctx)
	395	{
	396	int i;
2ad9b50f	397
fb21efe9	398	for (i = 0; i < WIN_DUMP_FIELD(NumberProcessors); i++) {
2ad9b50f	399	if (cpu_memory_rw_debug(first_cpu, saved_ctx[i].addr,
f5daa829	400	&saved_ctx[i].ctx, win_dump_ctx_size(x64), 1)) {
b0e70950	401	warn_report("win-dump: failed to restore CPU #%d context", i);
2ad9b50f VP	402	}
	403	}
	404	}
	405
2da91b54 VP	406	void create_win_dump(DumpState s, Error *errp)
2da91b54 VP	407	{
f5daa829	408	WinDumpHeader h = (void )(s->guest_note + VMCOREINFO_ELF_NOTE_HDR_SIZE);
92d1b3d5 VP	409	X86CPU *first_x86_cpu = X86_CPU(first_cpu);
92d1b3d5 VP	410	uint64_t saved_cr3 = first_x86_cpu->env.cr[3];
2ad9b50f	411	struct saved_context *saved_ctx = NULL;
2da91b54	412	Error *local_err = NULL;
f5daa829 VP	413	bool x64 = true;
f5daa829 VP	414	size_t hdr_size;
2da91b54	415
f5daa829 VP	416	if (s->guest_note_size != VMCOREINFO_WIN_DUMP_NOTE_SIZE32 &&
f5daa829 VP	417	s->guest_note_size != VMCOREINFO_WIN_DUMP_NOTE_SIZE64) {
2da91b54 VP	418	error_setg(errp, "win-dump: invalid vmcoreinfo note size");
	419	return;
	420	}
	421
f5daa829	422	if (!check_header(h, &x64, &local_err)) {
2da91b54 VP	423	error_propagate(errp, local_err);
	424	return;
	425	}
	426
f5daa829 VP	427	hdr_size = x64 ? sizeof(WinDumpHeader64) : sizeof(WinDumpHeader32);
f5daa829 VP	428
92d1b3d5 VP	429	/*
	430	* Further access to kernel structures by virtual addresses
	431	* should be made from system context.
	432	*/
	433
fb21efe9	434	first_x86_cpu->env.cr[3] = WIN_DUMP_FIELD(DirectoryTableBase);
92d1b3d5	435
f5daa829	436	check_kdbg(h, x64, &local_err);
2da91b54 VP	437	if (local_err) {
2da91b54 VP	438	error_propagate(errp, local_err);
92d1b3d5	439	goto out_cr3;
2da91b54 VP	440	}
2da91b54 VP	441
f5daa829	442	patch_header(h, x64);
2da91b54	443
fb21efe9	444	saved_ctx = g_new(struct saved_context, WIN_DUMP_FIELD(NumberProcessors));
2ad9b50f VP	445
	446	/*
	447	* Always patch context because there is no way
	448	* to determine if the system-saved context is valid
	449	*/
	450
f5daa829	451	patch_and_save_context(h, x64, saved_ctx, &local_err);
2ad9b50f VP	452	if (local_err) {
	453	error_propagate(errp, local_err);
	454	goto out_free;
	455	}
	456
fb21efe9	457	s->total_size = WIN_DUMP_FIELD(RequiredDumpSpace);
2da91b54	458
f5daa829 VP	459	s->written_size = qemu_write_full(s->fd, h, hdr_size);
f5daa829 VP	460	if (s->written_size != hdr_size) {
2da91b54	461	error_setg(errp, QERR_IO_ERROR);
2ad9b50f	462	goto out_restore;
2da91b54 VP	463	}
2da91b54 VP	464
f5daa829	465	write_runs(s, h, x64, &local_err);
2da91b54 VP	466	if (local_err) {
2da91b54 VP	467	error_propagate(errp, local_err);
2ad9b50f	468	goto out_restore;
2da91b54	469	}
92d1b3d5	470
2ad9b50f	471	out_restore:
f5daa829	472	restore_context(h, x64, saved_ctx);
2ad9b50f VP	473	out_free:
2ad9b50f VP	474	g_free(saved_ctx);
92d1b3d5 VP	475	out_cr3:
	476	first_x86_cpu->env.cr[3] = saved_cr3;
	477
	478	return;
2da91b54	479	}
efc3146a PMD	480
	481	#else /* !TARGET_X86_64 */
	482
	483	bool win_dump_available(Error **errp)
	484	{
	485	error_setg(errp, "Windows dump is only available for x86-64");
	486
	487	return false;
	488	}
	489
97244862 PMD	490	void create_win_dump(DumpState s, Error *errp)
	491	{
	492	win_dump_available(errp);
	493	}
	494
efc3146a	495	#endif