sbin/nvmecontrol/nvmecontrol.c

   1 /*-
   2  * Copyright (C) 2012-2013 Intel Corporation
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 THE AUTHOR 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
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include <sys/param.h>
  31 #include <sys/ioccom.h>
  32 #include <sys/stat.h>
  33
  34 #include <ctype.h>
  35 #include <errno.h>
  36 #include <fcntl.h>
  37 #include <stdbool.h>
  38 #include <stddef.h>
  39 #include <stdio.h>
  40 #include <stdlib.h>
  41 #include <string.h>
  42 #include <sysexits.h>
  43 #include <unistd.h>
  44
  45 #include "nvmecontrol.h"
  46
  47 typedef void (*nvme_fn_t)(int argc, char *argv[]);
  48
  49 static struct nvme_function {
  50         const char      *name;
  51         nvme_fn_t       fn;
  52         const char      *usage;
  53 } funcs[] = {
  54         {"devlist",     devlist,        DEVLIST_USAGE},
  55         {"identify",    identify,       IDENTIFY_USAGE},
  56         {"perftest",    perftest,       PERFTEST_USAGE},
  57         {"reset",       reset,          RESET_USAGE},
  58         {"logpage",     logpage,        LOGPAGE_USAGE},
  59         {"firmware",    firmware,       FIRMWARE_USAGE},
  60         {NULL,          NULL,           NULL},
  61 };
  62
  63 static void
  64 usage(void)
  65 {
  66         struct nvme_function *f;
  67
  68         f = funcs;
  69         fprintf(stderr, "usage:\n");
  70         while (f->name != NULL) {
  71                 fprintf(stderr, "%s", f->usage);
  72                 f++;
  73         }
  74         exit(EX_USAGE);
  75 }
  76
  77 static void
  78 print_bytes(void *data, uint32_t length)
  79 {
  80         uint32_t        i, j;
  81         uint8_t         *p, *end;
  82
  83         end = (uint8_t *)data + length;
  84
  85         for (i = 0; i < length; i++) {
  86                 p = (uint8_t *)data + (i*16);
  87                 printf("%03x: ", i*16);
  88                 for (j = 0; j < 16 && p < end; j++)
  89                         printf("%02x ", *p++);
  90                 if (p >= end)
  91                         break;
  92                 printf("\n");
  93         }
  94         printf("\n");
  95 }
  96
  97 static void
  98 print_dwords(void *data, uint32_t length)
  99 {
 100         uint32_t        *p;
 101         uint32_t        i, j;
 102
 103         p = (uint32_t *)data;
 104         length /= sizeof(uint32_t);
 105
 106         for (i = 0; i < length; i+=8) {
 107                 printf("%03x: ", i*4);
 108                 for (j = 0; j < 8; j++)
 109                         printf("%08x ", p[i+j]);
 110                 printf("\n");
 111         }
 112
 113         printf("\n");
 114 }
 115
 116 void
 117 print_hex(void *data, uint32_t length)
 118 {
 119         if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0)
 120                 print_dwords(data, length);
 121         else
 122                 print_bytes(data, length);
 123 }
 124
 125 void
 126 read_controller_data(int fd, struct nvme_controller_data *cdata)
 127 {
 128         struct nvme_pt_command  pt;
 129
 130         memset(&pt, 0, sizeof(pt));
 131         pt.cmd.opc = NVME_OPC_IDENTIFY;
 132         pt.cmd.cdw10 = 1;
 133         pt.buf = cdata;
 134         pt.len = sizeof(*cdata);
 135         pt.is_read = 1;
 136
 137         if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) {
 138                 printf("Identify request failed. errno=%d (%s)\n",
 139                     errno, strerror(errno));
 140                 exit(EX_IOERR);
 141         }
 142
 143         if (nvme_completion_is_error(&pt.cpl)) {
 144                 printf("Passthrough command returned error.\n");
 145                 exit(EX_IOERR);
 146         }
 147 }
 148
 149 void
 150 read_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata)
 151 {
 152         struct nvme_pt_command  pt;
 153
 154         memset(&pt, 0, sizeof(pt));
 155         pt.cmd.opc = NVME_OPC_IDENTIFY;
 156         pt.cmd.nsid = nsid;
 157         pt.buf = nsdata;
 158         pt.len = sizeof(*nsdata);
 159         pt.is_read = 1;
 160
 161         if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) {
 162                 printf("Identify request failed. errno=%d (%s)\n",
 163                     errno, strerror(errno));
 164                 exit(EX_IOERR);
 165         }
 166
 167         if (nvme_completion_is_error(&pt.cpl)) {
 168                 printf("Passthrough command returned error.\n");
 169                 exit(EX_IOERR);
 170         }
 171 }
 172
 173 int
 174 open_dev(const char *str, int *fd, int show_error, int exit_on_error)
 175 {
 176         struct stat     devstat;
 177         char            full_path[64];
 178
 179         if (!strnstr(str, NVME_CTRLR_PREFIX, strlen(NVME_CTRLR_PREFIX))) {
 180                 if (show_error)
 181                         fprintf(stderr,
 182                             "Controller/namespace IDs must begin with '%s'.\n",
 183                             NVME_CTRLR_PREFIX);
 184                 if (exit_on_error)
 185                         exit(EX_USAGE);
 186                 else
 187                         return (EX_USAGE);
 188         }
 189
 190         snprintf(full_path, sizeof(full_path), "/dev/%s", str);
 191         if (stat(full_path, &devstat) != 0) {
 192                 if (show_error)
 193                         fprintf(stderr, "Could not stat %s. errno=%d (%s)\n",
 194                             full_path, errno, strerror(errno));
 195                 if (exit_on_error)
 196                         exit(EX_NOINPUT);
 197                 else
 198                         return (EX_NOINPUT);
 199         }
 200
 201         *fd = open(full_path, O_RDWR);
 202         if (*fd < 0) {
 203                 if (show_error)
 204                         fprintf(stderr, "Could not open %s. errno=%d (%s)\n",
 205                             full_path, errno, strerror(errno));
 206                 if (exit_on_error)
 207                         exit(EX_NOPERM);
 208                 else
 209                         return (EX_NOPERM);
 210         }
 211
 212         return (EX_OK);
 213 }
 214
 215 int
 216 main(int argc, char *argv[])
 217 {
 218         struct nvme_function *f;
 219
 220         if (argc < 2)
 221                 usage();
 222
 223         f = funcs;
 224         while (f->name != NULL) {
 225                 if (strcmp(argv[1], f->name) == 0)
 226                         f->fn(argc-1, &argv[1]);
 227                 f++;
 228         }
 229
 230         usage();
 231
 232         return (0);
 233 }