1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
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 #include <sys/param.h>
31 #include <sys/ioccom.h>
32 #include <sys/stat.h>
33
34 #include <ctype.h>
35 #include <dlfcn.h>
36 #include <err.h>
37 #include <errno.h>
38 #include <fcntl.h>
39 #include <libutil.h>
40 #include <paths.h>
41 #include <stdbool.h>
42 #include <stddef.h>
43 #include <stdio.h>
44 #include <stdlib.h>
45 #include <string.h>
46 #include <sysexits.h>
47 #include <unistd.h>
48
49 #include "nvmecontrol.h"
50
51 static void
print_bytes(void * data,uint32_t length)52 print_bytes(void *data, uint32_t length)
53 {
54 uint32_t i, j;
55 uint8_t *p, *end;
56
57 end = (uint8_t *)data + length;
58
59 for (i = 0; i < length; i++) {
60 p = (uint8_t *)data + (i*16);
61 printf("%03x: ", i*16);
62 for (j = 0; j < 16 && p < end; j++)
63 printf("%02x ", *p++);
64 if (p >= end)
65 break;
66 printf("\n");
67 }
68 printf("\n");
69 }
70
71 static void
print_dwords(void * data,uint32_t length)72 print_dwords(void *data, uint32_t length)
73 {
74 uint32_t *p;
75 uint32_t i, j;
76
77 p = (uint32_t *)data;
78 length /= sizeof(uint32_t);
79
80 for (i = 0; i < length; i+=8) {
81 printf("%03x: ", i*4);
82 for (j = 0; j < 8; j++)
83 printf("%08x ", p[i+j]);
84 printf("\n");
85 }
86
87 printf("\n");
88 }
89
90 void
print_hex(void * data,uint32_t length)91 print_hex(void *data, uint32_t length)
92 {
93 if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0)
94 print_dwords(data, length);
95 else
96 print_bytes(data, length);
97 }
98
99 int
read_controller_data(int fd,struct nvme_controller_data * cdata)100 read_controller_data(int fd, struct nvme_controller_data *cdata)
101 {
102 struct nvme_pt_command pt;
103
104 memset(&pt, 0, sizeof(pt));
105 pt.cmd.opc = NVME_OPC_IDENTIFY;
106 pt.cmd.cdw10 = htole32(1);
107 pt.buf = cdata;
108 pt.len = sizeof(*cdata);
109 pt.is_read = 1;
110
111 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
112 return (errno);
113
114 /* Convert data to host endian */
115 nvme_controller_data_swapbytes(cdata);
116
117 if (nvme_completion_is_error(&pt.cpl))
118 return (EIO);
119 return (0);
120 }
121
122 int
read_namespace_data(int fd,uint32_t nsid,struct nvme_namespace_data * nsdata)123 read_namespace_data(int fd, uint32_t nsid, struct nvme_namespace_data *nsdata)
124 {
125 struct nvme_pt_command pt;
126
127 memset(&pt, 0, sizeof(pt));
128 pt.cmd.opc = NVME_OPC_IDENTIFY;
129 pt.cmd.nsid = htole32(nsid);
130 pt.cmd.cdw10 = htole32(0);
131 pt.buf = nsdata;
132 pt.len = sizeof(*nsdata);
133 pt.is_read = 1;
134
135 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
136 return (errno);
137
138 /* Convert data to host endian */
139 nvme_namespace_data_swapbytes(nsdata);
140
141 if (nvme_completion_is_error(&pt.cpl))
142 return (EIO);
143 return (0);
144 }
145
146 int
open_dev(const char * str,int * fd,int write,int exit_on_error)147 open_dev(const char *str, int *fd, int write, int exit_on_error)
148 {
149 char full_path[MAXPATHLEN];
150
151 if (str[0] == '/') /* Full path */
152 strlcpy(full_path, str, sizeof(full_path));
153 else /* Add /dev/ */
154 snprintf(full_path, sizeof(full_path), _PATH_DEV"%s", str);
155 *fd = open(full_path, write ? O_RDWR : O_RDONLY);
156 if (*fd < 0) {
157 if (exit_on_error) {
158 err(EX_OSFILE, "could not open %s%s", full_path,
159 write ? " for write" : "");
160 } else
161 return (errno);
162 }
163
164 return (0);
165 }
166
167 void
get_nsid(int fd,char ** ctrlr_str,uint32_t * nsid)168 get_nsid(int fd, char **ctrlr_str, uint32_t *nsid)
169 {
170 struct nvme_get_nsid gnsid;
171
172 if (ioctl(fd, NVME_GET_NSID, &gnsid) < 0)
173 err(EX_OSERR, "NVME_GET_NSID ioctl failed");
174 if (ctrlr_str != NULL)
175 *ctrlr_str = strndup(gnsid.cdev, sizeof(gnsid.cdev));
176 if (nsid != NULL)
177 *nsid = gnsid.nsid;
178 }
179
180 int
main(int argc,char * argv[])181 main(int argc, char *argv[])
182 {
183 static char dir[MAXPATHLEN];
184
185 cmd_init();
186
187 cmd_load_dir("/lib/nvmecontrol", NULL, NULL);
188 snprintf(dir, MAXPATHLEN, "%s/lib/nvmecontrol", getlocalbase());
189 cmd_load_dir(dir, NULL, NULL);
190
191 cmd_dispatch(argc, argv, NULL);
192
193 return (0);
194 }
195