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
361 lines
9.6 KiB
C
361 lines
9.6 KiB
C
/*-
|
|
* Copyright (c) 2015 iXsystems Inc.
|
|
* Copyright (c) 2017-2018 Jakub Klama <jceel@FreeBSD.org>
|
|
* All rights reserved.
|
|
*
|
|
* 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
|
|
* in this position and unchanged.
|
|
* 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 AUTHOR 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 AUTHOR 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.
|
|
*/
|
|
|
|
/*
|
|
* VirtIO filesystem passthrough using 9p protocol.
|
|
*/
|
|
|
|
#include <sys/cdefs.h>
|
|
__FBSDID("$FreeBSD$");
|
|
|
|
#include <sys/param.h>
|
|
#include <sys/linker_set.h>
|
|
#include <sys/uio.h>
|
|
#include <sys/capsicum.h>
|
|
|
|
#include <errno.h>
|
|
#include <fcntl.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <unistd.h>
|
|
#include <assert.h>
|
|
#include <pthread.h>
|
|
|
|
#include <lib9p.h>
|
|
#include <backend/fs.h>
|
|
|
|
#include "bhyverun.h"
|
|
#include "config.h"
|
|
#include "debug.h"
|
|
#include "pci_emul.h"
|
|
#include "virtio.h"
|
|
|
|
#define VT9P_MAX_IOV 128
|
|
#define VT9P_RINGSZ 256
|
|
#define VT9P_MAXTAGSZ 256
|
|
#define VT9P_CONFIGSPACESZ (VT9P_MAXTAGSZ + sizeof(uint16_t))
|
|
|
|
static int pci_vt9p_debug;
|
|
#define DPRINTF(params) if (pci_vt9p_debug) printf params
|
|
#define WPRINTF(params) printf params
|
|
|
|
/*
|
|
* Per-device softc
|
|
*/
|
|
struct pci_vt9p_softc {
|
|
struct virtio_softc vsc_vs;
|
|
struct vqueue_info vsc_vq;
|
|
pthread_mutex_t vsc_mtx;
|
|
uint64_t vsc_cfg;
|
|
uint64_t vsc_features;
|
|
char * vsc_rootpath;
|
|
struct pci_vt9p_config * vsc_config;
|
|
struct l9p_backend * vsc_fs_backend;
|
|
struct l9p_server * vsc_server;
|
|
struct l9p_connection * vsc_conn;
|
|
};
|
|
|
|
struct pci_vt9p_request {
|
|
struct pci_vt9p_softc * vsr_sc;
|
|
struct iovec * vsr_iov;
|
|
size_t vsr_niov;
|
|
size_t vsr_respidx;
|
|
size_t vsr_iolen;
|
|
uint16_t vsr_idx;
|
|
};
|
|
|
|
struct pci_vt9p_config {
|
|
uint16_t tag_len;
|
|
char tag[0];
|
|
} __attribute__((packed));
|
|
|
|
static int pci_vt9p_send(struct l9p_request *, const struct iovec *,
|
|
const size_t, const size_t, void *);
|
|
static void pci_vt9p_drop(struct l9p_request *, const struct iovec *, size_t,
|
|
void *);
|
|
static void pci_vt9p_reset(void *);
|
|
static void pci_vt9p_notify(void *, struct vqueue_info *);
|
|
static int pci_vt9p_cfgread(void *, int, int, uint32_t *);
|
|
static void pci_vt9p_neg_features(void *, uint64_t);
|
|
|
|
static struct virtio_consts vt9p_vi_consts = {
|
|
"vt9p", /* our name */
|
|
1, /* we support 1 virtqueue */
|
|
VT9P_CONFIGSPACESZ, /* config reg size */
|
|
pci_vt9p_reset, /* reset */
|
|
pci_vt9p_notify, /* device-wide qnotify */
|
|
pci_vt9p_cfgread, /* read virtio config */
|
|
NULL, /* write virtio config */
|
|
pci_vt9p_neg_features, /* apply negotiated features */
|
|
(1 << 0), /* our capabilities */
|
|
};
|
|
|
|
|
|
static void
|
|
pci_vt9p_reset(void *vsc)
|
|
{
|
|
struct pci_vt9p_softc *sc;
|
|
|
|
sc = vsc;
|
|
|
|
DPRINTF(("vt9p: device reset requested !\n"));
|
|
vi_reset_dev(&sc->vsc_vs);
|
|
}
|
|
|
|
static void
|
|
pci_vt9p_neg_features(void *vsc, uint64_t negotiated_features)
|
|
{
|
|
struct pci_vt9p_softc *sc = vsc;
|
|
|
|
sc->vsc_features = negotiated_features;
|
|
}
|
|
|
|
static int
|
|
pci_vt9p_cfgread(void *vsc, int offset, int size, uint32_t *retval)
|
|
{
|
|
struct pci_vt9p_softc *sc = vsc;
|
|
void *ptr;
|
|
|
|
ptr = (uint8_t *)sc->vsc_config + offset;
|
|
memcpy(retval, ptr, size);
|
|
return (0);
|
|
}
|
|
|
|
static int
|
|
pci_vt9p_get_buffer(struct l9p_request *req, struct iovec *iov, size_t *niov,
|
|
void *arg)
|
|
{
|
|
struct pci_vt9p_request *preq = req->lr_aux;
|
|
size_t n = preq->vsr_niov - preq->vsr_respidx;
|
|
|
|
memcpy(iov, preq->vsr_iov + preq->vsr_respidx,
|
|
n * sizeof(struct iovec));
|
|
*niov = n;
|
|
return (0);
|
|
}
|
|
|
|
static int
|
|
pci_vt9p_send(struct l9p_request *req, const struct iovec *iov,
|
|
const size_t niov, const size_t iolen, void *arg)
|
|
{
|
|
struct pci_vt9p_request *preq = req->lr_aux;
|
|
struct pci_vt9p_softc *sc = preq->vsr_sc;
|
|
|
|
preq->vsr_iolen = iolen;
|
|
|
|
pthread_mutex_lock(&sc->vsc_mtx);
|
|
vq_relchain(&sc->vsc_vq, preq->vsr_idx, preq->vsr_iolen);
|
|
vq_endchains(&sc->vsc_vq, 1);
|
|
pthread_mutex_unlock(&sc->vsc_mtx);
|
|
free(preq);
|
|
return (0);
|
|
}
|
|
|
|
static void
|
|
pci_vt9p_drop(struct l9p_request *req, const struct iovec *iov, size_t niov,
|
|
void *arg)
|
|
{
|
|
struct pci_vt9p_request *preq = req->lr_aux;
|
|
struct pci_vt9p_softc *sc = preq->vsr_sc;
|
|
|
|
pthread_mutex_lock(&sc->vsc_mtx);
|
|
vq_relchain(&sc->vsc_vq, preq->vsr_idx, 0);
|
|
vq_endchains(&sc->vsc_vq, 1);
|
|
pthread_mutex_unlock(&sc->vsc_mtx);
|
|
free(preq);
|
|
}
|
|
|
|
static void
|
|
pci_vt9p_notify(void *vsc, struct vqueue_info *vq)
|
|
{
|
|
struct iovec iov[VT9P_MAX_IOV];
|
|
struct pci_vt9p_softc *sc;
|
|
struct pci_vt9p_request *preq;
|
|
uint16_t idx, n, i;
|
|
uint16_t flags[VT9P_MAX_IOV];
|
|
|
|
sc = vsc;
|
|
|
|
while (vq_has_descs(vq)) {
|
|
n = vq_getchain(vq, &idx, iov, VT9P_MAX_IOV, flags);
|
|
preq = calloc(1, sizeof(struct pci_vt9p_request));
|
|
preq->vsr_sc = sc;
|
|
preq->vsr_idx = idx;
|
|
preq->vsr_iov = iov;
|
|
preq->vsr_niov = n;
|
|
preq->vsr_respidx = 0;
|
|
|
|
/* Count readable descriptors */
|
|
for (i = 0; i < n; i++) {
|
|
if (flags[i] & VRING_DESC_F_WRITE)
|
|
break;
|
|
|
|
preq->vsr_respidx++;
|
|
}
|
|
|
|
for (int i = 0; i < n; i++) {
|
|
DPRINTF(("vt9p: vt9p_notify(): desc%d base=%p, "
|
|
"len=%zu, flags=0x%04x\r\n", i, iov[i].iov_base,
|
|
iov[i].iov_len, flags[i]));
|
|
}
|
|
|
|
l9p_connection_recv(sc->vsc_conn, iov, preq->vsr_respidx, preq);
|
|
}
|
|
}
|
|
|
|
static int
|
|
pci_vt9p_legacy_config(nvlist_t *nvl, const char *opts)
|
|
{
|
|
char *sharename, *tofree, *token, *tokens;
|
|
|
|
if (opts == NULL)
|
|
return (0);
|
|
|
|
tokens = tofree = strdup(opts);
|
|
while ((token = strsep(&tokens, ",")) != NULL) {
|
|
if (strchr(token, '=') != NULL) {
|
|
if (sharename != NULL) {
|
|
EPRINTLN(
|
|
"virtio-9p: more than one share name given");
|
|
return (-1);
|
|
}
|
|
|
|
sharename = strsep(&token, "=");
|
|
set_config_value_node(nvl, "sharename", sharename);
|
|
set_config_value_node(nvl, "path", token);
|
|
} else
|
|
set_config_bool_node(nvl, token, true);
|
|
}
|
|
free(tofree);
|
|
return (0);
|
|
}
|
|
|
|
static int
|
|
pci_vt9p_init(struct vmctx *ctx, struct pci_devinst *pi, nvlist_t *nvl)
|
|
{
|
|
struct pci_vt9p_softc *sc;
|
|
const char *value;
|
|
const char *sharename;
|
|
int rootfd;
|
|
bool ro;
|
|
cap_rights_t rootcap;
|
|
|
|
ro = get_config_bool_node_default(nvl, "ro", false);
|
|
|
|
value = get_config_value_node(nvl, "path");
|
|
if (value == NULL) {
|
|
EPRINTLN("virtio-9p: path required");
|
|
return (1);
|
|
}
|
|
rootfd = open(value, O_DIRECTORY);
|
|
if (rootfd < 0) {
|
|
EPRINTLN("virtio-9p: failed to open '%s': %s", value,
|
|
strerror(errno));
|
|
return (-1);
|
|
}
|
|
|
|
sharename = get_config_value_node(nvl, "sharename");
|
|
if (sharename == NULL) {
|
|
EPRINTLN("virtio-9p: share name required");
|
|
return (1);
|
|
}
|
|
if (strlen(sharename) > VT9P_MAXTAGSZ) {
|
|
EPRINTLN("virtio-9p: share name too long");
|
|
return (1);
|
|
}
|
|
|
|
sc = calloc(1, sizeof(struct pci_vt9p_softc));
|
|
sc->vsc_config = calloc(1, sizeof(struct pci_vt9p_config) +
|
|
VT9P_MAXTAGSZ);
|
|
|
|
pthread_mutex_init(&sc->vsc_mtx, NULL);
|
|
|
|
cap_rights_init(&rootcap,
|
|
CAP_LOOKUP, CAP_ACL_CHECK, CAP_ACL_DELETE, CAP_ACL_GET,
|
|
CAP_ACL_SET, CAP_READ, CAP_WRITE, CAP_SEEK, CAP_FSTAT,
|
|
CAP_CREATE, CAP_FCHMODAT, CAP_FCHOWNAT, CAP_FTRUNCATE,
|
|
CAP_LINKAT_SOURCE, CAP_LINKAT_TARGET, CAP_MKDIRAT, CAP_MKNODAT,
|
|
CAP_PREAD, CAP_PWRITE, CAP_RENAMEAT_SOURCE, CAP_RENAMEAT_TARGET,
|
|
CAP_SEEK, CAP_SYMLINKAT, CAP_UNLINKAT, CAP_EXTATTR_DELETE,
|
|
CAP_EXTATTR_GET, CAP_EXTATTR_LIST, CAP_EXTATTR_SET,
|
|
CAP_FUTIMES, CAP_FSTATFS, CAP_FSYNC, CAP_FPATHCONF);
|
|
|
|
if (cap_rights_limit(rootfd, &rootcap) != 0)
|
|
return (1);
|
|
|
|
sc->vsc_config->tag_len = (uint16_t)strlen(sharename);
|
|
memcpy(sc->vsc_config->tag, sharename, sc->vsc_config->tag_len);
|
|
|
|
if (l9p_backend_fs_init(&sc->vsc_fs_backend, rootfd, ro) != 0) {
|
|
errno = ENXIO;
|
|
return (1);
|
|
}
|
|
|
|
if (l9p_server_init(&sc->vsc_server, sc->vsc_fs_backend) != 0) {
|
|
errno = ENXIO;
|
|
return (1);
|
|
}
|
|
|
|
if (l9p_connection_init(sc->vsc_server, &sc->vsc_conn) != 0) {
|
|
errno = EIO;
|
|
return (1);
|
|
}
|
|
|
|
sc->vsc_conn->lc_msize = L9P_MAX_IOV * PAGE_SIZE;
|
|
sc->vsc_conn->lc_lt.lt_get_response_buffer = pci_vt9p_get_buffer;
|
|
sc->vsc_conn->lc_lt.lt_send_response = pci_vt9p_send;
|
|
sc->vsc_conn->lc_lt.lt_drop_response = pci_vt9p_drop;
|
|
|
|
vi_softc_linkup(&sc->vsc_vs, &vt9p_vi_consts, sc, pi, &sc->vsc_vq);
|
|
sc->vsc_vs.vs_mtx = &sc->vsc_mtx;
|
|
sc->vsc_vq.vq_qsize = VT9P_RINGSZ;
|
|
|
|
/* initialize config space */
|
|
pci_set_cfgdata16(pi, PCIR_DEVICE, VIRTIO_DEV_9P);
|
|
pci_set_cfgdata16(pi, PCIR_VENDOR, VIRTIO_VENDOR);
|
|
pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_STORAGE);
|
|
pci_set_cfgdata16(pi, PCIR_SUBDEV_0, VIRTIO_ID_9P);
|
|
pci_set_cfgdata16(pi, PCIR_SUBVEND_0, VIRTIO_VENDOR);
|
|
|
|
if (vi_intr_init(&sc->vsc_vs, 1, fbsdrun_virtio_msix()))
|
|
return (1);
|
|
vi_set_io_bar(&sc->vsc_vs, 0);
|
|
|
|
return (0);
|
|
}
|
|
|
|
struct pci_devemu pci_de_v9p = {
|
|
.pe_emu = "virtio-9p",
|
|
.pe_legacy_config = pci_vt9p_legacy_config,
|
|
.pe_init = pci_vt9p_init,
|
|
.pe_barwrite = vi_pci_write,
|
|
.pe_barread = vi_pci_read
|
|
};
|
|
PCI_EMUL_SET(pci_de_v9p);
|