freebsd-dev/usr.sbin/bhyve/pctestdev.c
John Baldwin 621b509048 Refactor configuration management in bhyve.
Replace the existing ad-hoc configuration via various global variables
with a small database of key-value pairs.  The database supports
heirarchical keys using a MIB-like syntax to name the path to a given
key.  Values are always stored as strings.  The API used to manage
configuation values does include wrappers to handling boolean values.
Other values use non-string types require parsing by consumers.

The configuration values are stored in a tree using nvlists.  Leaf
nodes hold string values.  Configuration values are permitted to
reference other configuration values using '%(name)'.  This permits
constructing template configurations.

All existing command line arguments now set configuration values.  For
devices, the "-s" option parses its option argument to generate a list
of key-value pairs for the given device.

A new '-o' command line option permits setting an individual
configuration variable.  The key name is always given as a full path
of dot-separated components.

A new '-k' command line option parses a simple configuration file.
This configuration file holds a flat list of 'key=value' lines where
the 'key' is the full path of a configuration variable.  Lines
starting with a '#' are comments.

In general, bhyve starts by parsing command line options in sequence
and applying those settings to configuration values.  Once this is
complete, bhyve then begins initializing its state based on the
configuration values.  This means that subsequent configuration
options or files may override or supplement previously given settings.

A special 'config.dump' configuration value can be set to true to help
debug configuration issues.  When this value is set, bhyve will print
out the configuration variables as a flat list of 'key=value' lines.

Most command line argments map to a single configuration variable,
e.g.  '-w' sets the 'x86.strictmsr' value to false.  A few command
line arguments have less obvious effects:

- Multiple '-p' options append their values (as a comma-seperated
  list) to "vcpu.N.cpuset" values (where N is a decimal vcpu number).

- For '-s' options, a pci.<bus>.<slot>.<function> node is created.
  The first argument to '-s' (the device type) is used as the value of
  a "device" variable.  Additional comma-separated arguments are then
  parsed into 'key=value' pairs and used to set additional variables
  under the device node.  A PCI device emulation driver can provide
  its own hook to override the parsing of the additonal '-s' arguments
  after the device type.

  After the configuration phase as completed, the init_pci hook
  then walks the "pci.<bus>.<slot>.<func>" nodes.  It uses the
  "device" value to find the device model to use.  The device
  model's init routine is passed a reference to its nvlist node
  in the configuration tree which it can query for specific
  variables.

  The result is that a lot of the string parsing is removed from
  the device models and centralized.  In addition, adding a new
  variable just requires teaching the model to look for the new
  variable.

- For '-l' options, a similar model is used where the string is
  parsed into values that are later read during initialization.
  One key note here is that the serial ports use the commonly
  used lowercase names from existing documentation and examples
  (e.g. "lpc.com1") instead of the uppercase names previously
  used internally in bhyve.

Reviewed by:	grehan
MFC after:	3 months
Differential Revision:	https://reviews.freebsd.org/D26035
2021-03-18 16:30:26 -07:00

262 lines
6.2 KiB
C

/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 2020 Adam Fenn <adam@fenn.io>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* Emulation of selected legacy test/debug interfaces expected by KVM-unit-tests
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/types.h>
#include <sys/mman.h>
#include <machine/vmm.h>
#include <assert.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <vmmapi.h>
#include "debug.h"
#include "inout.h"
#include "mem.h"
#include "pctestdev.h"
#define DEBUGEXIT_BASE 0xf4
#define DEBUGEXIT_LEN 4
#define DEBUGEXIT_NAME "isa-debug-exit"
#define IOMEM_BASE 0xff000000
#define IOMEM_LEN 0x10000
#define IOMEM_NAME "pc-testdev-iomem"
#define IOPORT_BASE 0xe0
#define IOPORT_LEN 4
#define IOPORT_NAME "pc-testdev-ioport"
#define IRQ_BASE 0x2000
#define IRQ_IOAPIC_PINCOUNT_MIN 24
#define IRQ_IOAPIC_PINCOUNT_MAX 32
#define IRQ_NAME "pc-testdev-irq-line"
#define PCTESTDEV_NAME "pc-testdev"
static bool pctestdev_inited;
static uint8_t pctestdev_iomem_buf[IOMEM_LEN];
static uint32_t pctestdev_ioport_data;
static int pctestdev_debugexit_io(struct vmctx *ctx, int vcpu, int in,
int port, int bytes, uint32_t *eax, void *arg);
static int pctestdev_iomem_io(struct vmctx *ctx, int vcpu, int dir,
uint64_t addr, int size, uint64_t *val, void *arg1,
long arg2);
static int pctestdev_ioport_io(struct vmctx *ctx, int vcpu, int in,
int port, int bytes, uint32_t *eax, void *arg);
static int pctestdev_irq_io(struct vmctx *ctx, int vcpu, int in,
int port, int bytes, uint32_t *eax, void *arg);
const char *
pctestdev_getname(void)
{
return (PCTESTDEV_NAME);
}
int
pctestdev_init(struct vmctx *ctx)
{
struct mem_range iomem;
struct inout_port debugexit, ioport, irq;
int err, pincount;
if (pctestdev_inited) {
EPRINTLN("Only one pc-testdev device is allowed.");
return (-1);
}
err = vm_ioapic_pincount(ctx, &pincount);
if (err != 0) {
EPRINTLN("pc-testdev: Failed to obtain IOAPIC pin count.");
return (-1);
}
if (pincount < IRQ_IOAPIC_PINCOUNT_MIN ||
pincount > IRQ_IOAPIC_PINCOUNT_MAX) {
EPRINTLN("pc-testdev: Unsupported IOAPIC pin count: %d.",
pincount);
return (-1);
}
debugexit.name = DEBUGEXIT_NAME;
debugexit.port = DEBUGEXIT_BASE;
debugexit.size = DEBUGEXIT_LEN;
debugexit.flags = IOPORT_F_INOUT;
debugexit.handler = pctestdev_debugexit_io;
debugexit.arg = NULL;
iomem.name = IOMEM_NAME;
iomem.flags = MEM_F_RW | MEM_F_IMMUTABLE;
iomem.handler = pctestdev_iomem_io;
iomem.arg1 = NULL;
iomem.arg2 = 0;
iomem.base = IOMEM_BASE;
iomem.size = IOMEM_LEN;
ioport.name = IOPORT_NAME;
ioport.port = IOPORT_BASE;
ioport.size = IOPORT_LEN;
ioport.flags = IOPORT_F_INOUT;
ioport.handler = pctestdev_ioport_io;
ioport.arg = NULL;
irq.name = IRQ_NAME;
irq.port = IRQ_BASE;
irq.size = pincount;
irq.flags = IOPORT_F_INOUT;
irq.handler = pctestdev_irq_io;
irq.arg = NULL;
err = register_inout(&debugexit);
if (err != 0)
goto fail;
err = register_inout(&ioport);
if (err != 0)
goto fail_after_debugexit_reg;
err = register_inout(&irq);
if (err != 0)
goto fail_after_ioport_reg;
err = register_mem(&iomem);
if (err != 0)
goto fail_after_irq_reg;
pctestdev_inited = true;
return (0);
fail_after_irq_reg:
(void)unregister_inout(&irq);
fail_after_ioport_reg:
(void)unregister_inout(&ioport);
fail_after_debugexit_reg:
(void)unregister_inout(&debugexit);
fail:
return (err);
}
static int
pctestdev_debugexit_io(struct vmctx *ctx, int vcpu, int in, int port,
int bytes, uint32_t *eax, void *arg)
{
if (in)
*eax = 0;
else
exit((*eax << 1) | 1);
return (0);
}
static int
pctestdev_iomem_io(struct vmctx *ctx, int vcpu, int dir, uint64_t addr,
int size, uint64_t *val, void *arg1, long arg2)
{
uint64_t offset;
if (addr + size > IOMEM_BASE + IOMEM_LEN)
return (-1);
offset = addr - IOMEM_BASE;
if (dir == MEM_F_READ) {
(void)memcpy(val, pctestdev_iomem_buf + offset, size);
} else {
assert(dir == MEM_F_WRITE);
(void)memcpy(pctestdev_iomem_buf + offset, val, size);
}
return (0);
}
static int
pctestdev_ioport_io(struct vmctx *ctx, int vcpu, int in, int port,
int bytes, uint32_t *eax, void *arg)
{
uint32_t mask;
int lsb;
if (port + bytes > IOPORT_BASE + IOPORT_LEN)
return (-1);
lsb = (port & 0x3) * 8;
mask = (-1UL >> (32 - (bytes * 8))) << lsb;
if (in)
*eax = (pctestdev_ioport_data & mask) >> lsb;
else {
pctestdev_ioport_data &= ~mask;
pctestdev_ioport_data |= *eax << lsb;
}
return (0);
}
static int
pctestdev_irq_io(struct vmctx *ctx, int vcpu, int in, int port, int bytes,
uint32_t *eax, void *arg)
{
int irq;
if (bytes != 1)
return (-1);
if (in) {
*eax = 0;
return (0);
} else {
irq = port - IRQ_BASE;
if (irq < 16) {
if (*eax)
return (vm_isa_assert_irq(ctx, irq, irq));
else
return (vm_isa_deassert_irq(ctx, irq, irq));
} else {
if (*eax)
return (vm_ioapic_assert_irq(ctx, irq));
else
return (vm_ioapic_deassert_irq(ctx, irq));
}
}
}