libnvme: use 64-bit version struct nvme_passtru_cmd everywhere

The linux commit 65e68edce0db ("nvme: allow 64-bit results in passthru
commands") introduced the 64-bit version of the passthru. Reduce the
complexity of the library by just offering one passthru data structure.

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

Author: igaw

libnvme/src/libnvme.map

@@ -13,8 +13,6 @@ LIBNVME_1_16 {
 
 LIBNVME_2_0 {
 	global:
-		nvme_admin_passthru64;
-		nvme_admin_passthru;
 		nvme_close;
 		nvme_create_ctrl;
 		nvme_create_global_ctx;
@@ -132,8 +130,6 @@ LIBNVME_2_0 {
 		nvme_init_logging;
 		nvme_insert_tls_key;
 		nvme_insert_tls_key_versioned;
-		nvme_io_passthru64;
-		nvme_io_passthru;
 		nvme_ipaddrs_eq;
 		nvme_lookup_ctrl;
 		nvme_lookup_host;
@@ -250,12 +246,8 @@ LIBNVME_2_0 {
 		nvme_skip_namespaces;
 		nvme_status_to_errno;
 		nvme_status_to_string;
-		nvme_submit_admin_passthru64;
 		nvme_submit_admin_passthru;
-		nvme_submit_io_passthru64;
 		nvme_submit_io_passthru;
-		nvme_submit_passthru64;
-		nvme_submit_passthru;
 		nvme_subsys_filter;
 		nvme_subsystem_first_ctrl;
 		nvme_subsystem_first_ns;

libnvme/src/nvme/ioctl.c

@@ -100,9 +100,9 @@ int nvme_get_nsid(struct nvme_transport_handle *hdl, __u32 *nsid)
 }
 
 __attribute__((weak))
-int nvme_submit_passthru64(struct nvme_transport_handle *hdl, unsigned long ioctl_cmd,
-			   struct nvme_passthru_cmd64 *cmd,
-			   __u64 *result)
+int nvme_submit_passthru(struct nvme_transport_handle *hdl,
+		unsigned long ioctl_cmd, struct nvme_passthru_cmd *cmd,
+		__u64 *result)
 {
 	int err = ioctl(hdl->fd, ioctl_cmd, cmd);
 
@@ -113,132 +113,77 @@ int nvme_submit_passthru64(struct nvme_transport_handle *hdl, unsigned long ioct
 	return err;
 }
 
-__attribute__((weak))
-int nvme_submit_passthru(struct nvme_transport_handle *hdl, unsigned long ioctl_cmd,
-			 struct nvme_passthru_cmd *cmd, __u32 *result)
+/*
+ * The 64 bit version is the preferred version to use, but for backwards
+ * compatibility keep a 32 version.
+ */
+static int nvme_submit_passthru32(struct nvme_transport_handle *hdl,
+		unsigned long ioctl_cmd, struct nvme_passthru_cmd *cmd,
+		__u64 *result)
 {
-	int err = ioctl(hdl->fd, ioctl_cmd, cmd);
+	struct linux_passthru_cmd32 cmd32;
+	int err;
+
+	memcpy(&cmd32, cmd, offsetof(struct linux_passthru_cmd32, result));
+	cmd32.result = 0;
 
+	err = ioctl(hdl->fd, ioctl_cmd, &cmd32);
+	cmd->result = cmd32.result;
 	if (err >= 0 && result)
 		*result = cmd->result;
 	if (err < 0)
 		return -errno;
 	return err;
 }
 
-static int nvme_passthru64(struct nvme_transport_handle *hdl, unsigned long ioctl_cmd, __u8 opcode,
-			   __u8 flags, __u16 rsvd, __u32 nsid, __u32 cdw2,
-			   __u32 cdw3, __u32 cdw10, __u32 cdw11, __u32 cdw12,
-			   __u32 cdw13, __u32 cdw14, __u32 cdw15,
-			   __u32 data_len, void *data, __u32 metadata_len,
-			   void *metadata, __u32 timeout_ms, __u64 *result)
-{
-	struct nvme_passthru_cmd64 cmd = {
-		.opcode		= opcode,
-		.flags		= flags,
-		.rsvd1		= rsvd,
-		.nsid		= nsid,
-		.cdw2		= cdw2,
-		.cdw3		= cdw3,
-		.metadata	= (__u64)(uintptr_t)metadata,
-		.addr		= (__u64)(uintptr_t)data,
-		.metadata_len	= metadata_len,
-		.data_len	= data_len,
-		.cdw10		= cdw10,
-		.cdw11		= cdw11,
-		.cdw12		= cdw12,
-		.cdw13		= cdw13,
-		.cdw14		= cdw14,
-		.cdw15		= cdw15,
-		.timeout_ms	= timeout_ms,
-	};
-
-	return nvme_submit_passthru64(hdl, ioctl_cmd, &cmd, result);
-}
-
-static int nvme_passthru(struct nvme_transport_handle *hdl, unsigned long ioctl_cmd, __u8 opcode,
-			 __u8 flags, __u16 rsvd, __u32 nsid, __u32 cdw2,
-			 __u32 cdw3, __u32 cdw10, __u32 cdw11, __u32 cdw12,
-			 __u32 cdw13, __u32 cdw14, __u32 cdw15, __u32 data_len,
-			 void *data, __u32 metadata_len, void *metadata,
-			 __u32 timeout_ms, __u32 *result)
+/*
+ * supported since kernel 5.4, see
+ * 65e68edce0db ("nvme: allow 64-bit results in passthru commands")
+ */
+static int nvme_submit_passthru64(struct nvme_transport_handle *hdl,
+		unsigned long ioctl_cmd, struct nvme_passthru_cmd *cmd,
+		__u64 *result)
 {
-	struct nvme_passthru_cmd cmd = {
-		.opcode		= opcode,
-		.flags		= flags,
-		.rsvd1		= rsvd,
-		.nsid		= nsid,
-		.cdw2		= cdw2,
-		.cdw3		= cdw3,
-		.metadata	= (__u64)(uintptr_t)metadata,
-		.addr		= (__u64)(uintptr_t)data,
-		.metadata_len	= metadata_len,
-		.data_len	= data_len,
-		.cdw10		= cdw10,
-		.cdw11		= cdw11,
-		.cdw12		= cdw12,
-		.cdw13		= cdw13,
-		.cdw14		= cdw14,
-		.cdw15		= cdw15,
-		.timeout_ms	= timeout_ms,
-	};
-
-	return nvme_submit_passthru(hdl, ioctl_cmd, &cmd, result);
-}
+	int err;
 
-int nvme_submit_admin_passthru64(struct nvme_transport_handle *hdl, struct nvme_passthru_cmd64 *cmd,
-				 __u64 *result)
-{
-	return nvme_submit_passthru64(hdl, NVME_IOCTL_ADMIN64_CMD, cmd, result);
+	err = ioctl(hdl->fd, ioctl_cmd, cmd);
+	if (err >= 0 && result)
+		*result = cmd->result;
+	if (err < 0)
+		return -errno;
+	return err;
 }
 
-int nvme_admin_passthru64(struct nvme_transport_handle *hdl, __u8 opcode, __u8 flags, __u16 rsvd,
-			 __u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10,
-			 __u32 cdw11, __u32 cdw12, __u32 cdw13, __u32 cdw14,
-			 __u32 cdw15, __u32 data_len, void *data,
-			 __u32 metadata_len, void *metadata, __u32 timeout_ms,
-			 __u64 *result)
+int nvme_submit_io_passthru(struct nvme_transport_handle *hdl,
+		struct nvme_passthru_cmd *cmd, __u64 *result)
 {
-	return nvme_passthru64(hdl, NVME_IOCTL_ADMIN64_CMD, opcode, flags, rsvd,
-			       nsid, cdw2, cdw3, cdw10, cdw11, cdw12, cdw13,
-			       cdw14, cdw15, data_len, data, metadata_len,
-			       metadata, timeout_ms, result);
+	if (hdl->ioctl64)
+		return nvme_submit_passthru64(hdl,
+			NVME_IOCTL_IO64_CMD, cmd, result);
+	return nvme_submit_passthru32(hdl, NVME_IOCTL_IO_CMD, cmd, result);
 }
 
-int nvme_submit_admin_passthru(struct nvme_transport_handle *hdl, struct nvme_passthru_cmd *cmd, __u32 *result)
+int nvme_submit_admin_passthru(struct nvme_transport_handle *hdl,
+		struct nvme_passthru_cmd *cmd, __u64 *result)
 {
 	switch (hdl->type) {
 	case NVME_TRANSPORT_HANDLE_TYPE_DIRECT:
-		return nvme_submit_passthru(hdl, NVME_IOCTL_ADMIN_CMD, cmd, result);
+		if (hdl->ioctl64)
+			return nvme_submit_passthru64(hdl,
+				NVME_IOCTL_ADMIN64_CMD, cmd, result);
+		if (cmd->opcode == nvme_admin_fabrics)
+			return -ENOTSUP;
+		return nvme_submit_passthru32(hdl,
+				NVME_IOCTL_ADMIN_CMD, cmd, result);
 	case NVME_TRANSPORT_HANDLE_TYPE_MI:
-		return nvme_mi_admin_admin_passthru(
-			hdl, cmd->opcode, cmd->flags, cmd->rsvd1,
-			cmd->nsid, cmd->cdw2, cmd->cdw3, cmd->cdw10,
-			cmd->cdw11, cmd->cdw12, cmd->cdw13,
-			cmd->cdw14, cmd->cdw15,
-			cmd->data_len, (void *)(uintptr_t)cmd->addr,
-			cmd->metadata_len, (void *)(uintptr_t)cmd->metadata,
-			cmd->timeout_ms, result);
+		return nvme_mi_admin_admin_passthru(hdl, cmd, result);
 	default:
 		break;
 	}
 
 	return -ENOTSUP;
 }
 
-int nvme_admin_passthru(struct nvme_transport_handle *hdl, __u8 opcode, __u8 flags, __u16 rsvd,
-			__u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10,
-			__u32 cdw11, __u32 cdw12, __u32 cdw13, __u32 cdw14,
-			__u32 cdw15, __u32 data_len, void *data,
-			__u32 metadata_len, void *metadata, __u32 timeout_ms,
-			__u32 *result)
-{
-	return nvme_passthru(hdl, NVME_IOCTL_ADMIN_CMD, opcode, flags, rsvd,
-			     nsid, cdw2, cdw3, cdw10, cdw11, cdw12, cdw13,
-			     cdw14, cdw15, data_len, data, metadata_len,
-			     metadata, timeout_ms, result);
-}
-
 static bool force_4k;
 
 __attribute__((constructor))
@@ -264,6 +209,8 @@ enum {
 /*
  * gcc specific attribute, call automatically on the library loading.
  * if IORING_OP_URING_CMD is not supported, fallback to ioctl interface.
+ *
+ * The uring API expects the command of type struct nvme_passthru_cmd64.
  */
 __attribute__((constructor))
 static void nvme_uring_cmd_probe()
@@ -356,7 +303,7 @@ static bool nvme_uring_is_usable(struct nvme_transport_handle *hdl)
 
 int nvme_get_log(struct nvme_transport_handle *hdl,
 		struct nvme_passthru_cmd *cmd, bool rae,
-		__u32 xfer_len, __u32 *result)
+		__u32 xfer_len, __u64 *result)
 {
 	__u64 offset = 0, xfer, data_len = cmd->data_len;
 	__u64 start = (__u64)cmd->cdw13 << 32 | cmd->cdw12;
@@ -580,38 +527,3 @@ int nvme_get_ana_log_atomic(struct nvme_transport_handle *hdl, bool rae, bool rg
 
 	return -EAGAIN;
 }
-
-int nvme_submit_io_passthru64(struct nvme_transport_handle *hdl, struct nvme_passthru_cmd64 *cmd,
-			      __u64 *result)
-{
-	return nvme_submit_passthru64(hdl, NVME_IOCTL_IO64_CMD, cmd, result);
-}
-
-int nvme_io_passthru64(struct nvme_transport_handle *hdl, __u8 opcode, __u8 flags, __u16 rsvd,
-		       __u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10,
-		       __u32 cdw11, __u32 cdw12, __u32 cdw13, __u32 cdw14,
-		       __u32 cdw15, __u32 data_len, void *data, __u32 metadata_len,
-		       void *metadata, __u32 timeout_ms, __u64 *result)
-{
-	return nvme_passthru64(hdl, NVME_IOCTL_IO64_CMD, opcode, flags, rsvd,
-			       nsid, cdw2, cdw3, cdw10, cdw11, cdw12, cdw13,
-			       cdw14, cdw15, data_len, data, metadata_len, metadata,
-			       timeout_ms, result);
-}
-
-int nvme_submit_io_passthru(struct nvme_transport_handle *hdl, struct nvme_passthru_cmd *cmd, __u32 *result)
-{
-	return nvme_submit_passthru(hdl, NVME_IOCTL_IO_CMD, cmd, result);
-}
-
-int nvme_io_passthru(struct nvme_transport_handle *hdl, __u8 opcode, __u8 flags, __u16 rsvd,
-		     __u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10,
-		     __u32 cdw11, __u32 cdw12, __u32 cdw13, __u32 cdw14,
-		     __u32 cdw15, __u32 data_len, void *data, __u32 metadata_len,
-		     void *metadata, __u32 timeout_ms, __u32 *result)
-{
-	return nvme_passthru(hdl, NVME_IOCTL_IO_CMD, opcode, flags, rsvd, nsid,
-			     cdw2, cdw3, cdw10, cdw11, cdw12, cdw13, cdw14,
-			     cdw15, data_len, data, metadata_len, metadata,
-			     timeout_ms, result);
-}