Skip to content

doc: add nvme list namespace usage sizes description #2837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
igaw merged 2 commits into from
Jun 30, 2025
Merged

doc: add nvme list namespace usage sizes description #2837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9705407
doc: add nvme list namespace usage sizes description
ikegami-t Jun 4, 2025
9ef2234
nvme-print-stdout: add name space usage binary suffix verbose print
ikegami-t Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion Documentation/nvme-list.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ DESCRIPTION
-----------
Scan the sysfs tree for NVM Express devices and return the /dev node
for those devices as well as some pertinent information about them.
Namespace usage printed in powers of 1,000 with SI prefixes. (e.g., 1.02 TB)

OPTIONS
-------
Expand All @@ -34,7 +35,31 @@ PCI_IDS_PATH - Full path of pci.ids file in case nvme could not find it in commo

EXAMPLES
--------
No examples yet.
* Has the program issue a list
+
------------
# nvme list
Node Generic SN Model Namespace Usage Format FW Rev
--------------------- --------------------- -------------------- ---------------------------------------- ---------- -------------------------- ---------------- --------
/dev/nvme0n1 /dev/ng0n1 BTNH922508PS1P0B INTEL SSDPEKNW010T8 0x1 1.02 TB / 1.02 TB 512 B + 0 B 002C
------------

* Has the program issue a list with verbose
+
------------
# nvme list -v
Subsystem Subsystem-NQN Controllers
---------------- ------------------------------------------------------------------------------------------------ ----------------
nvme-subsys0 nqn.2019-22.com.intel:nvm-subsystem-sn-btnh922508ps1p0b nvme0

Device Cntlid SN MN FR TxPort Address Slot Subsystem Namespaces
---------------- ------ -------------------- ---------------------------------------- -------- ------ -------------- ------ ------------ ----------------
nvme0 1 BTNH922508PS1P0B INTEL SSDPEKNW010T8 002C pcie 0000:0d:00.0 nvme-subsys0 nvme0n1

Device Generic NSID Usage Format Controllers
----------------- ----------------- ---------- -------------------------- ---------------- ----------------
/dev/nvme0n1 /dev/ng0n1 0x1 1.02 TB / 1.02 TB 512 B + 0 B nvme0
------------

NVME
----
Expand Down
20 changes: 14 additions & 6 deletions nvme-print-stdout.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5376,26 +5376,34 @@ static void stdout_simple_list(nvme_root_t r)

static void stdout_ns_details(nvme_ns_t n)
{
char usage[128] = { 0 }, format[128] = { 0 };
char usage[128] = { 0 }, format[128] = { 0 }, usage_binary[128] = { 0 };
char devname[128] = { 0 }, genname[128] = { 0 };

long long lba = nvme_ns_get_lba_size(n);
double nsze = nvme_ns_get_lba_count(n) * lba;
double nuse = nvme_ns_get_lba_util(n) * lba;
double nsze_binary = nsze, nuse_binary = nuse;

const char *s_suffix = suffix_si_get(&nsze);
const char *u_suffix = suffix_si_get(&nuse);
const char *l_suffix = suffix_binary_get(&lba);

sprintf(usage, "%6.2f %2sB / %6.2f %2sB", nuse, u_suffix, nsze, s_suffix);
const char *s_suffix_binary, *u_suffix_binary;

sprintf(usage, "%6.2f %1sB / %6.2f %1sB", nuse, u_suffix, nsze, s_suffix);
sprintf(format, "%3.0f %2sB + %2d B", (double)lba, l_suffix,
nvme_ns_get_meta_size(n));

s_suffix_binary = suffix_dbinary_get(&nsze_binary);
u_suffix_binary = suffix_dbinary_get(&nuse_binary);
sprintf(usage_binary, "(%7.2f %2sB / %7.2f %2sB)", nuse_binary, u_suffix_binary,
nsze_binary, s_suffix_binary);

nvme_dev_full_path(n, devname, sizeof(devname));
nvme_generic_full_path(n, genname, sizeof(genname));

printf("%-12s %-12s %#-10x %-26s %-16s ", devname,
genname, nvme_ns_get_nsid(n), usage, format);
printf("%-17s %-17s %#-10x %-21s %-25s %-16s ", devname,
genname, nvme_ns_get_nsid(n), usage, usage_binary, format);
}

static bool stdout_detailed_name(const char *name, void *arg)
Expand Down Expand Up @@ -5540,9 +5548,9 @@ static void stdout_detailed_list(nvme_root_t r)
strset_iterate(&res.ctrls, stdout_detailed_ctrl, &res);
printf("\n");

printf("%-17s %-17s %-10s %-26s %-16s %-16s\n", "Device", "Generic",
printf("%-17s %-17s %-10s %-49s %-16s %-16s\n", "Device", "Generic",
"NSID", "Usage", "Format", "Controllers");
printf("%-.17s %-.17s %-.10s %-.26s %-.16s %-.16s\n", dash, dash, dash,
printf("%-.17s %-.17s %-.10s %-.49s %-.16s %-.16s\n", dash, dash, dash,
dash, dash, dash);
strset_iterate(&res.namespaces, stdout_detailed_ns, &res);

Expand Down