ioctl: rework nvme_dim_send command

Replace the struct args approach by providing init function for
initializing the passthru commands. This reduces the dependency between
callside and library.

Signed-off-by: Daniel Wagner <[email protected]>

Author: igaw

libnvme/src/libnvme.map

@@ -69,7 +69,6 @@ LIBNVME_2_0 {
 		nvme_ctrls_filter;
 		nvme_default_host;
 		nvme_describe_key_serial;
-		nvme_dim_send;
 		nvme_disconnect_ctrl;
 		nvme_dump_config;
 		nvme_dump_tree;

libnvme/src/nvme/api-types.h

@@ -143,24 +143,6 @@ struct nvme_copy_args {
 	__u64 ilbrt_u64;
 };
 
-/**
- * struct nvme_dim_args - Arguments for the Discovery Information Management (DIM) command
- * @result:	Set on completion to the command's CQE DWORD 0 controller response.
- * @data:	Pointer to the DIM data
- * @args_size:	Length of the structure
- * @timeout:	Timeout in ms
- * @data_len:	Length of @data
- * @tas:	Task field of the Command Dword 10 (cdw10)
- */
-struct nvme_dim_args {
-	__u32	*result;
-	void	*data;
-	int	args_size;
-	__u32	timeout;
-	__u32	data_len;
-	__u8	tas;
-};
-
 /**
  * struct nvme_lm_cdq_args - Arguments for Controller Data Queue (CDQ) command
  * @result:	Set on completion to the command's CQE DWORD 0 controller response

libnvme/src/nvme/fabrics.c

@@ -1596,18 +1596,13 @@ static int nvmf_dim(nvme_ctrl_t c, enum nvmf_dim_tas tas, __u8 trtype,
 {
 	struct nvme_global_ctx *ctx = c->s && c->s->h ? c->s->h->ctx : NULL;
 	_cleanup_free_ struct nvmf_dim_data *dim = NULL;
+	struct nvme_transport_handle *hdl = nvme_ctrl_get_transport_handle(c);
+	struct nvme_passthru_cmd cmd;
 	struct nvmf_ext_die  *die;
 	__u32 tdl;
 	__u32 tel;
 	int ret;
 
-	struct nvme_dim_args args = {
-		.args_size = sizeof(args),
-		.result = result,
-		.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
-		.tas = tas
-	};
-
 	if (!c->s) {
 		nvme_msg(ctx, LOG_ERR,
 			 "%s: failed to perform DIM. subsystem undefined.\n",
@@ -1673,9 +1668,8 @@ static int nvmf_dim(nvme_ctrl_t c, enum nvmf_dim_tas tas, __u8 trtype,
 	die = &dim->die->extended;
 	nvmf_fill_die(die, c->s->h, tel, trtype, adrfam, reg_addr, tsas);
 
-	args.data_len = tdl;
-	args.data = dim;
-	return nvme_dim_send(nvme_ctrl_get_transport_handle(c), &args);
+	nvme_init_dim_send(&cmd, tas, dim, tdl);
+	return nvme_submit_admin_passthru(hdl, &cmd, NULL);
 }
 
 /**

libnvme/src/nvme/ioctl.c

@@ -772,25 +772,6 @@ int nvme_copy(struct nvme_transport_handle *hdl, struct nvme_copy_args *args)
 	return nvme_submit_io_passthru(hdl, &cmd, args->result);
 }
 
-int nvme_dim_send(struct nvme_transport_handle *hdl, struct nvme_dim_args *args)
-{
-	__u32 cdw10 = NVME_SET(args->tas, DIM_TAS);
-
-	struct nvme_passthru_cmd  cmd = {
-		.opcode     = nvme_admin_discovery_info_mgmt,
-		.cdw10      = cdw10,
-		.addr       = (__u64)(uintptr_t)args->data,
-		.data_len   = args->data_len,
-		.timeout_ms = args->timeout,
-	};
-
-	if (args->args_size < sizeof(*args))
-		return -EINVAL;
-
-	return nvme_submit_admin_passthru(hdl, &cmd, args->result);
-}
-
-
 int nvme_lm_cdq(struct nvme_transport_handle *hdl, struct nvme_lm_cdq_args *args)
 {
 	__u32 cdw10 = NVME_SET(args->sel, LM_CDQ_SEL) |

libnvme/src/nvme/ioctl.h

@@ -329,7 +329,7 @@ enum nvme_cmd_dword_fields {
 	NVME_ZNS_MGMT_RECV_ZRA_SHIFT				= 0,
 	NVME_ZNS_MGMT_RECV_ZRA_MASK				= 0xff,
 	NVME_DIM_TAS_SHIFT					= 0,
-	NVME_DIM_TAS_MASK					= 0xF,
+	NVME_DIM_TAS_MASK					= 0xf,
 	NVME_DSM_CDW10_NR_SHIFT					= 0,
 	NVME_DSM_CDW10_NR_MASK					= 0xff,
 	NVME_DSM_CDW11_IDR_SHIFT				= 0,
@@ -5037,14 +5037,30 @@ nvme_init_zns_append(struct nvme_passthru_cmd64 *cmd, __u32 nsid,
 }
 
 /**
- * nvme_dim_send - Send a Discovery Information Management (DIM) command
- * @hdl:	Transport handle
- * @args:	&struct nvme_dim_args argument structure
+ * nvme_init_dim_send() - Initialize passthru command for
+ * Discovery Information Management (DIM) Send
+ * @cmd:	Passthru command to use
+ * @tas:	Task field of the Command Dword 10 (cdw10)
+ * @data:	Pointer to the DIM data buffer
+ * @len:	Length of @data
  *
- * Return: 0 on success, the nvme command status if a response was
- * received (see &enum nvme_status_field) or a negative error otherwise.
+ * Initializes the passthru command buffer for the Discovery Information
+ * Management Send command.
  */
-int nvme_dim_send(struct nvme_transport_handle *hdl, struct nvme_dim_args *args);
+static inline void
+nvme_init_dim_send(struct nvme_passthru_cmd *cmd,
+		__u8 tas, void *data, __u32 len)
+{
+	memset(cmd, 0, sizeof(*cmd));
+
+	cmd->opcode = nvme_admin_discovery_info_mgmt;
+	cmd->data_len = len;
+	cmd->addr = (__u64)(uintptr_t)data;
+	cmd->cdw10 = NVME_FIELD_ENCODE(tas,
+			NVME_DIM_TAS_SHIFT,
+			NVME_DIM_TAS_MASK);
+
+}
 
 /**
  * nvme_lm_cdq() - Controller Data Queue - Controller Data Queue command

libnvme/test/ioctl/misc.c

@@ -1321,29 +1321,24 @@ static void test_fdp_reclaim_unit_handle_update(void)
 
 static void test_dim_send(void)
 {
-	__u32 result = 0;
 	__u8 expected_data[8], data[8] = {};
-	struct nvme_dim_args args = {
-		.result = 0,
-		.data = &data,
-		.args_size = sizeof(args),
-		.data_len = sizeof(data),
-		.tas = 0xf,
-	};
-
+	__u32 data_len = sizeof(data);
+	__u32 result = 0;
+	__u8 tas = 0xf;
 	struct mock_cmd mock_admin_cmd = {
 		.opcode = nvme_admin_discovery_info_mgmt,
-		.cdw10 = args.tas,
-		.data_len = args.data_len,
+		.cdw10 = tas,
+		.data_len =data_len,
 		.in_data = &expected_data,
 	};
-
+	struct nvme_passthru_cmd cmd;
 	int err;
 
 	arbitrary(&expected_data, sizeof(expected_data));
 	memcpy(&data, &expected_data, sizeof(expected_data));
 	set_mock_admin_cmds(&mock_admin_cmd, 1);
-	err = nvme_dim_send(test_hdl, &args);
+	nvme_init_dim_send(&cmd, tas, data, data_len);
+	err = nvme_submit_admin_passthru(test_hdl, &cmd, &result);
 	end_mock_cmds();
 	check(err == 0, "returned error %d", err);
 	check(result == 0, "returned result %u", result);