| 1 |
.TH "libnvme" 9 "struct nvme_io_args" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nvme_io_args \- Arguments for NVMe I/O commands |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nvme_io_args { |
| 6 |
.br |
| 7 |
.BI " __u64 slba;" |
| 8 |
.br |
| 9 |
.BI " __u64 storage_tag;" |
| 10 |
.br |
| 11 |
.BI " __u32 *result;" |
| 12 |
.br |
| 13 |
.BI " void *data;" |
| 14 |
.br |
| 15 |
.BI " void *metadata;" |
| 16 |
.br |
| 17 |
.BI " int args_size;" |
| 18 |
.br |
| 19 |
.BI " int fd;" |
| 20 |
.br |
| 21 |
.BI " __u32 timeout;" |
| 22 |
.br |
| 23 |
.BI " __u32 nsid;" |
| 24 |
.br |
| 25 |
.BI " __u32 reftag;" |
| 26 |
.br |
| 27 |
.BI " __u32 data_len;" |
| 28 |
.br |
| 29 |
.BI " __u32 metadata_len;" |
| 30 |
.br |
| 31 |
.BI " __u16 nlb;" |
| 32 |
.br |
| 33 |
.BI " __u16 control;" |
| 34 |
.br |
| 35 |
.BI " __u16 apptag;" |
| 36 |
.br |
| 37 |
.BI " __u16 appmask;" |
| 38 |
.br |
| 39 |
.BI " __u16 dspec;" |
| 40 |
.br |
| 41 |
.BI " __u8 dsm;" |
| 42 |
.br |
| 43 |
.BI " __u8 rsvd1[1];" |
| 44 |
.br |
| 45 |
.BI " __u64 reftag_u64;" |
| 46 |
.br |
| 47 |
.BI " __u8 sts;" |
| 48 |
.br |
| 49 |
.BI " __u8 pif;" |
| 50 |
.br |
| 51 |
.BI " |
| 52 |
}; |
| 53 |
.br |
| 54 |
|
| 55 |
.SH Members |
| 56 |
.IP "slba" 12 |
| 57 |
Starting logical block |
| 58 |
.IP "storage_tag" 12 |
| 59 |
This filed specifies Variable Sized Expected Logical Block |
| 60 |
Storage Tag (ELBST) or Logical Block Storage Tag (LBST) |
| 61 |
.IP "result" 12 |
| 62 |
The command completion result from CQE dword0 |
| 63 |
.IP "data" 12 |
| 64 |
Pointer to user address of the data buffer |
| 65 |
.IP "metadata" 12 |
| 66 |
Pointer to user address of the metadata buffer |
| 67 |
.IP "args_size" 12 |
| 68 |
Size of \fIstruct nvme_io_args\fP |
| 69 |
.IP "fd" 12 |
| 70 |
File descriptor of nvme device |
| 71 |
.IP "timeout" 12 |
| 72 |
Timeout in ms |
| 73 |
.IP "nsid" 12 |
| 74 |
Namespace ID |
| 75 |
.IP "reftag" 12 |
| 76 |
This field specifies the variable sized Expected Initial |
| 77 |
Logical Block Reference Tag (EILBRT) or Initial Logical Block |
| 78 |
Reference Tag (ILBRT). Used only if the namespace is formatted |
| 79 |
to use end-to-end protection information. |
| 80 |
.IP "data_len" 12 |
| 81 |
Length of user buffer, \fIdata\fP, in bytes |
| 82 |
.IP "metadata_len" 12 |
| 83 |
Length of user buffer, \fImetadata\fP, in bytes |
| 84 |
.IP "nlb" 12 |
| 85 |
Number of logical blocks to send (0's based value) |
| 86 |
.IP "control" 12 |
| 87 |
Command control flags, see \fIenum nvme_io_control_flags\fP. |
| 88 |
.IP "apptag" 12 |
| 89 |
This field specifies the Application Tag Mask expected value. |
| 90 |
Used only if the namespace is formatted to use end-to-end |
| 91 |
protection information. |
| 92 |
.IP "appmask" 12 |
| 93 |
This field specifies the Application Tag expected value. Used |
| 94 |
only if the namespace is formatted to use end-to-end protection |
| 95 |
information. |
| 96 |
.IP "dspec" 12 |
| 97 |
Directive specific value |
| 98 |
.IP "dsm" 12 |
| 99 |
Data set management attributes, see \fIenum nvme_io_dsm_flags\fP |
| 100 |
.IP "rsvd1" 12 |
| 101 |
Reserved |
| 102 |
.IP "reftag_u64" 12 |
| 103 |
This field specifies the variable sized Expected Initial |
| 104 |
Logical Block Reference Tag (EILBRT) or Initial Logical Block |
| 105 |
Reference Tag (ILBRT). It is the 8 byte version required for |
| 106 |
enhanced protection information. Used only if the namespace is |
| 107 |
formatted to use end-to-end protection information. |
| 108 |
.IP "sts" 12 |
| 109 |
Storage tag size in bits, set by namespace Extended LBA Format |
| 110 |
.IP "pif" 12 |
| 111 |
Protection information format, determines how variable sized |
| 112 |
storage_tag and reftag are put into dwords 2, 3, and 14. Set by |
| 113 |
namespace Extended LBA Format. |