Page MenuHomeFreeBSD
Differential D19905 Diff 59721 head/usr.sbin/bhyve/pci_nvme.c

Changeset View

Standalone View

View Options

head/usr.sbin/bhyve/pci_nvme.c

/*- /*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
* *
* Copyright (c) 2017 Shunsuke Mie * Copyright (c) 2017 Shunsuke Mie
* Copyright (c) 2018 Leon Dang * Copyright (c) 2018 Leon Dang
* *
* Function crc16 Copyright (c) 2017, Fedor Uporov
* Obtained from function ext2_crc16() in sys/fs/ext2fs/ext2_csum.c
*
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions * modification, are permitted provided that the following conditions
* are met: * are met:
* 1. Redistributions of source code must retain the above copyright * 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer. * notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright * 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the * notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution. * documentation and/or other materials provided with the distribution.
Show All 10 Lines
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * SUCH DAMAGE.
*/ */
/* /*
* bhyve PCIe-NVMe device emulation. * bhyve PCIe-NVMe device emulation.
* *
* options: * options:
* -s <n>,nvme,devpath,maxq=#,qsz=#,ioslots=#,sectsz=#,ser=A-Z * -s <n>,nvme,devpath,maxq=#,qsz=#,ioslots=#,sectsz=#,ser=A-Z,eui64=#
* *
* accepted devpath: * accepted devpath:
* /dev/blockdev * /dev/blockdev
* /path/to/image * /path/to/image
* ram=size_in_MiB * ram=size_in_MiB
* *
* maxq = max number of queues * maxq = max number of queues
* qsz = max elements in each queue * qsz = max elements in each queue
* ioslots = max number of concurrent io requests * ioslots = max number of concurrent io requests
* sectsz = sector size (defaults to blockif sector size) * sectsz = sector size (defaults to blockif sector size)
* ser = serial number (20-chars max) * ser = serial number (20-chars max)
* eui64 = IEEE Extended Unique Identifier (8 byte value)
* *
*/ */
/* TODO: /* TODO:
- create async event for smart and log - create async event for smart and log
- intr coalesce - intr coalesce
*/ */
#include <sys/cdefs.h> #include <sys/cdefs.h>
__FBSDID("$FreeBSD$"); __FBSDID("$FreeBSD$");
#include <sys/types.h> #include <sys/types.h>
#include <net/ieee_oui.h>
#include <assert.h> #include <assert.h>
#include <pthread.h> #include <pthread.h>
#include <semaphore.h> #include <semaphore.h>
#include <stdbool.h> #include <stdbool.h>
#include <stddef.h> #include <stddef.h>
#include <stdint.h> #include <stdint.h>
#include <stdio.h> #include <stdio.h>
▲ Show 20 Lines • Show All 94 Lines • ▼ Show 20 Lines
}; };
struct pci_nvme_blockstore { struct pci_nvme_blockstore {
enum nvme_storage_type type; enum nvme_storage_type type;
void *ctx; void *ctx;
uint64_t size; uint64_t size;
uint32_t sectsz; uint32_t sectsz;
uint32_t sectsz_bits; uint32_t sectsz_bits;
uint64_t eui64;
}; };
struct pci_nvme_ioreq { struct pci_nvme_ioreq {
struct pci_nvme_softc *sc; struct pci_nvme_softc *sc;
struct pci_nvme_ioreq *next; struct pci_nvme_ioreq *next;
struct nvme_submission_queue *nvme_sq; struct nvme_submission_queue *nvme_sq;
uint16_t sqid; uint16_t sqid;
▲ Show 20 Lines • Show All 172 Lines • ▼ Show 20 Lines cd->cqes = (4 << NVME_CTRLR_DATA_CQES_MAX_SHIFT) |
(4 << NVME_CTRLR_DATA_CQES_MIN_SHIFT); (4 << NVME_CTRLR_DATA_CQES_MIN_SHIFT);
cd->nn = 1; /* number of namespaces */ cd->nn = 1; /* number of namespaces */
cd->fna = 0x03; cd->fna = 0x03;
cd->power_state[0].mp = 10; cd->power_state[0].mp = 10;
} }
static void /*
pci_nvme_init_nsdata(struct pci_nvme_softc *sc) * Calculate the CRC-16 of the given buffer
* See copyright attribution at top of file
*/
static uint16_t
crc16(uint16_t crc, const void *buffer, unsigned int len)
{ {
struct nvme_namespace_data *nd; const unsigned char *cp = buffer;
/* CRC table for the CRC-16. The poly is 0x8005 (x16 + x15 + x2 + 1). */
static uint16_t const crc16_table[256] = {
0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241,
0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440,
0xCC01, 0x0CC0, 0x0D80, 0xCD41, 0x0F00, 0xCFC1, 0xCE81, 0x0E40,
0x0A00, 0xCAC1, 0xCB81, 0x0B40, 0xC901, 0x09C0, 0x0880, 0xC841,
0xD801, 0x18C0, 0x1980, 0xD941, 0x1B00, 0xDBC1, 0xDA81, 0x1A40,
0x1E00, 0xDEC1, 0xDF81, 0x1F40, 0xDD01, 0x1DC0, 0x1C80, 0xDC41,
0x1400, 0xD4C1, 0xD581, 0x1540, 0xD701, 0x17C0, 0x1680, 0xD641,
0xD201, 0x12C0, 0x1380, 0xD341, 0x1100, 0xD1C1, 0xD081, 0x1040,
0xF001, 0x30C0, 0x3180, 0xF141, 0x3300, 0xF3C1, 0xF281, 0x3240,
0x3600, 0xF6C1, 0xF781, 0x3740, 0xF501, 0x35C0, 0x3480, 0xF441,
0x3C00, 0xFCC1, 0xFD81, 0x3D40, 0xFF01, 0x3FC0, 0x3E80, 0xFE41,
0xFA01, 0x3AC0, 0x3B80, 0xFB41, 0x3900, 0xF9C1, 0xF881, 0x3840,
0x2800, 0xE8C1, 0xE981, 0x2940, 0xEB01, 0x2BC0, 0x2A80, 0xEA41,
0xEE01, 0x2EC0, 0x2F80, 0xEF41, 0x2D00, 0xEDC1, 0xEC81, 0x2C40,
0xE401, 0x24C0, 0x2580, 0xE541, 0x2700, 0xE7C1, 0xE681, 0x2640,
0x2200, 0xE2C1, 0xE381, 0x2340, 0xE101, 0x21C0, 0x2080, 0xE041,
0xA001, 0x60C0, 0x6180, 0xA141, 0x6300, 0xA3C1, 0xA281, 0x6240,
0x6600, 0xA6C1, 0xA781, 0x6740, 0xA501, 0x65C0, 0x6480, 0xA441,
0x6C00, 0xACC1, 0xAD81, 0x6D40, 0xAF01, 0x6FC0, 0x6E80, 0xAE41,
0xAA01, 0x6AC0, 0x6B80, 0xAB41, 0x6900, 0xA9C1, 0xA881, 0x6840,
0x7800, 0xB8C1, 0xB981, 0x7940, 0xBB01, 0x7BC0, 0x7A80, 0xBA41,
0xBE01, 0x7EC0, 0x7F80, 0xBF41, 0x7D00, 0xBDC1, 0xBC81, 0x7C40,
0xB401, 0x74C0, 0x7580, 0xB541, 0x7700, 0xB7C1, 0xB681, 0x7640,
0x7200, 0xB2C1, 0xB381, 0x7340, 0xB101, 0x71C0, 0x7080, 0xB041,
0x5000, 0x90C1, 0x9181, 0x5140, 0x9301, 0x53C0, 0x5280, 0x9241,
0x9601, 0x56C0, 0x5780, 0x9741, 0x5500, 0x95C1, 0x9481, 0x5440,
0x9C01, 0x5CC0, 0x5D80, 0x9D41, 0x5F00, 0x9FC1, 0x9E81, 0x5E40,
0x5A00, 0x9AC1, 0x9B81, 0x5B40, 0x9901, 0x59C0, 0x5880, 0x9841,
0x8801, 0x48C0, 0x4980, 0x8941, 0x4B00, 0x8BC1, 0x8A81, 0x4A40,
0x4E00, 0x8EC1, 0x8F81, 0x4F40, 0x8D01, 0x4DC0, 0x4C80, 0x8C41,
0x4400, 0x84C1, 0x8581, 0x4540, 0x8701, 0x47C0, 0x4680, 0x8641,
0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040
};
nd = &sc->nsdata; while (len--)
crc = (((crc >> 8) & 0xffU) ^
crc16_table[(crc ^ *cp++) & 0xffU]) & 0x0000ffffU;
return crc;
}
static void
pci_nvme_init_nsdata(struct pci_nvme_softc *sc,
struct nvme_namespace_data *nd, uint32_t nsid,
uint64_t eui64)
{
nd->nsze = sc->nvstore.size / sc->nvstore.sectsz; nd->nsze = sc->nvstore.size / sc->nvstore.sectsz;
nd->ncap = nd->nsze; nd->ncap = nd->nsze;
nd->nuse = nd->nsze; nd->nuse = nd->nsze;
/* Get LBA and backstore information from backing store */ /* Get LBA and backstore information from backing store */
nd->nlbaf = 0; /* NLBAF is a 0's based value (i.e. 1 LBA Format) */ nd->nlbaf = 0; /* NLBAF is a 0's based value (i.e. 1 LBA Format) */
nd->flbas = 0;
/* Create an EUI-64 if user did not provide one */
if (eui64 == 0) {
char *data = NULL;
asprintf(&data, "%s%u%u%u", vmname, sc->nsc_pi->pi_bus,
sc->nsc_pi->pi_slot, sc->nsc_pi->pi_func);
if (data != NULL) {
eui64 = OUI_FREEBSD_NVME_LOW | crc16(0, data, strlen(data));
free(data);
}
eui64 = (eui64 << 16) | (nsid & 0xffff);
}
be64enc(nd->eui64, eui64);
/* LBA data-sz = 2^lbads */ /* LBA data-sz = 2^lbads */
nd->lbaf[0] = sc->nvstore.sectsz_bits << NVME_NS_DATA_LBAF_LBADS_SHIFT; nd->lbaf[0] = sc->nvstore.sectsz_bits << NVME_NS_DATA_LBAF_LBADS_SHIFT;
nd->flbas = 0;
} }
static void static void
pci_nvme_init_logpages(struct pci_nvme_softc *sc) pci_nvme_init_logpages(struct pci_nvme_softc *sc)
{ {
memset(&sc->err_log, 0, sizeof(sc->err_log)); memset(&sc->err_log, 0, sizeof(sc->err_log));
memset(&sc->health_log, 0, sizeof(sc->health_log)); memset(&sc->health_log, 0, sizeof(sc->health_log));
▲ Show 20 Lines • Show All 1,432 Lines • ▼ Show 20 Lines if (!strcmp("maxq", xopts)) {
sc->nvstore.ctx = calloc(1, sc->nvstore.size); sc->nvstore.ctx = calloc(1, sc->nvstore.size);
sc->nvstore.sectsz = 4096; sc->nvstore.sectsz = 4096;
sc->nvstore.sectsz_bits = 12; sc->nvstore.sectsz_bits = 12;
if (sc->nvstore.ctx == NULL) { if (sc->nvstore.ctx == NULL) {
perror("Unable to allocate RAM"); perror("Unable to allocate RAM");
free(uopt); free(uopt);
return (-1); return (-1);
} }
} else if (!strcmp("eui64", xopts)) {
sc->nvstore.eui64 = htobe64(strtoull(config, NULL, 0));
} else if (optidx == 0) { } else if (optidx == 0) {
snprintf(bident, sizeof(bident), "%d:%d", snprintf(bident, sizeof(bident), "%d:%d",
sc->nsc_pi->pi_slot, sc->nsc_pi->pi_func); sc->nsc_pi->pi_slot, sc->nsc_pi->pi_func);
sc->nvstore.ctx = blockif_open(xopts, bident); sc->nvstore.ctx = blockif_open(xopts, bident);
if (sc->nvstore.ctx == NULL) { if (sc->nvstore.ctx == NULL) {
perror("Could not open backing file"); perror("Could not open backing file");
free(uopt); free(uopt);
return (-1); return (-1);
▲ Show 20 Lines • Show All 104 Lines • ▼ Show 20 Lines if (error) {
goto done; goto done;
} }
pthread_mutex_init(&sc->mtx, NULL); pthread_mutex_init(&sc->mtx, NULL);
sem_init(&sc->iosemlock, 0, sc->ioslots); sem_init(&sc->iosemlock, 0, sc->ioslots);
pci_nvme_reset(sc); pci_nvme_reset(sc);
pci_nvme_init_ctrldata(sc); pci_nvme_init_ctrldata(sc);
pci_nvme_init_nsdata(sc); pci_nvme_init_nsdata(sc, &sc->nsdata, 1, sc->nvstore.eui64);
pci_nvme_init_logpages(sc); pci_nvme_init_logpages(sc);
pci_lintr_request(pi); pci_lintr_request(pi);
done: done:
return (error); return (error);
} }
struct pci_devemu pci_de_nvme = { struct pci_devemu pci_de_nvme = {
.pe_emu = "nvme", .pe_emu = "nvme",
.pe_init = pci_nvme_init, .pe_init = pci_nvme_init,
.pe_barwrite = pci_nvme_write, .pe_barwrite = pci_nvme_write,
.pe_barread = pci_nvme_read .pe_barread = pci_nvme_read
}; };
PCI_EMUL_SET(pci_de_nvme); PCI_EMUL_SET(pci_de_nvme);