libnvme: annotate libnvme_path::ana_state with !accessors:none

The default accessor generation creates getters that return cached
attribute values. However, for libnvme_path::ana_state, a real-time
(non-cached) value is required.

This is particularly useful for tools such as nvme-top, which rely on
up-to-date information for displaying a real-time dashboard.

Annotate libnvme_path::ana_state with "!accessors:none" to disable the
auto-generated accessor, and provide a custom implementation of
libnvme_path_get_ana_state() that returns the current value.

Signed-off-by: Nilay Shroff <[email protected]>
Link: https://patch.msgid.link/[email protected]
Signed-off-by: Daniel Wagner <[email protected]>

Author: shroffni

libnvme/libnvme/nvme-swig-accessors.i

@@ -60,12 +60,10 @@
 	/* struct libnvme_path */
 	#define libnvme_path_name_get       libnvme_path_get_name
 	#define libnvme_path_sysfs_dir_get  libnvme_path_get_sysfs_dir
-	#define libnvme_path_ana_state_get  libnvme_path_get_ana_state
 	#define libnvme_path_numa_nodes_get libnvme_path_get_numa_nodes
 	#define libnvme_path_grpid_get      libnvme_path_get_grpid
 	#define libnvme_path_name_set       libnvme_path_set_name
 	#define libnvme_path_sysfs_dir_set  libnvme_path_set_sysfs_dir
-	#define libnvme_path_ana_state_set  libnvme_path_set_ana_state
 	#define libnvme_path_numa_nodes_set libnvme_path_set_numa_nodes
 	#define libnvme_path_grpid_set      libnvme_path_set_grpid
 

libnvme/src/accessors.ld

@@ -166,12 +166,10 @@ LIBNVME_ACCESSORS_3 {
 		libnvme_ns_set_name;
 		libnvme_ns_set_nsid;
 		libnvme_ns_set_sysfs_dir;
-		libnvme_path_get_ana_state;
 		libnvme_path_get_grpid;
 		libnvme_path_get_name;
 		libnvme_path_get_numa_nodes;
 		libnvme_path_get_sysfs_dir;
-		libnvme_path_set_ana_state;
 		libnvme_path_set_grpid;
 		libnvme_path_set_name;
 		libnvme_path_set_numa_nodes;

libnvme/src/libnvme.ld

@@ -136,6 +136,7 @@ LIBNVME_3 {
 		libnvme_ns_write_uncorrectable;
 		libnvme_ns_write_zeros;
 		libnvme_open;
+		libnvme_path_get_ana_state;
 		libnvme_path_get_ctrl;
 		libnvme_path_get_ns;
 		libnvme_path_get_queue_depth;

libnvme/src/nvme/accessors.c

@@ -291,19 +291,6 @@ __public const char *libnvme_path_get_sysfs_dir(const struct libnvme_path *p)
 	return p->sysfs_dir;
 }
 
-__public void libnvme_path_set_ana_state(
-		struct libnvme_path *p,
-		const char *ana_state)
-{
-	free(p->ana_state);
-	p->ana_state = ana_state ? strdup(ana_state) : NULL;
-}
-
-__public const char *libnvme_path_get_ana_state(const struct libnvme_path *p)
-{
-	return p->ana_state;
-}
-
 __public void libnvme_path_set_numa_nodes(
 		struct libnvme_path *p,
 		const char *numa_nodes)

libnvme/src/nvme/accessors.h

@@ -391,21 +391,6 @@ void libnvme_path_set_sysfs_dir(struct libnvme_path *p, const char *sysfs_dir);
  */
 const char *libnvme_path_get_sysfs_dir(const struct libnvme_path *p);
 
-/**
- * libnvme_path_set_ana_state() - Set ana_state.
- * @p: The &struct libnvme_path instance to update.
- * @ana_state: New string; a copy is stored. Pass NULL to clear.
- */
-void libnvme_path_set_ana_state(struct libnvme_path *p, const char *ana_state);
-
-/**
- * libnvme_path_get_ana_state() - Get ana_state.
- * @p: The &struct libnvme_path instance to query.
- *
- * Return: The value of the ana_state field, or NULL if not set.
- */
-const char *libnvme_path_get_ana_state(const struct libnvme_path *p);
-
 /**
  * libnvme_path_set_numa_nodes() - Set numa_nodes.
  * @p: The &struct libnvme_path instance to update.

libnvme/src/nvme/private.h

@@ -179,7 +179,7 @@ struct libnvme_path {			// !generate-accessors
 
 	char *name;
 	char *sysfs_dir;
-	char *ana_state;
+	char *ana_state;		// !accessors:none
 	char *numa_nodes;
 	int grpid;
 	int queue_depth;		// !accessors:none

libnvme/src/nvme/tree.c

@@ -839,6 +839,21 @@ __public int libnvme_path_get_queue_depth(libnvme_path_t p)
 	return p->queue_depth;
 }
 
+__public char *libnvme_path_get_ana_state(libnvme_path_t p)
+{
+	__cleanup_free char *ana_state = NULL;
+
+	ana_state = libnvme_get_path_attr(p, "ana_state");
+	if (ana_state) {
+		if (!p->ana_state || strcmp(ana_state, p->ana_state)) {
+			free(p->ana_state);
+			p->ana_state = strdup(ana_state);
+		}
+	}
+
+	return p->ana_state;
+}
+
 void nvme_free_path(struct libnvme_path *p)
 {
 	if (!p)

libnvme/src/nvme/tree.h

@@ -660,6 +660,14 @@ int libnvme_ns_identify_descs(libnvme_ns_t n, struct nvme_ns_id_desc *descs);
  */
 int libnvme_path_get_queue_depth(libnvme_path_t p);
 
+/**
+ * libnvme_path_get_ana_state() - ANA state of an nvme_path_t object
+ * @p: &libnvme_path_t object
+ *
+ * Return: ANA state of @p
+ */
+char *libnvme_path_get_ana_state(libnvme_path_t p);
+
 /**
  * libnvme_path_get_ctrl() - Parent controller of an libnvme_path_t object
  * @p:	&libnvme_path_t object