1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2018 NetDEF, Inc.
10 #include "lib_errors.h"
12 #include "yang_translator.h"
13 #include "northbound.h"
15 DEFINE_MTYPE_STATIC(LIB
, YANG_MODULE
, "YANG module");
16 DEFINE_MTYPE_STATIC(LIB
, YANG_DATA
, "YANG data structure");
18 /* libyang container. */
19 struct ly_ctx
*ly_native_ctx
;
21 static struct yang_module_embed
*embeds
, **embedupd
= &embeds
;
23 void yang_module_embed(struct yang_module_embed
*embed
)
27 embedupd
= &embed
->next
;
30 static LY_ERR
yang_module_imp_clb(const char *mod_name
, const char *mod_rev
,
31 const char *submod_name
,
32 const char *submod_rev
, void *user_data
,
34 const char **module_data
,
35 void (**free_module_data
)(void *, void *))
37 struct yang_module_embed
*e
;
39 if (!strcmp(mod_name
, "ietf-inet-types") ||
40 !strcmp(mod_name
, "ietf-yang-types"))
41 /* libyang has these built in, don't try finding them here */
44 for (e
= embeds
; e
; e
= e
->next
) {
45 if (e
->sub_mod_name
&& submod_name
) {
46 if (strcmp(e
->sub_mod_name
, submod_name
))
49 if (submod_rev
&& strcmp(e
->sub_mod_rev
, submod_rev
))
52 if (strcmp(e
->mod_name
, mod_name
))
55 if (mod_rev
&& strcmp(e
->mod_rev
, mod_rev
))
60 *module_data
= e
->data
;
64 /* We get here for indirect modules like ietf-inet-types */
66 "YANG model \"%s@%s\" \"%s@%s\"not embedded, trying external file",
67 mod_name
, mod_rev
? mod_rev
: "*",
68 submod_name
? submod_name
: "*", submod_rev
? submod_rev
: "*");
73 /* clang-format off */
74 static const char *const frr_native_modules
[] = {
90 /* Generate the yang_modules tree. */
91 static inline int yang_module_compare(const struct yang_module
*a
,
92 const struct yang_module
*b
)
94 return strcmp(a
->name
, b
->name
);
96 RB_GENERATE(yang_modules
, yang_module
, entry
, yang_module_compare
)
98 struct yang_modules yang_modules
= RB_INITIALIZER(&yang_modules
);
100 struct yang_module
*yang_module_load(const char *module_name
)
102 struct yang_module
*module
;
103 const struct lys_module
*module_info
;
106 ly_ctx_load_module(ly_native_ctx
, module_name
, NULL
, NULL
);
108 flog_err(EC_LIB_YANG_MODULE_LOAD
,
109 "%s: failed to load data model: %s", __func__
,
114 module
= XCALLOC(MTYPE_YANG_MODULE
, sizeof(*module
));
115 module
->name
= module_name
;
116 module
->info
= module_info
;
118 if (RB_INSERT(yang_modules
, &yang_modules
, module
) != NULL
) {
119 flog_err(EC_LIB_YANG_MODULE_LOADED_ALREADY
,
120 "%s: YANG module is loaded already: %s", __func__
,
128 void yang_module_load_all(void)
130 for (size_t i
= 0; i
< array_size(frr_native_modules
); i
++)
131 yang_module_load(frr_native_modules
[i
]);
134 struct yang_module
*yang_module_find(const char *module_name
)
136 struct yang_module s
;
138 s
.name
= module_name
;
139 return RB_FIND(yang_modules
, &yang_modules
, &s
);
142 int yang_snodes_iterate_subtree(const struct lysc_node
*snode
,
143 const struct lys_module
*module
,
144 yang_iterate_cb cb
, uint16_t flags
, void *arg
)
146 const struct lysc_node
*child
;
147 int ret
= YANG_ITER_CONTINUE
;
149 if (module
&& snode
->module
!= module
)
152 switch (snode
->nodetype
) {
154 if (CHECK_FLAG(flags
, YANG_ITER_FILTER_NPCONTAINERS
)) {
155 if (!CHECK_FLAG(snode
->flags
, LYS_PRESENCE
))
160 if (CHECK_FLAG(flags
, YANG_ITER_FILTER_LIST_KEYS
)) {
161 /* Ignore list keys. */
162 if (lysc_is_key(snode
))
168 if (CHECK_FLAG(flags
, YANG_ITER_FILTER_INPUT_OUTPUT
))
172 assert(snode
->nodetype
!= LYS_AUGMENT
173 && snode
->nodetype
!= LYS_GROUPING
174 && snode
->nodetype
!= LYS_USES
);
178 ret
= (*cb
)(snode
, arg
);
179 if (ret
== YANG_ITER_STOP
)
184 * YANG leafs and leaf-lists can't have child nodes.
186 if (CHECK_FLAG(snode
->nodetype
, LYS_LEAF
| LYS_LEAFLIST
))
187 return YANG_ITER_CONTINUE
;
189 LY_LIST_FOR (lysc_node_child(snode
), child
) {
190 ret
= yang_snodes_iterate_subtree(child
, module
, cb
, flags
,
192 if (ret
== YANG_ITER_STOP
)
198 int yang_snodes_iterate(const struct lys_module
*module
, yang_iterate_cb cb
,
199 uint16_t flags
, void *arg
)
201 const struct lys_module
*module_iter
;
203 int ret
= YANG_ITER_CONTINUE
;
205 idx
= ly_ctx_internal_modules_count(ly_native_ctx
);
206 while ((module_iter
= ly_ctx_get_module_iter(ly_native_ctx
, &idx
))) {
207 struct lysc_node
*snode
;
209 if (!module_iter
->implemented
)
212 LY_LIST_FOR (module_iter
->compiled
->data
, snode
) {
213 ret
= yang_snodes_iterate_subtree(snode
, module
, cb
,
215 if (ret
== YANG_ITER_STOP
)
218 LY_LIST_FOR (&module_iter
->compiled
->rpcs
->node
, snode
) {
219 ret
= yang_snodes_iterate_subtree(snode
, module
, cb
,
221 if (ret
== YANG_ITER_STOP
)
224 LY_LIST_FOR (&module_iter
->compiled
->notifs
->node
, snode
) {
225 ret
= yang_snodes_iterate_subtree(snode
, module
, cb
,
227 if (ret
== YANG_ITER_STOP
)
235 void yang_snode_get_path(const struct lysc_node
*snode
,
236 enum yang_path_type type
, char *xpath
,
240 case YANG_PATH_SCHEMA
:
241 (void)lysc_path(snode
, LYSC_PATH_LOG
, xpath
, xpath_len
);
244 (void)lysc_path(snode
, LYSC_PATH_DATA
, xpath
, xpath_len
);
247 flog_err(EC_LIB_DEVELOPMENT
, "%s: unknown yang path type: %u",
253 struct lysc_node
*yang_snode_real_parent(const struct lysc_node
*snode
)
255 struct lysc_node
*parent
= snode
->parent
;
258 switch (parent
->nodetype
) {
260 if (CHECK_FLAG(parent
->flags
, LYS_PRESENCE
))
268 parent
= parent
->parent
;
274 struct lysc_node
*yang_snode_parent_list(const struct lysc_node
*snode
)
276 struct lysc_node
*parent
= snode
->parent
;
279 switch (parent
->nodetype
) {
285 parent
= parent
->parent
;
291 bool yang_snode_is_typeless_data(const struct lysc_node
*snode
)
293 const struct lysc_node_leaf
*sleaf
;
295 switch (snode
->nodetype
) {
297 sleaf
= (struct lysc_node_leaf
*)snode
;
298 if (sleaf
->type
->basetype
== LY_TYPE_EMPTY
)
308 const char *yang_snode_get_default(const struct lysc_node
*snode
)
310 const struct lysc_node_leaf
*sleaf
;
312 switch (snode
->nodetype
) {
314 sleaf
= (const struct lysc_node_leaf
*)snode
;
315 return sleaf
->dflt
? lyd_value_get_canonical(sleaf
->module
->ctx
,
319 /* TODO: check leaf-list default values */
326 const struct lysc_type
*yang_snode_get_type(const struct lysc_node
*snode
)
328 struct lysc_node_leaf
*sleaf
= (struct lysc_node_leaf
*)snode
;
329 struct lysc_type
*type
;
331 if (!CHECK_FLAG(sleaf
->nodetype
, LYS_LEAF
| LYS_LEAFLIST
))
335 while (type
->basetype
== LY_TYPE_LEAFREF
)
336 type
= ((struct lysc_type_leafref
*)type
)->realtype
;
341 unsigned int yang_snode_num_keys(const struct lysc_node
*snode
)
343 const struct lysc_node_leaf
*skey
;
346 if (!CHECK_FLAG(snode
->nodetype
, LYS_LIST
))
349 /* Walk list of children */
350 LY_FOR_KEYS (snode
, skey
) {
356 void yang_dnode_get_path(const struct lyd_node
*dnode
, char *xpath
,
359 lyd_path(dnode
, LYD_PATH_STD
, xpath
, xpath_len
);
362 const char *yang_dnode_get_schema_name(const struct lyd_node
*dnode
,
363 const char *xpath_fmt
, ...)
367 char xpath
[XPATH_MAXLEN
];
369 va_start(ap
, xpath_fmt
);
370 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
373 dnode
= yang_dnode_get(dnode
, xpath
);
375 flog_err(EC_LIB_YANG_DNODE_NOT_FOUND
,
376 "%s: couldn't find %s", __func__
, xpath
);
377 zlog_backtrace(LOG_ERR
);
382 return dnode
->schema
->name
;
385 struct lyd_node
*yang_dnode_get(const struct lyd_node
*dnode
, const char *xpath
)
387 struct ly_set
*set
= NULL
;
388 struct lyd_node
*dnode_ret
= NULL
;
391 * XXX a lot of the code uses this for style I guess. It shouldn't, as
392 * it adds to the xpath parsing complexity in libyang.
394 if (xpath
[0] == '.' && xpath
[1] == '/')
397 if (lyd_find_xpath(dnode
, xpath
, &set
)) {
398 assert(0); /* XXX replicates old libyang1 base code */
404 if (set
->count
> 1) {
405 flog_warn(EC_LIB_YANG_DNODE_NOT_FOUND
,
406 "%s: found %u elements (expected 0 or 1) [xpath %s]",
407 __func__
, set
->count
, xpath
);
411 dnode_ret
= set
->dnodes
[0];
414 ly_set_free(set
, NULL
);
419 struct lyd_node
*yang_dnode_getf(const struct lyd_node
*dnode
,
420 const char *xpath_fmt
, ...)
423 char xpath
[XPATH_MAXLEN
];
425 va_start(ap
, xpath_fmt
);
426 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
429 return yang_dnode_get(dnode
, xpath
);
432 bool yang_dnode_exists(const struct lyd_node
*dnode
, const char *xpath
)
434 struct ly_set
*set
= NULL
;
437 if (xpath
[0] == '.' && xpath
[1] == '/')
439 if (lyd_find_xpath(dnode
, xpath
, &set
))
441 exists
= set
->count
> 0;
442 ly_set_free(set
, NULL
);
446 bool yang_dnode_existsf(const struct lyd_node
*dnode
, const char *xpath_fmt
,
450 char xpath
[XPATH_MAXLEN
];
452 va_start(ap
, xpath_fmt
);
453 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
456 return yang_dnode_exists(dnode
, xpath
);
459 void yang_dnode_iterate(yang_dnode_iter_cb cb
, void *arg
,
460 const struct lyd_node
*dnode
, const char *xpath_fmt
,
464 char xpath
[XPATH_MAXLEN
];
467 va_start(ap
, xpath_fmt
);
468 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
471 if (lyd_find_xpath(dnode
, xpath
, &set
)) {
472 assert(0); /* XXX libyang2: ly1 code asserted success */
475 for (unsigned int i
= 0; i
< set
->count
; i
++) {
478 ret
= (*cb
)(set
->dnodes
[i
], arg
);
479 if (ret
== YANG_ITER_STOP
)
483 ly_set_free(set
, NULL
);
486 bool yang_dnode_is_default(const struct lyd_node
*dnode
, const char *xpath
)
488 const struct lysc_node
*snode
;
489 struct lysc_node_leaf
*sleaf
;
492 dnode
= yang_dnode_get(dnode
, xpath
);
495 snode
= dnode
->schema
;
496 switch (snode
->nodetype
) {
498 sleaf
= (struct lysc_node_leaf
*)snode
;
499 if (sleaf
->type
->basetype
== LY_TYPE_EMPTY
)
501 return lyd_is_default(dnode
);
503 /* TODO: check leaf-list default values */
506 if (CHECK_FLAG(snode
->flags
, LYS_PRESENCE
))
514 bool yang_dnode_is_defaultf(const struct lyd_node
*dnode
, const char *xpath_fmt
,
518 return yang_dnode_is_default(dnode
, NULL
);
521 char xpath
[XPATH_MAXLEN
];
523 va_start(ap
, xpath_fmt
);
524 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
527 return yang_dnode_is_default(dnode
, xpath
);
531 bool yang_dnode_is_default_recursive(const struct lyd_node
*dnode
)
533 struct lyd_node
*root
, *dnode_iter
;
535 if (!yang_dnode_is_default(dnode
, NULL
))
538 if (CHECK_FLAG(dnode
->schema
->nodetype
, LYS_LEAF
| LYS_LEAFLIST
))
541 LY_LIST_FOR (lyd_child(dnode
), root
) {
542 LYD_TREE_DFS_BEGIN (root
, dnode_iter
) {
543 if (!yang_dnode_is_default(dnode_iter
, NULL
))
546 LYD_TREE_DFS_END(root
, dnode_iter
);
553 void yang_dnode_change_leaf(struct lyd_node
*dnode
, const char *value
)
555 assert(dnode
->schema
->nodetype
== LYS_LEAF
);
556 lyd_change_term(dnode
, value
);
559 struct lyd_node
*yang_dnode_new(struct ly_ctx
*ly_ctx
, bool config_only
)
561 struct lyd_node
*dnode
= NULL
;
562 int options
= config_only
? LYD_VALIDATE_NO_STATE
: 0;
564 if (lyd_validate_all(&dnode
, ly_ctx
, options
, NULL
) != 0) {
565 /* Should never happen. */
566 flog_err(EC_LIB_LIBYANG
, "%s: lyd_validate() failed", __func__
);
573 struct lyd_node
*yang_dnode_dup(const struct lyd_node
*dnode
)
575 struct lyd_node
*dup
= NULL
;
577 err
= lyd_dup_siblings(dnode
, NULL
, LYD_DUP_RECURSIVE
, &dup
);
582 void yang_dnode_free(struct lyd_node
*dnode
)
584 while (dnode
->parent
)
585 dnode
= lyd_parent(dnode
);
589 struct yang_data
*yang_data_new(const char *xpath
, const char *value
)
591 struct yang_data
*data
;
593 data
= XCALLOC(MTYPE_YANG_DATA
, sizeof(*data
));
594 strlcpy(data
->xpath
, xpath
, sizeof(data
->xpath
));
596 data
->value
= strdup(value
);
601 void yang_data_free(struct yang_data
*data
)
605 XFREE(MTYPE_YANG_DATA
, data
);
608 struct list
*yang_data_list_new(void)
613 list
->del
= (void (*)(void *))yang_data_free
;
618 struct yang_data
*yang_data_list_find(const struct list
*list
,
619 const char *xpath_fmt
, ...)
621 char xpath
[XPATH_MAXLEN
];
622 struct yang_data
*data
;
623 struct listnode
*node
;
626 va_start(ap
, xpath_fmt
);
627 vsnprintf(xpath
, sizeof(xpath
), xpath_fmt
, ap
);
630 for (ALL_LIST_ELEMENTS_RO(list
, node
, data
))
631 if (strmatch(data
->xpath
, xpath
))
637 /* Make libyang log its errors using FRR logging infrastructure. */
638 static void ly_log_cb(LY_LOG_LEVEL level
, const char *msg
, const char *path
)
640 int priority
= LOG_ERR
;
647 priority
= LOG_WARNING
;
651 priority
= LOG_DEBUG
;
656 zlog(priority
, "libyang: %s (%s)", msg
, path
);
658 zlog(priority
, "libyang: %s", msg
);
661 const char *yang_print_errors(struct ly_ctx
*ly_ctx
, char *buf
, size_t buf_len
)
663 struct ly_err_item
*ei
;
666 ei
= ly_err_first(ly_ctx
);
670 strlcpy(buf
, "YANG error(s):\n", buf_len
);
671 for (; ei
; ei
= ei
->next
) {
672 strlcat(buf
, " ", buf_len
);
673 strlcat(buf
, ei
->msg
, buf_len
);
674 strlcat(buf
, "\n", buf_len
);
677 path
= ly_errpath(ly_ctx
);
679 strlcat(buf
, " YANG path: ", buf_len
);
680 strlcat(buf
, path
, buf_len
);
681 strlcat(buf
, "\n", buf_len
);
684 ly_err_clean(ly_ctx
, NULL
);
689 void yang_debugging_set(bool enable
)
692 ly_log_level(LY_LLDBG
);
693 ly_log_dbg_groups(0xFF);
695 ly_log_level(LY_LLERR
);
696 ly_log_dbg_groups(0);
700 struct ly_ctx
*yang_ctx_new_setup(bool embedded_modules
, bool explicit_compile
)
702 struct ly_ctx
*ctx
= NULL
;
703 const char *yang_models_path
= YANG_MODELS_PATH
;
706 if (access(yang_models_path
, R_OK
| X_OK
)) {
707 yang_models_path
= NULL
;
709 zlog_info("yang model directory \"%s\" does not exist",
712 flog_err_sys(EC_LIB_LIBYANG
,
713 "cannot access yang model directory \"%s\"",
717 uint options
= LY_CTX_NO_YANGLIBRARY
| LY_CTX_DISABLE_SEARCHDIR_CWD
;
718 if (explicit_compile
)
719 options
|= LY_CTX_EXPLICIT_COMPILE
;
720 err
= ly_ctx_new(yang_models_path
, options
, &ctx
);
724 if (embedded_modules
)
725 ly_ctx_set_module_imp_clb(ctx
, yang_module_imp_clb
, NULL
);
730 void yang_init(bool embedded_modules
, bool defer_compile
)
732 /* Initialize libyang global parameters that affect all containers. */
733 ly_set_log_clb(ly_log_cb
, 1);
734 ly_log_options(LY_LOLOG
| LY_LOSTORE
);
736 /* Initialize libyang container for native models. */
737 ly_native_ctx
= yang_ctx_new_setup(embedded_modules
, defer_compile
);
738 if (!ly_native_ctx
) {
739 flog_err(EC_LIB_LIBYANG
, "%s: ly_ctx_new() failed", __func__
);
743 yang_translator_init();
746 void yang_init_loading_complete(void)
748 /* Compile everything */
749 if (ly_ctx_compile(ly_native_ctx
) != LY_SUCCESS
) {
750 flog_err(EC_LIB_YANG_MODULE_LOAD
,
751 "%s: failed to compile loaded modules: %s", __func__
,
752 ly_errmsg(ly_native_ctx
));
757 void yang_terminate(void)
759 struct yang_module
*module
;
761 yang_translator_terminate();
763 while (!RB_EMPTY(yang_modules
, &yang_modules
)) {
764 module
= RB_ROOT(yang_modules
, &yang_modules
);
767 * We shouldn't call ly_ctx_remove_module() here because this
768 * function also removes other modules that depend on it.
770 * ly_ctx_destroy() will release all memory for us.
772 RB_REMOVE(yang_modules
, &yang_modules
, module
);
773 XFREE(MTYPE_YANG_MODULE
, module
);
776 ly_ctx_destroy(ly_native_ctx
);
779 const struct lyd_node
*yang_dnode_get_parent(const struct lyd_node
*dnode
,
782 const struct lyd_node
*orig_dnode
= dnode
;
785 switch (orig_dnode
->schema
->nodetype
) {
788 if (!strcmp(orig_dnode
->schema
->name
, name
))
795 orig_dnode
= lyd_parent(orig_dnode
);
801 bool yang_is_last_list_dnode(const struct lyd_node
*dnode
)
803 return (((dnode
->next
== NULL
)
805 && (strcmp(dnode
->next
->schema
->name
, dnode
->schema
->name
)
808 && ((dnode
->prev
== dnode
)
809 || (strcmp(dnode
->prev
->schema
->name
, dnode
->schema
->name
)
813 bool yang_is_last_level_dnode(const struct lyd_node
*dnode
)
815 const struct lyd_node
*parent
;
816 const struct lyd_node
*key_leaf
;
819 switch (dnode
->schema
->nodetype
) {
821 assert(dnode
->parent
);
822 parent
= lyd_parent(dnode
);
823 uint snode_num_keys
= yang_snode_num_keys(parent
->schema
);
824 /* XXX libyang2: q: really don't understand this code. */
825 key_leaf
= dnode
->prev
;
826 for (keys_size
= 1; keys_size
< snode_num_keys
; keys_size
++)
827 key_leaf
= key_leaf
->prev
;
828 if (key_leaf
->prev
== dnode
)
840 const struct lyd_node
*
841 yang_get_subtree_with_no_sibling(const struct lyd_node
*dnode
)
844 const struct lyd_node
*node
;
847 if (node
->schema
->nodetype
!= LYS_LIST
)
851 switch (node
->schema
->nodetype
) {
853 if (!CHECK_FLAG(node
->schema
->flags
, LYS_PRESENCE
)) {
855 && (node
->parent
->schema
->module
856 == dnode
->schema
->module
))
857 node
= lyd_parent(node
);
864 if (yang_is_last_list_dnode(node
)
865 && yang_is_last_level_dnode(node
)) {
867 && (node
->parent
->schema
->module
868 == dnode
->schema
->module
))
869 node
= lyd_parent(node
);
883 uint32_t yang_get_list_pos(const struct lyd_node
*node
)
885 return lyd_list_pos(node
);
888 uint32_t yang_get_list_elements_count(const struct lyd_node
*node
)
891 const struct lysc_node
*schema
;
894 || ((node
->schema
->nodetype
!= LYS_LIST
)
895 && (node
->schema
->nodetype
!= LYS_LEAFLIST
))) {
899 schema
= node
->schema
;
902 if (node
->schema
== schema
)