sbin/nvmecontrol/logpage.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2013 EMC Corp.
   5  * All rights reserved.
   6  *
   7  * Copyright (C) 2012-2013 Intel Corporation
   8  * All rights reserved.
   9  * Copyright (C) 2018-2019 Alexander Motin <mav@FreeBSD.org>
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD$");
  35
  36 #include <sys/param.h>
  37 #include <sys/ioccom.h>
  38
  39 #include <ctype.h>
  40 #include <err.h>
  41 #include <fcntl.h>
  42 #include <stdbool.h>
  43 #include <stddef.h>
  44 #include <stdio.h>
  45 #include <stdlib.h>
  46 #include <string.h>
  47 #include <sysexits.h>
  48 #include <unistd.h>
  49 #include <sys/endian.h>
  50
  51 #include "nvmecontrol.h"
  52
  53 /* Tables for command line parsing */
  54
  55 static cmd_fn_t logpage;
  56
  57 #define NONE 0xffffffffu
  58 static struct options {
  59         bool            binary;
  60         bool            hex;
  61         uint32_t        page;
  62         uint8_t         lsp;
  63         uint16_t        lsi;
  64         bool            rae;
  65         const char      *vendor;
  66         const char      *dev;
  67 } opt = {
  68         .binary = false,
  69         .hex = false,
  70         .page = NONE,
  71         .lsp = 0,
  72         .lsi = 0,
  73         .rae = false,
  74         .vendor = NULL,
  75         .dev = NULL,
  76 };
  77
  78 static const struct opts logpage_opts[] = {
  79 #define OPT(l, s, t, opt, addr, desc) { l, s, t, &opt.addr, desc }
  80         OPT("binary", 'b', arg_none, opt, binary,
  81             "Dump the log page as binary"),
  82         OPT("hex", 'x', arg_none, opt, hex,
  83             "Dump the log page as hex"),
  84         OPT("page", 'p', arg_uint32, opt, page,
  85             "Page to dump"),
  86         OPT("lsp", 'f', arg_uint8, opt, lsp,
  87             "Log Specific Field"),
  88         OPT("lsi", 'i', arg_uint16, opt, lsi,
  89             "Log Specific Identifier"),
  90         OPT("rae", 'r', arg_none, opt, rae,
  91             "Retain Asynchronous Event"),
  92         OPT("vendor", 'v', arg_string, opt, vendor,
  93             "Vendor specific formatting"),
  94         { NULL, 0, arg_none, NULL, NULL }
  95 };
  96 #undef OPT
  97
  98 static const struct args logpage_args[] = {
  99         { arg_string, &opt.dev, "<controller id|namespace id>" },
 100         { arg_none, NULL, NULL },
 101 };
 102
 103 static struct cmd logpage_cmd = {
 104         .name = "logpage",
 105         .fn = logpage,
 106         .descr = "Print logpages in human-readable form",
 107         .ctx_size = sizeof(opt),
 108         .opts = logpage_opts,
 109         .args = logpage_args,
 110 };
 111
 112 CMD_COMMAND(logpage_cmd);
 113
 114 /* End of tables for command line parsing */
 115
 116 #define MAX_FW_SLOTS    (7)
 117
 118 static SLIST_HEAD(,logpage_function) logpages;
 119
 120 static int
 121 logpage_compare(struct logpage_function *a, struct logpage_function *b)
 122 {
 123         int c;
 124
 125         if ((a->vendor == NULL) != (b->vendor == NULL))
 126                 return (a->vendor == NULL ? -1 : 1);
 127         if (a->vendor != NULL) {
 128                 c = strcmp(a->vendor, b->vendor);
 129                 if (c != 0)
 130                         return (c);
 131         }
 132         return ((int)a->log_page - (int)b->log_page);
 133 }
 134
 135 void
 136 logpage_register(struct logpage_function *p)
 137 {
 138         struct logpage_function *l, *a;
 139
 140         a = NULL;
 141         l = SLIST_FIRST(&logpages);
 142         while (l != NULL) {
 143                 if (logpage_compare(l, p) > 0)
 144                         break;
 145                 a = l;
 146                 l = SLIST_NEXT(l, link);
 147         }
 148         if (a == NULL)
 149                 SLIST_INSERT_HEAD(&logpages, p, link);
 150         else
 151                 SLIST_INSERT_AFTER(a, p, link);
 152 }
 153
 154 const char *
 155 kv_lookup(const struct kv_name *kv, size_t kv_count, uint32_t key)
 156 {
 157         static char bad[32];
 158         size_t i;
 159
 160         for (i = 0; i < kv_count; i++, kv++)
 161                 if (kv->key == key)
 162                         return kv->name;
 163         snprintf(bad, sizeof(bad), "Attribute %#x", key);
 164         return bad;
 165 }
 166
 167 static void
 168 print_log_hex(const struct nvme_controller_data *cdata __unused, void *data, uint32_t length)
 169 {
 170
 171         print_hex(data, length);
 172 }
 173
 174 static void
 175 print_bin(const struct nvme_controller_data *cdata __unused, void *data, uint32_t length)
 176 {
 177
 178         write(STDOUT_FILENO, data, length);
 179 }
 180
 181 static void *
 182 get_log_buffer(uint32_t size)
 183 {
 184         void    *buf;
 185
 186         if ((buf = malloc(size)) == NULL)
 187                 errx(EX_OSERR, "unable to malloc %u bytes", size);
 188
 189         memset(buf, 0, size);
 190         return (buf);
 191 }
 192
 193 void
 194 read_logpage(int fd, uint8_t log_page, uint32_t nsid, uint8_t lsp,
 195     uint16_t lsi, uint8_t rae, void *payload, uint32_t payload_size)
 196 {
 197         struct nvme_pt_command  pt;
 198         struct nvme_error_information_entry     *err_entry;
 199         u_int i, err_pages, numd;
 200
 201         numd = payload_size / sizeof(uint32_t) - 1;
 202         memset(&pt, 0, sizeof(pt));
 203         pt.cmd.opc = NVME_OPC_GET_LOG_PAGE;
 204         pt.cmd.nsid = htole32(nsid);
 205         pt.cmd.cdw10 = htole32(
 206             (numd << 16) |                      /* NUMDL */
 207             (rae << 15) |                       /* RAE */
 208             (lsp << 8) |                        /* LSP */
 209             log_page);                          /* LID */
 210         pt.cmd.cdw11 = htole32(
 211             ((uint32_t)lsi << 16) |             /* LSI */
 212             (numd >> 16));                      /* NUMDU */
 213         pt.cmd.cdw12 = 0;                       /* LPOL */
 214         pt.cmd.cdw13 = 0;                       /* LPOU */
 215         pt.cmd.cdw14 = 0;                       /* UUID Index */
 216         pt.buf = payload;
 217         pt.len = payload_size;
 218         pt.is_read = 1;
 219
 220         if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
 221                 err(EX_IOERR, "get log page request failed");
 222
 223         /* Convert data to host endian */
 224         switch (log_page) {
 225         case NVME_LOG_ERROR:
 226                 err_entry = (struct nvme_error_information_entry *)payload;
 227                 err_pages = payload_size / sizeof(struct nvme_error_information_entry);
 228                 for (i = 0; i < err_pages; i++)
 229                         nvme_error_information_entry_swapbytes(err_entry++);
 230                 break;
 231         case NVME_LOG_HEALTH_INFORMATION:
 232                 nvme_health_information_page_swapbytes(
 233                     (struct nvme_health_information_page *)payload);
 234                 break;
 235         case NVME_LOG_FIRMWARE_SLOT:
 236                 nvme_firmware_page_swapbytes(
 237                     (struct nvme_firmware_page *)payload);
 238                 break;
 239         case NVME_LOG_CHANGED_NAMESPACE:
 240                 nvme_ns_list_swapbytes((struct nvme_ns_list *)payload);
 241                 break;
 242         case NVME_LOG_COMMAND_EFFECT:
 243                 nvme_command_effects_page_swapbytes(
 244                     (struct nvme_command_effects_page *)payload);
 245                 break;
 246         case NVME_LOG_RES_NOTIFICATION:
 247                 nvme_res_notification_page_swapbytes(
 248                     (struct nvme_res_notification_page *)payload);
 249                 break;
 250         case NVME_LOG_SANITIZE_STATUS:
 251                 nvme_sanitize_status_page_swapbytes(
 252                     (struct nvme_sanitize_status_page *)payload);
 253                 break;
 254         case INTEL_LOG_TEMP_STATS:
 255                 intel_log_temp_stats_swapbytes(
 256                     (struct intel_log_temp_stats *)payload);
 257                 break;
 258         default:
 259                 break;
 260         }
 261
 262         if (nvme_completion_is_error(&pt.cpl))
 263                 errx(EX_IOERR, "get log page request returned error");
 264 }
 265
 266 static void
 267 print_log_error(const struct nvme_controller_data *cdata __unused, void *buf, uint32_t size)
 268 {
 269         int                                     i, nentries;
 270         uint16_t                                status;
 271         uint8_t                                 p, sc, sct, m, dnr;
 272         struct nvme_error_information_entry     *entry = buf;
 273
 274         printf("Error Information Log\n");
 275         printf("=====================\n");
 276
 277         if (entry->error_count == 0) {
 278                 printf("No error entries found\n");
 279                 return;
 280         }
 281
 282         nentries = size/sizeof(struct nvme_error_information_entry);
 283         for (i = 0; i < nentries; i++, entry++) {
 284                 if (entry->error_count == 0)
 285                         break;
 286
 287                 status = entry->status;
 288
 289                 p = NVME_STATUS_GET_P(status);
 290                 sc = NVME_STATUS_GET_SC(status);
 291                 sct = NVME_STATUS_GET_SCT(status);
 292                 m = NVME_STATUS_GET_M(status);
 293                 dnr = NVME_STATUS_GET_DNR(status);
 294
 295                 printf("Entry %02d\n", i + 1);
 296                 printf("=========\n");
 297                 printf(" Error count:          %ju\n", entry->error_count);
 298                 printf(" Submission queue ID:  %u\n", entry->sqid);
 299                 printf(" Command ID:           %u\n", entry->cid);
 300                 /* TODO: Export nvme_status_string structures from kernel? */
 301                 printf(" Status:\n");
 302                 printf("  Phase tag:           %d\n", p);
 303                 printf("  Status code:         %d\n", sc);
 304                 printf("  Status code type:    %d\n", sct);
 305                 printf("  More:                %d\n", m);
 306                 printf("  DNR:                 %d\n", dnr);
 307                 printf(" Error location:       %u\n", entry->error_location);
 308                 printf(" LBA:                  %ju\n", entry->lba);
 309                 printf(" Namespace ID:         %u\n", entry->nsid);
 310                 printf(" Vendor specific info: %u\n", entry->vendor_specific);
 311                 printf(" Transport type:       %u\n", entry->trtype);
 312                 printf(" Command specific info:%ju\n", entry->csi);
 313                 printf(" Transport specific:   %u\n", entry->ttsi);
 314         }
 315 }
 316
 317 void
 318 print_temp(uint16_t t)
 319 {
 320         printf("%u K, %2.2f C, %3.2f F\n", t, (float)t - 273.15, (float)t * 9 / 5 - 459.67);
 321 }
 322
 323
 324 static void
 325 print_log_health(const struct nvme_controller_data *cdata __unused, void *buf, uint32_t size __unused)
 326 {
 327         struct nvme_health_information_page *health = buf;
 328         char cbuf[UINT128_DIG + 1];
 329         uint8_t warning;
 330         int i;
 331
 332         warning = health->critical_warning;
 333
 334         printf("SMART/Health Information Log\n");
 335         printf("============================\n");
 336
 337         printf("Critical Warning State:         0x%02x\n", warning);
 338         printf(" Available spare:               %d\n",
 339             !!(warning & NVME_CRIT_WARN_ST_AVAILABLE_SPARE));
 340         printf(" Temperature:                   %d\n",
 341             !!(warning & NVME_CRIT_WARN_ST_TEMPERATURE));
 342         printf(" Device reliability:            %d\n",
 343             !!(warning & NVME_CRIT_WARN_ST_DEVICE_RELIABILITY));
 344         printf(" Read only:                     %d\n",
 345             !!(warning & NVME_CRIT_WARN_ST_READ_ONLY));
 346         printf(" Volatile memory backup:        %d\n",
 347             !!(warning & NVME_CRIT_WARN_ST_VOLATILE_MEMORY_BACKUP));
 348         printf("Temperature:                    ");
 349         print_temp(health->temperature);
 350         printf("Available spare:                %u\n",
 351             health->available_spare);
 352         printf("Available spare threshold:      %u\n",
 353             health->available_spare_threshold);
 354         printf("Percentage used:                %u\n",
 355             health->percentage_used);
 356
 357         printf("Data units (512,000 byte) read: %s\n",
 358             uint128_to_str(to128(health->data_units_read), cbuf, sizeof(cbuf)));
 359         printf("Data units written:             %s\n",
 360             uint128_to_str(to128(health->data_units_written), cbuf, sizeof(cbuf)));
 361         printf("Host read commands:             %s\n",
 362             uint128_to_str(to128(health->host_read_commands), cbuf, sizeof(cbuf)));
 363         printf("Host write commands:            %s\n",
 364             uint128_to_str(to128(health->host_write_commands), cbuf, sizeof(cbuf)));
 365         printf("Controller busy time (minutes): %s\n",
 366             uint128_to_str(to128(health->controller_busy_time), cbuf, sizeof(cbuf)));
 367         printf("Power cycles:                   %s\n",
 368             uint128_to_str(to128(health->power_cycles), cbuf, sizeof(cbuf)));
 369         printf("Power on hours:                 %s\n",
 370             uint128_to_str(to128(health->power_on_hours), cbuf, sizeof(cbuf)));
 371         printf("Unsafe shutdowns:               %s\n",
 372             uint128_to_str(to128(health->unsafe_shutdowns), cbuf, sizeof(cbuf)));
 373         printf("Media errors:                   %s\n",
 374             uint128_to_str(to128(health->media_errors), cbuf, sizeof(cbuf)));
 375         printf("No. error info log entries:     %s\n",
 376             uint128_to_str(to128(health->num_error_info_log_entries), cbuf, sizeof(cbuf)));
 377
 378         printf("Warning Temp Composite Time:    %d\n", health->warning_temp_time);
 379         printf("Error Temp Composite Time:      %d\n", health->error_temp_time);
 380         for (i = 0; i < 8; i++) {
 381                 if (health->temp_sensor[i] == 0)
 382                         continue;
 383                 printf("Temperature Sensor %d:           ", i + 1);
 384                 print_temp(health->temp_sensor[i]);
 385         }
 386         printf("Temperature 1 Transition Count: %d\n", health->tmt1tc);
 387         printf("Temperature 2 Transition Count: %d\n", health->tmt2tc);
 388         printf("Total Time For Temperature 1:   %d\n", health->ttftmt1);
 389         printf("Total Time For Temperature 2:   %d\n", health->ttftmt2);
 390 }
 391
 392 static void
 393 print_log_firmware(const struct nvme_controller_data *cdata, void *buf, uint32_t size __unused)
 394 {
 395         int                             i, slots;
 396         const char                      *status;
 397         struct nvme_firmware_page       *fw = buf;
 398         uint8_t                         afi_slot;
 399         uint16_t                        oacs_fw;
 400         uint8_t                         fw_num_slots;
 401
 402         afi_slot = fw->afi >> NVME_FIRMWARE_PAGE_AFI_SLOT_SHIFT;
 403         afi_slot &= NVME_FIRMWARE_PAGE_AFI_SLOT_MASK;
 404
 405         oacs_fw = (cdata->oacs >> NVME_CTRLR_DATA_OACS_FIRMWARE_SHIFT) &
 406                 NVME_CTRLR_DATA_OACS_FIRMWARE_MASK;
 407         fw_num_slots = (cdata->frmw >> NVME_CTRLR_DATA_FRMW_NUM_SLOTS_SHIFT) &
 408                 NVME_CTRLR_DATA_FRMW_NUM_SLOTS_MASK;
 409
 410         printf("Firmware Slot Log\n");
 411         printf("=================\n");
 412
 413         if (oacs_fw == 0)
 414                 slots = 1;
 415         else
 416                 slots = MIN(fw_num_slots, MAX_FW_SLOTS);
 417
 418         for (i = 0; i < slots; i++) {
 419                 printf("Slot %d: ", i + 1);
 420                 if (afi_slot == i + 1)
 421                         status = "  Active";
 422                 else
 423                         status = "Inactive";
 424
 425                 if (fw->revision[i] == 0LLU)
 426                         printf("Empty\n");
 427                 else
 428                         if (isprint(*(char *)&fw->revision[i]))
 429                                 printf("[%s] %.8s\n", status,
 430                                     (char *)&fw->revision[i]);
 431                         else
 432                                 printf("[%s] %016jx\n", status,
 433                                     fw->revision[i]);
 434         }
 435 }
 436
 437 static void
 438 print_log_ns(const struct nvme_controller_data *cdata __unused, void *buf,
 439     uint32_t size __unused)
 440 {
 441         struct nvme_ns_list *nsl;
 442         u_int i;
 443
 444         nsl = (struct nvme_ns_list *)buf;
 445         printf("Changed Namespace List\n");
 446         printf("======================\n");
 447
 448         for (i = 0; i < nitems(nsl->ns) && nsl->ns[i] != 0; i++) {
 449                 printf("%08x\n", nsl->ns[i]);
 450         }
 451 }
 452
 453 static void
 454 print_log_command_effects(const struct nvme_controller_data *cdata __unused,
 455     void *buf, uint32_t size __unused)
 456 {
 457         struct nvme_command_effects_page *ce;
 458         u_int i;
 459         uint32_t s;
 460
 461         ce = (struct nvme_command_effects_page *)buf;
 462         printf("Commands Supported and Effects\n");
 463         printf("==============================\n");
 464         printf("  Command\tLBCC\tNCC\tNIC\tCCC\tCSE\tUUID\n");
 465
 466         for (i = 0; i < 255; i++) {
 467                 s = ce->acs[i];
 468                 if (((s >> NVME_CE_PAGE_CSUP_SHIFT) &
 469                      NVME_CE_PAGE_CSUP_MASK) == 0)
 470                         continue;
 471                 printf("Admin\t%02x\t%s\t%s\t%s\t%s\t%u\t%s\n", i,
 472                     ((s >> NVME_CE_PAGE_LBCC_SHIFT) &
 473                      NVME_CE_PAGE_LBCC_MASK) ? "Yes" : "No",
 474                     ((s >> NVME_CE_PAGE_NCC_SHIFT) &
 475                      NVME_CE_PAGE_NCC_MASK) ? "Yes" : "No",
 476                     ((s >> NVME_CE_PAGE_NIC_SHIFT) &
 477                      NVME_CE_PAGE_NIC_MASK) ? "Yes" : "No",
 478                     ((s >> NVME_CE_PAGE_CCC_SHIFT) &
 479                      NVME_CE_PAGE_CCC_MASK) ? "Yes" : "No",
 480                     ((s >> NVME_CE_PAGE_CSE_SHIFT) &
 481                      NVME_CE_PAGE_CSE_MASK),
 482                     ((s >> NVME_CE_PAGE_UUID_SHIFT) &
 483                      NVME_CE_PAGE_UUID_MASK) ? "Yes" : "No");
 484         }
 485         for (i = 0; i < 255; i++) {
 486                 s = ce->iocs[i];
 487                 if (((s >> NVME_CE_PAGE_CSUP_SHIFT) &
 488                      NVME_CE_PAGE_CSUP_MASK) == 0)
 489                         continue;
 490                 printf("I/O\t%02x\t%s\t%s\t%s\t%s\t%u\t%s\n", i,
 491                     ((s >> NVME_CE_PAGE_LBCC_SHIFT) &
 492                      NVME_CE_PAGE_LBCC_MASK) ? "Yes" : "No",
 493                     ((s >> NVME_CE_PAGE_NCC_SHIFT) &
 494                      NVME_CE_PAGE_NCC_MASK) ? "Yes" : "No",
 495                     ((s >> NVME_CE_PAGE_NIC_SHIFT) &
 496                      NVME_CE_PAGE_NIC_MASK) ? "Yes" : "No",
 497                     ((s >> NVME_CE_PAGE_CCC_SHIFT) &
 498                      NVME_CE_PAGE_CCC_MASK) ? "Yes" : "No",
 499                     ((s >> NVME_CE_PAGE_CSE_SHIFT) &
 500                      NVME_CE_PAGE_CSE_MASK),
 501                     ((s >> NVME_CE_PAGE_UUID_SHIFT) &
 502                      NVME_CE_PAGE_UUID_MASK) ? "Yes" : "No");
 503         }
 504 }
 505
 506 static void
 507 print_log_res_notification(const struct nvme_controller_data *cdata __unused,
 508     void *buf, uint32_t size __unused)
 509 {
 510         struct nvme_res_notification_page *rn;
 511
 512         rn = (struct nvme_res_notification_page *)buf;
 513         printf("Reservation Notification\n");
 514         printf("========================\n");
 515
 516         printf("Log Page Count:                %ju\n", rn->log_page_count);
 517         printf("Log Page Type:                 ");
 518         switch (rn->log_page_type) {
 519         case 0:
 520                 printf("Empty Log Page\n");
 521                 break;
 522         case 1:
 523                 printf("Registration Preempted\n");
 524                 break;
 525         case 2:
 526                 printf("Reservation Released\n");
 527                 break;
 528         case 3:
 529                 printf("Reservation Preempted\n");
 530                 break;
 531         default:
 532                 printf("Unknown %x\n", rn->log_page_type);
 533                 break;
 534         };
 535         printf("Number of Available Log Pages: %d\n", rn->available_log_pages);
 536         printf("Namespace ID:                  0x%x\n", rn->nsid);
 537 }
 538
 539 static void
 540 print_log_sanitize_status(const struct nvme_controller_data *cdata __unused,
 541     void *buf, uint32_t size __unused)
 542 {
 543         struct nvme_sanitize_status_page *ss;
 544         u_int p;
 545
 546         ss = (struct nvme_sanitize_status_page *)buf;
 547         printf("Sanitize Status\n");
 548         printf("===============\n");
 549
 550         printf("Sanitize Progress:                   %u%% (%u/65535)\n",
 551             (ss->sprog * 100 + 32768) / 65536, ss->sprog);
 552         printf("Sanitize Status:                     ");
 553         switch ((ss->sstat >> NVME_SS_PAGE_SSTAT_STATUS_SHIFT) &
 554             NVME_SS_PAGE_SSTAT_STATUS_MASK) {
 555         case NVME_SS_PAGE_SSTAT_STATUS_NEVER:
 556                 printf("Never sanitized");
 557                 break;
 558         case NVME_SS_PAGE_SSTAT_STATUS_COMPLETED:
 559                 printf("Completed");
 560                 break;
 561         case NVME_SS_PAGE_SSTAT_STATUS_INPROG:
 562                 printf("In Progress");
 563                 break;
 564         case NVME_SS_PAGE_SSTAT_STATUS_FAILED:
 565                 printf("Failed");
 566                 break;
 567         case NVME_SS_PAGE_SSTAT_STATUS_COMPLETEDWD:
 568                 printf("Completed with deallocation");
 569                 break;
 570         default:
 571                 printf("Unknown");
 572                 break;
 573         }
 574         p = (ss->sstat >> NVME_SS_PAGE_SSTAT_PASSES_SHIFT) &
 575             NVME_SS_PAGE_SSTAT_PASSES_MASK;
 576         if (p > 0)
 577                 printf(", %d passes", p);
 578         if ((ss->sstat >> NVME_SS_PAGE_SSTAT_GDE_SHIFT) &
 579             NVME_SS_PAGE_SSTAT_GDE_MASK)
 580                 printf(", Global Data Erased");
 581         printf("\n");
 582         printf("Sanitize Command Dword 10:           0x%x\n", ss->scdw10);
 583         printf("Time For Overwrite:                  %u sec\n", ss->etfo);
 584         printf("Time For Block Erase:                %u sec\n", ss->etfbe);
 585         printf("Time For Crypto Erase:               %u sec\n", ss->etfce);
 586         printf("Time For Overwrite No-Deallocate:    %u sec\n", ss->etfownd);
 587         printf("Time For Block Erase No-Deallocate:  %u sec\n", ss->etfbewnd);
 588         printf("Time For Crypto Erase No-Deallocate: %u sec\n", ss->etfcewnd);
 589 }
 590
 591 /*
 592  * Table of log page printer / sizing.
 593  *
 594  * Make sure you keep all the pages of one vendor together so -v help
 595  * lists all the vendors pages.
 596  */
 597 NVME_LOGPAGE(error,
 598     NVME_LOG_ERROR,                     NULL,   "Drive Error Log",
 599     print_log_error,                    0);
 600 NVME_LOGPAGE(health,
 601     NVME_LOG_HEALTH_INFORMATION,        NULL,   "Health/SMART Data",
 602     print_log_health,                   sizeof(struct nvme_health_information_page));
 603 NVME_LOGPAGE(fw,
 604     NVME_LOG_FIRMWARE_SLOT,             NULL,   "Firmware Information",
 605     print_log_firmware,                 sizeof(struct nvme_firmware_page));
 606 NVME_LOGPAGE(ns,
 607     NVME_LOG_CHANGED_NAMESPACE,         NULL,   "Changed Namespace List",
 608     print_log_ns,                       sizeof(struct nvme_ns_list));
 609 NVME_LOGPAGE(ce,
 610     NVME_LOG_COMMAND_EFFECT,            NULL,   "Commands Supported and Effects",
 611     print_log_command_effects,          sizeof(struct nvme_command_effects_page));
 612 NVME_LOGPAGE(dst,
 613     NVME_LOG_DEVICE_SELF_TEST,          NULL,   "Device Self-test",
 614     NULL,                               564);
 615 NVME_LOGPAGE(thi,
 616     NVME_LOG_TELEMETRY_HOST_INITIATED,  NULL,   "Telemetry Host-Initiated",
 617     NULL,                               DEFAULT_SIZE);
 618 NVME_LOGPAGE(tci,
 619     NVME_LOG_TELEMETRY_CONTROLLER_INITIATED,    NULL,   "Telemetry Controller-Initiated",
 620     NULL,                               DEFAULT_SIZE);
 621 NVME_LOGPAGE(egi,
 622     NVME_LOG_ENDURANCE_GROUP_INFORMATION,       NULL,   "Endurance Group Information",
 623     NULL,                               DEFAULT_SIZE);
 624 NVME_LOGPAGE(plpns,
 625     NVME_LOG_PREDICTABLE_LATENCY_PER_NVM_SET,   NULL,   "Predictable Latency Per NVM Set",
 626     NULL,                               DEFAULT_SIZE);
 627 NVME_LOGPAGE(ple,
 628     NVME_LOG_PREDICTABLE_LATENCY_EVENT_AGGREGATE,       NULL,   "Predictable Latency Event Aggregate",
 629     NULL,                               DEFAULT_SIZE);
 630 NVME_LOGPAGE(ana,
 631     NVME_LOG_ASYMMETRIC_NAMESPAVE_ACCESS,       NULL,   "Asymmetric Namespace Access",
 632     NULL,                               DEFAULT_SIZE);
 633 NVME_LOGPAGE(pel,
 634     NVME_LOG_PERSISTENT_EVENT_LOG,      NULL,   "Persistent Event Log",
 635     NULL,                               DEFAULT_SIZE);
 636 NVME_LOGPAGE(lbasi,
 637     NVME_LOG_LBA_STATUS_INFORMATION,    NULL,   "LBA Status Information",
 638     NULL,                               DEFAULT_SIZE);
 639 NVME_LOGPAGE(egea,
 640     NVME_LOG_ENDURANCE_GROUP_EVENT_AGGREGATE,   NULL,   "Endurance Group Event Aggregate",
 641     NULL,                               DEFAULT_SIZE);
 642 NVME_LOGPAGE(res_notification,
 643     NVME_LOG_RES_NOTIFICATION,          NULL,   "Reservation Notification",
 644     print_log_res_notification,         sizeof(struct nvme_res_notification_page));
 645 NVME_LOGPAGE(sanitize_status,
 646     NVME_LOG_SANITIZE_STATUS,           NULL,   "Sanitize Status",
 647     print_log_sanitize_status,          sizeof(struct nvme_sanitize_status_page));
 648
 649 static void
 650 logpage_help(void)
 651 {
 652         const struct logpage_function   *f;
 653         const char                      *v;
 654
 655         fprintf(stderr, "\n");
 656         fprintf(stderr, "%-8s %-10s %s\n", "Page", "Vendor","Page Name");
 657         fprintf(stderr, "-------- ---------- ----------\n");
 658         SLIST_FOREACH(f, &logpages, link) {
 659                 v = f->vendor == NULL ? "-" : f->vendor;
 660                 fprintf(stderr, "0x%02x     %-10s %s\n", f->log_page, v, f->name);
 661         }
 662
 663         exit(EX_USAGE);
 664 }
 665
 666 static void
 667 logpage(const struct cmd *f, int argc, char *argv[])
 668 {
 669         int                             fd;
 670         char                            *path;
 671         uint32_t                        nsid, size;
 672         void                            *buf;
 673         const struct logpage_function   *lpf;
 674         struct nvme_controller_data     cdata;
 675         print_fn_t                      print_fn;
 676         uint8_t                         ns_smart;
 677
 678         if (arg_parse(argc, argv, f))
 679                 return;
 680         if (opt.hex && opt.binary) {
 681                 fprintf(stderr,
 682                     "Can't specify both binary and hex\n");
 683                 arg_help(argc, argv, f);
 684         }
 685         if (opt.vendor != NULL && strcmp(opt.vendor, "help") == 0)
 686                 logpage_help();
 687         if (opt.page == NONE) {
 688                 fprintf(stderr, "Missing page_id (-p).\n");
 689                 arg_help(argc, argv, f);
 690         }
 691         open_dev(opt.dev, &fd, 0, 1);
 692         get_nsid(fd, &path, &nsid);
 693         if (nsid == 0) {
 694                 nsid = NVME_GLOBAL_NAMESPACE_TAG;
 695         } else {
 696                 close(fd);
 697                 open_dev(path, &fd, 0, 1);
 698         }
 699         free(path);
 700
 701         if (read_controller_data(fd, &cdata))
 702                 errx(EX_IOERR, "Identify request failed");
 703
 704         ns_smart = (cdata.lpa >> NVME_CTRLR_DATA_LPA_NS_SMART_SHIFT) &
 705                 NVME_CTRLR_DATA_LPA_NS_SMART_MASK;
 706
 707         /*
 708          * The log page attribtues indicate whether or not the controller
 709          * supports the SMART/Health information log page on a per
 710          * namespace basis.
 711          */
 712         if (nsid != NVME_GLOBAL_NAMESPACE_TAG) {
 713                 if (opt.page != NVME_LOG_HEALTH_INFORMATION)
 714                         errx(EX_USAGE, "log page %d valid only at controller level",
 715                             opt.page);
 716                 if (ns_smart == 0)
 717                         errx(EX_UNAVAILABLE,
 718                             "controller does not support per namespace "
 719                             "smart/health information");
 720         }
 721
 722         print_fn = print_log_hex;
 723         size = DEFAULT_SIZE;
 724         if (opt.binary)
 725                 print_fn = print_bin;
 726         if (!opt.binary && !opt.hex) {
 727                 /*
 728                  * See if there is a pretty print function for the specified log
 729                  * page.  If one isn't found, we just revert to the default
 730                  * (print_hex). If there was a vendor specified by the user, and
 731                  * the page is vendor specific, don't match the print function
 732                  * unless the vendors match.
 733                  */
 734                 SLIST_FOREACH(lpf, &logpages, link) {
 735                         if (lpf->vendor != NULL && opt.vendor != NULL &&
 736                             strcmp(lpf->vendor, opt.vendor) != 0)
 737                                 continue;
 738                         if (opt.page != lpf->log_page)
 739                                 continue;
 740                         if (lpf->print_fn != NULL)
 741                                 print_fn = lpf->print_fn;
 742                         size = lpf->size;
 743                         break;
 744                 }
 745         }
 746
 747         if (opt.page == NVME_LOG_ERROR) {
 748                 size = sizeof(struct nvme_error_information_entry);
 749                 size *= (cdata.elpe + 1);
 750         }
 751
 752         /* Read the log page */
 753         buf = get_log_buffer(size);
 754         read_logpage(fd, opt.page, nsid, opt.lsp, opt.lsi, opt.rae, buf, size);
 755         print_fn(&cdata, buf, size);
 756
 757         close(fd);
 758         exit(0);
 759 }