Add intel vendor specific id-ctrl decoding

Signed-off-by: Keith Busch <keith.busch@intel.com>

Add vendor specific callback to id-ctrl print

Signed-off-by: Keith Busch <keith.busch@intel.com>

And intel vendor specific extensions

Signed-off-by: Keith Busch <keith.busch@intel.com>

Make help and version generic commands

Plugins don't need to implement these.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Move program execution to plugin handler

The command list definition is moved to a header file that generates the
structures and prototypes when compiled. This makes it easy to define
new extensions that are not part of the NVMe standard.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Execute sub-commands out of plugin structure

This encasulates sub-commands into a structure. This is the beginning
to support extensions and plugins.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Add json output format

Adds new control option for json ouput support. The new option has
parameters for json, binary and normal output options.

The older control flag for raw binary still exists and can be used to
override the output format.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Seperate kernel uapi from user structures

This pulls in the latest kernel's exported uapi. Including it here
so that it can be used when the kernel headers are either outdated or
not installed.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Use pattern rule for compiling objects

All the object files had the same pattern, though some of the targets
were missing the correct dependency list. This fixes them all with a
pattern rule.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Use int type for CFG_NONE

GNU long option requires flag be an int pointer. We were potentially
corrupting other parameters when using the 8-byte type.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Move parsing to top directory

We've diverged significantly from the argconfig program that nvme-cli
inherited, so no point in trying to keep it separate. Move it to the
top-level directory to make build rules easier.

Signed-off-by: Keith Busch <keith.busch@intel.com>

print friendly name for trtype and adrfam

Without this patch:
=====Discovery Log Entry 0======
trtype:  1
adrfam:  1

With this patch:
=====Discovery Log Entry 0======
trtype:  ipv4
adrfam:  rdma

Signed-off-by: Ming Lin <ming.l@samsung.com>

implement the connect-all command

Connects to all controllers pointed to by the discovery service.
Includes following referrals.

Signed-off-by: Christoph Hellwig <hch@lst.de>
Reviewed-by: Sagi Grimberg <sagi@grimberg.me>
Reviewed-by: Ming Lin <ming.l@samsung.com>
Tested-by: Ming Lin <ming.l@samsung.com>

Implement disconnect command

Example usage:

Disconnect by NQN,
nvme disconnect -n nqn.testiqn

or by device name,
nvme disconnect -d nvme0

Signed-off-by: Ming Lin <ming.l@ssi.samsung.com>
Tested-by: Armen Baloyan <armenx.baloyan@intel.com>
Tested-by: Sagi Grimberg <sagi@grimberg.me>
Reviewed-by: Jay Freyensee <james.p.freyensee@intel.com>

Implement connect command

Example usage:

root@host: nvme connect -t rdma -a 192.168.2.2 -p 1023 -n nqn.testiqn

Signed-off-by: Ming Lin <ming.l@ssi.samsung.com>
Tested-by: Armen Baloyan <armenx.baloyan@intel.com>
Tested-by: Sagi Grimberg <sagi@grimberg.me>
Reviewed-by: Jay Freyensee <james.p.freyensee@intel.com>

Add option to save discovery raw log to a file

root@host:~# nvme discover -t rdma -a 192.168.2.2 -p 1023 -r disc.raw
Discovery log is saved to disc.raw

Signed-off-by: Ming Lin <ming.l@ssi.samsung.com>
Tested-by: Armen Baloyan <armenx.baloyan@intel.com>
Tested-by: Sagi Grimberg <sagi@grimberg.me>

Implement discover command

Example output:

root@host:~# nvme discover -t rdma -a 192.168.2.2 -p 1023
Discovery Log Number of Records 1, Generation counter 3
=====Discovery Log Entry 0======
trtype:  1
adrfam:  1
nqntype: 2
treq:    0
portid:  1
trsvcid: 1023

subnqn:  nqn.testiqn
traddr:  192.168.2.2

rdma_prtype: 0
rdma_qptype: 0
rdma_cms:    0
rdma_pkey: 0x0000

Signed-off-by: Ming Lin <ming.l@ssi.samsung.com>
Tested-by: Armen Baloyan <armenx.baloyan@intel.com>
Tested-by: Sagi Grimberg <sagi@grimberg.me>
Reviewed-by: Jay Freyensee <james.p.freyensee@intel.com>

Adds parser library

This is imported from the Linux kernel 4.5.

Signed-off-by: Ming Lin <ming.l@ssi.samsung.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Reviewed-and-tested-by: Sagi Grimberg <sagi@grimberg.me>
Tested-by: Armen Baloyan <armenx.baloyan@intel.com>

Adds nvme_discovery_log()

Signed-off-by: Ming Lin <ming.l@ssi.samsung.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Reviewed-and-tested-by: Sagi Grimberg <sagi@grimberg.me>
Tested-by: Armen Baloyan <armenx.baloyan@intel.com>

Add macro helpers to common.h

Signed-off-by: Ming Lin <ming.l@ssi.samsung.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Reviewed-and-tested-by: Sagi Grimberg <sagi@grimberg.me>
Tested-by: Armen Baloyan <armenx.baloyan@intel.com>

Add NVMeoF definition to nvme.h

Signed-off-by: Ming Lin <ming.l@ssi.samsung.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Reviewed-and-tested-by: Sagi Grimberg <sagi@grimberg.me>
Tested-by: Armen Baloyan <armenx.baloyan@intel.com>

Support Get Log Page extended Number of Dwords

This supports 32 bits(rather than 12 bits) extended Number of Dwords
in nvme_get_log().

Signed-off-by: Ming Lin <ming.l@ssi.samsung.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Reviewed-and-tested-by: Sagi Grimberg <sagi@grimberg.me>
Tested-by: Armen Baloyan <armenx.baloyan@intel.com>

Makefile: introduce OBJS variable

Instead of listing all the objects twice.

Signed-off-by: Christoph Hellwig <hch@lst.de>

Merge pull request #91 from ColinIanKing/master

 Fix leak of mbuffer on error exit path

 Fix leak of mbuffer on error exit path

building with clang scan-build picked up a memory leak:
nvme.c:2176:3: warning: Potential leak of memory pointed to by 'mbuffer'
   fprintf(stderr, "failed to read data buffer from input file\n");
   ^~~~~~~

instead of returning, jump to free_and_return which performs the
correct cleanup.  Also fix the indentation of the return at the end of
the function.

Signed-off-by: Colin Ian King <colin.king@canonical.com>

Genarate lnvm documentation

Signed-off-by: Keith Busch <keith.busch@intel.com>

Merge pull request #90 from ColinIanKing/master

minor fix and code clean up

Remove extraneous and unused mode parameter from show_nvme_id_ctrl_power

mode is not used, so we may as well remove it

Signed-off-by: Colin Ian King <colin.king@canonical.com>

Merge pull request #87 from MatiasBjorling/for-keith

Add LightNVM adminstration and diagnose support

Fix null pointer dereference on strlen()

If string is NULL, then the proceeding strlen() on the string
will lead to a NULL pointer dereference error (segmentation fault).
Fix this by swapping the order of the comparisons, first check for
a NULL pointer; if that's not true then do the strlen check.

Signed-off-by: Colin Ian King <colin.king@canonical.com>

Merge pull request #89 from ColinIanKing/master

Fix segmentation fault using nvme show-regs with no device name

Fix segmentation fault using nvme show-regs with no device name

Add check_arg_dev() to check if a device name has been provided
and use this in show_registers to avoid the following segfault:

Segmentation fault (core dumped)

Signed-off-by: Colin Ian King <colin.king@canonical.com>

Add documentation for LightNVMcommands

Adds detailed documentation on each of these commands:

 - lnvm-list
 - lnvm-info
 - lnvm-id-ns
 - lnvm-init
 - lnvm-create
 - lnvm-remove
 - lnvm-factory
 - lnvm-diag-bbtbl
 - lnvm-diag-set-bbtbl

Add support for updating the bad block table

Introduce lnvm-diag-set-bbtbl. It takes the channel, lun, plane, block
and the value to update and sends it to the device. Afterwards, the
status can be retrieved with lnvm-diag-get-bbtbl.

Add LightNVM adminstration and diagnose support

Add support for identify geometry, get bad block interface and
administration interface for LightNVM. This patch adds the following
commands:

 - (lnvm-id-ns) Identify geometry of a LightNVM device.
 - (lnvm-diag-bbtbl) Retrieve bad block table from LightNVM device.
 - (lnvm-info) Get information about modules loaded, and available
               devices.
 - (lnvm-init) Initialize LightNVM device with a media manager.
 - (lnvm-create) Create targets on top of registered devices.
 - (lnvm-remove) Remove a registered target.
 - (lnvm-factory) Factory initialize a LightNVM device.

Signed-off-by: Matias Bjørling <m@bjorling.me>

Merge pull request #76 from maksim-teqniksoft/add-completion-to-packages

Install bash autocompletion by default

Merge pull request #88 from morbidrsa/for-keith

bash completion: Remove shebang line

bash completion: Remove shebang line

Remove shebang line from bash completion file as rpmlint on openSUSE/SLE
complains about a script ment to be sourced not executed containing a shebang
line.

[   38s] nvme-cli.x86_64: W: sourced-script-with-shebang /etc/bash_completion.d/nvme /usr/bin/env
[   38s] This text file contains a shebang, but is meant to be sourced, not executed.

Signed-off-by: Johannes Thumshirn <jthumshirn@suse.de>

Release v0.7

Just a few minor updates and documentation fixes. There is also a new
option for passthrough commands that can be used to help detect data
over/under run.

Tagging a stable release so we can consider features that bring in other
transports and third party extensions.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Align and clear user buffers

Avoid the bounce buffers a kernel may allocate by using aligned memory,
and clear the memory in case the user's input doesn't fill the entire
buffer.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Align passthrough buffers

Some versions of the kernel will create bounce buffers instead of using
directly if the user buffer is not aligned.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Fix create-ns man page size option

It's -s, not -n.

Issue: https://github.com/linux-nvme/nvme-cli/issues/86
Signed-off-by: Keith Busch <keith.busch@intel.com>

Pre-fill user buffers on passthrough commands

Reported that user data may be shorter than the buffer length, and need
to pad the data with a fixed byte value.

Also requested that we provied a way to prefill data in buffers so we
can know if a device is corrupting memory.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Use correct power scale bits

The active and idle power scales occupy the upper 2 bits of their byte
fields. Shift the scales to use these bits when decoding their values.

Issue: https://github.com/linux-nvme/nvme-cli/issues/85
Signed-off-by: Keith Busch <keith.busch@intel.com>

Decode all firmware activate reset codes

Signed-off-by: Keith Busch <keith.busch@intel.com>

Add all error codes from 1.2 spec

This adds enums and prints for all error codes. Since the names are
getting longer, all the prints have white space code shift to align
the same.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Merge pull request #79 from minggr/master

Rename nvme_log() to nvme_get_log()

Merge pull request #82 from hrasiq/ppc64-fixes

fix data_size and metadata_size types

fix data_size and metadata_size types

The data_size and metadata_size fields in the config struct are declared as
__u32, but should actually be __u64. The current types cause issues in the
argument parsing functions depending on machine architecture and endianness. In
ppc64, using __u32 causes "data size not provided" errors due to the way writes
are being done by argconfig_parse() at src/argconfig.c. Changing the types to
__u64 should fix this behaviour and is in accordance to the CFG_LONG_SUFFIX
flag.

Signed-off-by: Heitor Ricardo Alves de Siqueira <halves@linux.vnet.ibm.com>

Release 0.6

Fixes a couple missing namespace parameteters to newer sub-commands,
and various printing updates.

Merge pull request #80 from samiWaheed/master

Master

Fix nsid print in show_error_log

nsid in error log page could be set to 0xffffffff and should be printed
as unsigned instead of int

Rename nvme_log() to nvme_get_log()

This kills off the old nvme_get_log() and rename
nvme_log() to nvme_get_log().

Signed-off-by: Ming Lin <ming.l@ssi.samsung.com>

Use nsid parameter for security commands

Controllers optionally may use nsid.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Merge pull request #75 from asciiprod/debian-fixes

sync with actual debian package

Fix namespace attachment

The nsid was dropped from the command.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Code reuse: Namespace identification

Combining common code into single function.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Use enum instead of hard-coded values

Define constants to make clear what a device is doing.

Noticing that one identify mode was never used, so adding an option.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Namespace attach controller list endian fix

Convert for host endian.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Code reuse: parsing options and arguments

A common code pattern is to parse the options, then open the first
non-option argument as the device parameter.

This patch combines that pattern in a reusable single function. The
savings is not significant, but every little bit helps.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Code reuse: character device check

Moving character device sanity check to common function to reduce
duplication.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Merge pull request #77 from seehearfeel/master

Fix the bug of Model Number and display the info of Serial Number

Fix the bug of Model Number and display the info of Serial Number

OK, I see, thanks for your suggestion.

I have modified the related code of Serial Number, Model Number and Firmware Revision,
other fields are not be changed because the length can not be properly figured out by
the print format specifier, (int)sizeof(field) is too big and (int)strlen(field) is random.
In addition, fix a minor spelling mistake "Namepace" to "Namespace".

Please review, thanks!

Fix the bug of Model Number and display the info of Serial Number

According to the NVMe Specification, there is an error when display Model Number.
In addition, currently it does not display the info of Serial Number, so add it.

Install bash autocompletion by default

sync with actual debian package
drop all patches as they have all been fixed upstream

Release v0.5

The v0.4 breakage should all be resolved now. Tagging release v0.5,
and back to stability.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Add reset and subsystem reset commands

Signed-off-by: Keith Busch <keith.busch@intel.com>

Print format consistency

Use same format for both get and set features when displaying results.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Merge pull request #74 from sanderboom/master

Added Arch Linux install instructions to README.md

Added Arch Linux install instructions to README.md

Merge branch 'keith-fixes'

Fix 32-bit pointer conversion

Reported-by: Russell Joyce <russell@russellj.co.uk>
Signed-off-by: Keith Busch <keith.busch@intel.com>

Merge pull request #72 from kholmanskikh/map_failed

nvme: fix the mmap error check

Merge pull request #71 from kholmanskikh/nvme-print_typo

nvme-print: fix a typo

nvme: fix the mmap error check

Signed-off-by: Stanislav Kholmanskikh <stanislav.kholmanskikh@oracle.com>

nvme-print: fix a typo

Commit 82c4d1fff8db ("Use endian host conversions for endian type data")
introduced a typo. This is a fix for that.

Signed-off-by: Stanislav Kholmanskikh <stanislav.kholmanskikh@oracle.com>

Sync with latest kernel's provided nvme IOCTLs

New kernels provide reset and subsystem reset.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Consistent help text updates

Refer to identifiers as "identifier" instead of "name".

Signed-off-by: Keith Busch <keith.busch@intel.com>

Merge pull request #70 from lakshminarayanand/nvme-cli-config

Fix Memory leak on fail case of mbuffer

Fix Memory leak on fail case of mbuffer

Merge pull request #67 from wdc-tools/master

Fixed option checking for format to match NVMe spec limits.

Remove unused nvme_admin_cmd in format

Signed-off-by: Keith Busch <keith.busch@intel.com>

Simplify show-regs

You only need to specify the name of the device. The character or block
device was never necessary to show the registers since we're opening the
sysfs resource entry. This is backwards compatibles with the old way as
the basename was stripped from the path before.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Simplify non-argument params

The device is the first non-argument param. The handling for this is
done by argparse, and we expect to move it to the end. Instead, it'd be
easier to let getopt's handle this by not providing the '-' signifier
to treat non-arguments as arguments. This simplifies opening the device.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Add nvme security specific field

Signed-off-by: Keith Busch <keith.busch@intel.com>

Add namespace id param for security commands

Signed-off-by: Keith Busch <keith.busch@intel.com>

Access 64-bit registers as 2 32-bit

Some devices fail 64-bit MMIO.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Use endian host conversions for endian type data

Signed-off-by: Keith Busch <keith.busch@intel.com>

More print and format updates

Signed-off-by: Keith Busch <keith.busch@intel.com>

Changes to format range checks to retain forward compatibility.

Fixed option checking for format to match NVMe spec limits.

Fixing a get and set features

The get feature argument for extensive decoding for readibility is 'H'
rather than 'h', and a set feature value can be 0xffffffff, so fixing
that bogus check.

Signed-off-by: Keith Busch <keith.busch@intel.com>

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

Misc fixes

A few errors in the moving occured. The short non-option arguments
weren't working, gnu parse option parameters were mishandled, and get
features used the wrong opcode.

Folding in help text updates.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Merge pull request #66 from leitao/master

Fix problems on Debian package

Fix English typos only

This is a commit to fix a type across the project, from "identifer" to
"identifier".

The motivation behind this fix is to make this package perfect to be
included in the Debian project. As it is, the lintian checker is
complainging about these typos using the tag spelling-error-in-manpage.

Fix copyright file

The debian/copyright file was not proper create, as reported by
"licensecheck -r --copyright ."

This change seems to fix these problems.

Add write uncorrectable command

This concludes nvme-cli's implementing every IO command in the NVMe
1.2 specification.

Signed-off-by: Keith Busch <keith.busch@intel.com>

Add write zeroes command

As part of this, moving the namespace id error handling to a common
function, as this has become a common repitition.

Signed-off-by: Keith Busch <keith.busch@intel.com>