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 31 #include <err.h> 32 #include <errno.h> 33 #include <fcntl.h> 34 #include <stdbool.h> 35 #include <libutil.h> 36 #include <paths.h> 37 #include <stddef.h> 38 #include <stdio.h> 39 #include <stdlib.h> 40 #include <string.h> 41 #include <sysexits.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 options { 54 bool human; 55 } opt = { 56 .human = false, 57 }; 58 59 static const struct opts devlist_opts[] = { 60 #define OPT(l, s, t, opt, addr, desc) { l, s, t, &opt.addr, desc } 61 OPT("human", 'h', arg_none, opt, human, 62 "Show human readable disk size"), 63 { NULL, 0, arg_none, NULL, NULL } 64 }; 65 #undef OPT 66 67 static struct cmd devlist_cmd = { 68 .name = "devlist", 69 .fn = devlist, 70 .descr = "List NVMe controllers and namespaces", 71 .ctx_size = sizeof(opt), 72 .opts = devlist_opts, 73 .args = NULL, 74 }; 75 76 CMD_COMMAND(devlist_cmd); 77 78 /* End of tables for command line parsing */ 79 80 static inline uint32_t 81 ns_get_sector_size(struct nvme_namespace_data *nsdata) 82 { 83 uint8_t flbas_fmt, lbads; 84 85 flbas_fmt = NVMEV(NVME_NS_DATA_FLBAS_FORMAT, nsdata->flbas); 86 lbads = NVMEV(NVME_NS_DATA_LBAF_LBADS, nsdata->lbaf[flbas_fmt]); 87 88 return (1 << lbads); 89 } 90 91 static void 92 scan_namespace(int fd, int ctrlr, uint32_t nsid) 93 { 94 struct nvme_namespace_data nsdata; 95 char name[64]; 96 uint8_t buf[7]; 97 uint64_t size; 98 99 if (read_namespace_data(fd, nsid, &nsdata) != 0) 100 return; 101 if (nsdata.nsze == 0) 102 return; 103 snprintf(name, sizeof(name), "%s%d%s%d", NVME_CTRLR_PREFIX, ctrlr, 104 NVME_NS_PREFIX, nsid); 105 size = nsdata.nsze * (uint64_t)ns_get_sector_size(&nsdata); 106 if (opt.human) { 107 humanize_number(buf, sizeof(buf), size, "B", 108 HN_AUTOSCALE, HN_B | HN_NOSPACE | HN_DECIMAL); 109 printf(" %10s (%s)\n", name, buf); 110 } else { 111 printf(" %10s (%juMB)\n", name, (uintmax_t)size / 1024 / 1024); 112 } 113 } 114 115 static bool 116 scan_controller(int ctrlr) 117 { 118 struct nvme_controller_data cdata; 119 struct nvme_ns_list nslist; 120 char name[64]; 121 uint8_t mn[64]; 122 uint32_t nsid; 123 int fd, ret; 124 125 snprintf(name, sizeof(name), "%s%d", NVME_CTRLR_PREFIX, ctrlr); 126 127 ret = open_dev(name, &fd, 0, 0); 128 129 if (ret == EACCES) { 130 warnx("could not open "_PATH_DEV"%s\n", name); 131 return (false); 132 } else if (ret != 0) 133 return (false); 134 135 if (read_controller_data(fd, &cdata) != 0) { 136 close(fd); 137 return (true); 138 } 139 140 nvme_strvis(mn, cdata.mn, sizeof(mn), NVME_MODEL_NUMBER_LENGTH); 141 printf("%6s: %s\n", name, mn); 142 143 nsid = 0; 144 for (;;) { 145 if (read_active_namespaces(fd, nsid, &nslist) != 0) 146 break; 147 for (u_int i = 0; i < nitems(nslist.ns); i++) { 148 nsid = nslist.ns[i]; 149 if (nsid == 0) { 150 break; 151 } 152 153 scan_namespace(fd, ctrlr, nsid); 154 } 155 if (nsid == 0 || nsid >= NVME_GLOBAL_NAMESPACE_TAG - 1) 156 break; 157 } 158 159 close(fd); 160 return (true); 161 } 162 163 static void 164 devlist(const struct cmd *f, int argc, char *argv[]) 165 { 166 int ctrlr, found; 167 168 if (arg_parse(argc, argv, f)) 169 return; 170 171 ctrlr = -1; 172 found = 0; 173 174 while (ctrlr < NVME_MAX_UNIT) { 175 ctrlr++; 176 if (scan_controller(ctrlr)) 177 found++; 178 } 179 180 if (found == 0) { 181 printf("No NVMe controllers found.\n"); 182 exit(EX_UNAVAILABLE); 183 } 184 185 exit(0); 186 } 187