Source-Changes-HG archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[src/trunk]: src/sbin/nvmectl Added missing file...



details:   https://anonhg.NetBSD.org/src/rev/5f0662fb8691
branches:  trunk
changeset: 823614:5f0662fb8691
user:      nonaka <nonaka%NetBSD.org@localhost>
date:      Sat Apr 29 00:08:46 2017 +0000

description:
Added missing file...

> nvmectl(8): sync with FreeBSD HEAD r316105.
>
>  - Expand the SMART / Health Information Log Page (Page 02) printout based on
>    NVM Express 1.2.1 Standard.
>  - Implement Intel-specific log pages.
>  - Implement HGST-specific log pages.
>  - Implement wdc-specific nvme control options.
>  - Add the ability to dump log pages directly in binary to stdout.

diffstat:

 sbin/nvmectl/wdc.c |  354 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 354 insertions(+), 0 deletions(-)

diffs (truncated from 358 to 300 lines):

diff -r 74e6a0a31003 -r 5f0662fb8691 sbin/nvmectl/wdc.c
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/sbin/nvmectl/wdc.c        Sat Apr 29 00:08:46 2017 +0000
@@ -0,0 +1,354 @@
+/*     $NetBSD: wdc.c,v 1.1 2017/04/29 00:08:46 nonaka Exp $   */
+
+/*-
+ * Copyright (c) 2017 Netflix, Inc
+ * 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>
+#ifndef lint
+__RCSID("$NetBSD: wdc.c,v 1.1 2017/04/29 00:08:46 nonaka Exp $");
+#if 0
+__FBSDID("$FreeBSD: head/sbin/nvmecontrol/wdc.c 316105 2017-03-28 20:34:02Z ngie $");
+#endif
+#endif
+
+#include <sys/param.h>
+#include <sys/ioccom.h>
+#include <sys/endian.h>
+
+#include <ctype.h>
+#include <err.h>
+#include <fcntl.h>
+#include <stddef.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+#include "nvmectl.h"
+
+#define WDC_NVME_TOC_SIZE      8
+
+#define WDC_NVME_CAP_DIAG_OPCODE       0xe6
+#define WDC_NVME_CAP_DIAG_CMD          0x0000
+
+#define WDC_NVME_DIAG_OPCODE           0xc6
+#define WDC_NVME_DRIVE_LOG_SIZE_CMD    0x0120
+#define WDC_NVME_DRIVE_LOG_CMD         0x0020
+#define WDC_NVME_CRASH_DUMP_SIZE_CMD   0x0320
+#define WDC_NVME_CRASH_DUMP_CMD                0x0420
+#define WDC_NVME_PFAIL_DUMP_SIZE_CMD   0x0520
+#define WDC_NVME_PFAIL_DUMP_CMD                0x0620
+
+#define WDC_NVME_CLEAR_DUMP_OPCODE     0xff
+#define WDC_NVME_CLEAR_CRASH_DUMP_CMD  0x0503
+#define WDC_NVME_CLEAR_PFAIL_DUMP_CMD  0x0603
+
+static void wdc_cap_diag(int argc, char *argv[]);
+static void wdc_drive_log(int argc, char *argv[]);
+static void wdc_get_crash_dump(int argc, char *argv[]);
+static void wdc_purge(int argc, char *argv[]);
+static void wdc_purge_monitor(int argc, char *argv[]);
+
+#define WDC_CAP_DIAG_USAGE     "\tnvmecontrol wdc cap-diag [-o path-template]\n"
+#define WDC_DRIVE_LOG_USAGE    "\tnvmecontrol wdc drive-log [-o path-template]\n"
+#define WDC_GET_CRASH_DUMP_USAGE "\tnvmecontrol wdc get-crash-dump [-o path-template]\n"
+#define WDC_PURGE_USAGE                "\tnvmecontrol wdc purge [-o path-template]\n"
+#define WDC_PURGE_MONITOR_USAGE        "\tnvmecontrol wdc purge-monitor\n"
+
+static struct nvme_function wdc_funcs[] = {
+       {"cap-diag",            wdc_cap_diag,           WDC_CAP_DIAG_USAGE},
+       {"drive-log",           wdc_drive_log,          WDC_DRIVE_LOG_USAGE},
+       {"get-crash-dump",      wdc_get_crash_dump,     WDC_GET_CRASH_DUMP_USAGE},
+       {"purge",               wdc_purge,              WDC_PURGE_USAGE},
+       {"purge_monitor",       wdc_purge_monitor,      WDC_PURGE_MONITOR_USAGE},
+       {NULL,                  NULL,                   NULL},
+};
+
+static void
+wdc_append_serial_name(int fd, char *buf, size_t len, const char *suffix)
+{
+       struct nvm_identify_controller  cdata;
+       char sn[sizeof(cdata.sn) + 1];
+       char *walker;
+
+       len -= strlen(buf);
+       buf += strlen(buf);
+       read_controller_data(fd, &cdata);
+       memcpy(sn, cdata.sn, sizeof(cdata.sn));
+       walker = sn + sizeof(cdata.sn) - 1;
+       while (walker > sn && *walker == ' ')
+               walker--;
+       *++walker = '\0';
+       snprintf(buf, len, "%s%s.bin", sn, suffix);
+}
+
+static void
+wdc_get_data(int fd, uint32_t opcode, uint32_t len, uint32_t off, uint32_t cmd,
+    uint8_t *buffer, size_t buflen)
+{
+       struct nvme_pt_command  pt;
+
+       memset(&pt, 0, sizeof(pt));
+       pt.cmd.opcode = opcode;
+       pt.cmd.cdw10 = len / sizeof(uint32_t);  /* - 1 like all the others ??? */
+       pt.cmd.cdw11 = off / sizeof(uint32_t);
+       pt.cmd.cdw12 = cmd;
+       pt.buf = buffer;
+       pt.len = buflen;
+       pt.is_read = 1;
+//     printf("opcode %#x cdw10(len) %#x cdw11(offset?) %#x cdw12(cmd/sub) %#x buflen %zd\n",
+//         (int)opcode, (int)cdw10, (int)cdw11, (int)cdw12, buflen);
+
+       if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
+               err(1, "wdc_get_data request failed");
+       if (nvme_completion_is_error(&pt.cpl))
+               errx(1, "wdc_get_data request returned error");
+}
+
+static void
+wdc_do_dump(int fd, char *tmpl, const char *suffix, uint32_t opcode,
+    uint32_t size_cmd, uint32_t cmd, int len_off)
+{
+       int fd2;
+       uint8_t *buf;
+       uint32_t len, offset;
+       ssize_t resid;
+       long page_size;
+
+       page_size = sysconf(_SC_PAGESIZE);
+       if (page_size <= 0)
+               page_size = 4096;
+
+       wdc_append_serial_name(fd, tmpl, MAXPATHLEN, suffix);
+
+       buf = aligned_alloc(page_size, WDC_NVME_TOC_SIZE);
+       if (buf == NULL)
+               errx(1, "Can't get buffer to get size");
+       wdc_get_data(fd, opcode, WDC_NVME_TOC_SIZE,
+           0, size_cmd, buf, WDC_NVME_TOC_SIZE);
+       len = be32dec(buf + len_off);
+
+       if (len == 0)
+               errx(1, "No data for %s", suffix);
+
+       printf("Dumping %d bytes to %s\n", len, tmpl);
+       /* XXX overwrite protection? */
+       fd2 = open(tmpl, O_WRONLY | O_CREAT | O_TRUNC);
+       if (fd2 < 0)
+               err(1, "open %s", tmpl);
+       offset = 0;
+       buf = aligned_alloc(page_size, NVME_MAX_XFER_SIZE);
+       if (buf == NULL)
+               errx(1, "Can't get buffer to read dump");
+       while (len > 0) {
+               resid = len > NVME_MAX_XFER_SIZE ? NVME_MAX_XFER_SIZE : len;
+               wdc_get_data(fd, opcode, resid, offset, cmd, buf, resid);
+               if (write(fd2, buf, resid) != resid)
+                       err(1, "write");
+               offset += resid;
+               len -= resid;
+       }
+       free(buf);
+       close(fd2);
+}
+
+static void
+wdc_do_clear_dump(int fd, uint32_t opcode, uint32_t cmd)
+{
+       struct nvme_pt_command  pt;
+
+       memset(&pt, 0, sizeof(pt));
+       pt.cmd.opcode = opcode;
+       pt.cmd.cdw12 = cmd;
+       if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
+               err(1, "wdc_do_clear_dump request failed");
+       if (nvme_completion_is_error(&pt.cpl))
+               errx(1, "wdc_do_clear_dump request returned error");
+}
+
+__dead static void
+wdc_cap_diag_usage(void)
+{
+       fprintf(stderr, "usage:\n");
+       fprintf(stderr, WDC_CAP_DIAG_USAGE);
+       exit(1);
+}
+
+__dead static void
+wdc_cap_diag(int argc, char *argv[])
+{
+       char path_tmpl[MAXPATHLEN];
+       int ch, fd;
+
+       path_tmpl[0] = '\0';
+       while ((ch = getopt(argc, argv, "o:")) != -1) {
+               switch ((char)ch) {
+               case 'o':
+                       strlcpy(path_tmpl, optarg, MAXPATHLEN);
+                       break;
+               default:
+                       wdc_cap_diag_usage();
+               }
+       }
+       /* Check that a controller was specified. */
+       if (optind >= argc)
+               wdc_cap_diag_usage();
+       open_dev(argv[optind], &fd, 1, 1);
+
+       wdc_do_dump(fd, path_tmpl, "cap_diag", WDC_NVME_CAP_DIAG_OPCODE,
+           WDC_NVME_CAP_DIAG_CMD, WDC_NVME_CAP_DIAG_CMD, 4);
+
+       close(fd);
+
+       exit(1);        
+}
+
+__dead static void
+wdc_drive_log_usage(void)
+{
+       fprintf(stderr, "usage:\n");
+       fprintf(stderr, WDC_DRIVE_LOG_USAGE);
+       exit(1);
+}
+
+__dead static void
+wdc_drive_log(int argc, char *argv[])
+{
+       char path_tmpl[MAXPATHLEN];
+       int ch, fd;
+
+       path_tmpl[0] = '\0';
+       while ((ch = getopt(argc, argv, "o:")) != -1) {
+               switch ((char)ch) {
+               case 'o':
+                       strlcpy(path_tmpl, optarg, MAXPATHLEN);
+                       break;
+               default:
+                       wdc_drive_log_usage();
+               }
+       }
+       /* Check that a controller was specified. */
+       if (optind >= argc)
+               wdc_drive_log_usage();
+       open_dev(argv[optind], &fd, 1, 1);
+
+       wdc_do_dump(fd, path_tmpl, "drive_log", WDC_NVME_DIAG_OPCODE,
+           WDC_NVME_DRIVE_LOG_SIZE_CMD, WDC_NVME_DRIVE_LOG_CMD, 0);
+
+       close(fd);
+
+       exit(1);
+}
+
+__dead static void
+wdc_get_crash_dump_usage(void)
+{
+       fprintf(stderr, "usage:\n");
+       fprintf(stderr, WDC_CAP_DIAG_USAGE);
+       exit(1);
+}
+
+__dead static void
+wdc_get_crash_dump(int argc, char *argv[])
+{
+       char path_tmpl[MAXPATHLEN];
+       int ch, fd;
+
+       while ((ch = getopt(argc, argv, "o:")) != -1) {
+               switch ((char)ch) {
+               case 'o':
+                       strlcpy(path_tmpl, optarg, MAXPATHLEN);
+                       break;
+               default:
+                       wdc_get_crash_dump_usage();
+               }
+       }
+       /* Check that a controller was specified. */
+       if (optind >= argc)
+               wdc_get_crash_dump_usage();
+       open_dev(argv[optind], &fd, 1, 1);
+
+       wdc_do_dump(fd, path_tmpl, "crash_dump", WDC_NVME_DIAG_OPCODE,
+           WDC_NVME_CRASH_DUMP_SIZE_CMD, WDC_NVME_CRASH_DUMP_CMD, 0);
+       wdc_do_clear_dump(fd, WDC_NVME_CLEAR_DUMP_OPCODE,



Home | Main Index | Thread Index | Old Index