docs: update check-tls-key arguments

Add the newly added --keyfile command line option.

Signed-off-by: Daniel Wagner <wagi@kernel.org>

nvme: add support to append TLS PSK to keyfile for check-tls-key

When checking a key and it is inserted into keystore, support to
append it to a keyfile too.

Signed-off-by: Daniel Wagner <wagi@kernel.org>

nvme: return correct error code in append_keyfile

On success fprintf returns the number of bytes written, thus we need to
set the err variable to 0 to return success.

Signed-off-by: Daniel Wagner <wagi@kernel.org>

docs: nvme-id-doman: dom{ia => ai}n

$ sed -i 's/domian/domain/g' $(git grep -l domian)

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>

ocp: fix latency monitoring data structure entry endian

Fix the entry data to little endian format.
Also delete to fill the data to 0 since already initialized by 0.

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

ocp: fix TCG configuration log endian

Fix the entry data fields to little endian format.
Basically print functions convert the fields data to cpu format.
But still some errors then fixed the print json functions also.

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

ocp: fix firmware activation history entry endian

Fix the entry data fields to little endian format.
Basically print functions convert the fields data to cpu format.
But still some errors then fixed the print functions also.

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

CI: Add workflow for running tests on real nvme device

Introducing a GitHub workflow which runs all test cases under the
`tests` directory on real hardware through a self-hosted runner.
This workflow is triggered nightly or on demand as the tests run about an
hour.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Create default ns on tearDown

After a test was run, the `tearDown` function is called and then creates
and attaches a single ns with the full NVM capacity.
This is done so the caller or the next test case receives a reasonably
formated drive.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Fix nvme_get_lba_status_test and nvme_lba_status_log_test

Look up if the drive supports the `Get LBA Status` optional admin
command before executing a `nvme get-lba-status` or `nvme
lba-status-log` command.

Furthermore use the correct action value on `get-lba-status`.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Add feature check to nvme_compare_test

Check if the NVM 'compare' command is supported before running the
nvme_compare_test which whould then fail with an 'Invalid Command
Opcode'

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Fix nvme_smart_log_test

Don't parse the smart log output to then print the (unsuccessfuly) parsed
values. Instead we print out the whole smart log output.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Use correct flag in vendor specific id-ctrl

Use the long option for a vendor specific id-ctrl instead of the verbose
flag 'v'.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Fix nvme_get_features_test

Specify mandatory namespace for Error Recovery (Feature Identifier 05h)
get features command.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Adjust ncap and nsze for nvme_format_test

Set ncap and nsze to the lowest possible value, such that this test can
be run on different device capacities.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Improve nvme_ctrl_reset_test

Run I/O after a successful ctrl reset.
This tests if the sqs and cqs are constructed after reset.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Fixup nvme_create_max_ns_test

Fix off by one errors and capacity allocation.

Small speedup for nvme_create_max_ns_test by reducing the io done by
`run_ns_io`. For this we introduce a new count parameter which can
overwrite the default value of 10.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Fix nvme_copy_test python traceback fails

Reworking the `get_ocfs` function to correctly parse the ocfs field.
At the same time refactor `nvme id-ctrl` that extracts the ocfs
field into separate functions. This is in preparation for following
commits that reuse the same functionality.

Furthermore nvme_copy_test fails on devices that do not support any
copy formats. For this to pass we need to declare
`self.host_behavior_data` in any case.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: fix nvme_attach_detach_ns_test

Calculate ncap with configured flbas instead of setting a hard coded
value that might be to big for the test device.

Also, for this test to not fail the `nvme list-ctrl` outputs a summary
of ctrls present which must be skipped when parsing for the ctrl-id.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Use raw string for compiling regex

This fixes "SyntaxWarning: invalid escape sequence" when `get_error_log`
is being called.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

docs: update gen-tls-key arguments

Add the newly added --keyfile command line option.

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

nvme: add support to add derive TLS PSK to keyfile

When creating a new key and it is inserted into keystore also support to
append it to a keyfile.

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

nvme: rename identity to version

Use the variable name consistently. The rest of the code base names this
variable as version.

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

nvme: set file permission for keyfile to owner only

Since this file contains secret enforce the read/write permission
limited to the owner only.

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

nvme: export tls keys honoring version and hmac

Export the keys with the correct encoding scheme.

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

nvmf-keys: add udev rule to import tls keys

Load keys to the keyring when the nvme-tcp module is loaded.

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

docs: update TLS options

With the added support to also accept the key via the command line
update the documentation accordingly.

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

fabrics: add support to connect to accept a PSK command line

Extend the connect command also to accept the pre-shared key via command
line. Obviously, this is not recommended to use for a production system
but for testing this is a simple way to get a setup working.

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

fabrics: add support to connect to accept a configuration

The connect-all command accepts JSON configuration but not
the connect command. connect-all will try to connect to all
possible resources, which includes creating discovery controllers.
This might not always needed or wanted.

The connect command will only connect to the controllers
listed in the configuration file and doesn't to any
additional discovery at all.

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

nvme: use unsigned char for hmac and identity

The spec is limiting the size of both variables to one byte, thus there
is no need to use wider types.

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

build: bump libnvme wrap

Fetch TLS API changes.

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

nvme-print: Add Sanitize Media Verification Event in PEL log

Add Sanitize Media Verification Event in Persistent Event Log.

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

netapp-ontapdev: add err msg for no ontapdevices

Print an error message if no ontapdevices on the host.

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

netapp-smdev: add err msg for no smdevices

Print an error message if no smdevices on the host.

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

doc: Add sanitize command emvs option

Add Enter Media Verification State (EVMS) option of Sanitize command.

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

ocp: combine to use GUID length definitions

This reduces the duplicated GUID length 16 bytes definitions.

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

nvme: update tls_key() handling

Few misc issues in current tls_key() implementation:

1) Additional blank line printed in err message if the keyfile
cannot be opened.

2) For export, nvme_scan_tls_keys() can return positive values too
for successful scenarios. So this currently leads to erroneous return
value handling.

3) For import, no return value checking for import_key() failure
scenarios.

4) For revoke, return appropriate error immediately when
nvme_revoke_tls_key() fails.

5) No helpful success message printed for all the options.

Fix the same.

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

nvme-print-stdout: print VERS bit of SANICAP field

Print the newly added VERS bit of SANICAP field in Identify Controller
Data Structure. Also, changed the variable names as per spec.

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

nvme: add EMVS support to sanitize command

Add Enter Media Verification State (EMVS) support to sanitize
command.
TP4152 - Post-Sanitize Media Verification 2024.04.01 Ratified.

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

build: update libnvme wrap

Get EMVS support of sanitize command and SMVES enum.

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

ocp: remove callback function cast

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

doc: added commit conventions to contribution guidelines

Show new contributors the project's commit guidelines

Signed-off-by: paumr <paum@bdisk.eu>

ocp: fix ocp-print-stdout.c indentation error

Fix also some build warnings.

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

ocp: fix ocp-nvme.c indentation errors

Also fix to use cpu_to_le64 to output __le64 values.

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

ocp: build ocp-nvme.c and ocp-telemetry-decode.c without json

Still ocp-telemetry-decode.c includes json code so check CONFIG_JSON.

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

ocp: split TCG configuration log print codes

Move into ocp-print-stdout.c and ocp-print-json.c.

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

ocp: split telemetry string log print codes

Move into ocp-print-stdout.c and ocp-print-json.c.

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

ocp: split device capabilities log print codes

Move into ocp-print-stdout.c and ocp-print-json.c.

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

ocp: split error recovery log print codes

Move into ocp-print-stdout.c and ocp-print-json.c.

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

ocp: split unsupported requirement log print codes

Move into ocp-print-stdout.c and ocp-print-json.c.

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

ocp: split latency monitor log print codes

Move into ocp-print-stdout.c and ocp-print-json.c.

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

ocp: move ocp telemetry log print function into ocp-print

Still the ocp-telemetry-decode used by print functions combined json code.

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

ocp: split smart extended log print codes

Move into ocp-print-stdout.c and ocp-print-json.c.

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

ocp: split ocp-fw-activation-history print codes

Moved into print stdout and json files.

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

plugins: update meson.build file to always build ocp plugin

Still ocp-nvme.c and some other ocp commands files depended on json.

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

ocp-print: move json code into separate files

At first only hwcomp print code moved.

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

nvme-print-json: display only verbose output

Having separate regular & verbose outputs makes more sense for the
stdout outputs, and not necessarily for the JSON outputs. So let's
make things simpler by having the JSON output everything, and
nothing short.

Suggested-by: Daniel Wagner <dwagner@suse.de>
Signed-off-by: Martin George <marting@netapp.com>

ocp-nvme: ocp plugin version update

Add missing version update after adding changes for ocp spec 2.5

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

nvme-print: print KV command set page header

Let stdout_effects_log_page handle NVME_CSI_KV as well.

Signed-off-by: laiaferrer <laiaferrermoser@gmail.com>

doc: show where self-test results can be found

Point the reader of the device-self-test documentation to
the command used for querying the test results.

Signed-off-by: paumr <paum@bdisk.eu>

plugins/memblaze: fix a wrong id on smart-log-add

Modify 0xB8 to 0xDF

Signed-off-by: jinhua.huang <jinhua.huang@memblaze.com>

plugins/dapustor: smart-log-add fix

Output Extended Additional SMART raw binary data if it exists.
Add the missing 'temp_since_bootup' field for json output.

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

plugins/sed: add sid password change

The existing ioctl to change password only updated the admin1 password.
Add using a new ioctl IOC_OPAL_SET_SID_PW to also update the sid password
so that sid and admin1 passwords are kept in sync.

Signed-off-by: Greg Joyce <gjoyce@linux.ibm.com>

plugins/solidigm: Automatic retry smaller log chunk size.

Retry to retrieve telemetry and PEL with smaller chunk size, because
some systems are failing to retrieve telemetry in 256KB chunks.

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

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>