|
Packit |
dd4ba5 |
nvme-read(1)
|
|
Packit |
dd4ba5 |
============
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
NAME
|
|
Packit |
dd4ba5 |
----
|
|
Packit |
dd4ba5 |
nvme-read - Send an NVMe Read command, provide results
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
SYNOPSIS
|
|
Packit |
dd4ba5 |
--------
|
|
Packit |
dd4ba5 |
[verse]
|
|
Packit |
dd4ba5 |
'nvme-read' <device> [--start-block=<slba> | -s <slba>]
|
|
Packit |
dd4ba5 |
[--block-count=<nlb> | -c <nlb>]
|
|
Packit |
dd4ba5 |
[--data-size=<size> | -z <size>]
|
|
Packit |
dd4ba5 |
[--metadata-size=<size> | -y <size>]
|
|
Packit |
dd4ba5 |
[--ref-tag=<reftag> | -r <reftag>]
|
|
Packit |
dd4ba5 |
[--data=<data-file> | -d <data-file>]
|
|
Packit |
dd4ba5 |
[--metadata=<metadata-file> | -M <metadata-file>]
|
|
Packit |
dd4ba5 |
[--prinfo=<prinfo> | -p <prinfo>]
|
|
Packit |
dd4ba5 |
[--app-tag-mask=<appmask> | -m <appmask>]
|
|
Packit |
dd4ba5 |
[--app-tag=<apptag> | -a <apptag>]
|
|
Packit |
dd4ba5 |
[--limited-retry | -l]
|
|
Packit |
dd4ba5 |
[--force-unit-access | -f]
|
|
Packit |
dd4ba5 |
[--dir-type=<type> | -T <type>]
|
|
Packit |
dd4ba5 |
[--dir-spec=<spec> | -S <spec>]
|
|
Packit |
dd4ba5 |
[--dsm=<dsm> | -D <dsm>]
|
|
Packit |
dd4ba5 |
[--show-command | -v]
|
|
Packit |
dd4ba5 |
[--dry-run | -w]
|
|
Packit |
dd4ba5 |
[--latency | -t]
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
DESCRIPTION
|
|
Packit |
dd4ba5 |
-----------
|
|
Packit |
dd4ba5 |
The Read command reads the logical blocks specified by the command from
|
|
Packit |
dd4ba5 |
the medium and copies to the data data buffer provided. Will use stdout
|
|
Packit |
dd4ba5 |
by default if you don't provide a file.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
OPTIONS
|
|
Packit |
dd4ba5 |
-------
|
|
Packit |
dd4ba5 |
--start-block=<slba>::
|
|
Packit |
dd4ba5 |
-s <slba>::
|
|
Packit |
dd4ba5 |
Start block.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
--block-count::
|
|
Packit |
dd4ba5 |
-c::
|
|
Packit |
dd4ba5 |
The number of blocks to transfer. This is a zeroes based value to
|
|
Packit |
dd4ba5 |
align with the kernel's use of this field. (ie. 0 means transfer
|
|
Packit |
dd4ba5 |
1 block).
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
--data-size=<size>::
|
|
Packit |
dd4ba5 |
-z <size>::
|
|
Packit |
dd4ba5 |
Size of data, in bytes.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
--metadata-size=<size>::
|
|
Packit |
dd4ba5 |
-y <size>::
|
|
Packit |
dd4ba5 |
Size of metadata in bytes.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
--data=<data-file>::
|
|
Packit |
dd4ba5 |
-d <data-file>::
|
|
Packit |
dd4ba5 |
Data file. If none provided, contents are sent to STDOUT.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
--metadata=<metadata-file>::
|
|
Packit |
dd4ba5 |
-M <metadata-file>::
|
|
Packit |
dd4ba5 |
Metadata file, if necessary.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
--prinfo=<prinfo>::
|
|
Packit |
dd4ba5 |
-p <prinfo>::
|
|
Packit |
dd4ba5 |
Protection Information field definition.
|
|
Packit |
dd4ba5 |
+
|
|
Packit |
dd4ba5 |
[]
|
|
Packit |
dd4ba5 |
|=================
|
|
Packit |
dd4ba5 |
|Bit|Description
|
|
Packit |
dd4ba5 |
|3|PRACT: Protection Information Action. When set to 1, PI is stripped/inserted
|
|
Packit |
dd4ba5 |
on read/write when the block format's metadata size is 8. When set to 0,
|
|
Packit |
dd4ba5 |
metadata is passes.
|
|
Packit |
dd4ba5 |
|2:0|PRCHK: Protection Information Check:
|
|
Packit |
dd4ba5 |
|2|Set to 1 enables checking the guard tag
|
|
Packit |
dd4ba5 |
|1|Set to 1 enables checking the application tag
|
|
Packit |
dd4ba5 |
|0|Set to 1 enables checking the reference tag
|
|
Packit |
dd4ba5 |
|=================
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
--ref-tag=<reftag>::
|
|
Packit |
dd4ba5 |
-r <reftag>::
|
|
Packit |
dd4ba5 |
Optional reftag when used with protection information.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
--app-tag-mask=<appmask>::
|
|
Packit |
dd4ba5 |
-m <appmask>::
|
|
Packit |
dd4ba5 |
Optional application tag mask when used with protection information.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
--force-unit-access::
|
|
Packit |
dd4ba5 |
-f::
|
|
Packit |
dd4ba5 |
Set the force-unit access flag.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
-T <type>::
|
|
Packit |
dd4ba5 |
--dir-type=<type>::
|
|
Packit |
dd4ba5 |
Optional directive type. The nvme-cli only enforces the value
|
|
Packit |
dd4ba5 |
be in the defined range for the directive type, though the NVMe
|
|
Packit |
dd4ba5 |
specifcation (1.3a) defines only one directive, 01h, for write
|
|
Packit |
dd4ba5 |
stream idenfiers.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
-S <spec>::
|
|
Packit |
dd4ba5 |
--dir-spec=<spec>::
|
|
Packit |
dd4ba5 |
Optional field for directive specifics. When used with
|
|
Packit |
dd4ba5 |
write streams, this value is defined to be the write stream
|
|
Packit |
dd4ba5 |
identifier. The nvme-cli will not validate the stream requested
|
|
Packit |
dd4ba5 |
is within the controller's capabilities.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
-D <dsm>::
|
|
Packit |
dd4ba5 |
--dsm=<dsm>::
|
|
Packit |
dd4ba5 |
The optional data set management attributes for this command. The
|
|
Packit |
dd4ba5 |
argument for this is the lower 16 bits of the DSM field in a write
|
|
Packit |
dd4ba5 |
command; the upper 16 bits of the field come from the directive
|
|
Packit |
dd4ba5 |
specific field, if used. This may be used to set attributes for
|
|
Packit |
dd4ba5 |
the LBAs being written, like access frequency, type, latency,
|
|
Packit |
dd4ba5 |
among other things, as well as yet to be defined types. Please
|
|
Packit |
dd4ba5 |
consult the NVMe specification for detailed breakdown of how to
|
|
Packit |
dd4ba5 |
use this field.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
-v::
|
|
Packit |
dd4ba5 |
--show-cmd::
|
|
Packit |
dd4ba5 |
Print out the command to be sent.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
-w::
|
|
Packit |
dd4ba5 |
--dry-run::
|
|
Packit |
dd4ba5 |
Do not actually send the command. If want to use --dry-run option,
|
|
Packit |
dd4ba5 |
--show-cmd option _must_ be set. Otherwise --dry-run option will be
|
|
Packit |
dd4ba5 |
_ignored_.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
-t::
|
|
Packit |
dd4ba5 |
--latency::
|
|
Packit |
dd4ba5 |
Print out the latency the IOCTL took (in us).
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
EXAMPLES
|
|
Packit |
dd4ba5 |
--------
|
|
Packit |
dd4ba5 |
No examples yet.
|
|
Packit |
dd4ba5 |
|
|
Packit |
dd4ba5 |
NVME
|
|
Packit |
dd4ba5 |
----
|
|
Packit |
dd4ba5 |
Part of the nvme-user suite
|