summaryrefslogtreecommitdiffstats
path: root/sbin/nvmecontrol/nvmecontrol.c
diff options
context:
space:
mode:
Diffstat (limited to 'sbin/nvmecontrol/nvmecontrol.c')
-rw-r--r--sbin/nvmecontrol/nvmecontrol.c649
1 files changed, 114 insertions, 535 deletions
diff --git a/sbin/nvmecontrol/nvmecontrol.c b/sbin/nvmecontrol/nvmecontrol.c
index cbb365b..4dee190 100644
--- a/sbin/nvmecontrol/nvmecontrol.c
+++ b/sbin/nvmecontrol/nvmecontrol.c
@@ -1,5 +1,5 @@
/*-
- * Copyright (C) 2012 Intel Corporation
+ * Copyright (C) 2012-2013 Intel Corporation
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -31,140 +31,77 @@ __FBSDID("$FreeBSD$");
#include <sys/ioccom.h>
#include <sys/stat.h>
-#include <dev/nvme/nvme.h>
-
#include <ctype.h>
+#include <err.h>
#include <errno.h>
#include <fcntl.h>
+#include <paths.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
-#include <sysexits.h>
#include <unistd.h>
-#define DEVLIST_USAGE \
-" nvmecontrol devlist\n"
-
-#define IDENTIFY_USAGE \
-" nvmecontrol identify <controller id|namespace id>\n"
-
-#define PERFTEST_USAGE \
-" nvmecontrol perftest <-n num_threads> <-o read|write>\n" \
-" <-s size_in_bytes> <-t time_in_seconds>\n" \
-" <-i intr|wait> [-f refthread] [-p]\n" \
-" <namespace id>\n"
+#include "nvmecontrol.h"
-#define RESET_USAGE \
-" nvmecontrol reset <controller id>\n"
+typedef void (*nvme_fn_t)(int argc, char *argv[]);
-static void perftest_usage(void);
+static struct nvme_function {
+ const char *name;
+ nvme_fn_t fn;
+ const char *usage;
+} funcs[] = {
+ {"devlist", devlist, DEVLIST_USAGE},
+ {"identify", identify, IDENTIFY_USAGE},
+ {"perftest", perftest, PERFTEST_USAGE},
+ {"reset", reset, RESET_USAGE},
+ {"logpage", logpage, LOGPAGE_USAGE},
+ {"firmware", firmware, FIRMWARE_USAGE},
+ {NULL, NULL, NULL},
+};
static void
usage(void)
{
+ struct nvme_function *f;
+
+ f = funcs;
fprintf(stderr, "usage:\n");
- fprintf(stderr, DEVLIST_USAGE);
- fprintf(stderr, IDENTIFY_USAGE);
- fprintf(stderr, RESET_USAGE);
- fprintf(stderr, PERFTEST_USAGE);
- exit(EX_USAGE);
+ while (f->name != NULL) {
+ fprintf(stderr, "%s", f->usage);
+ f++;
+ }
+ exit(1);
}
static void
-print_controller_hex(struct nvme_controller_data *cdata, uint32_t length)
+print_bytes(void *data, uint32_t length)
{
- uint32_t *p;
uint32_t i, j;
+ uint8_t *p, *end;
- p = (uint32_t *)cdata;
- length /= sizeof(uint32_t);
+ end = (uint8_t *)data + length;
- for (i = 0; i < length; i+=8) {
- printf("%03x: ", i*4);
- for (j = 0; j < 8; j++)
- printf("%08x ", p[i+j]);
+ for (i = 0; i < length; i++) {
+ p = (uint8_t *)data + (i*16);
+ printf("%03x: ", i*16);
+ for (j = 0; j < 16 && p < end; j++)
+ printf("%02x ", *p++);
+ if (p >= end)
+ break;
printf("\n");
}
-
printf("\n");
}
static void
-print_controller(struct nvme_controller_data *cdata)
-{
- printf("Controller Capabilities/Features\n");
- printf("================================\n");
- printf("Vendor ID: %04x\n", cdata->vid);
- printf("Subsystem Vendor ID: %04x\n", cdata->ssvid);
- printf("Serial Number: %s\n", cdata->sn);
- printf("Model Number: %s\n", cdata->mn);
- printf("Firmware Version: %s\n", cdata->fr);
- printf("Recommended Arb Burst: %d\n", cdata->rab);
- printf("IEEE OUI Identifier: %02x %02x %02x\n",
- cdata->ieee[0], cdata->ieee[1], cdata->ieee[2]);
- printf("Multi-Interface Cap: %02x\n", cdata->mic);
- /* TODO: Use CAP.MPSMIN to determine true memory page size. */
- printf("Max Data Transfer Size: ");
- if (cdata->mdts == 0)
- printf("Unlimited\n");
- else
- printf("%d\n", PAGE_SIZE * (1 << cdata->mdts));
- printf("\n");
-
- printf("Admin Command Set Attributes\n");
- printf("============================\n");
- printf("Security Send/Receive: %s\n",
- cdata->oacs.security ? "Supported" : "Not Supported");
- printf("Format NVM: %s\n",
- cdata->oacs.format ? "Supported" : "Not Supported");
- printf("Firmware Activate/Download: %s\n",
- cdata->oacs.firmware ? "Supported" : "Not Supported");
- printf("Abort Command Limit: %d\n", cdata->acl+1);
- printf("Async Event Request Limit: %d\n", cdata->aerl+1);
- printf("Number of Firmware Slots: ");
- if (cdata->oacs.firmware != 0)
- printf("%d\n", cdata->frmw.num_slots);
- else
- printf("N/A\n");
- printf("Firmware Slot 1 Read-Only: ");
- if (cdata->oacs.firmware != 0)
- printf("%s\n", cdata->frmw.slot1_ro ? "Yes" : "No");
- else
- printf("N/A\n");
- printf("Per-Namespace SMART Log: %s\n",
- cdata->lpa.ns_smart ? "Yes" : "No");
- printf("Error Log Page Entries: %d\n", cdata->elpe+1);
- printf("Number of Power States: %d\n", cdata->npss+1);
- printf("\n");
-
- printf("NVM Command Set Attributes\n");
- printf("==========================\n");
- printf("Submission Queue Entry Size\n");
- printf(" Max: %d\n", 1 << cdata->sqes.max);
- printf(" Min: %d\n", 1 << cdata->sqes.min);
- printf("Completion Queue Entry Size\n");
- printf(" Max: %d\n", 1 << cdata->cqes.max);
- printf(" Min: %d\n", 1 << cdata->cqes.min);
- printf("Number of Namespaces: %d\n", cdata->nn);
- printf("Compare Command: %s\n",
- cdata->oncs.compare ? "Supported" : "Not Supported");
- printf("Write Uncorrectable Command: %s\n",
- cdata->oncs.write_unc ? "Supported" : "Not Supported");
- printf("Dataset Management Command: %s\n",
- cdata->oncs.dsm ? "Supported" : "Not Supported");
- printf("Volatile Write Cache: %s\n",
- cdata->vwc.present ? "Present" : "Not Present");
-}
-
-static void
-print_namespace_hex(struct nvme_namespace_data *nsdata, uint32_t length)
+print_dwords(void *data, uint32_t length)
{
uint32_t *p;
uint32_t i, j;
- p = (uint32_t *)nsdata;
+ p = (uint32_t *)data;
length /= sizeof(uint32_t);
for (i = 0; i < length; i+=8) {
@@ -177,477 +114,119 @@ print_namespace_hex(struct nvme_namespace_data *nsdata, uint32_t length)
printf("\n");
}
-static void
-print_namespace(struct nvme_namespace_data *nsdata)
-{
- uint32_t i;
-
- printf("Size (in LBAs): %lld (%lldM)\n",
- (long long)nsdata->nsze,
- (long long)nsdata->nsze / 1024 / 1024);
- printf("Capacity (in LBAs): %lld (%lldM)\n",
- (long long)nsdata->ncap,
- (long long)nsdata->ncap / 1024 / 1024);
- printf("Utilization (in LBAs): %lld (%lldM)\n",
- (long long)nsdata->nuse,
- (long long)nsdata->nuse / 1024 / 1024);
- printf("Thin Provisioning: %s\n",
- nsdata->nsfeat.thin_prov ? "Supported" : "Not Supported");
- printf("Number of LBA Formats: %d\n", nsdata->nlbaf+1);
- printf("Current LBA Format: LBA Format #%d\n",
- nsdata->flbas.format);
- for (i = 0; i <= nsdata->nlbaf; i++) {
- printf("LBA Format #%d:\n", i);
- printf(" LBA Data Size: %d\n",
- 1 << nsdata->lbaf[i].lbads);
- }
-}
-
-static uint32_t
-ns_get_sector_size(struct nvme_namespace_data *nsdata)
+void
+print_hex(void *data, uint32_t length)
{
-
- return (1 << nsdata->lbaf[0].lbads);
+ if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0)
+ print_dwords(data, length);
+ else
+ print_bytes(data, length);
}
-
-static void
-devlist(int argc, char *argv[])
+void
+read_controller_data(int fd, struct nvme_controller_data *cdata)
{
- struct nvme_controller_data cdata;
- struct nvme_namespace_data nsdata;
- struct stat devstat;
- char name[64], path[64];
- uint32_t i;
- int ch, ctrlr, exit_code, fd, found;
-
- exit_code = EX_OK;
-
- while ((ch = getopt(argc, argv, "")) != -1) {
- switch ((char)ch) {
- default:
- usage();
- }
- }
+ struct nvme_pt_command pt;
- ctrlr = -1;
- found = 0;
+ memset(&pt, 0, sizeof(pt));
+ pt.cmd.opc = NVME_OPC_IDENTIFY;
+ pt.cmd.cdw10 = 1;
+ pt.buf = cdata;
+ pt.len = sizeof(*cdata);
+ pt.is_read = 1;
- while (1) {
- ctrlr++;
- sprintf(name, "nvme%d", ctrlr);
- sprintf(path, "/dev/%s", name);
+ if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
+ err(1, "identify request failed");
- if (stat(path, &devstat) != 0)
- break;
-
- found++;
-
- fd = open(path, O_RDWR);
- if (fd < 0) {
- printf("Could not open %s. errno=%d (%s)\n", path,
- errno, strerror(errno));
- exit_code = EX_NOPERM;
- continue;
- }
-
- if (ioctl(fd, NVME_IDENTIFY_CONTROLLER, &cdata) < 0) {
- printf("Identify request to %s failed. errno=%d (%s)\n",
- path, errno, strerror(errno));
- exit_code = EX_IOERR;
- continue;
- }
-
- printf("%6s: %s\n", name, cdata.mn);
-
- for (i = 0; i < cdata.nn; i++) {
- sprintf(name, "nvme%dns%d", ctrlr, i+1);
- sprintf(path, "/dev/%s", name);
-
- fd = open(path, O_RDWR);
- if (fd < 0) {
- printf("Could not open %s. errno=%d (%s)\n",
- path, errno, strerror(errno));
- exit_code = EX_NOPERM;
- continue;
- }
- if (ioctl(fd, NVME_IDENTIFY_NAMESPACE, &nsdata) < 0) {
- printf("Identify request to %s failed. "
- "errno=%d (%s)\n", path, errno,
- strerror(errno));
- exit_code = EX_IOERR;
- continue;
- }
- printf(" %10s (%lldGB)\n",
- name,
- nsdata.nsze *
- (long long)ns_get_sector_size(&nsdata) /
- 1024 / 1024 / 1024);
- }
- }
-
- if (found == 0)
- printf("No NVMe controllers found.\n");
-
- exit(exit_code);
+ if (nvme_completion_is_error(&pt.cpl))
+ errx(1, "identify request returned error");
}
-static void
-identify_ctrlr(int argc, char *argv[])
+void
+read_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata)
{
- struct nvme_controller_data cdata;
- struct stat devstat;
- char path[64];
- int ch, fd, hexflag = 0, hexlength;
- int verboseflag = 0;
-
- while ((ch = getopt(argc, argv, "vx")) != -1) {
- switch ((char)ch) {
- case 'v':
- verboseflag = 1;
- break;
- case 'x':
- hexflag = 1;
- break;
- default:
- usage();
- }
- }
-
- sprintf(path, "/dev/%s", argv[optind]);
-
- if (stat(path, &devstat) < 0) {
- printf("Invalid device node %s. errno=%d (%s)\n", path, errno,
- strerror(errno));
- exit(EX_IOERR);
- }
+ struct nvme_pt_command pt;
- fd = open(path, O_RDWR);
- if (fd < 0) {
- printf("Could not open %s. errno=%d (%s)\n", path, errno,
- strerror(errno));
- exit(EX_NOPERM);
- }
+ memset(&pt, 0, sizeof(pt));
+ pt.cmd.opc = NVME_OPC_IDENTIFY;
+ pt.cmd.nsid = nsid;
+ pt.buf = nsdata;
+ pt.len = sizeof(*nsdata);
+ pt.is_read = 1;
- if (ioctl(fd, NVME_IDENTIFY_CONTROLLER, &cdata) < 0) {
- printf("Identify request to %s failed. errno=%d (%s)\n", path,
- errno, strerror(errno));
- exit(EX_IOERR);
- }
+ if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
+ err(1, "identify request failed");
- if (hexflag == 1) {
- if (verboseflag == 1)
- hexlength = sizeof(struct nvme_controller_data);
- else
- hexlength = offsetof(struct nvme_controller_data,
- reserved5);
- print_controller_hex(&cdata, hexlength);
- exit(EX_OK);
- }
-
- if (verboseflag == 1) {
- printf("-v not currently supported without -x.\n");
- usage();
- }
-
- print_controller(&cdata);
- exit(EX_OK);
+ if (nvme_completion_is_error(&pt.cpl))
+ errx(1, "identify request returned error");
}
-static void
-identify_ns(int argc, char *argv[])
+int
+open_dev(const char *str, int *fd, int show_error, int exit_on_error)
{
- struct nvme_namespace_data nsdata;
- struct stat devstat;
- char path[64];
- int ch, fd, hexflag = 0, hexlength;
- int verboseflag = 0;
-
- while ((ch = getopt(argc, argv, "vx")) != -1) {
- switch ((char)ch) {
- case 'v':
- verboseflag = 1;
- break;
- case 'x':
- hexflag = 1;
- break;
- default:
- usage();
- }
- }
-
- sprintf(path, "/dev/%s", argv[optind]);
-
- if (stat(path, &devstat) < 0) {
- printf("Invalid device node %s. errno=%d (%s)\n", path, errno,
- strerror(errno));
- exit(EX_IOERR);
- }
-
- fd = open(path, O_RDWR);
- if (fd < 0) {
- printf("Could not open %s. errno=%d (%s)\n", path, errno,
- strerror(errno));
- exit(EX_NOPERM);
- }
-
- if (ioctl(fd, NVME_IDENTIFY_NAMESPACE, &nsdata) < 0) {
- printf("Identify request to %s failed. errno=%d (%s)\n", path,
- errno, strerror(errno));
- exit(EX_IOERR);
- }
-
- if (hexflag == 1) {
- if (verboseflag == 1)
- hexlength = sizeof(struct nvme_namespace_data);
+ char full_path[64];
+
+ if (!strnstr(str, NVME_CTRLR_PREFIX, strlen(NVME_CTRLR_PREFIX))) {
+ if (show_error)
+ warnx("controller/namespace ids must begin with '%s'",
+ NVME_CTRLR_PREFIX);
+ if (exit_on_error)
+ exit(1);
else
- hexlength = offsetof(struct nvme_namespace_data,
- reserved6);
- print_namespace_hex(&nsdata, hexlength);
- exit(EX_OK);
+ return (EINVAL);
}
- if (verboseflag == 1) {
- printf("-v not currently supported without -x.\n");
- usage();
+ snprintf(full_path, sizeof(full_path), _PATH_DEV"%s", str);
+ *fd = open(full_path, O_RDWR);
+ if (*fd < 0) {
+ if (show_error)
+ warn("could not open %s", full_path);
+ if (exit_on_error)
+ exit(1);
+ else
+ return (errno);
}
- print_namespace(&nsdata);
- exit(EX_OK);
+ return (0);
}
-static void
-identify(int argc, char *argv[])
+void
+parse_ns_str(const char *ns_str, char *ctrlr_str, int *nsid)
{
- char *target;
-
- if (argc < 2)
- usage();
-
- while (getopt(argc, argv, "vx") != -1) ;
-
- target = argv[optind];
-
- /* Specified device node must have "nvme" in it. */
- if (strstr(argv[optind], "nvme") == NULL) {
- printf("Invalid device node '%s'.\n", argv[optind]);
- exit(EX_IOERR);
- }
-
- optreset = 1;
- optind = 1;
+ char *nsloc;
/*
- * If device node contains "ns", we consider it a namespace,
- * otherwise, consider it a controller.
+ * Pull the namespace id from the string. +2 skips past the "ns" part
+ * of the string. Don't search past 10 characters into the string,
+ * otherwise we know it is malformed.
*/
- if (strstr(target, "ns") == NULL)
- identify_ctrlr(argc, argv);
- else
- identify_ns(argc, argv);
-}
+ nsloc = strnstr(ns_str, NVME_NS_PREFIX, 10);
+ if (nsloc != NULL)
+ *nsid = strtol(nsloc + 2, NULL, 10);
+ if (nsloc == NULL || (*nsid == 0 && errno != 0))
+ errx(1, "invalid namespace ID '%s'", ns_str);
-static void
-print_perftest(struct nvme_io_test *io_test, bool perthread)
-{
- uint32_t i, io_completed = 0, iops, mbps;
-
- for (i = 0; i < io_test->num_threads; i++)
- io_completed += io_test->io_completed[i];
-
- iops = io_completed/io_test->time;
- mbps = iops * io_test->size / (1024*1024);
-
- printf("Threads: %2d Size: %6d %5s Time: %3d IO/s: %7d MB/s: %4d\n",
- io_test->num_threads, io_test->size,
- io_test->opc == NVME_OPC_READ ? "READ" : "WRITE",
- io_test->time, iops, mbps);
-
- if (perthread)
- for (i = 0; i < io_test->num_threads; i++)
- printf("\t%3d: %8d IO/s\n", i,
- io_test->io_completed[i]/io_test->time);
-
- exit(1);
-}
-
-static void
-perftest_usage(void)
-{
- fprintf(stderr, "usage:\n");
- fprintf(stderr, PERFTEST_USAGE);
- exit(EX_USAGE);
-}
-
-static void
-perftest(int argc, char *argv[])
-{
- struct nvme_io_test io_test;
- int fd;
- char ch;
- char *p;
- const char *name;
- char path[64];
- u_long ioctl_cmd = NVME_IO_TEST;
- bool nflag, oflag, sflag, tflag;
- int perthread = 0;
-
- nflag = oflag = sflag = tflag = false;
- name = NULL;
-
- memset(&io_test, 0, sizeof(io_test));
-
- while ((ch = getopt(argc, argv, "f:i:n:o:ps:t:")) != -1) {
- switch (ch) {
- case 'f':
- if (!strcmp(optarg, "refthread"))
- io_test.flags |= NVME_TEST_FLAG_REFTHREAD;
- break;
- case 'i':
- if (!strcmp(optarg, "bio") ||
- !strcmp(optarg, "wait"))
- ioctl_cmd = NVME_BIO_TEST;
- else if (!strcmp(optarg, "io") ||
- !strcmp(optarg, "intr"))
- ioctl_cmd = NVME_IO_TEST;
- break;
- case 'n':
- nflag = true;
- io_test.num_threads = strtoul(optarg, &p, 0);
- if (p != NULL && *p != '\0') {
- fprintf(stderr,
- "\"%s\" not valid number of threads.\n",
- optarg);
- perftest_usage();
- } else if (io_test.num_threads == 0 ||
- io_test.num_threads > 128) {
- fprintf(stderr,
- "\"%s\" not valid number of threads.\n",
- optarg);
- perftest_usage();
- }
- break;
- case 'o':
- oflag = true;
- if (!strcmp(optarg, "read") || !strcmp(optarg, "READ"))
- io_test.opc = NVME_OPC_READ;
- else if (!strcmp(optarg, "write") ||
- !strcmp(optarg, "WRITE"))
- io_test.opc = NVME_OPC_WRITE;
- else {
- fprintf(stderr, "\"%s\" not valid opcode.\n",
- optarg);
- perftest_usage();
- }
- break;
- case 'p':
- perthread = 1;
- break;
- case 's':
- sflag = true;
- io_test.size = strtoul(optarg, &p, 0);
- if (p == NULL || *p == '\0' || toupper(*p) == 'B') {
- // do nothing
- } else if (toupper(*p) == 'K') {
- io_test.size *= 1024;
- } else if (toupper(*p) == 'M') {
- io_test.size *= 1024 * 1024;
- } else {
- fprintf(stderr, "\"%s\" not valid size.\n",
- optarg);
- perftest_usage();
- }
- break;
- case 't':
- tflag = true;
- io_test.time = strtoul(optarg, &p, 0);
- if (p != NULL && *p != '\0') {
- fprintf(stderr,
- "\"%s\" not valid time duration.\n",
- optarg);
- perftest_usage();
- }
- break;
- }
- }
-
- name = argv[optind];
-
- if (!nflag || !oflag || !sflag || !tflag || name == NULL)
- perftest_usage();
-
- sprintf(path, "/dev/%s", name);
-
- fd = open(path, O_RDWR);
- if (fd < 0) {
- fprintf(stderr, "%s not valid device. errno=%d (%s)\n", path,
- errno, strerror(errno));
- perftest_usage();
- }
-
- if (ioctl(fd, ioctl_cmd, &io_test) < 0) {
- fprintf(stderr, "NVME_IO_TEST failed. errno=%d (%s)\n", errno,
- strerror(errno));
- exit(EX_IOERR);
- }
-
- print_perftest(&io_test, perthread);
- exit(EX_OK);
-}
-
-static void
-reset_ctrlr(int argc, char *argv[])
-{
- struct stat devstat;
- char path[64];
- int ch, fd;
-
- while ((ch = getopt(argc, argv, "")) != -1) {
- switch ((char)ch) {
- default:
- usage();
- }
- }
-
- sprintf(path, "/dev/%s", argv[optind]);
-
- if (stat(path, &devstat) < 0) {
- printf("Invalid device node %s. errno=%d (%s)\n", path, errno,
- strerror(errno));
- exit(EX_IOERR);
- }
-
- fd = open(path, O_RDWR);
- if (fd < 0) {
- printf("Could not open %s. errno=%d (%s)\n", path, errno,
- strerror(errno));
- exit(EX_NOPERM);
- }
-
- if (ioctl(fd, NVME_RESET_CONTROLLER) < 0) {
- printf("Reset request to %s failed. errno=%d (%s)\n", path,
- errno, strerror(errno));
- exit(EX_IOERR);
- }
-
- exit(EX_OK);
+ /*
+ * The controller string will include only the nvmX part of the
+ * nvmeXnsY string.
+ */
+ snprintf(ctrlr_str, nsloc - ns_str + 1, "%s", ns_str);
}
int
main(int argc, char *argv[])
{
+ struct nvme_function *f;
if (argc < 2)
usage();
- if (strcmp(argv[1], "devlist") == 0)
- devlist(argc-1, &argv[1]);
- else if (strcmp(argv[1], "identify") == 0)
- identify(argc-1, &argv[1]);
- else if (strcmp(argv[1], "perftest") == 0)
- perftest(argc-1, &argv[1]);
- else if (strcmp(argv[1], "reset") == 0)
- reset_ctrlr(argc-1, &argv[1]);
+ f = funcs;
+ while (f->name != NULL) {
+ if (strcmp(argv[1], f->name) == 0)
+ f->fn(argc-1, &argv[1]);
+ f++;
+ }
usage();
OpenPOWER on IntegriCloud