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

@@ -138,7 +138,6 @@ LIBNVME_2_0 {
 		nvme_io_passthru;
 		nvme_ipaddrs_eq;
 		nvme_lm_get_features_ctrl_data_queue;
-		nvme_lm_migration_recv;
 		nvme_lm_set_features_ctrl_data_queue;
 		nvme_lookup_ctrl;
 		nvme_lookup_host;

libnvme/src/nvme/api-types.h

@@ -143,44 +143,4 @@ struct nvme_copy_args {
 	__u64 ilbrt_u64;
 };
 
-/**
- * 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
- *		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
- * @fd:		File descriptor of nvme device
- * @timeout:	Timeout in ms
- * @numd:	Number of Dwords (NUMD): This field specifies the number of dwords to return. This
- *		is a 0's based value.
- * @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.
- * @csuidxp:	Controller State UUID Index Parameter (CSUIDXP): This field is vendor specific.
- */
-struct nvme_lm_migration_recv_args {
-	__u64	offset;
-	__u32	*result;
-	void	*data;
-	int	args_size;
-	int	fd;
-	__u32	timeout;
-	__u32	numd;
-	__u16	mos;
-	__u16	cntlid;
-	__u16	csuuidi;
-	__u8	sel;
-	__u8	uidx;
-	__u8	csuidxp;
-};
-
 #endif /* _LIBNVME_API_TYPES_H */

libnvme/src/nvme/ioctl.c

@@ -772,38 +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_recv(struct nvme_transport_handle *hdl, struct nvme_lm_migration_recv_args *args)
-{
-	__u32 cdw10 = NVME_SET(args->sel, LM_MIGRATION_RECV_SEL) |
-		      NVME_SET(args->mos, LM_MIGRATION_RECV_MOS);
-	__u32 cdw11 = 0, data_len = 0;
-
-	if (args->sel == NVME_LM_SEL_GET_CONTROLLER_STATE) {
-		cdw11 = NVME_SET(args->csuidxp, LM_GET_CONTROLLER_STATE_CSUIDXP) |
-			NVME_SET(args->csuuidi, LM_GET_CONTROLLER_STATE_CSUUIDI) |
-			NVME_SET(args->cntlid, LM_GET_CONTROLLER_STATE_CNTLID);
-		data_len = (args->numd + 1 /*0's based*/) << 2;
-	}
-
-	struct nvme_passthru_cmd cmd = {
-		.opcode = nvme_admin_migration_receive,
-		.cdw10 = cdw10,
-		.cdw11 = cdw11,
-		.cdw12 = (__u32)args->offset,
-		.cdw13 = (__u32)(args->offset >> 32),
-		.cdw14 = NVME_SET(args->uidx, LM_MIGRATION_RECV_UIDX),
-		.cdw15 = args->numd,
-		.addr = (__u64)(uintptr_t)args->data,
-		.data_len = 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_set_features_ctrl_data_queue(struct nvme_transport_handle *hdl, __u16 cdqid, __u32 hp, __u32 tpt, bool etpt,
 					 __u32 *result)
 {

libnvme/src/nvme/ioctl.h

@@ -5245,14 +5245,66 @@ nvme_init_lm_migration_send(struct nvme_passthru_cmd *cmd,
 }
 
 /**
- * nvme_lm_migration_recv - Migration Receive command
- * @hdl:	Transport handle
- * @args:	&struct nvme_lm_migration_rev_args argument structure
+ * nvme_init_lm_migration_recv() - Initialize passthru command for
+ * Migration Receive command
+ * @cmd:	Passthru command to use
+ * @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.
+ * @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)
+ * @sel:	Select (SEL): This field specifies the type of management
+ * 		operation to perform
+ * @uidx:	UUID Index (UIDX)
+ * @csuidxp:	Controller State UUID Index Parameter (CSUIDXP)
+ * @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 Receive command.
  */
-int nvme_lm_migration_recv(struct nvme_transport_handle *hdl, struct nvme_lm_migration_recv_args *args);
+static inline void
+nvme_init_lm_migration_recv(struct nvme_passthru_cmd *cmd,
+		__u64 offset, __u16 mos, __u16 cntlid, __u16 csuuidi, __u8 sel,
+		__u8 uidx, __u8 csuidxp, void *data, __u32 len)
+{
+	__u32 cdw11 = 0;
+	__u32 data_len = 0;
+
+	if (sel == NVME_LM_SEL_GET_CONTROLLER_STATE) {
+		cdw11 = NVME_FIELD_ENCODE(csuidxp,
+				NVME_LM_GET_CONTROLLER_STATE_CSUIDXP_SHIFT,
+				NVME_LM_GET_CONTROLLER_STATE_CSUIDXP_MASK) |
+			NVME_FIELD_ENCODE(csuuidi,
+				NVME_LM_GET_CONTROLLER_STATE_CSUUIDI_SHIFT,
+				NVME_LM_GET_CONTROLLER_STATE_CSUUIDI_MASK) |
+			NVME_FIELD_ENCODE(cntlid,
+				NVME_LM_GET_CONTROLLER_STATE_CNTLID_SHIFT,
+				NVME_LM_GET_CONTROLLER_STATE_CNTLID_MASK);
+		data_len = len;
+	}
+
+	memset(cmd, 0, sizeof(*cmd));
+
+	cmd->opcode = nvme_admin_migration_receive;
+	cmd->data_len = data_len;
+	cmd->addr = (__u64)(uintptr_t)data;
+	cmd->cdw10 = NVME_FIELD_ENCODE(sel,
+			NVME_LM_MIGRATION_RECV_SEL_SHIFT,
+			NVME_LM_MIGRATION_RECV_SEL_MASK) |
+		      NVME_FIELD_ENCODE(mos,
+			NVME_LM_MIGRATION_RECV_MOS_SHIFT,
+			NVME_LM_MIGRATION_RECV_MOS_MASK);
+	cmd->cdw11 = cdw11;
+	cmd->cdw12 = (__u32)offset;
+	cmd->cdw13 = (__u32)(offset >> 32);
+	cmd->cdw14 = NVME_FIELD_ENCODE(uidx,
+			NVME_LM_MIGRATION_RECV_UIDX_SHIFT,
+			NVME_LM_MIGRATION_RECV_UIDX_MASK);
+	cmd->cdw15 = len ? (__u32)((len - 1) / sizeof(__u32)) : 0;
+}
 
 /**
  * nvme_lm_set_features_ctrl_data_queue - Set Controller Datea Queue feature

libnvme/test/ioctl/misc.c

@@ -1439,40 +1439,36 @@ static void test_lm_migration_send(void)
 
 static void test_lm_migration_recv(void)
 {
-	__u32 result = 0;
+	__u8 sel = NVME_LM_SEL_GET_CONTROLLER_STATE;
 	__u32 expected_data[8], data[8] = {};
-	struct nvme_lm_migration_recv_args args = {
-		.offset = 0xffffffffff,
-		.result = 0,
-		.data = &data,
-		.args_size = sizeof(args),
-		.numd = 8 - 1,
-		.mos = 0x1,
-		.cntlid = 0x2,
-		.csuuidi = 0x3,
-		.sel = NVME_LM_SEL_GET_CONTROLLER_STATE,
-		.uidx = 0x4,
-		.csuidxp = 0x5,
-	};
-
+	__u64 offset = 0xffffffffff;
+	__u16 csuuidi = 0x3;
+	__u32 numd = 8 - 1;
+	__u16 cntlid = 0x2;
+	__u8 csuidxp = 0x5;
+	__u32 result = 0;
+	__u16 mos = 0x1;
+	__u8 uidx = 0x4;
 	struct mock_cmd mock_admin_cmd = {
 		.opcode = nvme_admin_migration_receive,
-		.cdw10 = args.sel | (args.mos << 16),
-		.cdw11 = args.cntlid | (args.csuuidi << 16) |
-			 (args.csuidxp << 24),
-		.cdw12 = (__u32)args.offset,
-		.cdw13 = (__u32)(args.offset >> 32),
-		.cdw14 = args.uidx,
-		.cdw15 = args.numd,
-		.data_len = (args.numd + 1) << 2,
+		.cdw10 = sel | (mos << 16),
+		.cdw11 = cntlid | (csuuidi << 16) |
+			 (csuidxp << 24),
+		.cdw12 = (__u32)offset,
+		.cdw13 = (__u32)(offset >> 32),
+		.cdw14 = uidx,
+		.cdw15 = numd,
+		.data_len = (numd + 1) << 2,
 		.out_data = &expected_data,
 	};
-
+	struct nvme_passthru_cmd cmd;
 	int err;
 
 	arbitrary(&expected_data, sizeof(expected_data));
 	set_mock_admin_cmds(&mock_admin_cmd, 1);
-	err = nvme_lm_migration_recv(test_hdl, &args);
+	nvme_init_lm_migration_recv(&cmd, offset, mos, cntlid, csuuidi, sel,
+		uidx, csuidxp, 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);