zebra, lib: fix the ZEBRA_INTERFACE_VRF_UPDATE zapi message

[mirror_frr.git] / lib / yang.h

diff --git a/lib/yang.h b/lib/yang.h
index c920060071fd186a32c74c3a08ae9542d8267607..3259189e987099ba9ab83f1c388a8b25e999b258 100644 (file)
--- a/lib/yang.h
+++ b/lib/yang.h
@@ -69,12 +69,6 @@ struct yang_data {
        /* XPath identifier of the data element. */
        char xpath[XPATH_MAXLEN];
 
-       /*
-        * Schema information (necessary to interpret certain values like
-        * enums).
-        */
-       const struct lys_node *snode;
-
        /* Value encoded as a raw string. */
        char *value;
 };
@@ -83,16 +77,8 @@ struct yang_list_keys {
        /* Number os keys (max: LIST_MAXKEYS). */
        uint8_t num;
 
-       struct {
-               /*
-                * Schema information (necessary to interpret certain values
-                * like enums).
-                */
-               struct lys_node *snode;
-
-               /* Value encoded as a raw string. */
-               char value[LIST_MAXKEYLEN];
-       } key[LIST_MAXKEYS];
+       /* Value encoded as a raw string. */
+       char key[LIST_MAXKEYS][LIST_MAXKEYLEN];
 };
 
 enum yang_path_type {
@@ -100,14 +86,29 @@ enum yang_path_type {
        YANG_PATH_DATA,
 };
 
-/* Filter non-presence containers. */
-#define YANG_ITER_FILTER_NPCONTAINERS 0x0001
-/* Filter list keys (leafs). */
-#define YANG_ITER_FILTER_LIST_KEYS 0x0002
-/* Filter RPC input/output nodes. */
-#define YANG_ITER_FILTER_INPUT_OUTPUT 0x0004
-/* Filter implicitely created nodes. */
-#define YANG_ITER_FILTER_IMPLICIT 0x0008
+enum yang_iter_flags {
+       /* Filter non-presence containers. */
+       YANG_ITER_FILTER_NPCONTAINERS = (1<<0),
+
+       /* Filter list keys (leafs). */
+       YANG_ITER_FILTER_LIST_KEYS = (1<<1),
+
+       /* Filter RPC input/output nodes. */
+       YANG_ITER_FILTER_INPUT_OUTPUT = (1<<2),
+
+       /* Filter implicitely created nodes. */
+       YANG_ITER_FILTER_IMPLICIT = (1<<3),
+
+       /* Allow iteration over augmentations. */
+       YANG_ITER_ALLOW_AUGMENTATIONS = (1<<4),
+};
+
+/* Callback used by the yang_snodes_iterate_*() family of functions. */
+typedef int (*yang_iterate_cb)(const struct lys_node *snode, void *arg);
+
+/* Return values of the 'yang_iterate_cb' callback. */
+#define YANG_ITER_CONTINUE 0
+#define YANG_ITER_STOP -1
 
 /* Global libyang context for native FRR models. */
 extern struct ly_ctx *ly_native_ctx;
@@ -128,6 +129,11 @@ extern struct yang_modules yang_modules;
  */
 extern struct yang_module *yang_module_load(const char *module_name);
 
+/*
+ * Load all FRR native YANG models.
+ */
+extern void yang_module_load_all(void);
+
 /*
  * Find a YANG module by its name.
  *
@@ -149,47 +155,67 @@ extern struct yang_module *yang_module_find(const char *module_name);
  */
 extern void yang_module_embed(struct yang_module_embed *embed);
 
+/*
+ * Iterate recursively over all children of a schema node.
+ *
+ * snode
+ *    YANG schema node to operate on.
+ *
+ * cb
+ *    Function to call with each schema node.
+ *
+ * flags
+ *    YANG_ITER_* flags to control how the iteration is performed.
+ *
+ * arg
+ *    Arbitrary argument passed as the second parameter in each call to 'cb'.
+ *
+ * Returns:
+ *    The return value of the last called callback.
+ */
+extern int yang_snodes_iterate_subtree(const struct lys_node *snode,
+                                      yang_iterate_cb cb, uint16_t flags,
+                                      void *arg);
+
 /*
  * Iterate over all libyang schema nodes from the given YANG module.
  *
  * module
  *    YANG module to operate on.
  *
- * func
+ * cb
  *    Function to call with each schema node.
  *
  * flags
- *    YANG_ITER_FILTER_* flags to specify node types that should be filtered.
+ *    YANG_ITER_* flags to control how the iteration is performed.
  *
- * arg1
- *    Arbitrary argument passed as the second parameter in each call to 'func'.
+ * arg
+ *    Arbitrary argument passed as the second parameter in each call to 'cb'.
  *
- * arg2
- *    Arbitrary argument passed as the third parameter in each call to 'func'.
+ * Returns:
+ *    The return value of the last called callback.
  */
-extern void yang_module_snodes_iterate(const struct lys_module *module,
-                                      void (*func)(const struct lys_node *,
-                                                   void *, void *),
-                                      uint16_t flags, void *arg1, void *arg2);
+extern int yang_snodes_iterate_module(const struct lys_module *module,
+                                     yang_iterate_cb cb, uint16_t flags,
+                                     void *arg);
 
 /*
  * Iterate over all libyang schema nodes from all loaded YANG modules.
  *
- * func
+ * cb
  *    Function to call with each schema node.
  *
  * flags
- *    YANG_ITER_FILTER_* flags to specify node types that should be filtered.
+ *    YANG_ITER_* flags to control how the iteration is performed.
  *
- * arg1
- *    Arbitrary argument passed as the second parameter in each call to 'func'.
+ * arg
+ *    Arbitrary argument passed as the second parameter in each call to 'cb'.
  *
- * arg2
- *    Arbitrary argument passed as the third parameter in each call to 'func'.
+ * Returns:
+ *    The return value of the last called callback.
  */
-extern void yang_all_snodes_iterate(void (*func)(const struct lys_node *,
-                                                void *, void *),
-                                   uint16_t flags, void *arg1, void *arg2);
+extern int yang_snodes_iterate_all(yang_iterate_cb cb, uint16_t flags,
+                                  void *arg);
 
 /*
  * Build schema path or data path of the schema node.
@@ -423,10 +449,14 @@ extern void *yang_dnode_get_entry(const struct lyd_node *dnode,
  * ly_ctx
  *    libyang context to operate on.
  *
+ * config
+ *    Specify whether the data node will contain only configuration data (true)
+ *    or both configuration data and state data (false).
+ *
  * Returns:
  *    Pointer to newly created libyang data node.
  */
-extern struct lyd_node *yang_dnode_new(struct ly_ctx *ly_ctx);
+extern struct lyd_node *yang_dnode_new(struct ly_ctx *ly_ctx, bool config_only);
 
 /*
  * Duplicate a libyang data node.