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

@@ -137,7 +137,6 @@ LIBNVME_2_0 {
 		nvme_io_passthru64;
 		nvme_io_passthru;
 		nvme_ipaddrs_eq;
-		nvme_lm_cdq;
 		nvme_lm_get_features_ctrl_data_queue;
 		nvme_lm_migration_recv;
 		nvme_lm_migration_send;

libnvme/src/nvme/api-types.h

@@ -143,36 +143,6 @@ struct nvme_copy_args {
 	__u64 ilbrt_u64;
 };
 
-/**
- * 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
- * @data:	Pointer to data
- * @args_size:	Length of structure
- * @timeout:	Timeout in ms
- * @mos:	Management Operation Specific (MOS): This field is specific to the SEL type
- * @cntlid:	Controller ID: For Create CDQ, specifies the target migratable controller
- * @cdqid:	Controller Data Queue ID (CDQID): For Create CDQ, this field is the CDQID created
- *		by the controller if no error is present. For Delete CDQ, this field is the CDQID
- *		to delete.
- * @sel:	Select (SEL): This field specifies the type of management operation to perform.
- * @sz_u8:	For Create CDQ, specifies the size of CDQ, in dwords - 1 byte
- * @rsvd1:	Reserved
- * @sz:		For Create CDQ, specifies the size of CDQ, in dwords - 4 byte
- */
-struct nvme_lm_cdq_args {
-	__u32	*result;
-	void	*data;
-	int	args_size;
-	__u32	timeout;
-	__u16	mos;
-	__u16	cntlid;
-	__u16	cdqid;
-	__u8	sel;
-	__u8	sz_u8;
-	__u8	rsvd1[4];
-	__u32	sz;
-};
-
 /**
  * struct nvme_lm_track_send_args - Arguments for the Track Send command
  * @result:	Set on completion to the command's CQE DWORD 0 controller response

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_cdq(struct nvme_transport_handle *hdl, struct nvme_lm_cdq_args *args)
-{
-	__u32 cdw10 = NVME_SET(args->sel, LM_CDQ_SEL) |
-		      NVME_SET(args->mos, LM_CDQ_MOS);
-	__u32 cdw11 = 0, data_len = 0, sz = 0;
-	int err;
-
-	sz = args->sz;
-
-	if (args->sel == NVME_LM_SEL_CREATE_CDQ) {
-		cdw11 = NVME_SET(NVME_SET(args->cntlid, LM_CREATE_CDQ_CNTLID), LM_CQS) |
-			NVME_LM_CREATE_CDQ_PC;
-		data_len = sz << 2;
-	} else if (args->sel == NVME_LM_SEL_DELETE_CDQ) {
-		cdw11 = NVME_SET(args->cdqid, LM_DELETE_CDQ_CDQID);
-	}
-
-	struct nvme_passthru_cmd cmd = {
-		.opcode = nvme_admin_ctrl_data_queue,
-		.cdw10 = cdw10,
-		.cdw11 = cdw11,
-		.cdw12 = sz,
-		.addr = (__u64)(uintptr_t)args->data,
-		.data_len = data_len,
-		.timeout_ms = args->timeout,
-	};
-
-	if (args->args_size < sizeof(*args))
-		return -EINVAL;
-
-	err = nvme_submit_admin_passthru(hdl, &cmd, args->result);
-
-	if (!err)
-		args->cdqid = NVME_GET(cmd.result, LM_CREATE_CDQ_CDQID);
-
-	return err;
-}
-
 int nvme_lm_track_send(struct nvme_transport_handle *hdl, struct nvme_lm_track_send_args *args)
 {
 	__u32 cdw10 = NVME_SET(args->sel, LM_TRACK_SEND_SEL) |

libnvme/src/nvme/ioctl.h

@@ -5063,14 +5063,79 @@ nvme_init_dim_send(struct nvme_passthru_cmd *cmd,
 }
 
 /**
- * nvme_lm_cdq() - Controller Data Queue - Controller Data Queue command
- * @hdl:	Transport handle
- * @args:	&struct nvme_lm_cdq_args argument structure
+ * nvme_init_lm_cdq_create() - Initialize passthru command for
+ * Controller Data Queue create - Controller Data Queue command
+ * @cmd:	Passthru command to use
+ * @mos:	Management Operation Specific (MOS): This field is
+ * 		specific to the SEL type
+ * @cntlid:	Controller ID: For Create CDQ, specifies the target
+ * 		migratable controller
+ * @cdqsize:	For Create CDQ, specifies the size of CDQ, in dwords - 4 byte
+ * @data:	Pointer to data buffer
  *
- * Return: The nvme command status if a response was received (see
- * &enum nvme_status_field) or -1 with errno set otherwise.)
+ * Initializes the passthru command buffer for the Controller Data Queue
+ * command. Note: The result CDQID is returned in the CQE dword0, which the
+ * submission function must handle.
+ */
+static inline void
+nvme_init_lm_cdq_create(struct nvme_passthru_cmd *cmd,
+		__u16 mos, __u16 cntlid, __u32 cdqsize, void *data)
+{
+	__u16 cqs;
+
+	memset(cmd, 0, sizeof(*cmd));
+
+	cqs = NVME_FIELD_ENCODE(cntlid,
+		NVME_LM_CREATE_CDQ_CNTLID_SHIFT,
+		NVME_LM_CREATE_CDQ_CNTLID_MASK);
+
+	cmd->opcode = nvme_admin_ctrl_data_queue;
+	cmd->data_len = cdqsize << 2;
+	cmd->addr = (__u64)(uintptr_t)data;
+	cmd->cdw10 = NVME_FIELD_ENCODE(NVME_LM_SEL_CREATE_CDQ,
+			NVME_LM_CDQ_SEL_SHIFT,
+			NVME_LM_CDQ_SEL_MASK) |
+		      NVME_FIELD_ENCODE(mos,
+			NVME_LM_CDQ_MOS_SHIFT,
+			NVME_LM_CDQ_MOS_MASK);
+	cmd->cdw11 = NVME_FIELD_ENCODE(NVME_LM_CREATE_CDQ_PC,
+			NVME_LM_CREATE_CDQ_PC_SHIFT,
+			NVME_LM_CREATE_CDQ_PC_MASK) |
+		     NVME_FIELD_ENCODE(cqs,
+			NVME_LM_CQS_SHIFT,
+			NVME_LM_CQS_MASK);
+	cmd->cdw12 = cdqsize;
+}
+
+/**
+ * nvme_init_lm_cdq_delete() - Initialize passthru command for
+ * Controller Data Queue delete - Controller Data Queue command
+ * @cmd:	Passthru command to use
+ * @mos:	Management Operation Specific (MOS): This field is
+ * 		specific to the SEL type
+ * @cdqid:	Controller Data Queue ID (CDQID): For Delete CDQ, this
+ * 		field is the CDQID to delete.
+ *
+ * Initializes the passthru command buffer for the Controller Data Queue delete
+ * command.
  */
-int nvme_lm_cdq(struct nvme_transport_handle *hdl, struct nvme_lm_cdq_args *args);
+static inline void
+nvme_init_lm_cdq_delete(struct nvme_passthru_cmd *cmd,
+		__u16 mos, __u16 cdqid)
+{
+	memset(cmd, 0, sizeof(*cmd));
+
+	cmd->opcode = nvme_admin_ctrl_data_queue;
+	cmd->cdw10 = NVME_FIELD_ENCODE(NVME_LM_SEL_DELETE_CDQ,
+			NVME_LM_CDQ_SEL_SHIFT,
+			NVME_LM_CDQ_SEL_MASK) |
+		      NVME_FIELD_ENCODE(mos,
+			NVME_LM_CDQ_MOS_SHIFT,
+			NVME_LM_CDQ_MOS_MASK);
+	cmd->cdw11 = NVME_FIELD_ENCODE(cdqid,
+			NVME_LM_DELETE_CDQ_CDQID_SHIFT,
+			NVME_LM_DELETE_CDQ_CDQID_MASK);
+}
 
 /**
  * nvme_lm_track_send() - Track Send command

libnvme/src/nvme/types.h

@@ -10016,6 +10016,8 @@ struct nvme_ns_mgmt_host_sw_specified {
  * @NVME_LM_CQS_SHIFT:			Shift amount for Create Queue Specific (CQS) field
  * @NVME_LM_CQS_MASK:			Mask to set CQS field
  * @NVME_LM_CREATE_CDQ_PC:		Physically Contiguous (PC)
+ * @NVME_LM_CREATE_CDQ_PC_SHIFT:	Shift amount to set the PC field
+ * @NVME_LM_CREATE_CDQ_PC_MASK:		Mask to set PC field
  * @NVME_LM_CREATE_CDQ_CNTLID_SHIFT:	Shift amount to set CNTLID field relative to MOS
  * @NVME_LM_CREATE_CDQ_CNTLID_MASK:	Mask to set CNTLID field relative to MOS
  * @NVME_LM_DELETE_CDQ_CDQID_SHIFT:	Shift amount to set CDQID field for deletion
@@ -10040,6 +10042,8 @@ enum nvme_lm_cdq_fields {
 	NVME_LM_CQS_MASK			= 0xffff,
 	NVME_LM_QT_USER_DATA_MIGRATION_QUEUE	= 0,
 	NVME_LM_CREATE_CDQ_PC			= 1,
+	NVME_LM_CREATE_CDQ_PC_SHIFT		= 0,
+	NVME_LM_CREATE_CDQ_PC_MASK		= 0x1,
 	NVME_LM_CREATE_CDQ_CNTLID_SHIFT		= 0,
 	NVME_LM_CREATE_CDQ_CNTLID_MASK		= 0xffff,
 

libnvme/test/ioctl/misc.c

@@ -1345,36 +1345,30 @@ static void test_dim_send(void)
 	cmp(&data, &expected_data, sizeof(data), "incorrect data");
 }
 
-static void test_lm_cdq(void)
+static void test_lm_cdq_delete(void)
 {
 	__u32 result = 0;
 	__u8 expected_data[8], data[8] = {};
-	struct nvme_lm_cdq_args args = {
-		.result = 0,
-		.data = &data,
-		.args_size = sizeof(args),
-		.mos = 0x1,
-		.cntlid = 0x2,
-		.cdqid = 0x3,
-		.sel = NVME_LM_SEL_DELETE_CDQ,
-		.sz = 0x4,
-	};
-
+	__u16 mos = 0x1;
+	__u16 cdqid = 0x3;
+	__u8 sel = NVME_LM_SEL_DELETE_CDQ;
+	__u32 sz = 0;
 	struct mock_cmd mock_admin_cmd = {
 		.opcode = nvme_admin_ctrl_data_queue,
-		.cdw10 = args.sel | (args.mos << 16),
-		.cdw11 = args.cdqid,
-		.cdw12 = args.sz,
+		.cdw10 = sel | (mos << 16),
+		.cdw11 = cdqid,
+		.cdw12 = sz,
 		.data_len = 0,
 		.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_cdq(test_hdl, &args);
+	nvme_init_lm_cdq_delete(&cmd, mos, cdqid);
+	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);
@@ -1559,7 +1553,7 @@ int main(void)
 	RUN_TEST(fdp_reclaim_unit_handle_status);
 	RUN_TEST(fdp_reclaim_unit_handle_update);
 	RUN_TEST(dim_send);
-	RUN_TEST(lm_cdq);
+	RUN_TEST(lm_cdq_delete);
 	RUN_TEST(lm_track_send);
 	RUN_TEST(lm_migration_send);
 	RUN_TEST(lm_migration_recv);