Merge pull request #284 from hreinecke/filter-doc

Document filter functions

Document filter functions

Add documentation for the various filter functions.

Signed-off-by: Hannes Reinecke <hare@suse.de>

Merge pull request #281 from glimchb/opensslci

CI: add test for subproject fallbacks compilation

CI: add test for subproject fallbacks compilation

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

Merge pull request #280 from glimchb/test

test: adding dependency on pynvme

test: adding dependency on pynvme

On few systems (i.e. Fedora) when running meson test,
the python library build is not invoked.

For example, on Ubuntu, this works fine.
That's why CI dodn't catch it.

So adding explicit dependency in tests.

Fixes #279

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

Merge pull request #278 from sc108-lee/list_ns

ns list bug fix (wrong cns value)

Merge pull request #277 from glimchb/openssl

openssl: update to patch-3 to fix installation issue

Merge pull request #275 from Arunpandian15/types_05

types: Add missing doc field description

ioctl.h: ns list bug fix (wrong cns value)

original cns is not using csi field
naming align
NVME_IDENTIFY_CNS_CSS_ALLOCATED_NS_LIST -> NVME_IDENTIFY_CNS_CSI_ALLOCATED_NS_LIST

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

types.h: Key Value Command Set Identifier added (NVME_CSI_KV)

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

openssl: update to patch-3 to fix installation issue

Fixes #268

Patch taken from https://mesonbuild.com/Wrapdb-projects.html
Wrap file used https://wrapdb.mesonbuild.com/v2/openssl_1.1.1l-3/openssl.wrap
Fixed by mesonbuild/wrapdb#322

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

types: Add missing doc field description

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #274 from sc108-lee/status_code_type

types: fix status code type bug (wrong masking)

types: fix status code type bug (wrong masking)

the error comes from fc274c57c6b3063d35dd76e36b777adc4da29e0d
using NVME_GET for masked value #148

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

doc: Regenerate all documentation

Prepare for next release candiate.

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

linux: Add log.h back

We still need log.h for the various log level definitions.

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

linux: Include private.h

Replace log.h with private.h because we added log.h only for
nvme_msg() but this define has been moved to the private.h header
file.

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

Merge pull request #236 from birkelund/meson-fixes

meson: small fixes

Merge pull request #273 from igaw/fix-libssl-dep

build: Depend on libssl when using the fallback dependency

build: Depend on libssl when using the fallback dependency

libnvme doesn't depend on the openssl application. Update the fallback
dependency to libssl.

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

Merge pull request #272 from Arunpandian15/sc

util: Add status code values in order to return errno

util: Add status code values in order to return errno

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #267 from igaw/traddr-case-insesitive

tree: Ignore traddr case in nvme_lookup_ctrl()

Merge pull request #269 from Arunpandian15/util_sc_02

util: Congregate status code values to return EINVAL

Merge pull request #270 from igaw/fix-pel

ioctl: Set lsp to action in nvme_get_log_persistent_event

ioctl: Set lsp to action in nvme_get_log_persistent_event

Retrieving PEL fails because the lsp is set to NVME_LOG_LSP_NONE
instead of action:

  # nvme -persistent-event-log  -a 1 /dev/nvme0
  NVMe status: Command Sequence Error: The command was aborted due to a protocol violation in a multi- command sequence(0xc)

Signed-off-by: Wen Xiong <wenxiong@linux.ibm.com>
[dwagner: updated commit message]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

util: Congregate status code values to return EINVAL

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

tree: Ignore traddr case in nvme_lookup_ctrl()

Some FC discovery controllers return traddr strings with upper case
hexadecimal. There was is no requirement in the NVME-FC specification
that it be upper or lower case. Switch to strcasecmp for case
insentive traddr comparison.

Based on nvme-cli change 1264c6323937 ("nvme-cli: Make connect-all
matching be case insensitive")

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

Merge pull request #264 from igaw/fix-system-uuid

fabrics: Do not swap bytes for system uuid

fabrics: Do not swap bytes for system uuid

The kernel is taking care of swapping the system uuid bytes since
f1d8e614d74b ("drivers/firmware/dmi_scan.c: check dmi version when get
system uuid"). Hence we should not swap them again. Instead just read
/sys/class/dmi/id/product_uuid and store the bytes directly into the
system_uuid buffer.

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

Merge pull request #266 from glimchb/actionbranch

CI: rename branch main to master

CI: rename branch main to master

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

Merge pull request #257 from glimchb/setuptools

 pyproject.toml instead of setup.py for new packaging

Workflow: temporary disable publish to PyPI, starting with TestPyPI

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

Merge pull request #259 from Arunpandian15/fix_sct

types: status code type value update as per NVMe specification

Merge pull request #262 from Arunpandian15/util_01

util: Add status code values in geneic status to errono conversion

util: Add status code values in generic status to errno conversion

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #261 from martin-belanger/move-ccan-out-of-public-headers

Move ccan definitions out of public headers.

Move ccan definitions out of public headers.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>

Add workflow to publish to PyPI and TestPyPI

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

pyproject.toml instead of setup.py for new packaging

This allows to build with meson and package for Pypi

Build like this:
    python -m build

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

types: status code type value update as per NVMe specification

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #258 from Arunpandian15/types_doc_28

types: Add missing doc for ZNS, NVMe OF, NVMe command set

types: Add missing doc for ZNS, NVMe OF, NVMe command set

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #256 from Arunpandian15/doc_types_25

types: Add doc section for enum fields

types: Add doc section for enum fields

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #255 from Arunpandian15/types_doc_24

types: Add doc field for admin opcodes, FIDs, LIDs, Identify commands

types: Add doc field for admin opcodes, FIDs, LIDs, Identify commands

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #254 from Arunpandian15/mi_types

types: All MI command related structure doc field update

types: All MI command related structure doc field update

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

build: Use boolean type for docs-build default

muon complains about the type used for the default value. As it a
boolean type use a boolean as value instead of a string value.

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

doc: Regenerate all documentation

Prepare for next release candiate.

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

doc: Do not precomple HTML doc anymore

The HTML part is not ready yet. Let's remove the precompiled HTML doc.

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

Merge pull request #253 from igaw/port-default-port-for-discovery

fabrics: add default port number for NVMe/TCP I/O controllers

fabrics: add default port number for NVMe/TCP I/O controllers

As per section 7.4.9.3 "Transport Service Identifier" of the NVMe over
Fabrics 1.1 specification, the default IANA port number for a NVMe/TCP
discovery controller is 8009. But at the same time, it also clearly
states that NVMe/TCP I/O controllers should not use TCP port number
8009, but may instead use 4420 as the default here.

So make sure to fill these values appropriately, and pass it down.

Signed-off-by: Martin George <marting@netapp.com>
[dwagner: backport from monolithic branch]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #252 from Arunpandian15/doc_mi

types: doc field update for NVM commands, Feature Identifiers

types: doc field update for NVM commands, Feature Identifiers

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #248 from igaw/tp8010-support-refactored

TP8010 support refactored

fabrics: Add support to register with a DC

This adds support for the TP8010 by introducing nvmf_registration_ctlr
function which performs the registration task with a Discovery
Controller.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
[dwagner: refactored, reformated, udpated documentation,
          moved nvme_fetch_cntrltype_dctype_from_id here]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

ioctl: Add nvme_dim_send()

Add nvme_dim_send() to send Discovery Information Managements commands.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
[dwagner: reorder args arguments, rename function]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

util: Add key-value helpers and OS identification tools

Key value helpers and also the OS identification are used for
implementing TP8010 support.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
[dwagner: refactoring, reformating]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

types: Add Discovery Information Managment types

Add Discovery Information Management related types for TP8010.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
[dwagner: renaming, adding documation and reformating]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

tree: Add cntrltype and dctype to the controller object

The Discovery Controller Type (dctype) is a new attribute defined
in TP8010. This new attribute, as well as the existing Controller
Type (cntrltype) attributes will now be exposed through the sysfs
starting with kernel 5.18. For older kernels, the cntrltype and
dctype must be retrieved by performing a Identify command.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
[dwagner: Removed nvme_fetch_cntrltype_dctype_from_id]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #250 from Arunpandian15/types_h_doc_21

types.h: doc update for ZNS structures

Merge pull request #246 from igaw/fix-nvme_msg

log: Allow nvme_msg usage with invalid root pointer

log: Allow nvme_msg usage with invalid root pointer

24ac082f481d ("Add 'nvme_root_t' argument to nvme_msg()") and
19b12831a9ec ("Move global logging variables into nvme_root_t") moved
the logging controller knobs into the root object. In case the pointer
is invalid we should not try to use it. Instead just bailing out just
log the line.

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

types.h: doc update for ZNS structures

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #247 from Arunpandian15/types_h_doc_field

types.h: Add missing documentation for all the log pages

Merge pull request #249 from AkhileshRN/telemetry_ctlr

Fix to update size for telemetry log page when telemetry controller initiated data is unavailable.

linux: Update size when telemetry controller initiated data is unavailable

Fix to update size for telemetry log page when telemetry controller
initiated data is unavailable.

types: Add DCTYPE to nvme_id_psd

TP8010 introduced Discovery Controller Type (DCTYPE) to the
Identify Controller data structure. Add the new field.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
Signed-off-by: Daniel Wagner <dwagner@suse.de>

tree: Add host symbolic name

The host symbolic name was introduced in TP8010. It is used for
explicit registration with discovery controllers using the
discovery information management (DIM) command.x

Signed-off-by: Martin Belanger <martin.belanger@dell.com>

python: Add dump_config

Add support to the Python binding to dump the JSON config by hooking
up nvme_dump_config.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
Signed-off-by: Daniel Wagner <dwagner@suse.de>

types.h: Add missing documentaion for all the log pages

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #245 from Arunpandian15/cleanup_17

Cleanup patch for linux.h, log.h, tree.h

tree: Add missing documentation

Add missing documentation to all functions declarations.
While at it also fix whitespace issues and intentions levels

Signed-off-by: Arunpandian J <apj.arun@samsung.com>
[dwagner: added commit messages, extended the docs bits]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

log: Fix whitespacing in documentation

Make the documentation consistent with the other header files.

Signed-off-by: Arunpandian J <apj.arun@samsung.com>
[dwagner: added commit messages]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

linux: Streamline documentation

Make the documetation consistent with the other header files.
While at it also fix whitespace issues and intentions levels

Signed-off-by: Arunpandian J <apj.arun@samsung.com>
[dwagner: added commit messages, extended the docs bits]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #242 from Arunpandian15/doc_update

ioctl.h: Add description for fields used

ioctl.h: Add description for fields used

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #234 from jeffreyalien/uuidx-parm

[libnvme] Add uuidx parm to get log page API

linux: Change nvme_get_log_page to use nvme_get_log_args parm

Combined nvme_get_log_page and nvme_get_log_page_padded into
one function

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

Merge pull request #237 from Arunpandian15/cleanup_Description

types: Add doc description for fields used

Merge pull request #239 from hanumanthuh/master

add cdw13 for set_feature_args structure

Merge pull request #238 from samiWaheed/master

Corrected FW log page used  in nvme_get_log_fw_slot

add cdw13 for set_feature_args structure

Update ioctl.h

types: Added doc description for fields used

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

meson: do not leak internal include directories

When building libnvme as a subproject, do not leak the internal ccan or
project root directories. Only add src/ to the list of directories to be
included.

Signed-off-by: Klaus Jensen <k.jensen@samsung.com>

Merge pull request #233 from igaw/fix-mem-leak

tree: Fix memleaks in __nvme_free_ns() and nvme_scan_subsystem()

build: make Python memory allocations valgrind friendly

When testing with

  meson test -C .build --wrap='valgrind --leak-check=full'

the Python binding will trigger 'Invalid read of size 4' warnings.
Tell Python to use malloc directly for all memory allocation which can
be properly traced by valgrind.

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

tree: Fix memleaks in __nvme_free_ns() and nvme_scan_subsystem()

valgrind reports that we are leaking memory in __nvme_free_ns() and
nvme_scan_subsystem(). Free ns->generic_name and path which makes
valgrind also happy.

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

Merge pull request #230 from sc108-lee/fix/io_cmd

ioctl: nvme_io_args.dspec(Directive Specific) value is 16 bits

ioctl: nvme_io_args.dspec(Directive Specific) value is 16 bits

Command Dword 13 [31:16]

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

Merge pull request #229 from igaw/remove-jsonc-ifdefs

tree: Remove CONFIG_JSONC ifdefs

tree: Remove CONFIG_JSONC ifdefs

We have an hard dependency on json-c, so we can rely it's always
available. Remove old ifdefs for json-c.

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

Merge pull request #221 from hreinecke/dump-tree

tree: add nvme_dump_tree()

tree: add nvme_dump_tree()

Dump the internal tree in JSON format to stdout for debugging.

Signed-off-by: Hannes Reinecke <hare@suse.de>
[dwagner: dropped json wrapper definition usage]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #227 from igaw/cleanup-libuuid-dep

tree: Remove dead !LIBUUID code