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.

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>

Export print_word_wrapped

... and use the word wrapping API to print long strings.

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

Simplify argument parsing

This combines short and long option names into the same argument entry
so we don't need to duplicate each entry. This also greatly simplifies
the help printing, which had an undocumented dependency  of argument
ordering just to print correctly.

The simpler setup makes it easier to add new commands.

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

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

Update default version

This should have been updated inline with the tags so the version file
wouldn't depend on having a git repository.

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

Updated README.md

Added text to cover the new support in Universe for Xenial.

Minor whitespace fix in README.md

Whitespace fixes

Just removing trailing whitespaces and putting braces where they belong.

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

Split display routines from cli

All routines that decode and show the data are moved to a common file
separate from the command line interface.

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

Split ioctl command handling from cli

Moving nvme ioctl handling from the command line interface into a
separate file.

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

Consistent code formatting

Used 'indent -linux' to quickly convert code style to linux conventions.

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

Merge pull request #61 from morbidrsa/master

README.md: Add the openSUSE Tumbleweed package

README.md: Add the openSUSE Tumbleweed package

Add the openSUSE Tumbleweed package to README.md

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

Documenation fixes

Addresing typos and a few subtle incorrect usages. '0x' is a required
prefix for parsing hex numbers.

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

Ignore swp files

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

Merge pull request #58 from leitao/master

Fix debian scripts and typos

Fix English typos only

This is a commit to fix typos accross the project, mainly the
following:

  * overriden -> overridden
  * paramter -> parameter
  * Comand -> Command
  * Offical -> Official

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.

It was also requested by a Debian maintainer in the following review:
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=810033#38

Fix two debian/control issues

It was reported by a mentor on Debian[1], two problems were detected
and fixed:

 - Remove the . at the end of the package description, that caused error
   description-synopsis-might-not-be-phrased-properly.

 - Remove hard dependency for libudev0 | libudev1. It is being generated
   by dh_shlibdeps.

[1] https://bugs.debian.org/cgi-bin/bugreport.cgi?att=0;msg=23;bug=810033

Changing the debian maintainer

Adding myself as the Debian maintainer, since Keith is the upstream
author, and I will be the Debian maintainer for the package.

Merge pull request #56 from FlorianHeigl/patch-2

Add starter doc for AlpineLinux

Add starter doc for AlpineLinux

I've included two command examples, i hope that's not too much bloat. normally people will try to avoid using udev, but it's not really necessary either assuming everyone can ls /dev/nvme* ;)

Merge pull request #55 from amluto/master

README.md: Mention the Fedora package

README.md: Mention the Fedora package

Signed-off-by: Andy Lutomirski <luto@kernel.org>

Add "CONTRIBUTING" file.

Setting general rules for contributing. Nothing is changing, but need
to make it explicit that contributions can't violate the software license.

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

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

Memory leak fix at argconfig_parse_subopt_string of argconfig

Memory leak fix at argconfig_parse_subopt_string of argconfig

Merge pull request #53 from amluto/nvme-list

Restrict 'nvme list' to disks, i.e. exclude partitions

Merge pull request #52 from amluto/decode-ps

Decode power states more readably

Restrict 'nvme list' to disks, i.e. exclude partitions

This stops 'nvme list' from separately enumerating all partitions.

Signed-off-by: Andy Lutomirski <luto@kernel.org>

Decode ps active and idle power

Decode the data instead of displaying it in raw form.

Signed-off-by: Andy Lutomirski <luto@kernel.org>

Improve power state flags and max power decoding

Signed-off-by: Andy Lutomirski <luto@kernel.org>

Merge branch 'lakshminarayanand-nvme-cli-local'

Merge pull request #50 from lakshminarayanand/nvme-cli-local

Fixing Memory Leak

Memory Leak Fix at nvme_passthru

In nvme_passthru buffers "data and metadata" allocated are not getting
freed at the fail cases and hence might lead to memory leak. This patch
free the buffer before the return of the function.

[Fixed tab formatting and conditional braces]
Signed-off-by: Keith Busch <keith.busch@intel.com>

Fixing Memory Leak

Fix udev flags assignment

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

Fixed README formatting.

Merge pull request #46 from leitao/master

Fixes in the debian scripts

Add debian/changelog

I created debian/changelog for the first nvme-cli debianization relase.

I kept Keith as the maintainer for the package, so, it doesn't mean an NMU.
If I try to push this in the future, I might change the maintainer.

Do not ignore debian/changelog

Changelog is required in order to build the package. As this project
keeps the debian scripts in the upstream source, changelog file is
one of the most important files to be kept here.

Fix debian copyright file to map Debp5

The debian/copyright file must be machine-interpretable, yet human-readable,
while communicating all mandated upstream information, copyright notices and
licensing details.

This new format maps to DEBP5, as specified at
http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

Add homepage and fix version on Control

Add the project homepage and fix the Debian version file in the debian control
file.

Tested against lintian and no problem found, even with pedantic option.