NVME-COMPARE(1) | NVMe Manual | NVME-COMPARE(1) |
nvme-compare - Send an NVMe Compare command, provide results
nvme-compare <device> [--start-block=<slba> | -s <slba>]
[--block-count=<nlb> | -c <nlb>]
[--data-size=<size> | -z <size>]
[--metadata-size=<metasize> | -y <metasize>]
[--ref-tag=<reftag> | -r <reftag>]
[--data=<data-file> | -d <data-file>]
[--metadata=<meta> | -M <meta>]
[--prinfo=<prinfo> | -p <prinfo>]
[--app-tag-mask=<appmask> | -m <appmask>]
[--app-tag=<apptag> | -a <apptag>]
[--limited-retry | -l]
[--force-unit-access | -f]
[--dir-type=<type> | -T <type>]
[--dir-spec=<spec> | -S <spec>]
[--dsm=<dsm> | -D <dsm>]
[--show-command | -v]
[--dry-run | -w]
[--latency | -t]
[--storage-tag<storage-tag> | -g <storage-tag>]
[--storage-tag-check<storage-tag-check> | -C <storage-tag-check>]
[--force]
The Compare command reads the logical blocks specified by the command from the medium and compares the data read to a comparison data buffer transferred as part of the command. If the data read from the controller and the comparison data buffer are equivalent with no miscompares, then the command completes successfully. If there is any miscompare, the command completes with an error of Compare Failure. If metadata is provided, then a comparison is also performed for the metadata.
-s <slba>, --start-block=<slba>
-c <nlb>, --block-count=<nlb>
-z <size>, --data-size=<size>
-y <metasize>, --metadata-size=<metasize>
-r <reftag>, --ref-tag=<reftag>
-d <data-file>, --data=<data-file>
-M <meta>, --metadata=<meta>
-p <prinfo>, --prinfo=<prinfo>
+
Bit | Description |
3 | PRACT: Protection Information Action. When set to 1, PI is stripped/inserted on read/write when the block format’s metadata size is 8. When set to 0, metadata is passes. |
2:0 | PRCHK: Protection Information Check: |
2 | Set to 1 enables checking the guard tag |
1 | Set to 1 enables checking the application tag |
0 | Set to 1 enables checking the reference tag |
-m <appmask>, --app-tag-mask=<appmask>
-a <apptag>, --app-tag=<apptag>
-l, --limited-retry
-f, --force-unit-access
-T <type>, --dir-type=<type>
-S <spec>, --dir-spec=<spec>
-D <dsm>, --dsm=<dsm>
-v, --show-cmd
-w, --dry-run
-t, --latency
--storage-tag=<storage-tag>, -g <storage-tag>
--storage-tag-check=<storage-tag-check>, -C <storage-tag-check>
--force
No examples yet.
Part of the nvme-user suite
04/15/2023 | NVMe |