diff options
Diffstat (limited to 'freebsd/sbin/nvmecontrol/identify.c')
| -rw-r--r-- | freebsd/sbin/nvmecontrol/identify.c | 280 |
1 files changed, 280 insertions, 0 deletions
diff --git a/freebsd/sbin/nvmecontrol/identify.c b/freebsd/sbin/nvmecontrol/identify.c new file mode 100644 index 00000000..be2fb00c --- /dev/null +++ b/freebsd/sbin/nvmecontrol/identify.c @@ -0,0 +1,280 @@ +#include <machine/rtems-bsd-user-space.h> + +/*- + * SPDX-License-Identifier: BSD-2-Clause-FreeBSD + * + * Copyright (C) 2012-2013 Intel Corporation + * All rights reserved. + * Copyright (C) 2018-2019 Alexander Motin <mav@FreeBSD.org> + * + * 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 <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 "nvmecontrol.h" +#include "nvmecontrol_ext.h" + +#define NONE 0xfffffffeu + +static struct options { + bool hex; + bool verbose; + const char *dev; + uint32_t nsid; +} opt = { + .hex = false, + .verbose = false, + .dev = NULL, + .nsid = NONE, +}; + +void +print_namespace(struct nvme_namespace_data *nsdata) +{ + uint32_t i; + uint32_t lbaf, lbads, ms, rp; + uint8_t thin_prov, ptype; + uint8_t flbas_fmt, t; + + thin_prov = (nsdata->nsfeat >> NVME_NS_DATA_NSFEAT_THIN_PROV_SHIFT) & + NVME_NS_DATA_NSFEAT_THIN_PROV_MASK; + + flbas_fmt = (nsdata->flbas >> NVME_NS_DATA_FLBAS_FORMAT_SHIFT) & + NVME_NS_DATA_FLBAS_FORMAT_MASK; + + printf("Size (in LBAs): %lld (%lldM)\n", + (long long)nsdata->nsze, + (long long)nsdata->nsze / 1024 / 1024); + printf("Capacity (in LBAs): %lld (%lldM)\n", + (long long)nsdata->ncap, + (long long)nsdata->ncap / 1024 / 1024); + printf("Utilization (in LBAs): %lld (%lldM)\n", + (long long)nsdata->nuse, + (long long)nsdata->nuse / 1024 / 1024); + printf("Thin Provisioning: %s\n", + thin_prov ? "Supported" : "Not Supported"); + printf("Number of LBA Formats: %d\n", nsdata->nlbaf+1); + printf("Current LBA Format: LBA Format #%02d\n", flbas_fmt); + printf("Data Protection Caps: %s%s%s%s%s%s\n", + (nsdata->dpc == 0) ? "Not Supported" : "", + ((nsdata->dpc >> NVME_NS_DATA_DPC_MD_END_SHIFT) & + NVME_NS_DATA_DPC_MD_END_MASK) ? "Last Bytes, " : "", + ((nsdata->dpc >> NVME_NS_DATA_DPC_MD_START_SHIFT) & + NVME_NS_DATA_DPC_MD_START_MASK) ? "First Bytes, " : "", + ((nsdata->dpc >> NVME_NS_DATA_DPC_PIT3_SHIFT) & + NVME_NS_DATA_DPC_PIT3_MASK) ? "Type 3, " : "", + ((nsdata->dpc >> NVME_NS_DATA_DPC_PIT2_SHIFT) & + NVME_NS_DATA_DPC_PIT2_MASK) ? "Type 2, " : "", + ((nsdata->dpc >> NVME_NS_DATA_DPC_PIT2_MASK) & + NVME_NS_DATA_DPC_PIT1_MASK) ? "Type 1" : ""); + printf("Data Protection Settings: "); + ptype = (nsdata->dps >> NVME_NS_DATA_DPS_PIT_SHIFT) & + NVME_NS_DATA_DPS_PIT_MASK; + if (ptype) { + printf("Type %d, %s Bytes\n", ptype, + ((nsdata->dps >> NVME_NS_DATA_DPS_MD_START_SHIFT) & + NVME_NS_DATA_DPS_MD_START_MASK) ? "First" : "Last"); + } else { + printf("Not Enabled\n"); + } + printf("Multi-Path I/O Capabilities: %s%s\n", + (nsdata->nmic == 0) ? "Not Supported" : "", + ((nsdata->nmic >> NVME_NS_DATA_NMIC_MAY_BE_SHARED_SHIFT) & + NVME_NS_DATA_NMIC_MAY_BE_SHARED_MASK) ? "May be shared" : ""); + printf("Reservation Capabilities: %s%s%s%s%s%s%s%s%s\n", + (nsdata->rescap == 0) ? "Not Supported" : "", + ((nsdata->rescap >> NVME_NS_DATA_RESCAP_IEKEY13_SHIFT) & + NVME_NS_DATA_RESCAP_IEKEY13_MASK) ? "IEKEY13, " : "", + ((nsdata->rescap >> NVME_NS_DATA_RESCAP_EX_AC_AR_SHIFT) & + NVME_NS_DATA_RESCAP_EX_AC_AR_MASK) ? "EX_AC_AR, " : "", + ((nsdata->rescap >> NVME_NS_DATA_RESCAP_WR_EX_AR_SHIFT) & + NVME_NS_DATA_RESCAP_WR_EX_AR_MASK) ? "WR_EX_AR, " : "", + ((nsdata->rescap >> NVME_NS_DATA_RESCAP_EX_AC_RO_SHIFT) & + NVME_NS_DATA_RESCAP_EX_AC_RO_MASK) ? "EX_AC_RO, " : "", + ((nsdata->rescap >> NVME_NS_DATA_RESCAP_WR_EX_RO_SHIFT) & + NVME_NS_DATA_RESCAP_WR_EX_RO_MASK) ? "WR_EX_RO, " : "", + ((nsdata->rescap >> NVME_NS_DATA_RESCAP_EX_AC_SHIFT) & + NVME_NS_DATA_RESCAP_EX_AC_MASK) ? "EX_AC, " : "", + ((nsdata->rescap >> NVME_NS_DATA_RESCAP_WR_EX_SHIFT) & + NVME_NS_DATA_RESCAP_WR_EX_MASK) ? "WR_EX, " : "", + ((nsdata->rescap >> NVME_NS_DATA_RESCAP_PTPL_SHIFT) & + NVME_NS_DATA_RESCAP_PTPL_MASK) ? "PTPL" : ""); + printf("Format Progress Indicator: "); + if ((nsdata->fpi >> NVME_NS_DATA_FPI_SUPP_SHIFT) & + NVME_NS_DATA_FPI_SUPP_MASK) { + printf("%u%% remains\n", + (nsdata->fpi >> NVME_NS_DATA_FPI_PERC_SHIFT) & + NVME_NS_DATA_FPI_PERC_MASK); + } else + printf("Not Supported\n"); + t = (nsdata->dlfeat >> NVME_NS_DATA_DLFEAT_READ_SHIFT) & + NVME_NS_DATA_DLFEAT_READ_MASK; + printf("Deallocate Logical Block: Read %s%s%s\n", + (t == NVME_NS_DATA_DLFEAT_READ_NR) ? "Not Reported" : + (t == NVME_NS_DATA_DLFEAT_READ_00) ? "00h" : + (t == NVME_NS_DATA_DLFEAT_READ_FF) ? "FFh" : "Unknown", + (nsdata->dlfeat >> NVME_NS_DATA_DLFEAT_DWZ_SHIFT) & + NVME_NS_DATA_DLFEAT_DWZ_MASK ? ", Write Zero" : "", + (nsdata->dlfeat >> NVME_NS_DATA_DLFEAT_GCRC_SHIFT) & + NVME_NS_DATA_DLFEAT_GCRC_MASK ? ", Guard CRC" : ""); + printf("Optimal I/O Boundary (LBAs): %u\n", nsdata->noiob); + printf("Globally Unique Identifier: "); + for (i = 0; i < sizeof(nsdata->nguid); i++) + printf("%02x", nsdata->nguid[i]); + printf("\n"); + printf("IEEE EUI64: "); + for (i = 0; i < sizeof(nsdata->eui64); i++) + printf("%02x", nsdata->eui64[i]); + printf("\n"); + for (i = 0; i <= nsdata->nlbaf; i++) { + lbaf = nsdata->lbaf[i]; + lbads = (lbaf >> NVME_NS_DATA_LBAF_LBADS_SHIFT) & + NVME_NS_DATA_LBAF_LBADS_MASK; + ms = (lbaf >> NVME_NS_DATA_LBAF_MS_SHIFT) & + NVME_NS_DATA_LBAF_MS_MASK; + rp = (lbaf >> NVME_NS_DATA_LBAF_RP_SHIFT) & + NVME_NS_DATA_LBAF_RP_MASK; + printf("LBA Format #%02d: Data Size: %5d Metadata Size: %5d" + " Performance: %s\n", + i, 1 << lbads, ms, (rp == 0) ? "Best" : + (rp == 1) ? "Better" : (rp == 2) ? "Good" : "Degraded"); + } +} + +static void +identify_ctrlr(int fd) +{ + struct nvme_controller_data cdata; + int hexlength; + + read_controller_data(fd, &cdata); + close(fd); + + if (opt.hex) { + if (opt.verbose) + hexlength = sizeof(struct nvme_controller_data); + else + hexlength = offsetof(struct nvme_controller_data, + reserved8); + print_hex(&cdata, hexlength); + exit(0); + } + + nvme_print_controller(&cdata); + exit(0); +} + +static void +identify_ns(int fd, uint32_t nsid) +{ + struct nvme_namespace_data nsdata; + int hexlength; + + read_namespace_data(fd, nsid, &nsdata); + close(fd); + + if (opt.hex) { + if (opt.verbose) + hexlength = sizeof(struct nvme_namespace_data); + else + hexlength = offsetof(struct nvme_namespace_data, + reserved6); + print_hex(&nsdata, hexlength); + exit(0); + } + + print_namespace(&nsdata); + exit(0); +} + +static void +identify(const struct cmd *f, int argc, char *argv[]) +{ + char *path; + int fd; + uint32_t nsid; + + arg_parse(argc, argv, f); + + open_dev(opt.dev, &fd, 1, 1); + get_nsid(fd, &path, &nsid); + if (nsid != 0) { + /* + * We got namespace device, but we need to send IDENTIFY + * commands to the controller, not the namespace, since it + * is an admin cmd. The namespace ID will be specified in + * the IDENTIFY command itself. + */ + close(fd); + open_dev(path, &fd, 1, 1); + } + free(path); + if (opt.nsid != NONE) + nsid = opt.nsid; + + if (nsid == 0) + identify_ctrlr(fd); + else + identify_ns(fd, nsid); +} + +static const struct opts identify_opts[] = { +#define OPT(l, s, t, opt, addr, desc) { l, s, t, &opt.addr, desc } + OPT("hex", 'x', arg_none, opt, hex, + "Print identiy information in hex"), + OPT("verbose", 'v', arg_none, opt, verbose, + "More verbosity: print entire identify table"), + OPT("nsid", 'n', arg_uint32, opt, nsid, + "Namespace ID to use if not in device name"), + { NULL, 0, arg_none, NULL, NULL } +}; +#undef OPT + +static const struct args identify_args[] = { + { arg_string, &opt.dev, "controller-id|namespace-id" }, + { arg_none, NULL, NULL }, +}; + +static struct cmd identify_cmd = { + .name = "identify", + .fn = identify, + .descr = "Print summary of the IDENTIFY information", + .ctx_size = sizeof(opt), + .opts = identify_opts, + .args = identify_args, +}; + +CMD_COMMAND(identify_cmd); |