2 * Copyright (c) 2011 NetApp, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/linker_set.h>
36 #include <sys/ioctl.h>
56 #define VTBLK_RINGSZ 64
59 #define VTBLK_S_IOERR 1
60 #define VTBLK_S_UNSUPP 2
62 #define VTBLK_BLK_ID_BYTES 20
65 #define VTBLK_F_SEG_MAX (1 << 2) /* Maximum request segments */
66 #define VTBLK_F_BLK_SIZE (1 << 6) /* cfg block size valid */
67 #define VTBLK_F_FLUSH (1 << 9) /* Cache flush support */
68 #define VTBLK_F_TOPOLOGY (1 << 10) /* Optimal I/O alignment */
73 #define VTBLK_S_HOSTCAPS \
78 VIRTIO_RING_F_INDIRECT_DESC ) /* indirect descriptors */
81 * Config space "registers"
84 uint64_t vbc_capacity;
85 uint32_t vbc_size_max;
92 uint32_t vbc_blk_size;
94 uint8_t physical_block_exp;
95 uint8_t alignment_offset;
99 uint8_t vbc_writeback;
103 * Fixed-size block header
105 struct virtio_blk_hdr {
106 #define VBH_OP_READ 0
107 #define VBH_OP_WRITE 1
108 #define VBH_OP_FLUSH 4
109 #define VBH_OP_FLUSH_OUT 5
110 #define VBH_OP_IDENT 8
111 #define VBH_FLAG_BARRIER 0x80000000 /* OR'ed into vbh_type */
120 static int pci_vtblk_debug;
121 #define DPRINTF(params) if (pci_vtblk_debug) printf params
122 #define WPRINTF(params) printf params
124 struct pci_vtblk_ioreq {
125 struct blockif_req io_req;
126 struct pci_vtblk_softc *io_sc;
134 struct pci_vtblk_softc {
135 struct virtio_softc vbsc_vs;
136 pthread_mutex_t vsc_mtx;
137 struct vqueue_info vbsc_vq;
138 struct vtblk_config vbsc_cfg;
139 struct blockif_ctxt *bc;
140 char vbsc_ident[VTBLK_BLK_ID_BYTES];
141 struct pci_vtblk_ioreq vbsc_ios[VTBLK_RINGSZ];
144 static void pci_vtblk_reset(void *);
145 static void pci_vtblk_notify(void *, struct vqueue_info *);
146 static int pci_vtblk_cfgread(void *, int, int, uint32_t *);
147 static int pci_vtblk_cfgwrite(void *, int, int, uint32_t);
149 static struct virtio_consts vtblk_vi_consts = {
150 "vtblk", /* our name */
151 1, /* we support 1 virtqueue */
152 sizeof(struct vtblk_config), /* config reg size */
153 pci_vtblk_reset, /* reset */
154 pci_vtblk_notify, /* device-wide qnotify */
155 pci_vtblk_cfgread, /* read PCI config */
156 pci_vtblk_cfgwrite, /* write PCI config */
157 NULL, /* apply negotiated features */
158 VTBLK_S_HOSTCAPS, /* our capabilities */
162 pci_vtblk_reset(void *vsc)
164 struct pci_vtblk_softc *sc = vsc;
166 DPRINTF(("vtblk: device reset requested !\n"));
167 vi_reset_dev(&sc->vbsc_vs);
171 pci_vtblk_done(struct blockif_req *br, int err)
173 struct pci_vtblk_ioreq *io = br->br_param;
174 struct pci_vtblk_softc *sc = io->io_sc;
176 /* convert errno into a virtio block error return */
177 if (err == EOPNOTSUPP || err == ENOSYS)
178 *io->io_status = VTBLK_S_UNSUPP;
180 *io->io_status = VTBLK_S_IOERR;
182 *io->io_status = VTBLK_S_OK;
185 * Return the descriptor back to the host.
186 * We wrote 1 byte (our status) to host.
188 pthread_mutex_lock(&sc->vsc_mtx);
189 vq_relchain(&sc->vbsc_vq, io->io_idx, 1);
190 vq_endchains(&sc->vbsc_vq, 0);
191 pthread_mutex_unlock(&sc->vsc_mtx);
195 pci_vtblk_proc(struct pci_vtblk_softc *sc, struct vqueue_info *vq)
197 struct virtio_blk_hdr *vbh;
198 struct pci_vtblk_ioreq *io;
204 struct iovec iov[BLOCKIF_IOV_MAX + 2];
205 uint16_t idx, flags[BLOCKIF_IOV_MAX + 2];
207 n = vq_getchain(vq, &idx, iov, BLOCKIF_IOV_MAX + 2, flags);
210 * The first descriptor will be the read-only fixed header,
211 * and the last is for status (hence +2 above and below).
212 * The remaining iov's are the actual data I/O vectors.
214 * XXX - note - this fails on crash dump, which does a
215 * VIRTIO_BLK_T_FLUSH with a zero transfer length
217 assert(n >= 2 && n <= BLOCKIF_IOV_MAX + 2);
219 io = &sc->vbsc_ios[idx];
220 assert((flags[0] & VRING_DESC_F_WRITE) == 0);
221 assert(iov[0].iov_len == sizeof(struct virtio_blk_hdr));
222 vbh = iov[0].iov_base;
223 memcpy(&io->io_req.br_iov, &iov[1], sizeof(struct iovec) * (n - 2));
224 io->io_req.br_iovcnt = n - 2;
225 io->io_req.br_offset = vbh->vbh_sector * DEV_BSIZE;
226 io->io_status = iov[--n].iov_base;
227 assert(iov[n].iov_len == 1);
228 assert(flags[n] & VRING_DESC_F_WRITE);
232 * The guest should not be setting the BARRIER flag because
233 * we don't advertise the capability.
235 type = vbh->vbh_type & ~VBH_FLAG_BARRIER;
236 writeop = (type == VBH_OP_WRITE);
239 for (i = 1; i < n; i++) {
241 * - write op implies read-only descriptor,
242 * - read/ident op implies write-only descriptor,
243 * therefore test the inverse of the descriptor bit
246 assert(((flags[i] & VRING_DESC_F_WRITE) == 0) == writeop);
247 iolen += iov[i].iov_len;
249 io->io_req.br_resid = iolen;
251 DPRINTF(("virtio-block: %s op, %zd bytes, %d segs, offset %ld\n\r",
252 writeop ? "write" : "read/ident", iolen, i - 1, offset));
256 err = blockif_read(sc->bc, &io->io_req);
259 err = blockif_write(sc->bc, &io->io_req);
262 case VBH_OP_FLUSH_OUT:
263 err = blockif_flush(sc->bc, &io->io_req);
266 /* Assume a single buffer */
267 /* S/n equal to buffer is not zero-terminated. */
268 memset(iov[1].iov_base, 0, iov[1].iov_len);
269 strncpy(iov[1].iov_base, sc->vbsc_ident,
270 MIN(iov[1].iov_len, sizeof(sc->vbsc_ident)));
271 pci_vtblk_done(&io->io_req, 0);
274 pci_vtblk_done(&io->io_req, EOPNOTSUPP);
281 pci_vtblk_notify(void *vsc, struct vqueue_info *vq)
283 struct pci_vtblk_softc *sc = vsc;
285 while (vq_has_descs(vq))
286 pci_vtblk_proc(sc, vq);
290 pci_vtblk_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
292 char bident[sizeof("XX:X:X")];
293 struct blockif_ctxt *bctxt;
296 struct pci_vtblk_softc *sc;
298 int i, sectsz, sts, sto;
301 printf("virtio-block: backing device required\n");
306 * The supplied backing file has to exist
308 snprintf(bident, sizeof(bident), "%d:%d", pi->pi_slot, pi->pi_func);
309 bctxt = blockif_open(opts, bident);
311 perror("Could not open backing file");
315 size = blockif_size(bctxt);
316 sectsz = blockif_sectsz(bctxt);
317 blockif_psectsz(bctxt, &sts, &sto);
319 sc = calloc(1, sizeof(struct pci_vtblk_softc));
321 for (i = 0; i < VTBLK_RINGSZ; i++) {
322 struct pci_vtblk_ioreq *io = &sc->vbsc_ios[i];
323 io->io_req.br_callback = pci_vtblk_done;
324 io->io_req.br_param = io;
329 pthread_mutex_init(&sc->vsc_mtx, NULL);
331 /* init virtio softc and virtqueues */
332 vi_softc_linkup(&sc->vbsc_vs, &vtblk_vi_consts, sc, pi, &sc->vbsc_vq);
333 sc->vbsc_vs.vs_mtx = &sc->vsc_mtx;
335 sc->vbsc_vq.vq_qsize = VTBLK_RINGSZ;
336 /* sc->vbsc_vq.vq_notify = we have no per-queue notify */
339 * Create an identifier for the backing file. Use parts of the
340 * md5 sum of the filename
343 MD5Update(&mdctx, opts, strlen(opts));
344 MD5Final(digest, &mdctx);
345 sprintf(sc->vbsc_ident, "BHYVE-%02X%02X-%02X%02X-%02X%02X",
346 digest[0], digest[1], digest[2], digest[3], digest[4], digest[5]);
348 /* setup virtio block config space */
349 sc->vbsc_cfg.vbc_capacity = size / DEV_BSIZE; /* 512-byte units */
350 sc->vbsc_cfg.vbc_size_max = 0; /* not negotiated */
351 sc->vbsc_cfg.vbc_seg_max = BLOCKIF_IOV_MAX;
352 sc->vbsc_cfg.vbc_geometry.cylinders = 0; /* no geometry */
353 sc->vbsc_cfg.vbc_geometry.heads = 0;
354 sc->vbsc_cfg.vbc_geometry.sectors = 0;
355 sc->vbsc_cfg.vbc_blk_size = sectsz;
356 sc->vbsc_cfg.vbc_topology.physical_block_exp =
357 (sts > sectsz) ? (ffsll(sts / sectsz) - 1) : 0;
358 sc->vbsc_cfg.vbc_topology.alignment_offset =
359 (sto != 0) ? ((sts - sto) / sectsz) : 0;
360 sc->vbsc_cfg.vbc_topology.min_io_size = 0;
361 sc->vbsc_cfg.vbc_topology.opt_io_size = 0;
362 sc->vbsc_cfg.vbc_writeback = 0;
365 * Should we move some of this into virtio.c? Could
366 * have the device, class, and subdev_0 as fields in
367 * the virtio constants structure.
369 pci_set_cfgdata16(pi, PCIR_DEVICE, VIRTIO_DEV_BLOCK);
370 pci_set_cfgdata16(pi, PCIR_VENDOR, VIRTIO_VENDOR);
371 pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_STORAGE);
372 pci_set_cfgdata16(pi, PCIR_SUBDEV_0, VIRTIO_TYPE_BLOCK);
373 pci_set_cfgdata16(pi, PCIR_SUBVEND_0, VIRTIO_VENDOR);
375 if (vi_intr_init(&sc->vbsc_vs, 1, fbsdrun_virtio_msix())) {
376 blockif_close(sc->bc);
380 vi_set_io_bar(&sc->vbsc_vs, 0);
385 pci_vtblk_cfgwrite(void *vsc, int offset, int size, uint32_t value)
388 DPRINTF(("vtblk: write to readonly reg %d\n\r", offset));
393 pci_vtblk_cfgread(void *vsc, int offset, int size, uint32_t *retval)
395 struct pci_vtblk_softc *sc = vsc;
398 /* our caller has already verified offset and size */
399 ptr = (uint8_t *)&sc->vbsc_cfg + offset;
400 memcpy(retval, ptr, size);
404 struct pci_devemu pci_de_vblk = {
405 .pe_emu = "virtio-blk",
406 .pe_init = pci_vtblk_init,
407 .pe_barwrite = vi_pci_write,
408 .pe_barread = vi_pci_read
410 PCI_EMUL_SET(pci_de_vblk);