freebsd-skq/sbin/nvmecontrol/nvmecontrol.c
imp 32a1fe0af3 Usage cleanup pt 2
Eliminage redundant spaces and nvmecontrol at start of all the usage
strings. Update the usage printing code to add them back when
presenting to the user. Allow multi-line usage messages and print
proper leading spaces for lines starting with a space.

Sponsored by: Netflix
Differential Revision: https://reviews.freebsd.org/D18403
2018-12-02 23:13:12 +00:00

274 lines
6.0 KiB
C

/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* 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 <sys/stat.h>
#include <ctype.h>
#include <err.h>
#include <errno.h>
#include <fcntl.h>
#include <paths.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include "nvmecontrol.h"
SET_DECLARE(top, struct nvme_function);
static void
print_usage(const struct nvme_function *f)
{
const char *cp;
char ch;
bool need_prefix = true;
cp = f->usage;
while (*cp) {
ch = *cp++;
if (need_prefix) {
if (ch != ' ')
fputs(" nvmecontrol ", stderr);
else
fputs(" ", stderr);
}
fputc(ch, stderr);
need_prefix = (ch == '\n');
}
if (!need_prefix)
fputc('\n', stderr);
}
static void
gen_usage_set(struct nvme_function **f, struct nvme_function **flimit)
{
fprintf(stderr, "usage:\n");
while (f < flimit) {
print_usage(*f);
f++;
}
exit(1);
}
void
usage(const struct nvme_function *f)
{
fprintf(stderr, "usage:\n");
print_usage(f);
exit(1);
}
void
dispatch_set(int argc, char *argv[], struct nvme_function **tbl,
struct nvme_function **tbl_limit)
{
struct nvme_function **f = tbl;
if (argv[1] == NULL) {
gen_usage_set(tbl, tbl_limit);
return;
}
while (f < tbl_limit) {
if (strcmp(argv[1], (*f)->name) == 0) {
(*f)->fn(*f, argc-1, &argv[1]);
return;
}
f++;
}
fprintf(stderr, "Unknown command: %s\n", argv[1]);
gen_usage_set(tbl, tbl_limit);
}
static void
print_bytes(void *data, uint32_t length)
{
uint32_t i, j;
uint8_t *p, *end;
end = (uint8_t *)data + length;
for (i = 0; i < length; i++) {
p = (uint8_t *)data + (i*16);
printf("%03x: ", i*16);
for (j = 0; j < 16 && p < end; j++)
printf("%02x ", *p++);
if (p >= end)
break;
printf("\n");
}
printf("\n");
}
static void
print_dwords(void *data, uint32_t length)
{
uint32_t *p;
uint32_t i, j;
p = (uint32_t *)data;
length /= sizeof(uint32_t);
for (i = 0; i < length; i+=8) {
printf("%03x: ", i*4);
for (j = 0; j < 8; j++)
printf("%08x ", p[i+j]);
printf("\n");
}
printf("\n");
}
void
print_hex(void *data, uint32_t length)
{
if (length >= sizeof(uint32_t) || length % sizeof(uint32_t) == 0)
print_dwords(data, length);
else
print_bytes(data, length);
}
void
read_controller_data(int fd, struct nvme_controller_data *cdata)
{
struct nvme_pt_command pt;
memset(&pt, 0, sizeof(pt));
pt.cmd.opc = NVME_OPC_IDENTIFY;
pt.cmd.cdw10 = htole32(1);
pt.buf = cdata;
pt.len = sizeof(*cdata);
pt.is_read = 1;
if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
err(1, "identify request failed");
/* Convert data to host endian */
nvme_controller_data_swapbytes(cdata);
if (nvme_completion_is_error(&pt.cpl))
errx(1, "identify request returned error");
}
void
read_namespace_data(int fd, uint32_t nsid, struct nvme_namespace_data *nsdata)
{
struct nvme_pt_command pt;
memset(&pt, 0, sizeof(pt));
pt.cmd.opc = NVME_OPC_IDENTIFY;
pt.cmd.nsid = htole32(nsid);
pt.buf = nsdata;
pt.len = sizeof(*nsdata);
pt.is_read = 1;
if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
err(1, "identify request failed");
/* Convert data to host endian */
nvme_namespace_data_swapbytes(nsdata);
if (nvme_completion_is_error(&pt.cpl))
errx(1, "identify request returned error");
}
int
open_dev(const char *str, int *fd, int show_error, int exit_on_error)
{
char full_path[64];
if (!strnstr(str, NVME_CTRLR_PREFIX, strlen(NVME_CTRLR_PREFIX))) {
if (show_error)
warnx("controller/namespace ids must begin with '%s'",
NVME_CTRLR_PREFIX);
if (exit_on_error)
exit(1);
else
return (EINVAL);
}
snprintf(full_path, sizeof(full_path), _PATH_DEV"%s", str);
*fd = open(full_path, O_RDWR);
if (*fd < 0) {
if (show_error)
warn("could not open %s", full_path);
if (exit_on_error)
exit(1);
else
return (errno);
}
return (0);
}
void
parse_ns_str(const char *ns_str, char *ctrlr_str, uint32_t *nsid)
{
char *nsloc;
/*
* Pull the namespace id from the string. +2 skips past the "ns" part
* of the string. Don't search past 10 characters into the string,
* otherwise we know it is malformed.
*/
nsloc = strnstr(ns_str, NVME_NS_PREFIX, 10);
if (nsloc != NULL)
*nsid = strtol(nsloc + 2, NULL, 10);
if (nsloc == NULL || (*nsid == 0 && errno != 0))
errx(1, "invalid namespace ID '%s'", ns_str);
/*
* The controller string will include only the nvmX part of the
* nvmeXnsY string.
*/
snprintf(ctrlr_str, nsloc - ns_str + 1, "%s", ns_str);
}
int
main(int argc, char *argv[])
{
if (argc < 2)
gen_usage_set(SET_BEGIN(top), SET_LIMIT(top));
DISPATCH(argc, argv, top);
return (0);
}