1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2013 Chris Torek <torek @ torek net> 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 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _VIRTIO_H_ 32 #define _VIRTIO_H_ 33 34 #include <pthread_np.h> 35 36 /* 37 * These are derived from several virtio specifications. 38 * 39 * Some useful links: 40 * https://github.com/rustyrussell/virtio-spec 41 * http://people.redhat.com/pbonzini/virtio-spec.pdf 42 */ 43 44 /* 45 * A virtual device has zero or more "virtual queues" (virtqueue). 46 * Each virtqueue uses at least two 4096-byte pages, laid out thus: 47 * 48 * +-----------------------------------------------+ 49 * | "desc": <N> descriptors, 16 bytes each | 50 * | ----------------------------------------- | 51 * | "avail": 2 uint16; <N> uint16; 1 uint16 | 52 * | ----------------------------------------- | 53 * | pad to 4k boundary | 54 * +-----------------------------------------------+ 55 * | "used": 2 x uint16; <N> elems; 1 uint16 | 56 * | ----------------------------------------- | 57 * | pad to 4k boundary | 58 * +-----------------------------------------------+ 59 * 60 * The number <N> that appears here is always a power of two and is 61 * limited to no more than 32768 (as it must fit in a 16-bit field). 62 * If <N> is sufficiently large, the above will occupy more than 63 * two pages. In any case, all pages must be physically contiguous 64 * within the guest's physical address space. 65 * 66 * The <N> 16-byte "desc" descriptors consist of a 64-bit guest 67 * physical address <addr>, a 32-bit length <len>, a 16-bit 68 * <flags>, and a 16-bit <next> field (all in guest byte order). 69 * 70 * There are three flags that may be set : 71 * NEXT descriptor is chained, so use its "next" field 72 * WRITE descriptor is for host to write into guest RAM 73 * (else host is to read from guest RAM) 74 * INDIRECT descriptor address field is (guest physical) 75 * address of a linear array of descriptors 76 * 77 * Unless INDIRECT is set, <len> is the number of bytes that may 78 * be read/written from guest physical address <addr>. If 79 * INDIRECT is set, WRITE is ignored and <len> provides the length 80 * of the indirect descriptors (and <len> must be a multiple of 81 * 16). Note that NEXT may still be set in the main descriptor 82 * pointing to the indirect, and should be set in each indirect 83 * descriptor that uses the next descriptor (these should generally 84 * be numbered sequentially). However, INDIRECT must not be set 85 * in the indirect descriptors. Upon reaching an indirect descriptor 86 * without a NEXT bit, control returns to the direct descriptors. 87 * 88 * Except inside an indirect, each <next> value must be in the 89 * range [0 .. N) (i.e., the half-open interval). (Inside an 90 * indirect, each <next> must be in the range [0 .. <len>/16).) 91 * 92 * The "avail" data structures reside in the same pages as the 93 * "desc" structures since both together are used by the device to 94 * pass information to the hypervisor's virtual driver. These 95 * begin with a 16-bit <flags> field and 16-bit index <idx>, then 96 * have <N> 16-bit <ring> values, followed by one final 16-bit 97 * field <used_event>. The <N> <ring> entries are simply indices 98 * indices into the descriptor ring (and thus must meet the same 99 * constraints as each <next> value). However, <idx> is counted 100 * up from 0 (initially) and simply wraps around after 65535; it 101 * is taken mod <N> to find the next available entry. 102 * 103 * The "used" ring occupies a separate page or pages, and contains 104 * values written from the virtual driver back to the guest OS. 105 * This begins with a 16-bit <flags> and 16-bit <idx>, then there 106 * are <N> "vring_used" elements, followed by a 16-bit <avail_event>. 107 * The <N> "vring_used" elements consist of a 32-bit <id> and a 108 * 32-bit <len> (vu_tlen below). The <id> is simply the index of 109 * the head of a descriptor chain the guest made available 110 * earlier, and the <len> is the number of bytes actually written, 111 * e.g., in the case of a network driver that provided a large 112 * receive buffer but received only a small amount of data. 113 * 114 * The two event fields, <used_event> and <avail_event>, in the 115 * avail and used rings (respectively -- note the reversal!), are 116 * always provided, but are used only if the virtual device 117 * negotiates the VIRTIO_RING_F_EVENT_IDX feature during feature 118 * negotiation. Similarly, both rings provide a flag -- 119 * VRING_AVAIL_F_NO_INTERRUPT and VRING_USED_F_NO_NOTIFY -- in 120 * their <flags> field, indicating that the guest does not need an 121 * interrupt, or that the hypervisor driver does not need a 122 * notify, when descriptors are added to the corresponding ring. 123 * (These are provided only for interrupt optimization and need 124 * not be implemented.) 125 */ 126 #define VRING_ALIGN 4096 127 128 #define VRING_DESC_F_NEXT (1 << 0) 129 #define VRING_DESC_F_WRITE (1 << 1) 130 #define VRING_DESC_F_INDIRECT (1 << 2) 131 132 struct virtio_desc { /* AKA vring_desc */ 133 uint64_t vd_addr; /* guest physical address */ 134 uint32_t vd_len; /* length of scatter/gather seg */ 135 uint16_t vd_flags; /* VRING_F_DESC_* */ 136 uint16_t vd_next; /* next desc if F_NEXT */ 137 } __packed; 138 139 struct virtio_used { /* AKA vring_used_elem */ 140 uint32_t vu_idx; /* head of used descriptor chain */ 141 uint32_t vu_tlen; /* length written-to */ 142 } __packed; 143 144 #define VRING_AVAIL_F_NO_INTERRUPT 1 145 146 struct vring_avail { 147 uint16_t va_flags; /* VRING_AVAIL_F_* */ 148 uint16_t va_idx; /* counts to 65535, then cycles */ 149 uint16_t va_ring[]; /* size N, reported in QNUM value */ 150 /* uint16_t va_used_event; -- after N ring entries */ 151 } __packed; 152 153 #define VRING_USED_F_NO_NOTIFY 1 154 struct vring_used { 155 uint16_t vu_flags; /* VRING_USED_F_* */ 156 uint16_t vu_idx; /* counts to 65535, then cycles */ 157 struct virtio_used vu_ring[]; /* size N */ 158 /* uint16_t vu_avail_event; -- after N ring entries */ 159 } __packed; 160 161 /* 162 * The address of any given virtual queue is determined by a single 163 * Page Frame Number register. The guest writes the PFN into the 164 * PCI config space. However, a device that has two or more 165 * virtqueues can have a different PFN, and size, for each queue. 166 * The number of queues is determinable via the PCI config space 167 * VTCFG_R_QSEL register. Writes to QSEL select the queue: 0 means 168 * queue #0, 1 means queue#1, etc. Once a queue is selected, the 169 * remaining PFN and QNUM registers refer to that queue. 170 * 171 * QNUM is a read-only register containing a nonzero power of two 172 * that indicates the (hypervisor's) queue size. Or, if reading it 173 * produces zero, the hypervisor does not have a corresponding 174 * queue. (The number of possible queues depends on the virtual 175 * device. The block device has just one; the network device 176 * provides either two -- 0 = receive, 1 = transmit -- or three, 177 * with 2 = control.) 178 * 179 * PFN is a read/write register giving the physical page address of 180 * the virtqueue in guest memory (the guest must allocate enough space 181 * based on the hypervisor's provided QNUM). 182 * 183 * QNOTIFY is effectively write-only: when the guest writes a queue 184 * number to the register, the hypervisor should scan the specified 185 * virtqueue. (Reading QNOTIFY currently always gets 0). 186 */ 187 188 /* 189 * PFN register shift amount 190 */ 191 #define VRING_PFN 12 192 193 /* 194 * Virtio device types 195 * 196 * XXX Should really be merged with <dev/virtio/virtio.h> defines 197 */ 198 #define VIRTIO_TYPE_NET 1 199 #define VIRTIO_TYPE_BLOCK 2 200 #define VIRTIO_TYPE_CONSOLE 3 201 #define VIRTIO_TYPE_ENTROPY 4 202 #define VIRTIO_TYPE_BALLOON 5 203 #define VIRTIO_TYPE_IOMEMORY 6 204 #define VIRTIO_TYPE_RPMSG 7 205 #define VIRTIO_TYPE_SCSI 8 206 #define VIRTIO_TYPE_9P 9 207 208 /* experimental IDs start at 65535 and work down */ 209 210 /* 211 * PCI vendor/device IDs 212 */ 213 #define VIRTIO_VENDOR 0x1AF4 214 #define VIRTIO_DEV_NET 0x1000 215 #define VIRTIO_DEV_BLOCK 0x1001 216 #define VIRTIO_DEV_CONSOLE 0x1003 217 #define VIRTIO_DEV_RANDOM 0x1005 218 #define VIRTIO_DEV_SCSI 0x1008 219 220 /* 221 * PCI config space constants. 222 * 223 * If MSI-X is enabled, the ISR register is generally not used, 224 * and the configuration vector and queue vector appear at offsets 225 * 20 and 22 with the remaining configuration registers at 24. 226 * If MSI-X is not enabled, those two registers disappear and 227 * the remaining configuration registers start at offset 20. 228 */ 229 #define VTCFG_R_HOSTCAP 0 230 #define VTCFG_R_GUESTCAP 4 231 #define VTCFG_R_PFN 8 232 #define VTCFG_R_QNUM 12 233 #define VTCFG_R_QSEL 14 234 #define VTCFG_R_QNOTIFY 16 235 #define VTCFG_R_STATUS 18 236 #define VTCFG_R_ISR 19 237 #define VTCFG_R_CFGVEC 20 238 #define VTCFG_R_QVEC 22 239 #define VTCFG_R_CFG0 20 /* No MSI-X */ 240 #define VTCFG_R_CFG1 24 /* With MSI-X */ 241 #define VTCFG_R_MSIX 20 242 243 /* 244 * Bits in VTCFG_R_STATUS. Guests need not actually set any of these, 245 * but a guest writing 0 to this register means "please reset". 246 */ 247 #define VTCFG_STATUS_ACK 0x01 /* guest OS has acknowledged dev */ 248 #define VTCFG_STATUS_DRIVER 0x02 /* guest OS driver is loaded */ 249 #define VTCFG_STATUS_DRIVER_OK 0x04 /* guest OS driver ready */ 250 #define VTCFG_STATUS_FAILED 0x80 /* guest has given up on this dev */ 251 252 /* 253 * Bits in VTCFG_R_ISR. These apply only if not using MSI-X. 254 * 255 * (We don't [yet?] ever use CONF_CHANGED.) 256 */ 257 #define VTCFG_ISR_QUEUES 0x01 /* re-scan queues */ 258 #define VTCFG_ISR_CONF_CHANGED 0x80 /* configuration changed */ 259 260 #define VIRTIO_MSI_NO_VECTOR 0xFFFF 261 262 /* 263 * Feature flags. 264 * Note: bits 0 through 23 are reserved to each device type. 265 */ 266 #define VIRTIO_F_NOTIFY_ON_EMPTY (1 << 24) 267 #define VIRTIO_RING_F_INDIRECT_DESC (1 << 28) 268 #define VIRTIO_RING_F_EVENT_IDX (1 << 29) 269 270 /* From section 2.3, "Virtqueue Configuration", of the virtio specification */ 271 static inline size_t 272 vring_size(u_int qsz) 273 { 274 size_t size; 275 276 /* constant 3 below = va_flags, va_idx, va_used_event */ 277 size = sizeof(struct virtio_desc) * qsz + sizeof(uint16_t) * (3 + qsz); 278 size = roundup2(size, VRING_ALIGN); 279 280 /* constant 3 below = vu_flags, vu_idx, vu_avail_event */ 281 size += sizeof(uint16_t) * 3 + sizeof(struct virtio_used) * qsz; 282 size = roundup2(size, VRING_ALIGN); 283 284 return (size); 285 } 286 287 struct vmctx; 288 struct pci_devinst; 289 struct vqueue_info; 290 291 /* 292 * A virtual device, with some number (possibly 0) of virtual 293 * queues and some size (possibly 0) of configuration-space 294 * registers private to the device. The virtio_softc should come 295 * at the front of each "derived class", so that a pointer to the 296 * virtio_softc is also a pointer to the more specific, derived- 297 * from-virtio driver's softc. 298 * 299 * Note: inside each hypervisor virtio driver, changes to these 300 * data structures must be locked against other threads, if any. 301 * Except for PCI config space register read/write, we assume each 302 * driver does the required locking, but we need a pointer to the 303 * lock (if there is one) for PCI config space read/write ops. 304 * 305 * When the guest reads or writes the device's config space, the 306 * generic layer checks for operations on the special registers 307 * described above. If the offset of the register(s) being read 308 * or written is past the CFG area (CFG0 or CFG1), the request is 309 * passed on to the virtual device, after subtracting off the 310 * generic-layer size. (So, drivers can just use the offset as 311 * an offset into "struct config", for instance.) 312 * 313 * (The virtio layer also makes sure that the read or write is to/ 314 * from a "good" config offset, hence vc_cfgsize, and on BAR #0. 315 * However, the driver must verify the read or write size and offset 316 * and that no one is writing a readonly register.) 317 * 318 * The BROKED flag ("this thing done gone and broked") is for future 319 * use. 320 */ 321 #define VIRTIO_USE_MSIX 0x01 322 #define VIRTIO_EVENT_IDX 0x02 /* use the event-index values */ 323 #define VIRTIO_BROKED 0x08 /* ??? */ 324 325 struct virtio_softc { 326 struct virtio_consts *vs_vc; /* constants (see below) */ 327 int vs_flags; /* VIRTIO_* flags from above */ 328 pthread_mutex_t *vs_mtx; /* POSIX mutex, if any */ 329 struct pci_devinst *vs_pi; /* PCI device instance */ 330 uint32_t vs_negotiated_caps; /* negotiated capabilities */ 331 struct vqueue_info *vs_queues; /* one per vc_nvq */ 332 int vs_curq; /* current queue */ 333 uint8_t vs_status; /* value from last status write */ 334 uint8_t vs_isr; /* ISR flags, if not MSI-X */ 335 uint16_t vs_msix_cfg_idx; /* MSI-X vector for config event */ 336 }; 337 338 #define VS_LOCK(vs) \ 339 do { \ 340 if (vs->vs_mtx) \ 341 pthread_mutex_lock(vs->vs_mtx); \ 342 } while (0) 343 344 #define VS_UNLOCK(vs) \ 345 do { \ 346 if (vs->vs_mtx) \ 347 pthread_mutex_unlock(vs->vs_mtx); \ 348 } while (0) 349 350 struct virtio_consts { 351 const char *vc_name; /* name of driver (for diagnostics) */ 352 int vc_nvq; /* number of virtual queues */ 353 size_t vc_cfgsize; /* size of dev-specific config regs */ 354 void (*vc_reset)(void *); /* called on virtual device reset */ 355 void (*vc_qnotify)(void *, struct vqueue_info *); 356 /* called on QNOTIFY if no VQ notify */ 357 int (*vc_cfgread)(void *, int, int, uint32_t *); 358 /* called to read config regs */ 359 int (*vc_cfgwrite)(void *, int, int, uint32_t); 360 /* called to write config regs */ 361 void (*vc_apply_features)(void *, uint64_t); 362 /* called to apply negotiated features */ 363 uint64_t vc_hv_caps; /* hypervisor-provided capabilities */ 364 }; 365 366 /* 367 * Data structure allocated (statically) per virtual queue. 368 * 369 * Drivers may change vq_qsize after a reset. When the guest OS 370 * requests a device reset, the hypervisor first calls 371 * vs->vs_vc->vc_reset(); then the data structure below is 372 * reinitialized (for each virtqueue: vs->vs_vc->vc_nvq). 373 * 374 * The remaining fields should only be fussed-with by the generic 375 * code. 376 * 377 * Note: the addresses of vq_desc, vq_avail, and vq_used are all 378 * computable from each other, but it's a lot simpler if we just 379 * keep a pointer to each one. The event indices are similarly 380 * (but more easily) computable, and this time we'll compute them: 381 * they're just XX_ring[N]. 382 */ 383 #define VQ_ALLOC 0x01 /* set once we have a pfn */ 384 #define VQ_BROKED 0x02 /* ??? */ 385 struct vqueue_info { 386 uint16_t vq_qsize; /* size of this queue (a power of 2) */ 387 void (*vq_notify)(void *, struct vqueue_info *); 388 /* called instead of vc_notify, if not NULL */ 389 390 struct virtio_softc *vq_vs; /* backpointer to softc */ 391 uint16_t vq_num; /* we're the num'th queue in the softc */ 392 393 uint16_t vq_flags; /* flags (see above) */ 394 uint16_t vq_last_avail; /* a recent value of vq_avail->va_idx */ 395 uint16_t vq_save_used; /* saved vq_used->vu_idx; see vq_endchains */ 396 uint16_t vq_msix_idx; /* MSI-X index, or VIRTIO_MSI_NO_VECTOR */ 397 398 uint32_t vq_pfn; /* PFN of virt queue (not shifted!) */ 399 400 volatile struct virtio_desc *vq_desc; /* descriptor array */ 401 volatile struct vring_avail *vq_avail; /* the "avail" ring */ 402 volatile struct vring_used *vq_used; /* the "used" ring */ 403 404 }; 405 /* as noted above, these are sort of backwards, name-wise */ 406 #define VQ_AVAIL_EVENT_IDX(vq) \ 407 (*(volatile uint16_t *)&(vq)->vq_used->vu_ring[(vq)->vq_qsize]) 408 #define VQ_USED_EVENT_IDX(vq) \ 409 ((vq)->vq_avail->va_ring[(vq)->vq_qsize]) 410 411 /* 412 * Is this ring ready for I/O? 413 */ 414 static inline int 415 vq_ring_ready(struct vqueue_info *vq) 416 { 417 418 return (vq->vq_flags & VQ_ALLOC); 419 } 420 421 /* 422 * Are there "available" descriptors? (This does not count 423 * how many, just returns True if there are some.) 424 */ 425 static inline int 426 vq_has_descs(struct vqueue_info *vq) 427 { 428 429 return (vq_ring_ready(vq) && vq->vq_last_avail != 430 vq->vq_avail->va_idx); 431 } 432 433 /* 434 * Deliver an interrupt to guest on the given virtual queue 435 * (if possible, or a generic MSI interrupt if not using MSI-X). 436 */ 437 static inline void 438 vq_interrupt(struct virtio_softc *vs, struct vqueue_info *vq) 439 { 440 441 if (pci_msix_enabled(vs->vs_pi)) 442 pci_generate_msix(vs->vs_pi, vq->vq_msix_idx); 443 else { 444 #ifndef __FreeBSD__ 445 boolean_t unlock = B_FALSE; 446 447 if (vs->vs_mtx && !pthread_mutex_isowned_np(vs->vs_mtx)) { 448 unlock = B_TRUE; 449 pthread_mutex_lock(vs->vs_mtx); 450 } 451 #else 452 VS_LOCK(vs); 453 #endif 454 vs->vs_isr |= VTCFG_ISR_QUEUES; 455 pci_generate_msi(vs->vs_pi, 0); 456 pci_lintr_assert(vs->vs_pi); 457 #ifndef __FreeBSD__ 458 if (unlock) 459 pthread_mutex_unlock(vs->vs_mtx); 460 #else 461 VS_UNLOCK(vs); 462 #endif 463 } 464 } 465 466 struct iovec; 467 void vi_softc_linkup(struct virtio_softc *vs, struct virtio_consts *vc, 468 void *dev_softc, struct pci_devinst *pi, 469 struct vqueue_info *queues); 470 int vi_intr_init(struct virtio_softc *vs, int barnum, int use_msix); 471 void vi_reset_dev(struct virtio_softc *); 472 void vi_set_io_bar(struct virtio_softc *, int); 473 474 int vq_getchain(struct vqueue_info *vq, uint16_t *pidx, 475 struct iovec *iov, int n_iov, uint16_t *flags); 476 void vq_retchain(struct vqueue_info *vq); 477 void vq_relchain(struct vqueue_info *vq, uint16_t idx, uint32_t iolen); 478 void vq_endchains(struct vqueue_info *vq, int used_all_avail); 479 480 uint64_t vi_pci_read(struct vmctx *ctx, int vcpu, struct pci_devinst *pi, 481 int baridx, uint64_t offset, int size); 482 void vi_pci_write(struct vmctx *ctx, int vcpu, struct pci_devinst *pi, 483 int baridx, uint64_t offset, int size, uint64_t value); 484 #endif /* _VIRTIO_H_ */ 485