12#ifndef _PACKET_NVME_H_
13#define _PACKET_NVME_H_
15#define NVME_CMD_SIZE 64
16#define NVME_CQE_SIZE 16
18#define NVME_FABRIC_OPC 0x7F
19#define NVME_FCTYPE_PROP_SET 0x0
20#define NVME_FCTYPE_CONNECT 0x1
21#define NVME_FCTYPE_PROP_GET 0x4
22#define NVME_FCTYPE_AUTH_SEND 0x5
23#define NVME_FCTYPE_AUTH_RECV 0x6
24#define NVME_FCTYPE_DISCONNECT 0x8
27#define NVME_AQ_OPC_DELETE_SQ 0x00
28#define NVME_AQ_OPC_CREATE_SQ 0x01
29#define NVME_AQ_OPC_GET_LOG_PAGE 0x02
30#define NVME_AQ_OPC_DELETE_CQ 0x04
31#define NVME_AQ_OPC_CREATE_CQ 0x05
32#define NVME_AQ_OPC_IDENTIFY 0x06
33#define NVME_AQ_OPC_ABORT 0x08
34#define NVME_AQ_OPC_SET_FEATURES 0x09
35#define NVME_AQ_OPC_GET_FEATURES 0x0a
36#define NVME_AQ_OPC_ASYNC_EVE_REQ 0x0c
37#define NVME_AQ_OPC_NS_MGMT 0x0d
38#define NVME_AQ_OPC_FW_COMMIT 0x10
39#define NVME_AQ_OPC_FW_IMG_DOWNLOAD 0x11
40#define NVME_AQ_OPC_SELF_TEST 0x14
41#define NVME_AQ_OPC_NS_ATTACH 0x15
42#define NVME_AQ_OPC_KEEP_ALIVE 0x18
43#define NVME_AQ_OPC_DIRECTIVE_SEND 0x19
44#define NVME_AQ_OPC_DIRECTIVE_RECV 0x1a
45#define NVME_AQ_OPC_VIRT_MGMT 0x1c
46#define NVME_AQ_OPC_MI_SEND 0x1d
47#define NVME_AQ_OPC_MI_RECV 0x1e
48#define NVME_AQ_OPC_CAP_MGMT 0x20
49#define NVME_AQ_OPC_DISC_INFO_MGMT 0x21
50#define NVME_AQ_OPC_FABRIC_ZONING_RECV 0x22
51#define NVME_AQ_OPC_LOCKDOWN 0x24
52#define NVME_AQ_OPC_FABRIC_ZONING_LOOKUP 0x25
53#define NVME_AQ_OPC_CLEAR_EXP_NVM_CFG 0x28
54#define NVME_AQ_OPC_FABRIC_ZONING_SEND 0x29
55#define NVME_AQ_OPC_CREATE_EXP_NVM_SUBSYS 0x2a
56#define NVME_AQ_OPC_MANAGE_EXP_NVM_SUBSYS 0x2d
57#define NVME_AQ_OPC_MANAGE_EXP_NS 0x31
58#define NVME_AQ_OPC_MANAGE_EXP_PORT 0x35
59#define NVME_AQ_OPC_CROSS_CTRL_RESET 0x38
60#define NVME_AQ_OPC_SEND_DISC_LOG_PAGE 0x39
61#define NVME_AQ_OPC_TRACK_SEND 0x3d
62#define NVME_AQ_OPC_TRACK_RECV 0x3e
63#define NVME_AQ_OPC_MIGRATION_SEND 0x41
64#define NVME_AQ_OPC_MIGRATION_RECV 0x42
65#define NVME_AQ_OPC_CTRL_DATA_QUEUE 0x45
66#define NVME_AQ_OPC_DBBUF_CONFIG 0x7c
67#define NVME_AQ_OPC_FORMAT_NVM 0x80
68#define NVME_AQ_OPC_SECURITY_SEND 0x81
69#define NVME_AQ_OPC_SECURITY_RECV 0x82
70#define NVME_AQ_OPC_SANITIZE 0x84
71#define NVME_AQ_OPC_LOAD_PROGRAM 0x85
72#define NVME_AQ_OPC_GET_LBA_STATUS 0x86
73#define NVME_AQ_OPC_PROG_ACTIVATION_MGMT 0x88
74#define NVME_AQ_OPC_MEM_RANGE_SET_MGMT 0x89
75#define NVME_AQ_OPC_SANITIZE_NS 0x8c
77#define NVME_IDENTIFY_CNS_IDENTIFY_NS 0x0
78#define NVME_IDENTIFY_CNS_IDENTIFY_CTRL 0x1
79#define NVME_IDENTIFY_CNS_IDENTIFY_NSLIST 0x2
80#define NVME_IDENTIFY_CNS_NSID_DESC_LIST 0x3
81#define NVME_IDENTIFY_CNS_NVM_SET_LIST 0x4
82#define NVME_IDENTIFY_CNS_CS_IND_NS 0x8
83#define NVME_IDENTIFY_CNS_NS_ALLOC_LIST 0x10
84#define NVME_IDENTIFY_CNS_NS_ALLOC 0x11
85#define NVME_IDENTIFY_CNS_CTRL_LIST_NS 0x12
86#define NVME_IDENTIFY_CNS_CTRL_LIST 0x13
87#define NVME_IDENTIFY_CNS_PRI_CTRL_CAP 0x14
88#define NVME_IDENTIFY_CNS_SEC_CTRL_LIST 0x15
89#define NVME_IDENTIFY_CNS_NS_GRAN_LIST 0x16
90#define NVME_IDENTIFY_CNS_UUID_LIST 0x17
95enum nvme_data_provenance {
96 NVME_DATA_PROV_NONE = 0,
97 NVME_DATA_PROV_RESPONSE,
101enum nvme_data_window {
102 NVME_DATA_WINDOW_UNKNOWN = 0,
103 NVME_DATA_WINDOW_TRACKED,
104 NVME_DATA_WINDOW_EXPLICIT,
108enum nvme_data_direction {
109 NVME_DATA_DIR_HOST_TO_CONTROLLER,
110 NVME_DATA_DIR_CONTROLLER_TO_HOST,
115 enum nvme_data_provenance prov;
116 enum nvme_data_window window;
122#define NVME_DATA_ORIGIN_NONE ((struct nvme_data_origin){ \
123 .prov = NVME_DATA_PROV_NONE, .window = NVME_DATA_WINDOW_UNKNOWN })
124#define NVME_DATA_ORIGIN_TRACKED ((struct nvme_data_origin){ \
125 .prov = NVME_DATA_PROV_RESPONSE, .window = NVME_DATA_WINDOW_TRACKED })
136bool nvme_admin_opcode_is_reserved(uint8_t opcode);
139 NVME_FEAT_XFER_UNKNOWN,
146enum nvme_feat_xfer nvme_feature_transfer(uint8_t fid,
bool get, uint8_t sel,
147 uint32_t cdw11, uint32_t cdw13,
152bool nvme_data_tree_has_fields(proto_tree *tree);
154#define NVME_CMD_MAX_TRS (16)
157 uint32_t cmd_pkt_num;
158 uint32_t cqe_pkt_num;
160 uint32_t data_req_pkt_num;
161 uint32_t data_tr_pkt_num[NVME_CMD_MAX_TRS];
162 uint32_t first_tr_psn;
180 unsigned tr_sub_entries;
183 uint32_t tr_next_off;
207 uint8_t response_count;
208 bool response_count_valid;
247extern int hf_nvmeof_cmd_pkt;
248extern int hf_nvmeof_data_req;
250const char *get_nvmeof_cmd_string(uint8_t fctype);
253nvme_publish_qid(proto_tree *tree,
int field_index, uint16_t qid);
256nvme_publish_cmd_latency(proto_tree *tree,
struct nvme_cmd_ctx *cmd_ctx,
259nvme_publish_to_cmd_link(proto_tree *tree, tvbuff_t *tvb,
262nvme_publish_to_cqe_link(proto_tree *tree, tvbuff_t *tvb,
265nvme_publish_to_data_req_link(proto_tree *tree, tvbuff_t *tvb,
268nvme_publish_to_data_resp_link(proto_tree *tree, tvbuff_t *tvb,
271nvme_publish_link(proto_tree *tree, tvbuff_t *tvb,
int hf_index,
272 uint32_t pkt_no,
bool zero_ok);
279 void *ctx, uint16_t cmd_id);
280void* nvme_lookup_cmd_in_pending_list(
struct nvme_q_ctx *q_ctx, uint16_t cmd_id);
290dissect_nvmeof_fabric_cmd(tvbuff_t *nvme_tvb,
packet_info *pinfo, proto_tree *nvme_tree,
293dissect_nvmeof_cmd_data(tvbuff_t *data_tvb,
packet_info *pinfo, proto_tree *data_tree,
296dissect_nvmeof_fabric_cqe(tvbuff_t *nvme_tvb,
packet_info *pinfo,
297 proto_tree *nvme_tree,
309 struct nvme_cmd_ctx *cmd_ctx, uint32_t rkey, uint32_t frame_num);
311nvme_lookup_data_tr_pkt(
struct nvme_q_ctx *q_ctx,
312 uint32_t rkey, uint32_t frame_num);
315nvme_add_data_tr_off(
struct nvme_q_ctx *q_ctx, uint32_t off, uint32_t frame_num);
318nvme_lookup_data_tr_off(
struct nvme_q_ctx *q_ctx, uint32_t frame_num);
321nvme_add_cmd_cqe_to_done_list(
struct nvme_q_ctx *q_ctx,
325 uint16_t cmd_id,
bool is_cqe);
327void dissect_nvme_cmd_sgl(tvbuff_t *cmd_tvb, proto_tree *cmd_tree,
int field_index,
331dissect_nvme_cmd(tvbuff_t *nvme_tvb,
packet_info *pinfo, proto_tree *root_tree,
337dissect_nvme_data_response(tvbuff_t *nvme_tvb,
packet_info *pinfo, proto_tree *root_tree,
342dissect_nvme_cqe(tvbuff_t *nvme_tvb,
packet_info *pinfo, proto_tree *root_tree,
350nvme_get_opcode_string(uint8_t opcode, uint16_t qid);
354nvme_get_admin_opcode_string(uint8_t opcode, uint8_t csi);
362nvme_dissect_admin_sqe_cdws(tvbuff_t *sqe_tvb,
packet_info *pinfo,
368nvme_dissect_admin_cqe_dw0(tvbuff_t *nvme_tvb,
int dw0_off, proto_tree *cqe_tree,
374nvme_dissect_admin_cqe_dw1(tvbuff_t *nvme_tvb,
int dw1_off, proto_tree *cqe_tree,
380nvme_dissect_cqe_status(tvbuff_t *nvme_tvb,
packet_info *pinfo, proto_tree *cqe_tree,
381 unsigned status_off,
bool nvmeof);
387nvme_dissect_admin_cqe_status(tvbuff_t *nvme_tvb,
packet_info *pinfo, proto_tree *cqe_tree,
388 unsigned status_off, uint8_t opcode);
407nvme_security_info_of(const struct
nvme_cmd_ctx *cmd_ctx,
bool send)
411 .secp = cmd_ctx->cmd_ctx.security.secp,
412 .spsp = cmd_ctx->cmd_ctx.security.spsp,
413 .xfer_len = cmd_ctx->cmd_ctx.security.xfer_len,
414 .scope = cmd_ctx->cmd_ctx.security.scope,
415 .controller = cmd_ctx->cmd_ctx.security.controller,
416 .state_valid = cmd_ctx->cmd_ctx.security.state_valid,
427nvme_dissect_admin_data_resp(tvbuff_t *nvme_tvb,
packet_info *pinfo,
429 unsigned off,
unsigned len,
431 enum nvme_data_direction dir);
436nvme_cmd_implies_admin_queue(tvbuff_t *tvb,
unsigned off);
440unsigned nvme_dissect_controller_list(tvbuff_t *tvb,
packet_info *pinfo,
441 proto_tree *tree,
unsigned off,
unsigned len,
int hf_count,
int hf_id);
struct _packet_info packet_info
Represents the metadata and indexing information for a single captured frame.
struct _wmem_tree_t wmem_tree_t
Opaque type representing a red-black tree in the wmem system.
Definition wmem_tree.h:49
Definition packet-nvme.h:283
Definition packet-nvme.h:156
Definition packet-nvme.h:114
Definition packet-nvme.h:127
Definition packet-nvme.h:393
struct _value_string value_string
Mapping between a 32-bit integer value and its string representation.