sbin/nvmecontrol/nvmecontrol.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (C) 2012-2013 Intel Corporation
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <sys/param.h>
  33 #include <sys/ioccom.h>
  34 #include <sys/stat.h>
  35
  36 #include <ctype.h>
  37 #include <dlfcn.h>
  38 #include <err.h>
  39 #include <errno.h>
  40 #include <fcntl.h>
  41 #include <libutil.h>
  42 #include <paths.h>
  43 #include <stdbool.h>
  44 #include <stddef.h>
  45 #include <stdio.h>
  46 #include <stdlib.h>
  47 #include <string.h>
  48 #include <sysexits.h>
  49 #include <unistd.h>
  50
  51 #include "nvmecontrol.h"
  52
  53 static void
  54 print_bytes(void *data, uint32_t length)
  55 {
  56         uint32_t        i, j;
  57         uint8_t         *p, *end;
  58
  59         end = (uint8_t *)data + length;
  60
  61         for (i = 0; i < length; i++) {
  62                 p = (uint8_t *)data + (i*16);
  63                 printf("%03x: ", i*16);
  64                 for (j = 0; j < 16 && p < end; j++)
  65                         printf("%02x ", *p++);
  66                 if (p >= end)
  67                         break;
  68                 printf("\n");
  69         }
  70         printf("\n");
  71 }
  72
  73 static void
  74 print_dwords(void *data, uint32_t length)
  75 {
  76         uint32_t        *p;
  77         uint32_t        i, j;
  78
  79         p = (uint32_t *)data;
  80         length /= sizeof(uint32_t);
  81
  82         for (i = 0; i < length; i+=8) {
  83                 printf("%03x: ", i*4);
  84                 for (j = 0; j < 8; j++)
  85                         printf("%08x ", p[i+j]);
  86                 printf("\n");
  87         }
  88
  89         printf("\n");
  90 }
  91
  92 void
  93 print_hex(void *data, uint32_t length)
  94 {
  95         if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0)
  96                 print_dwords(data, length);
  97         else
  98                 print_bytes(data, length);
  99 }
 100
 101 int
 102 read_controller_data(int fd, struct nvme_controller_data *cdata)
 103 {
 104         struct nvme_pt_command  pt;
 105
 106         memset(&pt, 0, sizeof(pt));
 107         pt.cmd.opc = NVME_OPC_IDENTIFY;
 108         pt.cmd.cdw10 = htole32(1);
 109         pt.buf = cdata;
 110         pt.len = sizeof(*cdata);
 111         pt.is_read = 1;
 112
 113         if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
 114                 return (errno);
 115
 116         /* Convert data to host endian */
 117         nvme_controller_data_swapbytes(cdata);
 118
 119         if (nvme_completion_is_error(&pt.cpl))
 120                 return (EIO);
 121         return (0);
 122 }
 123
 124 int
 125 read_namespace_data(int fd, uint32_t nsid, struct nvme_namespace_data *nsdata)
 126 {
 127         struct nvme_pt_command  pt;
 128
 129         memset(&pt, 0, sizeof(pt));
 130         pt.cmd.opc = NVME_OPC_IDENTIFY;
 131         pt.cmd.nsid = htole32(nsid);
 132         pt.cmd.cdw10 = htole32(0);
 133         pt.buf = nsdata;
 134         pt.len = sizeof(*nsdata);
 135         pt.is_read = 1;
 136
 137         if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
 138                 return (errno);
 139
 140         /* Convert data to host endian */
 141         nvme_namespace_data_swapbytes(nsdata);
 142
 143         if (nvme_completion_is_error(&pt.cpl))
 144                 return (EIO);
 145         return (0);
 146 }
 147
 148 int
 149 open_dev(const char *str, int *fd, int write, int exit_on_error)
 150 {
 151         char            full_path[64];
 152
 153         snprintf(full_path, sizeof(full_path), _PATH_DEV"%s", str);
 154         *fd = open(full_path, write ? O_RDWR : O_RDONLY);
 155         if (*fd < 0) {
 156                 if (exit_on_error) {
 157                         err(EX_OSFILE, "could not open %s%s", full_path,
 158                             write ? " for write" : "");
 159                 } else
 160                         return (errno);
 161         }
 162
 163         return (0);
 164 }
 165
 166 void
 167 get_nsid(int fd, char **ctrlr_str, uint32_t *nsid)
 168 {
 169         struct nvme_get_nsid gnsid;
 170
 171         if (ioctl(fd, NVME_GET_NSID, &gnsid) < 0)
 172                 err(EX_OSERR, "NVME_GET_NSID ioctl failed");
 173         if (ctrlr_str != NULL)
 174                 *ctrlr_str = strndup(gnsid.cdev, sizeof(gnsid.cdev));
 175         if (nsid != NULL)
 176                 *nsid = gnsid.nsid;
 177 }
 178
 179 int
 180 main(int argc, char *argv[])
 181 {
 182         static char dir[MAXPATHLEN];
 183
 184         cmd_init();
 185
 186         cmd_load_dir("/lib/nvmecontrol", NULL, NULL);
 187         snprintf(dir, MAXPATHLEN, "%s/lib/nvmecontrol", getlocalbase());
 188         cmd_load_dir(dir, NULL, NULL);
 189
 190         cmd_dispatch(argc, argv, NULL);
 191
 192         return (0);
 193 }