libnvme: drop support for hostid config

The NVMe subsystem of Linux expects a 1:1 mapping of the hostnqn to
hostid. There is no point in exposing the hostid argument through all
public APIs.

To ensure backward compatibility, always set the hostid extracted from
the hostnqn when building the connect string. This matches the default
behavior prior to removing hostid from the API.

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

Author: igaw

fabrics.c

@@ -70,7 +70,7 @@ static const char *nvmf_trsvcid		= "transport service id (e.g. IP port)";
 static const char *nvmf_htraddr		= "host traddr (e.g. FC WWN's)";
 static const char *nvmf_hiface		= "host interface (for tcp transport)";
 static const char *nvmf_hostnqn		= "user-defined hostnqn";
-static const char *nvmf_hostid		= "user-defined hostid (if default not used)";
+static const char *nvmf_hostid		= "(deprecated and ignored)";
 static const char *nvmf_hostkey		= "user-defined dhchap key (if default not used)";
 static const char *nvmf_ctrlkey		= "user-defined dhchap controller key (for bi-directional authentication)";
 static const char *nvmf_nr_io_queues	= "number of io queues to use (default is core count)";
@@ -334,7 +334,7 @@ static int setup_common_context(struct nvmf_context *fctx,
 		return err;
 
 	err = nvmf_context_set_hostnqn(fctx,
-		fa->hostnqn, fa->hostid);
+		fa->hostnqn);
 	if (err)
 		return err;
 
@@ -367,7 +367,7 @@ static int create_common_context(struct nvme_global_ctx *ctx,
 	if (err)
 		goto err;
 
-	err = nvmf_context_set_hostnqn(fctx, fa->hostnqn, fa->hostid);
+	err = nvmf_context_set_hostnqn(fctx, fa->hostnqn);
 	if (err)
 		goto err;
 

libnvme/doc/config-schema.json.in

@@ -21,10 +21,6 @@
 		    "type": "string",
 		    "maxLength": 223
 		},
-		"hostid": {
-		    "description": "NVMe host ID",
-		    "type": "string"
-		},
 		"dhchap_key": {
 		    "description": "Host DH-HMAC-CHAP key",
 		    "type": "string"

libnvme/examples/discover-loop.c

@@ -69,7 +69,7 @@ int main()
 		nvme_free_global_ctx(ctx);
 		return 1;
 	}
-	ret = nvme_get_host(ctx, NULL, NULL, &h);
+	ret = nvme_get_host(ctx, NULL, &h);
 	if (ret) {
 		fprintf(stderr, "Failed to allocated memory\n");
 		return 1;

libnvme/libnvme/nvme.i

@@ -44,15 +44,8 @@
 		free(val);
 		return obj;
 	}
-	PyObject *read_hostid() {
-		char * val = nvme_read_hostid();
-		PyObject * obj = val ? PyUnicode_FromString(val) : Py_NewRef(Py_None);
-		free(val);
-		return obj;
-	}
 %}
 PyObject *read_hostnqn();
-PyObject *read_hostid();
 
 %exception nvme_ctrl::connect {
 	connect_err = 0;
@@ -363,10 +356,8 @@ struct nvme_global_ctx {
 
 struct nvme_host {
 	%immutable hostnqn;
-	%immutable hostid;
 	%immutable hostsymname;
 	char *hostnqn;
-	char *hostid;
 	char *hostsymname;
 	%extend {
 		char *dhchap_host_key;
@@ -546,18 +537,16 @@ struct nvme_ns {
 
 %pythonappend nvme_host::nvme_host(struct nvme_global_ctx *ctx,
 				   const char *hostnqn,
-				   const char *hostid,
 				   const char *hostkey,
 				   const char *hostsymname) {
 	self.__parent = ctx  # Keep a reference to parent to ensure garbage collection happens in the right order}
 %extend nvme_host {
 	nvme_host(struct nvme_global_ctx *ctx,
 		  const char *hostnqn = NULL,
-		  const char *hostid = NULL,
 		  const char *hostkey = NULL,
 		  const char *hostsymname = NULL) {
 		nvme_host_t h;
-		if (nvme_get_host(ctx, hostnqn, hostid, &h))
+		if (nvme_get_host(ctx, hostnqn, &h))
 			return NULL;
 		if (hostsymname)
 			nvme_host_set_hostsymname(h, hostsymname);
@@ -580,7 +569,7 @@ struct nvme_ns {
 	}
 
 	PyObject* __str__() {
-		return PyUnicode_FromFormat("nvme.host(%s,%s)", STR_OR_NONE($self->hostnqn), STR_OR_NONE($self->hostid));
+		return PyUnicode_FromFormat("nvme.host(%s)", STR_OR_NONE($self->hostnqn));
 	}
 	%pythoncode %{
 	def subsystems(self):

libnvme/libnvme/tests/test-objects.py

@@ -69,13 +69,6 @@ def test_creation_with_explicit_hostnqn(self):
         self.assertIsNotNone(host)
         self.assertEqual(host.hostnqn, hostnqn)
 
-    def test_creation_with_hostnqn_and_hostid(self):
-        hostnqn = 'nqn.2014-08.com.example:test-host-props'
-        hostid = '11111111-2222-3333-4444-555555555555'
-        host = nvme.host(self.ctx, hostnqn=hostnqn, hostid=hostid)
-        self.assertEqual(host.hostnqn, hostnqn)
-        self.assertEqual(host.hostid, hostid)
-
     def test_creation_with_hostsymname(self):
         hostnqn = 'nqn.2014-08.com.example:test-host-symname'
         symname = 'my-storage-host'
@@ -248,10 +241,6 @@ def test_read_hostnqn_returns_string_or_none(self):
         hostnqn = nvme.read_hostnqn()
         self.assertIsInstance(hostnqn, (str, type(None)))
 
-    def test_read_hostid_returns_string_or_none(self):
-        hostid = nvme.read_hostid()
-        self.assertIsInstance(hostid, (str, type(None)))
-
 
 if __name__ == '__main__':
     unittest.main()

libnvme/src/accessors.ld

@@ -84,7 +84,6 @@ LIBNVME_ACCESSORS_3 {
 		nvme_subsystem_get_iopolicy;
 		nvme_subsystem_set_iopolicy;
 		nvme_host_get_hostnqn;
-		nvme_host_get_hostid;
 		nvme_host_get_dhchap_host_key;
 		nvme_host_set_dhchap_host_key;
 		nvme_host_get_hostsymname;

libnvme/src/libnvme.ld

@@ -42,9 +42,7 @@ LIBNVME_3 {
 		nvme_free_ns;
 		nvme_free_subsystem;
 		nvme_gen_dhchap_key;
-		nvme_generate_hostid;
 		nvme_generate_hostnqn;
-		nvme_generate_hostnqn_from_hostid;
 		nvme_generate_tls_key_identity;
 		nvme_generate_tls_key_identity_compat;
 		nvme_get_ana_log_atomic;
@@ -72,9 +70,9 @@ LIBNVME_3 {
 		nvme_get_uuid_list;
 		nvme_get_version;
 		nvme_host_get_global_ctx;
-		nvme_host_get_ids;
 		nvme_host_is_pdc_enabled;
 		nvme_host_release_fds;
+		nvme_host_resolve_hostnqn;
 		nvme_host_set_pdc_enabled;
 		nvme_import_tls_key;
 		nvme_import_tls_key_versioned;
@@ -144,7 +142,6 @@ LIBNVME_3 {
 		nvme_path_get_queue_depth;
 		nvme_random_uuid;
 		nvme_read_config;
-		nvme_read_hostid;
 		nvme_read_hostnqn;
 		nvme_read_key;
 		nvme_read_nbft;

libnvme/src/nvme/accessors.c

@@ -452,11 +452,6 @@ __public const char *nvme_host_get_hostnqn(const struct nvme_host *p)
 	return p->hostnqn;
 }
 
-__public const char *nvme_host_get_hostid(const struct nvme_host *p)
-{
-	return p->hostid;
-}
-
 __public void nvme_host_set_dhchap_host_key(
 		struct nvme_host *p,
 		const char *dhchap_host_key)
@@ -668,30 +663,30 @@ __public bool nvme_fabric_options_get_host_traddr(
 	return p->host_traddr;
 }
 
-__public void nvme_fabric_options_set_hostid(
+__public void nvme_fabric_options_set_hostnqn(
 		struct nvme_fabric_options *p,
-		bool hostid)
+		bool hostnqn)
 {
-	p->hostid = hostid;
+	p->hostnqn = hostnqn;
 }
 
-__public bool nvme_fabric_options_get_hostid(
+__public bool nvme_fabric_options_get_hostnqn(
 		const struct nvme_fabric_options *p)
 {
-	return p->hostid;
+	return p->hostnqn;
 }
 
-__public void nvme_fabric_options_set_hostnqn(
+__public void nvme_fabric_options_set_hostid(
 		struct nvme_fabric_options *p,
-		bool hostnqn)
+		bool hostid)
 {
-	p->hostnqn = hostnqn;
+	p->hostid = hostid;
 }
 
-__public bool nvme_fabric_options_get_hostnqn(
+__public bool nvme_fabric_options_get_hostid(
 		const struct nvme_fabric_options *p)
 {
-	return p->hostnqn;
+	return p->hostid;
 }
 
 __public void nvme_fabric_options_set_instance(

libnvme/src/nvme/accessors.h

@@ -634,14 +634,6 @@ const char *nvme_subsystem_get_iopolicy(const struct nvme_subsystem *p);
  */
 const char *nvme_host_get_hostnqn(const struct nvme_host *p);
 
-/**
- * nvme_host_get_hostid() - Get hostid.
- * @p: The &struct nvme_host instance to query.
- *
- * Return: The value of the hostid field, or NULL if not set.
- */
-const char *nvme_host_get_hostid(const struct nvme_host *p);
-
 /**
  * nvme_host_set_dhchap_host_key() - Set dhchap_host_key.
  * @p: The &struct nvme_host instance to update.
@@ -917,36 +909,36 @@ void nvme_fabric_options_set_host_traddr(
 bool nvme_fabric_options_get_host_traddr(const struct nvme_fabric_options *p);
 
 /**
- * nvme_fabric_options_set_hostid() - Set hostid.
+ * nvme_fabric_options_set_hostnqn() - Set hostnqn.
  * @p: The &struct nvme_fabric_options instance to update.
- * @hostid: Value to assign to the hostid field.
+ * @hostnqn: Value to assign to the hostnqn field.
  */
-void nvme_fabric_options_set_hostid(struct nvme_fabric_options *p, bool hostid);
+void nvme_fabric_options_set_hostnqn(
+		struct nvme_fabric_options *p,
+		bool hostnqn);
 
 /**
- * nvme_fabric_options_get_hostid() - Get hostid.
+ * nvme_fabric_options_get_hostnqn() - Get hostnqn.
  * @p: The &struct nvme_fabric_options instance to query.
  *
- * Return: The value of the hostid field.
+ * Return: The value of the hostnqn field.
  */
-bool nvme_fabric_options_get_hostid(const struct nvme_fabric_options *p);
+bool nvme_fabric_options_get_hostnqn(const struct nvme_fabric_options *p);
 
 /**
- * nvme_fabric_options_set_hostnqn() - Set hostnqn.
+ * nvme_fabric_options_set_hostid() - Set hostid.
  * @p: The &struct nvme_fabric_options instance to update.
- * @hostnqn: Value to assign to the hostnqn field.
+ * @hostid: Value to assign to the hostid field.
  */
-void nvme_fabric_options_set_hostnqn(
-		struct nvme_fabric_options *p,
-		bool hostnqn);
+void nvme_fabric_options_set_hostid(struct nvme_fabric_options *p, bool hostid);
 
 /**
- * nvme_fabric_options_get_hostnqn() - Get hostnqn.
+ * nvme_fabric_options_get_hostid() - Get hostid.
  * @p: The &struct nvme_fabric_options instance to query.
  *
- * Return: The value of the hostnqn field.
+ * Return: The value of the hostid field.
  */
-bool nvme_fabric_options_get_hostnqn(const struct nvme_fabric_options *p);
+bool nvme_fabric_options_get_hostid(const struct nvme_fabric_options *p);
 
 /**
  * nvme_fabric_options_set_instance() - Set instance.