tree: add nvme_host_get

Replace nvme_default_host() with generic nvme_host_get(), which creates
the host object on demand. This enables retiring nvme_lookup_host() from
the public API.

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

Author: igaw

libnvme/examples/discover-loop.c

@@ -62,7 +62,7 @@ int main()
 	ret = nvme_scan(NULL, &ctx);
 	if (ret)
 		return ret;
-	ret = nvme_default_host(ctx, &h);
+	ret = nvme_host_get(ctx, NULL, NULL, &h);
 	if (ret) {
 		fprintf(stderr, "Failed to allocated memory\n");
 		return ret;

libnvme/libnvme/nvme.i

@@ -556,9 +556,7 @@ struct nvme_ns {
 		  const char *hostkey = NULL,
 		  const char *hostsymname = NULL) {
 		nvme_host_t h;
-		if (hostnqn)
-			h = nvme_lookup_host(ctx, hostnqn, hostid);
-		if (nvme_default_host(ctx, &h))
+		if (nvme_host_get(ctx, hostnqn, hostid, &h))
 			return NULL;
 		if (hostsymname)
 			nvme_host_set_hostsymname(h, hostsymname);

libnvme/src/libnvme.ld

@@ -56,7 +56,6 @@ LIBNVME_2_0 {
 		nvme_ctrl_set_tls_key_identity;
 		nvme_ctrl_set_unique_discovery_ctrl;
 		nvme_ctrls_filter;
-		nvme_default_host;
 		nvme_describe_key_serial;
 		nvme_disconnect_ctrl;
 		nvme_dump_config;
@@ -100,6 +99,7 @@ LIBNVME_2_0 {
 		nvme_get_telemetry_max;
 		nvme_get_uuid_list;
 		nvme_get_version;
+		nvme_host_get;
 		nvme_host_get_dhchap_key;
 		nvme_host_get_global_ctx;
 		nvme_host_get_hostid;
@@ -127,7 +127,6 @@ LIBNVME_2_0 {
 		nvme_insert_tls_key_versioned;
 		nvme_ipaddrs_eq;
 		nvme_lookup_ctrl;
-		nvme_lookup_host;
 		nvme_lookup_key;
 		nvme_lookup_keyring;
 		nvme_lookup_subsystem;

libnvme/src/nvme/private.h

@@ -411,6 +411,9 @@ void *__nvme_alloc(size_t len);
 
 void *__nvme_realloc(void *p, size_t len);
 
+nvme_host_t nvme_lookup_host(struct nvme_global_ctx *ctx, const char *hostnqn,
+			     const char *hostid);
+
 #if (LOG_FUNCNAME == 1)
 #define __nvme_log_func __func__
 #else

libnvme/src/nvme/tree.c

@@ -194,18 +194,19 @@ int nvme_host_get_ids(struct nvme_global_ctx *ctx,
 	return 0;
 }
 
-int nvme_default_host(struct nvme_global_ctx *ctx, nvme_host_t *hp)
+int nvme_host_get(struct nvme_global_ctx *ctx, const char *hostnqn,
+		const char *hostid, nvme_host_t *hp)
 {
-	_cleanup_free_ char *hostnqn = NULL;
-	_cleanup_free_ char *hostid = NULL;
+	_cleanup_free_ char *hnqn = NULL;
+	_cleanup_free_ char *hid = NULL;
 	struct nvme_host *h;
 	int err;
 
-	err = nvme_host_get_ids(ctx, NULL, NULL, &hostnqn, &hostid);
+	err = nvme_host_get_ids(ctx, hostnqn, hostid, &hnqn, &hid);
 	if (err)
 		return err;
 
-	h = nvme_lookup_host(ctx, hostnqn, hostid);
+	h = nvme_lookup_host(ctx, hnqn, hid);
 
 	nvme_host_set_hostsymname(h, NULL);
 
@@ -888,7 +889,7 @@ static int nvme_scan_subsystem(struct nvme_global_ctx *ctx, const char *name)
 		 */
 		nvme_msg(ctx, LOG_DEBUG, "creating detached subsystem '%s'\n",
 			 name);
-		ret = nvme_default_host(ctx, &h);
+		ret = nvme_host_get(ctx, NULL, NULL, &h);
 		if (ret)
 			return ret;
 		s = nvme_alloc_subsystem(h, name, subsysnqn);
@@ -2255,21 +2256,17 @@ int nvme_scan_ctrl(struct nvme_global_ctx *ctx, const char *name,
 
 	hostnqn = nvme_get_attr(path, "hostnqn");
 	hostid = nvme_get_attr(path, "hostid");
-	h = nvme_lookup_host(ctx, hostnqn, hostid);
-	if (h) {
-		host_key = nvme_get_attr(path, "dhchap_secret");
-		if (host_key && strcmp(host_key, "none")) {
-			free(h->dhchap_key);
-			h->dhchap_key = host_key;
-			host_key = NULL;
-		}
-		free(host_key);
-	}
-	if (!h) {
-		ret = nvme_default_host(ctx, &h);
-		if (ret)
-			return ret;
+	ret = nvme_host_get(ctx, hostnqn, hostid, &h);
+	if (ret)
+		return ret;
+
+	host_key = nvme_get_attr(path, "dhchap_secret");
+	if (host_key && strcmp(host_key, "none")) {
+		free(h->dhchap_key);
+		h->dhchap_key = host_key;
+		host_key = NULL;
 	}
+	free(host_key);
 
 	subsysnqn = nvme_get_attr(path, "subsysnqn");
 	if (!subsysnqn)

libnvme/src/nvme/tree.h

@@ -96,20 +96,6 @@ nvme_host_t nvme_next_host(struct nvme_global_ctx *ctx, nvme_host_t h);
  */
 struct nvme_global_ctx *nvme_host_get_global_ctx(nvme_host_t h);
 
-/**
- * nvme_lookup_host() - Lookup nvme_host_t object
- * @ctx:	struct nvme_global_ctx object
- * @hostnqn:	Host NQN
- * @hostid:	Host ID
- *
- * Lookup a nvme_host_t object based on @hostnqn and @hostid
- * or create one if not found.
- *
- * Return: &nvme_host_t object
- */
-nvme_host_t nvme_lookup_host(struct nvme_global_ctx *ctx, const char *hostnqn,
-			     const char *hostid);
-
 /**
  * nvme_host_get_dhchap_key() - Return host key
  * @h:	Host for which the key should be returned
@@ -148,16 +134,19 @@ void nvme_host_set_pdc_enabled(nvme_host_t h, bool enabled);
 bool nvme_host_is_pdc_enabled(nvme_host_t h, bool fallback);
 
 /**
- * nvme_default_host() - Initializes the default host
+ * nvme_host_get() - Returns a host object
  * @ctx:	struct nvme_global_ctx object
- * @h:  &nvme_host_t object to return
+ * @hostnqn:	Host NQN (optional)
+ * @hostid:	Host ID (optional)
+ * @h:		&nvme_host_t object to return
  *
- * Initializes the default host object based on the hostnqn/hostid
- * values returned by nvme_host_get_ids() and attaches it to @r.
+ * Returns a host object based on the hostnqn/hostid values or the default if
+ * hostnqn/hostid are NULL.
  *
  * Return: 0 on success or negative error code otherwise
  */
-int nvme_default_host(struct nvme_global_ctx *ctx, nvme_host_t *h);
+int nvme_host_get(struct nvme_global_ctx *ctx, const char *hostnqn,
+		const char *hostid, nvme_host_t *h);
 
 /**
  * nvme_host_get_ids - Retrieve host ids from various sources

libnvme/test/tree.c

@@ -17,6 +17,8 @@
 
 struct test_data {
 	/* input data */
+	const char *hostnqn;
+	const char *hostid;
 	const char *subsysname;
 	const char *subsysnqn;
 	const char *transport;
@@ -31,23 +33,27 @@ struct test_data {
 	int ctrl_id;
 };
 
+#define DEFAULT_HOSTID "9ba1651a-ed36-11f0-9858-6c1ff71ba506"
+#define DEFAULT_HOSTNQN "nqn.2014-08.org.nvmexpress:uuid:DEFAULT_HOSTID"
 #define DEFAULT_SUBSYSNAME "subsysname"
 #define DEFAULT_SUBSYSNQN "subsysnqn"
 #define SRC_ADDR4 "192.168.56.100"
 #define SRC_ADDR6 "1234:5678:abcd:EF01:1234:5678:abcd:EF01"
 
+#define DEFAULTS DEFAULT_HOSTNQN, DEFAULT_HOSTNQN, DEFAULT_SUBSYSNAME, DEFAULT_SUBSYSNQN
+
 struct test_data test_data[] = {
-	{ DEFAULT_SUBSYSNAME, DEFAULT_SUBSYSNQN, "tcp", "192.168.1.1", "192.168.1.20", NULL, "4420" },
-	{ DEFAULT_SUBSYSNAME, DEFAULT_SUBSYSNQN, "tcp", "192.168.1.1", "192.168.1.20", NULL, "4421" },
-	{ DEFAULT_SUBSYSNAME, DEFAULT_SUBSYSNQN, "tcp", "192.168.1.2", "192.168.1.20", "eth1", "4420" },
-	{ DEFAULT_SUBSYSNAME, DEFAULT_SUBSYSNQN, "tcp", "192.168.1.2", "192.168.1.20", "eth1", "4421" },
-	{ DEFAULT_SUBSYSNAME, DEFAULT_SUBSYSNQN, "rdma", "192.168.1.3", "192.168.1.20", NULL, NULL },
-	{ DEFAULT_SUBSYSNAME, DEFAULT_SUBSYSNQN, "rdma", "192.168.1.4", "192.168.1.20", NULL, NULL },
-	{ DEFAULT_SUBSYSNAME, DEFAULT_SUBSYSNQN, "fc",
+	{ DEFAULTS, "tcp", "192.168.1.1", "192.168.1.20", NULL, "4420" },
+	{ DEFAULTS, "tcp", "192.168.1.1", "192.168.1.20", NULL, "4421" },
+	{ DEFAULTS, "tcp", "192.168.1.2", "192.168.1.20", "eth1", "4420" },
+	{ DEFAULTS, "tcp", "192.168.1.2", "192.168.1.20", "eth1", "4421" },
+	{ DEFAULTS, "rdma", "192.168.1.3", "192.168.1.20", NULL, NULL },
+	{ DEFAULTS, "rdma", "192.168.1.4", "192.168.1.20", NULL, NULL },
+	{ DEFAULTS, "fc",
 	  "nn-0x201700a09890f5bf:pn-0x201900a09890f5bf",
 	  "nn-0x200000109b579ef3:pn-0x100000109b579ef3"
 	},
-	{ DEFAULT_SUBSYSNAME, DEFAULT_SUBSYSNQN, "fc",
+	{ DEFAULTS, "fc",
 	  "nn-0x201700a09890f5bf:pn-0x201900a09890f5bf",
 	  "nn-0x200000109b579ef6:pn-0x100000109b579ef6",
 	},
@@ -125,7 +131,7 @@ static struct nvme_global_ctx *create_tree()
 
 	ctx = nvme_create_global_ctx(stdout, LOG_DEBUG);
 	assert(ctx);
-	nvme_default_host(ctx, &h);
+	nvme_host_get(ctx, DEFAULT_HOSTNQN, DEFAULT_HOSTID, &h);
 	assert(h);
 
 	printf("  ctrls created:\n");
@@ -281,7 +287,7 @@ static bool test_src_addr()
 	ctx = nvme_create_global_ctx(stdout, LOG_DEBUG);
 	assert(ctx);
 
-	nvme_default_host(ctx, &h);
+	nvme_host_get(ctx, DEFAULT_HOSTNQN, DEFAULT_HOSTID, &h);
 	assert(h);
 
 	s = nvme_lookup_subsystem(h, DEFAULT_SUBSYSNAME, DEFAULT_SUBSYSNQN);
@@ -457,7 +463,7 @@ static bool ctrl_match(const char *tag,
 	ctx = nvme_create_global_ctx(stdout, LOG_INFO);
 	assert(ctx);
 
-	nvme_default_host(ctx, &h);
+	nvme_host_get(ctx, DEFAULT_HOSTNQN, DEFAULT_HOSTID, &h);
 	assert(h);
 
 	s = nvme_lookup_subsystem(h, DEFAULT_SUBSYSNAME, reference->subsysnqn ? reference->subsysnqn : DEFAULT_SUBSYSNQN);
@@ -1070,7 +1076,7 @@ static bool ctrl_config_match(const char *tag,
 	ctx = nvme_create_global_ctx(stdout, LOG_INFO);
 	assert(ctx);
 
-	nvme_default_host(ctx, &h);
+	nvme_host_get(ctx, DEFAULT_HOSTNQN, DEFAULT_HOSTID, &h);
 	assert(h);
 
 	s = nvme_lookup_subsystem(h, DEFAULT_SUBSYSNAME, reference->subsysnqn ? reference->subsysnqn : DEFAULT_SUBSYSNQN);