tree: fixup crash on pcie controller for older kernels

Older kernels do not provide an 'address' sysfs entry for 'pcie'
controllers, causing a crash during scanning.

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

examples,test: depend on libnvme.a

When libnvme is changed we should be rebuilding the example and test
programs, too, to build them against the updated libnvme.

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

fix path->nentry bugs

The "path->nentry" is initialized after it is added to the list in
"nvme_subsystem_set_path_ns" function.

Signed-off-by: chengjike <chengjike.cheng@huawei.com>

Revert "tree: rework topology for multiple hosts"

The hosts check breaks pci

This reverts commit aad3881a446560e6add56202e8029183d5dd825d.

Link: https://github.com/linux-nvme/libnvme/issues/32
Signed-off-by: Keith Busch <kbusch@kernel.org>

Merge pull request #31 from martin-belanger/fix-compilation-warning

Allow control objects to be deleted.

Un-stub nvme_free_ctrl(). In other words, nvme_free_ctrl() will now properly delete ctrl objects

Merge pull request #30 from martin-belanger/fix-compilation-warning

Fix memory leaks and double free

Fix memory leaks and double free

Merge pull request #28 from hreinecke/topology

tree: rework topology for multiple hosts

Merge pull request #29 from martin-belanger/fix-compilation-warning

Fix compiler warning

Fix compiler warning

private.h: drop 'hostid' and 'hostnqn' from nvme_ctrl_t

Never referenced anywhere.

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

src/Makefile: fixup depencendy for private.h

The Makefile references 'private.h' as 'libnvme_priv', not
'libnvme_private'.

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

tree: rework topology for multiple hosts

Our tree structure host->subsys->ctrl doesn't match the underlying
topology; the subsystem actually just a container for controllers,
and the hosts are specified on the controller level, not the subsystem
level.
So to flatten that into our tree structure we need to duplicate the
subsystem objects for each host, and filter out the controllers such
that only the controllers with the correct hostnqn will show up
in our internal tree.

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

Merge pull request #27 from martin-belanger/fix-empty-model

Default empty model attribute to 'undefined'

Default empty model attribute to 'undefined'

Merge pull request #26 from hreinecke/discovery-fixes

Discovery fixes

tree.h: remove stale declaration of nvme_ctrl_get_nqn()

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

json: use nvme_msg() instead of fprintf()

Use nvme logging to make error output configurable.

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

tree: set errno in nvme_create_ctrl()

There is no reason why we shouldn't be setting errno in
nvme_create_ctrl(); in fact, doing so will help with debugging.

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

fabrics: add nvme_host_t as argument to build_options()

build_options() can be called when the controller hasn't been
instantiated; in that case the 'subsystem' link in the controller
is empty, and there is no host associated with it.
Rather than selecting the default nvme host (and thereby losing
any different hostnqn settings which might have passed in from
the commandline) we should be passing in the nvme host directly
as argument to build_options().

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

tree: avoid crash on unset subsystem in nvme_ctrl_get_host{nqn,id}

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

Merge pull request #15 from jk-ozlabs/fixes

Minor fixes for a couple of compilation failures

ioctl: Fix incorrect cdw initialisation in nvme_set_features

We're not currently setting cdw15 in nvme_set_features due to a typo in
the struct initialisation. This change fixes the init.

Signed-off-by: Jeremy Kerr <jk@ozlabs.org>

Build c++ objects with c++ compiler

We should use $(CXX) when building objects from .cc sources

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

Separate libs from link flags to fix link-order compile failure

Currently, builds fail for me with a link error:

  /usr/bin/ld: ../src//libnvme.a(tree.ol): in function `nvme_ns_get_uuid':
  src/nvme/tree.c:1321: undefined reference to `uuid_copy'
  /usr/bin/ld: ../src//libnvme.a(json.ol): in function `json_read_config':
  src/nvme/json.c:152: undefined reference to `json_object_from_file'

Turns out my linker ("GNU ld (GNU Binutils for Debian) 2.35.2") is
sensitive to object argument order - the dependent libs need to be listed
last.

This change splits the required libraries into a LIBS variable, used
last on the Makefile rules to perform the link.

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

Merge pull request #24 from tbzatek/docs-updates-2

types: Device self-test doc strings update

types: Device self-test doc strings update

Doc strings update related to the device self-test log page
retrieval and the self-test command issue.

API changes:
 * renamed NVME_ST_CODE_RESRVED -> NVME_ST_CODE_RESERVED
 * added enum nvme_st_curr_op definiton

Merge pull request #21 from martin-belanger/move-python-to-separate-dir

Move python bindings to a separate directory (pynvme)

Merge latest changes from master branch

Bug fix in Python SWIG module

Merge pull request #20 from tbzatek/json-c-build-fixes

build: Fix build without json-c

Merge pull request #19 from tbzatek/status-to-string

Add new status codes, add nvme_status_to_string()

build: Fix build without json-c

util: Add strings for new status codes

types: Add new status codes

Sync with nvme-cli master, doc strings updates.

util: Add nvme_status_to_string()

Taken from nvme-cli/libnvme-int-3.4.2021 branch,
commit 70b9835a9dace56557acc5ed10fd4c77ac063238.

add README file for python bindings

Move 'Python bindings' SWIG and Makefile to 'pynvme' directory

rename Python class names using SWIG's %rename

fix memory leak

Merge branch 'logging.v2' of https://github.com/hreinecke/libnvme

re-arm discovery AEN

Ensure that the discovery AEN is unmasked by clearing RAE on the last
read of the full discovery log page.

Link: https://github.com/linux-nvme/libnvme/issues/17
Signed-off-by: Keith Busch <kbusch@kernel.org>

fabrics: Remove trailing newline from debugging messages

The debugging messages in __nvmf_add_ctrl() contained newlines,
making for an improper formatted message.

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

Makefile: fix libnvme_wrap targets

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

tree: do not free 'path' in nvme_init_ctrl()

After nvme_configure_ctrl() completes successfully we must not
free the 'path' argument as control has been transferred to the
controller structure.

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

tree: implement nvme_deconfigure_ctrl()

Separate out nvme_deconfigure_ctrl() from nvme_disconnect_ctrl()
to make it symmetric with nvme_configure_ctrl().

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

tree: rename __nvme_init_ctrl() to nvme_configure_ctrl()

To clarify the intent on the function, and reduce confusion between
nvme_ctrl_init() and __nvme_init_ctrl().

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

tree: use 'stat' to lookup nvme controller

When looking up nvme subsystems for individual controllers we should
be using 'stat()' instead of 'opendir()'; this is less heavy-handed
and provides better error checking.

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

tree: add error logging when failing to lookup subsystem name

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

libnvme.i: add a 'log_level' function to nvme_root object

Add a 'log_level' function to the nvme_root object to allow to
increase the logging level of the libnvme library.

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

libnvme.i: display last error message on connect()

Instead of displaying just a generic 'connect failed' message
we should be using nvme_log_message to display the most recent
failure message to the user.

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

log: export last error message

Add a static string 'nvme_log_message' containing the last error
message written out by 'nvme_msg'.

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

Merge pull request #14 from hreinecke/realloc

Rework tree reallocation

tree: rework topology deallocation

The original idea of implementing a simple refcount doesn't really
work out, as refcounting is everything but.
And especially when used with the SWIG bindings it's not easy to
figure if and when a refcount needs to be released.
So kill the entire refcounting and free the internal structure
only when calling nvme_free_tree(); the object-dependent functions
like nvme_free_subsystem() etc now merely become stubs for
symmetry and to keep SWIG happy.
That removes the need for refcounting at all as the tree
and its contents will always be available, and a call to
nvme_free_tree() will clear the entire structure.

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

tree: initialize all lists

As otherwise python will crash horribly.

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

libnvme.i: decode discover log page entry fields

Decode the individual fields from the discover log page entry to
make the output usable for creating controllers.

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

Merge pull request #13 from hreinecke/swig.v3

SWIG Python bindings

tree: check hostnqn and hostid when scanning topology

Newer kernel versions will display the hostnqn and hostid in sysfs
attributes, so we should be using them to find the host structure
instead of the default host.

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

test/tree.py: add test script for the python binding

Add a simple test script for the python binding which just
prints out details about the NVMe subsystem.

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

examples/discover-loop.py: python example for nvme discovery

Add an example script on how nvme discovery can be done with
the libnvme python binding.

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

Add SWIG interface generator files

Add files to generate a python binding via SWIG.

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

tree: re-read 'state' attribute

The 'state' attribute might change at any time, so we need to update
it upon access.

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

tree: rename nvme_disconnect_ctrl()

Rename nvme_ctrl_disconnect() to nvme_disconnect_ctrl() to avoid
name clash with SWIG generated interface files.

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

tree: export nvme_free_subsystem()

Required for SWIG interface.

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

tree: export nvme_free_host()

Required for SWIG interface.

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

tree: add nvme_rescan_ctrl()

Add a function to rescan a controller eg after receiving an AEN.

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

tree: add refcounting for objects

Each object can be referenced multiple times, so add
reference counting for hosts, subsystems, and controllers.

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

tree: Move structures to private.h

Move generic structures to private.h to avoid having to duplicate
definitions in the SWIG interface file.

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

tree: move static declarations into private header file

Static directory declarations are not part of the libnvme API, so
move them into the private header file.

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

tree: controller subsystem pointer might be NULL

The subsystem pointer 's' in the controller structure might be
NULL, as the controller is only associated with a subsystem once
nvmf_add_ctrl() has been called.

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

tree: error checking in nvme_init_ctrl()

nvme_init_ctrl() is called to initialize a controller after a
'connect' call. As this might fail for a variety of reasons we
need to ensure to change the controller state if we need to
return an error; this ensures that we can repeat a call to
nvme_init_ctrl() after the error causing the failure has been
resolved.

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

tree: initialize subsystem in nvme_init_ctrl()

nvme_init_ctrl() might be called from a nvme_ctrl with no
subsystem set (eg after a connect call). So ensure to
re-scan the subsystem to have it fully initialized.

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

tree: error checking in nvme_ns_init()

The call to 'nvme_ns_identify()' in nvme_ns_init() might fail,
leading to a largely unusable namespace. So not continue here, but
rather fail the call to nvme_ns_open().

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

Merge pull request #12 from birkelund/fix

nvme/fabrics: fix compile error

nvme/fabrics: fix compile error

Fix string formatting of the uuid from systemd.

Fixes: 8999e3d9b218 ("fabrics: Read system UUID from DMI and merge hostnqn generation functions")
Signed-off-by: Klaus Jensen <k.jensen@samsung.com>

Merge pull request #11 from hreinecke/int-fixes

fabrics,tree: Fixes for PCIe devices

fabrics,tree: Fixes for PCIe devices

PCIe devices do not necessarily have a hostnqn set, so use the
default hostnqn when looking up hosts.
And for PCIe devices the transport address is the entire 'address'
string, no parsing required.

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

Merge pull request #10 from hreinecke/nvme-cli

Preparation for nvme-cli integration

tree,fabrics: add 'host_iface' controller option

Add a 'host_iface' controller option.

Ported from nvme-cli.

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

fabrics: add fast_io_fail_tmo option

Option to fail fast I/O when connecting to a controller. It is useful
to set a fast-fail timeout for nvme in case upper layer SW wants to
detect unresponsive controllers early (e.g. mdraid).

Ported from nvme-cli.

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

fabrics: blank out invalid arguments in build_options()

Not all options are valid under all circumstances; eg for
discovery some options like 'nr_io_queues' are invalid.
So mask out invalid options to avoid a failure when creating
a controller.

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

tree: argument checking for nvme_create_ctrl()

Add argument checking for nvme_create_ctrl() to ensure the controller
values are correct and avoid failures later on in nvme_add_ctrl().

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

Add logging functionality to libnvme

Port the logging functionality from nvme-cli to libnvme and
replace the 'verbose' option.

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

ioctl: add 'nsid' parameter to nvme_identify_secondary_ctrl_list()

nvme_identify_secondary_ctrl_list() can relate to specific nsids,
so allow the nsid parameter to be settable.

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

ioctl: add definitions for Namespace Write Protect Feature

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

fabrics: Read system UUID from DMI and merge hostnqn generation functions

Ported from nvme-cli.

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

types: add NVME_LOG_LPO_NONE

Add additional log page definition.

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

Merge pull request #9 from birkelund/fixes

Typo fix

Typo fix

Fix a small typo.

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

Merge pull request #7 from hreinecke/topology.v2

Per-controller configuration support

tree: move config_file argument into nvme_root

Store the config file in the nvme_root structure; that allows us
to call nvme_update_config() without having to specify the
configuration file.

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

tree: add 'nvme_update_config()' as API function

Add a function nvme_update_config() to write out the configuration
as an JSON file.

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

JSON configuration file handling

Add functions 'json_read_config()' and 'json_update_config()' to
read and write configuration informations from or to a JSON file.

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

fabrics: 'tos' is invalid for loop

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

tree: implement nvme_ctrl_is_persistent()

Move the 'persistent' argument into the controller configuration.

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

fabrics: add 'verbose' option

Add a 'verbose' option to print out logging messages during
discovery.

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

tree,fabrics: detect discovery loops

Add an attribute 'discovered' to the controller configuration to
identify discovery referral loops; if the controller is already
discovered we'll skip it for subsequent discovery commands.

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

tree,fabrics: per-controller configuration

Make the fabrics configuration settings per-controller and implement
nvme_ctrl_disable_sqflow().

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

tree,fabrics: use topology information for discovery

Implement a topology tree containing all hosts, subsystems, and
controllers in the system, and use that information during
discovery.

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