[2/2] hw: Add test device for unittests execution v4

Add a test device which supports the kvmctl ioports,
so one can run the KVM unittest suite.

Intended Usage:

qemu-system-x86_64 -device pc-testdev -serial stdio \
-device isa-debugexit,iobase=0xf4,access-size=4 \
-kernel /path/to/kvm/unittests/msr.flat

Where msr.flat is one of the KVM unittests, present on a
separate repo,

git://git.kernel.org/pub/scm/virt/kvm/kvm-unit-tests.git

Changes from v3:
* Ported all register_ioport functions to memory API

Changes from v2:

* Rename struct testdev to PCTestdev
* Embed ioport_data into PCTestdev struct
* Porting most register_ioport functions to memory API

Changes from v1:

* Removed unused testdev member
* Renamed device to a less generic name, pc-testdev

Initial changes from initial attempt:

* Removed port 0xf1, since now kvm-unit-tests use
  serial
* Removed exit code port 0xf4, since that can be
  replaced by

-device isa-debugexit,iobase=0xf4,access-size=4

* Removed ram size port 0xd1, since guest memory
  size can be retrieved from firmware, there's a
  patch for kvm-unit-tests including an API to
  retrieve that value.

CC: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
Signed-off-by: Avi Kivity <avi@redhat.com>
Signed-off-by: Marcelo Tosatti <mtosatti@redhat.com>
Signed-off-by: Lucas Meneghel Rodrigues <lmr@redhat.com>
---
 hw/i386/Makefile.objs |   1 +
 hw/pc-testdev.c       | 167 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 168 insertions(+)
 create mode 100644 hw/pc-testdev.c

On 2012-10-09 15:03, Lucas Meneghel Rodrigues wrote:
> Add a test device which supports the kvmctl ioports,
> so one can run the KVM unittest suite.
> 
> Intended Usage:
> 
> qemu-system-x86_64 -device pc-testdev -serial stdio \
> -device isa-debugexit,iobase=0xf4,access-size=4 \
> -kernel /path/to/kvm/unittests/msr.flat
> 
> Where msr.flat is one of the KVM unittests, present on a
> separate repo,
> 
> git://git.kernel.org/pub/scm/virt/kvm/kvm-unit-tests.git
> 
> Changes from v3:
> * Ported all register_ioport functions to memory API
> 
> Changes from v2:
> 
> * Rename struct testdev to PCTestdev
> * Embed ioport_data into PCTestdev struct
> * Porting most register_ioport functions to memory API
> 
> Changes from v1:
> 
> * Removed unused testdev member
> * Renamed device to a less generic name, pc-testdev
> 
> Initial changes from initial attempt:
> 
> * Removed port 0xf1, since now kvm-unit-tests use
>   serial
> * Removed exit code port 0xf4, since that can be
>   replaced by
> 
> -device isa-debugexit,iobase=0xf4,access-size=4
> 
> * Removed ram size port 0xd1, since guest memory
>   size can be retrieved from firmware, there's a
>   patch for kvm-unit-tests including an API to
>   retrieve that value.
> 
> CC: Paolo Bonzini <pbonzini@redhat.com>
> Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
> Signed-off-by: Avi Kivity <avi@redhat.com>
> Signed-off-by: Marcelo Tosatti <mtosatti@redhat.com>
> Signed-off-by: Lucas Meneghel Rodrigues <lmr@redhat.com>
> ---
>  hw/i386/Makefile.objs |   1 +
>  hw/pc-testdev.c       | 167 ++++++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 168 insertions(+)
>  create mode 100644 hw/pc-testdev.c
> 
> diff --git a/hw/i386/Makefile.objs b/hw/i386/Makefile.objs
> index b34c61c..3ef3b4a 100644
> --- a/hw/i386/Makefile.objs
> +++ b/hw/i386/Makefile.objs
> @@ -11,5 +11,6 @@ obj-$(CONFIG_XEN_PCI_PASSTHROUGH) += xen-host-pci-device.o
>  obj-$(CONFIG_XEN_PCI_PASSTHROUGH) += xen_pt.o xen_pt_config_init.o xen_pt_msi.o
>  obj-y += kvm/
>  obj-$(CONFIG_SPICE) += qxl.o qxl-logger.o qxl-render.o
> +obj-y += pc-testdev.o
>  
>  obj-y := $(addprefix ../,$(obj-y))
> diff --git a/hw/pc-testdev.c b/hw/pc-testdev.c
> new file mode 100644
> index 0000000..d326e01
> --- /dev/null
> +++ b/hw/pc-testdev.c
> @@ -0,0 +1,167 @@
> +/*
> + * QEMU x86 ISA testdev
> + *
> + * Copyright (c) 2012 Avi Kivity, Gerd Hoffmann, Marcelo Tosatti
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a copy
> + * of this software and associated documentation files (the "Software"), to deal
> + * in the Software without restriction, including without limitation the rights
> + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> + * copies of the Software, and to permit persons to whom the Software is
> + * furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice shall be included in
> + * all copies or substantial portions of the Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
> + * THE SOFTWARE.
> + */
> +
> +/*
> + * This device is used to test KVM features specific to the x86 port, such
> + * as emulation, power management, interrupt routing, among others. It's meant
> + * to be used like:
> + *
> + * qemu-system-x86_64 -device pc-testdev -serial stdio \
> + * -device isa-debugexit,iobase=0xf4,access-size=2 \
> + * -kernel /home/lmr/Code/virt-test.git/kvm/unittests/msr.flat
> + *
> + * Where msr.flat is one of the KVM unittests, present on a separate repo,
> + * git://git.kernel.org/pub/scm/virt/kvm/kvm-unit-tests.git
> +*/
> +
> +#include <sys/mman.h>
> +#include "hw.h"
> +#include "qdev.h"
> +#include "isa.h"
> +#include "exec-memory.h"
> +
> +typedef struct PCTestdev {
> +    ISADevice dev;
> +    MemoryRegion iomem;
> +    uint32_t ioport_data;
> +} PCTestdev;
> +
> +#define TYPE_TESTDEV "pc-testdev"
> +#define TESTDEV(obj) \
> +     OBJECT_CHECK(struct PCTestdev, (obj), TYPE_TESTDEV)
> +
> +static void test_device_irq_line(void *opaque, uint32_t addr, uint32_t data)
> +{
> +    struct PCTestdev *dev = opaque;
> +    qemu_set_irq(isa_get_irq(&dev->dev, addr - 0x2000), !!data);
> +}
> +
> +static void test_device_ioport_write(void *opaque, uint32_t addr, uint32_t data)
> +{
> +    struct PCTestdev *dev = opaque;
> +    dev->ioport_data = data;
> +}
> +
> +static uint32_t test_device_ioport_read(void *opaque, uint32_t addr)
> +{
> +    struct PCTestdev *dev = opaque;
> +    return dev->ioport_data;
> +}
> +
> +static void test_device_flush_page(void *opaque, uint32_t addr, uint32_t data)
> +{
> +    target_phys_addr_t len = 4096;
> +    void *a = cpu_physical_memory_map(data & ~0xffful, &len, 0);
> +
> +    mprotect(a, 4096, PROT_NONE);
> +    mprotect(a, 4096, PROT_READ|PROT_WRITE);
> +    cpu_physical_memory_unmap(a, len, 0, 0);
> +}
> +
> +static char *iomem_buf;
> +
> +static uint32_t test_iomem_readb(void *opaque, target_phys_addr_t addr)
> +{
> +    return iomem_buf[addr];
> +}
> +
> +static uint32_t test_iomem_readw(void *opaque, target_phys_addr_t addr)
> +{
> +    return *(uint16_t*)(iomem_buf + addr);
> +}
> +
> +static uint32_t test_iomem_readl(void *opaque, target_phys_addr_t addr)
> +{
> +    return *(uint32_t*)(iomem_buf + addr);
> +}
> +
> +static void test_iomem_writeb(void *opaque, target_phys_addr_t addr, uint32_t val)
> +{
> +    iomem_buf[addr] = val;
> +}
> +
> +static void test_iomem_writew(void *opaque, target_phys_addr_t addr, uint32_t val)
> +{
> +    *(uint16_t*)(iomem_buf + addr) = val;
> +}
> +
> +static void test_iomem_writel(void *opaque, target_phys_addr_t addr, uint32_t val)
> +{
> +    *(uint32_t*)(iomem_buf + addr) = val;
> +}
> +
> +static const MemoryRegionOps test_iomem_ops = {
> +    .old_mmio = {
> +        .read = { test_iomem_readb, test_iomem_readw, test_iomem_readl, },
> +        .write = { test_iomem_writeb, test_iomem_writew, test_iomem_writel, },

New devices shall not use legacy interfaces. Sorry if missed this in the
last round.

> +    },
> +    .endianness = DEVICE_LITTLE_ENDIAN,
> +};
> +
> +static const MemoryRegionPortio test_dev_portio_list[] = {
> +    { 0xe0, 1, 1, .read = test_device_ioport_read, .write = test_device_ioport_write, },
> +    { 0xe0, 1, 2, .read = test_device_ioport_read, .write = test_device_ioport_write, },
> +    { 0xe0, 1, 4, .read = test_device_ioport_read, .write = test_device_ioport_write, },
> +    { 0xe4, 1, 4, .write = test_device_flush_page, },
> +    { 0x2000, 24, 1, .write = test_device_irq_line, },
> +    PORTIO_END_OF_LIST(),
> +};

Can't we consolidate this to a number of consecutive ports, maybe above
0x2000 by default (but configurable via a property) and use a single
memory region? The unit tests need patching anyway, so they can also be
adjusted to a new interface.

> +
> +static int init_test_device(ISADevice *isa)
> +{
> +    struct PCTestdev *dev = DO_UPCAST(struct PCTestdev, dev, isa);
> +
> +    PortioList *test_dev_port_list = g_new(PortioList, 1);
> +    portio_list_init(test_dev_port_list, test_dev_portio_list,
> +                     NULL, "pc-testdev");
> +    portio_list_add(test_dev_port_list, get_system_io(), 0x0);
> +
> +    iomem_buf = g_malloc0(0x10000);
> +    memory_region_init_io(&dev->iomem, &test_iomem_ops, dev,
> +                          "pc-testdev", 0x10000);
> +    memory_region_add_subregion(isa_address_space(&dev->dev), 0xff000000,
> +                                                  &dev->iomem);
> +    return 0;
> +}
> +
> +static void testdev_class_init(ObjectClass *klass, void *data)
> +{
> +    ISADeviceClass *k = ISA_DEVICE_CLASS(klass);
> +
> +    k->init = init_test_device;
> +}
> +
> +static TypeInfo testdev_info = {
> +    .name           = "pc-testdev",
> +    .parent         = TYPE_ISA_DEVICE,
> +    .instance_size  = sizeof(struct PCTestdev),
> +    .class_init     = testdev_class_init,
> +};
> +
> +static void testdev_register_types(void)
> +{
> +    type_register_static(&testdev_info);
> +}
> +
> +type_init(testdev_register_types)
> 

Jan

On Tue, Oct 9, 2012 at 1:03 PM, Lucas Meneghel Rodrigues <lmr@redhat.com> wrote:
> Add a test device which supports the kvmctl ioports,
> so one can run the KVM unittest suite.
>
> Intended Usage:
>
> qemu-system-x86_64 -device pc-testdev -serial stdio \
> -device isa-debugexit,iobase=0xf4,access-size=4 \
> -kernel /path/to/kvm/unittests/msr.flat
>
> Where msr.flat is one of the KVM unittests, present on a
> separate repo,
>
> git://git.kernel.org/pub/scm/virt/kvm/kvm-unit-tests.git
>
> Changes from v3:
> * Ported all register_ioport functions to memory API
>
> Changes from v2:
>
> * Rename struct testdev to PCTestdev
> * Embed ioport_data into PCTestdev struct
> * Porting most register_ioport functions to memory API
>
> Changes from v1:
>
> * Removed unused testdev member
> * Renamed device to a less generic name, pc-testdev
>
> Initial changes from initial attempt:
>
> * Removed port 0xf1, since now kvm-unit-tests use
>   serial
> * Removed exit code port 0xf4, since that can be
>   replaced by
>
> -device isa-debugexit,iobase=0xf4,access-size=4
>
> * Removed ram size port 0xd1, since guest memory
>   size can be retrieved from firmware, there's a
>   patch for kvm-unit-tests including an API to
>   retrieve that value.
>
> CC: Paolo Bonzini <pbonzini@redhat.com>
> Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
> Signed-off-by: Avi Kivity <avi@redhat.com>
> Signed-off-by: Marcelo Tosatti <mtosatti@redhat.com>
> Signed-off-by: Lucas Meneghel Rodrigues <lmr@redhat.com>
> ---
>  hw/i386/Makefile.objs |   1 +
>  hw/pc-testdev.c       | 167 ++++++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 168 insertions(+)
>  create mode 100644 hw/pc-testdev.c
>
> diff --git a/hw/i386/Makefile.objs b/hw/i386/Makefile.objs
> index b34c61c..3ef3b4a 100644
> --- a/hw/i386/Makefile.objs
> +++ b/hw/i386/Makefile.objs
> @@ -11,5 +11,6 @@ obj-$(CONFIG_XEN_PCI_PASSTHROUGH) += xen-host-pci-device.o
>  obj-$(CONFIG_XEN_PCI_PASSTHROUGH) += xen_pt.o xen_pt_config_init.o xen_pt_msi.o
>  obj-y += kvm/
>  obj-$(CONFIG_SPICE) += qxl.o qxl-logger.o qxl-render.o
> +obj-y += pc-testdev.o
>
>  obj-y := $(addprefix ../,$(obj-y))
> diff --git a/hw/pc-testdev.c b/hw/pc-testdev.c
> new file mode 100644
> index 0000000..d326e01
> --- /dev/null
> +++ b/hw/pc-testdev.c
> @@ -0,0 +1,167 @@
> +/*
> + * QEMU x86 ISA testdev
> + *
> + * Copyright (c) 2012 Avi Kivity, Gerd Hoffmann, Marcelo Tosatti
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a copy
> + * of this software and associated documentation files (the "Software"), to deal
> + * in the Software without restriction, including without limitation the rights
> + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> + * copies of the Software, and to permit persons to whom the Software is
> + * furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice shall be included in
> + * all copies or substantial portions of the Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
> + * THE SOFTWARE.
> + */
> +
> +/*
> + * This device is used to test KVM features specific to the x86 port, such
> + * as emulation, power management, interrupt routing, among others. It's meant
> + * to be used like:
> + *
> + * qemu-system-x86_64 -device pc-testdev -serial stdio \
> + * -device isa-debugexit,iobase=0xf4,access-size=2 \
> + * -kernel /home/lmr/Code/virt-test.git/kvm/unittests/msr.flat
> + *
> + * Where msr.flat is one of the KVM unittests, present on a separate repo,
> + * git://git.kernel.org/pub/scm/virt/kvm/kvm-unit-tests.git
> +*/
> +
> +#include <sys/mman.h>
> +#include "hw.h"
> +#include "qdev.h"
> +#include "isa.h"
> +#include "exec-memory.h"
> +
> +typedef struct PCTestdev {
> +    ISADevice dev;
> +    MemoryRegion iomem;
> +    uint32_t ioport_data;
> +} PCTestdev;
> +
> +#define TYPE_TESTDEV "pc-testdev"
> +#define TESTDEV(obj) \
> +     OBJECT_CHECK(struct PCTestdev, (obj), TYPE_TESTDEV)
> +
> +static void test_device_irq_line(void *opaque, uint32_t addr, uint32_t data)
> +{
> +    struct PCTestdev *dev = opaque;
> +    qemu_set_irq(isa_get_irq(&dev->dev, addr - 0x2000), !!data);
> +}
> +
> +static void test_device_ioport_write(void *opaque, uint32_t addr, uint32_t data)
> +{
> +    struct PCTestdev *dev = opaque;
> +    dev->ioport_data = data;
> +}
> +
> +static uint32_t test_device_ioport_read(void *opaque, uint32_t addr)
> +{
> +    struct PCTestdev *dev = opaque;
> +    return dev->ioport_data;
> +}
> +
> +static void test_device_flush_page(void *opaque, uint32_t addr, uint32_t data)
> +{
> +    target_phys_addr_t len = 4096;
> +    void *a = cpu_physical_memory_map(data & ~0xffful, &len, 0);
> +
> +    mprotect(a, 4096, PROT_NONE);
> +    mprotect(a, 4096, PROT_READ|PROT_WRITE);
> +    cpu_physical_memory_unmap(a, len, 0, 0);
> +}
> +
> +static char *iomem_buf;

Please pass the allocated buffer as opaque for the accessors.

> +
> +static uint32_t test_iomem_readb(void *opaque, target_phys_addr_t addr)
> +{
> +    return iomem_buf[addr];
> +}
> +
> +static uint32_t test_iomem_readw(void *opaque, target_phys_addr_t addr)
> +{
> +    return *(uint16_t*)(iomem_buf + addr);
> +}
> +
> +static uint32_t test_iomem_readl(void *opaque, target_phys_addr_t addr)
> +{
> +    return *(uint32_t*)(iomem_buf + addr);
> +}
> +
> +static void test_iomem_writeb(void *opaque, target_phys_addr_t addr, uint32_t val)
> +{
> +    iomem_buf[addr] = val;
> +}
> +
> +static void test_iomem_writew(void *opaque, target_phys_addr_t addr, uint32_t val)
> +{
> +    *(uint16_t*)(iomem_buf + addr) = val;
> +}
> +
> +static void test_iomem_writel(void *opaque, target_phys_addr_t addr, uint32_t val)
> +{
> +    *(uint32_t*)(iomem_buf + addr) = val;
> +}
> +
> +static const MemoryRegionOps test_iomem_ops = {
> +    .old_mmio = {
> +        .read = { test_iomem_readb, test_iomem_readw, test_iomem_readl, },
> +        .write = { test_iomem_writeb, test_iomem_writew, test_iomem_writel, },
> +    },
> +    .endianness = DEVICE_LITTLE_ENDIAN,
> +};
> +
> +static const MemoryRegionPortio test_dev_portio_list[] = {
> +    { 0xe0, 1, 1, .read = test_device_ioport_read, .write = test_device_ioport_write, },
> +    { 0xe0, 1, 2, .read = test_device_ioport_read, .write = test_device_ioport_write, },
> +    { 0xe0, 1, 4, .read = test_device_ioport_read, .write = test_device_ioport_write, },
> +    { 0xe4, 1, 4, .write = test_device_flush_page, },
> +    { 0x2000, 24, 1, .write = test_device_irq_line, },
> +    PORTIO_END_OF_LIST(),
> +};
> +
> +static int init_test_device(ISADevice *isa)
> +{
> +    struct PCTestdev *dev = DO_UPCAST(struct PCTestdev, dev, isa);
> +
> +    PortioList *test_dev_port_list = g_new(PortioList, 1);
> +    portio_list_init(test_dev_port_list, test_dev_portio_list,
> +                     NULL, "pc-testdev");
> +    portio_list_add(test_dev_port_list, get_system_io(), 0x0);
> +
> +    iomem_buf = g_malloc0(0x10000);
> +    memory_region_init_io(&dev->iomem, &test_iomem_ops, dev,
> +                          "pc-testdev", 0x10000);
> +    memory_region_add_subregion(isa_address_space(&dev->dev), 0xff000000,
> +                                                  &dev->iomem);
> +    return 0;
> +}
> +
> +static void testdev_class_init(ObjectClass *klass, void *data)
> +{
> +    ISADeviceClass *k = ISA_DEVICE_CLASS(klass);
> +
> +    k->init = init_test_device;
> +}
> +
> +static TypeInfo testdev_info = {

const

> +    .name           = "pc-testdev",
> +    .parent         = TYPE_ISA_DEVICE,
> +    .instance_size  = sizeof(struct PCTestdev),
> +    .class_init     = testdev_class_init,
> +};
> +
> +static void testdev_register_types(void)
> +{
> +    type_register_static(&testdev_info);
> +}
> +
> +type_init(testdev_register_types)
> --
> 1.7.11.4
>
>