build: use latest container instead fixed version

We control the build containers so there is little risk
that these randomly break. So let's go with the latest
version and avoid updating the build files all the time.

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

build: run tests before coverage tool

Obviously, we need to run the tests before the coverage tool.

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

build: fix coverage report build

We need to run the build first, before we can run the coverage tool.

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

build: checkout repo in coverage build

The previous commit removed accidentally the checkout step.
Add it back.

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

build: use container for coverage build

The coverage build also fails due missing dependency in
install step. Let's use a prebuild container here as well.

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

build: use debian container for release-python build

The build keeps failing because the dependencies can't be installed.
Let's use the prebuild container for this as well.

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

build: use prebuild container images for cross builds

The cross tool installation is breaking very often. Let's use a prebuild
container for this.

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

test: fix lookup test case

The tcp lookup test is not correct. The trsvcid is mandatory and thus we
have only to try to lookup all combination of host_traddr and host_iface.

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

test: make all function static

No need to export local functions.

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

test: add tests for new tcp controller matching algorithm

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

tree: Improve TCP controller matching algorithm

The configuration parameters used to connect to a TCP controller are:

1. transport - "tcp"
2. traddr - Destination address (controller's IP address)
3. trsvcid - Service ID (controller's port - typically 8009 or 4420)
4. host-traddr - Source address (host's IP address)
5. host-iface - Physical/Logical interface where the connection will be made

For TCP, transport, traddr, and trsvcid are mandatory, while the
host-traddr and host-iface are optional. The host-traddr and host-iface
can be used as "overrides" to select a different source address and
interface than those that the kernel would choose by default.

When an application using libnvme to connect to a controller does
not specify the host-traddr or host-iface, the kernel will have to
determine the best interface and source address by itself. It does that
by looking up the destination address (traddr) in the routing table to
determine the best interface for the connection. The kernel then
retrieves the primary IP address assigned to that interface and uses that
as the connection's source address. By default, the kernel always uses
the interface's primary address as the connection's source address
unless host-traddr is used to override it.

Prior to version 6.1, the kernel did not reveal the source address or
interface it selected. Therefore, it was impossible for user-space apps
to tell exactly where connections were made. With kernel 6.1 (and later),
the sysfs now exposes the source address as "src_addr=" in the nvme
"address" attribute. The src_addr not only provides us with the
connection's source address, but by scanning the interface map one can
find out which interface owns that source address and precisely determine
on which interface each connection is made.

With TP8010 and the introduction of the Centralized Discovery Controller
(CDC), it is very important for hosts to connect to CDCs with a consistent
source address. That's because of the way the CDC keeps track of all the
hosts that connect to it. In addition to the host NQN, the CDC also checks
the host IP address (the connection's source address) to uniquely identify
a host. This unique identifier is then used for fabric zoning.

With fabric zoning, administrators configure the list of I/O controllers
that a host is allowed to connect to. The CDC sends the list of I/O
controllers to the host in response to a Get Discovery Log Page (DLP)
command from the host. If a host does not connect to the CDC with the
right source address, it will receive invalid DLP entries (wrong zone).
This will cause the host to connect to the wrong I/O controllers.

libnvme tries to avoid making duplicate connections to the same
controller. This avoids consuming precious kernel resources. When an
application requests libnvme to connect to a controller (the candidate
controller), libnvme scans the sysfs to see if an existing connection
matches the candidate. If a matching connection is found, libnvme just
reuses it instead of creating a new one.

Matching the 3 mandatory parameters (transport, traddr, trsvcid) between
existing connections and a candidate connection is easy because they can
never be NULL and can therefore be compared. It is not the case for the
host-traddr and host-iface. These optional parameters can be NULL. A NULL
host-traddr or host-iface means that we have left it to the kernel to
determine the interface and source address to use for the connection.
Therefore, if we want to compare a non-NULL candidate host-traddr to
an existing connection with a NULL host-traddr, we cannot just compare the
two. They will obviously be different. Instead, we need to check the
src_addr of the existing connection to see if it matches the candidate's
host-traddr.

Prior to this patch, libnvme performed a simple string comparison
between the candidate's host-traddr (or host-iface) and the existing
connection's host-traddr (or host-iface). A match would be declared if
both were the same (including both NULL). Also, a match would even be
declared if the existing connection's host-traddr (or host-iface) was
NULL while the candidate's host-traddr (or host-iface) was non-NULL.
This is wrong and can lead to the wrong connections being reused and
the wrong DLP entries returned by the CDC.

With this patch, when a candidate wants a specific source address
(host-traddr != NULL) or interface (host-iface != NULL), libnvme will
now check the src_addr of each existing connection to ensure a 100%
match. If the src_addr is not available (kernel older than 6.1), then we
can still infer the real interface and source address of an existing
connection, if the existing connection has either its host-traddr or
host-iface defined (check code to see how it's done).

It's only when an exsiting connection's src_addr, host-iface, and
host-traddr are all NULL that we cannot clearly match to a candidate.
When that happens, libnvme will take an optimistic approach and
declare a match even though it doesn't have enough info to do so.
This "optimistic match" follows what libnvme was doing prior to this
patch.

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

util: Add functions to parse the system's interfaces

1) nvme_iface_matching_addr() identifies which interface owns a
specific IP address.

2) nvme_iface_primary_addr_matches() checks that the primary IP
address of a given interface matches a specific IP address.

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

types: Add support for EGFEAT, Domain Identifier, TEGCAP and UEGCAP

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

mi: remove nsid from nvme_mi_admin_identify_secondary_ctrl_list()

According to the NVMe specification, Identify CNS value 15h
("Secondary Controller list of controllers associated with the primary
controller processing the command") does not use the NSID field. So
remove the "nsid" argument from
nvme_mi_admin_identify_secondary_ctrl_list().

Fixes: 07b63103878 ("ioctl: remove nsid from nvme_identify_secondary_ctrl_list()")
Signed-off-by: Daniel Wagner <dwagner@suse.de>

test: add tests for nvme_ctrl_get_src_addr()

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

tree: Add nvme_ctrl_get_src_addr() to get the controller's src_addr

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

util: Split _nvme_ipaddrs_eq() from nvme_ipaddrs_eq()

Extract the core algorithm from nvme_ipaddrs_eq() and create
a reusable function _nvme_ipaddrs_eq().

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

test: add tests for Identify functions

Use the mock ioctl() infrastructure to test  the functions in ioctl.h
that issue Identify commands.
nvme_identify_ns_csi_user_data_format() and
nvme_identify_iocs_ns_csi_user_data_format() are omitted
since they're not defined in the NVMe specification yet
Functions tested indirectly from other functions are also omitted.

Signed-off-by: Caleb Sander <csander@purestorage.com>

ioctl: use available Identify helper functions

nvme_identify_independent_identify_ns() only specifies a CNS and a NSID,
so have it just call nvme_identify_cns_nsid()
instead of duplicating most of its implementation.
Similarly, nvme_zns_identify_ns() is just nvme_identify_ns_csi()
with the CSI set to ZNS and no UUID index.

Signed-off-by: Caleb Sander <csander@purestorage.com>

test: pass a large enough buffer to nvme_identify_ns_descs()

nvme_identify_ns_descs() takes a struct nvme_ns_id_desc * parameter,
but passes it as the data to nvme_identify(), which sets data_len = 4K.
But struct nvme_ns_id_desc only represents the start of a single
Namespace Identification Descriptor, so it is less than 4 KB.
So it needs to be explicitly allocated with at least 4 KB.
Allocate a 4 KB buffer in test.c to avoid a stack buffer overflow.

Signed-off-by: Caleb Sander <csander@purestorage.com>

ioctl: remove nsid from nvme_identify_secondary_ctrl_list()

According to the NVMe specification, Identify CNS value 15h
("Secondary Controller list of controllers associated with
the primary controller processing the command")
does not use the NSID field.
So remove the "nsid" argument from nvme_identify_secondary_ctrl_list().

Signed-off-by: Caleb Sander <csander@purestorage.com>

build: clean up version script

Remove symbols from libnvme.map that don't exist in libnvme.so.
These are a mix of static inline functions,
static (unexported) functions, nonexistent functions, and types.
Also remove a couple of duplicate symbols.

Bash script to find unexported symbols:
for symbol in `grep -o nvm[ef]_[a-z0-9_]* src/libnvme.map`
do
    if nm -D .build/src/libnvme.so | grep $symbol$ > /dev/null
    then
        true
    else
        echo $symbol
    fi
done

Bash command to find duplicated symbols:
grep nvm src/libnvme.map | uniq -c | grep -v '^\s*1 '

Signed-off-by: Caleb Sander <csander@purestorage.com>

meson: Don't hard-code path to "internal/config.h"

When building libnvme as a subproject of another project
(e.g. nvme-stas), the hard-coded absolute path to config.h, i.e.
"-include internal/config.h" does not resolve properly and fails
to build. Instead, use the real path calculated by meson and
saved to variable "config_h".

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

fabrics: Do not pass disable_sqflow if not supported

Do not try to use disable_sqflow if the kernel actually supports this
option.

Reported-by: Sagi Grimberg <sagi@grimberg.me>
Signed-off-by: Daniel Wagner <dwagner@suse.de>
Reviewed-by: Chaitanya Kulkarni <kch@nvidia.com>

fabrics: Read the supported options lazy

Read the options in when we need the for the first time.

Reported-by: Sagi Grimberg <sagi@grimberg.me>
Signed-off-by: Daniel Wagner <dwagner@suse.de>
Reviewed-by: Chaitanya Kulkarni <kch@nvidia.com>

test: add discovery log page tests

Add unit tests for nvmf_get_discovery_log().
They provide coverage of the logic in nvme_discovery_log(),
nvme_get_log_page(), and nvme_get_log() too.
The tests use the mock ioctl() infra to validate the Get Log Page
commands issued and inject responses triggering different code paths.

Signed-off-by: Caleb Sander <csander@purestorage.com>

test: add infra for mocking passthru ioctls

Functions issuing admin/IO passthru ioctls sorely lack unit tests.
It would be great for unit tests not to need a real NVMe controller.
It's also useful to be able to test responses to commands
that might be impossible to trigger with real controllers.

To that end, implement infrastructure for mocking ioctl(),
allowing tests to set expectations for the NVMe passthru ioctls
that will be issued and control the corresponding responses.

The mock library can be used with LD_PRELOAD so that libnvme's ioctl()
calls are redirected from libc. No changes in libnvme itself are needed.

Signed-off-by: Caleb Sander <csander@purestorage.com>

tree: fix segfault in nvme_scan_subsystem()

The wrong nvme_subsystem struct was being passed to
__nvme_subsystem_scan() which caused it to segfault.
Fix it.

Fixes: d08fd10 ("make __nvme_scan_subsystem() returning bool")
Signed-off-by: Martin George <marting@netapp.com>

src/nvme/tree.c: make __nvme_scan_subsystem() returning bool

__nvme_scan_subsystem() will free the 's' argument when the filter
triggers, so it needs a return value to inform the caller that the
argument has been freed.

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

doc: fix minor mistake in README.md about dependencies

OpenSSL is used for TLS over TCP whereas Keyutils is used for
authentication.

Also fix spelling mistake: dependend -> dependent.

Signed-off-by: Christophe Vu-Brugier <cvubrugier@fastmail.fm>

nvme-tree: avoid warning in 'list-subsys'

With the recent change to scan all subsystems, 'nvme list-subsys
/dev/nvmeXnY' now displays an annoying warning for the NQN mismatch
for all other subsystems that don't match during the subsystem
scan. For e.g.

NQN mismatch for subsystem 'nvme-subsys1'
NQN mismatch for subsystem 'nvme-subsys4'
nvme-subsys3 - NQN=nqn.1992-08.com.netapp:sn.48391d66c0a611ecaaa5d039ea165514:subsystem.subsys_CLIENT116_1
               hostnqn=nqn.2014-08.org.nvmexpress:uuid:e6550026-173e-4959-ba74-be367844bd8a
\
 +- nvme3 tcp traddr=192.168.1.116,trsvcid=4420,host_traddr=192.168.1.16,host_iface=eth5 live optimized
 +- nvme7 tcp traddr=192.168.2.116,trsvcid=4420,host_traddr=192.168.2.16 live optimized
 +- nvme8 tcp traddr=192.168.1.116,trsvcid=4420,host_traddr=192.168.2.16 live optimized

Avoid this warning by displaying it only under debug level.

Fixes: fbd45f1 ("tree: Scan all subsystems")
Signed-off-by: Martin George <marting@netapp.com>

tree: Add getter for subsystem iopolicy

Allow to retrieve the iopolicy settings for the subsystem.

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

fabrics: Consider also all hosts settings for context match

It's not enough to iterate over all subsystem of one host. We need to
iterate over all hosts as well to find a match.

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

tree: Scan all subsystems

We need to scan all subsystems because a subsystem might show up on
different hosts, e.g 'nvme connect' with different hostnqn and the
target reports the same namespace.

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

doc: Fixing compile instruction in README

Update the instruction how to build with meson.

mi: allow non-4-byte-aligned responses

We currently assume that a MI response will be a multiple of four bytes
in length. However, this may not be the case: for example, a Read MI
Data (Controller List) with an even number of controllers, and with an
unpadded response, may only be aligned on a two-byte boundary.

The NVMe-MI spec states, for the MIC field:

    This field is byte aligned.

So, relax the requirement for alignment on the response sizes, and the
expected response size values. We only do this for the mi commands; the
Admin commands still require an aligned value for DLEN.

In doing so, drop the explicit alignment tests, and add a couple that
check that the Controller List example above will work.

Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>
Reported-by: Klaus Jensen <its@irrelevant.dk>

mi-mctp: use a linear response buffer

Currently, we're passing a 3-entry iovec to the MCTP resvmsg()
interface:

 - header
 - payload
 - MIC

This is fine if the response comes back eaxctly the size we expect, but
causes complexity if we get a smaller response (for example, as an error
or a More Processing Required response), as we need to extract the MIC
from somewhere in those buffers.

At the moment, since we're enforcing 4-byte alignment, that isn't too
complex - we know the MIC will be entirely in one of the buffers. The
MPR code is a bit awkward, but still manageable.

However: we now want to allow unaligned responses from MI messages,
which is about to make that a lot more complex; in the worst case, the
MIC could be split over all three buffers!

This change uses a fixed linear buffer for the MCTP response instead. We
allocate 4k for this by default, but expand if necessary. We use this as
the sendmsg() buffer, so get a linear message back from the MCTP
endpoint. Once we have verified the format (and extracted the MIC), we
copy this into the actual response header/payload buffers as required.

This makes the response handing code simpler, at the cost of one extra
response buffer per endpoint.

Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>

mi: implement length and offset alignment checks in admin_xfer()

We're about to relax some alignment requirements in the generic
(internal) nvme_mi_submit function. To ensure that the raw admin
interface continues to enfore the required alignment on DOFST and DLEN
fields, implement checks in the Admin command interface.

Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>

tree: Don't open nvme devices until it's absolutely required

Don't open nvme devices while scanning the tree. Only open devices
when we actually need to write commands to them.

This patch also provides functions to close fds when a user no
longer needs them to be open.

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

tree: missing closedir() causes fd leak for "/sys/bus/pci/slots"

In nvme_ctrl_lookup_phy_slot(), we are missing a closedir(), which
causes file descriptors to leak. Also, there was a missing free()
when the function returns with ENOMEM.

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

mi: don't return from mi_mctp_submit with a tag held

If the poll() times-out or fails, we'll exit early from
nvme_mi_mctp_submit still holding the tag reservation. When using an i2c
transport, this may mean we hold a lock on the i2c bus with no way to
release.

Instead, always drop the tag on function exit.

Fixes: 6a08780 ("mi-mctp: Add timeout support to MCTP transport")
Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>

doc: Regenerate all docs for v1.5

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

build: Update version to v1.5

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

build: Update cross instruction and drop verbose test flag

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

build: Use containers with matrix build

Use a matrix build approach and a base container which already contains
all the libraries installed.

util: Provide empty nvme_ipaddrs_eq for static builds

Static builds can't use netdb functions, they are only available when
linking dynamically against glibc.

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

scripts: Use spaces instead of tabs

The build.sh file contains a mix of tabs and spaces, just use spaces
consistently.

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

build: Move CI build steps into a scripts

Move the build instruction into a script. This allows to run these steps
also locally.

Also disable the fallback static library build as it is clearly not
working because in the dependencies rely to link against a dynamic
glibc. Instead just add a minimal static build without fallbacks.

While we are at it, also add a debug clang build.

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

scripts: Sync release script

Sync with the nvme-cli release script.

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

scripts: Call update doc script from top level dir

Make sure that the script runs from the lop level dir.

While at it also properly quote variables to make shellcheck happy.

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

scripts: Move helper scripts to a central place

The helper scripts for maintaining are distributed over several
directories. Let's move them to the scripts directory.

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

fabrics: Relax match on well known disc ctrl lookup

In case nvmf_add_ctrl() is called to add a well known discovery
controller we also need to verify if we should ignore it (see --context
command line argument of nvme-cli). Though we have to be careful not to
overmatch on the lookup.

That means the host_traddr and host_iface might be different for the
discovery controller than the normal controllers. For example this can
happen when the discovery controller is reached via different interface
than the data controllers.

Thus only consider the transport type, target address and trsvcid only
when looking up well known discovery controllers.

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

tree: Ignore NULL address pointer for phy slot lookup

The PCI physical slot lookup works obviously only for physical cards.
Thus do not try to dereference the address pointer if it is a NULL
pointer.

Fixes: 42ac45359635 ("tree: Add PCI physical slot number for controller")
Signed-off-by: Daniel Wagner <dwagner@suse.de>

fabrics: Filter discovery ctrls out during application context check

We also need to filter out the well known discovery controllers when
using the execution context filtering. Obviously, we can't use the
subsystem name, thus match on the host and target address instead.

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

util: Add ignored error code

When libnvme ignores a connection attempt via the 'application' context
tracking return an unique error code to allow proper filtering on the
caller side.

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

json: Use memory block allocated by realloc() instead printbuf

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

util: Use HAVE_NETDB instead of HAVE_LIBNSS

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

tree: Add PCI physical slot number for controller

This commit introduces a physical slot field for controller, that
contains the PCI physcial slot number for controller device.

In case, there are multiple NVME drives present on the platform,
it's hard to identify which NVME drive is present in which slot.
The slot number is usually helpful in determining the location.
It is cross reference-able from lspci, but it would be nice to
have a direct option.

Signed-off-by: Umer Saleem <usaleem@ixsystems.com>

tree: Use nvme_ipaddrs_eq() to compare IP addresses

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

fabrics: Add EADDRNOTAVAIL error mapping

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

fabrics: filter out subsystems with non-matching application string

If the nvme root has an application string set any subsystem lookup
should ignore subsystems which either have no application string set
or which have a non-matching application string.

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

libnvme: add 'application' setting to nvme_root

Add an 'application' string to the tree root to indicate which
application manages this configuration.

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

libnvme: add 'application' setting to the subsystem

Add an 'application' string to the subsystem to indicate which
application should manage this particular subsystem.

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

test: Add more code coverage for nvme_ipaddrs_eq()

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

util: rename ipaddrs_eq() to nvme_ipaddrs_eq() and make public.

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

util: Add ipaddrs_eq() to check whether two IP addresses are equal

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

examples: Fix wrong indentation in discover-loop.py

Running `examples/discover-loop.py` fails:

```
  File "examples/discover-loop.py", line 59
    c.disconnect()
    ^
IndentationError: expected an indented block after 'try' statement on line 58
```

Signed-off-by: Benjamin Drung <benjamin.drung@canonical.com>

test: Add unit test for ctrl lookups

Add a simple unit test which tests the ctrl lookup logic.

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

build: Install missing s390 library

libjson-c-dev:s390x depends on the libgcc-s1 library.

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

ioctl: fix RAE bit on last Get Log Page command

If nvme_get_log_page() requires multiple Get Log Page commands
because the total log length exceeds the transfer length,
args->rae is overwritten, causing the RAE bit to be set in all commands.
Retrieve the value of args->rae before overwriting it
so the RAE bit is set as requested in the last command.

Fixes: c23dbd4 ("linux: Change nvme_get_log_page to use nvme_get_log_args parm")
Signed-off-by: Caleb Sander <csander@purestorage.com>

fabrics: check genctr after getting discovery entries

From the NVMe base spec (version 2.0c, section 5.16.1.23):
If the host reads the Discovery Log Page using multiple Get Log Page
commands the host should ensure that there has not been a change in the
contents of the data. The host should read the Discovery Log Page
contents in order (i.e., with increasing Log Page Offset values) and
then re-read the Generation Counter after the entire log page is
transferred. If the Generation Counter does not match the original value
read, the host should discard the log page read as the entries may be
inconsistent.

nvme_get_log_page() will issue multiple Get Log Page commands
to fetch the discovery log page if it exceeds 4 KB.
Since GENCTR is at the start of the log page, this ordering is possible:
- GENCTR is read by a Get Log Page command for the first 4 KB
- The log page is modified, changing GENCTR
- Other Get Log Page commands read the remainder of the log page
So the check that GENCTR hasn't changed will incorrectly pass,
despite the log page having been modified.
This can lead to inconsistent, missing, or duplicate log page entries.

Ensure a GENCTR update is not missed
by fetching log page header again after all entries.

Also use NVME_LOG_PAGE_PDU_SIZE to match other nvme_get_log_page() calls
instead of hard-coding the 4 KB max transfer length.
And ensure LPO is correctly reset if the log page is read again.

Signed-off-by: Caleb Sander <csander@purestorage.com>

fabrics: handle /dev/nvme-fabrics read failure

The ability to read from /dev/nvme-fabrics to find supported options
is a newer Linux kernel feature added in f18ee3d988157 (5.17-rc1).
On earlier kernels, this read returns EINVAL,
preventing the controller from being added:
$ nvme discover --transport tcp --traddr 192.168.1.62
Failed to read from /dev/nvme-fabrics: Invalid argument
failed to add controller, error Invalid argument

So don't treat EINVAL as a fatal error, and instead fall back
to a default set of supported options.
With this change, controllers can be created successfully:
$ nvme discover --transport tcp --traddr 192.168.1.62

Discovery Log Number of Records 4, Generation counter 125
...

Fixes: d123131f2e ("fabrics: Do not pass unsupported options to kernel")
Signed-off-by: Caleb Sander <csander@purestorage.com>

fabrics: fix potential invalid memory access in __nvmf_supported_option()

In __nvmf_supported_option(), len is declared as size_t (unsigned)

"len = read()" may return a negative number;
the check "if (len < 0)" will always be false and therefore
"buf[len]" will dereference an invalid memory address.

len should be declared as a signed size_t (ssize_t)

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

Python: Fix crash during garbage collection

Same fix as commit d2a5491d1681ead6d8983d0bf6ecae937ab9f317

Prevent Garbage Collector (GC) from deleting host and root objects
before all controller objects under that root/host have been GCed.
This time, it's the init() method that needed the fix. Previously
we had only fixed the connect() method.

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

python/swig: Check swig version to determine whether -py3 is needed

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

python/swig: Wrap swig-sensitive struct inside #ifwdef SWIG

To suppress the warnings generated by swig when parsing anonymous
struct/union, we simply wrap the offending struct/union in a
"#ifndef SWIG" statement. This is an acceptable workaround because
we don't need to generate Python bindings for these structs. In
fact, we specifically tell swig to not generate wrappers for all
structs in types.h. Although swig does not generate wrappers for
those structs, it still warns when a struct doesn't have a name
and therefore we need to use this workaround.

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

mi: Add nvme_mi_ctrl_id to retrieve controller ID

Controllers may be scanned through nvme_mi_scan_ep, in which case the
caller will not have access to the underlying controller IDs.

Add an accessor function to retrieve the controller ID for use in
subsequent commands (like namespace attach).

Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>

Python: Suppress swig warnings about unnamed struct

Ref: https://github.com/linux-nvme/libnvme/issues/634

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

examples: fix incorrect controller status in MI info output

In the mi-mctp example, we're incorrectly reporting the percent drive
life used as the controller status. Fix the controller status output
to use the correct (ccs) field.

Signed-off-by: Lior Weintraub <liorw@pliops.com>
Reviewed-by: Jeremy Kerr <jk@codeconstruct.com.au>

ioctl: Explicitly initialize all members of struct nvme_ns_mgmt_args

Older compilers complain with:

../src/nvme/ioctl.h:3063:2: sorry, unimplemented: non-trivial designated initializers not supported

Thus explicitly initialize all members of this data structure.

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

Python: make NBFT data more pythonic

I made the nfollowing changes so that the data is more Pythonic.

1) For boolean values, set them to True/False instead of 1/0.

2) NBFT data contains ordered lists. In the raw NBFT data the
position of each element in the list is indicated by a 1-based
index. When converting to Python lists, make sure that each
element is inserted in the list at the right position. This is
done by converting the 1-based index to a 0-based index.

3) For objects that contain index variables that refer to items in
a list, make sure to convert the 1-based index to 0-based so that
it can be used directly to access the python lists (e.g. list[index]).

4) Since Python lists are ordered (per 2 above), there is no
need to keep an explicit 1-based index in each of the list items.
Therefore those 1-based indexes were removed.

5) No need to keep explicit variables representing the length of
a list. In Python one need only use len(list) to get the length.

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

ioctl: io management send, receive args fix

TP4146 Flexible Data Placement 2022.11.30 Ratified
Command Dword 10
Bits[31:16] : Management Operation Specific (MOS)
Bits[07:00] : Management Operation (MO)
Signed-off-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

python: Update test data

Since commit 1617d1a3f42a ("nbft: Parse the {HOSTID,HOSTNQN}_CONFIGURED
flags") host_id_configured and host_nqn_configured are parsed. Thus we
need to update the test case accordingly.

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

NBFT: Remove documentation from nbft.c since it's also in nbft.h

Also, replace nbft_free() by nvme_nbft_free() in documentation
found in nbft.h.

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

Python: Add NBFT support

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

nbft: Doc typo - Use nvme_nbft_free() instead of nbft_free()

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

nbft: Parse the {HOSTID,HOSTNQN}_CONFIGURED flags

nbft: Fix nbft_ssns_flags endianness test

Missing flags endianness conversion leading to ssns_ext_info
not being parsed on s390x and armhf.

nbft: Add a simple unit test

A simple table dump utility, a set of real ACPI NBFT table files
and corresponding set of reference dumps, compared against each
other as part of the meson test run.

Please check the README file for details.

Signed-off-by: Tomas Bzatek <tbzatek@redhat.com>

doc: Update README

Extend the documentation on the build process.

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

build: Simple muon build configuration

The auto detection takes care to disable all dependencies. Thus we
should actually test this by explicitly disabling this part.

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

build: Extend summary section

List also the dependencies in the summary.

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

build: Make json-c dependency lookup not fail

Let's relax the dependency on json-c, when the command list option is set
to auto. It will just ignore the dependency if not found

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

nbft: Move added symbols to LIBNVME_1_5

build: Update wrap mode defaults

We switched the default of the wrap mode to nofallback. Update the CI
builds accordingly.

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

build: Disable fallback on default

meson's default setting for wrap mode is to attempt to download missing
dependencies. Disable this feature as the community is unhappy with
this default behavior.

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

tree: Fix offset argument check in nvme_bytes_to_lba

Also offset modulo blocksize needs to be 0. Commit 01c6055e5602 ("tree:
Fix argument check in nvme_bytes_to_lba") missed to update this, thus do
it now.

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

nbft: add NBFT v1.0 table support

Added support for parsing and printing the contents
of the NBFT table (per NVMe-oF boot specification v1.0).

Signed-off-by: Stuart Hayes <stuart_hayes@dell.com>
Signed-off-by: Martin Belanger <martin.belanger@dell.com>
Signed-off-by: Martin Wilck <mwilck@suse.com>
Signed-off-by: Tomas Bzatek <tbzatek@redhat.com>
Signed-off-by: John Meneghini <jmeneghi@redhat.com>

types: Add IO command set specific field on nsmgmt

nvme_ns_mgmt_host_sw_specified_zns from TP4115 ZNS Namespace Management Enhancements 2022.03.15 Ratified

Reviewed-by: Daniel Wagner <dwagner@suse.de>
Signed-off-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

fabrics: Do not pass unsupported options to kernel

The kernel API might not support all options libnvme is supporting.
Filter out all options which the kernel doesn't support.

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