ioctl: rework nvme_lm_migration_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

@@ -139,7 +139,6 @@ LIBNVME_2_0 {
 		nvme_ipaddrs_eq;
 		nvme_lm_get_features_ctrl_data_queue;
 		nvme_lm_migration_recv;
-		nvme_lm_migration_send;
 		nvme_lm_set_features_ctrl_data_queue;
 		nvme_lookup_ctrl;
 		nvme_lookup_host;

libnvme/src/nvme/api-types.h

@@ -143,53 +143,6 @@ struct nvme_copy_args {
 	__u64 ilbrt_u64;
 };
 
-/**
- * struct nvme_lm_migration_send_args - Arguments for the Migration Send command
- * @offset:	Offset: This field specifies the offset, in bytes, within the data available to be
- *		returned and specifies the starting point for that data for what is actually
- *		returned to the host.
- * @result:	Set on completion to the command's CQE DWORD 0 controller response
- * @data:	Pointer to data
- * @args_size:	Length of structure
- * @timeout:	Timeout in ms
- * @numd:	Number of Dwords (NUMD): This field specifies the number of dwords being transferred
- * @mos:	Management Operation Specific (MOS): This field is specific to the SEL type
- * @cntlid:	Controller ID: This field specifies the identifier of the controller to which the
- *		operation is performed.
- * @csuuidi:	Controller State UUID Index (CSUUIDI): A non-zero value in this field specifies the
- *		index to a specific entry in the Vendor Specific Controller State UUID Supported.
- *		list of the Supported Controller State Formats data structure.
- * @sel:	Select (SEL): This field specifies the type of management operation to perform.
- * @uidx:	UUID Index (UIDX): If this field is set to a non-zero value, then the value of this
- *		field is the index of a UUID in the UUID List (refer to Figure 320) that is used by
- *		the command.
- * @stype:	Suspend Type (STYPE): This field specifies the type of suspend.
- * @seqind:	Sequence Identifier (SEQIND): This field identified the sequences of this Migration
- *		Send command in relation to other Migration Send commands.
- * @csvi:	Controller State Version Index (CSVI): A non-zero value in this field specifies the
- *		index to a specific entry in the NVMe Controller State Version list of the Supported
- *		Controller State Formats data structure.
- * @dudmq:	Delete User Data Migration Queue (DUDMQ): If set, the migration queue is deleted
- *		is deleted as part of the Suspend operation. If cleared, it is retained.
- */
-struct nvme_lm_migration_send_args {
-	__u64	offset;
-	__u32	*result;
-	void	*data;
-	int	args_size;
-	__u32	timeout;
-	__u32	numd;
-	__u16	mos;
-	__u16	cntlid;
-	__u16	csuuidi;
-	__u8	sel;
-	__u8	uidx;
-	__u8	stype;
-	__u8	seqind;
-	__u8	csvi;
-	bool	dudmq;
-};
-
 /**
  * struct nvme_lm_migration_recv_args - Arguments for the Migration Receive command
  * @offset:	Offset: This field specifies the offset, in bytes, within the data available to be

libnvme/src/nvme/ioctl.c

@@ -772,44 +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_lm_migration_send(struct nvme_transport_handle *hdl, struct nvme_lm_migration_send_args *args)
-{
-	__u32 cdw10 = NVME_SET(args->sel, LM_MIGRATION_SEND_SEL) |
-		      NVME_SET(args->mos, LM_MIGRATION_SEND_MOS);
-	__u32 cdw11 = 0;
-
-	if (args->sel == NVME_LM_SEL_SUSPEND) {
-		cdw11 = NVME_SET(args->stype, LM_STYPE) |
-			NVME_SET(args->cntlid, LM_SUSPEND_CNTLID);
-		if (args->dudmq)
-			cdw11 |= NVME_LM_DUDMQ;
-	} else if (args->sel == NVME_LM_SEL_RESUME) {
-		cdw11 = NVME_SET(args->cntlid, LM_RESUME_CNTLID);
-	} else if (args->sel == NVME_LM_SEL_SET_CONTROLLER_STATE) {
-		cdw11 = NVME_SET(args->csuuidi, LM_SET_CONTROLLER_STATE_CSUUIDI) |
-			NVME_SET(args->csvi, LM_SET_CONTROLLER_STATE_CSVI) |
-			NVME_SET(args->cntlid, LM_SET_CONTROLLER_STATE_CNTLID);
-	}
-
-	struct nvme_passthru_cmd cmd = {
-		.opcode = nvme_admin_migration_send,
-		.cdw10 = cdw10,
-		.cdw11 = cdw11,
-		.cdw12 = (__u32)args->offset,
-		.cdw13 = (__u32)(args->offset >> 32),
-		.cdw14 = NVME_SET(args->uidx, LM_MIGRATION_SEND_UIDX),
-		.cdw15 = args->numd,
-		.addr = (__u64)(uintptr_t)args->data,
-		.data_len = args->numd << 2,
-		.timeout_ms = args->timeout,
-	};
-
-	if (args->args_size < sizeof(*args))
-		return -EINVAL;
-
-	return nvme_submit_admin_passthru(hdl, &cmd, args->result);
-}
-
 int nvme_lm_migration_recv(struct nvme_transport_handle *hdl, struct nvme_lm_migration_recv_args *args)
 {
 	__u32 cdw10 = NVME_SET(args->sel, LM_MIGRATION_RECV_SEL) |

libnvme/src/nvme/ioctl.h

@@ -5166,14 +5166,83 @@ nvme_init_lm_track_send(struct nvme_passthru_cmd *cmd,
 }
 
 /**
- * nvme_lm_migration_send() - Migration Send command
- * @hdl:	Transport handle
- * @args:	&struct nvme_lm_migration_send_args argument structure
+ * nvme_init_lm_migration_send() - Initialize passthru command for
+ * Migration Send command
+ * @cmd:	Passthru command to use
+ * @sel:	Select (SEL): This field specifies the type of management
+ *		operation to perform.
+ * @mos:	Management Operation Specific (MOS): This field is specific
+ *		to the SEL type
+ * @cntlid:	Controller ID: This field specifies the identifier of the
+ *		controller to which the operation is performed.
+ * @stype:	Suspend Type (STYPE): This field specifies the type of suspend.
+ * @dudmq:	Delete User Data Migration Queue (DUDMQ): If set, the migration
+ *		queue is deleted is deleted as part of the Suspend operation.
+ * @csvi:	Controller State Version Index (CSVI)
+ * @csuuidi:	Controller State UUID Index (CSUUIDI)
+ * @cso:	Offset: This field specifies the offset, in bytes, within
+ *		the data available to be returned and specifies the starting
+ *		point for that data for what is actually returned to the host.
+ * @uidx:	UUID Index (UIDX)
+ * @data:	Pointer to 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 Migration Send command.
  */
-int nvme_lm_migration_send(struct nvme_transport_handle *hdl, struct nvme_lm_migration_send_args *args);
+static inline void
+nvme_init_lm_migration_send(struct nvme_passthru_cmd *cmd,
+		__u16 sel, __u16 mos, __u16 cntlid, __u8 stype, bool dudmq,
+		__u8 csvi, __u16 csuuidi, __u64 cso, __u8 uidx,
+		void *data, __u32 len)
+{
+	__u32 cdw10 = NVME_FIELD_ENCODE(sel,
+			NVME_LM_MIGRATION_SEND_SEL_SHIFT,
+			NVME_LM_MIGRATION_SEND_SEL_MASK) |
+		      NVME_FIELD_ENCODE(mos,
+			NVME_LM_MIGRATION_SEND_MOS_SHIFT,
+			NVME_LM_MIGRATION_SEND_MOS_MASK);
+	__u32 cdw11 = 0;
+	__u32 cdw14 = NVME_FIELD_ENCODE(uidx,
+			NVME_LM_MIGRATION_SEND_UIDX_SHIFT,
+			NVME_LM_MIGRATION_SEND_UIDX_MASK);
+
+	if (sel == NVME_LM_SEL_SUSPEND) {
+		cdw11 = NVME_FIELD_ENCODE(stype,
+				NVME_LM_STYPE_SHIFT,
+				NVME_LM_STYPE_MASK) |
+			NVME_FIELD_ENCODE(cntlid,
+				NVME_LM_SUSPEND_CNTLID_SHIFT,
+				NVME_LM_SUSPEND_CNTLID_MASK);
+		if (dudmq)
+			cdw11 |= NVME_LM_DUDMQ;
+	} else if (sel == NVME_LM_SEL_RESUME) {
+		cdw11 = NVME_FIELD_ENCODE(cntlid,
+				NVME_LM_RESUME_CNTLID_SHIFT,
+				NVME_LM_RESUME_CNTLID_MASK);
+	} else if (sel == NVME_LM_SEL_SET_CONTROLLER_STATE) {
+		cdw11 = NVME_FIELD_ENCODE(csuuidi,
+				NVME_LM_SET_CONTROLLER_STATE_CSUUIDI_SHIFT,
+				NVME_LM_SET_CONTROLLER_STATE_CSUUIDI_MASK) |
+			NVME_FIELD_ENCODE(csvi,
+				NVME_LM_SET_CONTROLLER_STATE_CSVI_SHIFT,
+				NVME_LM_SET_CONTROLLER_STATE_CSVI_MASK) |
+			NVME_FIELD_ENCODE(cntlid,
+				NVME_LM_SET_CONTROLLER_STATE_CNTLID_SHIFT,
+				NVME_LM_SET_CONTROLLER_STATE_CNTLID_MASK);
+	}
+
+	memset(cmd, 0, sizeof(*cmd));
+
+	cmd->opcode = nvme_admin_migration_send;
+	cmd->data_len = len;
+	cmd->addr = (__u64)(uintptr_t)data;
+	cmd->cdw10 = cdw10;
+	cmd->cdw11 = cdw11;
+	cmd->cdw12 = (__u32)cso;
+	cmd->cdw13 = (__u32)(cso >> 32);
+	cmd->cdw14 = cdw14;
+	cmd->cdw15 = len / sizeof(__u32);
+}
 
 /**
  * nvme_lm_migration_recv - Migration Receive command

libnvme/test/ioctl/misc.c

@@ -1399,43 +1399,38 @@ static void test_lm_track_send(void)
 
 static void test_lm_migration_send(void)
 {
-	__u32 result = 0;
 	__u32 expected_data[8], data[8] = {};
-	struct nvme_lm_migration_send_args args = {
-		.offset = 0xffffffffff,
-		.result = 0,
-		.data = &expected_data,
-		.args_size = sizeof(args),
-		.numd = 8 - 1,
-		.mos = 0x1,
-		.cntlid = 0x2,
-		.csuuidi = 0x3,
-		.sel = NVME_LM_SEL_RESUME,
-		.uidx = 0x4,
-		.stype = 0x5,
-		.seqind = 0x6,
-		.csvi = 0x7,
-		.dudmq = true,
-	};
-
+	__u8 sel = NVME_LM_SEL_RESUME;
+	__u64 offset = 0xffffffffff;
+	__u32 numd = 8;
+	__u16 cntlid = 0x2;
+	__u32 result = 0;
+	__u16 mos = 0x1;
+	__u8 uidx = 0x4;
+	__u8 stype = 0x1;
+	__u8 csvi = 0x2;
+	__u16 csuuidi = 0x13;
+	bool dudmq = false;
 	struct mock_cmd mock_admin_cmd = {
 		.opcode = nvme_admin_migration_send,
-		.cdw10 = args.sel | (args.mos << 16),
-		.cdw11 = args.cntlid,
-		.cdw12 = (__u32)args.offset,
-		.cdw13 = (__u32)(args.offset >> 32),
-		.cdw14 = args.uidx,
-		.cdw15 = args.numd,
-		.data_len = args.numd << 2,
-		.in_data = &data,
+		.cdw10 = sel | (mos << 16),
+		.cdw11 = cntlid,
+		.cdw12 = (__u32)offset,
+		.cdw13 = (__u32)(offset >> 32),
+		.cdw14 = uidx,
+		.cdw15 = numd,
+		.data_len = numd << 2,
+		.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_lm_migration_send(test_hdl, &args);
+	nvme_init_lm_migration_send(&cmd, sel, mos, cntlid, stype, dudmq,
+		csvi, csuuidi, offset, uidx, &data, sizeof(data));
+	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);