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