Typo fix

Fix a small typo.

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

fix integration breakage

Signed-off-by: Keith Busch <kbusch@kernel.org>

updates from integration

Various fixes and support for newer nvme operations.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Merge pull request #5 from hreinecke/master

Make systemd and uuid optional

Merge pull request #6 from hreinecke/address-parse

Parse 'address' string into components

Parse 'address' string into components

The 'address' string really are several parts (traddr, trsvcid, and
host_addr) which are separated by commas. So avoid every user having
to parse that string on its own this patch exposes the individual parts
via nvme_ctrl_get_{traddr,trsvcid,host_traddr}.
Each call might return NULL if the respective value isn't set.

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

Make systemd and uuid optional

Add configuration flags '--disable-systemd' and '--disable-uuid'
to forcibly exclude systemd and uuid during build.

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

Merge pull request #4 from tbzatek/build-pkg-config

build: Include libnvme.pc in the default make target

build: Include libnvme.pc in the default make target

Merge pull request #3 from tbzatek/docs-updates-1

Docs strings updates

Docs strings updates

fix log numdu mask

This is a 16-bit value, not 8.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Merge pull request #2 from tbzatek/get_log_cdw10_mask

ioctl: Fix NVME_LOG_CDW10_NUMDL_MASK

ioctl: Fix NVME_LOG_CDW10_NUMDL_MASK

Used in nvme_get_log(), caused nvme_get_log_error() failures.

add lba status log helper

This log requires a more complex multi-sequence to successfully get, so
add a helper.

Signed-off-by: Keith Busch <kbusch@kernel.org>

examples: Add src/ into the include and library path

That will fix the compiling errors like:
     CC telemetry-listen
telemetry-listen.c:21:10: fatal error: libnvme.h: No such file or directory
   21 | #include <libnvme.h>
      |          ^~~~~~~~~~~

Signed-off-by: Han Han <hhan@redhat.com>

spec: Fix the sub-include dir name to nvme

It will fix the error of "libnvme/ dir is not found":
$ rpmbuild -ba ~/rpmbuild/SPECS/libnvme.spec
...
error: Directory not found:
/home/hhan/rpmbuild/BUILDROOT/libnvme-0.1-0.x86_64/usr/include/libnvme

Signed-off-by: Han Han <hhan@redhat.com>

spec: Use the correct url of libnvme

Signed-off-by: Han Han <hhan@redhat.com>

update doc cross links

Signed-off-by: Keith Busch <kbusch@kernel.org>

document corner case for large nsids

Signed-off-by: Keith Busch <kbusch@kernel.org>

fix mmio accesses

64-bit access needs to ensure no reorder or combining.

Signed-off-by: Keith Busch <kbusch@kernel.org>

common code all the complex value accessors

Signed-off-by: Keith Busch <kbusch@kernel.org>

update and inline feature decoding

Signed-off-by: Keith Busch <kbusch@kernel.org>

fix up get_nsid api

namespaces can be anything from 1 to 0xfffffffe, which means they must
be unsigned. Change the api to take a parameter for the nsid value
rather than try to return an 'int', which would have confusing
signedness.

Signed-off-by: Keith Busch <kbusch@kernel.org>

report zones helpers

Signed-off-by: Keith Busch <kbusch@kernel.org>

zns and ns-types

Signed-off-by: Keith Busch <kbusch@kernel.org>

export metadata size

Signed-off-by: Keith Busch <kbusch@kernel.org>

generic whitespace strip routine

Printing routines have a need to strip white spaces too, so make this a
common nvme lib routine.

Signed-off-by: Keith Busch <kbusch@kernel.org>

have tree export directly opening namespaces

Signed-off-by: Keith Busch <kbusch@kernel.org>

minor updates

A collection of updates including:

  Naming consistency improvements

  Namespace descriptor attributes added to namespace elements

  Doc updates to use more consise descriptions

Signed-off-by: Keith Busch <kbusch@kernel.org>

Explicit casting from void *

Signed-off-by: Keith Busch <kbusch@kernel.org>

fix comment typo

Signed-off-by: Keith Busch <kbusch@kernel.org>

Define all nvme registers

Provide enum and accessor methods for all nvme regsiter values and
sub-values.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Export single namespace open

Signed-off-by: Keith Busch <kbusch@kernel.org>

nvme/types.h: avoid using anon enums

Signed-off-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
Signed-off-by: Keith Busch <kbusch@kernel.org>

Merge branch 'master' of https://github.com/linux-nvme/libnvme

Fill out additional documentation fields

Signed-off-by: Keith Busch <kbusch@kernel.org>

Merge pull request #1 from safl/master

Fix dependency on systemd

Fix dependency on systemd

When libsystemd is not installed on the system, then the pkg-config
check would still be true when systemd itself is on the system. Also,
when the library is unavailable then the hard-coded "-lsystemd" would
cause the build to fail. The following changes fix that.

* configure: changed check from "systemd" to the library "libsystemd"

* examples/Makefile: Replaced hard-coded "-lsystemd" with "${LDFLAGS}"
  as defined by "config-host.mak" in examples/Makefile

* src/Makefile: added include of "config-host.mak", removed hard-coded
  "-lsystemd", "-lsystemd" will trickle in from LDFLAGS

Signed-off-by: Simon A. F. Lund <simon.lund@samsung.com>

Fix double free discover log

Signed-off-by: Keith Busch <kbusch@kernel.org>

Move feature field decoding to utilitiies

Export a more coder friendly way to decode complex status fields than
the mask+shift macros.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Typo fixes

Signed-off-by: Keith Busch <kbusch@kernel.org>

Fix status code mask

Signed-off-by: Keith Busch <kbusch@kernel.org>

Merge branch 'master' of https://github.com/linux-nvme/libnvme

Fix install make targets

The makefile needs to be updated to reflect the current layout after
shuffling some things around,

Signed-off-by: Keith Busch <kbusch@kernel.org>

Fix split line documentation

The documentation parser won't recognize the desired link nmae if enum
and the name are on separate lines.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Merge branch 'master' of https://github.com/linux-nvme/libnvme

Testing rst html options

Signed-off-by: Keith Busch <kbusch@kernel.org>

Fix typo in comments

Signed-off-by: Keith Busch <kbusch@kernel.org>

Integration fixes

Fix up inconsistencies and missing features discovered while integrating
with nvme-cli.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Update .gitignore

Update ccan artifacts to their correct directory.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Fill in more documentation details

And start adding more cross references.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Add man pages for exports

Generate man-pages from existing source. This will likely change soon
as the types (struct and enum) should probably be grouped in the same
manual as the primary function that uses it rather than have their own,
and similiar functions can in turn be grouped in the same manual as
well.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Set up ccan make dependency correctly

Fixes parallel -j make.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Fix copyright comments

Don't use the kernel-doc style as that will try to get interpreted by
the scripts.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Move ccan up a directory

This will make it easier to generate library documentation when the
source is not mixed with external libraries.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Apply kernel-doc comments to more structs and enums

Signed-off-by: Keith Busch <kbusch@kernel.org>

Add licence tags, copyright, and author comments

Signed-off-by: Keith Busch <kbusch@kernel.org>

Add c++ inclusion support

extern "C" the top level header file, and add a simple c++ compile test.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Make systemd-devel optional

There's only one libnvme feature that uses this package. Let's make this
feature optional and return error ENOTSUP if the package is not available.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Update .gitignore

Signed-off-by: Keith Busch <kbusch@kernel.org>

Consolodate features into common header

Locate all command submission helper declarations into common ioctl.h
header rather than split these.

Remove the private.h file as only one .c was using it.

Signed-off-by: Keith Busch <kbusch@kernel.org>

libnvme: code cleanup src/nvme/util.c

Various coding style fixes.

Signed-off-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
Signed-off-by: Keith Busch <kbusch@kernel.org>

libnvme: code cleanup src/nvme/tree.c

Various coding style fixes.

Signed-off-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
Signed-off-by: Keith Busch <kbusch@kernel.org>

libnvme: code cleanup src/nvme/ioctl.c

Various coding style fixes.

Signed-off-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
Signed-off-by: Keith Busch <kbusch@kernel.org>

libnvme: code cleanup src/nvme/filters.c

Make sure lines length stays <= 80 character.

Signed-off-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
Signed-off-by: Keith Busch <kbusch@kernel.org>

libnvme: code cleanup src/nvme/fabrics.c

This patch has following style fixes :-
Add a new line after function.
Adjust function arguments.
Init array remove memset.
Return early in the function.

Signed-off-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
Signed-off-by: Keith Busch <kbusch@kernel.org>

Split host and controller telemetry log API

While similar, these are logs are not obtained the same way.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Import ccan modules

Replace <sys/queue.h> list implementation with the superior ccan list.
This is a more pleasant C implementation to work with, and since we the
structures using this are not exported through the API, we can freely
change these kinds of implementation details.

And while we're at it, include a few other useful modules to provide
useful macros and compile time checks on spec defined structs.

Signed-off-by: Keith Busch <kbusch@kernel.org>

tests: Fix fw log check

Had the return check inverted (0 is success).

Signed-off-by: Keith Busch <kbusch@kernel.org>

util: Fix default log transfer length typo

Transfer lengths are 4k, not 4086 bytes.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Add README

Signed-off-by: Keith Busch <kbusch@kernel.org>

Add license information

Added LGPL licence via:

  wget https://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt -O COPYING

Signed-off-by: Keith Busch <kbusch@kernel.org>

tests: Remove some of the output

Remove parts made redundant with the examples/display programs.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Add documentation

Experimenting with documentation generation:

Initialize sphinx documentation building.

Use linux's 'scripts/kernel-doc' to extract documentation comments from
source and format as .rst file.

Signed-off-by: Keith Busch <kbusch@kernel.org>

examples: Add loop discover example

A basic fabrics example discoverying loop nvme fabric targets. Apply
fixes and updates to lib code as needed from testing.

Signed-off-by: Keith Busch <kbusch@kernel.org>

examples: Add column disaply of topology

Pretty print nvme topology in detailed columns.

Signed-off-by: Keith Busch <kbusch@kernel.org>

examples/telemetry: Fix scanning uevent file

Continue to the next line if current one does not contain async event
information.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Add nvme display tree example

Simple visual demonstration of an nvme topology.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Add exported symbols to libnvme.map

And add the kernel-doc style comments in all exported functions.

This is just a capture of what currently exists and may change prior to tagging
as a stable release.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Add a telemetry scan example

Copy the liburing directory structure and start adding examples. The first
example monitors all devices for telemetry events, and if available will write
out the telemetry log to a file in /var/log/.

While developing the example, some other misc fixes and updates were added to
the library code.

Signed-off-by: Keith Busch <kbusch@kernel.org>

Initial libnvme commit

Most of the planned features are developed, however many of the interfaces have
only been lighlty touched as the features they implement are not broadly
supported in hardware.

The remaining gaps in command support from 1.4 are:

  Management Interface Send/Recieve OOB support
  Persistent Event Logs

There is no plan to support Abort, AER, IO SQ/CQ Create/Delete, or Doorbell
Buffer Config since that has high risk to abuse and interfere with the
stability of a running system.

Signed-off-by: Keith Busch <kbusch@kernel.org>