Skip to contentSkip to conversation

Add new clear_ids attribute for passthru targets

PATCH Superseded Alan Adamson 4 participants 6 messages Jun 22, 2022 – Jun 27, 2022

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Add new clear_ids attribute for passthru targets

If the clear_ids attribute is set to true, the EUI/GUID/UUID is cleared for the passthru target. By default, loop targets will set clear_ids to true.

This resolves an issue where a connect to a passthru target fails when using a trtype of 'loop' because EUI/GUID/UUID is not unique.

---
 drivers/nvme/target/configfs.c | 20 ++++++++++++
 drivers/nvme/target/core.c     |  4 +++
 drivers/nvme/target/nvmet.h    |  1 +
 drivers/nvme/target/passthru.c | 58 ++++++++++++++++++++++++++++++++++
 4 files changed, 83 insertions(+)
drivers/nvme/target/configfs.c +20 -0
index e44b2988759e..ff77c3d2354f 100644
@@ -773,11 +773,31 @@ static ssize_t nvmet_passthru_io_timeout_store(struct config_item *item,
 }
 CONFIGFS_ATTR(nvmet_passthru_, io_timeout);
 
+static ssize_t nvmet_passthru_clear_ids_show(struct config_item *item,
+		char *page)
+{
+	return sprintf(page, "%u\n", to_subsys(item->ci_parent)->clear_ids);
+}
+
+static ssize_t nvmet_passthru_clear_ids_store(struct config_item *item,
+		const char *page, size_t count)
+{
+	struct nvmet_subsys *subsys = to_subsys(item->ci_parent);
+	unsigned int clear_ids;
+
+	if (kstrtouint(page, 0, &clear_ids))
+		return -EINVAL;
+	subsys->clear_ids = clear_ids;
+	return count;
+}
+CONFIGFS_ATTR(nvmet_passthru_, clear_ids);
+
 static struct configfs_attribute *nvmet_passthru_attrs[] = {
 	&nvmet_passthru_attr_device_path,
 	&nvmet_passthru_attr_enable,
 	&nvmet_passthru_attr_admin_timeout,
 	&nvmet_passthru_attr_io_timeout,
+	&nvmet_passthru_attr_clear_ids,
 	NULL,
 };
 
drivers/nvme/target/core.c +4 -0
index 90e75324dae0..d4203d582343 100644
@@ -1374,6 +1374,10 @@ u16 nvmet_alloc_ctrl(const char *subsysnqn, const char *hostnqn,
 	ctrl->port = req->port;
 	ctrl->ops = req->ops;
 
+	/* By default, set loop targets to clear IDS by default */
+	if (ctrl->port->disc_addr.trtype == NVMF_TRTYPE_LOOP)
+		subsys->clear_ids = 1;
+
 	INIT_WORK(&ctrl->async_event_work, nvmet_async_event_work);
 	INIT_LIST_HEAD(&ctrl->async_events);
 	INIT_RADIX_TREE(&ctrl->p2p_ns_map, GFP_KERNEL);
drivers/nvme/target/nvmet.h +1 -0
index 69818752a33a..2b3e5719f24e 100644
@@ -249,6 +249,7 @@ struct nvmet_subsys {
 	struct config_group	passthru_group;
 	unsigned int		admin_timeout;
 	unsigned int		io_timeout;
+	unsigned int		clear_ids;
 #endif /* CONFIG_NVME_TARGET_PASSTHRU */
 
 #ifdef CONFIG_BLK_DEV_ZONED
drivers/nvme/target/passthru.c +58 -0

82 lines not on this page · raw message

Signature · 1 line
2.31.1
maintainer
#1 lore raw
Quoted 124 lines · Alan Adamson

If the clear_ids attribute is set to true, the EUI/GUID/UUID is cleared for the passthru target. By default, loop targets will set clear_ids to true.

This resolves an issue where a connect to a passthru target fails when using a trtype of 'loop' because EUI/GUID/UUID is not unique.

---
  drivers/nvme/target/configfs.c | 20 ++++++++++++
  drivers/nvme/target/core.c     |  4 +++
  drivers/nvme/target/nvmet.h    |  1 +
  drivers/nvme/target/passthru.c | 58 ++++++++++++++++++++++++++++++++++
  4 files changed, 83 insertions(+)
drivers/nvme/target/configfs.c +20 -0
index e44b2988759e..ff77c3d2354f 100644
@@ -773,11 +773,31 @@ static ssize_t nvmet_passthru_io_timeout_store(struct config_item *item,
  }
  CONFIGFS_ATTR(nvmet_passthru_, io_timeout);
 
+static ssize_t nvmet_passthru_clear_ids_show(struct config_item *item,
+		char *page)
+{
+	return sprintf(page, "%u\n", to_subsys(item->ci_parent)->clear_ids);
+}
+
+static ssize_t nvmet_passthru_clear_ids_store(struct config_item *item,
+		const char *page, size_t count)
+{
+	struct nvmet_subsys *subsys = to_subsys(item->ci_parent);
+	unsigned int clear_ids;
+
+	if (kstrtouint(page, 0, &clear_ids))
+		return -EINVAL;
+	subsys->clear_ids = clear_ids;
+	return count;
+}
+CONFIGFS_ATTR(nvmet_passthru_, clear_ids);
+
  static struct configfs_attribute *nvmet_passthru_attrs[] = {
  	&nvmet_passthru_attr_device_path,
  	&nvmet_passthru_attr_enable,
  	&nvmet_passthru_attr_admin_timeout,
  	&nvmet_passthru_attr_io_timeout,
+	&nvmet_passthru_attr_clear_ids,
  	NULL,
  };
 
drivers/nvme/target/core.c +4 -0
index 90e75324dae0..d4203d582343 100644
@@ -1374,6 +1374,10 @@ u16 nvmet_alloc_ctrl(const char *subsysnqn, const char *hostnqn,
  	ctrl->port = req->port;
  	ctrl->ops = req->ops;
 
+	/* By default, set loop targets to clear IDS by default */
+	if (ctrl->port->disc_addr.trtype == NVMF_TRTYPE_LOOP)
+		subsys->clear_ids = 1;
+
  	INIT_WORK(&ctrl->async_event_work, nvmet_async_event_work);
  	INIT_LIST_HEAD(&ctrl->async_events);
  	INIT_RADIX_TREE(&ctrl->p2p_ns_map, GFP_KERNEL);
drivers/nvme/target/nvmet.h +1 -0
index 69818752a33a..2b3e5719f24e 100644
@@ -249,6 +249,7 @@ struct nvmet_subsys {
  	struct config_group	passthru_group;
  	unsigned int		admin_timeout;
  	unsigned int		io_timeout;
+	unsigned int		clear_ids;
  #endif /* CONFIG_NVME_TARGET_PASSTHRU */
 
  #ifdef CONFIG_BLK_DEV_ZONED
drivers/nvme/target/passthru.c +38 -0
index b1f7efab3918..e8c033fbdb5c 100644
@@ -30,6 +30,55 @@ void nvmet_passthrough_override_cap(struct nvmet_ctrl *ctrl)
  		ctrl->cap &= ~(1ULL << 43);
  }
 
+static u16 nvmet_passthru_override_id_descs(struct nvmet_req *req)
+{
+	struct nvmet_ctrl *ctrl = req->sq->ctrl;
+	void *data;
+	struct nvme_ns_id_desc *cur;
+	u16 status = NVME_SC_SUCCESS;
+	u8 csi;
+	int pos, len;
+	bool csi_seen;
+
+	if (!ctrl->subsys->clear_ids)
+		return status;
+
+	data = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
+	if (!data)
+		return NVME_SC_INTERNAL;
+
+	status = nvmet_copy_from_sgl(req, 0, data, NVME_IDENTIFY_DATA_SIZE);
+	if (status)
+		goto out_free;
+
+	for (pos = 0; pos < NVME_IDENTIFY_DATA_SIZE; pos += len) {
+		cur = data + pos;
+
+		if (cur->nidl == 0)
+			break;
+		len = cur->nidl;
+		if (cur->nidt == NVME_NIDT_CSI) {
+			memcpy(&csi, data + pos + sizeof(struct nvme_ns_id_desc),
+			       NVME_NIDT_CSI_LEN);
+			csi_seen = 1;
+			break;
+		}
+		len += sizeof(struct nvme_ns_id_desc);
+	}
+
+	memset(data, 0, NVME_IDENTIFY_DATA_SIZE);
+	if (csi_seen) {

drivers/nvme/target/passthru.c void nvmet_passthrough_override_cap(struct nvmet_ctrl *ctrl) · line 80

Quoted 10 lines
drivers/nvme/target/passthru.c +10 -0
+		cur = data;
+		cur->nidt = NVME_NIDT_CSI;
+		cur->nidl = NVME_NIDT_CSI_LEN;
+		memcpy(data + sizeof(struct nvme_ns_id_desc), &csi,  NVME_NIDT_CSI_LEN);
+	}
+	status = nvmet_copy_to_sgl(req, 0, data, NVME_IDENTIFY_DATA_SIZE);
+out_free:
+	kfree(data);
+	return status;
+}

I can't understand what this function does...

Quoted 13 lines
drivers/nvme/target/passthru.c +2 -0
+
  static u16 nvmet_passthru_override_id_ctrl(struct nvmet_req *req)
  {
  	struct nvmet_ctrl *ctrl = req->sq->ctrl;
@@ -127,6 +176,7 @@ static u16 nvmet_passthru_override_id_ctrl(struct nvmet_req *req)
 
  static u16 nvmet_passthru_override_id_ns(struct nvmet_req *req)
  {
+	struct nvmet_ctrl *ctrl = req->sq->ctrl;
  	u16 status = NVME_SC_SUCCESS;
  	struct nvme_id_ns *id;
  	int i;

drivers/nvme/target/passthru.c static u16 nvmet_passthru_override_id_ns(struct nvmet_req *req) · line 207

Quoted 6 lines
drivers/nvme/target/passthru.c +3 -0
@@ -152,6 +202,11 @@ static u16 nvmet_passthru_override_id_ns(struct nvmet_req *req)
  	 */
  	id->mc = 0;
 
+	if (ctrl->subsys->clear_ids) {
+		memset(id->nguid, 0, NVME_NIDT_NGUID_LEN);
+		memset(id->eui64, 0, NVME_NIDT_EUI64_LEN);

What about uuid?

Quoted 15 lines
drivers/nvme/target/passthru.c +5 -0
+	}
+
  	status = nvmet_copy_to_sgl(req, 0, id, sizeof(*id));
 
  out_free:
@@ -176,6 +231,9 @@ static void nvmet_passthru_execute_cmd_work(struct work_struct *w)
  		case NVME_ID_CNS_NS:
  			nvmet_passthru_override_id_ns(req);
  			break;
+		case NVME_ID_CNS_NS_DESC_LIST:
+			nvmet_passthru_override_id_descs(req);
+			break;
  		}
  	} else if (status < 0)
  		status = NVME_SC_INTERNAL;
maintainer
#2 lore raw
Quoted 2 lines

I can't understand what this function does...

OK, just learned about it from a different thread. You can disregard.

maintainer Reviewed-by on v1 1/1
#3 lore raw
In reply to Alan Adamson
Quoted 6 lines · Alan Adamson

If the clear_ids attribute is set to true, the EUI/GUID/UUID is cleared for the passthru target. By default, loop targets will set clear_ids to true.

This resolves an issue where a connect to a passthru target fails when using a trtype of 'loop' because EUI/GUID/UUID is not unique.

This looks good to me.

Reviewed-by on v1 1/1
#4 lore raw
In reply to Alan Adamson
Quoted 20 lines · Alan Adamson

If the clear_ids attribute is set to true, the EUI/GUID/UUID is cleared for the passthru target. By default, loop targets will set clear_ids to true.

This resolves an issue where a connect to a passthru target fails when using a trtype of 'loop' because EUI/GUID/UUID is not unique.

---
  drivers/nvme/target/configfs.c | 20 ++++++++++++
  drivers/nvme/target/core.c     |  4 +++
  drivers/nvme/target/nvmet.h    |  1 +
  drivers/nvme/target/passthru.c | 58 ++++++++++++++++++++++++++++++++++
  4 files changed, 83 insertions(+)
drivers/nvme/target/configfs.c +0 -0
index e44b2988759e..ff77c3d2354f 100644

drivers/nvme/target/configfs.c static ssize_t nvmet_passthru_io_timeout_store(struct config_item *item, · line 779

Quoted 7 lines
drivers/nvme/target/configfs.c +4 -0
@@ -773,11 +773,31 @@ static ssize_t nvmet_passthru_io_timeout_store(struct config_item *item,
  }
  CONFIGFS_ATTR(nvmet_passthru_, io_timeout);
 
+static ssize_t nvmet_passthru_clear_ids_show(struct config_item *item,
+		char *page)
+{
+	return sprintf(page, "%u\n", to_subsys(item->ci_parent)->clear_ids);

should we use snprintf() ? (I don't think so just a thought.

Quoted 59 lines
drivers/nvme/target/configfs.c +16 -0
+}
+
+static ssize_t nvmet_passthru_clear_ids_store(struct config_item *item,
+		const char *page, size_t count)
+{
+	struct nvmet_subsys *subsys = to_subsys(item->ci_parent);
+	unsigned int clear_ids;
+
+	if (kstrtouint(page, 0, &clear_ids))
+		return -EINVAL;
+	subsys->clear_ids = clear_ids;
+	return count;
+}
+CONFIGFS_ATTR(nvmet_passthru_, clear_ids);
+
  static struct configfs_attribute *nvmet_passthru_attrs[] = {
  	&nvmet_passthru_attr_device_path,
  	&nvmet_passthru_attr_enable,
  	&nvmet_passthru_attr_admin_timeout,
  	&nvmet_passthru_attr_io_timeout,
+	&nvmet_passthru_attr_clear_ids,
  	NULL,
  };
 
drivers/nvme/target/core.c +4 -0
index 90e75324dae0..d4203d582343 100644
@@ -1374,6 +1374,10 @@ u16 nvmet_alloc_ctrl(const char *subsysnqn, const char *hostnqn,
  	ctrl->port = req->port;
  	ctrl->ops = req->ops;
 
+	/* By default, set loop targets to clear IDS by default */
+	if (ctrl->port->disc_addr.trtype == NVMF_TRTYPE_LOOP)
+		subsys->clear_ids = 1;
+
  	INIT_WORK(&ctrl->async_event_work, nvmet_async_event_work);
  	INIT_LIST_HEAD(&ctrl->async_events);
  	INIT_RADIX_TREE(&ctrl->p2p_ns_map, GFP_KERNEL);
drivers/nvme/target/nvmet.h +1 -0
index 69818752a33a..2b3e5719f24e 100644
@@ -249,6 +249,7 @@ struct nvmet_subsys {
  	struct config_group	passthru_group;
  	unsigned int		admin_timeout;
  	unsigned int		io_timeout;
+	unsigned int		clear_ids;
  #endif /* CONFIG_NVME_TARGET_PASSTHRU */
 
  #ifdef CONFIG_BLK_DEV_ZONED
drivers/nvme/target/passthru.c +0 -0
index b1f7efab3918..e8c033fbdb5c 100644
@@ -30,6 +30,55 @@ void nvmet_passthrough_override_cap(struct nvmet_ctrl *ctrl)
  		ctrl->cap &= ~(1ULL << 43);
  }
 

drivers/nvme/target/passthru.c void nvmet_passthrough_override_cap(struct nvmet_ctrl *ctrl) · line 42

Quoted 10 lines
drivers/nvme/target/passthru.c +10 -0
+static u16 nvmet_passthru_override_id_descs(struct nvmet_req *req)
+{
+	struct nvmet_ctrl *ctrl = req->sq->ctrl;
+	void *data;
+	struct nvme_ns_id_desc *cur;
+	u16 status = NVME_SC_SUCCESS;
+	u8 csi;
+	int pos, len;
+	bool csi_seen;
+

consider followig if it works, totally untested :-

        struct nvmet_ctrl *ctrl = req->sq->ctrl;
        struct nvme_ns_id_desc *cur;
        u16 status = NVME_SC_SUCCESS;
        int pos, len;
        bool csi_seen;
        void *data;
        u8 csi;
Quoted 43 lines
drivers/nvme/target/passthru.c +39 -0
+	if (!ctrl->subsys->clear_ids)
+		return status;
+
+	data = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
+	if (!data)
+		return NVME_SC_INTERNAL;
+
+	status = nvmet_copy_from_sgl(req, 0, data, NVME_IDENTIFY_DATA_SIZE);
+	if (status)
+		goto out_free;
+
+	for (pos = 0; pos < NVME_IDENTIFY_DATA_SIZE; pos += len) {
+		cur = data + pos;
+
+		if (cur->nidl == 0)
+			break;
+		len = cur->nidl;
+		if (cur->nidt == NVME_NIDT_CSI) {
+			memcpy(&csi, data + pos + sizeof(struct nvme_ns_id_desc),
+			       NVME_NIDT_CSI_LEN);
+			csi_seen = 1;
+			break;
+		}
+		len += sizeof(struct nvme_ns_id_desc);
+	}
+
+	memset(data, 0, NVME_IDENTIFY_DATA_SIZE);
+	if (csi_seen) {
+		cur = data;
+		cur->nidt = NVME_NIDT_CSI;
+		cur->nidl = NVME_NIDT_CSI_LEN;
+		memcpy(data + sizeof(struct nvme_ns_id_desc), &csi,  NVME_NIDT_CSI_LEN);
+	}
+	status = nvmet_copy_to_sgl(req, 0, data, NVME_IDENTIFY_DATA_SIZE);
+out_free:
+	kfree(data);
+	return status;
+}
+
  static u16 nvmet_passthru_override_id_ctrl(struct nvmet_req *req)
  {
  	struct nvmet_ctrl *ctrl = req->sq->ctrl;

drivers/nvme/target/passthru.c static u16 nvmet_passthru_override_id_ctrl(struct nvmet_req *req) · line 179

Quoted 4 lines
drivers/nvme/target/passthru.c +1 -0
@@ -127,6 +176,7 @@ static u16 nvmet_passthru_override_id_ctrl(struct nvmet_req *req)
 
  static u16 nvmet_passthru_override_id_ns(struct nvmet_req *req)
  {
+	struct nvmet_ctrl *ctrl = req->sq->ctrl;

since ctrl is only used once in this function do can we get away with the req->sq->ctrl->subsys->clear_ids ?

Quoted 16 lines
drivers/nvme/target/passthru.c +5 -0
  	u16 status = NVME_SC_SUCCESS;
  	struct nvme_id_ns *id;
  	int i;
@@ -152,6 +202,11 @@ static u16 nvmet_passthru_override_id_ns(struct nvmet_req *req)
  	 */
  	id->mc = 0;
 
+	if (ctrl->subsys->clear_ids) {
+		memset(id->nguid, 0, NVME_NIDT_NGUID_LEN);
+		memset(id->eui64, 0, NVME_NIDT_EUI64_LEN);
+	}
+
  	status = nvmet_copy_to_sgl(req, 0, id, sizeof(*id));
 
  out_free:

drivers/nvme/target/passthru.c static void nvmet_passthru_execute_cmd_work(struct work_struct *w) · line 239

Quoted 9 lines
drivers/nvme/target/passthru.c +3 -0
@@ -176,6 +231,9 @@ static void nvmet_passthru_execute_cmd_work(struct work_struct *w)
  		case NVME_ID_CNS_NS:
  			nvmet_passthru_override_id_ns(req);
  			break;
+		case NVME_ID_CNS_NS_DESC_LIST:
+			nvmet_passthru_override_id_descs(req);
+			break;
  		}
  	} else if (status < 0)
  		status = NVME_SC_INTERNAL;

Irrespective of cosmetics, looks good.

-ck

#5 lore raw
Quoted 28 lines · Chaitanya Kulkarni
Quoted 23 lines · Alan Adamson

If the clear_ids attribute is set to true, the EUI/GUID/UUID is cleared for the passthru target. By default, loop targets will set clear_ids to true.

This resolves an issue where a connect to a passthru target fails when using a trtype of 'loop' because EUI/GUID/UUID is not unique.

---
 drivers/nvme/target/configfs.c | 20 ++++++++++++
 drivers/nvme/target/core.c     |  4 +++
 drivers/nvme/target/nvmet.h    |  1 +
 drivers/nvme/target/passthru.c | 58 ++++++++++++++++++++++++++++++++++
 4 files changed, 83 insertions(+)
drivers/nvme/target/configfs.c +0 -0
index e44b2988759e..ff77c3d2354f 100644
@@ -773,11 +773,31 @@ static ssize_t nvmet_passthru_io_timeout_store(struct config_item *item,
 }
 CONFIGFS_ATTR(nvmet_passthru_, io_timeout);
 
Quoted 6 lines

drivers/nvme/target/configfs.c static ssize_t nvmet_passthru_io_timeout_store(struct config_item *item, · line 779

Quoted 4 lines
drivers/nvme/target/configfs.c +4 -0
+static ssize_t nvmet_passthru_clear_ids_show(struct config_item *item,
+		char *page)
+{
+	return sprintf(page, "%u\n", to_subsys(item->ci_parent)->clear_ids);

should we use snprintf() ? (I don't think so just a thought.

I used sprintf() to be consistent with the other passthru attributes.

Quoted 14 lines

drivers/nvme/target/configfs.c static ssize_t nvmet_passthru_io_timeout_store(struct config_item *item, · line 789

Quoted 11 lines
drivers/nvme/target/configfs.c +10 -0
+static u16 nvmet_passthru_override_id_descs(struct nvmet_req *req)
+{
+	struct nvmet_ctrl *ctrl = req->sq->ctrl;
+	void *data;
+	struct nvme_ns_id_desc *cur;
+	u16 status = NVME_SC_SUCCESS;
+	u8 csi;
+	int pos, len;
+	bool csi_seen;
+

consider followig if it works, totally untested :-

Quoted 7 lines
       struct nvmet_ctrl *ctrl = req->sq->ctrl;
       struct nvme_ns_id_desc *cur;
       u16 status = NVME_SC_SUCCESS;
       int pos, len;
       bool csi_seen;
       void *data;
       u8 csi;

I'll include these changes in v2.

Quoted 7 lines

drivers/nvme/target/configfs.c static ssize_t nvmet_passthru_io_timeout_store(struct config_item *item, · line 792

Quoted 4 lines
drivers/nvme/target/configfs.c +1 -0
 static u16 nvmet_passthru_override_id_ns(struct nvmet_req *req)
 {
+	struct nvmet_ctrl *ctrl = req->sq->ctrl;

since ctrl is only used once in this function do can we get away with the req->sq->ctrl->subsys->clear_ids ?

I’ll include in v2.

Quoted 8 lines
Quoted 1 line

Irrespective of cosmetics, looks good.

-ck

Thanks,

Alan