Blame SOURCES/kvm-dump-add-guest-ELF-note.patch

9bac43
From 93d31dbfbf412b8a80d364aac0ff6f5f319e831c Mon Sep 17 00:00:00 2001
9bac43
From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= <marcandre.lureau@redhat.com>
9bac43
Date: Mon, 27 Nov 2017 22:51:06 +0100
9bac43
Subject: [PATCH 08/21] dump: add guest ELF note
9bac43
MIME-Version: 1.0
9bac43
Content-Type: text/plain; charset=UTF-8
9bac43
Content-Transfer-Encoding: 8bit
9bac43
9bac43
RH-Author: Marc-André Lureau <marcandre.lureau@redhat.com>
9bac43
Message-id: <20171127225111.24518-5-marcandre.lureau@redhat.com>
9bac43
Patchwork-id: 77925
9bac43
O-Subject: [RHV7.5 qemu-kvm-rhev PATCH 4/9] dump: add guest ELF note
9bac43
Bugzilla: 1398633
9bac43
RH-Acked-by: Laszlo Ersek <lersek@redhat.com>
9bac43
RH-Acked-by: Andrew Jones <drjones@redhat.com>
9bac43
RH-Acked-by: Miroslav Rezanina <mrezanin@redhat.com>
9bac43
9bac43
Read the guest ELF PT_NOTE from guest memory when fw_cfg
9bac43
etc/vmcoreinfo entry provides the location, and write it as an
9bac43
additional note in the dump.
9bac43
9bac43
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
9bac43
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
9bac43
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
9bac43
9bac43
(cherry picked from commit 903ef7349699dcd932b5981b85c1f1ebe4a4bf2a)
9bac43
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
9bac43
Signed-off-by: Miroslav Rezanina <mrezanin@redhat.com>
9bac43
---
9bac43
 dump.c                | 107 ++++++++++++++++++++++++++++++++++++++++++++++++++
9bac43
 include/sysemu/dump.h |   2 +
9bac43
 2 files changed, 109 insertions(+)
9bac43
9bac43
diff --git a/dump.c b/dump.c
9bac43
index 99117ba..a4f175d 100644
9bac43
--- a/dump.c
9bac43
+++ b/dump.c
9bac43
@@ -26,6 +26,8 @@
9bac43
 #include "qapi/qmp/qerror.h"
9bac43
 #include "qmp-commands.h"
9bac43
 #include "qapi-event.h"
9bac43
+#include "qemu/error-report.h"
9bac43
+#include "hw/misc/vmcoreinfo.h"
9bac43
 
9bac43
 #include <zlib.h>
9bac43
 #ifdef CONFIG_LZO
9bac43
@@ -38,6 +40,13 @@
9bac43
 #define ELF_MACHINE_UNAME "Unknown"
9bac43
 #endif
9bac43
 
9bac43
+#define MAX_GUEST_NOTE_SIZE (1 << 20) /* 1MB should be enough */
9bac43
+
9bac43
+#define ELF_NOTE_SIZE(hdr_size, name_size, desc_size)   \
9bac43
+    ((DIV_ROUND_UP((hdr_size), 4) +                     \
9bac43
+      DIV_ROUND_UP((name_size), 4) +                    \
9bac43
+      DIV_ROUND_UP((desc_size), 4)) * 4)
9bac43
+
9bac43
 uint16_t cpu_to_dump16(DumpState *s, uint16_t val)
9bac43
 {
9bac43
     if (s->dump_info.d_endian == ELFDATA2LSB) {
9bac43
@@ -76,6 +85,8 @@ static int dump_cleanup(DumpState *s)
9bac43
     guest_phys_blocks_free(&s->guest_phys_blocks);
9bac43
     memory_mapping_list_free(&s->list);
9bac43
     close(s->fd);
9bac43
+    g_free(s->guest_note);
9bac43
+    s->guest_note = NULL;
9bac43
     if (s->resume) {
9bac43
         if (s->detached) {
9bac43
             qemu_mutex_lock_iothread();
9bac43
@@ -235,6 +246,19 @@ static inline int cpu_index(CPUState *cpu)
9bac43
     return cpu->cpu_index + 1;
9bac43
 }
9bac43
 
9bac43
+static void write_guest_note(WriteCoreDumpFunction f, DumpState *s,
9bac43
+                             Error **errp)
9bac43
+{
9bac43
+    int ret;
9bac43
+
9bac43
+    if (s->guest_note) {
9bac43
+        ret = f(s->guest_note, s->guest_note_size, s);
9bac43
+        if (ret < 0) {
9bac43
+            error_setg(errp, "dump: failed to write guest note");
9bac43
+        }
9bac43
+    }
9bac43
+}
9bac43
+
9bac43
 static void write_elf64_notes(WriteCoreDumpFunction f, DumpState *s,
9bac43
                               Error **errp)
9bac43
 {
9bac43
@@ -258,6 +282,8 @@ static void write_elf64_notes(WriteCoreDumpFunction f, DumpState *s,
9bac43
             return;
9bac43
         }
9bac43
     }
9bac43
+
9bac43
+    write_guest_note(f, s, errp);
9bac43
 }
9bac43
 
9bac43
 static void write_elf32_note(DumpState *s, Error **errp)
9bac43
@@ -303,6 +329,8 @@ static void write_elf32_notes(WriteCoreDumpFunction f, DumpState *s,
9bac43
             return;
9bac43
         }
9bac43
     }
9bac43
+
9bac43
+    write_guest_note(f, s, errp);
9bac43
 }
9bac43
 
9bac43
 static void write_elf_section(DumpState *s, int type, Error **errp)
9bac43
@@ -714,6 +742,44 @@ static int buf_write_note(const void *buf, size_t size, void *opaque)
9bac43
     return 0;
9bac43
 }
9bac43
 
9bac43
+/*
9bac43
+ * This function retrieves various sizes from an elf header.
9bac43
+ *
9bac43
+ * @note has to be a valid ELF note. The return sizes are unmodified
9bac43
+ * (not padded or rounded up to be multiple of 4).
9bac43
+ */
9bac43
+static void get_note_sizes(DumpState *s, const void *note,
9bac43
+                           uint64_t *note_head_size,
9bac43
+                           uint64_t *name_size,
9bac43
+                           uint64_t *desc_size)
9bac43
+{
9bac43
+    uint64_t note_head_sz;
9bac43
+    uint64_t name_sz;
9bac43
+    uint64_t desc_sz;
9bac43
+
9bac43
+    if (s->dump_info.d_class == ELFCLASS64) {
9bac43
+        const Elf64_Nhdr *hdr = note;
9bac43
+        note_head_sz = sizeof(Elf64_Nhdr);
9bac43
+        name_sz = tswap64(hdr->n_namesz);
9bac43
+        desc_sz = tswap64(hdr->n_descsz);
9bac43
+    } else {
9bac43
+        const Elf32_Nhdr *hdr = note;
9bac43
+        note_head_sz = sizeof(Elf32_Nhdr);
9bac43
+        name_sz = tswap32(hdr->n_namesz);
9bac43
+        desc_sz = tswap32(hdr->n_descsz);
9bac43
+    }
9bac43
+
9bac43
+    if (note_head_size) {
9bac43
+        *note_head_size = note_head_sz;
9bac43
+    }
9bac43
+    if (name_size) {
9bac43
+        *name_size = name_sz;
9bac43
+    }
9bac43
+    if (desc_size) {
9bac43
+        *desc_size = desc_sz;
9bac43
+    }
9bac43
+}
9bac43
+
9bac43
 /* write common header, sub header and elf note to vmcore */
9bac43
 static void create_header32(DumpState *s, Error **errp)
9bac43
 {
9bac43
@@ -1492,6 +1558,7 @@ static void dump_init(DumpState *s, int fd, bool has_format,
9bac43
                       DumpGuestMemoryFormat format, bool paging, bool has_filter,
9bac43
                       int64_t begin, int64_t length, Error **errp)
9bac43
 {
9bac43
+    VMCoreInfoState *vmci = vmcoreinfo_find();
9bac43
     CPUState *cpu;
9bac43
     int nr_cpus;
9bac43
     Error *err = NULL;
9bac43
@@ -1569,6 +1636,46 @@ static void dump_init(DumpState *s, int fd, bool has_format,
9bac43
         goto cleanup;
9bac43
     }
9bac43
 
9bac43
+    /*
9bac43
+     * The goal of this block is to copy the guest note out of
9bac43
+     * the guest.  Failure to do so is not fatal for dumping.
9bac43
+     */
9bac43
+    if (vmci) {
9bac43
+        uint64_t addr, note_head_size, name_size, desc_size;
9bac43
+        uint32_t size;
9bac43
+        uint16_t format;
9bac43
+
9bac43
+        note_head_size = s->dump_info.d_class == ELFCLASS32 ?
9bac43
+            sizeof(Elf32_Nhdr) : sizeof(Elf64_Nhdr);
9bac43
+
9bac43
+        format = le16_to_cpu(vmci->vmcoreinfo.guest_format);
9bac43
+        size = le32_to_cpu(vmci->vmcoreinfo.size);
9bac43
+        addr = le64_to_cpu(vmci->vmcoreinfo.paddr);
9bac43
+        if (!vmci->has_vmcoreinfo) {
9bac43
+            warn_report("guest note is not present");
9bac43
+        } else if (size < note_head_size || size > MAX_GUEST_NOTE_SIZE) {
9bac43
+            warn_report("guest note size is invalid: %" PRIu32, size);
9bac43
+        } else if (format != VMCOREINFO_FORMAT_ELF) {
9bac43
+            warn_report("guest note format is unsupported: %" PRIu16, format);
9bac43
+        } else {
9bac43
+            s->guest_note = g_malloc(size + 1); /* +1 for adding \0 */
9bac43
+            cpu_physical_memory_read(addr, s->guest_note, size);
9bac43
+
9bac43
+            get_note_sizes(s, s->guest_note, NULL, &name_size, &desc_size);
9bac43
+            s->guest_note_size = ELF_NOTE_SIZE(note_head_size, name_size,
9bac43
+                                               desc_size);
9bac43
+            if (name_size > MAX_GUEST_NOTE_SIZE ||
9bac43
+                desc_size > MAX_GUEST_NOTE_SIZE ||
9bac43
+                s->guest_note_size > size) {
9bac43
+                warn_report("Invalid guest note header");
9bac43
+                g_free(s->guest_note);
9bac43
+                s->guest_note = NULL;
9bac43
+            } else {
9bac43
+                s->note_size += s->guest_note_size;
9bac43
+            }
9bac43
+        }
9bac43
+    }
9bac43
+
9bac43
     /* get memory mapping */
9bac43
     if (paging) {
9bac43
         qemu_get_guest_memory_mapping(&s->list, &s->guest_phys_blocks, &err;;
9bac43
diff --git a/include/sysemu/dump.h b/include/sysemu/dump.h
9bac43
index 2672a15..df43bd0 100644
9bac43
--- a/include/sysemu/dump.h
9bac43
+++ b/include/sysemu/dump.h
9bac43
@@ -192,6 +192,8 @@ typedef struct DumpState {
9bac43
                                   * this could be used to calculate
9bac43
                                   * how much work we have
9bac43
                                   * finished. */
9bac43
+    uint8_t *guest_note;         /* ELF note content */
9bac43
+    size_t guest_note_size;
9bac43
 } DumpState;
9bac43
 
9bac43
 uint16_t cpu_to_dump16(DumpState *s, uint16_t val);
9bac43
-- 
9bac43
1.8.3.1
9bac43