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