xref: /freebsd/sbin/nvmecontrol/devlist.c (revision 76afb20c58adb296f09857aed214b91464242264)
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 
34 #include <err.h>
35 #include <errno.h>
36 #include <fcntl.h>
37 #include <paths.h>
38 #include <stddef.h>
39 #include <stdio.h>
40 #include <stdlib.h>
41 #include <string.h>
42 #include <unistd.h>
43 
44 #include "nvmecontrol.h"
45 #include "comnd.h"
46 
47 /* Tables for command line parsing */
48 
49 #define NVME_MAX_UNIT 256
50 
51 static cmd_fn_t devlist;
52 
53 static struct cmd devlist_cmd = {
54 	.name = "devlist",
55 	.fn = devlist,
56 	.descr = "List NVMe controllers and namespaces"
57 };
58 
59 CMD_COMMAND(devlist_cmd);
60 
61 /* End of tables for command line parsing */
62 
63 static inline uint32_t
64 ns_get_sector_size(struct nvme_namespace_data *nsdata)
65 {
66 	uint8_t flbas_fmt, lbads;
67 
68 	flbas_fmt = (nsdata->flbas >> NVME_NS_DATA_FLBAS_FORMAT_SHIFT) &
69 		NVME_NS_DATA_FLBAS_FORMAT_MASK;
70 	lbads = (nsdata->lbaf[flbas_fmt] >> NVME_NS_DATA_LBAF_LBADS_SHIFT) &
71 		NVME_NS_DATA_LBAF_LBADS_MASK;
72 
73 	return (1 << lbads);
74 }
75 
76 static void
77 devlist(const struct cmd *f, int argc, char *argv[])
78 {
79 	struct nvme_controller_data	cdata;
80 	struct nvme_namespace_data	nsdata;
81 	char				name[64];
82 	uint8_t				mn[64];
83 	uint32_t			i;
84 	int				ctrlr, fd, found, ret;
85 
86 	if (arg_parse(argc, argv, f))
87 		return;
88 
89 	ctrlr = -1;
90 	found = 0;
91 
92 	while (ctrlr < NVME_MAX_UNIT) {
93 		ctrlr++;
94 		sprintf(name, "%s%d", NVME_CTRLR_PREFIX, ctrlr);
95 
96 		ret = open_dev(name, &fd, 0, 0);
97 
98 		if (ret == EACCES) {
99 			warnx("could not open "_PATH_DEV"%s\n", name);
100 			continue;
101 		} else if (ret != 0)
102 			continue;
103 
104 		found++;
105 		read_controller_data(fd, &cdata);
106 		nvme_strvis(mn, cdata.mn, sizeof(mn), NVME_MODEL_NUMBER_LENGTH);
107 		printf("%6s: %s\n", name, mn);
108 
109 		for (i = 0; i < cdata.nn; i++) {
110 			read_namespace_data(fd, i + 1, &nsdata);
111 			if (nsdata.nsze == 0)
112 				continue;
113 			sprintf(name, "%s%d%s%d", NVME_CTRLR_PREFIX, ctrlr,
114 			    NVME_NS_PREFIX, i + 1);
115 			printf("  %10s (%lldMB)\n",
116 				name,
117 				nsdata.nsze *
118 				(long long)ns_get_sector_size(&nsdata) /
119 				1024 / 1024);
120 		}
121 
122 		close(fd);
123 	}
124 
125 	if (found == 0)
126 		printf("No NVMe controllers found.\n");
127 
128 	exit(1);
129 }
130