usr.sbin/bhyve/virtio.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2013  Chris Torek <torek @ torek net>
   5  * All rights reserved.
   6  * Copyright (c) 2019 Joyent, Inc.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  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 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include <sys/param.h>
  34 #include <sys/uio.h>
  35
  36 #include <machine/atomic.h>
  37 #include <machine/vmm_snapshot.h>
  38
  39 #include <dev/virtio/pci/virtio_pci_legacy_var.h>
  40
  41 #include <stdio.h>
  42 #include <stdint.h>
  43 #include <string.h>
  44 #include <pthread.h>
  45 #include <pthread_np.h>
  46
  47 #include "bhyverun.h"
  48 #include "debug.h"
  49 #include "pci_emul.h"
  50 #include "virtio.h"
  51
  52 /*
  53  * Functions for dealing with generalized "virtual devices" as
  54  * defined by <https://www.google.com/#output=search&q=virtio+spec>
  55  */
  56
  57 /*
  58  * In case we decide to relax the "virtio softc comes at the
  59  * front of virtio-based device softc" constraint, let's use
  60  * this to convert.
  61  */
  62 #define DEV_SOFTC(vs) ((void *)(vs))
  63
  64 /*
  65  * Link a virtio_softc to its constants, the device softc, and
  66  * the PCI emulation.
  67  */
  68 void
  69 vi_softc_linkup(struct virtio_softc *vs, struct virtio_consts *vc,
  70                 void *dev_softc, struct pci_devinst *pi,
  71                 struct vqueue_info *queues)
  72 {
  73         int i;
  74
  75         /* vs and dev_softc addresses must match */
  76         assert((void *)vs == dev_softc);
  77         vs->vs_vc = vc;
  78         vs->vs_pi = pi;
  79         pi->pi_arg = vs;
  80
  81         vs->vs_queues = queues;
  82         for (i = 0; i < vc->vc_nvq; i++) {
  83                 queues[i].vq_vs = vs;
  84                 queues[i].vq_num = i;
  85         }
  86 }
  87
  88 /*
  89  * Reset device (device-wide).  This erases all queues, i.e.,
  90  * all the queues become invalid (though we don't wipe out the
  91  * internal pointers, we just clear the VQ_ALLOC flag).
  92  *
  93  * It resets negotiated features to "none".
  94  *
  95  * If MSI-X is enabled, this also resets all the vectors to NO_VECTOR.
  96  */
  97 void
  98 vi_reset_dev(struct virtio_softc *vs)
  99 {
 100         struct vqueue_info *vq;
 101         int i, nvq;
 102
 103         if (vs->vs_mtx)
 104                 assert(pthread_mutex_isowned_np(vs->vs_mtx));
 105
 106         nvq = vs->vs_vc->vc_nvq;
 107         for (vq = vs->vs_queues, i = 0; i < nvq; vq++, i++) {
 108                 vq->vq_flags = 0;
 109                 vq->vq_last_avail = 0;
 110                 vq->vq_next_used = 0;
 111                 vq->vq_save_used = 0;
 112                 vq->vq_pfn = 0;
 113                 vq->vq_msix_idx = VIRTIO_MSI_NO_VECTOR;
 114         }
 115         vs->vs_negotiated_caps = 0;
 116         vs->vs_curq = 0;
 117         /* vs->vs_status = 0; -- redundant */
 118         if (vs->vs_isr)
 119                 pci_lintr_deassert(vs->vs_pi);
 120         vs->vs_isr = 0;
 121         vs->vs_msix_cfg_idx = VIRTIO_MSI_NO_VECTOR;
 122 }
 123
 124 /*
 125  * Set I/O BAR (usually 0) to map PCI config registers.
 126  */
 127 void
 128 vi_set_io_bar(struct virtio_softc *vs, int barnum)
 129 {
 130         size_t size;
 131
 132         /*
 133          * ??? should we use VIRTIO_PCI_CONFIG_OFF(0) if MSI-X is disabled?
 134          * Existing code did not...
 135          */
 136         size = VIRTIO_PCI_CONFIG_OFF(1) + vs->vs_vc->vc_cfgsize;
 137         pci_emul_alloc_bar(vs->vs_pi, barnum, PCIBAR_IO, size);
 138 }
 139
 140 /*
 141  * Initialize MSI-X vector capabilities if we're to use MSI-X,
 142  * or MSI capabilities if not.
 143  *
 144  * We assume we want one MSI-X vector per queue, here, plus one
 145  * for the config vec.
 146  */
 147 int
 148 vi_intr_init(struct virtio_softc *vs, int barnum, int use_msix)
 149 {
 150         int nvec;
 151
 152         if (use_msix) {
 153                 vs->vs_flags |= VIRTIO_USE_MSIX;
 154                 VS_LOCK(vs);
 155                 vi_reset_dev(vs); /* set all vectors to NO_VECTOR */
 156                 VS_UNLOCK(vs);
 157                 nvec = vs->vs_vc->vc_nvq + 1;
 158                 if (pci_emul_add_msixcap(vs->vs_pi, nvec, barnum))
 159                         return (1);
 160         } else
 161                 vs->vs_flags &= ~VIRTIO_USE_MSIX;
 162
 163         /* Only 1 MSI vector for bhyve */
 164         pci_emul_add_msicap(vs->vs_pi, 1);
 165
 166         /* Legacy interrupts are mandatory for virtio devices */
 167         pci_lintr_request(vs->vs_pi);
 168
 169         return (0);
 170 }
 171
 172 /*
 173  * Initialize the currently-selected virtio queue (vs->vs_curq).
 174  * The guest just gave us a page frame number, from which we can
 175  * calculate the addresses of the queue.
 176  */
 177 static void
 178 vi_vq_init(struct virtio_softc *vs, uint32_t pfn)
 179 {
 180         struct vqueue_info *vq;
 181         uint64_t phys;
 182         size_t size;
 183         char *base;
 184
 185         vq = &vs->vs_queues[vs->vs_curq];
 186         vq->vq_pfn = pfn;
 187         phys = (uint64_t)pfn << VRING_PFN;
 188         size = vring_size_aligned(vq->vq_qsize);
 189         base = paddr_guest2host(vs->vs_pi->pi_vmctx, phys, size);
 190
 191         /* First page(s) are descriptors... */
 192         vq->vq_desc = (struct vring_desc *)base;
 193         base += vq->vq_qsize * sizeof(struct vring_desc);
 194
 195         /* ... immediately followed by "avail" ring (entirely uint16_t's) */
 196         vq->vq_avail = (struct vring_avail *)base;
 197         base += (2 + vq->vq_qsize + 1) * sizeof(uint16_t);
 198
 199         /* Then it's rounded up to the next page... */
 200         base = (char *)roundup2((uintptr_t)base, VRING_ALIGN);
 201
 202         /* ... and the last page(s) are the used ring. */
 203         vq->vq_used = (struct vring_used *)base;
 204
 205         /* Mark queue as allocated, and start at 0 when we use it. */
 206         vq->vq_flags = VQ_ALLOC;
 207         vq->vq_last_avail = 0;
 208         vq->vq_next_used = 0;
 209         vq->vq_save_used = 0;
 210 }
 211
 212 /*
 213  * Helper inline for vq_getchain(): record the i'th "real"
 214  * descriptor.
 215  */
 216 static inline void
 217 _vq_record(int i, struct vring_desc *vd, struct vmctx *ctx, struct iovec *iov,
 218     int n_iov, struct vi_req *reqp)
 219 {
 220         if (i >= n_iov)
 221                 return;
 222         iov[i].iov_base = paddr_guest2host(ctx, vd->addr, vd->len);
 223         iov[i].iov_len = vd->len;
 224         if ((vd->flags & VRING_DESC_F_WRITE) == 0)
 225                 reqp->readable++;
 226         else
 227                 reqp->writable++;
 228 }
 229 #define VQ_MAX_DESCRIPTORS      512     /* see below */
 230
 231 /*
 232  * Examine the chain of descriptors starting at the "next one" to
 233  * make sure that they describe a sensible request.  If so, return
 234  * the number of "real" descriptors that would be needed/used in
 235  * acting on this request.  This may be smaller than the number of
 236  * available descriptors, e.g., if there are two available but
 237  * they are two separate requests, this just returns 1.  Or, it
 238  * may be larger: if there are indirect descriptors involved,
 239  * there may only be one descriptor available but it may be an
 240  * indirect pointing to eight more.  We return 8 in this case,
 241  * i.e., we do not count the indirect descriptors, only the "real"
 242  * ones.
 243  *
 244  * Basically, this vets the "flags" and "next" field of each
 245  * descriptor and tells you how many are involved.  Since some may
 246  * be indirect, this also needs the vmctx (in the pci_devinst
 247  * at vs->vs_pi) so that it can find indirect descriptors.
 248  *
 249  * As we process each descriptor, we copy and adjust it (guest to
 250  * host address wise, also using the vmtctx) into the given iov[]
 251  * array (of the given size).  If the array overflows, we stop
 252  * placing values into the array but keep processing descriptors,
 253  * up to VQ_MAX_DESCRIPTORS, before giving up and returning -1.
 254  * So you, the caller, must not assume that iov[] is as big as the
 255  * return value (you can process the same thing twice to allocate
 256  * a larger iov array if needed, or supply a zero length to find
 257  * out how much space is needed).
 258  *
 259  * If some descriptor(s) are invalid, this prints a diagnostic message
 260  * and returns -1.  If no descriptors are ready now it simply returns 0.
 261  *
 262  * You are assumed to have done a vq_ring_ready() if needed (note
 263  * that vq_has_descs() does one).
 264  */
 265 int
 266 vq_getchain(struct vqueue_info *vq, struct iovec *iov, int niov,
 267             struct vi_req *reqp)
 268 {
 269         int i;
 270         u_int ndesc, n_indir;
 271         u_int idx, next;
 272         struct vi_req req;
 273         struct vring_desc *vdir, *vindir, *vp;
 274         struct vmctx *ctx;
 275         struct virtio_softc *vs;
 276         const char *name;
 277
 278         vs = vq->vq_vs;
 279         name = vs->vs_vc->vc_name;
 280         memset(&req, 0, sizeof(req));
 281
 282         /*
 283          * Note: it's the responsibility of the guest not to
 284          * update vq->vq_avail->idx until all of the descriptors
 285          * the guest has written are valid (including all their
 286          * "next" fields and "flags").
 287          *
 288          * Compute (vq_avail->idx - last_avail) in integers mod 2**16.  This is
 289          * the number of descriptors the device has made available
 290          * since the last time we updated vq->vq_last_avail.
 291          *
 292          * We just need to do the subtraction as an unsigned int,
 293          * then trim off excess bits.
 294          */
 295         idx = vq->vq_last_avail;
 296         ndesc = (uint16_t)((u_int)vq->vq_avail->idx - idx);
 297         if (ndesc == 0)
 298                 return (0);
 299         if (ndesc > vq->vq_qsize) {
 300                 /* XXX need better way to diagnose issues */
 301                 EPRINTLN(
 302                     "%s: ndesc (%u) out of range, driver confused?",
 303                     name, (u_int)ndesc);
 304                 return (-1);
 305         }
 306
 307         /*
 308          * Now count/parse "involved" descriptors starting from
 309          * the head of the chain.
 310          *
 311          * To prevent loops, we could be more complicated and
 312          * check whether we're re-visiting a previously visited
 313          * index, but we just abort if the count gets excessive.
 314          */
 315         ctx = vs->vs_pi->pi_vmctx;
 316         req.idx = next = vq->vq_avail->ring[idx & (vq->vq_qsize - 1)];
 317         vq->vq_last_avail++;
 318         for (i = 0; i < VQ_MAX_DESCRIPTORS; next = vdir->next) {
 319                 if (next >= vq->vq_qsize) {
 320                         EPRINTLN(
 321                             "%s: descriptor index %u out of range, "
 322                             "driver confused?",
 323                             name, next);
 324                         return (-1);
 325                 }
 326                 vdir = &vq->vq_desc[next];
 327                 if ((vdir->flags & VRING_DESC_F_INDIRECT) == 0) {
 328                         _vq_record(i, vdir, ctx, iov, niov, &req);
 329                         i++;
 330                 } else if ((vs->vs_vc->vc_hv_caps &
 331                     VIRTIO_RING_F_INDIRECT_DESC) == 0) {
 332                         EPRINTLN(
 333                             "%s: descriptor has forbidden INDIRECT flag, "
 334                             "driver confused?",
 335                             name);
 336                         return (-1);
 337                 } else {
 338                         n_indir = vdir->len / 16;
 339                         if ((vdir->len & 0xf) || n_indir == 0) {
 340                                 EPRINTLN(
 341                                     "%s: invalid indir len 0x%x, "
 342                                     "driver confused?",
 343                                     name, (u_int)vdir->len);
 344                                 return (-1);
 345                         }
 346                         vindir = paddr_guest2host(ctx,
 347                             vdir->addr, vdir->len);
 348                         /*
 349                          * Indirects start at the 0th, then follow
 350                          * their own embedded "next"s until those run
 351                          * out.  Each one's indirect flag must be off
 352                          * (we don't really have to check, could just
 353                          * ignore errors...).
 354                          */
 355                         next = 0;
 356                         for (;;) {
 357                                 vp = &vindir[next];
 358                                 if (vp->flags & VRING_DESC_F_INDIRECT) {
 359                                         EPRINTLN(
 360                                             "%s: indirect desc has INDIR flag,"
 361                                             " driver confused?",
 362                                             name);
 363                                         return (-1);
 364                                 }
 365                                 _vq_record(i, vp, ctx, iov, niov, &req);
 366                                 if (++i > VQ_MAX_DESCRIPTORS)
 367                                         goto loopy;
 368                                 if ((vp->flags & VRING_DESC_F_NEXT) == 0)
 369                                         break;
 370                                 next = vp->next;
 371                                 if (next >= n_indir) {
 372                                         EPRINTLN(
 373                                             "%s: invalid next %u > %u, "
 374                                             "driver confused?",
 375                                             name, (u_int)next, n_indir);
 376                                         return (-1);
 377                                 }
 378                         }
 379                 }
 380                 if ((vdir->flags & VRING_DESC_F_NEXT) == 0)
 381                         goto done;
 382         }
 383
 384 loopy:
 385         EPRINTLN(
 386             "%s: descriptor loop? count > %d - driver confused?",
 387             name, i);
 388         return (-1);
 389
 390 done:
 391         *reqp = req;
 392         return (i);
 393 }
 394
 395 /*
 396  * Return the first n_chain request chains back to the available queue.
 397  *
 398  * (These chains are the ones you handled when you called vq_getchain()
 399  * and used its positive return value.)
 400  */
 401 void
 402 vq_retchains(struct vqueue_info *vq, uint16_t n_chains)
 403 {
 404
 405         vq->vq_last_avail -= n_chains;
 406 }
 407
 408 void
 409 vq_relchain_prepare(struct vqueue_info *vq, uint16_t idx, uint32_t iolen)
 410 {
 411         struct vring_used *vuh;
 412         struct vring_used_elem *vue;
 413         uint16_t mask;
 414
 415         /*
 416          * Notes:
 417          *  - mask is N-1 where N is a power of 2 so computes x % N
 418          *  - vuh points to the "used" data shared with guest
 419          *  - vue points to the "used" ring entry we want to update
 420          */
 421         mask = vq->vq_qsize - 1;
 422         vuh = vq->vq_used;
 423
 424         vue = &vuh->ring[vq->vq_next_used++ & mask];
 425         vue->id = idx;
 426         vue->len = iolen;
 427 }
 428
 429 void
 430 vq_relchain_publish(struct vqueue_info *vq)
 431 {
 432         /*
 433          * Ensure the used descriptor is visible before updating the index.
 434          * This is necessary on ISAs with memory ordering less strict than x86
 435          * (and even on x86 to act as a compiler barrier).
 436          */
 437         atomic_thread_fence_rel();
 438         vq->vq_used->idx = vq->vq_next_used;
 439 }
 440
 441 /*
 442  * Return specified request chain to the guest, setting its I/O length
 443  * to the provided value.
 444  *
 445  * (This chain is the one you handled when you called vq_getchain()
 446  * and used its positive return value.)
 447  */
 448 void
 449 vq_relchain(struct vqueue_info *vq, uint16_t idx, uint32_t iolen)
 450 {
 451         vq_relchain_prepare(vq, idx, iolen);
 452         vq_relchain_publish(vq);
 453 }
 454
 455 /*
 456  * Driver has finished processing "available" chains and calling
 457  * vq_relchain on each one.  If driver used all the available
 458  * chains, used_all should be set.
 459  *
 460  * If the "used" index moved we may need to inform the guest, i.e.,
 461  * deliver an interrupt.  Even if the used index did NOT move we
 462  * may need to deliver an interrupt, if the avail ring is empty and
 463  * we are supposed to interrupt on empty.
 464  *
 465  * Note that used_all_avail is provided by the caller because it's
 466  * a snapshot of the ring state when he decided to finish interrupt
 467  * processing -- it's possible that descriptors became available after
 468  * that point.  (It's also typically a constant 1/True as well.)
 469  */
 470 void
 471 vq_endchains(struct vqueue_info *vq, int used_all_avail)
 472 {
 473         struct virtio_softc *vs;
 474         uint16_t event_idx, new_idx, old_idx;
 475         int intr;
 476
 477         /*
 478          * Interrupt generation: if we're using EVENT_IDX,
 479          * interrupt if we've crossed the event threshold.
 480          * Otherwise interrupt is generated if we added "used" entries,
 481          * but suppressed by VRING_AVAIL_F_NO_INTERRUPT.
 482          *
 483          * In any case, though, if NOTIFY_ON_EMPTY is set and the
 484          * entire avail was processed, we need to interrupt always.
 485          */
 486         vs = vq->vq_vs;
 487         old_idx = vq->vq_save_used;
 488         vq->vq_save_used = new_idx = vq->vq_used->idx;
 489
 490         /*
 491          * Use full memory barrier between "idx" store from preceding
 492          * vq_relchain() call and the loads from VQ_USED_EVENT_IDX() or
 493          * "flags" field below.
 494          */
 495         atomic_thread_fence_seq_cst();
 496         if (used_all_avail &&
 497             (vs->vs_negotiated_caps & VIRTIO_F_NOTIFY_ON_EMPTY))
 498                 intr = 1;
 499         else if (vs->vs_negotiated_caps & VIRTIO_RING_F_EVENT_IDX) {
 500                 event_idx = VQ_USED_EVENT_IDX(vq);
 501                 /*
 502                  * This calculation is per docs and the kernel
 503                  * (see src/sys/dev/virtio/virtio_ring.h).
 504                  */
 505                 intr = (uint16_t)(new_idx - event_idx - 1) <
 506                         (uint16_t)(new_idx - old_idx);
 507         } else {
 508                 intr = new_idx != old_idx &&
 509                     !(vq->vq_avail->flags & VRING_AVAIL_F_NO_INTERRUPT);
 510         }
 511         if (intr)
 512                 vq_interrupt(vs, vq);
 513 }
 514
 515 /* Note: these are in sorted order to make for a fast search */
 516 static struct config_reg {
 517         uint16_t        cr_offset;      /* register offset */
 518         uint8_t         cr_size;        /* size (bytes) */
 519         uint8_t         cr_ro;          /* true => reg is read only */
 520         const char      *cr_name;       /* name of reg */
 521 } config_regs[] = {
 522         { VIRTIO_PCI_HOST_FEATURES,     4, 1, "HOST_FEATURES" },
 523         { VIRTIO_PCI_GUEST_FEATURES,    4, 0, "GUEST_FEATURES" },
 524         { VIRTIO_PCI_QUEUE_PFN,         4, 0, "QUEUE_PFN" },
 525         { VIRTIO_PCI_QUEUE_NUM,         2, 1, "QUEUE_NUM" },
 526         { VIRTIO_PCI_QUEUE_SEL,         2, 0, "QUEUE_SEL" },
 527         { VIRTIO_PCI_QUEUE_NOTIFY,      2, 0, "QUEUE_NOTIFY" },
 528         { VIRTIO_PCI_STATUS,            1, 0, "STATUS" },
 529         { VIRTIO_PCI_ISR,               1, 0, "ISR" },
 530         { VIRTIO_MSI_CONFIG_VECTOR,     2, 0, "CONFIG_VECTOR" },
 531         { VIRTIO_MSI_QUEUE_VECTOR,      2, 0, "QUEUE_VECTOR" },
 532 };
 533
 534 static inline struct config_reg *
 535 vi_find_cr(int offset) {
 536         u_int hi, lo, mid;
 537         struct config_reg *cr;
 538
 539         lo = 0;
 540         hi = sizeof(config_regs) / sizeof(*config_regs) - 1;
 541         while (hi >= lo) {
 542                 mid = (hi + lo) >> 1;
 543                 cr = &config_regs[mid];
 544                 if (cr->cr_offset == offset)
 545                         return (cr);
 546                 if (cr->cr_offset < offset)
 547                         lo = mid + 1;
 548                 else
 549                         hi = mid - 1;
 550         }
 551         return (NULL);
 552 }
 553
 554 /*
 555  * Handle pci config space reads.
 556  * If it's to the MSI-X info, do that.
 557  * If it's part of the virtio standard stuff, do that.
 558  * Otherwise dispatch to the actual driver.
 559  */
 560 uint64_t
 561 vi_pci_read(struct vmctx *ctx __unused,
 562     struct pci_devinst *pi, int baridx, uint64_t offset, int size)
 563 {
 564         struct virtio_softc *vs = pi->pi_arg;
 565         struct virtio_consts *vc;
 566         struct config_reg *cr;
 567         uint64_t virtio_config_size, max;
 568         const char *name;
 569         uint32_t newoff;
 570         uint32_t value;
 571         int error;
 572
 573         if (vs->vs_flags & VIRTIO_USE_MSIX) {
 574                 if (baridx == pci_msix_table_bar(pi) ||
 575                     baridx == pci_msix_pba_bar(pi)) {
 576                         return (pci_emul_msix_tread(pi, offset, size));
 577                 }
 578         }
 579
 580         /* XXX probably should do something better than just assert() */
 581         assert(baridx == 0);
 582
 583         if (vs->vs_mtx)
 584                 pthread_mutex_lock(vs->vs_mtx);
 585
 586         vc = vs->vs_vc;
 587         name = vc->vc_name;
 588         value = size == 1 ? 0xff : size == 2 ? 0xffff : 0xffffffff;
 589
 590         if (size != 1 && size != 2 && size != 4)
 591                 goto bad;
 592
 593         virtio_config_size = VIRTIO_PCI_CONFIG_OFF(pci_msix_enabled(pi));
 594
 595         if (offset >= virtio_config_size) {
 596                 /*
 597                  * Subtract off the standard size (including MSI-X
 598                  * registers if enabled) and dispatch to underlying driver.
 599                  * If that fails, fall into general code.
 600                  */
 601                 newoff = offset - virtio_config_size;
 602                 max = vc->vc_cfgsize ? vc->vc_cfgsize : 0x100000000;
 603                 if (newoff + size > max)
 604                         goto bad;
 605                 if (vc->vc_cfgread != NULL)
 606                         error = (*vc->vc_cfgread)(DEV_SOFTC(vs), newoff, size, &value);
 607                 else
 608                         error = 0;
 609                 if (!error)
 610                         goto done;
 611         }
 612
 613 bad:
 614         cr = vi_find_cr(offset);
 615         if (cr == NULL || cr->cr_size != size) {
 616                 if (cr != NULL) {
 617                         /* offset must be OK, so size must be bad */
 618                         EPRINTLN(
 619                             "%s: read from %s: bad size %d",
 620                             name, cr->cr_name, size);
 621                 } else {
 622                         EPRINTLN(
 623                             "%s: read from bad offset/size %jd/%d",
 624                             name, (uintmax_t)offset, size);
 625                 }
 626                 goto done;
 627         }
 628
 629         switch (offset) {
 630         case VIRTIO_PCI_HOST_FEATURES:
 631                 value = vc->vc_hv_caps;
 632                 break;
 633         case VIRTIO_PCI_GUEST_FEATURES:
 634                 value = vs->vs_negotiated_caps;
 635                 break;
 636         case VIRTIO_PCI_QUEUE_PFN:
 637                 if (vs->vs_curq < vc->vc_nvq)
 638                         value = vs->vs_queues[vs->vs_curq].vq_pfn;
 639                 break;
 640         case VIRTIO_PCI_QUEUE_NUM:
 641                 value = vs->vs_curq < vc->vc_nvq ?
 642                     vs->vs_queues[vs->vs_curq].vq_qsize : 0;
 643                 break;
 644         case VIRTIO_PCI_QUEUE_SEL:
 645                 value = vs->vs_curq;
 646                 break;
 647         case VIRTIO_PCI_QUEUE_NOTIFY:
 648                 value = 0;      /* XXX */
 649                 break;
 650         case VIRTIO_PCI_STATUS:
 651                 value = vs->vs_status;
 652                 break;
 653         case VIRTIO_PCI_ISR:
 654                 value = vs->vs_isr;
 655                 vs->vs_isr = 0;         /* a read clears this flag */
 656                 if (value)
 657                         pci_lintr_deassert(pi);
 658                 break;
 659         case VIRTIO_MSI_CONFIG_VECTOR:
 660                 value = vs->vs_msix_cfg_idx;
 661                 break;
 662         case VIRTIO_MSI_QUEUE_VECTOR:
 663                 value = vs->vs_curq < vc->vc_nvq ?
 664                     vs->vs_queues[vs->vs_curq].vq_msix_idx :
 665                     VIRTIO_MSI_NO_VECTOR;
 666                 break;
 667         }
 668 done:
 669         if (vs->vs_mtx)
 670                 pthread_mutex_unlock(vs->vs_mtx);
 671         return (value);
 672 }
 673
 674 /*
 675  * Handle pci config space writes.
 676  * If it's to the MSI-X info, do that.
 677  * If it's part of the virtio standard stuff, do that.
 678  * Otherwise dispatch to the actual driver.
 679  */
 680 void
 681 vi_pci_write(struct vmctx *ctx __unused,
 682     struct pci_devinst *pi, int baridx, uint64_t offset, int size,
 683     uint64_t value)
 684 {
 685         struct virtio_softc *vs = pi->pi_arg;
 686         struct vqueue_info *vq;
 687         struct virtio_consts *vc;
 688         struct config_reg *cr;
 689         uint64_t virtio_config_size, max;
 690         const char *name;
 691         uint32_t newoff;
 692         int error;
 693
 694         if (vs->vs_flags & VIRTIO_USE_MSIX) {
 695                 if (baridx == pci_msix_table_bar(pi) ||
 696                     baridx == pci_msix_pba_bar(pi)) {
 697                         pci_emul_msix_twrite(pi, offset, size, value);
 698                         return;
 699                 }
 700         }
 701
 702         /* XXX probably should do something better than just assert() */
 703         assert(baridx == 0);
 704
 705         if (vs->vs_mtx)
 706                 pthread_mutex_lock(vs->vs_mtx);
 707
 708         vc = vs->vs_vc;
 709         name = vc->vc_name;
 710
 711         if (size != 1 && size != 2 && size != 4)
 712                 goto bad;
 713
 714         virtio_config_size = VIRTIO_PCI_CONFIG_OFF(pci_msix_enabled(pi));
 715
 716         if (offset >= virtio_config_size) {
 717                 /*
 718                  * Subtract off the standard size (including MSI-X
 719                  * registers if enabled) and dispatch to underlying driver.
 720                  */
 721                 newoff = offset - virtio_config_size;
 722                 max = vc->vc_cfgsize ? vc->vc_cfgsize : 0x100000000;
 723                 if (newoff + size > max)
 724                         goto bad;
 725                 if (vc->vc_cfgwrite != NULL)
 726                         error = (*vc->vc_cfgwrite)(DEV_SOFTC(vs), newoff, size, value);
 727                 else
 728                         error = 0;
 729                 if (!error)
 730                         goto done;
 731         }
 732
 733 bad:
 734         cr = vi_find_cr(offset);
 735         if (cr == NULL || cr->cr_size != size || cr->cr_ro) {
 736                 if (cr != NULL) {
 737                         /* offset must be OK, wrong size and/or reg is R/O */
 738                         if (cr->cr_size != size)
 739                                 EPRINTLN(
 740                                     "%s: write to %s: bad size %d",
 741                                     name, cr->cr_name, size);
 742                         if (cr->cr_ro)
 743                                 EPRINTLN(
 744                                     "%s: write to read-only reg %s",
 745                                     name, cr->cr_name);
 746                 } else {
 747                         EPRINTLN(
 748                             "%s: write to bad offset/size %jd/%d",
 749                             name, (uintmax_t)offset, size);
 750                 }
 751                 goto done;
 752         }
 753
 754         switch (offset) {
 755         case VIRTIO_PCI_GUEST_FEATURES:
 756                 vs->vs_negotiated_caps = value & vc->vc_hv_caps;
 757                 if (vc->vc_apply_features)
 758                         (*vc->vc_apply_features)(DEV_SOFTC(vs),
 759                             vs->vs_negotiated_caps);
 760                 break;
 761         case VIRTIO_PCI_QUEUE_PFN:
 762                 if (vs->vs_curq >= vc->vc_nvq)
 763                         goto bad_qindex;
 764                 vi_vq_init(vs, value);
 765                 break;
 766         case VIRTIO_PCI_QUEUE_SEL:
 767                 /*
 768                  * Note that the guest is allowed to select an
 769                  * invalid queue; we just need to return a QNUM
 770                  * of 0 while the bad queue is selected.
 771                  */
 772                 vs->vs_curq = value;
 773                 break;
 774         case VIRTIO_PCI_QUEUE_NOTIFY:
 775                 if (value >= (unsigned int)vc->vc_nvq) {
 776                         EPRINTLN("%s: queue %d notify out of range",
 777                                 name, (int)value);
 778                         goto done;
 779                 }
 780                 vq = &vs->vs_queues[value];
 781                 if (vq->vq_notify)
 782                         (*vq->vq_notify)(DEV_SOFTC(vs), vq);
 783                 else if (vc->vc_qnotify)
 784                         (*vc->vc_qnotify)(DEV_SOFTC(vs), vq);
 785                 else
 786                         EPRINTLN(
 787                             "%s: qnotify queue %d: missing vq/vc notify",
 788                                 name, (int)value);
 789                 break;
 790         case VIRTIO_PCI_STATUS:
 791                 vs->vs_status = value;
 792                 if (value == 0)
 793                         (*vc->vc_reset)(DEV_SOFTC(vs));
 794                 break;
 795         case VIRTIO_MSI_CONFIG_VECTOR:
 796                 vs->vs_msix_cfg_idx = value;
 797                 break;
 798         case VIRTIO_MSI_QUEUE_VECTOR:
 799                 if (vs->vs_curq >= vc->vc_nvq)
 800                         goto bad_qindex;
 801                 vq = &vs->vs_queues[vs->vs_curq];
 802                 vq->vq_msix_idx = value;
 803                 break;
 804         }
 805         goto done;
 806
 807 bad_qindex:
 808         EPRINTLN(
 809             "%s: write config reg %s: curq %d >= max %d",
 810             name, cr->cr_name, vs->vs_curq, vc->vc_nvq);
 811 done:
 812         if (vs->vs_mtx)
 813                 pthread_mutex_unlock(vs->vs_mtx);
 814 }
 815
 816 #ifdef BHYVE_SNAPSHOT
 817 int
 818 vi_pci_pause(struct vmctx *ctx __unused, struct pci_devinst *pi)
 819 {
 820         struct virtio_softc *vs;
 821         struct virtio_consts *vc;
 822
 823         vs = pi->pi_arg;
 824         vc = vs->vs_vc;
 825
 826         vc = vs->vs_vc;
 827         assert(vc->vc_pause != NULL);
 828         (*vc->vc_pause)(DEV_SOFTC(vs));
 829
 830         return (0);
 831 }
 832
 833 int
 834 vi_pci_resume(struct vmctx *ctx __unused, struct pci_devinst *pi)
 835 {
 836         struct virtio_softc *vs;
 837         struct virtio_consts *vc;
 838
 839         vs = pi->pi_arg;
 840         vc = vs->vs_vc;
 841
 842         vc = vs->vs_vc;
 843         assert(vc->vc_resume != NULL);
 844         (*vc->vc_resume)(DEV_SOFTC(vs));
 845
 846         return (0);
 847 }
 848
 849 static int
 850 vi_pci_snapshot_softc(struct virtio_softc *vs, struct vm_snapshot_meta *meta)
 851 {
 852         int ret;
 853
 854         SNAPSHOT_VAR_OR_LEAVE(vs->vs_flags, meta, ret, done);
 855         SNAPSHOT_VAR_OR_LEAVE(vs->vs_negotiated_caps, meta, ret, done);
 856         SNAPSHOT_VAR_OR_LEAVE(vs->vs_curq, meta, ret, done);
 857         SNAPSHOT_VAR_OR_LEAVE(vs->vs_status, meta, ret, done);
 858         SNAPSHOT_VAR_OR_LEAVE(vs->vs_isr, meta, ret, done);
 859         SNAPSHOT_VAR_OR_LEAVE(vs->vs_msix_cfg_idx, meta, ret, done);
 860
 861 done:
 862         return (ret);
 863 }
 864
 865 static int
 866 vi_pci_snapshot_consts(struct virtio_consts *vc, struct vm_snapshot_meta *meta)
 867 {
 868         int ret;
 869
 870         SNAPSHOT_VAR_CMP_OR_LEAVE(vc->vc_nvq, meta, ret, done);
 871         SNAPSHOT_VAR_CMP_OR_LEAVE(vc->vc_cfgsize, meta, ret, done);
 872         SNAPSHOT_VAR_CMP_OR_LEAVE(vc->vc_hv_caps, meta, ret, done);
 873
 874 done:
 875         return (ret);
 876 }
 877
 878 static int
 879 vi_pci_snapshot_queues(struct virtio_softc *vs, struct vm_snapshot_meta *meta)
 880 {
 881         int i;
 882         int ret;
 883         struct virtio_consts *vc;
 884         struct vqueue_info *vq;
 885         uint64_t addr_size;
 886
 887         vc = vs->vs_vc;
 888
 889         /* Save virtio queue info */
 890         for (i = 0; i < vc->vc_nvq; i++) {
 891                 vq = &vs->vs_queues[i];
 892
 893                 SNAPSHOT_VAR_CMP_OR_LEAVE(vq->vq_qsize, meta, ret, done);
 894                 SNAPSHOT_VAR_CMP_OR_LEAVE(vq->vq_num, meta, ret, done);
 895
 896                 SNAPSHOT_VAR_OR_LEAVE(vq->vq_flags, meta, ret, done);
 897                 SNAPSHOT_VAR_OR_LEAVE(vq->vq_last_avail, meta, ret, done);
 898                 SNAPSHOT_VAR_OR_LEAVE(vq->vq_next_used, meta, ret, done);
 899                 SNAPSHOT_VAR_OR_LEAVE(vq->vq_save_used, meta, ret, done);
 900                 SNAPSHOT_VAR_OR_LEAVE(vq->vq_msix_idx, meta, ret, done);
 901
 902                 SNAPSHOT_VAR_OR_LEAVE(vq->vq_pfn, meta, ret, done);
 903
 904                 if (!vq_ring_ready(vq))
 905                         continue;
 906
 907                 addr_size = vq->vq_qsize * sizeof(struct vring_desc);
 908                 SNAPSHOT_GUEST2HOST_ADDR_OR_LEAVE(vq->vq_desc, addr_size,
 909                         false, meta, ret, done);
 910
 911                 addr_size = (2 + vq->vq_qsize + 1) * sizeof(uint16_t);
 912                 SNAPSHOT_GUEST2HOST_ADDR_OR_LEAVE(vq->vq_avail, addr_size,
 913                         false, meta, ret, done);
 914
 915                 addr_size  = (2 + 2 * vq->vq_qsize + 1) * sizeof(uint16_t);
 916                 SNAPSHOT_GUEST2HOST_ADDR_OR_LEAVE(vq->vq_used, addr_size,
 917                         false, meta, ret, done);
 918
 919                 SNAPSHOT_BUF_OR_LEAVE(vq->vq_desc,
 920                         vring_size_aligned(vq->vq_qsize), meta, ret, done);
 921         }
 922
 923 done:
 924         return (ret);
 925 }
 926
 927 int
 928 vi_pci_snapshot(struct vm_snapshot_meta *meta)
 929 {
 930         int ret;
 931         struct pci_devinst *pi;
 932         struct virtio_softc *vs;
 933         struct virtio_consts *vc;
 934
 935         pi = meta->dev_data;
 936         vs = pi->pi_arg;
 937         vc = vs->vs_vc;
 938
 939         /* Save virtio softc */
 940         ret = vi_pci_snapshot_softc(vs, meta);
 941         if (ret != 0)
 942                 goto done;
 943
 944         /* Save virtio consts */
 945         ret = vi_pci_snapshot_consts(vc, meta);
 946         if (ret != 0)
 947                 goto done;
 948
 949         /* Save virtio queue info */
 950         ret = vi_pci_snapshot_queues(vs, meta);
 951         if (ret != 0)
 952                 goto done;
 953
 954         /* Save device softc, if needed */
 955         if (vc->vc_snapshot != NULL) {
 956                 ret = (*vc->vc_snapshot)(DEV_SOFTC(vs), meta);
 957                 if (ret != 0)
 958                         goto done;
 959         }
 960
 961 done:
 962         return (ret);
 963 }
 964 #endif