468 lines
13 KiB
C
468 lines
13 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
*
|
|
* Copyright (c) 2013 EMC Corp.
|
|
* All rights reserved.
|
|
*
|
|
* Copyright (C) 2012-2013 Intel Corporation
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*/
|
|
|
|
#include <sys/cdefs.h>
|
|
__FBSDID("$FreeBSD$");
|
|
|
|
#include <sys/param.h>
|
|
#include <sys/ioccom.h>
|
|
|
|
#include <ctype.h>
|
|
#include <err.h>
|
|
#include <fcntl.h>
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <unistd.h>
|
|
#include <sys/endian.h>
|
|
|
|
#include "nvmecontrol.h"
|
|
|
|
SET_DECLARE(logpage, struct logpage_function);
|
|
|
|
#define LOGPAGE_USAGE \
|
|
"logpage <-p page_id> [-b] [-v vendor] [-x] <controller id|namespace id>\n" \
|
|
|
|
#define MAX_FW_SLOTS (7)
|
|
|
|
const char *
|
|
kv_lookup(const struct kv_name *kv, size_t kv_count, uint32_t key)
|
|
{
|
|
static char bad[32];
|
|
size_t i;
|
|
|
|
for (i = 0; i < kv_count; i++, kv++)
|
|
if (kv->key == key)
|
|
return kv->name;
|
|
snprintf(bad, sizeof(bad), "Attribute %#x", key);
|
|
return bad;
|
|
}
|
|
|
|
static void
|
|
print_log_hex(const struct nvme_controller_data *cdata __unused, void *data, uint32_t length)
|
|
{
|
|
|
|
print_hex(data, length);
|
|
}
|
|
|
|
static void
|
|
print_bin(const struct nvme_controller_data *cdata __unused, void *data, uint32_t length)
|
|
{
|
|
|
|
write(STDOUT_FILENO, data, length);
|
|
}
|
|
|
|
static void *
|
|
get_log_buffer(uint32_t size)
|
|
{
|
|
void *buf;
|
|
|
|
if ((buf = malloc(size)) == NULL)
|
|
errx(1, "unable to malloc %u bytes", size);
|
|
|
|
memset(buf, 0, size);
|
|
return (buf);
|
|
}
|
|
|
|
void
|
|
read_logpage(int fd, uint8_t log_page, uint32_t nsid, void *payload,
|
|
uint32_t payload_size)
|
|
{
|
|
struct nvme_pt_command pt;
|
|
struct nvme_error_information_entry *err_entry;
|
|
int i, err_pages;
|
|
|
|
memset(&pt, 0, sizeof(pt));
|
|
pt.cmd.opc = NVME_OPC_GET_LOG_PAGE;
|
|
pt.cmd.nsid = htole32(nsid);
|
|
pt.cmd.cdw10 = ((payload_size/sizeof(uint32_t)) - 1) << 16;
|
|
pt.cmd.cdw10 |= log_page;
|
|
pt.cmd.cdw10 = htole32(pt.cmd.cdw10);
|
|
pt.buf = payload;
|
|
pt.len = payload_size;
|
|
pt.is_read = 1;
|
|
|
|
if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
|
|
err(1, "get log page request failed");
|
|
|
|
/* Convert data to host endian */
|
|
switch (log_page) {
|
|
case NVME_LOG_ERROR:
|
|
err_entry = (struct nvme_error_information_entry *)payload;
|
|
err_pages = payload_size / sizeof(struct nvme_error_information_entry);
|
|
for (i = 0; i < err_pages; i++)
|
|
nvme_error_information_entry_swapbytes(err_entry++);
|
|
break;
|
|
case NVME_LOG_HEALTH_INFORMATION:
|
|
nvme_health_information_page_swapbytes(
|
|
(struct nvme_health_information_page *)payload);
|
|
break;
|
|
case NVME_LOG_FIRMWARE_SLOT:
|
|
nvme_firmware_page_swapbytes(
|
|
(struct nvme_firmware_page *)payload);
|
|
break;
|
|
case INTEL_LOG_TEMP_STATS:
|
|
intel_log_temp_stats_swapbytes(
|
|
(struct intel_log_temp_stats *)payload);
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
if (nvme_completion_is_error(&pt.cpl))
|
|
errx(1, "get log page request returned error");
|
|
}
|
|
|
|
static void
|
|
print_log_error(const struct nvme_controller_data *cdata __unused, void *buf, uint32_t size)
|
|
{
|
|
int i, nentries;
|
|
uint16_t status;
|
|
uint8_t p, sc, sct, m, dnr;
|
|
struct nvme_error_information_entry *entry = buf;
|
|
|
|
printf("Error Information Log\n");
|
|
printf("=====================\n");
|
|
|
|
if (entry->error_count == 0) {
|
|
printf("No error entries found\n");
|
|
return;
|
|
}
|
|
|
|
nentries = size/sizeof(struct nvme_error_information_entry);
|
|
for (i = 0; i < nentries; i++, entry++) {
|
|
if (entry->error_count == 0)
|
|
break;
|
|
|
|
status = entry->status;
|
|
|
|
p = NVME_STATUS_GET_P(status);
|
|
sc = NVME_STATUS_GET_SC(status);
|
|
sct = NVME_STATUS_GET_SCT(status);
|
|
m = NVME_STATUS_GET_M(status);
|
|
dnr = NVME_STATUS_GET_DNR(status);
|
|
|
|
printf("Entry %02d\n", i + 1);
|
|
printf("=========\n");
|
|
printf(" Error count: %ju\n", entry->error_count);
|
|
printf(" Submission queue ID: %u\n", entry->sqid);
|
|
printf(" Command ID: %u\n", entry->cid);
|
|
/* TODO: Export nvme_status_string structures from kernel? */
|
|
printf(" Status:\n");
|
|
printf(" Phase tag: %d\n", p);
|
|
printf(" Status code: %d\n", sc);
|
|
printf(" Status code type: %d\n", sct);
|
|
printf(" More: %d\n", m);
|
|
printf(" DNR: %d\n", dnr);
|
|
printf(" Error location: %u\n", entry->error_location);
|
|
printf(" LBA: %ju\n", entry->lba);
|
|
printf(" Namespace ID: %u\n", entry->nsid);
|
|
printf(" Vendor specific info: %u\n", entry->vendor_specific);
|
|
}
|
|
}
|
|
|
|
void
|
|
print_temp(uint16_t t)
|
|
{
|
|
printf("%u K, %2.2f C, %3.2f F\n", t, (float)t - 273.15, (float)t * 9 / 5 - 459.67);
|
|
}
|
|
|
|
|
|
static void
|
|
print_log_health(const struct nvme_controller_data *cdata __unused, void *buf, uint32_t size __unused)
|
|
{
|
|
struct nvme_health_information_page *health = buf;
|
|
char cbuf[UINT128_DIG + 1];
|
|
uint8_t warning;
|
|
int i;
|
|
|
|
warning = health->critical_warning;
|
|
|
|
printf("SMART/Health Information Log\n");
|
|
printf("============================\n");
|
|
|
|
printf("Critical Warning State: 0x%02x\n", warning);
|
|
printf(" Available spare: %d\n",
|
|
!!(warning & NVME_CRIT_WARN_ST_AVAILABLE_SPARE));
|
|
printf(" Temperature: %d\n",
|
|
!!(warning & NVME_CRIT_WARN_ST_TEMPERATURE));
|
|
printf(" Device reliability: %d\n",
|
|
!!(warning & NVME_CRIT_WARN_ST_DEVICE_RELIABILITY));
|
|
printf(" Read only: %d\n",
|
|
!!(warning & NVME_CRIT_WARN_ST_READ_ONLY));
|
|
printf(" Volatile memory backup: %d\n",
|
|
!!(warning & NVME_CRIT_WARN_ST_VOLATILE_MEMORY_BACKUP));
|
|
printf("Temperature: ");
|
|
print_temp(health->temperature);
|
|
printf("Available spare: %u\n",
|
|
health->available_spare);
|
|
printf("Available spare threshold: %u\n",
|
|
health->available_spare_threshold);
|
|
printf("Percentage used: %u\n",
|
|
health->percentage_used);
|
|
|
|
printf("Data units (512,000 byte) read: %s\n",
|
|
uint128_to_str(to128(health->data_units_read), cbuf, sizeof(cbuf)));
|
|
printf("Data units written: %s\n",
|
|
uint128_to_str(to128(health->data_units_written), cbuf, sizeof(cbuf)));
|
|
printf("Host read commands: %s\n",
|
|
uint128_to_str(to128(health->host_read_commands), cbuf, sizeof(cbuf)));
|
|
printf("Host write commands: %s\n",
|
|
uint128_to_str(to128(health->host_write_commands), cbuf, sizeof(cbuf)));
|
|
printf("Controller busy time (minutes): %s\n",
|
|
uint128_to_str(to128(health->controller_busy_time), cbuf, sizeof(cbuf)));
|
|
printf("Power cycles: %s\n",
|
|
uint128_to_str(to128(health->power_cycles), cbuf, sizeof(cbuf)));
|
|
printf("Power on hours: %s\n",
|
|
uint128_to_str(to128(health->power_on_hours), cbuf, sizeof(cbuf)));
|
|
printf("Unsafe shutdowns: %s\n",
|
|
uint128_to_str(to128(health->unsafe_shutdowns), cbuf, sizeof(cbuf)));
|
|
printf("Media errors: %s\n",
|
|
uint128_to_str(to128(health->media_errors), cbuf, sizeof(cbuf)));
|
|
printf("No. error info log entries: %s\n",
|
|
uint128_to_str(to128(health->num_error_info_log_entries), cbuf, sizeof(cbuf)));
|
|
|
|
printf("Warning Temp Composite Time: %d\n", health->warning_temp_time);
|
|
printf("Error Temp Composite Time: %d\n", health->error_temp_time);
|
|
for (i = 0; i < 8; i++) {
|
|
if (health->temp_sensor[i] == 0)
|
|
continue;
|
|
printf("Temperature Sensor %d: ", i + 1);
|
|
print_temp(health->temp_sensor[i]);
|
|
}
|
|
}
|
|
|
|
static void
|
|
print_log_firmware(const struct nvme_controller_data *cdata, void *buf, uint32_t size __unused)
|
|
{
|
|
int i, slots;
|
|
const char *status;
|
|
struct nvme_firmware_page *fw = buf;
|
|
uint8_t afi_slot;
|
|
uint16_t oacs_fw;
|
|
uint8_t fw_num_slots;
|
|
|
|
afi_slot = fw->afi >> NVME_FIRMWARE_PAGE_AFI_SLOT_SHIFT;
|
|
afi_slot &= NVME_FIRMWARE_PAGE_AFI_SLOT_MASK;
|
|
|
|
oacs_fw = (cdata->oacs >> NVME_CTRLR_DATA_OACS_FIRMWARE_SHIFT) &
|
|
NVME_CTRLR_DATA_OACS_FIRMWARE_MASK;
|
|
fw_num_slots = (cdata->frmw >> NVME_CTRLR_DATA_FRMW_NUM_SLOTS_SHIFT) &
|
|
NVME_CTRLR_DATA_FRMW_NUM_SLOTS_MASK;
|
|
|
|
printf("Firmware Slot Log\n");
|
|
printf("=================\n");
|
|
|
|
if (oacs_fw == 0)
|
|
slots = 1;
|
|
else
|
|
slots = MIN(fw_num_slots, MAX_FW_SLOTS);
|
|
|
|
for (i = 0; i < slots; i++) {
|
|
printf("Slot %d: ", i + 1);
|
|
if (afi_slot == i + 1)
|
|
status = " Active";
|
|
else
|
|
status = "Inactive";
|
|
|
|
if (fw->revision[i] == 0LLU)
|
|
printf("Empty\n");
|
|
else
|
|
if (isprint(*(char *)&fw->revision[i]))
|
|
printf("[%s] %.8s\n", status,
|
|
(char *)&fw->revision[i]);
|
|
else
|
|
printf("[%s] %016jx\n", status,
|
|
fw->revision[i]);
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Table of log page printer / sizing.
|
|
*
|
|
* Make sure you keep all the pages of one vendor together so -v help
|
|
* lists all the vendors pages.
|
|
*/
|
|
NVME_LOGPAGE(error,
|
|
NVME_LOG_ERROR, NULL, "Drive Error Log",
|
|
print_log_error, 0);
|
|
NVME_LOGPAGE(health,
|
|
NVME_LOG_HEALTH_INFORMATION, NULL, "Health/SMART Data",
|
|
print_log_health, sizeof(struct nvme_health_information_page));
|
|
NVME_LOGPAGE(fw,
|
|
NVME_LOG_FIRMWARE_SLOT, NULL, "Firmware Information",
|
|
print_log_firmware, sizeof(struct nvme_firmware_page));
|
|
|
|
static void
|
|
logpage_help(void)
|
|
{
|
|
struct logpage_function **f;
|
|
const char *v;
|
|
|
|
fprintf(stderr, "\n");
|
|
fprintf(stderr, "%-8s %-10s %s\n", "Page", "Vendor","Page Name");
|
|
fprintf(stderr, "-------- ---------- ----------\n");
|
|
for (f = SET_BEGIN(logpage); f < SET_LIMIT(logpage); f++) {
|
|
v = (*f)->vendor == NULL ? "-" : (*f)->vendor;
|
|
fprintf(stderr, "0x%02x %-10s %s\n", (*f)->log_page, v, (*f)->name);
|
|
}
|
|
|
|
exit(1);
|
|
}
|
|
|
|
static void
|
|
logpage(struct nvme_function *nf, int argc, char *argv[])
|
|
{
|
|
int fd;
|
|
int log_page = 0, pageflag = false;
|
|
int binflag = false, hexflag = false, ns_specified;
|
|
int opt;
|
|
char *p;
|
|
char cname[64];
|
|
uint32_t nsid, size;
|
|
void *buf;
|
|
const char *vendor = NULL;
|
|
struct logpage_function **f;
|
|
struct nvme_controller_data cdata;
|
|
print_fn_t print_fn;
|
|
uint8_t ns_smart;
|
|
|
|
while ((opt = getopt(argc, argv, "bp:xv:")) != -1) {
|
|
switch (opt) {
|
|
case 'b':
|
|
binflag = true;
|
|
break;
|
|
case 'p':
|
|
if (strcmp(optarg, "help") == 0)
|
|
logpage_help();
|
|
|
|
/* TODO: Add human-readable ASCII page IDs */
|
|
log_page = strtol(optarg, &p, 0);
|
|
if (p != NULL && *p != '\0') {
|
|
fprintf(stderr,
|
|
"\"%s\" not valid log page id.\n",
|
|
optarg);
|
|
usage(nf);
|
|
}
|
|
pageflag = true;
|
|
break;
|
|
case 'x':
|
|
hexflag = true;
|
|
break;
|
|
case 'v':
|
|
if (strcmp(optarg, "help") == 0)
|
|
logpage_help();
|
|
vendor = optarg;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!pageflag) {
|
|
printf("Missing page_id (-p).\n");
|
|
usage(nf);
|
|
}
|
|
|
|
/* Check that a controller and/or namespace was specified. */
|
|
if (optind >= argc)
|
|
usage(nf);
|
|
|
|
if (strstr(argv[optind], NVME_NS_PREFIX) != NULL) {
|
|
ns_specified = true;
|
|
parse_ns_str(argv[optind], cname, &nsid);
|
|
open_dev(cname, &fd, 1, 1);
|
|
} else {
|
|
ns_specified = false;
|
|
nsid = NVME_GLOBAL_NAMESPACE_TAG;
|
|
open_dev(argv[optind], &fd, 1, 1);
|
|
}
|
|
|
|
read_controller_data(fd, &cdata);
|
|
|
|
ns_smart = (cdata.lpa >> NVME_CTRLR_DATA_LPA_NS_SMART_SHIFT) &
|
|
NVME_CTRLR_DATA_LPA_NS_SMART_MASK;
|
|
|
|
/*
|
|
* The log page attribtues indicate whether or not the controller
|
|
* supports the SMART/Health information log page on a per
|
|
* namespace basis.
|
|
*/
|
|
if (ns_specified) {
|
|
if (log_page != NVME_LOG_HEALTH_INFORMATION)
|
|
errx(1, "log page %d valid only at controller level",
|
|
log_page);
|
|
if (ns_smart == 0)
|
|
errx(1,
|
|
"controller does not support per namespace "
|
|
"smart/health information");
|
|
}
|
|
|
|
print_fn = print_log_hex;
|
|
size = DEFAULT_SIZE;
|
|
if (binflag)
|
|
print_fn = print_bin;
|
|
if (!binflag && !hexflag) {
|
|
/*
|
|
* See if there is a pretty print function for the specified log
|
|
* page. If one isn't found, we just revert to the default
|
|
* (print_hex). If there was a vendor specified by the user, and
|
|
* the page is vendor specific, don't match the print function
|
|
* unless the vendors match.
|
|
*/
|
|
for (f = SET_BEGIN(logpage); f < SET_LIMIT(logpage); f++) {
|
|
if ((*f)->vendor != NULL && vendor != NULL &&
|
|
strcmp((*f)->vendor, vendor) != 0)
|
|
continue;
|
|
if (log_page != (*f)->log_page)
|
|
continue;
|
|
print_fn = (*f)->print_fn;
|
|
size = (*f)->size;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (log_page == NVME_LOG_ERROR) {
|
|
size = sizeof(struct nvme_error_information_entry);
|
|
size *= (cdata.elpe + 1);
|
|
}
|
|
|
|
/* Read the log page */
|
|
buf = get_log_buffer(size);
|
|
read_logpage(fd, log_page, nsid, buf, size);
|
|
print_fn(&cdata, buf, size);
|
|
|
|
close(fd);
|
|
exit(0);
|
|
}
|
|
|
|
NVME_COMMAND(top, logpage, logpage, LOGPAGE_USAGE);
|