sbin/nvmecontrol/devlist.c

   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 <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 cmd devlist_cmd = {
  55         .name = "devlist",
  56         .fn = devlist,
  57         .descr = "List NVMe controllers and namespaces"
  58 };
  59
  60 CMD_COMMAND(devlist_cmd);
  61
  62 /* End of tables for command line parsing */
  63
  64 static inline uint32_t
  65 ns_get_sector_size(struct nvme_namespace_data *nsdata)
  66 {
  67         uint8_t flbas_fmt, lbads;
  68
  69         flbas_fmt = (nsdata->flbas >> NVME_NS_DATA_FLBAS_FORMAT_SHIFT) &
  70                 NVME_NS_DATA_FLBAS_FORMAT_MASK;
  71         lbads = (nsdata->lbaf[flbas_fmt] >> NVME_NS_DATA_LBAF_LBADS_SHIFT) &
  72                 NVME_NS_DATA_LBAF_LBADS_MASK;
  73
  74         return (1 << lbads);
  75 }
  76
  77 static void
  78 devlist(const struct cmd *f, int argc, char *argv[])
  79 {
  80         struct nvme_controller_data     cdata;
  81         struct nvme_namespace_data      nsdata;
  82         char                            name[64];
  83         uint8_t                         mn[64];
  84         uint32_t                        i;
  85         int                             ctrlr, fd, found, ret;
  86
  87         if (arg_parse(argc, argv, f))
  88                 return;
  89
  90         ctrlr = -1;
  91         found = 0;
  92
  93         while (ctrlr < NVME_MAX_UNIT) {
  94                 ctrlr++;
  95                 sprintf(name, "%s%d", NVME_CTRLR_PREFIX, ctrlr);
  96
  97                 ret = open_dev(name, &fd, 0, 0);
  98
  99                 if (ret == EACCES) {
 100                         warnx("could not open "_PATH_DEV"%s\n", name);
 101                         continue;
 102                 } else if (ret != 0)
 103                         continue;
 104
 105                 found++;
 106                 if (read_controller_data(fd, &cdata))
 107                         continue;
 108                 nvme_strvis(mn, cdata.mn, sizeof(mn), NVME_MODEL_NUMBER_LENGTH);
 109                 printf("%6s: %s\n", name, mn);
 110
 111                 for (i = 0; i < cdata.nn; i++) {
 112                         if (read_namespace_data(fd, i + 1, &nsdata))
 113                                 continue;
 114                         if (nsdata.nsze == 0)
 115                                 continue;
 116                         sprintf(name, "%s%d%s%d", NVME_CTRLR_PREFIX, ctrlr,
 117                             NVME_NS_PREFIX, i + 1);
 118                         printf("  %10s (%lldMB)\n",
 119                                 name,
 120                                 nsdata.nsze *
 121                                 (long long)ns_get_sector_size(&nsdata) /
 122                                 1024 / 1024);
 123                 }
 124
 125                 close(fd);
 126         }
 127
 128         if (found == 0) {
 129                 printf("No NVMe controllers found.\n");
 130                 exit(EX_UNAVAILABLE);
 131         }
 132
 133         exit(0);
 134 }