generate-accessors: add lifecycle and default-value generation

Extend the generator with two new annotations:

  // !generate-lifecycle   (on struct brace) -- generate _new(), _free(),
                            and (when defaults exist) _init_defaults()
  // !default:<value>      (on a member line) -- set the initial value of
                            that member in _init_defaults()

Apply // !generate-lifecycle to struct libnvmf_discovery_args, replacing
the hand-written libnvmf_discovery_args_create() / _free() pair:

  - libnvmf_discovery_args_new() replaces libnvmf_discovery_args_create().
    Same int return / double-pointer signature; sets defaults via
    libnvmf_discovery_args_init_defaults().
  - libnvmf_discovery_args_free() is now generated (same name, same
    semantics -- NULL-safe via free(NULL)).
  - libnvmf_discovery_args_init_defaults() is new; sets max_retries = 6
    and lsp = NVMF_LOG_DISC_LSP_NONE.

Update all callers (nvme.i, discover-loop.c, test/ioctl/discovery.c) to
use the new _new() API. Move the ABI entries for the removed functions
from libnvmf.ld to accessors-fabrics.ld.

Signed-off-by: Martin Belanger <[email protected]>

Author: Martin Belanger

libnvme/examples/discover-loop.c

@@ -94,7 +94,7 @@ int main()
 		goto free_fctx;
 	}
 
-	ret = libnvmf_discovery_args_create(&args);
+	ret = libnvmf_discovery_args_new(&args);
 	if (!ret) {
 		libnvmf_discovery_args_set_max_retries(args, 4);
 		ret = libnvmf_get_discovery_log(c, args, &log);

libnvme/libnvme/nvme.i

@@ -829,7 +829,7 @@ struct libnvmf_context {};
 			discover_err = 1;
 			return NULL;
 		}
-		discover_err = libnvmf_discovery_args_create(&args);
+		discover_err = libnvmf_discovery_args_new(&args);
 		if (discover_err)
 			return NULL;
 		libnvmf_discovery_args_set_lsp(args, lsp);

libnvme/src/accessors-fabrics.ld

@@ -10,8 +10,11 @@
 
 LIBNVMF_ACCESSORS_3 {
 	global:
+		libnvmf_discovery_args_free;
 		libnvmf_discovery_args_get_lsp;
 		libnvmf_discovery_args_get_max_retries;
+		libnvmf_discovery_args_init_defaults;
+		libnvmf_discovery_args_new;
 		libnvmf_discovery_args_set_lsp;
 		libnvmf_discovery_args_set_max_retries;
 		libnvmf_uri_get_fragment;

libnvme/src/libnvmf.ld

@@ -24,8 +24,6 @@ LIBNVMF_3 {
 		libnvmf_ctrl_get_fabrics_config;
 		libnvmf_disconnect_ctrl;
 		libnvmf_discovery;
-		libnvmf_discovery_args_create;
-		libnvmf_discovery_args_free;
 		libnvmf_discovery_config_file;
 		libnvmf_discovery_config_json;
 		libnvmf_discovery_nbft;

libnvme/src/nvme/accessors-fabrics.c

@@ -17,6 +17,7 @@
  * To update run: meson compile -C [BUILD-DIR] update-accessors
  * Or:            make update-accessors
  */
+#include <errno.h>
 #include <stdlib.h>
 #include <string.h>
 #include "accessors-fabrics.h"
@@ -28,6 +29,31 @@
  * Accessors for: struct libnvmf_discovery_args
  ****************************************************************************/
 
+__public int libnvmf_discovery_args_new(struct libnvmf_discovery_args **pp)
+{
+	if (!pp)
+		return -EINVAL;
+	*pp = calloc(1, sizeof(struct libnvmf_discovery_args));
+	if (!*pp)
+		return -ENOMEM;
+	libnvmf_discovery_args_init_defaults(*pp);
+	return 0;
+}
+
+__public void libnvmf_discovery_args_free(struct libnvmf_discovery_args *p)
+{
+	free(p);
+}
+
+__public void libnvmf_discovery_args_init_defaults(
+		struct libnvmf_discovery_args *p)
+{
+	if (!p)
+		return;
+	p->max_retries = 6;
+	p->lsp = NVMF_LOG_DISC_LSP_NONE;
+}
+
 __public void libnvmf_discovery_args_set_max_retries(
 		struct libnvmf_discovery_args *p,
 		int max_retries)

libnvme/src/nvme/accessors-fabrics.h

@@ -35,6 +35,36 @@ struct libnvmf_uri;
  * Accessors for: struct libnvmf_discovery_args
  ****************************************************************************/
 
+/**
+ * libnvmf_discovery_args_new() - Allocate and initialise a new instance.
+ * @pp: On success, *pp is set to the newly allocated object.
+ *
+ * Allocates a zeroed &struct libnvmf_discovery_args on the heap.
+ * The caller must release it with libnvmf_discovery_args_free().
+ *
+ * Return: 0 on success, -EINVAL if @pp is NULL,
+ *         -ENOMEM if allocation fails.
+ */
+int libnvmf_discovery_args_new(struct libnvmf_discovery_args **pp);
+
+/**
+ * libnvmf_discovery_args_free() - Release a libnvmf_discovery_args object.
+ * @p: Object previously returned by libnvmf_discovery_args_new().
+ *     A NULL pointer is silently ignored.
+ */
+void libnvmf_discovery_args_free(struct libnvmf_discovery_args *p);
+
+/**
+ * libnvmf_discovery_args_init_defaults() - Set fields to their defaults.
+ * @p: The &struct libnvmf_discovery_args instance to initialise.
+ *
+ * Sets each field that carries a default annotation to its
+ * compile-time default value.  Called automatically by
+ * libnvmf_discovery_args_new() but may also be called directly to reset an
+ * instance to its defaults without reallocating it.
+ */
+void libnvmf_discovery_args_init_defaults(struct libnvmf_discovery_args *p);
+
 /**
  * libnvmf_discovery_args_set_max_retries() - Set max_retries.
  * @p: The &struct libnvmf_discovery_args instance to update.

libnvme/src/nvme/accessors.c

@@ -17,6 +17,7 @@
  * To update run: meson compile -C [BUILD-DIR] update-accessors
  * Or:            make update-accessors
  */
+#include <errno.h>
 #include <stdlib.h>
 #include <string.h>
 #include "accessors.h"

libnvme/src/nvme/accessors.h

@@ -236,7 +236,7 @@ long libnvme_fabrics_config_get_tls_key_id(
 		const struct libnvme_fabrics_config *p);
 
 /**
- * libnvme_fabrics_config_set_tls_configured_key_id() - Set tls_configured_key_id.
+ * libnvme_fabrics_config_set_tls_configured_key_id() - Setter.
  * @p: The &struct libnvme_fabrics_config instance to update.
  * @tls_configured_key_id: Value to assign to the tls_configured_key_id field.
  */
@@ -245,7 +245,7 @@ void libnvme_fabrics_config_set_tls_configured_key_id(
 		long tls_configured_key_id);
 
 /**
- * libnvme_fabrics_config_get_tls_configured_key_id() - Get tls_configured_key_id.
+ * libnvme_fabrics_config_get_tls_configured_key_id() - Getter.
  * @p: The &struct libnvme_fabrics_config instance to query.
  *
  * Return: The value of the tls_configured_key_id field.

libnvme/src/nvme/fabrics.c

@@ -1496,32 +1496,6 @@ static void sanitize_discovery_log_entry(struct libnvme_global_ctx *ctx,
 	}
 }
 
-__public int libnvmf_discovery_args_create(struct libnvmf_discovery_args **argsp)
-{
-	struct libnvmf_discovery_args *args;
-
-	if (!argsp)
-		return -EINVAL;
-
-	args = calloc(1, sizeof(*args));
-	if (!args)
-		return -ENOMEM;
-
-	args->max_retries = 6;
-	args->lsp = NVMF_LOG_DISC_LSP_NONE;
-
-	*argsp = args;
-	return 0;
-}
-
-__public void libnvmf_discovery_args_free(struct libnvmf_discovery_args *args)
-{
-	if (!args)
-		return;
-
-	free(args);
-}
-
 __public int libnvmf_get_discovery_log(libnvme_ctrl_t ctrl,
 				    const struct libnvmf_discovery_args *args,
 				    struct nvmf_discovery_log **logp)

libnvme/src/nvme/fabrics.h

@@ -157,7 +157,7 @@ int libnvmf_connect_ctrl(libnvme_ctrl_t c);
 /*
  * struct libnvmf_discovery_args - Opaque arguments for libnvmf_get_discovery_log()
  *
- * Allocate with libnvmf_discovery_args_create() and release with
+ * Allocate with libnvmf_discovery_args_new() and release with
  * libnvmf_discovery_args_free(). Use the setter/getter accessors to configure
  * fields; do not access members directly.
  */
@@ -168,23 +168,6 @@ struct libnvmf_discovery_args;
  */
 struct libnvmf_uri;
 
-/**
- * libnvmf_discovery_args_create() - Allocate a discovery args object
- * @argsp:	On success, set to the newly allocated object
- *
- * Allocates and initialises a &struct libnvmf_discovery_args with sensible
- * defaults. The caller must release it with libnvmf_discovery_args_free().
- *
- * Return: 0 on success, or a negative error code on failure.
- */
-int libnvmf_discovery_args_create(struct libnvmf_discovery_args **argsp);
-
-/**
- * libnvmf_discovery_args_free() - Release a discovery args object
- * @args:	Object previously returned by libnvmf_discovery_args_create()
- */
-void libnvmf_discovery_args_free(struct libnvmf_discovery_args *args);
-
 /**
  * libnvmf_get_discovery_log() - Fetch the NVMe-oF discovery log page
  * @ctrl:	Discovery controller