ocp-nvme: Add LMDATA-37 for Latency Monitor Log

Datacenter NVMe SSD Specification v2.5
Log Identifier C3h
[447:436] Latency Monitor Debug Telemetry Log Size
This is the number of Dwords in the Latency Monitor Debug Log.
This value is in Dwords.
little endian order print

Signed-off-by: Hyuntae Kim <h1219.kim@samsung.com>
Signed-off-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

ocp-nvme: remove ocp log page version checking

For supporting ocp 2.5 and legacy version
if we want to check the log version,
we need to get DSSD(OCP) Spec version from ocp smart.

example) Latency Monitor (Log Identifier C3h)
OCP 2.0 Log Page version : 0x1
OCP 2.5 Log Page version : 0x4

Signed-off-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

wdc: Fix for Reading WDC C2 Vendor Unique Log Page

In cases where nvme drives are connected via a PCIe
switch, the pci vendor and device id are unable to
be read.  This causes a failure when reading values
in the WDC C2 log page needed for the get-drive-status
wdc plugin command.

Signed-off-by: jeff-lien-wdc <jeff.lien@wdc.com>

ocp: Fixes for OCP 2.5 Telemetry DA1 FIFO Event Parsing

This commit fixes several issues related to parsing
the Telemetry DA 1 and 2 Event FIFO's.

Fixes parsing of VU Event Data.
    Added checking for VU data.
    Removed the vu_event_identifier field from the debug
    event class structs since it's not guaranteed to be there.
    Added nvme_ocp_common_dbg_evt_class_vu_data to be used
    to access the VU data.

    Added checking for NULL pointers

    Added a check for the end of the Event FIFO entries that will
    break from the while loop when detected.

    Fixed lines longer then 100 columns.
    Fixed other miscellaneous errors flagged
    by checkpatch.pl.
    Fixed "Suspicious sizeof offset in a pointer
    arithmetic expression." errors flagged by Code
    scanning.

    Fixed loop index size error
    Fixed LE variable declarations and conversion issues
    Fixed vu data size errors
    Make variable names more descriptive

Signed-off-by: jeff-lien-wdc <jeff.lien@wdc.com>

nvme-print-json: update JSON verbose output for nvm-id-ctrl

Update the nvme-id-ctrl JSON verbose output for parity with this
command's normal verbose output.

Signed-off-by: Martin George <marting@netapp.com>

wdc: Add Support for SN5100S

This commit will add support for the SN51000S drive
which includes the following pci device ids:
0x5061, 0x5062, 0x5063.

Signed-off-by: jeff-lien-wdc <jeff.lien@wdc.com>

nvme: Support show-regs for nvmeof

Get properties only at offsets that support nvme fabric registers.
Since crto was not found in the nvmeof spec, it is removed.
Also, NSSR is only optional register. If the device is not supported by
the optional register, the error is ignored.

Reviewed-by: Steven Seungcheol <sc108.lee@samsung.com>
Signed-off-by: Minsik Jeon <hmi.jeon@samsung.com>

ocp: fix option handling in internal-log

When the noraml format is specified without -t option to
ocp internal-log command, the command ends abnormally with
segmentation fault.
This commit fixes the option handling.

Signed-off-by: Tetsuya TAKAHASHI <tetsuya20.takahashi@kioxia.com>

Documentation: Added solidigm plugin commands

Added documentation to all current solidigm plugin commands

Signed-off-by: Leonardo da Cunha <leonardo.da.cunha@solidigm.com>

wdc: add support for SNTMP drive

Adding an additional PCI Device ID (0x2761) to be recognized.

Signed-off-by: Brandon Paupore <brandon.paupore@wdc.com>

build: use linux-nvme/ci-containers

Use the pre build containers from linux-nvme/ci-containers.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

nvme-print: print NSSES field of CAP register

Print the newly added NSSES field of CAP register.

Signed-off-by: Francis Pravin <francis.p@samsung.com>

ocp: fix GUID output

Some OCP commands are missing a high-order zero in each byte
of the output GUID.

This commit fixes the format specifier for the printf function.

Signed-off-by: Tetsuya TAKAHASHI <tetsuya20.takahashi@kioxia.com>
Signed-off-by: Koki Ueha <koki1.ueha@kioxia.com>

nvme-print-json: print controller register values in offset order

Print the Controller Register valuse in order based on the offset.

Signed-off-by: Francis Pravin <francis.p@samsung.com>

nvme-print-json: print CMBEBS and CMBSWTP in json format

Print the CMBEBS and CMBSWTP register in json forma

Signed-off-by: Francis Pravin <francis.p@samsung.com>

nvme-print-stdout: update changed-ns-list-log output

The changed-ns-list-log command currently prints nothing for
scenarios where there are no changed ns in the log data. Print a
meaningful message for the same.

Signed-off-by: Martin George <marting@netapp.com>

nvme: fix uninitialized value in error-log

Valgrind complained about an "uninitialized value created by a
stack allocation" error while running the error-log command.
Fix the same.

Signed-off-by: Martin George <marting@netapp.com>

nvme: fix to convert metadata size to native byte order

The changes for create-ns, compare, read and write commands.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme-print: fix error information log page endianness error

Convert the status and phase tag fields to native byte order at first.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

completions: add get-feature command changed option

Separeted from the sel option changed value.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

doc: add get-feature command changed option

Separeted from the sel option changed value.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme: separate get NVME_GET_FEATURES_SEL_CHANGED definition

Since it is not defined in the NVMe specification.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme: use NVME_GET_FEATURES_SEL definitions

These changes are to replace the hardcoded SEL values.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme-print-stdout: use NVME_CTRL_OAES definitions

This is to reduce the hard coded value usage.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

completion: add ocp set-telemetry-profile to zsh

The zsh completion is missing the ocp set-telemetry-profile binding.

Signed-off-by: Leonardo da Cunha <leonardo.da.cunha@solidigm.com>

completion: add solidgm work-tracker binding

Signed-off-by: Leonardo da Cunha <leonardo.da.cunha@solidigm.com>

plugins/solidigm: Added Workload Tracker Triggers and Wall Time

Added Trigger configurations, Stopped converting timestamps to millisec,
added optional property to display wall clock column.

Signed-off-by: Leonardo da Cunha <leonardo.da.cunha@solidigm.com>

ocp: include util/types.h to use nvme_uint128_t

This is to fix nvme_uint128_t functions to work correctly.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: fix to set log data pointer allocated

Previously the NULL pointer is set incorrectly.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme: use NVME_CHECK() to check get features select field value

Use the macro instead of comparing the long filed value definition.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

build: bump libnvme wrap

Include libnvme NVME_CHECK() definition addition.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: split ocp-hwcomp log

This is to reduce the ocp-nvme.c code size.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

completions: add ocp hardware-component-log command

The command lists component descriptions.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

doc: add ocp hardware-component-log command

The command lists component descriptions.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: add hwcomp log json output

Add struct hwcomp_desc_entry and fix id option value type error.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: add hwcomp log command list option

This is to list component descriptions.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: add hwcomp log command comp-id option

This is to filter the component descriptions.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: add hwcomp dummy definition

This is for a debugging.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: add support for hwcomp log page

Note: Still json output not supported.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme: use NVME_CTRL_FNA definitions

Replace the hardcoded values.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

netapp-smdevices: print single device output too

In addition to printing info of all smdevices on the host, provide
an option to print the output of the specified device alone.

Signed-off-by: Martin George <marting@netapp.com>
Tested-by: Clayton Skaggs <claytons@netapp.com>

netapp-smdevices: segregate print routines

Segregate printing the respective normal/column and json outputs
into separate routines for better readability.

Signed-off-by: Martin George <marting@netapp.com>
Tested-by: Clayton Skaggs <claytons@netapp.com>

Add Support for new SN655 PCI Device ID

Support was added for an additional PCI Device ID (0x2723)
for SN655 drives.

Signed-off-by: jeff-lien-wdc <jeff.lien@wdc.com>

nvme-print-json: extern json object add functions

Some additinal functions introduced and fix obj_add_uint_0nx error.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: add SMART / health information extended log page version 4

Add NVMe command set errata version and lowest permitted firmware revision.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: add error recovery log page version 3

Add panic count and previous panic IDs.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: add get-enable-ieee1667-silo command

The commands returns set of enable IEEE1667 silo.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

fabrics: fix incorrect access filename check

Config JSON file handling is currently broken due to an incorrect
access filename check. Fix it.

Signed-off-by: Martin George <marting@netapp.com>

nvme: use NVME_GET_FEATURES_SEL_SUPPORTED definition

This is to delete the hardcoded values.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme-print-json: use _cleanup_free_

This is to delete the free function call.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

plugins/solidigm: fix use after free.

the "output" file descriptor is automatically closed when the function
returns; therefore we shouldn't explicitly call close() against it.

Signed-off-by: Maurizio Lombardi <mlombard@redhat.com>

ocp: fix ocp-nvme.c coding style errors

Only fixed some errors found by the file changes.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: Change C9 function names to use c9 instead

This is to unify c9 and C9 function names.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: fix to return c9 log page data error to open file

Use _cleanup_fd_ function so delete close() call and goto statement.
Also fix some minor coding style errors around the code.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: fix to set return value to get c9 log page data

The value not set but checked the ret variable after the call.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme: update nvme_insert_tls_key_versioned() return handling

Treat nvme_insert_tls_key_versioned() return value of zero as
errors too.

Signed-off-by: Martin George <marting@netapp.com>

nvme-print-stdout: add print_array function

To reduce the repeated print code for arrays.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

logging: add print_info function

This is for debugging print.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

util: extern uint128_t_to_double() function

Use the function to calculate with the uint128_t value.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme-print: sanitize error-log output

Minor textual and formatting changes to the error-log output.

Signed-off-by: Martin George <marting@netapp.com>

plugins/solidigm : Fixing vs-internal-log to generate identify per allocated namespace.

CNS 11h is for namespace data structures for allocated namespaces.
Earlier code was using attached namespaces. This fix is to generate
identify data structures per allocated namespace.

Signed-off-by: Haro Panosyan <haro.panosyan@solidigm.com>

nvme-print: added new fields for nvm_id_ns

Added new fields from I/O Command Set Specific Identify Namespace
Data Structure CNS5 as per NVM Command Set Specification(Rev 1.1).

Signed-off-by: Ankit Soni <soni.ankit@samsung.com>
Reviewed-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

build: update libnvme wrap

5585f06 - types: added new fields in nvme_nvme_id_ns

Signed-off-by: Ankit Soni <soni.ankit@samsung.com>

plugins/fdp: bugfix error check to validate output format

The return value of validate_output_format functions is whether the
functions fails. So I fix to check the err variable.

Signed-off-by: Minsik Jeon <hmi.jeon@samsung.com>

plugins/wdc: fix json output for vs-nand-stats

Running nvme wdc vs-nand-stats will change the values of the user data fields
depending on output format used. In regular stdout, the ordering is TLC min,
TLC Max, SLC Min, SLC Max. However in json, the values get reassigned, what
was SLC Min in stdout will become TLC >

Regular format (TLC Min, TLC Max, SLC Min, SLC Max)
[root@ /tmp/]# nvme wdc vs-nand-stats /dev/nvme0n1 | grep User\ Data
User Data Erase Counts - TLC Min 169
User Data Erase Counts - TLC Max 310
User Data Erase Counts - SLC Min 10719
User Data Erase Counts - SLC Max 11676

Json format (SLC Min, SLC Max, TLC Min, TLC Max)
[root@ /tmp/]# nvme wdc vs-nand-stats /dev/nvme0n1 -o json | grep User\ Data
"User Data Erase Counts - SLC Min" : 169,
"User Data Erase Counts - SLC Max" : 310,
"User Data Erase Counts - TLC Min" : 10719,
"User Data Erase Counts - TLC Max" : 11676,

The difference can be traced to how the array subscripts are being
used in the two output formats

stdout : https://t.ly/sRIDz

tlc_min == 0
tlc_max == 1
slc_min == 2
slc_max == 3

json : https://t.ly/pmU-m
slc_min = 0
slc_max = 1
tlc_min = 2
tlc_max = 3

With the patch, we rename the fields to be the same for both stdout & json.
Output comparison below

Regular format (TLC Min, TLC Max, SLC Min, SLC Max)
[root@ /tmp/]# ./nvme wdc vs-nand-stats /dev/nvme0n1 | grep User\ Data
User Data Erase Counts - TLC Min 169
User Data Erase Counts - TLC Max 310
User Data Erase Counts - SLC Min 10719
User Data Erase Counts - SLC Max 11676

Json format (TLC Min, TLC Max, SLC Min, SLC Max)
[root@ /tmp/]# ./nvme wdc vs-nand-stats /dev/nvme0n1 -o json | grep User\ Data
"User Data Erase Counts - TLC Min":169,
"User Data Erase Counts - TLC Max":310,
"User Data Erase Counts - SLC Min":10719,
"User Data Erase Counts - SLC Max":11676,

Signed-off-by: Carl Moran<carl.moran1@meta.com>

nvme-print-stdout: use NVME_FEAT util definitions

Some NVME_FEAT definitions needed to add for FDP, etc.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme-print: update subsys verbose outputs

The current list-subsys & show-topology simple outputs are a
little crowded. Also the respective verbose options to both
these commands are a no-op at the moment. So move the iopolicy
and subsystype details to the respective verbose outputs instead
so that the simple outputs are restricted to displaying key subsys
details like subsys name & NQN alone.

Signed-off-by: Martin George <marting@netapp.com>

nvme-print: add subsystype to the list-subsys output

The nvme list-subsys and show-topology outputs misses out on the
subsystype details. Add the same.

Signed-off-by: Martin George <marting@netapp.com>

netapp: print output for single device too

In addition to printing info of all ontap devices on the host,
provide an option to print the output for the specified
device alone.

Signed-off-by: Martin George <marting@netapp.com>

netapp: segregate the print routines

Segregate printing the respective regular/normal and json outputs
into separate routines for better readability.

Signed-off-by: Martin George <marting@netapp.com>

netapp: fix uninitialized value from heap error

Valgrind complained about an "uninitialized value created by a
heap allocation" error. Fix the same.

Signed-off-by: Martin George <marting@netapp.com>

nvme-print: print the new fields added in TP4142

Print the new fields added in Identify Controller Data Structure.
Also, print the field added in Temperature Threshold feature.

Signed-off-by: Francis Pravin <francis.p@samsung.com>
Reviewed-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

plugins/innogrit: modify for project tacoma

modify get-eventlog and remove smart-log-add function

Signed-off-by: innogritkenny <kenny.chu@innogrit.com>

wdc: Add Support for new SN-861 PCI device id

A new form factor (EDSFF E3.S) of the SN-861
drive was added to the wdc plugin code.

Signed-off-by: jeff-lien-wdc <jeff.lien@wdc.com>

nvme-print: use LC_MEASUREMENT to check fahrenheit temperature

Previously used LC_ALL so not checked correctly if LC_MEASUREMENT set.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme-print: use Completion Condition enum

Use the Completion Condition enum for LBA Status Descriptor.
Also, modified the print statement of Completion Condition.

Signed-off-by: Francis Pravin <francis.p@samsung.com>

build: update libnvme wrap

9bee8e1 - types: add new fields added in TP4142
df12de6 - types: Add enum for Completion Condition of
Get LBA status command

Signed-off-by: Francis Pravin <francis.p@samsung.com>

completions: add the zsh completion of the dapustor plugin

add the zsh completion of the dapustor plugin

Signed-off-by: Xiaoyuan Zhang <zhxiaoy2024@gmail.com>

nvme-print: print the new fields added in TP4165

Print the new fields added in TP4165.

Signed-off-by: Francis Pravin <francis.p@samsung.com>
Reviewed-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

plugins/dapustor: dapustor smart-log-add update

Extended Additional SMART log is optional.
If the collection fails, the command dose not stop.

Add the manual of dapustor plugin.
Update tab completion.

Signed-off-by: Xiaoyuan Zhang <zhxiaoy2024@gmail.com>

nvme-print-stdout: Added print for new field CSER (TP4167)

As per TP4167, added print for a new field CSER (Command Submission
and Execution Relaxations) [15:14] added in Commands Supported and
Effects Data Structure.

Signed-off-by: Nitin Sao <nitin.sao@samsung.com>
Reviewed-by: Mohit Kapoor <mohit.kap@samsung.com>

build: bump libnvme wrap

fetch NVME_CMD_EFFECTS_CSER_MASK from enum nvme_cmd_effects

Signed-off-by: Nitin Sao <nitin.sao@samsung.com>

plugins: Add a new DapuStor plugin and the smart-log-add command

Add the DapuStor plugin to support the retrieval and
display of the Vendor Specific SMART logs:
Additional SMART log page (0xCA)
Extended Additional SMART log page (0xCB)

Signed-off-by: Xiaoyuan Zhang <zhxiaoy2024@gmail.com>

Release v2.10.2

Signed-off-by: Daniel Wagner <dwagner@suse.de>

doc: Regenerate all docs for v2.10.2

Signed-off-by: Daniel Wagner <dwagner@suse.de>

build: fix libnvme dependency

Undo last libnvme dependency update which was done automatically
done by the release script.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

Release v2.10.1

Signed-off-by: Daniel Wagner <dwagner@suse.de>

doc: Regenerate all docs for v2.10.1

Signed-off-by: Daniel Wagner <dwagner@suse.de>

build: add install step to doc CI build

We had some fallouts which were happened at the install step when the
documentation was build. Let's add this step, so we catch those errors
in future.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

docs: rename ocp-unsupported-req-log file

The filename has to match the command name, thus rename the filename.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

Release v2.10

Signed-off-by: Daniel Wagner <dwagner@suse.de>

doc: Regenerate all docs for v2.10

Signed-off-by: Daniel Wagner <dwagner@suse.de>

build: bump libnvme wrap

Update to libnvme v1.10 release.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

sed: Fix parsing of Discovery0 features

TCG SED features have variable sizes, so the code needs to use
stored length to move the offset for the next feature.
Otherwise, it checks the code at the wrong offset.

Signed-off-by: Milan Broz <gmazyland@gmail.com>

fabrics: avoid potential segfault in nvmf_dim()

Eliminate the call to nvme_free_tree() in nvmf_dim() since the
cleanup helper is already available here.

Signed-off-by: Martin George <marting@netapp.com>

nvme: avoid segfault in show-topology

The show-topology command currently ends in a segfault for
ENOENT scenarios:

nvme show-topology
Failed to scan topology: No such file or directory
Segmentation fault (core dumped)

Fix this by eliminating the call to nvme_free_tree() since the
cleanup helper is already available here.

Signed-off-by: Martin George <marting@netapp.com>

fabrics: do not leak nvme_ctrl_t object on connect

valgrinds reports that the nvme_ctrl_t is leaked in the connect command.
Let's introduced a new cleanup helper for this.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

nvme: extend help message when mmap regs fails

Newer kernels enable the lockdown feature when secure boot is enabled.
This feature also prevents the register mapping into userspace. Thus it
is not enough to have CONFIG_IO_STRICT_DEVMEM disabled. Extend the
message with the hint also to disable secure boot.

While at it, also lower the reporting level to INFO, so that one single
'-v' is enough to get this information.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

nvme: return -ENXIO value to open device if errno not set

The APIs may not set errno so set errno to ENXIO before the device open.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

wdc: OCP 2.5 Log Page Updates

Add panic count and prev panic id to Error Recovery log page (0xC1)

Add debug telemetry log size to Latency Monitor log page (0xc3)

Signed-off-by: jeff-lien-wdc <jeff.lien@wdc.com>