1NVME-WRITE(1)                     NVMe Manual                    NVME-WRITE(1)
2
3
4

NAME

6       nvme-write - Send an NVMe write command, provide results
7

SYNOPSIS

9       nvme-write <device> [--start-block=<slba> | -s <slba>]
10                               [--block-count=<nlb> | -c <nlb>]
11                               [--data-size=<size> | -z <size>]
12                               [--metadata-size=<size> | -y <size>]
13                               [--ref-tag=<reftag> | -r <reftag>]
14                               [--data=<data-file> | -d <data-file>]
15                               [--metadata=<metadata-file> | -M <metadata-file>]
16                               [--prinfo=<prinfo> | -p <prinfo>]
17                               [--app-tag-mask=<appmask> | -m <appmask>]
18                               [--app-tag=<apptag> | -a <apptag>]
19                               [--limited-retry | -l]
20                               [--force-unit-access | -f]
21                               [--dir-type=<type> | -T <type>]
22                               [--dir-spec=<spec> | -S <spec>]
23                               [--dsm=<dsm> | -D <dsm>]
24                               [--show-command | -v]
25                               [--dry-run | -w]
26                               [--latency | -t]
27

DESCRIPTION

29       The Write command writes the logical blocks specified by the command to
30       the medium from the data data buffer provided. Will use stdin by
31       default if you don’t provide a file.
32

OPTIONS

34       --start-block=<slba>, -s <slba>
35           Start block.
36
37       --block-count, -c
38           The number of blocks to transfer. This is a zeroes based value to
39           align with the kernel’s use of this field. (ie. 0 means transfer 1
40           block).
41
42       --data-size=<size>, -z <size>
43           Size of data, in bytes.
44
45       --metadata-size=<size>, -y <size>
46           Size of metadata in bytes.
47
48       --data=<data-file>, -d <data-file>
49           Data file. If none provided, contents are sent from STDIN.
50
51       --metadata=<metadata-file>, -M <metadata-file>
52           Metadata file, if necessary.
53
54       --prinfo=<prinfo>, -p <prinfo>
55           Protection Information field definition.
56
57           ┌────┬────────────────────────────┐
58           │Bit │ Description                │
59           ├────┼────────────────────────────┤
60           │3   │ PRACT: Protection          │
61           │    │ Information Action. When   │
62           │    │ set to 1, PI is            │
63           │    │ stripped/inserted on       │
64           │    │ read/write when the block  │
65           │    │ format’s metadata size is  │
66           │    │ 8. When set to 0, metadata │
67           │    │ is passes.                 │
68           ├────┼────────────────────────────┤
69           │2:0 │ PRCHK: Protection          │
70           │    │ Information Check:         │
71           ├────┼────────────────────────────┤
72           │2   │ Set to 1 enables checking  │
73           │    │ the guard tag              │
74           ├────┼────────────────────────────┤
75           │1   │ Set to 1 enables checking  │
76           │    │ the application tag        │
77           ├────┼────────────────────────────┤
78           │0   │ Set to 1 enables checking  │
79           │    │ the reference tag          │
80           └────┴────────────────────────────┘
81
82       --ref-tag=<reftag>, -r <reftag>
83           Optional reftag when used with protection information.
84
85       --app-tag-mask=<appmask>, -m <appmask>
86           Optional application tag mask when used with protection
87           information.
88
89       --app-tag=<apptag>, -a <apptag>
90           Optional application tag when used with protection information.
91
92       --limited-retry, -l
93           Sets the limited retry flag.
94
95       --force-unit-access, -f
96           Set the force-unit access flag.
97
98       -T <type>, --dir-type=<type>
99           Optional directive type. The nvme-cli only enforces the value be in
100           the defined range for the directive type, though the NVMe
101           specifcation (1.3a) defines only one directive, 01h, for write
102           stream idenfiers.
103
104       -S <spec>, --dir-spec=<spec>
105           Optional field for directive specifics. When used with write
106           streams, this value is defined to be the write stream identifier.
107           The nvme-cli will not validate the stream requested is within the
108           controller’s capabilities.
109
110       -D <dsm>, --dsm=<dsm>
111           The optional data set management attributes for this command. The
112           argument for this is the lower 16 bits of the DSM field in a write
113           command; the upper 16 bits of the field come from the directive
114           specific field, if used. This may be used to set attributes for the
115           LBAs being written, like access frequency, type, latency, among
116           other things, as well as yet to be defined types. Please consult
117           the NVMe specification for detailed breakdown of how to use this
118           field.
119
120       -v, --show-cmd
121           Print out the command to be sent.
122
123       -w, --dry-run
124           Do not actually send the command. If want to use --dry-run option,
125           --show-cmd option must be set. Otherwise --dry-run option will be
126           ignored.
127
128       -t, --latency
129           Print out the latency the IOCTL took (in us).
130

EXAMPLES

132       No examples yet.
133

NVME

135       Part of the nvme-user suite
136
137
138
139NVMe                              01/07/2020                     NVME-WRITE(1)
Impressum