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 = (nsdata->flbas >> NVME_NS_DATA_FLBAS_FORMAT_SHIFT) & 86 NVME_NS_DATA_FLBAS_FORMAT_MASK; 87 lbads = (nsdata->lbaf[flbas_fmt] >> NVME_NS_DATA_LBAF_LBADS_SHIFT) & 88 NVME_NS_DATA_LBAF_LBADS_MASK; 89 90 return (1 << lbads); 91 } 92 93 static void 94 devlist(const struct cmd *f, int argc, char *argv[]) 95 { 96 struct nvme_controller_data cdata; 97 struct nvme_namespace_data nsdata; 98 char name[64]; 99 uint8_t mn[64]; 100 uint8_t buf[7]; 101 uint32_t i; 102 uint64_t size; 103 int ctrlr, fd, found, ret; 104 105 if (arg_parse(argc, argv, f)) 106 return; 107 108 ctrlr = -1; 109 found = 0; 110 111 while (ctrlr < NVME_MAX_UNIT) { 112 ctrlr++; 113 sprintf(name, "%s%d", NVME_CTRLR_PREFIX, ctrlr); 114 115 ret = open_dev(name, &fd, 0, 0); 116 117 if (ret == EACCES) { 118 warnx("could not open "_PATH_DEV"%s\n", name); 119 continue; 120 } else if (ret != 0) 121 continue; 122 123 found++; 124 if (read_controller_data(fd, &cdata)) 125 continue; 126 nvme_strvis(mn, cdata.mn, sizeof(mn), NVME_MODEL_NUMBER_LENGTH); 127 printf("%6s: %s\n", name, mn); 128 129 for (i = 0; i < cdata.nn; i++) { 130 if (read_namespace_data(fd, i + 1, &nsdata)) 131 continue; 132 if (nsdata.nsze == 0) 133 continue; 134 sprintf(name, "%s%d%s%d", NVME_CTRLR_PREFIX, ctrlr, 135 NVME_NS_PREFIX, i + 1); 136 size = nsdata.nsze * (uint64_t)ns_get_sector_size(&nsdata); 137 if (opt.human) { 138 humanize_number(buf, sizeof(buf), size, "B", 139 HN_AUTOSCALE, HN_B | HN_NOSPACE | HN_DECIMAL); 140 printf(" %10s (%s)\n", name, buf); 141 142 } else { 143 printf(" %10s (%juMB)\n", name, (uintmax_t)size / 1024 / 1024); 144 } 145 } 146 147 close(fd); 148 } 149 150 if (found == 0) { 151 printf("No NVMe controllers found.\n"); 152 exit(EX_UNAVAILABLE); 153 } 154 155 exit(0); 156 } 157