usr.sbin/bhyve/pci_virtio_rnd.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2014 Nahanni Systems Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer
  12  *    in this position and unchanged.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 /*
  31  * virtio entropy device emulation.
  32  * Randomness is sourced from /dev/random which does not block
  33  * once it has been seeded at bootup.
  34  */
  35
  36 #include <sys/cdefs.h>
  37 __FBSDID("$FreeBSD$");
  38
  39 #include <sys/param.h>
  40 #ifndef WITHOUT_CAPSICUM
  41 #include <sys/capsicum.h>
  42 #endif
  43 #include <sys/linker_set.h>
  44 #include <sys/uio.h>
  45
  46 #ifndef WITHOUT_CAPSICUM
  47 #include <capsicum_helpers.h>
  48 #endif
  49 #include <err.h>
  50 #include <errno.h>
  51 #include <fcntl.h>
  52 #include <stdio.h>
  53 #include <stdlib.h>
  54 #include <string.h>
  55 #include <unistd.h>
  56 #include <assert.h>
  57 #include <pthread.h>
  58 #include <sysexits.h>
  59
  60 #include "bhyverun.h"
  61 #include "pci_emul.h"
  62 #include "virtio.h"
  63
  64 #define VTRND_RINGSZ    64
  65
  66
  67 static int pci_vtrnd_debug;
  68 #define DPRINTF(params) if (pci_vtrnd_debug) printf params
  69 #define WPRINTF(params) printf params
  70
  71 /*
  72  * Per-device softc
  73  */
  74 struct pci_vtrnd_softc {
  75         struct virtio_softc vrsc_vs;
  76         struct vqueue_info  vrsc_vq;
  77         pthread_mutex_t     vrsc_mtx;
  78         uint64_t            vrsc_cfg;
  79         int                 vrsc_fd;
  80 };
  81
  82 static void pci_vtrnd_reset(void *);
  83 static void pci_vtrnd_notify(void *, struct vqueue_info *);
  84
  85 static struct virtio_consts vtrnd_vi_consts = {
  86         "vtrnd",                /* our name */
  87         1,                      /* we support 1 virtqueue */
  88         0,                      /* config reg size */
  89         pci_vtrnd_reset,        /* reset */
  90         pci_vtrnd_notify,       /* device-wide qnotify */
  91         NULL,                   /* read virtio config */
  92         NULL,                   /* write virtio config */
  93         NULL,                   /* apply negotiated features */
  94         0,                      /* our capabilities */
  95 };
  96
  97
  98 static void
  99 pci_vtrnd_reset(void *vsc)
 100 {
 101         struct pci_vtrnd_softc *sc;
 102
 103         sc = vsc;
 104
 105         DPRINTF(("vtrnd: device reset requested !\n"));
 106         vi_reset_dev(&sc->vrsc_vs);
 107 }
 108
 109
 110 static void
 111 pci_vtrnd_notify(void *vsc, struct vqueue_info *vq)
 112 {
 113         struct iovec iov;
 114         struct pci_vtrnd_softc *sc;
 115         int len;
 116         uint16_t idx;
 117
 118         sc = vsc;
 119
 120         if (sc->vrsc_fd < 0) {
 121                 vq_endchains(vq, 0);
 122                 return;
 123         }
 124
 125         while (vq_has_descs(vq)) {
 126                 vq_getchain(vq, &idx, &iov, 1, NULL);
 127
 128                 len = read(sc->vrsc_fd, iov.iov_base, iov.iov_len);
 129
 130                 DPRINTF(("vtrnd: vtrnd_notify(): %d\r\n", len));
 131
 132                 /* Catastrophe if unable to read from /dev/random */
 133                 assert(len > 0);
 134
 135                 /*
 136                  * Release this chain and handle more
 137                  */
 138                 vq_relchain(vq, idx, len);
 139         }
 140         vq_endchains(vq, 1);    /* Generate interrupt if appropriate. */
 141 }
 142
 143
 144 static int
 145 pci_vtrnd_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
 146 {
 147         struct pci_vtrnd_softc *sc;
 148         int fd;
 149         int len;
 150         uint8_t v;
 151 #ifndef WITHOUT_CAPSICUM
 152         cap_rights_t rights;
 153 #endif
 154
 155         /*
 156          * Should always be able to open /dev/random.
 157          */
 158         fd = open("/dev/random", O_RDONLY | O_NONBLOCK);
 159
 160         assert(fd >= 0);
 161
 162 #ifndef WITHOUT_CAPSICUM
 163         cap_rights_init(&rights, CAP_READ);
 164         if (caph_rights_limit(fd, &rights) == -1)
 165                 errx(EX_OSERR, "Unable to apply rights for sandbox");
 166 #endif
 167
 168         /*
 169          * Check that device is seeded and non-blocking.
 170          */
 171         len = read(fd, &v, sizeof(v));
 172         if (len <= 0) {
 173                 WPRINTF(("vtrnd: /dev/random not ready, read(): %d", len));
 174                 close(fd);
 175                 return (1);
 176         }
 177
 178         sc = calloc(1, sizeof(struct pci_vtrnd_softc));
 179
 180         vi_softc_linkup(&sc->vrsc_vs, &vtrnd_vi_consts, sc, pi, &sc->vrsc_vq);
 181         sc->vrsc_vs.vs_mtx = &sc->vrsc_mtx;
 182
 183         sc->vrsc_vq.vq_qsize = VTRND_RINGSZ;
 184
 185         /* keep /dev/random opened while emulating */
 186         sc->vrsc_fd = fd;
 187
 188         /* initialize config space */
 189         pci_set_cfgdata16(pi, PCIR_DEVICE, VIRTIO_DEV_RANDOM);
 190         pci_set_cfgdata16(pi, PCIR_VENDOR, VIRTIO_VENDOR);
 191         pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_CRYPTO);
 192         pci_set_cfgdata16(pi, PCIR_SUBDEV_0, VIRTIO_TYPE_ENTROPY);
 193         pci_set_cfgdata16(pi, PCIR_SUBVEND_0, VIRTIO_VENDOR);
 194
 195         if (vi_intr_init(&sc->vrsc_vs, 1, fbsdrun_virtio_msix()))
 196                 return (1);
 197         vi_set_io_bar(&sc->vrsc_vs, 0);
 198
 199         return (0);
 200 }
 201
 202
 203 struct pci_devemu pci_de_vrnd = {
 204         .pe_emu =       "virtio-rnd",
 205         .pe_init =      pci_vtrnd_init,
 206         .pe_barwrite =  vi_pci_write,
 207         .pe_barread =   vi_pci_read
 208 };
 209 PCI_EMUL_SET(pci_de_vrnd);