linux: move the hostid/hostnqn function

The hostid and hostnqn are used through out the library and are not
fabric specific. Because tree.c depends on it move it to linux.c, so
it's possible to make the fabrics code optional.

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

Author: igaw

libnvme/libnvme/nvme.i

@@ -39,13 +39,13 @@
 		Py_XDECREF(val);                   /* .. therefore decrement ref. count. */
 	}
 	PyObject *hostnqn_from_file() {
-		char * val = nvmf_hostnqn_from_file();
+		char * val = nvme_hostnqn_from_file();
 		PyObject * obj = PyUnicode_FromString(val);
 		free(val);
 		return obj;
 	}
 	PyObject *hostid_from_file() {
-		char * val = nvmf_hostid_from_file();
+		char * val = nvme_hostid_from_file();
 		PyObject * obj = PyUnicode_FromString(val);
 		free(val);
 		return obj;

libnvme/src/libnvme.ld

@@ -108,6 +108,11 @@ LIBNVME_2_0 {
 		nvme_host_set_dhchap_key;
 		nvme_host_set_hostsymname;
 		nvme_host_set_pdc_enabled;
+		nvme_hostid_from_file;
+		nvme_hostid_generate;
+		nvme_hostnqn_from_file;
+		nvme_hostnqn_generate;
+		nvme_hostnqn_generate_from_hostid;
 		nvme_import_tls_key;
 		nvme_import_tls_key_versioned;
 		nvme_init_copy_range;
@@ -320,11 +325,6 @@ LIBNVME_2_0 {
 		nvmf_get_default_trsvcid;
 		nvmf_get_discovery_log;
 		nvmf_get_discovery_wargs;
-		nvmf_hostid_from_file;
-		nvmf_hostid_generate;
-		nvmf_hostnqn_from_file;
-		nvmf_hostnqn_generate;
-		nvmf_hostnqn_generate_from_hostid;
 		nvmf_is_registration_supported;
 		nvmf_nbft_free;
 		nvmf_nbft_read_files;

libnvme/src/nvme/fabrics.c

@@ -37,11 +37,6 @@
 #include "cleanup.h"
 #include "private.h"
 
-#define NVMF_HOSTID_SIZE	37
-
-#define NVMF_HOSTNQN_FILE	SYSCONFDIR "/nvme/hostnqn"
-#define NVMF_HOSTID_FILE	SYSCONFDIR "/nvme/hostid"
-
 const char *nvmf_dev = "/dev/nvme-fabrics";
 
 /**
@@ -1391,244 +1386,6 @@ int nvmf_get_discovery_wargs(struct nvme_get_discovery_args *args,
 	return 0;
 }
 
-static int uuid_from_device_tree(char *system_uuid)
-{
-	_cleanup_fd_ int f = -1;
-	ssize_t len;
-
-	f = open(nvme_uuid_ibm_filename(), O_RDONLY);
-	if (f < 0)
-		return -ENXIO;
-
-	memset(system_uuid, 0, NVME_UUID_LEN_STRING);
-	len = read(f, system_uuid, NVME_UUID_LEN_STRING - 1);
-	if (len < 0)
-		return -ENXIO;
-
-	return strlen(system_uuid) ? 0 : -ENXIO;
-}
-
-/*
- * See System Management BIOS (SMBIOS) Reference Specification
- * https://www.dmtf.org/sites/default/files/standards/documents/DSP0134_3.2.0.pdf
- */
-#define DMI_SYSTEM_INFORMATION	1
-
-static bool is_dmi_uuid_valid(const char *buf, size_t len)
-{
-	int i;
-
-	/* UUID bytes are from byte 8 to 23 */
-	if (len < 24)
-		return false;
-
-	/* Test it's a invalid UUID with all zeros */
-	for (i = 8; i < 24; i++) {
-		if (buf[i])
-			break;
-	}
-	if (i == 24)
-		return false;
-
-	return true;
-}
-
-static int uuid_from_dmi_entries(char *system_uuid)
-{
-	_cleanup_dir_ DIR *d = NULL;
-	const char *entries_dir = nvme_dmi_entries_dir();
-	int f;
-	struct dirent *de;
-	char buf[512] = {0};
-
-	system_uuid[0] = '\0';
-	d = opendir(entries_dir);
-	if (!d)
-		return -ENXIO;
-	while ((de = readdir(d))) {
-		char filename[PATH_MAX];
-		int len, type;
-
-		if (de->d_name[0] == '.')
-			continue;
-		sprintf(filename, "%s/%s/type", entries_dir, de->d_name);
-		f = open(filename, O_RDONLY);
-		if (f < 0)
-			continue;
-		len = read(f, buf, 512);
-		close(f);
-		if (len <= 0)
-			continue;
-		if (sscanf(buf, "%d", &type) != 1)
-			continue;
-		if (type != DMI_SYSTEM_INFORMATION)
-			continue;
-		sprintf(filename, "%s/%s/raw", entries_dir, de->d_name);
-		f = open(filename, O_RDONLY);
-		if (f < 0)
-			continue;
-		len = read(f, buf, 512);
-		close(f);
-		if (len <= 0)
-			continue;
-
-		if (!is_dmi_uuid_valid(buf, len))
-			continue;
-
-		/* Sigh. https://en.wikipedia.org/wiki/Overengineering */
-		/* DMTF SMBIOS 3.0 Section 7.2.1 System UUID */
-		sprintf(system_uuid,
-			"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-"
-			"%02x%02x%02x%02x%02x%02x",
-			(uint8_t)buf[8 + 3], (uint8_t)buf[8 + 2],
-			(uint8_t)buf[8 + 1], (uint8_t)buf[8 + 0],
-			(uint8_t)buf[8 + 5], (uint8_t)buf[8 + 4],
-			(uint8_t)buf[8 + 7], (uint8_t)buf[8 + 6],
-			(uint8_t)buf[8 + 8], (uint8_t)buf[8 + 9],
-			(uint8_t)buf[8 + 10], (uint8_t)buf[8 + 11],
-			(uint8_t)buf[8 + 12], (uint8_t)buf[8 + 13],
-			(uint8_t)buf[8 + 14], (uint8_t)buf[8 + 15]);
-		break;
-	}
-	return strlen(system_uuid) ? 0 : -ENXIO;
-}
-
-#define PATH_DMI_PROD_UUID  "/sys/class/dmi/id/product_uuid"
-
-/**
- * uuid_from_product_uuid() - Get system UUID from product_uuid
- * @system_uuid: Where to save the system UUID.
- *
- * Return: 0 on success, -ENXIO otherwise.
- */
-static int uuid_from_product_uuid(char *system_uuid)
-{
-	_cleanup_file_ FILE *stream = NULL;
-	ssize_t nread;
-	_cleanup_free_ char *line = NULL;
-	size_t len = 0;
-
-	stream = fopen(PATH_DMI_PROD_UUID, "re");
-	if (!stream)
-		return -ENXIO;
-	system_uuid[0] = '\0';
-
-	nread = getline(&line, &len, stream);
-	if (nread != NVME_UUID_LEN_STRING)
-		return -ENXIO;
-
-	/* The kernel is handling the byte swapping according DMTF
-	 * SMBIOS 3.0 Section 7.2.1 System UUID */
-
-	memcpy(system_uuid, line, NVME_UUID_LEN_STRING - 1);
-	system_uuid[NVME_UUID_LEN_STRING - 1] = '\0';
-
-	return 0;
-}
-
-/**
- * uuid_from_dmi() - read system UUID
- * @system_uuid: buffer for the UUID
- *
- * The system UUID can be read from two different locations:
- *
- *     1) /sys/class/dmi/id/product_uuid
- *     2) /sys/firmware/dmi/entries
- *
- * Note that the second location is not present on Debian-based systems.
- *
- * Return: 0 on success, negative errno otherwise.
- */
-static int uuid_from_dmi(char *system_uuid)
-{
-	int ret = uuid_from_product_uuid(system_uuid);
-	if (ret != 0)
-		ret = uuid_from_dmi_entries(system_uuid);
-	return ret;
-}
-
-char *nvmf_hostid_generate()
-{
-	int ret;
-	char uuid_str[NVME_UUID_LEN_STRING];
-	unsigned char uuid[NVME_UUID_LEN];
-
-	ret = uuid_from_dmi(uuid_str);
-	if (ret < 0)
-		ret = uuid_from_device_tree(uuid_str);
-	if (ret < 0) {
-		if (nvme_uuid_random(uuid) < 0)
-			memset(uuid, 0, NVME_UUID_LEN);
-		nvme_uuid_to_string(uuid, uuid_str);
-	}
-
-	return strdup(uuid_str);
-}
-
-char *nvmf_hostnqn_generate_from_hostid(char *hostid)
-{
-	char *hid = NULL;
-	char *hostnqn;
-	int ret;
-
-	if (!hostid)
-		hostid = hid = nvmf_hostid_generate();
-
-	ret = asprintf(&hostnqn, "nqn.2014-08.org.nvmexpress:uuid:%s", hostid);
-	free(hid);
-
-	return (ret < 0) ? NULL : hostnqn;
-}
-
-char *nvmf_hostnqn_generate()
-{
-	return nvmf_hostnqn_generate_from_hostid(NULL);
-}
-
-static char *nvmf_read_file(const char *f, int len)
-{
-	char buf[len];
-	_cleanup_fd_ int fd = -1;
-	int ret;
-
-	fd = open(f, O_RDONLY);
-	if (fd < 0)
-		return NULL;
-
-	memset(buf, 0, len);
-	ret = read(fd, buf, len - 1);
-
-	if (ret < 0 || !strlen(buf))
-		return NULL;
-	return strndup(buf, strcspn(buf, "\n"));
-}
-
-char *nvmf_hostnqn_from_file()
-{
-	char *hostnqn = getenv("LIBNVME_HOSTNQN");
-
-	if (hostnqn) {
-		if (!strcmp(hostnqn, ""))
-			return NULL;
-		return strdup(hostnqn);
-	}
-
-	return nvmf_read_file(NVMF_HOSTNQN_FILE, NVMF_NQN_SIZE);
-}
-
-char *nvmf_hostid_from_file()
-{
-	char *hostid = getenv("LIBNVME_HOSTID");
-
-	if (hostid) {
-		if (!strcmp(hostid, ""))
-			return NULL;
-		return strdup(hostid);
-	}
-
-	return nvmf_read_file(NVMF_HOSTID_FILE, NVMF_HOSTID_SIZE);
-}
-
 /**
  * nvmf_get_tel() - Calculate the amount of memory needed for a DIE.
  * @hostsymname:	Symbolic name (may be NULL)
@@ -2675,9 +2432,9 @@ int nvmf_config_modify(struct nvme_global_ctx *ctx,
 	struct nvme_ctrl *c;
 
 	if (!fctx->hostnqn)
-		fctx->hostnqn = hnqn = nvmf_hostnqn_from_file();
+		fctx->hostnqn = hnqn = nvme_hostnqn_from_file();
 	if (!fctx->hostid && hnqn)
-		fctx->hostid = hid = nvmf_hostid_from_file();
+		fctx->hostid = hid = nvme_hostid_from_file();
 
 	h = nvme_lookup_host(ctx, fctx->hostnqn, fctx->hostid);
 	if (!h) {

libnvme/src/nvme/fabrics.h

@@ -283,57 +283,6 @@ struct nvme_get_discovery_args {
 int nvmf_get_discovery_wargs(struct nvme_get_discovery_args *args,
 			     struct nvmf_discovery_log **log);
 
-/**
- * nvmf_hostnqn_generate() - Generate a machine specific host nqn
- * Returns: An nvm namespace qualified name string based on the machine
- * identifier, or NULL if not successful.
- */
-char *nvmf_hostnqn_generate();
-
-/**
- * nvmf_hostnqn_generate_from_hostid() - Generate a host nqn from host identifier
- * @hostid:		Host identifier
- *
- * If @hostid is NULL, the function generates it based on the machine
- * identifier.
- *
- * Return: On success, an NVMe Qualified Name for host identification. This
- * name is based on the given host identifier. On failure, NULL.
- */
-char *nvmf_hostnqn_generate_from_hostid(char *hostid);
-
-/**
- * nvmf_hostid_generate() - Generate a machine specific host identifier
- *
- * Return: On success, an identifier string based on the machine identifier to
- * be used as NVMe Host Identifier, or NULL on failure.
- */
-char *nvmf_hostid_generate();
-
-/**
- * nvmf_hostnqn_from_file() - Reads the host nvm qualified name from the config
- *			      default location
- *
- * Retrieve the qualified name from the config file located in $SYSCONFIDR/nvme.
- * $SYSCONFDIR is usually /etc.
- *
- * Return: The host nqn, or NULL if unsuccessful. If found, the caller
- * is responsible to free the string.
- */
-char *nvmf_hostnqn_from_file();
-
-/**
- * nvmf_hostid_from_file() - Reads the host identifier from the config default
- *			     location
- *
- * Retrieve the host idenditifer from the config file located in $SYSCONFDIR/nvme/.
- * $SYSCONFDIR is usually /etc.
- *
- * Return: The host identifier, or NULL if unsuccessful. If found, the caller
- *	   is responsible to free the string.
- */
-char *nvmf_hostid_from_file();
-
 /**
  * nvmf_is_registration_supported - check whether registration can be performed.
  * @c:	Controller instance