{"id":812444,"url":"http://patchwork.ozlabs.org/api/patches/812444/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170911165929.2791-3-marcandre.lureau@redhat.com/","project":{"id":14,"url":"http://patchwork.ozlabs.org/api/projects/14/?format=json","name":"QEMU Development","link_name":"qemu-devel","list_id":"qemu-devel.nongnu.org","list_email":"qemu-devel@nongnu.org","web_url":"","scm_url":"","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20170911165929.2791-3-marcandre.lureau@redhat.com>","list_archive_url":null,"date":"2017-09-11T16:59:24","name":"[v6,2/7] hw/misc: add vmcoreinfo device","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"42426437ebd75aa3ca49e891849ac869d324bc5c","submitter":{"id":66774,"url":"http://patchwork.ozlabs.org/api/people/66774/?format=json","name":"Marc-André Lureau","email":"marcandre.lureau@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170911165929.2791-3-marcandre.lureau@redhat.com/mbox/","series":[{"id":2525,"url":"http://patchwork.ozlabs.org/api/series/2525/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=2525","date":"2017-09-11T16:59:22","name":"KASLR kernel dump support","version":6,"mbox":"http://patchwork.ozlabs.org/series/2525/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/812444/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/812444/checks/","tags":{},"related":[],"headers":{"Return-Path":"<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@bilbo.ozlabs.org","Authentication-Results":["ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=nongnu.org\n\t(client-ip=2001:4830:134:3::11; helo=lists.gnu.org;\n\tenvelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n\treceiver=<UNKNOWN>)","ext-mx08.extmail.prod.ext.phx2.redhat.com;\n\tdmarc=none (p=none dis=none) header.from=redhat.com","ext-mx08.extmail.prod.ext.phx2.redhat.com;\n\tspf=fail smtp.mailfrom=marcandre.lureau@redhat.com"],"Received":["from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11])\n\t(using TLSv1 with cipher AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3xrZ1Z3lNmz9s81\n\tfor <incoming@patchwork.ozlabs.org>;\n\tTue, 12 Sep 2017 03:00:34 +1000 (AEST)","from localhost ([::1]:59150 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>)\n\tid 1drS4W-0005zB-Kh\n\tfor incoming@patchwork.ozlabs.org; Mon, 11 Sep 2017 13:00:32 -0400","from eggs.gnu.org ([2001:4830:134:3::10]:57630)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from <marcandre.lureau@redhat.com>) id 1drS3p-0005vu-5y\n\tfor qemu-devel@nongnu.org; Mon, 11 Sep 2017 12:59:50 -0400","from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from <marcandre.lureau@redhat.com>) id 1drS3m-00076W-2s\n\tfor qemu-devel@nongnu.org; Mon, 11 Sep 2017 12:59:49 -0400","from mx1.redhat.com ([209.132.183.28]:45170)\n\tby eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)\n\t(Exim 4.71) (envelope-from <marcandre.lureau@redhat.com>)\n\tid 1drS3l-00076K-RI\n\tfor qemu-devel@nongnu.org; Mon, 11 Sep 2017 12:59:46 -0400","from smtp.corp.redhat.com\n\t(int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14])\n\t(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby mx1.redhat.com (Postfix) with ESMTPS id CC190C0587D9\n\tfor <qemu-devel@nongnu.org>; Mon, 11 Sep 2017 16:59:44 +0000 (UTC)","from localhost (ovpn-112-51.ams2.redhat.com [10.36.112.51])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id 30EB65D9CA;\n\tMon, 11 Sep 2017 16:59:43 +0000 (UTC)"],"DMARC-Filter":"OpenDMARC Filter v1.3.2 mx1.redhat.com CC190C0587D9","From":"=?utf-8?q?Marc-Andr=C3=A9_Lureau?= <marcandre.lureau@redhat.com>","To":"qemu-devel@nongnu.org","Date":"Mon, 11 Sep 2017 18:59:24 +0200","Message-Id":"<20170911165929.2791-3-marcandre.lureau@redhat.com>","In-Reply-To":"<20170911165929.2791-1-marcandre.lureau@redhat.com>","References":"<20170911165929.2791-1-marcandre.lureau@redhat.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","X-Scanned-By":"MIMEDefang 2.79 on 10.5.11.14","X-Greylist":"Sender IP whitelisted, not delayed by milter-greylist-4.5.16\n\t(mx1.redhat.com [10.5.110.32]);\n\tMon, 11 Sep 2017 16:59:44 +0000 (UTC)","Content-Transfer-Encoding":"quoted-printable","X-detected-operating-system":"by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]\n\t[fuzzy]","X-Received-From":"209.132.183.28","Subject":"[Qemu-devel] [PATCH v6 2/7] hw/misc: add vmcoreinfo device","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.21","Precedence":"list","List-Id":"<qemu-devel.nongnu.org>","List-Unsubscribe":"<https://lists.nongnu.org/mailman/options/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>","List-Archive":"<http://lists.nongnu.org/archive/html/qemu-devel/>","List-Post":"<mailto:qemu-devel@nongnu.org>","List-Help":"<mailto:qemu-devel-request@nongnu.org?subject=help>","List-Subscribe":"<https://lists.nongnu.org/mailman/listinfo/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=subscribe>","Cc":"ehabkost@redhat.com, mst@redhat.com, anderson@redhat.com, =?utf-8?q?Ma?=\n\t=?utf-8?q?rc-Andr=C3=A9_Lureau?= <marcandre.lureau@redhat.com>,\n\timammedo@redhat.com, lersek@redhat.com","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>"},"content":"See docs/specs/vmcoreinfo.txt for details.\n\n\"etc/vmcoreinfo\" fw_cfg entry is added when using \"-device vmcoreinfo\".\n\nSigned-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>\n---\n include/hw/misc/vmcoreinfo.h | 46 +++++++++++++++++++++\n hw/misc/vmcoreinfo.c         | 96 ++++++++++++++++++++++++++++++++++++++++++++\n docs/specs/vmcoreinfo.txt    | 41 +++++++++++++++++++\n hw/misc/Makefile.objs        |  1 +\n 4 files changed, 184 insertions(+)\n create mode 100644 include/hw/misc/vmcoreinfo.h\n create mode 100644 hw/misc/vmcoreinfo.c\n create mode 100644 docs/specs/vmcoreinfo.txt","diff":"diff --git a/include/hw/misc/vmcoreinfo.h b/include/hw/misc/vmcoreinfo.h\nnew file mode 100644\nindex 0000000000..c3aa856545\n--- /dev/null\n+++ b/include/hw/misc/vmcoreinfo.h\n@@ -0,0 +1,46 @@\n+/*\n+ * Virtual Machine coreinfo device\n+ *\n+ * Copyright (C) 2017 Red Hat, Inc.\n+ *\n+ * Authors: Marc-André Lureau <marcandre.lureau@redhat.com>\n+ *\n+ * This work is licensed under the terms of the GNU GPL, version 2 or later.\n+ * See the COPYING file in the top-level directory.\n+ *\n+ */\n+#ifndef VMCOREINFO_H\n+#define VMCOREINFO_H\n+\n+#include \"hw/qdev.h\"\n+\n+#define VMCOREINFO_DEVICE \"vmcoreinfo\"\n+#define VMCOREINFO(obj) OBJECT_CHECK(VMCoreInfoState, (obj), VMCOREINFO_DEVICE)\n+\n+#define VMCOREINFO_FORMAT_NONE 0x0\n+#define VMCOREINFO_FORMAT_ELF 0x1\n+\n+/* all fields are little-endian */\n+typedef struct FWCfgVMCoreInfo {\n+    uint16_t host_format; /* set on reset */\n+    uint16_t guest_format;\n+    uint32_t size;\n+    uint64_t paddr;\n+} QEMU_PACKED FWCfgVMCoreInfo;\n+\n+typedef struct VMCoreInfoState {\n+    DeviceClass parent_obj;\n+\n+    bool has_vmcoreinfo;\n+    FWCfgVMCoreInfo vmcoreinfo;\n+} VMCoreInfoState;\n+\n+/* returns NULL unless there is exactly one device */\n+static inline VMCoreInfoState *vmcoreinfo_find(void)\n+{\n+    Object *o = object_resolve_path_type(\"\", VMCOREINFO_DEVICE, NULL);\n+\n+    return o ? VMCOREINFO(o) : NULL;\n+}\n+\n+#endif\ndiff --git a/hw/misc/vmcoreinfo.c b/hw/misc/vmcoreinfo.c\nnew file mode 100644\nindex 0000000000..a618e12677\n--- /dev/null\n+++ b/hw/misc/vmcoreinfo.c\n@@ -0,0 +1,96 @@\n+/*\n+ * Virtual Machine coreinfo device\n+ *\n+ * Copyright (C) 2017 Red Hat, Inc.\n+ *\n+ * Authors: Marc-André Lureau <marcandre.lureau@redhat.com>\n+ *\n+ * This work is licensed under the terms of the GNU GPL, version 2 or later.\n+ * See the COPYING file in the top-level directory.\n+ *\n+ */\n+#include \"qemu/osdep.h\"\n+#include \"qapi/error.h\"\n+#include \"hw/nvram/fw_cfg.h\"\n+#include \"hw/misc/vmcoreinfo.h\"\n+\n+static void fw_cfg_vmci_write(void *dev, off_t offset, size_t len)\n+{\n+    VMCoreInfoState *s = VMCOREINFO(dev);\n+\n+    s->has_vmcoreinfo = offset == 0 && len == sizeof(s->vmcoreinfo)\n+        && s->vmcoreinfo.guest_format != VMCOREINFO_FORMAT_NONE;\n+}\n+\n+static void vmcoreinfo_reset(void *dev)\n+{\n+    VMCoreInfoState *s = VMCOREINFO(dev);\n+\n+    s->has_vmcoreinfo = false;\n+    memset(&s->vmcoreinfo, 0, sizeof(s->vmcoreinfo));\n+    s->vmcoreinfo.host_format = cpu_to_le16(VMCOREINFO_FORMAT_ELF);\n+}\n+\n+static void vmcoreinfo_realize(DeviceState *dev, Error **errp)\n+{\n+    VMCoreInfoState *s = VMCOREINFO(dev);\n+    FWCfgState *fw_cfg = fw_cfg_find();\n+\n+    /* Given that this function is executing, there is at least one VMCOREINFO\n+     * device. Check if there are several.\n+     */\n+    if (!vmcoreinfo_find()) {\n+        error_setg(errp, \"at most one %s device is permitted\",\n+                   VMCOREINFO_DEVICE);\n+        return;\n+    }\n+\n+    if (!fw_cfg || !fw_cfg->dma_enabled) {\n+        error_setg(errp, \"%s device requires fw_cfg with DMA\",\n+                   VMCOREINFO_DEVICE);\n+        return;\n+    }\n+\n+    fw_cfg_add_file_callback(fw_cfg, \"etc/vmcoreinfo\",\n+                             NULL, fw_cfg_vmci_write, s,\n+                             &s->vmcoreinfo, sizeof(s->vmcoreinfo), false);\n+\n+    qemu_register_reset(vmcoreinfo_reset, dev);\n+}\n+\n+static const VMStateDescription vmstate_vmcoreinfo = {\n+    .name = \"vmcoreinfo\",\n+    .version_id = 1,\n+    .minimum_version_id = 1,\n+    .fields = (VMStateField[]) {\n+        VMSTATE_BOOL(has_vmcoreinfo, VMCoreInfoState),\n+        VMSTATE_UINT16(vmcoreinfo.host_format, VMCoreInfoState),\n+        VMSTATE_UINT16(vmcoreinfo.guest_format, VMCoreInfoState),\n+        VMSTATE_UINT32(vmcoreinfo.size, VMCoreInfoState),\n+        VMSTATE_UINT64(vmcoreinfo.paddr, VMCoreInfoState),\n+        VMSTATE_END_OF_LIST()\n+    },\n+};\n+\n+static void vmcoreinfo_device_class_init(ObjectClass *klass, void *data)\n+{\n+    DeviceClass *dc = DEVICE_CLASS(klass);\n+\n+    dc->vmsd = &vmstate_vmcoreinfo;\n+    dc->realize = vmcoreinfo_realize;\n+    dc->hotpluggable = false;\n+}\n+\n+static const TypeInfo vmcoreinfo_device_info = {\n+    .name          = VMCOREINFO_DEVICE,\n+    .parent        = TYPE_DEVICE,\n+    .instance_size = sizeof(VMCoreInfoState),\n+    .class_init    = vmcoreinfo_device_class_init,\n+};\n+\n+static void vmcoreinfo_register_types(void)\n+{\n+    type_register_static(&vmcoreinfo_device_info);\n+}\n+\n+type_init(vmcoreinfo_register_types)\ndiff --git a/docs/specs/vmcoreinfo.txt b/docs/specs/vmcoreinfo.txt\nnew file mode 100644\nindex 0000000000..2868a77142\n--- /dev/null\n+++ b/docs/specs/vmcoreinfo.txt\n@@ -0,0 +1,41 @@\n+=================\n+VMCoreInfo device\n+=================\n+\n+The `-device vmcoreinfo` will create a fw_cfg entry for a guest to\n+store dump details.\n+\n+etc/vmcoreinfo\n+**************\n+\n+A guest may use this fw_cfg entry to add information details to qemu\n+dumps.\n+\n+The entry of 16 bytes has the following layout, in little-endian::\n+\n+#define VMCOREINFO_FORMAT_NONE 0x0\n+#define VMCOREINFO_FORMAT_ELF 0x1\n+\n+    struct FWCfgVMCoreInfo {\n+        uint16_t host_format;  /* formats host supports */\n+        uint16_t guest_format; /* format guest supplies */\n+        uint32_t size;         /* size of vmcoreinfo region */\n+        uint64_t paddr;        /* physical address of vmcoreinfo region */\n+    };\n+\n+Only full write (of 16 bytes) are considered valid for further\n+processing of entry values.\n+\n+A write of 0 in guest_format will disable further processing of\n+vmcoreinfo entry values & content.\n+\n+Format & content\n+****************\n+\n+As of qemu 2.11, only VMCOREINFO_FORMAT_ELF is supported.\n+\n+The entry gives location and size of an ELF note that is appended in\n+qemu dumps.\n+\n+The note format/class must be of the target bitness and the size must\n+be less than 1Mb.\ndiff --git a/hw/misc/Makefile.objs b/hw/misc/Makefile.objs\nindex 29fb922cef..052982f69b 100644\n--- a/hw/misc/Makefile.objs\n+++ b/hw/misc/Makefile.objs\n@@ -9,6 +9,7 @@ common-obj-$(CONFIG_PCI_TESTDEV) += pci-testdev.o\n common-obj-$(CONFIG_EDU) += edu.o\n \n common-obj-y += unimp.o\n+common-obj-y += vmcoreinfo.o\n \n obj-$(CONFIG_VMPORT) += vmport.o\n \n","prefixes":["v6","2/7"]}