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
23 #include "lib_errors.h"
25 #include "yang_translator.h"
26 #include "northbound.h"
28 DEFINE_MTYPE_STATIC(LIB
, YANG_MODULE
, "YANG module");
29 DEFINE_MTYPE_STATIC(LIB
, YANG_DATA
, "YANG data structure");
31 /* libyang container. */
32 struct ly_ctx
*ly_native_ctx
;
34 static struct yang_module_embed
*embeds
, **embedupd
= &embeds
;
36 void yang_module_embed(struct yang_module_embed
*embed
)
40 embedupd
= &embed
->next
;
43 static LY_ERR
yang_module_imp_clb(const char *mod_name
, const char *mod_rev
,
44 const char *submod_name
,
45 const char *submod_rev
, void *user_data
,
47 const char **module_data
,
48 void (**free_module_data
)(void *, void *))
50 struct yang_module_embed
*e
;
52 for (e
= embeds
; e
; e
= e
->next
) {
53 if (e
->sub_mod_name
&& submod_name
) {
54 if (strcmp(e
->sub_mod_name
, submod_name
))
57 if (submod_rev
&& strcmp(e
->sub_mod_rev
, submod_rev
))
60 if (strcmp(e
->mod_name
, mod_name
))
63 if (mod_rev
&& strcmp(e
->mod_rev
, mod_rev
))
68 *module_data
= e
->data
;
72 /* We get here for indirect modules like ietf-inet-types */
74 "YANG model \"%s@%s\" \"%s@%s\"not embedded, trying external file",
75 mod_name
, mod_rev
? mod_rev
: "*",
76 submod_name
? submod_name
: "*", submod_rev
? submod_rev
: "*");
81 /* clang-format off */
82 static const char *const frr_native_modules
[] = {
97 /* Generate the yang_modules tree. */
98 static inline int yang_module_compare(const struct yang_module
*a
,
99 const struct yang_module
*b
)
101 return strcmp(a
->name
, b
->name
);
103 RB_GENERATE(yang_modules
, yang_module
, entry
, yang_module_compare
)
105 struct yang_modules yang_modules
= RB_INITIALIZER(&yang_modules
);
107 struct yang_module
*yang_module_load(const char *module_name
)
109 struct yang_module
*module
;
110 const struct lys_module
*module_info
;
113 ly_ctx_load_module(ly_native_ctx
, module_name
, NULL
, NULL
);
115 flog_err(EC_LIB_YANG_MODULE_LOAD
,
116 "%s: failed to load data model: %s", __func__
,
121 module
= XCALLOC(MTYPE_YANG_MODULE
, sizeof(*module
));
122 module
->name
= module_name
;
123 module
->info
= module_info
;
125 if (RB_INSERT(yang_modules
, &yang_modules
, module
) != NULL
) {
126 flog_err(EC_LIB_YANG_MODULE_LOADED_ALREADY
,
127 "%s: YANG module is loaded already: %s", __func__
,
135 void yang_module_load_all(void)
137 for (size_t i
= 0; i
< array_size(frr_native_modules
); i
++)
138 yang_module_load(frr_native_modules
[i
]);
141 struct yang_module
*yang_module_find(const char *module_name
)
143 struct yang_module s
;
145 s
.name
= module_name
;
146 return RB_FIND(yang_modules
, &yang_modules
, &s
);
149 int yang_snodes_iterate_subtree(const struct lysc_node
*snode
,
150 const struct lys_module
*module
,
151 yang_iterate_cb cb
, uint16_t flags
, void *arg
)
153 const struct lysc_node
*child
;
154 int ret
= YANG_ITER_CONTINUE
;
156 if (module
&& snode
->module
!= module
)
159 switch (snode
->nodetype
) {
161 if (CHECK_FLAG(flags
, YANG_ITER_FILTER_NPCONTAINERS
)) {
162 if (!CHECK_FLAG(snode
->flags
, LYS_PRESENCE
))
167 if (CHECK_FLAG(flags
, YANG_ITER_FILTER_LIST_KEYS
)) {
168 /* Ignore list keys. */
169 if (lysc_is_key(snode
))
175 if (CHECK_FLAG(flags
, YANG_ITER_FILTER_INPUT_OUTPUT
))
179 assert(snode
->nodetype
!= LYS_AUGMENT
180 && snode
->nodetype
!= LYS_GROUPING
181 && snode
->nodetype
!= LYS_USES
);
185 ret
= (*cb
)(snode
, arg
);
186 if (ret
== YANG_ITER_STOP
)
191 * YANG leafs and leaf-lists can't have child nodes.
193 if (CHECK_FLAG(snode
->nodetype
, LYS_LEAF
| LYS_LEAFLIST
))
194 return YANG_ITER_CONTINUE
;
196 LY_LIST_FOR (lysc_node_child(snode
), child
) {
197 ret
= yang_snodes_iterate_subtree(child
, module
, cb
, flags
,
199 if (ret
== YANG_ITER_STOP
)
205 int yang_snodes_iterate(const struct lys_module
*module
, yang_iterate_cb cb
,
206 uint16_t flags
, void *arg
)
208 const struct lys_module
*module_iter
;
210 int ret
= YANG_ITER_CONTINUE
;
212 idx
= ly_ctx_internal_modules_count(ly_native_ctx
);
213 while ((module_iter
= ly_ctx_get_module_iter(ly_native_ctx
, &idx
))) {
214 struct lysc_node
*snode
;
216 if (!module_iter
->implemented
)
219 LY_LIST_FOR (module_iter
->compiled
->data
, snode
) {
220 ret
= yang_snodes_iterate_subtree(snode
, module
, cb
,
222 if (ret
== YANG_ITER_STOP
)
225 LY_LIST_FOR (&module_iter
->compiled
->rpcs
->node
, snode
) {
226 ret
= yang_snodes_iterate_subtree(snode
, module
, cb
,
228 if (ret
== YANG_ITER_STOP
)
231 LY_LIST_FOR (&module_iter
->compiled
->notifs
->node
, snode
) {
232 ret
= yang_snodes_iterate_subtree(snode
, module
, cb
,
234 if (ret
== YANG_ITER_STOP
)
242 void yang_snode_get_path(const struct lysc_node
*snode
,
243 enum yang_path_type type
, char *xpath
,
247 case YANG_PATH_SCHEMA
:
248 (void)lysc_path(snode
, LYSC_PATH_LOG
, xpath
, xpath_len
);
251 (void)lysc_path(snode
, LYSC_PATH_DATA
, xpath
, xpath_len
);
254 flog_err(EC_LIB_DEVELOPMENT
, "%s: unknown yang path type: %u",
260 struct lysc_node
*yang_snode_real_parent(const struct lysc_node
*snode
)
262 struct lysc_node
*parent
= snode
->parent
;
265 switch (parent
->nodetype
) {
267 if (CHECK_FLAG(parent
->flags
, LYS_PRESENCE
))
275 parent
= parent
->parent
;
281 struct lysc_node
*yang_snode_parent_list(const struct lysc_node
*snode
)
283 struct lysc_node
*parent
= snode
->parent
;
286 switch (parent
->nodetype
) {
292 parent
= parent
->parent
;
298 bool yang_snode_is_typeless_data(const struct lysc_node
*snode
)
300 const struct lysc_node_leaf
*sleaf
;
302 switch (snode
->nodetype
) {
304 sleaf
= (struct lysc_node_leaf
*)snode
;
305 if (sleaf
->type
->basetype
== LY_TYPE_EMPTY
)
315 const char *yang_snode_get_default(const struct lysc_node
*snode
)
317 const struct lysc_node_leaf
*sleaf
;
319 switch (snode
->nodetype
) {
321 sleaf
= (const struct lysc_node_leaf
*)snode
;
322 return sleaf
->dflt
? lyd_value_get_canonical(sleaf
->module
->ctx
,
326 /* TODO: check leaf-list default values */
333 const struct lysc_type
*yang_snode_get_type(const struct lysc_node
*snode
)
335 struct lysc_node_leaf
*sleaf
= (struct lysc_node_leaf
*)snode
;
336 struct lysc_type
*type
;
338 if (!CHECK_FLAG(sleaf
->nodetype
, LYS_LEAF
| LYS_LEAFLIST
))
342 while (type
->basetype
== LY_TYPE_LEAFREF
)
343 type
= ((struct lysc_type_leafref
*)type
)->realtype
;
348 unsigned int yang_snode_num_keys(const struct lysc_node
*snode
)
350 const struct lysc_node_leaf
*skey
;
353 if (!CHECK_FLAG(snode
->nodetype
, LYS_LIST
))
356 /* Walk list of children */
357 LY_FOR_KEYS (snode
, skey
) {
363 void yang_dnode_get_path(const struct lyd_node
*dnode
, char *xpath
,
366 lyd_path(dnode
, LYD_PATH_STD
, xpath
, xpath_len
);
369 const char *yang_dnode_get_schema_name(const struct lyd_node
*dnode
,
370 const char *xpath_fmt
, ...)
374 char xpath
[XPATH_MAXLEN
];
376 va_start(ap
, xpath_fmt
);
377 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
380 dnode
= yang_dnode_get(dnode
, xpath
);
382 flog_err(EC_LIB_YANG_DNODE_NOT_FOUND
,
383 "%s: couldn't find %s", __func__
, xpath
);
384 zlog_backtrace(LOG_ERR
);
389 return dnode
->schema
->name
;
392 struct lyd_node
*yang_dnode_get(const struct lyd_node
*dnode
, const char *xpath
)
394 struct ly_set
*set
= NULL
;
395 struct lyd_node
*dnode_ret
= NULL
;
398 * XXX a lot of the code uses this for style I guess. It shouldn't, as
399 * it adds to the xpath parsing complexity in libyang.
401 if (xpath
[0] == '.' && xpath
[1] == '/')
404 if (lyd_find_xpath(dnode
, xpath
, &set
)) {
405 assert(0); /* XXX replicates old libyang1 base code */
411 if (set
->count
> 1) {
412 flog_warn(EC_LIB_YANG_DNODE_NOT_FOUND
,
413 "%s: found %u elements (expected 0 or 1) [xpath %s]",
414 __func__
, set
->count
, xpath
);
418 dnode_ret
= set
->dnodes
[0];
421 ly_set_free(set
, NULL
);
426 struct lyd_node
*yang_dnode_getf(const struct lyd_node
*dnode
,
427 const char *xpath_fmt
, ...)
430 char xpath
[XPATH_MAXLEN
];
432 va_start(ap
, xpath_fmt
);
433 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
436 return yang_dnode_get(dnode
, xpath
);
439 bool yang_dnode_exists(const struct lyd_node
*dnode
, const char *xpath
)
441 struct ly_set
*set
= NULL
;
444 if (xpath
[0] == '.' && xpath
[1] == '/')
446 if (lyd_find_xpath(dnode
, xpath
, &set
))
448 exists
= set
->count
> 0;
449 ly_set_free(set
, NULL
);
453 bool yang_dnode_existsf(const struct lyd_node
*dnode
, const char *xpath_fmt
,
457 char xpath
[XPATH_MAXLEN
];
459 va_start(ap
, xpath_fmt
);
460 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
463 return yang_dnode_exists(dnode
, xpath
);
466 void yang_dnode_iterate(yang_dnode_iter_cb cb
, void *arg
,
467 const struct lyd_node
*dnode
, const char *xpath_fmt
,
471 char xpath
[XPATH_MAXLEN
];
474 va_start(ap
, xpath_fmt
);
475 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
478 if (lyd_find_xpath(dnode
, xpath
, &set
)) {
479 assert(0); /* XXX libyang2: ly1 code asserted success */
482 for (unsigned int i
= 0; i
< set
->count
; i
++) {
485 ret
= (*cb
)(set
->dnodes
[i
], arg
);
486 if (ret
== YANG_ITER_STOP
)
490 ly_set_free(set
, NULL
);
493 bool yang_dnode_is_default(const struct lyd_node
*dnode
, const char *xpath
)
495 const struct lysc_node
*snode
;
496 struct lysc_node_leaf
*sleaf
;
499 dnode
= yang_dnode_get(dnode
, xpath
);
502 snode
= dnode
->schema
;
503 switch (snode
->nodetype
) {
505 sleaf
= (struct lysc_node_leaf
*)snode
;
506 if (sleaf
->type
->basetype
== LY_TYPE_EMPTY
)
508 return lyd_is_default(dnode
);
510 /* TODO: check leaf-list default values */
513 if (CHECK_FLAG(snode
->flags
, LYS_PRESENCE
))
521 bool yang_dnode_is_defaultf(const struct lyd_node
*dnode
, const char *xpath_fmt
,
525 return yang_dnode_is_default(dnode
, NULL
);
528 char xpath
[XPATH_MAXLEN
];
530 va_start(ap
, xpath_fmt
);
531 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
534 return yang_dnode_is_default(dnode
, xpath
);
538 bool yang_dnode_is_default_recursive(const struct lyd_node
*dnode
)
540 struct lyd_node
*root
, *dnode_iter
;
542 if (!yang_dnode_is_default(dnode
, NULL
))
545 if (CHECK_FLAG(dnode
->schema
->nodetype
, LYS_LEAF
| LYS_LEAFLIST
))
548 LY_LIST_FOR (lyd_child(dnode
), root
) {
549 LYD_TREE_DFS_BEGIN (root
, dnode_iter
) {
550 if (!yang_dnode_is_default(dnode_iter
, NULL
))
553 LYD_TREE_DFS_END(root
, dnode_iter
);
560 void yang_dnode_change_leaf(struct lyd_node
*dnode
, const char *value
)
562 assert(dnode
->schema
->nodetype
== LYS_LEAF
);
563 lyd_change_term(dnode
, value
);
566 struct lyd_node
*yang_dnode_new(struct ly_ctx
*ly_ctx
, bool config_only
)
568 struct lyd_node
*dnode
= NULL
;
569 int options
= config_only
? LYD_VALIDATE_NO_STATE
: 0;
571 if (lyd_validate_all(&dnode
, ly_ctx
, options
, NULL
) != 0) {
572 /* Should never happen. */
573 flog_err(EC_LIB_LIBYANG
, "%s: lyd_validate() failed", __func__
);
580 struct lyd_node
*yang_dnode_dup(const struct lyd_node
*dnode
)
582 struct lyd_node
*dup
= NULL
;
584 err
= lyd_dup_siblings(dnode
, NULL
, LYD_DUP_RECURSIVE
, &dup
);
589 void yang_dnode_free(struct lyd_node
*dnode
)
591 while (dnode
->parent
)
592 dnode
= lyd_parent(dnode
);
596 struct yang_data
*yang_data_new(const char *xpath
, const char *value
)
598 struct yang_data
*data
;
600 data
= XCALLOC(MTYPE_YANG_DATA
, sizeof(*data
));
601 strlcpy(data
->xpath
, xpath
, sizeof(data
->xpath
));
603 data
->value
= strdup(value
);
608 void yang_data_free(struct yang_data
*data
)
612 XFREE(MTYPE_YANG_DATA
, data
);
615 struct list
*yang_data_list_new(void)
620 list
->del
= (void (*)(void *))yang_data_free
;
625 struct yang_data
*yang_data_list_find(const struct list
*list
,
626 const char *xpath_fmt
, ...)
628 char xpath
[XPATH_MAXLEN
];
629 struct yang_data
*data
;
630 struct listnode
*node
;
633 va_start(ap
, xpath_fmt
);
634 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
637 for (ALL_LIST_ELEMENTS_RO(list
, node
, data
))
638 if (strmatch(data
->xpath
, xpath
))
644 /* Make libyang log its errors using FRR logging infrastructure. */
645 static void ly_log_cb(LY_LOG_LEVEL level
, const char *msg
, const char *path
)
647 int priority
= LOG_ERR
;
654 priority
= LOG_WARNING
;
658 priority
= LOG_DEBUG
;
663 zlog(priority
, "libyang: %s (%s)", msg
, path
);
665 zlog(priority
, "libyang: %s", msg
);
668 const char *yang_print_errors(struct ly_ctx
*ly_ctx
, char *buf
, size_t buf_len
)
670 struct ly_err_item
*ei
;
673 ei
= ly_err_first(ly_ctx
);
677 strlcpy(buf
, "YANG error(s):\n", buf_len
);
678 for (; ei
; ei
= ei
->next
) {
679 strlcat(buf
, " ", buf_len
);
680 strlcat(buf
, ei
->msg
, buf_len
);
681 strlcat(buf
, "\n", buf_len
);
684 path
= ly_errpath(ly_ctx
);
686 strlcat(buf
, " YANG path: ", buf_len
);
687 strlcat(buf
, path
, buf_len
);
688 strlcat(buf
, "\n", buf_len
);
691 ly_err_clean(ly_ctx
, NULL
);
696 void yang_debugging_set(bool enable
)
699 ly_log_level(LY_LLDBG
);
700 ly_log_dbg_groups(0xFF);
702 ly_log_level(LY_LLERR
);
703 ly_log_dbg_groups(0);
707 struct ly_ctx
*yang_ctx_new_setup(bool embedded_modules
, bool explicit_compile
)
709 struct ly_ctx
*ctx
= NULL
;
710 const char *yang_models_path
= YANG_MODELS_PATH
;
713 if (access(yang_models_path
, R_OK
| X_OK
)) {
714 yang_models_path
= NULL
;
716 zlog_info("yang model directory \"%s\" does not exist",
719 flog_err_sys(EC_LIB_LIBYANG
,
720 "cannot access yang model directory \"%s\"",
724 uint options
= LY_CTX_NO_YANGLIBRARY
| LY_CTX_DISABLE_SEARCHDIR_CWD
;
725 if (explicit_compile
)
726 options
|= LY_CTX_EXPLICIT_COMPILE
;
727 err
= ly_ctx_new(yang_models_path
, options
, &ctx
);
731 if (embedded_modules
)
732 ly_ctx_set_module_imp_clb(ctx
, yang_module_imp_clb
, NULL
);
737 void yang_init(bool embedded_modules
, bool defer_compile
)
739 /* Initialize libyang global parameters that affect all containers. */
740 ly_set_log_clb(ly_log_cb
, 1);
741 ly_log_options(LY_LOLOG
| LY_LOSTORE
);
743 /* Initialize libyang container for native models. */
744 ly_native_ctx
= yang_ctx_new_setup(embedded_modules
, defer_compile
);
745 if (!ly_native_ctx
) {
746 flog_err(EC_LIB_LIBYANG
, "%s: ly_ctx_new() failed", __func__
);
750 yang_translator_init();
753 void yang_init_loading_complete(void)
755 /* Compile everything */
756 if (ly_ctx_compile(ly_native_ctx
) != LY_SUCCESS
) {
757 flog_err(EC_LIB_YANG_MODULE_LOAD
,
758 "%s: failed to compile loaded modules: %s", __func__
,
759 ly_errmsg(ly_native_ctx
));
764 void yang_terminate(void)
766 struct yang_module
*module
;
768 yang_translator_terminate();
770 while (!RB_EMPTY(yang_modules
, &yang_modules
)) {
771 module
= RB_ROOT(yang_modules
, &yang_modules
);
774 * We shouldn't call ly_ctx_remove_module() here because this
775 * function also removes other modules that depend on it.
777 * ly_ctx_destroy() will release all memory for us.
779 RB_REMOVE(yang_modules
, &yang_modules
, module
);
780 XFREE(MTYPE_YANG_MODULE
, module
);
783 ly_ctx_destroy(ly_native_ctx
);
786 const struct lyd_node
*yang_dnode_get_parent(const struct lyd_node
*dnode
,
789 const struct lyd_node
*orig_dnode
= dnode
;
792 switch (orig_dnode
->schema
->nodetype
) {
795 if (!strcmp(orig_dnode
->schema
->name
, name
))
802 orig_dnode
= lyd_parent(orig_dnode
);
808 bool yang_is_last_list_dnode(const struct lyd_node
*dnode
)
810 return (((dnode
->next
== NULL
)
812 && (strcmp(dnode
->next
->schema
->name
, dnode
->schema
->name
)
815 && ((dnode
->prev
== dnode
)
816 || (strcmp(dnode
->prev
->schema
->name
, dnode
->schema
->name
)
820 bool yang_is_last_level_dnode(const struct lyd_node
*dnode
)
822 const struct lyd_node
*parent
;
823 const struct lyd_node
*key_leaf
;
826 switch (dnode
->schema
->nodetype
) {
828 assert(dnode
->parent
);
829 parent
= lyd_parent(dnode
);
830 uint snode_num_keys
= yang_snode_num_keys(parent
->schema
);
831 /* XXX libyang2: q: really don't understand this code. */
832 key_leaf
= dnode
->prev
;
833 for (keys_size
= 1; keys_size
< snode_num_keys
; keys_size
++)
834 key_leaf
= key_leaf
->prev
;
835 if (key_leaf
->prev
== dnode
)
847 const struct lyd_node
*
848 yang_get_subtree_with_no_sibling(const struct lyd_node
*dnode
)
851 const struct lyd_node
*node
;
854 if (node
->schema
->nodetype
!= LYS_LIST
)
858 switch (node
->schema
->nodetype
) {
860 if (!CHECK_FLAG(node
->schema
->flags
, LYS_PRESENCE
)) {
862 && (node
->parent
->schema
->module
863 == dnode
->schema
->module
))
864 node
= lyd_parent(node
);
871 if (yang_is_last_list_dnode(node
)
872 && yang_is_last_level_dnode(node
)) {
874 && (node
->parent
->schema
->module
875 == dnode
->schema
->module
))
876 node
= lyd_parent(node
);
890 uint32_t yang_get_list_pos(const struct lyd_node
*node
)
892 return lyd_list_pos(node
);
895 uint32_t yang_get_list_elements_count(const struct lyd_node
*node
)
898 const struct lysc_node
*schema
;
901 || ((node
->schema
->nodetype
!= LYS_LIST
)
902 && (node
->schema
->nodetype
!= LYS_LEAFLIST
))) {
906 schema
= node
->schema
;
909 if (node
->schema
== schema
)