xref: /freebsd/sbin/nvmecontrol/devlist.c (revision 9f23cbd6cae82fd77edfad7173432fa8dccd0a95)
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 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 
34 #include <err.h>
35 #include <errno.h>
36 #include <fcntl.h>
37 #include <stdbool.h>
38 #include <libutil.h>
39 #include <paths.h>
40 #include <stddef.h>
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <string.h>
44 #include <sysexits.h>
45 #include <unistd.h>
46 
47 #include "nvmecontrol.h"
48 #include "comnd.h"
49 
50 /* Tables for command line parsing */
51 
52 #define NVME_MAX_UNIT 256
53 
54 static cmd_fn_t devlist;
55 
56 static struct options {
57 	bool	human;
58 } opt = {
59 	.human = false,
60 };
61 
62 static const struct opts devlist_opts[] = {
63 #define OPT(l, s, t, opt, addr, desc) { l, s, t, &opt.addr, desc }
64 	OPT("human", 'h', arg_none, opt, human,
65 	    "Show human readable disk size"),
66 	{ NULL, 0, arg_none, NULL, NULL }
67 };
68 #undef OPT
69 
70 static struct cmd devlist_cmd = {
71 	.name = "devlist",
72 	.fn = devlist,
73 	.descr = "List NVMe controllers and namespaces",
74 	.ctx_size = sizeof(opt),
75 	.opts = devlist_opts,
76 	.args = NULL,
77 };
78 
79 CMD_COMMAND(devlist_cmd);
80 
81 /* End of tables for command line parsing */
82 
83 static inline uint32_t
84 ns_get_sector_size(struct nvme_namespace_data *nsdata)
85 {
86 	uint8_t flbas_fmt, lbads;
87 
88 	flbas_fmt = (nsdata->flbas >> NVME_NS_DATA_FLBAS_FORMAT_SHIFT) &
89 		NVME_NS_DATA_FLBAS_FORMAT_MASK;
90 	lbads = (nsdata->lbaf[flbas_fmt] >> NVME_NS_DATA_LBAF_LBADS_SHIFT) &
91 		NVME_NS_DATA_LBAF_LBADS_MASK;
92 
93 	return (1 << lbads);
94 }
95 
96 static void
97 devlist(const struct cmd *f, int argc, char *argv[])
98 {
99 	struct nvme_controller_data	cdata;
100 	struct nvme_namespace_data	nsdata;
101 	char				name[64];
102 	uint8_t				mn[64];
103 	uint8_t				buf[7];
104 	uint32_t			i;
105 	uint64_t			size;
106 	int				ctrlr, fd, found, ret;
107 
108 	if (arg_parse(argc, argv, f))
109 		return;
110 
111 	ctrlr = -1;
112 	found = 0;
113 
114 	while (ctrlr < NVME_MAX_UNIT) {
115 		ctrlr++;
116 		sprintf(name, "%s%d", NVME_CTRLR_PREFIX, ctrlr);
117 
118 		ret = open_dev(name, &fd, 0, 0);
119 
120 		if (ret == EACCES) {
121 			warnx("could not open "_PATH_DEV"%s\n", name);
122 			continue;
123 		} else if (ret != 0)
124 			continue;
125 
126 		found++;
127 		if (read_controller_data(fd, &cdata))
128 			continue;
129 		nvme_strvis(mn, cdata.mn, sizeof(mn), NVME_MODEL_NUMBER_LENGTH);
130 		printf("%6s: %s\n", name, mn);
131 
132 		for (i = 0; i < cdata.nn; i++) {
133 			if (read_namespace_data(fd, i + 1, &nsdata))
134 				continue;
135 			if (nsdata.nsze == 0)
136 				continue;
137 			sprintf(name, "%s%d%s%d", NVME_CTRLR_PREFIX, ctrlr,
138 			    NVME_NS_PREFIX, i + 1);
139 			size = nsdata.nsze * (uint64_t)ns_get_sector_size(&nsdata);
140 			if (opt.human) {
141 				humanize_number(buf, sizeof(buf), size, "B",
142 				    HN_AUTOSCALE, HN_B | HN_NOSPACE | HN_DECIMAL);
143 				printf("  %10s (%s)\n", name, buf);
144 
145 			} else {
146 				printf("  %10s (%juMB)\n", name, (uintmax_t)size / 1024 / 1024);
147 			}
148 		}
149 
150 		close(fd);
151 	}
152 
153 	if (found == 0) {
154 		printf("No NVMe controllers found.\n");
155 		exit(EX_UNAVAILABLE);
156 	}
157 
158 	exit(0);
159 }
160