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

tree: Remove dead !LIBUUID code

We have added a hard dependency to libuuid. Remove the ifdefs and the
dead code.

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

Merge pull request #226 from linux-nvme/kernel-doc-ci

build: Add kernel-doc CI build

build: Add kernel-doc CI build

We want to catching documentation failures early. Let's add a
dedicated documentation CI build. To keep build times low just
shortcut here and do not call meson to build the complete
documentation.

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

Merge pull request #213 from jeffreyalien/telemetry-da4-2

[libnvme] Add Support for Telemetry Log Page Data Area 4

linux: Add size and data area parm to nvme_get_telemetry_log

This is necessary to support the retrieval of data area 4.

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

Merge pull request #223 from hreinecke/json-mandatory

Make JSON-C mandatory

Merge pull request #225 from igaw/fail-on-warnings

build: Make CI build fail on warnings

build: Make CI build fail on warnings

Currently, warnings are hidden in the logs and the build is marked as
succeeded. Mark all warnings as error so that we see them show up in
the review process.

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

Merge pull request #222 from igaw/mesonize-doc

doc: Mesonize documentation generation

doc: Regenerate all documentation

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

doc: Fix sphinx setup

sphinx warns about cyclic refernce. Do not include the index into the
index file.

Also add the build dir and index.rst to the ignore list. This avoids
another type of warnings.

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

doc: Mesonize documentation generation

Introduce a new config flag -Ddocs-build=true which controls if the
build system should generate documentation or not. If disabled but
-Ddocs=man is used then the pre compiled documentation will be
installed.

Furthmore, we are hooking up the sphinx tooling so that we generate
the HTML documentation ouf of the rst files.

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

types: Fix doc description

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

tree: Remove doublicated declaration

nvme_host_get_hostnqn() and nvme_host_get_hostid() are declared
twice. Remove one.

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

doc: Remove unused make.bat file

The file was added by the initial doc experiment commit. It's not
used. Remove it.

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

Merge pull request #166 from sc108-lee/for-upstream/tp4095

For upstream/tp4095

nvme: get log domain id included in Log Specific Identifier

domid was not used in nvme_get_log as well

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

nvme: Add nulbaf(Number of Unique Capability LBA Formats) field on nvmd_id_ns

Add explaination for mssrl, mcl, src
Based on spec NVMe - TP 4095 Namespace Capability Reporting 2021.06.28 - Ratified

ioctl: Add identify ioctl for CNS 09h, 0Ah

09h - Identify Namespace data structure for the specified
      User Data Format index containing the namespace capabilities
      for the NVM Command Set.
0Ah - I/O Command Set specific Identify Namespace data structure
      for the specified User Data Format index containing
      the namespace capabilities for the I/O Command Set
      specified in the CSI field.

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

types: Add NVM Command Set id-ns structure

Add uuid index argument on nvme_identify_ns_csi

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

ioctl: Modify identify command argument based on spec

CNS Specific identifier presents all names below for DWORD11 bits [15:00]
    NVM Set Identifier(NVM Set List (04h))
    Domain Identifier(Domain List (18h))
    Endurance Group Identifier(Endurance Group List (19h))

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

Merge pull request #224 from Arunpandian15/Enhanced_ctrl_MD

nvme: Add Enhanced Controller Meta Data(FID: 0x7D)

nvme: Add Enhanced Controller Meta Data(FID: 0x7D)

Reviewed-by: Steven Seungcheol Lee <sc108.lee@samsung.com>
Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Make JSON-C mandatory during built

We already have a JSON-C subproject, so we can make it mandatory
during build anyway.

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

json: remove wrapper definitions

Switch to JSON-C API.

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

tree: do not print function twice

nvme_msg() already prints out the function name, no need to specify
it in the message itself.

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

Merge pull request #199 from Arunpandian15/Supported_Cap_Config_List_Log_Page

nvme: Add Supported Capacity Configuration List log page(LID: 0x11)

nvme: Add Supported Capacity Configuration List log page(LID: 0x11)

Reviewed-by: Steven Seungcheol Lee <sc108.lee@samsung.com>
Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #220 from hreinecke/dhchap-fix

tree: do not set dhchap_key to 'none'

tree: do not set dhchap_key to 'none'

When no dhchap key is set the kernel will set the sysfs attribute
to 'none'. And we shouldn't display this value in our internal tree
as it really means 'not set'.

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

Merge pull request #211 from hreinecke/config-errors

Return json parsing errors

Merge pull request #219 from hreinecke/lookup-restart

Restart controller lookup

tree: loop address may be NULL

Return an empty string in nvme_ctrl_get_address() and not a NULL
to get a better output.

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

tree: loop controllers can have transport addresses

Loop controllers may have transport addresses, so we need to parse
them to allocated correct objects.

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

Merge pull request #215 from hreinecke/regen-doc

Scripts for regenerating documentation

Add scripts to regenerate documentation

Import the 'kernel-doc' script from the linux kernel sources and
add scripts to regenerate libnvme.rst and man-pages.

Signed-off-by: Hannes Reinecke <hare@suse.de>
[dwagner: moved scripts from internal to doc]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

tree: restart controller lookup

nvme_lookup_ctrl() might match more than one controller (eg for loop
devices), in which case the iterator will only ever find the first one.
So add a parameter 'p' to nvme_lookup_ctrl() to re-start the iteration
at a given point instead of just the first one.

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

tree: fixup memory leak in nvme_scan_ctrl()

'subsysname' was never freed.

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

Merge pull request #217 from martin-belanger/fix-license

Fix license info

fix license info

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

Fixup wrong kernel-doc annotations

Some function descriptions weren't properly specified.

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

Add documentation section descriptions

Add DOC: statements to the header files to have each header file
start its own section in the API documentation.

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

Merge pull request #214 from hreinecke/kdoc

Sanitize kernel-doc comments

Regenerate libnvme.rst

Regenerate libnvme.rst with 'kernel-doc src/nvme/{filters,ioctl,linux,tree,types,fabrics,util}.h > doc/libnvme.rst'

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

Fixup sphinx warnings

When configuring with 'meson -Dman=true' sphinx is printing out errors
on the generated libnvme.rst file. This patch fixes up the function
documentations to fixup these warnings.

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

util.h: fixup kernel-doc comments

To keep sphinx happy.

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

fabrics.c: fixup kernel-doc comments

To keep sphinx happy.

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

types.h: fixup kernel-doc comments

To keep sphinx happy.

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

tree.h: fixup kernel-doc comments

To keep sphinx happy.

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

linux.h: fixup kernel-doc comments

To keep sphinx happy.

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

ioctl.h: fixup kernel-doc comments

To keep sphinx happy.

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

Merge pull request #209 from hreinecke/doc-proto

Document function prototypes

Ignore errors when opening JSON configuration file

The JSON configuration file is optional, so any errors during
opening can be ignored.

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

Return error from nvme_read_config()

nvme_read_config() can fail, so we should be returning an error code
to inform the caller about it.

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

tree: document function prototypes

Document all function prototypes in tree.h.

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

Merge pull request #205 from igaw/fix-64bit-alignment

ioctl: Sort members their natural size

Rename nvme_path_get_subsystem()

Misnamed, should be nvme_path_get_ctrl() to be consistent with the
other library functions.

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

Merge pull request #207 from igaw/rename-__nvme_get_log_page

Rename   nvme get log page

Remove nvme_reset_topology()

Identical to nvme_refresh_topology().

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

libvnme: Remove __nvme_msg from export map

nvme-cli was using the library infrastructure for logging. In the
meantime this has been removed, hence we can remove this function from
the export map.

Furthermore, move nvme_msg() and __nvme_msg() to private header.

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

linux: Rename __nvme_get_log_page()

The prefix of __nvme_get_log_page() is confusing as it usually
indicates this is a private function. Rename this function to
nvme_get_log_page().

The already existing one nvme_get_log_page() is renamed to
nvme_get_log_page_padded() which is asking for 4k transfers.

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

Merge pull request #202 from hreinecke/msg-redirect

Redirect error messages

Rework nvme_scan_filter()

Split off nvme_scan_filter() into nvme_create_root() and export the
remaining functionality as nvme_scan_topology(). With that
nvme_scan_filter() becomes pointless as the component functions
can be called directly.

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

ioctl: Sort members their natural size

Previous attempt to align the members of all *_args structure didn't
take into account that pointer types vary between 32bit and 64bit
depending the arch. The only reliable alignemnt is to sort the members
according their natural size: 64bit, pointers, 32bit, 16bit, 8bit.

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

Merge pull request #204 from igaw/fix-nvme_get_log_args-layout

ioctl: Fix struct nvme_get_log_args memberm alignment

libnvme/tests: fixup create-ctrl-obj.py

Add the new 'root' argument to nvme.ctrl()

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

ioctl: Fix struct nvme_get_log_args memberm alignment

Commit 781b9105cc43 ("nvme: Add Media Unit Status log page(LID:
0x10)") placed the domid member between two u8 members. The access
domid member would not be 16 bit aligned which is caused problems on
certain architectures. Let's fix the aligemnt by moving domid before
lsp. This give us following layout

struct nvme_get_log_args {
        int                        args_size;            /*     0     4 */
        int                        fd;                   /*     4     4 */
        __u32 *                    result;               /*     8     8 */
        __u32                      timeout;              /*    16     4 */
        enum nvme_cmd_get_log_lid  lid;                  /*    20     4 */
        __u64                      lpo;                  /*    24     8 */
        void *                     log;                  /*    32     8 */
        __u32                      len;                  /*    40     4 */
        __u32                      nsid;                 /*    44     4 */
        enum nvme_csi              csi;                  /*    48     4 */
        __u16                      lsi;                  /*    52     2 */
        __u16                      domid;                /*    54     2 */
        __u8                       lsp;                  /*    56     1 */
        __u8                       uuidx;                /*    57     1 */
        _Bool                      rae;                  /*    58     1 */
        _Bool                      ot;                   /*    59     1 */

        /* size: 64, cachelines: 1, members: 16 */
        /* padding: 4 */
} __attribute__((__aligned__(8)));

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

Remove stale definition for nvme_log_message

No functionality anymore.

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

Move global logging variables into nvme_root_t

Move the global logging variables into nvme_root_t to make them
settable by the application.

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

Add 'nvme_root_t' argument to nvme_msg()

Add a 'nvme_root_t' argument to nvme_msg() to allow for error
messages to be redirected to a different filedescriptor than
'stderr'.

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

Merge hostname2traddr()

For some reason we have two versions of hostname2traddr().

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

Merge pull request #203 from igaw/fix-error-codes

Fix error codes

util: Set errno in error case nvme_get_directive_receive_length

The API says we return -1 in the error case and set the errno
accordingly. Update nvme_get_directive_receive_length
to fulfill the promise.

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

ioctl: Set errno when command args check fails

In error the function is supposed to return -1 and set the errno
accordingly.

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

Merge pull request #201 from Arunpandian15/types_h_cleanup

Clean up Patch for types.h, ioctl.h

Clean up Patch for types.h, ioctl.h

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

Update README.md

Add documentation on how to build a static library.

Merge pull request #196 from hreinecke/rc-cleanup

Cleanups for release candidate

fabrics: remove documentation for nvmf_add_ctrl_opts()

function is gone, no need for the documentation.

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

fabrics: Update prototype documentation

Fill out missing bits in the function prototyp documentation.

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

fabrics: Remove nvmf_add_ctrl_opts()

Unused, and nvmf_add_ctrl() is doing exactly the same.

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

Merge pull request #195 from hreinecke/disable-sqflow

fabrics: kill 'disable_sqflow' argument to nvmf_add_ctrl()

fabrics: kill 'disable_sqflow' argument to nvmf_add_ctrl()

The 'disable_sqflow' argument to nvmf_add_ctrl() is pointless, as
'struct fabrics_config' is exported and the caller can set it
directly there, without having to involve library functions at all.
And consequently we can also remove nvme_ctrl_disable_sqflow().

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

Merge pull request #194 from hreinecke/ctrl-init

tree: only open controller device node if required

tree: only open controller device node if required

Opening the controller device will fail if the controller is resetting,
so trying to open it during controller initialisation will fail, and
the controller will not displayed correctly.
So only try to open the controller device if required, allowing the
initialisation to continue.

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

Merge pull request #192 from igaw/fix-nvme_get_log_args

ioctl: Initialize all members in nvme_get_log_args

ioctl: Initialize all members in nvme_get_log_args

Commit 781b9105cc43 ("nvme: Add Media Unit Status log page(LID:
0x10)") introduces a new member in nvme_get_log_args. Older compilers
are not happy when we don't initialize all members in the inline
functions.

In file included from ../subprojects/libnvme/src/libnvme.h:19:0,
                 from ../subprojects/libnvme/test/cpp.cc:10:
../subprojects/libnvme/src/nvme/ioctl.h: In function ‘int nvme_get_log_cmd_effects(int, nvme_csi, nvme_cmd_effects_log*)’:
../subprojects/libnvme/src/nvme/ioctl.h:1328:2: sorry, unimplemented: non-trivial designated initializers not supported
  };

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

Merge pull request #191 from hreinecke/tls

fabrics: add fabrics config option 'tls'

Merge pull request #157 from Arunpandian15/Media_Unit_Status_Log_Page

nvme: Add Media Unit Status log page(LID: 0x10)

fabrics: add fabrics config option 'tls'

Add an option 'tls' to the fabrics config to start TLS encryption
on the connection.

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

Merge pull request #186 from igaw/print-format-specifier

src: Use PRIu64 format specifier for uint64 types

Merge pull request #135 from hreinecke/ctrl-loss-args

Fix up handling of '-1' values

src: Use PRIu64 format specifier for uint64 types

When compiling for 32bit architectures the compiler is complaining
about the wrong format specifier for uint64. Use the the PRIu64 format
specifier in this case which is supported from 32bit and 64bit.

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

Merge pull request #185 from martin-belanger/ccan-static-lib

Define ccan as a static library

Define ccan as a static library

ccan gets built as a static library, which gets linked
to libnvme.so.

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

nvme: Add Media Unit Status log page(LID: 0x10)

Reviewed-by: Steven Seungcheol Lee <sc108.lee@samsung.com>
Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #164 from sc108-lee/add/flbas_to_lbaf_inuse

util: modify flbas rsvd bits to be used