nvmecontrol.c revision 328716
1240620Sjimharris/*- 2252263Sjimharris * Copyright (C) 2012-2013 Intel Corporation 3240620Sjimharris * All rights reserved. 4240620Sjimharris * 5240620Sjimharris * Redistribution and use in source and binary forms, with or without 6240620Sjimharris * modification, are permitted provided that the following conditions 7240620Sjimharris * are met: 8240620Sjimharris * 1. Redistributions of source code must retain the above copyright 9240620Sjimharris * notice, this list of conditions and the following disclaimer. 10240620Sjimharris * 2. Redistributions in binary form must reproduce the above copyright 11240620Sjimharris * notice, this list of conditions and the following disclaimer in the 12240620Sjimharris * documentation and/or other materials provided with the distribution. 13240620Sjimharris * 14240620Sjimharris * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15240620Sjimharris * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16240620Sjimharris * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17240620Sjimharris * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18240620Sjimharris * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19240620Sjimharris * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20240620Sjimharris * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21240620Sjimharris * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22240620Sjimharris * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23240620Sjimharris * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24240620Sjimharris * SUCH DAMAGE. 25240620Sjimharris */ 26240620Sjimharris 27240620Sjimharris#include <sys/cdefs.h> 28240620Sjimharris__FBSDID("$FreeBSD: stable/11/sbin/nvmecontrol/nvmecontrol.c 328716 2018-02-01 19:37:50Z mav $"); 29240620Sjimharris 30240620Sjimharris#include <sys/param.h> 31240620Sjimharris#include <sys/ioccom.h> 32240620Sjimharris#include <sys/stat.h> 33240620Sjimharris 34240620Sjimharris#include <ctype.h> 35253109Sjimharris#include <err.h> 36253114Sjimharris#include <errno.h> 37240620Sjimharris#include <fcntl.h> 38253459Sjimharris#include <paths.h> 39240620Sjimharris#include <stdbool.h> 40240620Sjimharris#include <stddef.h> 41240620Sjimharris#include <stdio.h> 42240620Sjimharris#include <stdlib.h> 43240620Sjimharris#include <string.h> 44240620Sjimharris#include <unistd.h> 45240620Sjimharris 46252265Sjimharris#include "nvmecontrol.h" 47240620Sjimharris 48252269Sjimharris 49328715Smavstatic struct nvme_function funcs[] = { 50252269Sjimharris {"devlist", devlist, DEVLIST_USAGE}, 51252269Sjimharris {"identify", identify, IDENTIFY_USAGE}, 52252269Sjimharris {"perftest", perftest, PERFTEST_USAGE}, 53252269Sjimharris {"reset", reset, RESET_USAGE}, 54252277Sjimharris {"logpage", logpage, LOGPAGE_USAGE}, 55252278Sjimharris {"firmware", firmware, FIRMWARE_USAGE}, 56295087Simp {"power", power, POWER_USAGE}, 57328716Smav {"wdc", wdc, WDC_USAGE}, 58252269Sjimharris {NULL, NULL, NULL}, 59252269Sjimharris}; 60252269Sjimharris 61328715Smavvoid 62328715Smavgen_usage(struct nvme_function *f) 63240620Sjimharris{ 64252269Sjimharris 65240620Sjimharris fprintf(stderr, "usage:\n"); 66252269Sjimharris while (f->name != NULL) { 67252269Sjimharris fprintf(stderr, "%s", f->usage); 68252269Sjimharris f++; 69252269Sjimharris } 70253109Sjimharris exit(1); 71240620Sjimharris} 72240620Sjimharris 73328715Smavvoid 74328715Smavdispatch(int argc, char *argv[], struct nvme_function *tbl) 75328715Smav{ 76328715Smav struct nvme_function *f = tbl; 77328715Smav 78328715Smav while (f->name != NULL) { 79328715Smav if (strcmp(argv[1], f->name) == 0) 80328715Smav f->fn(argc-1, &argv[1]); 81328715Smav f++; 82328715Smav } 83328715Smav 84328715Smav fprintf(stderr, "Unknown command: %s\n", argv[1]); 85328715Smav gen_usage(tbl); 86328715Smav} 87328715Smav 88252275Sjimharrisstatic void 89252275Sjimharrisprint_bytes(void *data, uint32_t length) 90252275Sjimharris{ 91252275Sjimharris uint32_t i, j; 92252275Sjimharris uint8_t *p, *end; 93252275Sjimharris 94252275Sjimharris end = (uint8_t *)data + length; 95252275Sjimharris 96252275Sjimharris for (i = 0; i < length; i++) { 97252275Sjimharris p = (uint8_t *)data + (i*16); 98252275Sjimharris printf("%03x: ", i*16); 99252275Sjimharris for (j = 0; j < 16 && p < end; j++) 100252275Sjimharris printf("%02x ", *p++); 101252275Sjimharris if (p >= end) 102252275Sjimharris break; 103252275Sjimharris printf("\n"); 104252275Sjimharris } 105252275Sjimharris printf("\n"); 106252275Sjimharris} 107252275Sjimharris 108252275Sjimharrisstatic void 109252275Sjimharrisprint_dwords(void *data, uint32_t length) 110252275Sjimharris{ 111252275Sjimharris uint32_t *p; 112252275Sjimharris uint32_t i, j; 113252275Sjimharris 114252275Sjimharris p = (uint32_t *)data; 115252275Sjimharris length /= sizeof(uint32_t); 116252275Sjimharris 117252275Sjimharris for (i = 0; i < length; i+=8) { 118252275Sjimharris printf("%03x: ", i*4); 119252275Sjimharris for (j = 0; j < 8; j++) 120252275Sjimharris printf("%08x ", p[i+j]); 121252275Sjimharris printf("\n"); 122252275Sjimharris } 123252275Sjimharris 124252275Sjimharris printf("\n"); 125252275Sjimharris} 126252275Sjimharris 127252265Sjimharrisvoid 128252275Sjimharrisprint_hex(void *data, uint32_t length) 129252275Sjimharris{ 130252275Sjimharris if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0) 131252275Sjimharris print_dwords(data, length); 132252275Sjimharris else 133252275Sjimharris print_bytes(data, length); 134252275Sjimharris} 135252275Sjimharris 136252275Sjimharrisvoid 137249422Sjimharrisread_controller_data(int fd, struct nvme_controller_data *cdata) 138249422Sjimharris{ 139249422Sjimharris struct nvme_pt_command pt; 140240620Sjimharris 141249422Sjimharris memset(&pt, 0, sizeof(pt)); 142249422Sjimharris pt.cmd.opc = NVME_OPC_IDENTIFY; 143249422Sjimharris pt.cmd.cdw10 = 1; 144249422Sjimharris pt.buf = cdata; 145249422Sjimharris pt.len = sizeof(*cdata); 146249422Sjimharris pt.is_read = 1; 147249422Sjimharris 148253109Sjimharris if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 149253109Sjimharris err(1, "identify request failed"); 150249422Sjimharris 151253109Sjimharris if (nvme_completion_is_error(&pt.cpl)) 152253109Sjimharris errx(1, "identify request returned error"); 153249422Sjimharris} 154249422Sjimharris 155252265Sjimharrisvoid 156249422Sjimharrisread_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata) 157249422Sjimharris{ 158249422Sjimharris struct nvme_pt_command pt; 159249422Sjimharris 160249422Sjimharris memset(&pt, 0, sizeof(pt)); 161249422Sjimharris pt.cmd.opc = NVME_OPC_IDENTIFY; 162249422Sjimharris pt.cmd.nsid = nsid; 163249422Sjimharris pt.buf = nsdata; 164249422Sjimharris pt.len = sizeof(*nsdata); 165249422Sjimharris pt.is_read = 1; 166249422Sjimharris 167253109Sjimharris if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 168253109Sjimharris err(1, "identify request failed"); 169249422Sjimharris 170253109Sjimharris if (nvme_completion_is_error(&pt.cpl)) 171253109Sjimharris errx(1, "identify request returned error"); 172249422Sjimharris} 173249422Sjimharris 174252265Sjimharrisint 175252263Sjimharrisopen_dev(const char *str, int *fd, int show_error, int exit_on_error) 176252263Sjimharris{ 177252263Sjimharris char full_path[64]; 178252263Sjimharris 179252274Sjimharris if (!strnstr(str, NVME_CTRLR_PREFIX, strlen(NVME_CTRLR_PREFIX))) { 180252274Sjimharris if (show_error) 181253109Sjimharris warnx("controller/namespace ids must begin with '%s'", 182252274Sjimharris NVME_CTRLR_PREFIX); 183252274Sjimharris if (exit_on_error) 184253109Sjimharris exit(1); 185252274Sjimharris else 186253458Sjimharris return (EINVAL); 187252274Sjimharris } 188252274Sjimharris 189253459Sjimharris snprintf(full_path, sizeof(full_path), _PATH_DEV"%s", str); 190252263Sjimharris *fd = open(full_path, O_RDWR); 191252263Sjimharris if (*fd < 0) { 192252263Sjimharris if (show_error) 193253109Sjimharris warn("could not open %s", full_path); 194252263Sjimharris if (exit_on_error) 195253109Sjimharris exit(1); 196252263Sjimharris else 197253458Sjimharris return (errno); 198252263Sjimharris } 199252263Sjimharris 200253109Sjimharris return (0); 201252263Sjimharris} 202252263Sjimharris 203253114Sjimharrisvoid 204253114Sjimharrisparse_ns_str(const char *ns_str, char *ctrlr_str, int *nsid) 205253114Sjimharris{ 206253114Sjimharris char *nsloc; 207253114Sjimharris 208253114Sjimharris /* 209253114Sjimharris * Pull the namespace id from the string. +2 skips past the "ns" part 210253114Sjimharris * of the string. Don't search past 10 characters into the string, 211253114Sjimharris * otherwise we know it is malformed. 212253114Sjimharris */ 213253114Sjimharris nsloc = strnstr(ns_str, NVME_NS_PREFIX, 10); 214253114Sjimharris if (nsloc != NULL) 215253114Sjimharris *nsid = strtol(nsloc + 2, NULL, 10); 216253114Sjimharris if (nsloc == NULL || (*nsid == 0 && errno != 0)) 217253114Sjimharris errx(1, "invalid namespace ID '%s'", ns_str); 218253114Sjimharris 219253114Sjimharris /* 220253114Sjimharris * The controller string will include only the nvmX part of the 221253114Sjimharris * nvmeXnsY string. 222253114Sjimharris */ 223253114Sjimharris snprintf(ctrlr_str, nsloc - ns_str + 1, "%s", ns_str); 224253114Sjimharris} 225253114Sjimharris 226240620Sjimharrisint 227240620Sjimharrismain(int argc, char *argv[]) 228240620Sjimharris{ 229240620Sjimharris 230240620Sjimharris if (argc < 2) 231328715Smav gen_usage(funcs); 232240620Sjimharris 233328715Smav dispatch(argc, argv, funcs); 234240620Sjimharris 235240620Sjimharris return (0); 236240620Sjimharris} 237