nvmecontrol.c revision 252278
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: head/sbin/nvmecontrol/nvmecontrol.c 252278 2013-06-27 00:08:25Z jimharris $"); 29240620Sjimharris 30240620Sjimharris#include <sys/param.h> 31240620Sjimharris#include <sys/ioccom.h> 32240620Sjimharris#include <sys/stat.h> 33240620Sjimharris 34240620Sjimharris#include <ctype.h> 35240620Sjimharris#include <errno.h> 36240620Sjimharris#include <fcntl.h> 37240620Sjimharris#include <stdbool.h> 38240620Sjimharris#include <stddef.h> 39240620Sjimharris#include <stdio.h> 40240620Sjimharris#include <stdlib.h> 41240620Sjimharris#include <string.h> 42240620Sjimharris#include <sysexits.h> 43240620Sjimharris#include <unistd.h> 44240620Sjimharris 45252265Sjimharris#include "nvmecontrol.h" 46240620Sjimharris 47252269Sjimharristypedef void (*nvme_fn_t)(int argc, char *argv[]); 48252269Sjimharris 49252269Sjimharrisstruct nvme_function { 50252269Sjimharris const char *name; 51252269Sjimharris nvme_fn_t fn; 52252269Sjimharris const char *usage; 53252269Sjimharris} funcs[] = { 54252269Sjimharris {"devlist", devlist, DEVLIST_USAGE}, 55252269Sjimharris {"identify", identify, IDENTIFY_USAGE}, 56252269Sjimharris {"perftest", perftest, PERFTEST_USAGE}, 57252269Sjimharris {"reset", reset, RESET_USAGE}, 58252277Sjimharris {"logpage", logpage, LOGPAGE_USAGE}, 59252278Sjimharris {"firmware", firmware, FIRMWARE_USAGE}, 60252269Sjimharris {NULL, NULL, NULL}, 61252269Sjimharris}; 62252269Sjimharris 63240620Sjimharrisstatic void 64240620Sjimharrisusage(void) 65240620Sjimharris{ 66252269Sjimharris struct nvme_function *f; 67252269Sjimharris 68252269Sjimharris f = funcs; 69240620Sjimharris fprintf(stderr, "usage:\n"); 70252269Sjimharris while (f->name != NULL) { 71252269Sjimharris fprintf(stderr, "%s", f->usage); 72252269Sjimharris f++; 73252269Sjimharris } 74240620Sjimharris exit(EX_USAGE); 75240620Sjimharris} 76240620Sjimharris 77252275Sjimharrisstatic void 78252275Sjimharrisprint_bytes(void *data, uint32_t length) 79252275Sjimharris{ 80252275Sjimharris uint32_t i, j; 81252275Sjimharris uint8_t *p, *end; 82252275Sjimharris 83252275Sjimharris end = (uint8_t *)data + length; 84252275Sjimharris 85252275Sjimharris for (i = 0; i < length; i++) { 86252275Sjimharris p = (uint8_t *)data + (i*16); 87252275Sjimharris printf("%03x: ", i*16); 88252275Sjimharris for (j = 0; j < 16 && p < end; j++) 89252275Sjimharris printf("%02x ", *p++); 90252275Sjimharris if (p >= end) 91252275Sjimharris break; 92252275Sjimharris printf("\n"); 93252275Sjimharris } 94252275Sjimharris printf("\n"); 95252275Sjimharris} 96252275Sjimharris 97252275Sjimharrisstatic void 98252275Sjimharrisprint_dwords(void *data, uint32_t length) 99252275Sjimharris{ 100252275Sjimharris uint32_t *p; 101252275Sjimharris uint32_t i, j; 102252275Sjimharris 103252275Sjimharris p = (uint32_t *)data; 104252275Sjimharris length /= sizeof(uint32_t); 105252275Sjimharris 106252275Sjimharris for (i = 0; i < length; i+=8) { 107252275Sjimharris printf("%03x: ", i*4); 108252275Sjimharris for (j = 0; j < 8; j++) 109252275Sjimharris printf("%08x ", p[i+j]); 110252275Sjimharris printf("\n"); 111252275Sjimharris } 112252275Sjimharris 113252275Sjimharris printf("\n"); 114252275Sjimharris} 115252275Sjimharris 116252265Sjimharrisvoid 117252275Sjimharrisprint_hex(void *data, uint32_t length) 118252275Sjimharris{ 119252275Sjimharris if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0) 120252275Sjimharris print_dwords(data, length); 121252275Sjimharris else 122252275Sjimharris print_bytes(data, length); 123252275Sjimharris} 124252275Sjimharris 125252275Sjimharrisvoid 126249422Sjimharrisread_controller_data(int fd, struct nvme_controller_data *cdata) 127249422Sjimharris{ 128249422Sjimharris struct nvme_pt_command pt; 129240620Sjimharris 130249422Sjimharris memset(&pt, 0, sizeof(pt)); 131249422Sjimharris pt.cmd.opc = NVME_OPC_IDENTIFY; 132249422Sjimharris pt.cmd.cdw10 = 1; 133249422Sjimharris pt.buf = cdata; 134249422Sjimharris pt.len = sizeof(*cdata); 135249422Sjimharris pt.is_read = 1; 136249422Sjimharris 137249422Sjimharris if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) { 138249422Sjimharris printf("Identify request failed. errno=%d (%s)\n", 139249422Sjimharris errno, strerror(errno)); 140249422Sjimharris exit(EX_IOERR); 141249422Sjimharris } 142249422Sjimharris 143249422Sjimharris if (nvme_completion_is_error(&pt.cpl)) { 144249422Sjimharris printf("Passthrough command returned error.\n"); 145249422Sjimharris exit(EX_IOERR); 146249422Sjimharris } 147249422Sjimharris} 148249422Sjimharris 149252265Sjimharrisvoid 150249422Sjimharrisread_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata) 151249422Sjimharris{ 152249422Sjimharris struct nvme_pt_command pt; 153249422Sjimharris 154249422Sjimharris memset(&pt, 0, sizeof(pt)); 155249422Sjimharris pt.cmd.opc = NVME_OPC_IDENTIFY; 156249422Sjimharris pt.cmd.nsid = nsid; 157249422Sjimharris pt.buf = nsdata; 158249422Sjimharris pt.len = sizeof(*nsdata); 159249422Sjimharris pt.is_read = 1; 160249422Sjimharris 161249422Sjimharris if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) { 162249422Sjimharris printf("Identify request failed. errno=%d (%s)\n", 163249422Sjimharris errno, strerror(errno)); 164249422Sjimharris exit(EX_IOERR); 165249422Sjimharris } 166249422Sjimharris 167249422Sjimharris if (nvme_completion_is_error(&pt.cpl)) { 168249422Sjimharris printf("Passthrough command returned error.\n"); 169249422Sjimharris exit(EX_IOERR); 170249422Sjimharris } 171249422Sjimharris} 172249422Sjimharris 173252265Sjimharrisint 174252263Sjimharrisopen_dev(const char *str, int *fd, int show_error, int exit_on_error) 175252263Sjimharris{ 176252263Sjimharris struct stat devstat; 177252263Sjimharris char full_path[64]; 178252263Sjimharris 179252274Sjimharris if (!strnstr(str, NVME_CTRLR_PREFIX, strlen(NVME_CTRLR_PREFIX))) { 180252274Sjimharris if (show_error) 181252274Sjimharris fprintf(stderr, 182252274Sjimharris "Controller/namespace IDs must begin with '%s'.\n", 183252274Sjimharris NVME_CTRLR_PREFIX); 184252274Sjimharris if (exit_on_error) 185252274Sjimharris exit(EX_USAGE); 186252274Sjimharris else 187252274Sjimharris return (EX_USAGE); 188252274Sjimharris } 189252274Sjimharris 190252263Sjimharris snprintf(full_path, sizeof(full_path), "/dev/%s", str); 191252263Sjimharris if (stat(full_path, &devstat) != 0) { 192252263Sjimharris if (show_error) 193252274Sjimharris fprintf(stderr, "Could not stat %s. errno=%d (%s)\n", 194252274Sjimharris full_path, errno, strerror(errno)); 195252263Sjimharris if (exit_on_error) 196252263Sjimharris exit(EX_NOINPUT); 197252263Sjimharris else 198252263Sjimharris return (EX_NOINPUT); 199252263Sjimharris } 200252263Sjimharris 201252263Sjimharris *fd = open(full_path, O_RDWR); 202252263Sjimharris if (*fd < 0) { 203252263Sjimharris if (show_error) 204252274Sjimharris fprintf(stderr, "Could not open %s. errno=%d (%s)\n", 205252274Sjimharris full_path, errno, strerror(errno)); 206252263Sjimharris if (exit_on_error) 207252263Sjimharris exit(EX_NOPERM); 208252263Sjimharris else 209252263Sjimharris return (EX_NOPERM); 210252263Sjimharris } 211252263Sjimharris 212252263Sjimharris return (EX_OK); 213252263Sjimharris} 214252263Sjimharris 215240620Sjimharrisint 216240620Sjimharrismain(int argc, char *argv[]) 217240620Sjimharris{ 218252269Sjimharris struct nvme_function *f; 219240620Sjimharris 220240620Sjimharris if (argc < 2) 221240620Sjimharris usage(); 222240620Sjimharris 223252269Sjimharris f = funcs; 224252269Sjimharris while (f->name != NULL) { 225252269Sjimharris if (strcmp(argv[1], f->name) == 0) 226252269Sjimharris f->fn(argc-1, &argv[1]); 227252269Sjimharris f++; 228252269Sjimharris } 229240620Sjimharris 230240620Sjimharris usage(); 231240620Sjimharris 232240620Sjimharris return (0); 233240620Sjimharris} 234