Merge pull request #234 from jeffreyalien/uuidx-parm

[libnvme] Add uuidx parm to get log page API

Author: dwsuse

src/libnvme.map

@@ -123,7 +123,6 @@ LIBNVME_1_0 {
 		nvme_get_log_fw_slot;
 		nvme_get_log_lba_status;
 		nvme_get_log_page;
-		nvme_get_log_page_padded;
 		nvme_get_log_persistent_event;
 		nvme_get_log_predictable_lat_event;
 		nvme_get_log_predictable_lat_nvmset;

src/nvme/fabrics.c

@@ -670,8 +670,24 @@ nvme_ctrl_t nvmf_connect_disc_entry(nvme_host_t h,
 
 static int nvme_discovery_log(int fd, __u32 len, struct nvmf_discovery_log *log, bool rae)
 {
-	return nvme_get_log_page(fd, 0, NVME_LOG_LID_DISCOVER, rae, 512,
-				 len, log);
+	struct nvme_get_log_args args = {
+		.args_size = sizeof(args),
+		.fd = fd,
+		.nsid = NVME_NSID_NONE,
+		.lsp = NVME_LOG_LSP_NONE,
+		.lsi = NVME_LOG_LSI_NONE,
+		.uuidx = NVME_UUID_NONE,
+		.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
+		.result = NULL,
+		.lid = NVME_LOG_LID_DISCOVER,
+		.log = log,
+		.len = len,
+		.csi = NVME_CSI_NVM,
+		.rae = rae,
+		.ot = false,
+	};
+
+	return nvme_get_log_page(fd, 4096, &args);
 }
 
 int nvmf_get_discovery_log(nvme_ctrl_t c, struct nvmf_discovery_log **logp,

src/nvme/linux.c

@@ -116,33 +116,19 @@ int nvme_fw_download_seq(int fd, __u32 size, __u32 xfer, __u32 offset,
 	return err;
 }
 
-int nvme_get_log_page(int fd, __u32 nsid, __u8 log_id, bool rae,
-		      __u32 xfer_len, __u32 data_len, void *data)
+int nvme_get_log_page(int fd, __u32 xfer_len, struct nvme_get_log_args *args)
 {
 	__u64 offset = 0, xfer;
 	bool retain = true;
-	void *ptr = data;
+	void *ptr = args->log;
 	int ret;
-	struct nvme_get_log_args args = {
-		.args_size = sizeof(args),
-		.fd = fd,
-		.nsid = nsid,
-		.lid = log_id,
-		.lsp = NVME_LOG_LSP_NONE,
-		.lsi = NVME_LOG_LSI_NONE,
-		.uuidx = NVME_UUID_NONE,
-		.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
-		.result = NULL,
-		.csi = NVME_CSI_NVM,
-		.ot = false,
-	};
 
 	/*
 	 * 4k is the smallest possible transfer unit, so restricting to 4k
 	 * avoids having to check the MDTS value of the controller.
 	 */
 	do {
-		xfer = data_len - offset;
+		xfer = args->len - offset;
 		if (xfer > xfer_len)
 			xfer  = xfer_len;
 
@@ -151,30 +137,24 @@ int nvme_get_log_page(int fd, __u32 nsid, __u8 log_id, bool rae,
 		 * last portion of this log page so the data remains latched
 		 * during the fetch sequence.
 		 */
-		if (offset + xfer == data_len)
-			retain = rae;
-
-		args.lpo = offset;
-		args.len = xfer;
-		args.log = ptr;
-		args.rae = retain;
-		ret = nvme_get_log(&args);
+		if (offset + xfer == args->len)
+			retain = args->rae;
+
+		args->lpo = offset;
+		args->len = xfer;
+		args->log = ptr;
+		args->rae = retain;
+		ret = nvme_get_log(args);
 		if (ret)
 			return ret;
 
 		offset += xfer;
 		ptr += xfer;
-	} while (offset < data_len);
+	} while (offset < args->len);
 
 	return 0;
 }
 
-int nvme_get_log_page_padded(int fd, __u32 nsid, __u8 log_id, bool rae,
-			     __u32 data_len, void *data)
-{
-	return nvme_get_log_page(fd, nsid, log_id, rae, 4096, data_len, data);
-}
-
 static int nvme_get_telemetry_log(int fd, bool create, bool ctrl, bool rae,
 				  struct nvme_telemetry_log **buf, enum nvme_telemetry_da da,
 				  size_t *size)
@@ -186,6 +166,19 @@ static int nvme_get_telemetry_log(int fd, bool create, bool ctrl, bool rae,
 	struct nvme_id_ctrl id_ctrl;
 	void *log, *tmp;
 	int err;
+	struct nvme_get_log_args args = {
+		.args_size = sizeof(args),
+		.fd = fd,
+		.nsid = NVME_NSID_NONE,
+		.lsp = NVME_LOG_LSP_NONE,
+		.lsi = NVME_LOG_LSI_NONE,
+		.uuidx = NVME_UUID_NONE,
+		.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
+		.result = NULL,
+		.csi = NVME_CSI_NVM,
+		.rae = rae,
+		.ot = false,
+	};
 
 	*size = 0;
 
@@ -254,8 +247,10 @@ static int nvme_get_telemetry_log(int fd, bool create, bool ctrl, bool rae,
 	}
 	log = tmp;
 
-	err = nvme_get_log_page_padded(fd, NVME_NSID_NONE, lid, rae, (__u32)*size,
-				       (void *)log);
+	args.lid = lid;
+	args.log = log;
+	args.len = *size;
+	err = nvme_get_log_page(fd, 4096, &args);
 	if (!err) {
 		*buf = log;
 		return 0;
@@ -288,6 +283,19 @@ int nvme_get_lba_status_log(int fd, bool rae, struct nvme_lba_status_log **log)
 	__u32 size = sizeof(struct nvme_lba_status_log);
 	void *buf, *tmp;
 	int err;
+	struct nvme_get_log_args args = {
+		.args_size = sizeof(args),
+		.fd = fd,
+		.nsid = NVME_NSID_NONE,
+		.lsp = NVME_LOG_LSP_NONE,
+		.lsi = NVME_LOG_LSI_NONE,
+		.uuidx = NVME_UUID_NONE,
+		.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
+		.result = NULL,
+		.csi = NVME_CSI_NVM,
+		.rae = rae,
+		.ot = false,
+	};
 
 	buf = malloc(size);
 	if (!buf)
@@ -310,8 +318,10 @@ int nvme_get_lba_status_log(int fd, bool rae, struct nvme_lba_status_log **log)
 	buf = tmp;
 	*log = buf;
 
-	err = nvme_get_log_page_padded(fd, NVME_NSID_NONE, NVME_LOG_LID_LBA_STATUS,
-				       rae, size, buf);
+	args.lid = NVME_LOG_LID_LBA_STATUS;
+	args.log = buf;
+	args.len = size;
+	err = nvme_get_log_page(fd, 4096, &args);
 	if (!err)
 		return 0;
 

src/nvme/linux.h

@@ -11,6 +11,7 @@
 
 #include <stddef.h>
 
+#include "ioctl.h"
 #include "types.h"
 
 /**
@@ -99,36 +100,13 @@ int nvme_get_new_host_telemetry(int fd,  struct nvme_telemetry_log **log,
 /**
  * nvme_get_log_page() - get log page data
  * @fd:	      File descriptor of nvme device
- * @nsid:     Namespace Identifier, if applicable.
- * @log_id:   Log Identifier, see &enum nvme_cmd_get_log_lid.
- * @rae:      Retain asynchronous events
  * @xfer_len: Max log transfer size per request to split the total.
- * @data_len: Total length of the log to transfer.
- * @data:     User address of at least &data_len to store the log.
+ * @args:	&struct nvme_get_log_args argument structure
  *
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-int nvme_get_log_page(int fd, __u32 nsid, __u8 log_id, bool rae,
-		      __u32 xfer_len, __u32 data_len, void *data);
-
-/**
- * nvme_get_log_page_padded() - get log page data with 4k xfer length
- * @fd:	      File descriptor of nvme device
- * @nsid:     Namespace Identifier, if applicable.
- * @log_id:   Log Identifier, see &enum nvme_cmd_get_log_lid.
- * @rae:      Retain asynchronous events
- * @data_len: Total length of the log to transfer.
- * @data:     User address of at least &data_len to store the log.
- *
- * Calls nvme_get_log_page() with a default 4k transfer length, as that is
- * guaranteed by the protocol to be a safe transfer size.
- *
- * Return: The nvme command status if a response was received (see
- * &enum nvme_status_field) or -1 with errno set otherwise.
- */
-int nvme_get_log_page_padded(int fd, __u32 nsid, __u8 log_id, bool rae,
-			     __u32 data_len, void *data);
+int nvme_get_log_page(int fd, __u32 xfer_len, struct nvme_get_log_args *args);
 
 /**
  * nvme_get_ana_log_len() - Retreive size of the current ANA log