Use argument structure for nvme_format_nvm() and nvme_ns_mgmt()

Use an argument structure instead of passing all arguments one by one.
This allows for a future expansion of the argument list without having
to change the library ABI.

Signed-off-by: Hannes Reinecke <[email protected]>

Author: hreinecke

src/nvme/ioctl.c

@@ -1147,87 +1147,63 @@ int nvme_get_features_iocs_profile(int fd, enum nvme_get_features_sel sel,
 	return __nvme_get_features(fd, NVME_FEAT_FID_IOCS_PROFILE, sel, result);
 }
 
-int nvme_format_nvm(int fd, __u32 nsid, __u8 lbaf,
-		    enum nvme_cmd_format_mset mset, enum nvme_cmd_format_pi pi,
-		    enum nvme_cmd_format_pil pil, enum nvme_cmd_format_ses ses,
-		    __u32 timeout, __u32 *result)
+int nvme_format_nvm(struct nvme_format_nvm_args *args)
 {
-	__u32 cdw10 = NVME_SET(lbaf, FORMAT_CDW10_LBAF) |
-			NVME_SET(mset, FORMAT_CDW10_MSET) |
-			NVME_SET(pi, FORMAT_CDW10_PI) |
-			NVME_SET(pil, FORMAT_CDW10_PIL) |
-			NVME_SET(ses, FORMAT_CDW10_SES);
+	__u32 cdw10 = NVME_SET(args->lbaf, FORMAT_CDW10_LBAF) |
+			NVME_SET(args->mset, FORMAT_CDW10_MSET) |
+			NVME_SET(args->pi, FORMAT_CDW10_PI) |
+			NVME_SET(args->pil, FORMAT_CDW10_PIL) |
+			NVME_SET(args->ses, FORMAT_CDW10_SES);
 
 	struct nvme_passthru_cmd cmd = {
 		.opcode		= nvme_admin_format_nvm,
-		.nsid		= nsid,
+		.nsid		= args->nsid,
 		.cdw10		= cdw10,
-		.timeout_ms	= timeout,
+		.timeout_ms	= args->timeout,
 	};
 
-	return nvme_submit_admin_passthru(fd, &cmd, result);
+	if (args->args_size < sizeof(*args))
+		return -EINVAL;
+	return nvme_submit_admin_passthru(args->fd, &cmd, args->result);
 }
 
-int nvme_ns_mgmt(int fd, __u32 nsid, enum nvme_ns_mgmt_sel sel,
-		 struct nvme_id_ns *ns, __u32 *result, __u32 timeout, __u8 csi)
+int nvme_ns_mgmt(struct nvme_ns_mgmt_args *args)
 {
-	__u32 cdw10    = NVME_SET(sel, NAMESPACE_MGMT_CDW10_SEL);
-	__u32 cdw11    = NVME_SET(csi, NAMESPACE_MGMT_CDW11_CSI);
-	__u32 data_len = ns ? sizeof(*ns) : 0;
+	__u32 cdw10    = NVME_SET(args->sel, NAMESPACE_MGMT_CDW10_SEL);
+	__u32 cdw11    = NVME_SET(args->csi, NAMESPACE_MGMT_CDW11_CSI);
+	__u32 data_len = args->ns ? sizeof(*args->ns) : 0;
 
 	struct nvme_passthru_cmd cmd = {
-		.nsid	    = nsid,
+		.nsid	    = args->nsid,
 		.opcode	    = nvme_admin_ns_mgmt,
 		.cdw10	    = cdw10,
 		.cdw11	    = cdw11,
-		.timeout_ms = timeout,
+		.timeout_ms = args->timeout,
 		.data_len   = data_len,
-		.addr	    = (__u64)(uintptr_t)ns,
+		.addr	    = (__u64)(uintptr_t)args->ns,
 	};
 
-	return nvme_submit_admin_passthru(fd, &cmd, result);
-}
-
-int nvme_ns_mgmt_create(int fd, struct nvme_id_ns *ns, __u32 *nsid,
-			__u32 timeout, __u8 csi)
-{
-	return nvme_ns_mgmt(fd, NVME_NSID_NONE, NVME_NS_MGMT_SEL_CREATE, ns,
-			    nsid, timeout, csi);
-}
-
-int nvme_ns_mgmt_delete(int fd, __u32 nsid)
-{
-	return nvme_ns_mgmt(fd, nsid, NVME_NS_MGMT_SEL_DELETE, NULL, NULL, 0,
-			    0);
+	if (args->args_size < sizeof(*args))
+		return -EINVAL;
+	return nvme_submit_admin_passthru(args->fd, &cmd, args->result);
 }
 
-int nvme_ns_attach(int fd, __u32 nsid, enum nvme_ns_attach_sel sel,
-		   struct nvme_ctrl_list *ctrlist, __u32 timeout)
+int nvme_ns_attach(struct nvme_ns_attach_args *args)
 {
-	__u32 cdw10 = NVME_SET(sel, NAMESPACE_ATTACH_CDW10_SEL);
+	__u32 cdw10 = NVME_SET(args->sel, NAMESPACE_ATTACH_CDW10_SEL);
 
 	struct nvme_passthru_cmd cmd = {
 		.opcode		= nvme_admin_ns_attach,
-		.nsid		= nsid,
+		.nsid		= args->nsid,
 		.cdw10		= cdw10,
-		.data_len	= sizeof(*ctrlist),
-		.addr		= (__u64)(uintptr_t)ctrlist,
-		.timeout_ms	= timeout,
+		.data_len	= sizeof(*args->ctrlist),
+		.addr		= (__u64)(uintptr_t)args->ctrlist,
+		.timeout_ms	= args->timeout,
 	};
 
-	return nvme_submit_admin_passthru(fd, &cmd, NULL);
-}
-
-int nvme_ns_attach_ctrls(int fd, __u32 nsid, struct nvme_ctrl_list *ctrlist)
-{
-	return nvme_ns_attach(fd, nsid, NVME_NS_ATTACH_SEL_CTRL_ATTACH,
-			      ctrlist, NVME_DEFAULT_IOCTL_TIMEOUT);
-}
-
-int nvme_ns_detach_ctrls(int fd, __u32 nsid, struct nvme_ctrl_list *ctrlist)
-{
-	return nvme_ns_attach(fd, nsid, NVME_NS_ATTACH_SEL_CTRL_DEATTACH,
-			      ctrlist, NVME_DEFAULT_IOCTL_TIMEOUT);
+	if (args->args_size < sizeof(*args))
+		return -EINVAL;
+	return nvme_submit_admin_passthru(args->fd, &cmd, NULL);
 }
 
 int nvme_fw_download(int fd, __u32 offset, __u32 data_len, void *data,

src/nvme/ioctl.h

@@ -2666,7 +2666,7 @@ int nvme_get_features_iocs_profile(int fd, enum nvme_get_features_sel sel,
 				   __u32 *result);
 
 /**
- * nvme_format_nvm() - Format nvme namespace(s)
+ * nvme_format_nvm_args - Arguments for the Format Nvme Namespace command
  * @fd:		File descriptor of nvme device
  * @nsid:	Namespace ID to format
  * @lbaf:	Logical block address format
@@ -2677,6 +2677,23 @@ int nvme_get_features_iocs_profile(int fd, enum nvme_get_features_sel sel,
  * @timeout:	Set to override default timeout to this value in milliseconds;
  * 		useful for long running formats. 0 will use system default.
  * @result:	The command completion result from CQE dword0
+ */
+struct nvme_format_nvm_args {
+	int args_size;
+	int fd;
+	__u32 nsid;
+	__u8 lbaf;
+	enum nvme_cmd_format_mset mset;
+	enum nvme_cmd_format_pi pi;
+	enum nvme_cmd_format_pil pil;
+	enum nvme_cmd_format_ses ses;
+	__u32 timeout;
+	__u32 *result;
+};
+
+/**
+ * nvme_format_nvm() - Format nvme namespace(s)
+ * @args:	&struct nvme_format_nvme_args argument structure
  *
  * The Format NVM command low level formats the NVM media. This command is used
  * by the host to change the LBA data size and/or metadata size. A low level
@@ -2686,25 +2703,34 @@ int nvme_get_features_iocs_profile(int fd, enum nvme_get_features_sel sel,
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-int nvme_format_nvm(int fd, __u32 nsid, __u8 lbaf,
-		    enum nvme_cmd_format_mset mset,
-		    enum nvme_cmd_format_pi pi,
-		    enum nvme_cmd_format_pil pil,
-		    enum nvme_cmd_format_ses ses,
-		    __u32 timeout, __u32 *result);
+int nvme_format_nvm(struct nvme_format_nvm_args *args);
 
 /**
- * nvme_ns_mgmt() -
+ * nvme_ns_mgmt_args - Arguments for NVMe Namespace Management command
  * @fd:		File descriptor of nvme device
  * @nsid:	Namespace identifier
- * @sel:
+ * @sel:	Type of management operation to perform
  * @ns:		Namespace identication descriptors
  * @result:	NVMe command result
  * @timeout:	Timeout in ms
  * @csi:	Command Set Identifier
  */
-int nvme_ns_mgmt(int fd, __u32 nsid, enum nvme_ns_mgmt_sel sel,
-		 struct nvme_id_ns *ns, __u32 *result, __u32 timeout, __u8 csi);
+struct nvme_ns_mgmt_args {
+	int args_size;
+	int fd;
+	__u32 nsid;
+	enum nvme_ns_mgmt_sel sel;
+	struct nvme_id_ns *ns;
+	__u32 *result;
+	__u32 timeout;
+	__u8 csi;
+};
+
+/**
+ * nvme_ns_mgmt() -
+ * @args:	&struct nvme_ns_mgmt_args Argument structure
+ */
+int nvme_ns_mgmt(struct nvme_ns_mgmt_args *args);
 
 /**
  * nvme_ns_mgmt_create() -
@@ -2722,8 +2748,22 @@ int nvme_ns_mgmt(int fd, __u32 nsid, enum nvme_ns_mgmt_sel sel,
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-int nvme_ns_mgmt_create(int fd, struct nvme_id_ns *ns, __u32 *nsid,
-			__u32 timeout, __u8 csi);
+static inline int nvme_ns_mgmt_create(int fd, struct nvme_id_ns *ns,
+			__u32 *nsid, __u32 timeout, __u8 csi)
+{
+	struct nvme_ns_mgmt_args args = {
+		.args_size = sizeof(args),
+		.fd = fd,
+		.nsid = NVME_NSID_NONE,
+		.sel = NVME_NS_MGMT_SEL_CREATE,
+		.ns = ns,
+		.result = nsid,
+		.timeout = timeout,
+		.csi = csi,
+	};
+
+	return nvme_ns_mgmt(&args);
+}
 
 /**
  * nvme_ns_mgmt_delete() -
@@ -2737,34 +2777,86 @@ int nvme_ns_mgmt_create(int fd, struct nvme_id_ns *ns, __u32 *nsid,
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-int nvme_ns_mgmt_delete(int fd, __u32 nsid);
+static inline int nvme_ns_mgmt_delete(int fd, __u32 nsid)
+{
+	struct nvme_ns_mgmt_args args = {
+		.args_size = sizeof(args),
+		.fd = fd,
+		.nsid = nsid,
+		.sel = NVME_NS_MGMT_SEL_DELETE,
+		.ns = NULL,
+		.result = NULL,
+		.timeout = 0,
+		.csi = 0,
+	};
+
+	return nvme_ns_mgmt(&args);
+}
 
 /**
- * nvme_ns_attach() - Attach or detach namespace to controller(s)
+ * nvme_ns_attach_args - Arguments for Nvme Namespace Management command
  * @fd:		File descriptor of nvme device
  * @nsid:	Namespace ID to execute attach selection
  * @sel:	Attachment selection, see &enum nvme_ns_attach_sel
  * @ctrlist:	Controller list to modify attachment state of nsid
  * @timeout:	Timeout in ms
  */
-int nvme_ns_attach(int fd, __u32 nsid, enum nvme_ns_attach_sel sel,
-		   struct nvme_ctrl_list *ctrlist, __u32 timeout);
+struct nvme_ns_attach_args {
+	int args_size;
+	int fd;
+	__u32 nsid;
+	enum nvme_ns_attach_sel sel;
+	struct nvme_ctrl_list *ctrlist;
+	__u32 timeout;
+};
+
+/**
+ * nvme_ns_attach_args - Attach or detach namespace to controller(s)
+ * @args:	&struct nvme_ns_attach_args Argument structure
+ */
+int nvme_ns_attach(struct nvme_ns_attach_args *args);
 
 /**
  * nvme_ns_attach_ctrls() -
  * @fd:		File descriptor of nvme device
  * @nsid:	Namespace ID to attach
  * @ctrlist:	Controller list to modify attachment state of nsid
  */
-int nvme_ns_attach_ctrls(int fd, __u32 nsid, struct nvme_ctrl_list *ctrlist);
+static inline int nvme_ns_attach_ctrls(int fd, __u32 nsid,
+			struct nvme_ctrl_list *ctrlist)
+{
+	struct nvme_ns_attach_args args = {
+		.args_size = sizeof(args),
+		.fd = fd,
+		.nsid = nsid,
+		.sel = NVME_NS_ATTACH_SEL_CTRL_ATTACH,
+		.ctrlist = ctrlist,
+		.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
+	};
+
+	return nvme_ns_attach(&args);
+}
 
 /**
  * nvme_ns_detach_ctrls() -
  * @fd:		File descriptor of nvme device
  * @nsid:	Namespace ID to detach
  * @ctrlist:	Controller list to modify attachment state of nsid
  */
-int nvme_ns_detach_ctrls(int fd, __u32 nsid, struct nvme_ctrl_list *ctrlist);
+static inline int nvme_ns_detach_ctrls(int fd, __u32 nsid,
+			struct nvme_ctrl_list *ctrlist)
+{
+	struct nvme_ns_attach_args args = {
+		.args_size = sizeof(args),
+		.fd = fd,
+		.nsid = nsid,
+		.sel = NVME_NS_ATTACH_SEL_CTRL_DEATTACH,
+		.ctrlist = ctrlist,
+		.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
+	};
+
+	return nvme_ns_attach(&args);
+}
 
 /**
  * nvme_fw_download() - Download part or all of a firmware image to the
@@ -3016,7 +3108,7 @@ int nvme_directive_recv_stream_allocate(int fd, __u32 nsid, __u16 nsr,
 					__u32 *result);
 
 /**
- * nvme_capacity_mgmt() -
+ * nvme_capacity_mgmt_args - Arguments for the NVMe Capacity Management command
  * @fd:		File descriptor of nvme device
  * @op:		Operation to be performed by the controller
  * @element_id:	Value specific to the value of the Operation field

src/nvme/linux.c

@@ -280,14 +280,21 @@ int nvme_get_lba_status_log(int fd, bool rae, struct nvme_lba_status_log **log)
 static int nvme_ns_attachment(int fd, __u32 nsid, __u16 num_ctrls,
 			      __u16 *ctrlist, bool attach, __u32 timeout)
 {
-	enum nvme_ns_attach_sel sel = NVME_NS_ATTACH_SEL_CTRL_DEATTACH;
 	struct nvme_ctrl_list cntlist = { 0 };
+	struct nvme_ns_attach_args args = {
+		.args_size = sizeof(args),
+		.fd = fd,
+		.nsid = nsid,
+		.sel = NVME_NS_ATTACH_SEL_CTRL_DEATTACH,
+		.ctrlist = &cntlist,
+		.timeout = timeout,
+	};
 
 	if (attach)
-		sel = NVME_NS_ATTACH_SEL_CTRL_ATTACH;
+		args.sel = NVME_NS_ATTACH_SEL_CTRL_ATTACH;
 
-	nvme_init_ctrl_list(&cntlist, num_ctrls, ctrlist);
-	return nvme_ns_attach(fd, nsid, sel, &cntlist, timeout);
+	nvme_init_ctrl_list(args.ctrlist, num_ctrls, ctrlist);
+	return nvme_ns_attach(&args);
 }
 
 int nvme_namespace_attach_ctrls(int fd, __u32 nsid, __u16 num_ctrls,