lib: update function names to follow pattern

Make the naming more consistent. Functions are grouped by common
prefixes. Generic top-level functions use the nvme_ prefix, while
functions operating on specific objects use the object type as a
prefix (e.g., nvme_ns_). The prefix is typically followed by a verb,
such as nvme_create_ctrl.

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

Author: igaw

libnvme/examples/discover-loop.c

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

libnvme/libnvme/nvme.i

@@ -38,21 +38,21 @@
 		PyDict_SetItemString(p, key, val); /* Does NOT steal reference to val .. */
 		Py_XDECREF(val);                   /* .. therefore decrement ref. count. */
 	}
-	PyObject *hostnqn_from_file() {
-		char * val = nvme_hostnqn_from_file();
+	PyObject *read_hostnqn() {
+		char * val = nvme_read_hostnqn();
 		PyObject * obj = PyUnicode_FromString(val);
 		free(val);
 		return obj;
 	}
-	PyObject *hostid_from_file() {
-		char * val = nvme_hostid_from_file();
+	PyObject *read_hostid() {
+		char * val = nvme_read_hostid();
 		PyObject * obj = PyUnicode_FromString(val);
 		free(val);
 		return obj;
 	}
 %}
-PyObject *hostnqn_from_file();
-PyObject *hostid_from_file();
+PyObject *read_hostnqn();
+PyObject *read_hostid();
 
 %exception nvme_ctrl::connect {
 	connect_err = 0;
@@ -557,7 +557,7 @@ struct nvme_ns {
 		  const char *hostkey = NULL,
 		  const char *hostsymname = NULL) {
 		nvme_host_t h;
-		if (nvme_host_get(ctx, hostnqn, hostid, &h))
+		if (nvme_get_host(ctx, hostnqn, hostid, &h))
 			return NULL;
 		if (hostsymname)
 			nvme_host_set_hostsymname(h, hostsymname);
@@ -613,7 +613,7 @@ struct nvme_ns {
 		       const char *name = NULL) {
 		struct nvme_subsystem *s;
 
-		if (nvme_subsystem_get(ctx, host, name, subsysnqn, &s))
+		if (nvme_get_subsystem(ctx, host, name, subsysnqn, &s))
 			return NULL;
 
 		return s;
@@ -1245,13 +1245,13 @@ struct nvme_ns {
 		PyObject *output;
 		int ret;
 
-		ret = nvme_nbft_read(ctx, &nbft, filename);
+		ret = nvme_read_nbft(ctx, &nbft, filename);
 		if (ret) {
 			Py_RETURN_NONE;
 		}
 
 		output = nbft_to_pydict(nbft);
-		nvme_nbft_free(ctx, nbft);
+		nvme_free_nbft(ctx, nbft);
 		return output;
 	}
 %};

libnvme/src/libnvme.ld

@@ -6,7 +6,7 @@ LIBNVME_3 {
 		nvme_close;
 		nvme_create_ctrl;
 		nvme_create_global_ctx;
-		nvme_ctrl_config_match;
+		nvme_ctrl_match_config;
 		nvme_ctrl_first_ns;
 		nvme_ctrl_first_path;
 		nvme_ctrl_get_address;
@@ -25,9 +25,9 @@ LIBNVME_3 {
 		nvme_ctrl_next_ns;
 		nvme_ctrl_next_path;
 		nvme_ctrl_release_transport_handle;
-		nvme_ctrl_reset;
+		nvme_reset_ctrl;
 		nvme_ctrl_set_dhchap_host_key;
-		nvme_ctrls_filter;
+		nvme_filter_ctrls;
 		nvme_describe_key_serial;
 		nvme_disconnect_ctrl;
 		nvme_dump_config;
@@ -68,17 +68,17 @@ LIBNVME_3 {
 		nvme_get_telemetry_max;
 		nvme_get_uuid_list;
 		nvme_get_version;
-		nvme_host_get;
+		nvme_get_host;
 		nvme_host_get_global_ctx;
 		nvme_host_get_ids;
 		nvme_host_is_pdc_enabled;
 		nvme_host_release_fds;
 		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_read_hostid;
+		nvme_generate_hostid;
+		nvme_read_hostnqn;
+		nvme_generate_hostnqn;
+		nvme_generate_hostnqn_from_hostid;
 		nvme_import_tls_key;
 		nvme_import_tls_key_versioned;
 		nvme_init_ctrl;
@@ -123,11 +123,11 @@ LIBNVME_3 {
 		nvme_mi_submit_exit;
 		nvme_namespace_attach_ctrls;
 		nvme_namespace_detach_ctrls;
-		nvme_namespace_filter;
+		nvme_filter_namespace;
 		nvme_namespace_first_path;
 		nvme_namespace_next_path;
-		nvme_nbft_free;
-		nvme_nbft_read;
+		nvme_free_nbft;
+		nvme_read_nbft;
 		nvme_next_host;
 		nvme_next_subsystem;
 		nvme_ns_attach;
@@ -145,7 +145,7 @@ LIBNVME_3 {
 		nvme_ns_get_uuid;
 		nvme_ns_identify;
 		nvme_ns_read;
-		nvme_ns_rescan;
+		nvme_rescan_ns;
 		nvme_ns_verify;
 		nvme_ns_write;
 		nvme_ns_write_uncorrectable;
@@ -155,7 +155,7 @@ LIBNVME_3 {
 		nvme_path_get_ctrl;
 		nvme_path_get_ns;
 		nvme_path_get_queue_depth;
-		nvme_paths_filter;
+		nvme_filter_paths;
 		nvme_read_config;
 		nvme_read_key;
 		nvme_refresh_topology;
@@ -186,10 +186,10 @@ LIBNVME_3 {
 		nvme_strerror;
 		nvme_submit_admin_passthru;
 		nvme_submit_io_passthru;
-		nvme_subsys_filter;
+		nvme_filter_subsys;
 		nvme_subsystem_first_ctrl;
 		nvme_subsystem_first_ns;
-		nvme_subsystem_get;
+		nvme_get_subsystem;
 		nvme_subsystem_get_fw_rev;
 		nvme_subsystem_get_host;
 		nvme_subsystem_get_nqn;
@@ -198,7 +198,7 @@ LIBNVME_3 {
 		nvme_subsystem_next_ctrl;
 		nvme_subsystem_next_ns;
 		nvme_subsystem_release_fds;
-		nvme_subsystem_reset;
+		nvme_reset_subsystem;
 		nvme_transport_handle_get_fd;
 		nvme_transport_handle_get_name;
 		nvme_transport_handle_is_blkdev;
@@ -210,9 +210,9 @@ LIBNVME_3 {
 		nvme_transport_handle_set_submit_exit;
 		nvme_unlink_ctrl;
 		nvme_update_key;
-		nvme_uuid_find;
+		nvme_find_uuid;
 		nvme_uuid_from_string;
-		nvme_uuid_random;
+		nvme_random_uuid;
 		nvme_uuid_to_string;
 	local:
 		*;

libnvme/src/nvme/fabrics.c

@@ -2425,9 +2425,9 @@ int nvmf_config_modify(struct nvme_global_ctx *ctx,
 	struct nvme_ctrl *c;
 
 	if (!fctx->hostnqn)
-		fctx->hostnqn = hnqn = nvme_hostnqn_from_file();
+		fctx->hostnqn = hnqn = nvme_read_hostnqn();
 	if (!fctx->hostid && hnqn)
-		fctx->hostid = hid = nvme_hostid_from_file();
+		fctx->hostid = hid = nvme_read_hostid();
 
 	h = nvme_lookup_host(ctx, fctx->hostnqn, fctx->hostid);
 	if (!h) {
@@ -2489,7 +2489,7 @@ int nvmf_nbft_read_files(struct nvme_global_ctx *ctx, char *path,
 		snprintf(filename, sizeof(filename), "%s/%s", path,
 			dent[i]->d_name);
 
-		ret = nvme_nbft_read(ctx, &nbft, filename);
+		ret = nvme_read_nbft(ctx, &nbft, filename);
 		if (!ret) {
 			struct nbft_file_entry *new;
 
@@ -2516,7 +2516,7 @@ void nvmf_nbft_free(struct nvme_global_ctx *ctx, struct nbft_file_entry *head)
 	while (head) {
 		struct nbft_file_entry *next = head->next;
 
-		nvme_nbft_free(ctx, head->nbft);
+		nvme_free_nbft(ctx, head->nbft);
 		free(head);
 
 		head = next;
@@ -3041,7 +3041,7 @@ int nvmf_discovery(struct nvme_global_ctx *ctx, struct nvmf_context *fctx,
 		ret = nvme_scan_ctrl(ctx, fctx->device, &c);
 		if (!ret) {
 			/* Check if device matches command-line options */
-			if (!nvme_ctrl_config_match(c, fctx->transport,
+			if (!nvme_ctrl_match_config(c, fctx->transport,
 				fctx->traddr, fctx->trsvcid,
 					fctx->subsysnqn, fctx->host_traddr,
 					fctx->host_iface)) {

libnvme/src/nvme/filters.c

@@ -14,7 +14,7 @@
 
 #include "private.h"
 
-int nvme_namespace_filter(const struct dirent *d)
+int nvme_filter_namespace(const struct dirent *d)
 {
 	int i, n;
 
@@ -28,7 +28,7 @@ int nvme_namespace_filter(const struct dirent *d)
 	return 0;
 }
 
-int nvme_paths_filter(const struct dirent *d)
+int nvme_filter_paths(const struct dirent *d)
 {
 	int i, c, n;
 
@@ -42,7 +42,7 @@ int nvme_paths_filter(const struct dirent *d)
 	return 0;
 }
 
-int nvme_ctrls_filter(const struct dirent *d)
+int nvme_filter_ctrls(const struct dirent *d)
 {
 	int i, c, n;
 
@@ -61,7 +61,7 @@ int nvme_ctrls_filter(const struct dirent *d)
 	return 0;
 }
 
-int nvme_subsys_filter(const struct dirent *d)
+int nvme_filter_subsys(const struct dirent *d)
 {
 	int i;
 
@@ -80,7 +80,7 @@ int nvme_scan_subsystems(struct dirent ***subsys)
 	const char *dir = nvme_subsys_sysfs_dir();
 	int ret;
 
-	ret = scandir(dir, subsys, nvme_subsys_filter, alphasort);
+	ret = scandir(dir, subsys, nvme_filter_subsys, alphasort);
 	if (ret < 0)
 		return -errno;
 
@@ -92,7 +92,7 @@ int nvme_scan_subsystem_namespaces(nvme_subsystem_t s, struct dirent ***ns)
 	int ret;
 
 	ret = scandir(nvme_subsystem_get_sysfs_dir(s), ns,
-		       nvme_namespace_filter, alphasort);
+		       nvme_filter_namespace, alphasort);
 	if (ret < 0)
 		return -errno;
 
@@ -104,7 +104,7 @@ int nvme_scan_ctrls(struct dirent ***ctrls)
 	const char *dir = nvme_ctrl_sysfs_dir();
 	int ret;
 
-	ret = scandir(dir, ctrls, nvme_ctrls_filter, alphasort);
+	ret = scandir(dir, ctrls, nvme_filter_ctrls, alphasort);
 	if (ret < 0)
 		return -errno;
 
@@ -116,7 +116,7 @@ int nvme_scan_ctrl_namespace_paths(nvme_ctrl_t c, struct dirent ***paths)
 	int ret;
 
 	ret = scandir(nvme_ctrl_get_sysfs_dir(c), paths,
-		       nvme_paths_filter, alphasort);
+		       nvme_filter_paths, alphasort);
 	if (ret < 0)
 		return -errno;
 
@@ -128,7 +128,7 @@ int nvme_scan_ctrl_namespaces(nvme_ctrl_t c, struct dirent ***ns)
 	int ret;
 
 	ret = scandir(nvme_ctrl_get_sysfs_dir(c), ns,
-		       nvme_namespace_filter, alphasort);
+		       nvme_filter_namespace, alphasort);
 	if (ret < 0)
 		return -errno;
 
@@ -140,7 +140,7 @@ int nvme_scan_ns_head_paths(nvme_ns_head_t head, struct dirent ***paths)
 	int ret;
 
 	ret = scandir(nvme_ns_head_get_sysfs_dir(head), paths,
-		       nvme_paths_filter, alphasort);
+		       nvme_filter_paths, alphasort);
 	if (ret < 0)
 		return -errno;
 

libnvme/src/nvme/filters.h

@@ -20,36 +20,36 @@
  */
 
 /**
- * nvme_namespace_filter() - Filter for namespaces
+ * nvme_filter_namespace() - Filter for namespaces
  * @d: dirent to check
  *
  * Return: 1 if @d matches, 0 otherwise
  */
-int nvme_namespace_filter(const struct dirent *d);
+int nvme_filter_namespace(const struct dirent *d);
 
 /**
- * nvme_paths_filter() - Filter for paths
+ * nvme_filter_paths() - Filter for paths
  * @d: dirent to check
  *
  * Return: 1 if @d matches, 0 otherwise
  */
-int nvme_paths_filter(const struct dirent *d);
+int nvme_filter_paths(const struct dirent *d);
 
 /**
- * nvme_ctrls_filter() - Filter for controllers
+ * nvme_filter_ctrls() - Filter for controllers
  * @d: dirent to check
  *
  * Return: 1 if @d matches, 0 otherwise
  */
-int nvme_ctrls_filter(const struct dirent *d);
+int nvme_filter_ctrls(const struct dirent *d);
 
 /**
- * nvme_subsys_filter() - Filter for subsystems
+ * nvme_filter_subsys() - Filter for subsystems
  * @d: dirent to check
  *
  * Return: 1 if @d matches, 0 otherwise
  */
-int nvme_subsys_filter(const struct dirent *d);
+int nvme_filter_subsys(const struct dirent *d);
 
 /**
  * nvme_scan_subsystems() - Scan for subsystems

libnvme/src/nvme/ioctl.c

@@ -37,7 +37,7 @@ static int nvme_verify_chr(struct nvme_transport_handle *hdl)
 	return 0;
 }
 
-int nvme_subsystem_reset(struct nvme_transport_handle *hdl)
+int nvme_reset_subsystem(struct nvme_transport_handle *hdl)
 {
 	int ret;
 
@@ -51,7 +51,7 @@ int nvme_subsystem_reset(struct nvme_transport_handle *hdl)
 	return ret;
 }
 
-int nvme_ctrl_reset(struct nvme_transport_handle *hdl)
+int nvme_reset_ctrl(struct nvme_transport_handle *hdl)
 {
 	int ret;
 
@@ -65,7 +65,7 @@ int nvme_ctrl_reset(struct nvme_transport_handle *hdl)
 	return ret;
 }
 
-int nvme_ns_rescan(struct nvme_transport_handle *hdl)
+int nvme_rescan_ns(struct nvme_transport_handle *hdl)
 {
 	int ret;