2 * Copyright (C) 2018 NetDEF, Inc.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; either version 2 of the License, or (at your option)
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; see the file COPYING; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 #include <libyang/libyang.h>
30 #include "yang_wrappers.h"
36 /* Maximum XPath length. */
37 #define XPATH_MAXLEN 1024
39 /* Maximum list key length. */
40 #define LIST_MAXKEYS 8
42 /* Maximum list key length. */
43 #define LIST_MAXKEYLEN 128
45 /* Maximum string length of an YANG value. */
46 #define YANG_VALUE_MAXLEN 1024
48 struct yang_module_embed
{
49 struct yang_module_embed
*next
;
50 const char *mod_name
, *mod_rev
;
51 const char *sub_mod_name
;
52 const char *sub_mod_rev
;
58 RB_ENTRY(yang_module
) entry
;
60 const struct lys_module
*info
;
65 sr_subscription_ctx_t
*sr_subscription
;
66 struct thread
*sr_thread
;
69 RB_HEAD(yang_modules
, yang_module
);
70 RB_PROTOTYPE(yang_modules
, yang_module
, entry
, yang_module_compare
);
73 /* XPath identifier of the data element. */
74 char xpath
[XPATH_MAXLEN
];
76 /* Value encoded as a raw string. */
80 struct yang_list_keys
{
81 /* Number os keys (max: LIST_MAXKEYS). */
84 /* Value encoded as a raw string. */
85 char key
[LIST_MAXKEYS
][LIST_MAXKEYLEN
];
93 enum yang_iter_flags
{
94 /* Filter non-presence containers. */
95 YANG_ITER_FILTER_NPCONTAINERS
= (1<<0),
97 /* Filter list keys (leafs). */
98 YANG_ITER_FILTER_LIST_KEYS
= (1<<1),
100 /* Filter RPC input/output nodes. */
101 YANG_ITER_FILTER_INPUT_OUTPUT
= (1<<2),
104 /* Callback used by the yang_snodes_iterate_*() family of functions. */
105 typedef int (*yang_iterate_cb
)(const struct lysc_node
*snode
, void *arg
);
107 /* Callback used by the yang_dnode_iterate() function. */
108 typedef int (*yang_dnode_iter_cb
)(const struct lyd_node
*dnode
, void *arg
);
110 /* Return values of the 'yang_iterate_cb' callback. */
111 #define YANG_ITER_CONTINUE 0
112 #define YANG_ITER_STOP -1
114 /* Global libyang context for native FRR models. */
115 extern struct ly_ctx
*ly_native_ctx
;
117 /* Tree of all loaded YANG modules. */
118 extern struct yang_modules yang_modules
;
121 * Create a new YANG module and load it using libyang. If the YANG module is not
122 * found in the YANG_MODELS_PATH directory, the program will exit with an error.
123 * Once loaded, a YANG module can't be unloaded anymore.
126 * Name of the YANG module.
129 * Pointer to newly created YANG module.
131 extern struct yang_module
*yang_module_load(const char *module_name
);
134 * Load all FRR native YANG models.
136 extern void yang_module_load_all(void);
139 * Find a YANG module by its name.
142 * Name of the YANG module.
145 * Pointer to YANG module if found, NULL otherwise.
147 extern struct yang_module
*yang_module_find(const char *module_name
);
150 * Register a YANG module embedded in the binary file. Should be called
151 * from a constructor function.
154 * YANG module embedding structure to register. (static global provided
157 extern void yang_module_embed(struct yang_module_embed
*embed
);
160 * Iterate recursively over all children of a schema node.
163 * YANG schema node to operate on.
166 * When set, iterate over all nodes of the specified module only.
169 * Function to call with each schema node.
172 * YANG_ITER_* flags to control how the iteration is performed.
175 * Arbitrary argument passed as the second parameter in each call to 'cb'.
178 * The return value of the last called callback.
180 extern int yang_snodes_iterate_subtree(const struct lysc_node
*snode
,
181 const struct lys_module
*module
,
182 yang_iterate_cb cb
, uint16_t flags
,
186 * Iterate over all libyang schema nodes from all loaded modules of the
190 * When set, iterate over all nodes of the specified module only.
193 * Function to call with each schema node.
196 * YANG_ITER_* flags to control how the iteration is performed.
199 * Arbitrary argument passed as the second parameter in each call to 'cb'.
202 * The return value of the last called callback.
204 extern int yang_snodes_iterate(const struct lys_module
*module
,
205 yang_iterate_cb cb
, uint16_t flags
, void *arg
);
208 * Build schema path or data path of the schema node.
211 * libyang schema node to be processed.
214 * Specify whether a schema path or a data path should be built.
217 * Pointer to previously allocated buffer.
220 * Size of the xpath buffer.
222 extern void yang_snode_get_path(const struct lysc_node
*snode
,
223 enum yang_path_type type
, char *xpath
,
227 * Find first parent schema node which is a presence-container or a list
228 * (non-presence containers are ignored).
231 * libyang schema node to operate on.
234 * The parent libyang schema node if found, or NULL if not found.
236 extern struct lysc_node
*yang_snode_real_parent(const struct lysc_node
*snode
);
239 * Find first parent schema node which is a list.
242 * libyang schema node to operate on.
245 * The parent libyang schema node (list) if found, or NULL if not found.
247 extern struct lysc_node
*yang_snode_parent_list(const struct lysc_node
*snode
);
250 * Check if the libyang schema node represents typeless data (e.g. containers,
251 * leafs of type empty, etc).
254 * libyang schema node to operate on.
257 * true if the schema node represents typeless data, false otherwise.
259 extern bool yang_snode_is_typeless_data(const struct lysc_node
*snode
);
262 * Get the default value associated to a YANG leaf or leaf-list.
265 * libyang schema node to operate on.
268 * The default value if it exists, NULL otherwise.
270 extern const char *yang_snode_get_default(const struct lysc_node
*snode
);
273 * Get the type structure of a leaf of leaf-list. If the type is a leafref, the
274 * final (if there is a chain of leafrefs) target's type is found.
277 * libyang schema node to operate on.
280 * The found type if the schema node represents a leaf or a leaf-list, NULL
283 extern const struct lysc_type
*
284 yang_snode_get_type(const struct lysc_node
*snode
);
287 * Get the number of key nodes for the given list.
290 * libyang (LYS_LIST) schema node to operate on.
293 * The number of key LYS_LEAFs as children of this list node.
295 extern unsigned int yang_snode_num_keys(const struct lysc_node
*snode
);
297 #define LY_FOR_KEYS(snode, skey) \
298 for ((skey) = (const struct lysc_node_leaf *)lysc_node_child((snode)); \
299 (skey); (skey) = (const struct lysc_node_leaf *)((skey)->next)) \
300 if (!lysc_is_key(skey)) { \
306 * Build data path of the data node.
309 * libyang data node to be processed.
312 * Pointer to previously allocated buffer.
315 * Size of the xpath buffer.
317 extern void yang_dnode_get_path(const struct lyd_node
*dnode
, char *xpath
,
321 * Return the schema name of the given libyang data node.
327 * Optional XPath expression (absolute or relative) to specify a different
328 * data node to operate on in the same data tree.
331 * Schema name of the libyang data node.
333 extern const char *yang_dnode_get_schema_name(const struct lyd_node
*dnode
,
334 const char *xpath_fmt
, ...)
338 * Find a libyang data node by its YANG data path.
341 * Base libyang data node to operate on.
344 * Limited XPath (absolute or relative) string. See Path in libyang
345 * documentation for restrictions.
348 * The libyang data node if found, or NULL if not found.
350 extern struct lyd_node
*yang_dnode_get(const struct lyd_node
*dnode
,
354 * Find a libyang data node by its YANG data path.
357 * Base libyang data node to operate on.
360 * Limited XPath (absolute or relative) format string. See Path in libyang
361 * documentation for restrictions.
364 * any parameters for xpath_fmt.
367 * The libyang data node if found, or NULL if not found.
369 extern struct lyd_node
*yang_dnode_getf(const struct lyd_node
*dnode
,
370 const char *path_fmt
, ...)
374 * Check if a libyang data node exists.
377 * Base libyang data node to operate on.
380 * Limited XPath (absolute or relative) string. See Path in libyang
381 * documentation for restrictions.
384 * true if a libyang data node was found, false otherwise.
386 extern bool yang_dnode_exists(const struct lyd_node
*dnode
, const char *xpath
);
389 * Check if a libyang data node exists.
392 * Base libyang data node to operate on.
395 * Limited XPath (absolute or relative) format string. See Path in
396 * libyang documentation for restrictions.
399 * any parameters for xpath_fmt.
402 * true if a libyang data node was found, false otherwise.
404 extern bool yang_dnode_existsf(const struct lyd_node
*dnode
,
405 const char *xpath_fmt
, ...) PRINTFRR(2, 3);
408 * Iterate over all libyang data nodes that satisfy an XPath query.
411 * Function to call with each data node.
414 * Arbitrary argument passed as the second parameter in each call to 'cb'.
417 * Base libyang data node to operate on.
420 * XPath expression (absolute or relative).
423 * any parameters for xpath_fmt.
425 void yang_dnode_iterate(yang_dnode_iter_cb cb
, void *arg
,
426 const struct lyd_node
*dnode
, const char *xpath_fmt
,
430 * Check if the libyang data node contains a default value. Non-presence
431 * containers are assumed to always contain a default value.
434 * Base libyang data node to operate on.
437 * Optional XPath expression (absolute or relative) to specify a different
438 * data node to operate on in the same data tree.
441 * true if the data node contains the default value, false otherwise.
443 extern bool yang_dnode_is_default(const struct lyd_node
*dnode
,
447 * Check if the libyang data node contains a default value. Non-presence
448 * containers are assumed to always contain a default value.
451 * Base libyang data node to operate on.
454 * Optional limited XPath (absolute or relative) format string. See Path in
455 * libyang documentation for restrictions.
458 * any parameters for xpath_fmt.
461 * true if the data node contains the default value, false otherwise.
463 extern bool yang_dnode_is_defaultf(const struct lyd_node
*dnode
,
464 const char *xpath_fmt
, ...) PRINTFRR(2, 3);
467 * Check if the libyang data node and all of its children contain default
468 * values. Non-presence containers are assumed to always contain a default
472 * libyang data node to operate on.
475 * true if the data node and all of its children contain default values,
478 extern bool yang_dnode_is_default_recursive(const struct lyd_node
*dnode
);
481 * Change the value of a libyang leaf node.
484 * libyang data node to operate on.
487 * String representing the new value.
489 extern void yang_dnode_change_leaf(struct lyd_node
*dnode
, const char *value
);
492 * Create a new libyang data node.
495 * libyang context to operate on.
498 * Specify whether the data node will contain only configuration data (true)
499 * or both configuration data and state data (false).
502 * Pointer to newly created libyang data node.
504 extern struct lyd_node
*yang_dnode_new(struct ly_ctx
*ly_ctx
, bool config_only
);
507 * Duplicate a libyang data node.
510 * libyang data node to duplicate.
513 * Pointer to duplicated libyang data node.
515 extern struct lyd_node
*yang_dnode_dup(const struct lyd_node
*dnode
);
518 * Delete a libyang data node.
521 * Pointer to the libyang data node that is going to be deleted along with
522 * the entire tree it belongs to.
524 extern void yang_dnode_free(struct lyd_node
*dnode
);
527 * Create a new yang_data structure.
530 * Data path of the YANG data.
533 * String representing the value of the YANG data.
536 * Pointer to newly created yang_data structure.
538 extern struct yang_data
*yang_data_new(const char *xpath
, const char *value
);
541 * Delete a yang_data structure.
544 * yang_data to delete.
546 extern void yang_data_free(struct yang_data
*data
);
549 * Create a new linked list of yang_data structures. The list 'del' callback is
550 * initialized appropriately so that the entire list can be deleted safely with
551 * list_delete_and_null().
554 * Pointer to newly created linked list.
556 extern struct list
*yang_data_list_new(void);
559 * Find the yang_data structure corresponding to an XPath in a list.
562 * list of yang_data structures to operate on.
565 * XPath to search for (format string).
568 * Pointer to yang_data if found, NULL otherwise.
570 extern struct yang_data
*yang_data_list_find(const struct list
*list
,
571 const char *xpath_fmt
, ...)
575 * Create and set up a libyang context (for use by the translator)
578 * Specify whether libyang should attempt to look for embedded YANG modules.
581 * True if the caller will later call ly_ctx_compile to compile all loaded
584 extern struct ly_ctx
*yang_ctx_new_setup(bool embedded_modules
,
585 bool explicit_compile
);
588 * Enable or disable libyang verbose debugging.
591 * When set to true, enable libyang verbose debugging, otherwise disable it.
593 extern void yang_debugging_set(bool enable
);
596 * Print libyang error messages into the provided buffer.
599 * libyang context to operate on.
602 * Buffer to store the libyang error messages.
608 * The provided buffer.
610 extern const char *yang_print_errors(struct ly_ctx
*ly_ctx
, char *buf
,
614 * Initialize the YANG subsystem. Should be called only once during the
615 * daemon initialization process.
618 * Specify whether libyang should attempt to look for embedded YANG modules.
620 * Hold off on compiling modules until yang_init_loading_complete is called.
622 extern void yang_init(bool embedded_modules
, bool defer_compile
);
625 * Should be called after yang_init and all yang_module_load()s have been done,
626 * compiles all modules loaded into the yang context.
628 extern void yang_init_loading_complete(void);
631 * Finish the YANG subsystem gracefully. Should be called only when the daemon
634 extern void yang_terminate(void);
637 * API to return the parent dnode having a given schema-node name
638 * Use case: One has to access the parent dnode's private pointer
639 * for a given child node.
640 * For that there is a need to find parent dnode first.
642 * dnode The starting node to work on
644 * name The name of container/list schema-node
646 * Returns The dnode matched with the given name
648 extern const struct lyd_node
*
649 yang_dnode_get_parent(const struct lyd_node
*dnode
, const char *name
);
653 * In some cases there is a need to auto delete the parent nodes
654 * if the given node is last in the list.
655 * It tries to delete all the parents in a given tree in a given module.
656 * The use case is with static routes and route maps
657 * example : ip route 1.1.1.1/32 ens33
658 * ip route 1.1.1.1/32 ens34
659 * After this no ip route 1.1.1.1/32 ens34 came, now staticd
660 * has to find out upto which level it has to delete the dnodes.
661 * For this case it has to send delete nexthop
662 * After this no ip route 1.1.1.1/32 ens33 came, now staticd has to
663 * clear nexthop, path and route nodes.
664 * The same scheme is required for routemaps also
665 * dnode The starting node to work on
667 * Returns The final parent node selected for deletion
669 extern const struct lyd_node
*
670 yang_get_subtree_with_no_sibling(const struct lyd_node
*dnode
);
672 /* To get the relative position of a node in list */
673 extern uint32_t yang_get_list_pos(const struct lyd_node
*node
);
675 /* To get the number of elements in a list
677 * dnode : The head of list
678 * Returns : The number of dnodes present in the list
680 extern uint32_t yang_get_list_elements_count(const struct lyd_node
*node
);
682 /* API to check if the given node is last node in the list */
683 bool yang_is_last_list_dnode(const struct lyd_node
*dnode
);
685 /* API to check if the given node is last node in the data tree level */
686 bool yang_is_last_level_dnode(const struct lyd_node
*dnode
);
692 #endif /* _FRR_YANG_H_ */