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
24 #include "lib_errors.h"
27 #include "northbound.h"
28 #include "northbound_cli.h"
29 #include "northbound_db.h"
31 DEFINE_MTYPE_STATIC(LIB
, NB_NODE
, "Northbound Node")
32 DEFINE_MTYPE_STATIC(LIB
, NB_CONFIG
, "Northbound Configuration")
34 /* Running configuration - shouldn't be modified directly. */
35 struct nb_config
*running_config
;
38 * Global lock used to prevent multiple configuration transactions from
39 * happening concurrently.
41 static bool transaction_in_progress
;
43 static int nb_configuration_callback(const enum nb_event event
,
44 struct nb_config_change
*change
);
45 static struct nb_transaction
*nb_transaction_new(struct nb_config
*config
,
46 struct nb_config_cbs
*changes
,
47 enum nb_client client
,
49 static void nb_transaction_free(struct nb_transaction
*transaction
);
50 static int nb_transaction_process(enum nb_event event
,
51 struct nb_transaction
*transaction
);
52 static void nb_transaction_apply_finish(struct nb_transaction
*transaction
);
53 static int nb_oper_data_iter_node(const struct lys_node
*snode
,
54 const char *xpath
, const void *list_entry
,
55 const struct yang_list_keys
*list_keys
,
56 struct yang_translator
*translator
,
57 bool first
, uint32_t flags
,
58 nb_oper_data_cb cb
, void *arg
);
60 static int nb_node_check_config_only(const struct lys_node
*snode
, void *arg
)
62 bool *config_only
= arg
;
64 if (CHECK_FLAG(snode
->flags
, LYS_CONFIG_R
)) {
66 return YANG_ITER_STOP
;
69 return YANG_ITER_CONTINUE
;
72 static int nb_node_new_cb(const struct lys_node
*snode
, void *arg
)
74 struct nb_node
*nb_node
;
75 struct lys_node
*sparent
, *sparent_list
;
77 nb_node
= XCALLOC(MTYPE_NB_NODE
, sizeof(*nb_node
));
78 yang_snode_get_path(snode
, YANG_PATH_DATA
, nb_node
->xpath
,
79 sizeof(nb_node
->xpath
));
80 nb_node
->priority
= NB_DFLT_PRIORITY
;
81 sparent
= yang_snode_real_parent(snode
);
83 nb_node
->parent
= sparent
->priv
;
84 sparent_list
= yang_snode_parent_list(snode
);
86 nb_node
->parent_list
= sparent_list
->priv
;
89 if (CHECK_FLAG(snode
->nodetype
, LYS_CONTAINER
| LYS_LIST
)) {
90 bool config_only
= true;
92 yang_snodes_iterate_subtree(snode
, nb_node_check_config_only
,
93 YANG_ITER_ALLOW_AUGMENTATIONS
,
96 SET_FLAG(nb_node
->flags
, F_NB_NODE_CONFIG_ONLY
);
98 if (CHECK_FLAG(snode
->nodetype
, LYS_LIST
)) {
99 struct lys_node_list
*slist
;
101 slist
= (struct lys_node_list
*)snode
;
102 if (slist
->keys_size
== 0)
103 SET_FLAG(nb_node
->flags
, F_NB_NODE_KEYLESS_LIST
);
107 * Link the northbound node and the libyang schema node with one
110 nb_node
->snode
= snode
;
111 lys_set_private(snode
, nb_node
);
113 return YANG_ITER_CONTINUE
;
116 static int nb_node_del_cb(const struct lys_node
*snode
, void *arg
)
118 struct nb_node
*nb_node
;
120 nb_node
= snode
->priv
;
121 lys_set_private(snode
, NULL
);
122 XFREE(MTYPE_NB_NODE
, nb_node
);
124 return YANG_ITER_CONTINUE
;
127 void nb_nodes_create(void)
129 yang_snodes_iterate_all(nb_node_new_cb
, 0, NULL
);
132 void nb_nodes_delete(void)
134 yang_snodes_iterate_all(nb_node_del_cb
, 0, NULL
);
137 struct nb_node
*nb_node_find(const char *xpath
)
139 const struct lys_node
*snode
;
142 * Use libyang to find the schema node associated to the xpath and get
143 * the northbound node from there (snode private pointer).
145 snode
= ly_ctx_get_node(ly_native_ctx
, NULL
, xpath
, 0);
152 static int nb_node_validate_cb(const struct nb_node
*nb_node
,
153 enum nb_operation operation
,
154 int callback_implemented
, bool optional
)
158 valid
= nb_operation_is_valid(operation
, nb_node
->snode
);
160 if (!valid
&& callback_implemented
)
161 flog_warn(EC_LIB_NB_CB_UNNEEDED
,
162 "unneeded '%s' callback for '%s'",
163 nb_operation_name(operation
), nb_node
->xpath
);
165 if (!optional
&& valid
&& !callback_implemented
) {
166 flog_err(EC_LIB_NB_CB_MISSING
, "missing '%s' callback for '%s'",
167 nb_operation_name(operation
), nb_node
->xpath
);
175 * Check if the required callbacks were implemented for the given northbound
178 static unsigned int nb_node_validate_cbs(const struct nb_node
*nb_node
)
181 unsigned int error
= 0;
183 error
+= nb_node_validate_cb(nb_node
, NB_OP_CREATE
,
184 !!nb_node
->cbs
.create
, false);
185 error
+= nb_node_validate_cb(nb_node
, NB_OP_MODIFY
,
186 !!nb_node
->cbs
.modify
, false);
187 error
+= nb_node_validate_cb(nb_node
, NB_OP_DESTROY
,
188 !!nb_node
->cbs
.destroy
, false);
189 error
+= nb_node_validate_cb(nb_node
, NB_OP_MOVE
, !!nb_node
->cbs
.move
,
191 error
+= nb_node_validate_cb(nb_node
, NB_OP_APPLY_FINISH
,
192 !!nb_node
->cbs
.apply_finish
, true);
193 error
+= nb_node_validate_cb(nb_node
, NB_OP_GET_ELEM
,
194 !!nb_node
->cbs
.get_elem
, false);
195 error
+= nb_node_validate_cb(nb_node
, NB_OP_GET_NEXT
,
196 !!nb_node
->cbs
.get_next
, false);
197 error
+= nb_node_validate_cb(nb_node
, NB_OP_GET_KEYS
,
198 !!nb_node
->cbs
.get_keys
, false);
199 error
+= nb_node_validate_cb(nb_node
, NB_OP_LOOKUP_ENTRY
,
200 !!nb_node
->cbs
.lookup_entry
, false);
201 error
+= nb_node_validate_cb(nb_node
, NB_OP_RPC
, !!nb_node
->cbs
.rpc
,
207 static unsigned int nb_node_validate_priority(const struct nb_node
*nb_node
)
209 /* Top-level nodes can have any priority. */
210 if (!nb_node
->parent
)
213 if (nb_node
->priority
< nb_node
->parent
->priority
) {
214 flog_err(EC_LIB_NB_CB_INVALID_PRIO
,
215 "node has higher priority than its parent [xpath %s]",
223 static int nb_node_validate(const struct lys_node
*snode
, void *arg
)
225 struct nb_node
*nb_node
= snode
->priv
;
226 unsigned int *errors
= arg
;
228 /* Validate callbacks and priority. */
229 *errors
+= nb_node_validate_cbs(nb_node
);
230 *errors
+= nb_node_validate_priority(nb_node
);
232 return YANG_ITER_CONTINUE
;
235 struct nb_config
*nb_config_new(struct lyd_node
*dnode
)
237 struct nb_config
*config
;
239 config
= XCALLOC(MTYPE_NB_CONFIG
, sizeof(*config
));
241 config
->dnode
= dnode
;
243 config
->dnode
= yang_dnode_new(ly_native_ctx
, true);
249 void nb_config_free(struct nb_config
*config
)
252 yang_dnode_free(config
->dnode
);
253 XFREE(MTYPE_NB_CONFIG
, config
);
256 struct nb_config
*nb_config_dup(const struct nb_config
*config
)
258 struct nb_config
*dup
;
260 dup
= XCALLOC(MTYPE_NB_CONFIG
, sizeof(*dup
));
261 dup
->dnode
= yang_dnode_dup(config
->dnode
);
262 dup
->version
= config
->version
;
267 int nb_config_merge(struct nb_config
*config_dst
, struct nb_config
*config_src
,
268 bool preserve_source
)
272 ret
= lyd_merge(config_dst
->dnode
, config_src
->dnode
, LYD_OPT_EXPLICIT
);
274 flog_warn(EC_LIB_LIBYANG
, "%s: lyd_merge() failed", __func__
);
276 if (!preserve_source
)
277 nb_config_free(config_src
);
279 return (ret
== 0) ? NB_OK
: NB_ERR
;
282 void nb_config_replace(struct nb_config
*config_dst
,
283 struct nb_config
*config_src
, bool preserve_source
)
285 /* Update version. */
286 if (config_src
->version
!= 0)
287 config_dst
->version
= config_src
->version
;
290 if (config_dst
->dnode
)
291 yang_dnode_free(config_dst
->dnode
);
292 if (preserve_source
) {
293 config_dst
->dnode
= yang_dnode_dup(config_src
->dnode
);
295 config_dst
->dnode
= config_src
->dnode
;
296 config_src
->dnode
= NULL
;
297 nb_config_free(config_src
);
301 /* Generate the nb_config_cbs tree. */
302 static inline int nb_config_cb_compare(const struct nb_config_cb
*a
,
303 const struct nb_config_cb
*b
)
305 /* Sort by priority first. */
306 if (a
->nb_node
->priority
< b
->nb_node
->priority
)
308 if (a
->nb_node
->priority
> b
->nb_node
->priority
)
312 * Use XPath as a tie-breaker. This will naturally sort parent nodes
313 * before their children.
315 return strcmp(a
->xpath
, b
->xpath
);
317 RB_GENERATE(nb_config_cbs
, nb_config_cb
, entry
, nb_config_cb_compare
);
319 static void nb_config_diff_add_change(struct nb_config_cbs
*changes
,
320 enum nb_operation operation
,
321 const struct lyd_node
*dnode
)
323 struct nb_config_change
*change
;
325 change
= XCALLOC(MTYPE_TMP
, sizeof(*change
));
326 change
->cb
.operation
= operation
;
327 change
->cb
.nb_node
= dnode
->schema
->priv
;
328 yang_dnode_get_path(dnode
, change
->cb
.xpath
, sizeof(change
->cb
.xpath
));
329 change
->cb
.dnode
= dnode
;
331 RB_INSERT(nb_config_cbs
, changes
, &change
->cb
);
334 static void nb_config_diff_del_changes(struct nb_config_cbs
*changes
)
336 while (!RB_EMPTY(nb_config_cbs
, changes
)) {
337 struct nb_config_change
*change
;
339 change
= (struct nb_config_change
*)RB_ROOT(nb_config_cbs
,
341 RB_REMOVE(nb_config_cbs
, changes
, &change
->cb
);
342 XFREE(MTYPE_TMP
, change
);
347 * Helper function used when calculating the delta between two different
348 * configurations. Given a new subtree, calculate all new YANG data nodes,
349 * excluding default leafs and leaf-lists. This is a recursive function.
351 static void nb_config_diff_new_subtree(const struct lyd_node
*dnode
,
352 struct nb_config_cbs
*changes
)
354 struct lyd_node
*child
;
356 LY_TREE_FOR (dnode
->child
, child
) {
357 enum nb_operation operation
;
359 switch (child
->schema
->nodetype
) {
362 if (lyd_wd_default((struct lyd_node_leaf_list
*)child
))
365 if (nb_operation_is_valid(NB_OP_CREATE
, child
->schema
))
366 operation
= NB_OP_CREATE
;
367 else if (nb_operation_is_valid(NB_OP_MODIFY
,
369 operation
= NB_OP_MODIFY
;
373 nb_config_diff_add_change(changes
, operation
, child
);
377 if (nb_operation_is_valid(NB_OP_CREATE
, child
->schema
))
378 nb_config_diff_add_change(changes
, NB_OP_CREATE
,
380 nb_config_diff_new_subtree(child
, changes
);
388 /* Calculate the delta between two different configurations. */
389 static void nb_config_diff(const struct nb_config
*config1
,
390 const struct nb_config
*config2
,
391 struct nb_config_cbs
*changes
)
393 struct lyd_difflist
*diff
;
395 diff
= lyd_diff(config1
->dnode
, config2
->dnode
,
396 LYD_DIFFOPT_WITHDEFAULTS
);
399 for (int i
= 0; diff
->type
[i
] != LYD_DIFF_END
; i
++) {
401 struct lyd_node
*dnode
;
402 enum nb_operation operation
;
404 type
= diff
->type
[i
];
407 case LYD_DIFF_CREATED
:
408 dnode
= diff
->second
[i
];
410 if (nb_operation_is_valid(NB_OP_CREATE
, dnode
->schema
))
411 operation
= NB_OP_CREATE
;
412 else if (nb_operation_is_valid(NB_OP_MODIFY
,
414 operation
= NB_OP_MODIFY
;
418 case LYD_DIFF_DELETED
:
419 dnode
= diff
->first
[i
];
420 operation
= NB_OP_DESTROY
;
422 case LYD_DIFF_CHANGED
:
423 dnode
= diff
->second
[i
];
424 operation
= NB_OP_MODIFY
;
426 case LYD_DIFF_MOVEDAFTER1
:
427 case LYD_DIFF_MOVEDAFTER2
:
432 nb_config_diff_add_change(changes
, operation
, dnode
);
434 if (type
== LYD_DIFF_CREATED
435 && CHECK_FLAG(dnode
->schema
->nodetype
,
436 LYS_CONTAINER
| LYS_LIST
))
437 nb_config_diff_new_subtree(dnode
, changes
);
443 int nb_candidate_edit(struct nb_config
*candidate
,
444 const struct nb_node
*nb_node
,
445 enum nb_operation operation
, const char *xpath
,
446 const struct yang_data
*previous
,
447 const struct yang_data
*data
)
449 struct lyd_node
*dnode
;
450 char xpath_edit
[XPATH_MAXLEN
];
452 if (!nb_operation_is_valid(operation
, nb_node
->snode
)) {
453 flog_warn(EC_LIB_NB_CANDIDATE_EDIT_ERROR
,
454 "%s: %s operation not valid for %s", __func__
,
455 nb_operation_name(operation
), xpath
);
459 /* Use special notation for leaf-lists (RFC 6020, section 9.13.5). */
460 if (nb_node
->snode
->nodetype
== LYS_LEAFLIST
)
461 snprintf(xpath_edit
, sizeof(xpath_edit
), "%s[.='%s']", xpath
,
464 strlcpy(xpath_edit
, xpath
, sizeof(xpath_edit
));
470 dnode
= lyd_new_path(candidate
->dnode
, ly_native_ctx
,
471 xpath_edit
, (void *)data
->value
, 0,
472 LYD_PATH_OPT_UPDATE
);
473 if (!dnode
&& ly_errno
) {
474 flog_warn(EC_LIB_LIBYANG
, "%s: lyd_new_path() failed",
480 * If a new node was created, call lyd_validate() only to create
481 * default child nodes.
484 lyd_schema_sort(dnode
, 0);
485 lyd_validate(&dnode
, LYD_OPT_CONFIG
, ly_native_ctx
);
489 dnode
= yang_dnode_get(candidate
->dnode
, xpath_edit
);
492 * Return a special error code so the caller can choose
493 * whether to ignore it or not.
495 return NB_ERR_NOT_FOUND
;
499 /* TODO: update configuration. */
502 flog_warn(EC_LIB_DEVELOPMENT
,
503 "%s: unknown operation (%u) [xpath %s]", __func__
,
504 operation
, xpath_edit
);
511 bool nb_candidate_needs_update(const struct nb_config
*candidate
)
513 if (candidate
->version
< running_config
->version
)
519 int nb_candidate_update(struct nb_config
*candidate
)
521 struct nb_config
*updated_config
;
523 updated_config
= nb_config_dup(running_config
);
524 if (nb_config_merge(updated_config
, candidate
, true) != NB_OK
)
527 nb_config_replace(candidate
, updated_config
, false);
533 * The northbound configuration callbacks use the 'priv' pointer present in the
534 * libyang lyd_node structure to store pointers to FRR internal variables
535 * associated to YANG lists and presence containers. Before commiting a
536 * candidate configuration, we must restore the 'priv' pointers stored in the
537 * running configuration since they might be lost while editing the candidate.
539 static void nb_candidate_restore_priv_pointers(struct nb_config
*candidate
)
541 struct lyd_node
*root
, *next
, *dnode_iter
;
543 LY_TREE_FOR (running_config
->dnode
, root
) {
544 LY_TREE_DFS_BEGIN (root
, next
, dnode_iter
) {
545 struct lyd_node
*dnode_candidate
;
546 char xpath
[XPATH_MAXLEN
];
548 if (!dnode_iter
->priv
)
551 yang_dnode_get_path(dnode_iter
, xpath
, sizeof(xpath
));
553 yang_dnode_get(candidate
->dnode
, xpath
);
555 yang_dnode_set_entry(dnode_candidate
,
559 LY_TREE_DFS_END(root
, next
, dnode_iter
);
565 * Perform YANG syntactic and semantic validation.
567 * WARNING: lyd_validate() can change the configuration as part of the
568 * validation process.
570 static int nb_candidate_validate_yang(struct nb_config
*candidate
)
572 if (lyd_validate(&candidate
->dnode
, LYD_OPT_STRICT
| LYD_OPT_CONFIG
,
575 return NB_ERR_VALIDATION
;
580 /* Perform code-level validation using the northbound callbacks. */
581 static int nb_candidate_validate_changes(struct nb_config
*candidate
,
582 struct nb_config_cbs
*changes
)
584 struct nb_config_cb
*cb
;
586 nb_candidate_restore_priv_pointers(candidate
);
587 RB_FOREACH (cb
, nb_config_cbs
, changes
) {
588 struct nb_config_change
*change
= (struct nb_config_change
*)cb
;
591 ret
= nb_configuration_callback(NB_EV_VALIDATE
, change
);
593 return NB_ERR_VALIDATION
;
599 int nb_candidate_validate(struct nb_config
*candidate
)
601 struct nb_config_cbs changes
;
604 if (nb_candidate_validate_yang(candidate
) != NB_OK
)
605 return NB_ERR_VALIDATION
;
607 RB_INIT(nb_config_cbs
, &changes
);
608 nb_config_diff(running_config
, candidate
, &changes
);
609 ret
= nb_candidate_validate_changes(candidate
, &changes
);
610 nb_config_diff_del_changes(&changes
);
615 int nb_candidate_commit_prepare(struct nb_config
*candidate
,
616 enum nb_client client
, const char *comment
,
617 struct nb_transaction
**transaction
)
619 struct nb_config_cbs changes
;
621 if (nb_candidate_validate_yang(candidate
) != NB_OK
) {
622 flog_warn(EC_LIB_NB_CANDIDATE_INVALID
,
623 "%s: failed to validate candidate configuration",
625 return NB_ERR_VALIDATION
;
628 RB_INIT(nb_config_cbs
, &changes
);
629 nb_config_diff(running_config
, candidate
, &changes
);
630 if (RB_EMPTY(nb_config_cbs
, &changes
))
631 return NB_ERR_NO_CHANGES
;
633 if (nb_candidate_validate_changes(candidate
, &changes
) != NB_OK
) {
634 flog_warn(EC_LIB_NB_CANDIDATE_INVALID
,
635 "%s: failed to validate candidate configuration",
637 nb_config_diff_del_changes(&changes
);
638 return NB_ERR_VALIDATION
;
641 *transaction
= nb_transaction_new(candidate
, &changes
, client
, comment
);
642 if (*transaction
== NULL
) {
643 flog_warn(EC_LIB_NB_TRANSACTION_CREATION_FAILED
,
644 "%s: failed to create transaction", __func__
);
645 nb_config_diff_del_changes(&changes
);
646 return NB_ERR_LOCKED
;
649 return nb_transaction_process(NB_EV_PREPARE
, *transaction
);
652 void nb_candidate_commit_abort(struct nb_transaction
*transaction
)
654 (void)nb_transaction_process(NB_EV_ABORT
, transaction
);
655 nb_transaction_free(transaction
);
658 void nb_candidate_commit_apply(struct nb_transaction
*transaction
,
659 bool save_transaction
, uint32_t *transaction_id
)
661 (void)nb_transaction_process(NB_EV_APPLY
, transaction
);
662 nb_transaction_apply_finish(transaction
);
664 /* Replace running by candidate. */
665 transaction
->config
->version
++;
666 nb_config_replace(running_config
, transaction
->config
, true);
668 /* Record transaction. */
670 && nb_db_transaction_save(transaction
, transaction_id
) != NB_OK
)
671 flog_warn(EC_LIB_NB_TRANSACTION_RECORD_FAILED
,
672 "%s: failed to record transaction", __func__
);
674 nb_transaction_free(transaction
);
677 int nb_candidate_commit(struct nb_config
*candidate
, enum nb_client client
,
678 bool save_transaction
, const char *comment
,
679 uint32_t *transaction_id
)
681 struct nb_transaction
*transaction
= NULL
;
684 ret
= nb_candidate_commit_prepare(candidate
, client
, comment
,
687 * Apply the changes if the preparation phase succeeded. Otherwise abort
691 nb_candidate_commit_apply(transaction
, save_transaction
,
693 else if (transaction
!= NULL
)
694 nb_candidate_commit_abort(transaction
);
699 static void nb_log_callback(const enum nb_event event
,
700 enum nb_operation operation
, const char *xpath
,
704 "northbound callback: event [%s] op [%s] xpath [%s] value [%s]",
705 nb_event_name(event
), nb_operation_name(operation
), xpath
,
710 * Call the northbound configuration callback associated to a given
711 * configuration change.
713 static int nb_configuration_callback(const enum nb_event event
,
714 struct nb_config_change
*change
)
716 enum nb_operation operation
= change
->cb
.operation
;
717 const char *xpath
= change
->cb
.xpath
;
718 const struct nb_node
*nb_node
= change
->cb
.nb_node
;
719 const struct lyd_node
*dnode
= change
->cb
.dnode
;
720 union nb_resource
*resource
;
723 if (debug_northbound
) {
724 const char *value
= "(none)";
726 if (dnode
&& !yang_snode_is_typeless_data(dnode
->schema
))
727 value
= yang_dnode_get_string(dnode
, NULL
);
729 nb_log_callback(event
, operation
, xpath
, value
);
732 if (event
== NB_EV_VALIDATE
)
735 resource
= &change
->resource
;
739 ret
= (*nb_node
->cbs
.create
)(event
, dnode
, resource
);
742 ret
= (*nb_node
->cbs
.modify
)(event
, dnode
, resource
);
745 ret
= (*nb_node
->cbs
.destroy
)(event
, dnode
);
748 ret
= (*nb_node
->cbs
.move
)(event
, dnode
);
755 enum lib_log_refs ref
= 0;
759 ref
= EC_LIB_NB_CB_CONFIG_VALIDATE
;
762 ref
= EC_LIB_NB_CB_CONFIG_PREPARE
;
765 ref
= EC_LIB_NB_CB_CONFIG_ABORT
;
768 ref
= EC_LIB_NB_CB_CONFIG_APPLY
;
771 if (event
== NB_EV_VALIDATE
|| event
== NB_EV_PREPARE
)
774 "%s: error processing configuration change: error [%s] event [%s] operation [%s] xpath [%s]",
775 __func__
, nb_err_name(ret
),
776 nb_event_name(event
),
777 nb_operation_name(operation
), xpath
);
781 "%s: error processing configuration change: error [%s] event [%s] operation [%s] xpath [%s]",
782 __func__
, nb_err_name(ret
),
783 nb_event_name(event
),
784 nb_operation_name(operation
), xpath
);
790 static struct nb_transaction
*nb_transaction_new(struct nb_config
*config
,
791 struct nb_config_cbs
*changes
,
792 enum nb_client client
,
795 struct nb_transaction
*transaction
;
797 if (transaction_in_progress
) {
799 EC_LIB_NB_TRANSACTION_CREATION_FAILED
,
800 "%s: error - there's already another transaction in progress",
804 transaction_in_progress
= true;
806 transaction
= XCALLOC(MTYPE_TMP
, sizeof(*transaction
));
807 transaction
->client
= client
;
809 strlcpy(transaction
->comment
, comment
,
810 sizeof(transaction
->comment
));
811 transaction
->config
= config
;
812 transaction
->changes
= *changes
;
817 static void nb_transaction_free(struct nb_transaction
*transaction
)
819 nb_config_diff_del_changes(&transaction
->changes
);
820 XFREE(MTYPE_TMP
, transaction
);
821 transaction_in_progress
= false;
824 /* Process all configuration changes associated to a transaction. */
825 static int nb_transaction_process(enum nb_event event
,
826 struct nb_transaction
*transaction
)
828 struct nb_config_cb
*cb
;
830 RB_FOREACH (cb
, nb_config_cbs
, &transaction
->changes
) {
831 struct nb_config_change
*change
= (struct nb_config_change
*)cb
;
835 * Only try to release resources that were allocated
838 if (event
== NB_EV_ABORT
&& change
->prepare_ok
== false)
841 /* Call the appropriate callback. */
842 ret
= nb_configuration_callback(event
, change
);
847 change
->prepare_ok
= true;
852 * At this point it's not possible to reject the
853 * transaction anymore, so any failure here can lead to
854 * inconsistencies and should be treated as a bug.
855 * Operations prone to errors, like validations and
856 * resource allocations, should be performed during the
868 static struct nb_config_cb
*
869 nb_apply_finish_cb_new(struct nb_config_cbs
*cbs
, const char *xpath
,
870 const struct nb_node
*nb_node
,
871 const struct lyd_node
*dnode
)
873 struct nb_config_cb
*cb
;
875 cb
= XCALLOC(MTYPE_TMP
, sizeof(*cb
));
876 strlcpy(cb
->xpath
, xpath
, sizeof(cb
->xpath
));
877 cb
->nb_node
= nb_node
;
879 RB_INSERT(nb_config_cbs
, cbs
, cb
);
884 static struct nb_config_cb
*
885 nb_apply_finish_cb_find(struct nb_config_cbs
*cbs
, const char *xpath
,
886 const struct nb_node
*nb_node
)
888 struct nb_config_cb s
;
890 strlcpy(s
.xpath
, xpath
, sizeof(s
.xpath
));
892 return RB_FIND(nb_config_cbs
, cbs
, &s
);
895 /* Call the 'apply_finish' callbacks. */
896 static void nb_transaction_apply_finish(struct nb_transaction
*transaction
)
898 struct nb_config_cbs cbs
;
899 struct nb_config_cb
*cb
;
901 /* Initialize tree of 'apply_finish' callbacks. */
902 RB_INIT(nb_config_cbs
, &cbs
);
904 /* Identify the 'apply_finish' callbacks that need to be called. */
905 RB_FOREACH (cb
, nb_config_cbs
, &transaction
->changes
) {
906 struct nb_config_change
*change
= (struct nb_config_change
*)cb
;
907 const struct lyd_node
*dnode
= change
->cb
.dnode
;
910 * Iterate up to the root of the data tree. When a node is being
911 * deleted, skip its 'apply_finish' callback if one is defined
912 * (the 'apply_finish' callbacks from the node ancestors should
915 if (change
->cb
.operation
== NB_OP_DESTROY
) {
916 char xpath
[XPATH_MAXLEN
];
918 dnode
= dnode
->parent
;
923 * The dnode from 'delete' callbacks point to elements
924 * from the running configuration. Use yang_dnode_get()
925 * to get the corresponding dnode from the candidate
926 * configuration that is being committed.
928 yang_dnode_get_path(dnode
, xpath
, sizeof(xpath
));
929 dnode
= yang_dnode_get(transaction
->config
->dnode
,
933 char xpath
[XPATH_MAXLEN
];
934 struct nb_node
*nb_node
;
936 nb_node
= dnode
->schema
->priv
;
937 if (!nb_node
->cbs
.apply_finish
)
941 * Don't call the callback more than once for the same
944 yang_dnode_get_path(dnode
, xpath
, sizeof(xpath
));
945 if (nb_apply_finish_cb_find(&cbs
, xpath
, nb_node
))
948 nb_apply_finish_cb_new(&cbs
, xpath
, nb_node
, dnode
);
951 dnode
= dnode
->parent
;
955 /* Call the 'apply_finish' callbacks, sorted by their priorities. */
956 RB_FOREACH (cb
, nb_config_cbs
, &cbs
) {
957 if (debug_northbound
)
958 nb_log_callback(NB_EV_APPLY
, NB_OP_APPLY_FINISH
,
961 (*cb
->nb_node
->cbs
.apply_finish
)(cb
->dnode
);
964 /* Release memory. */
965 while (!RB_EMPTY(nb_config_cbs
, &cbs
)) {
966 cb
= RB_ROOT(nb_config_cbs
, &cbs
);
967 RB_REMOVE(nb_config_cbs
, &cbs
, cb
);
968 XFREE(MTYPE_TMP
, cb
);
972 static int nb_oper_data_iter_children(const struct lys_node
*snode
,
973 const char *xpath
, const void *list_entry
,
974 const struct yang_list_keys
*list_keys
,
975 struct yang_translator
*translator
,
976 bool first
, uint32_t flags
,
977 nb_oper_data_cb cb
, void *arg
)
979 struct lys_node
*child
;
981 LY_TREE_FOR (snode
->child
, child
) {
984 ret
= nb_oper_data_iter_node(child
, xpath
, list_entry
,
985 list_keys
, translator
, false,
994 static int nb_oper_data_iter_leaf(const struct nb_node
*nb_node
,
995 const char *xpath
, const void *list_entry
,
996 const struct yang_list_keys
*list_keys
,
997 struct yang_translator
*translator
,
998 uint32_t flags
, nb_oper_data_cb cb
, void *arg
)
1000 struct yang_data
*data
;
1002 if (CHECK_FLAG(nb_node
->snode
->flags
, LYS_CONFIG_W
))
1005 /* Ignore list keys. */
1006 if (lys_is_key((struct lys_node_leaf
*)nb_node
->snode
, NULL
))
1009 data
= nb_node
->cbs
.get_elem(xpath
, list_entry
);
1011 /* Leaf of type "empty" is not present. */
1014 return (*cb
)(nb_node
->snode
, translator
, data
, arg
);
1017 static int nb_oper_data_iter_container(const struct nb_node
*nb_node
,
1019 const void *list_entry
,
1020 const struct yang_list_keys
*list_keys
,
1021 struct yang_translator
*translator
,
1022 uint32_t flags
, nb_oper_data_cb cb
,
1025 if (CHECK_FLAG(nb_node
->flags
, F_NB_NODE_CONFIG_ONLY
))
1028 /* Presence containers. */
1029 if (nb_node
->cbs
.get_elem
) {
1030 struct yang_data
*data
;
1033 data
= nb_node
->cbs
.get_elem(xpath
, list_entry
);
1035 /* Presence container is not present. */
1038 ret
= (*cb
)(nb_node
->snode
, translator
, data
, arg
);
1043 /* Iterate over the child nodes. */
1044 return nb_oper_data_iter_children(nb_node
->snode
, xpath
, list_entry
,
1045 list_keys
, translator
, false, flags
,
1050 nb_oper_data_iter_leaflist(const struct nb_node
*nb_node
, const char *xpath
,
1051 const void *parent_list_entry
,
1052 const struct yang_list_keys
*parent_list_keys
,
1053 struct yang_translator
*translator
, uint32_t flags
,
1054 nb_oper_data_cb cb
, void *arg
)
1056 const void *list_entry
= NULL
;
1058 if (CHECK_FLAG(nb_node
->snode
->flags
, LYS_CONFIG_W
))
1062 struct yang_data
*data
;
1066 nb_node
->cbs
.get_next(parent_list_entry
, list_entry
);
1068 /* End of the list. */
1071 data
= nb_node
->cbs
.get_elem(xpath
, list_entry
);
1075 ret
= (*cb
)(nb_node
->snode
, translator
, data
, arg
);
1078 } while (list_entry
);
1083 static int nb_oper_data_iter_list(const struct nb_node
*nb_node
,
1084 const char *xpath_list
,
1085 const void *parent_list_entry
,
1086 const struct yang_list_keys
*parent_list_keys
,
1087 struct yang_translator
*translator
,
1088 uint32_t flags
, nb_oper_data_cb cb
, void *arg
)
1090 struct lys_node_list
*slist
= (struct lys_node_list
*)nb_node
->snode
;
1091 const void *list_entry
= NULL
;
1092 uint32_t position
= 1;
1094 if (CHECK_FLAG(nb_node
->flags
, F_NB_NODE_CONFIG_ONLY
))
1097 /* Iterate over all list entries. */
1099 struct yang_list_keys list_keys
;
1100 char xpath
[XPATH_MAXLEN
* 2];
1103 /* Obtain list entry. */
1105 nb_node
->cbs
.get_next(parent_list_entry
, list_entry
);
1107 /* End of the list. */
1110 if (!CHECK_FLAG(nb_node
->flags
, F_NB_NODE_KEYLESS_LIST
)) {
1111 /* Obtain the list entry keys. */
1112 if (nb_node
->cbs
.get_keys(list_entry
, &list_keys
)
1114 flog_warn(EC_LIB_NB_CB_STATE
,
1115 "%s: failed to get list keys",
1120 /* Build XPath of the list entry. */
1121 strlcpy(xpath
, xpath_list
, sizeof(xpath
));
1122 for (unsigned int i
= 0; i
< list_keys
.num
; i
++) {
1123 snprintf(xpath
+ strlen(xpath
),
1124 sizeof(xpath
) - strlen(xpath
),
1125 "[%s='%s']", slist
->keys
[i
]->name
,
1130 * Keyless list - build XPath using a positional index.
1132 snprintf(xpath
, sizeof(xpath
), "%s[%u]", xpath_list
,
1137 /* Iterate over the child nodes. */
1138 ret
= nb_oper_data_iter_children(
1139 nb_node
->snode
, xpath
, list_entry
, &list_keys
,
1140 translator
, false, flags
, cb
, arg
);
1143 } while (list_entry
);
1148 static int nb_oper_data_iter_node(const struct lys_node
*snode
,
1149 const char *xpath_parent
,
1150 const void *list_entry
,
1151 const struct yang_list_keys
*list_keys
,
1152 struct yang_translator
*translator
,
1153 bool first
, uint32_t flags
,
1154 nb_oper_data_cb cb
, void *arg
)
1156 struct nb_node
*nb_node
;
1157 char xpath
[XPATH_MAXLEN
];
1160 if (!first
&& CHECK_FLAG(flags
, NB_OPER_DATA_ITER_NORECURSE
)
1161 && CHECK_FLAG(snode
->nodetype
, LYS_CONTAINER
| LYS_LIST
))
1165 strlcpy(xpath
, xpath_parent
, sizeof(xpath
));
1166 if (!first
&& snode
->nodetype
!= LYS_USES
)
1167 snprintf(xpath
+ strlen(xpath
), sizeof(xpath
) - strlen(xpath
),
1168 "/%s", snode
->name
);
1170 nb_node
= snode
->priv
;
1171 switch (snode
->nodetype
) {
1173 ret
= nb_oper_data_iter_container(nb_node
, xpath
, list_entry
,
1174 list_keys
, translator
, flags
,
1178 ret
= nb_oper_data_iter_leaf(nb_node
, xpath
, list_entry
,
1179 list_keys
, translator
, flags
, cb
,
1183 ret
= nb_oper_data_iter_leaflist(nb_node
, xpath
, list_entry
,
1184 list_keys
, translator
, flags
,
1188 ret
= nb_oper_data_iter_list(nb_node
, xpath
, list_entry
,
1189 list_keys
, translator
, flags
, cb
,
1193 ret
= nb_oper_data_iter_children(snode
, xpath
, list_entry
,
1194 list_keys
, translator
, false,
1204 int nb_oper_data_iterate(const char *xpath
, struct yang_translator
*translator
,
1205 uint32_t flags
, nb_oper_data_cb cb
, void *arg
)
1207 struct nb_node
*nb_node
;
1208 const void *list_entry
= NULL
;
1209 struct yang_list_keys list_keys
;
1210 struct list
*list_dnodes
;
1211 struct lyd_node
*dnode
, *dn
;
1212 struct listnode
*ln
;
1215 nb_node
= nb_node_find(xpath
);
1217 flog_warn(EC_LIB_YANG_UNKNOWN_DATA_PATH
,
1218 "%s: unknown data path: %s", __func__
, xpath
);
1222 /* For now this function works only with containers and lists. */
1223 if (!CHECK_FLAG(nb_node
->snode
->nodetype
, LYS_CONTAINER
| LYS_LIST
)) {
1225 EC_LIB_NB_OPERATIONAL_DATA
,
1226 "%s: can't iterate over YANG leaf or leaf-list [xpath %s]",
1232 * Create a data tree from the XPath so that we can parse the keys of
1233 * all YANG lists (if any).
1236 dnode
= lyd_new_path(NULL
, ly_native_ctx
, xpath
, NULL
, 0,
1237 LYD_PATH_OPT_UPDATE
);
1238 if (!dnode
&& ly_errno
) {
1239 flog_warn(EC_LIB_LIBYANG
, "%s: lyd_new_path() failed",
1244 * We can remove the following two lines once we depend on
1245 * libyang-v0.16-r2, which has the LYD_PATH_OPT_NOPARENTRET flag for
1248 dnode
= yang_dnode_get(dnode
, xpath
);
1252 * Create a linked list to sort the data nodes starting from the root.
1254 list_dnodes
= list_new();
1255 for (dn
= dnode
; dn
; dn
= dn
->parent
) {
1256 if (dn
->schema
->nodetype
!= LYS_LIST
|| !dn
->child
)
1258 listnode_add_head(list_dnodes
, dn
);
1261 * Use the northbound callbacks to find list entry pointer corresponding
1262 * to the given XPath.
1264 for (ALL_LIST_ELEMENTS_RO(list_dnodes
, ln
, dn
)) {
1265 struct lyd_node
*child
;
1269 /* Obtain the list entry keys. */
1270 memset(&list_keys
, 0, sizeof(list_keys
));
1271 LY_TREE_FOR (dn
->child
, child
) {
1272 if (!lys_is_key((struct lys_node_leaf
*)child
->schema
,
1275 strlcpy(list_keys
.key
[n
],
1276 yang_dnode_get_string(child
, NULL
),
1277 sizeof(list_keys
.key
[n
]));
1282 != ((struct lys_node_list
*)dn
->schema
)->keys_size
) {
1283 list_delete(&list_dnodes
);
1284 yang_dnode_free(dnode
);
1285 return NB_ERR_NOT_FOUND
;
1288 /* Find the list entry pointer. */
1289 nn
= dn
->schema
->priv
;
1290 list_entry
= nn
->cbs
.lookup_entry(list_entry
, &list_keys
);
1291 if (list_entry
== NULL
) {
1292 list_delete(&list_dnodes
);
1293 yang_dnode_free(dnode
);
1294 return NB_ERR_NOT_FOUND
;
1298 /* If a list entry was given, iterate over that list entry only. */
1299 if (dnode
->schema
->nodetype
== LYS_LIST
&& dnode
->child
)
1300 ret
= nb_oper_data_iter_children(
1301 nb_node
->snode
, xpath
, list_entry
, &list_keys
,
1302 translator
, true, flags
, cb
, arg
);
1304 ret
= nb_oper_data_iter_node(nb_node
->snode
, xpath
, list_entry
,
1305 &list_keys
, translator
, true,
1308 list_delete(&list_dnodes
);
1309 yang_dnode_free(dnode
);
1314 bool nb_operation_is_valid(enum nb_operation operation
,
1315 const struct lys_node
*snode
)
1317 struct nb_node
*nb_node
= snode
->priv
;
1318 struct lys_node_container
*scontainer
;
1319 struct lys_node_leaf
*sleaf
;
1321 switch (operation
) {
1323 if (!CHECK_FLAG(snode
->flags
, LYS_CONFIG_W
))
1326 switch (snode
->nodetype
) {
1328 sleaf
= (struct lys_node_leaf
*)snode
;
1329 if (sleaf
->type
.base
!= LY_TYPE_EMPTY
)
1333 scontainer
= (struct lys_node_container
*)snode
;
1334 if (!scontainer
->presence
)
1345 if (!CHECK_FLAG(snode
->flags
, LYS_CONFIG_W
))
1348 switch (snode
->nodetype
) {
1350 sleaf
= (struct lys_node_leaf
*)snode
;
1351 if (sleaf
->type
.base
== LY_TYPE_EMPTY
)
1354 /* List keys can't be modified. */
1355 if (lys_is_key(sleaf
, NULL
))
1363 if (!CHECK_FLAG(snode
->flags
, LYS_CONFIG_W
))
1366 switch (snode
->nodetype
) {
1368 sleaf
= (struct lys_node_leaf
*)snode
;
1370 /* List keys can't be deleted. */
1371 if (lys_is_key(sleaf
, NULL
))
1375 * Only optional leafs can be deleted, or leafs whose
1376 * parent is a case statement.
1378 if (snode
->parent
->nodetype
== LYS_CASE
)
1382 if (CHECK_FLAG(sleaf
->flags
, LYS_MAND_TRUE
)
1387 scontainer
= (struct lys_node_container
*)snode
;
1388 if (!scontainer
->presence
)
1399 if (!CHECK_FLAG(snode
->flags
, LYS_CONFIG_W
))
1402 switch (snode
->nodetype
) {
1405 if (!CHECK_FLAG(snode
->flags
, LYS_USERORDERED
))
1412 case NB_OP_APPLY_FINISH
:
1413 if (!CHECK_FLAG(snode
->flags
, LYS_CONFIG_W
))
1416 case NB_OP_GET_ELEM
:
1417 if (!CHECK_FLAG(snode
->flags
, LYS_CONFIG_R
))
1420 switch (snode
->nodetype
) {
1425 scontainer
= (struct lys_node_container
*)snode
;
1426 if (!scontainer
->presence
)
1433 case NB_OP_GET_NEXT
:
1434 switch (snode
->nodetype
) {
1436 if (CHECK_FLAG(nb_node
->flags
, F_NB_NODE_CONFIG_ONLY
))
1440 if (CHECK_FLAG(snode
->flags
, LYS_CONFIG_W
))
1447 case NB_OP_GET_KEYS
:
1448 case NB_OP_LOOKUP_ENTRY
:
1449 switch (snode
->nodetype
) {
1451 if (CHECK_FLAG(nb_node
->flags
, F_NB_NODE_CONFIG_ONLY
))
1453 if (CHECK_FLAG(nb_node
->flags
, F_NB_NODE_KEYLESS_LIST
))
1461 if (CHECK_FLAG(snode
->flags
, LYS_CONFIG_W
| LYS_CONFIG_R
))
1464 switch (snode
->nodetype
) {
1477 DEFINE_HOOK(nb_notification_send
, (const char *xpath
, struct list
*arguments
),
1478 (xpath
, arguments
));
1480 int nb_notification_send(const char *xpath
, struct list
*arguments
)
1484 ret
= hook_call(nb_notification_send
, xpath
, arguments
);
1486 list_delete(&arguments
);
1491 const char *nb_event_name(enum nb_event event
)
1494 case NB_EV_VALIDATE
:
1507 const char *nb_operation_name(enum nb_operation operation
)
1509 switch (operation
) {
1518 case NB_OP_APPLY_FINISH
:
1519 return "apply_finish";
1520 case NB_OP_GET_ELEM
:
1522 case NB_OP_GET_NEXT
:
1524 case NB_OP_GET_KEYS
:
1526 case NB_OP_LOOKUP_ENTRY
:
1527 return "lookup_entry";
1535 const char *nb_err_name(enum nb_error error
)
1541 return "generic error";
1542 case NB_ERR_NO_CHANGES
:
1543 return "no changes";
1544 case NB_ERR_NOT_FOUND
:
1545 return "element not found";
1547 return "resource is locked";
1548 case NB_ERR_VALIDATION
:
1549 return "validation error";
1550 case NB_ERR_RESOURCE
:
1551 return "failed to allocate resource";
1552 case NB_ERR_INCONSISTENCY
:
1553 return "internal inconsistency";
1559 const char *nb_client_name(enum nb_client client
)
1564 case NB_CLIENT_CONFD
:
1566 case NB_CLIENT_SYSREPO
:
1573 static void nb_load_callbacks(const struct frr_yang_module_info
*module
)
1575 for (size_t i
= 0; module
->nodes
[i
].xpath
; i
++) {
1576 struct nb_node
*nb_node
;
1579 nb_node
= nb_node_find(module
->nodes
[i
].xpath
);
1581 flog_warn(EC_LIB_YANG_UNKNOWN_DATA_PATH
,
1582 "%s: unknown data path: %s", __func__
,
1583 module
->nodes
[i
].xpath
);
1587 nb_node
->cbs
= module
->nodes
[i
].cbs
;
1588 priority
= module
->nodes
[i
].priority
;
1590 nb_node
->priority
= priority
;
1594 void nb_init(struct thread_master
*tm
,
1595 const struct frr_yang_module_info
*modules
[], size_t nmodules
)
1597 unsigned int errors
= 0;
1599 /* Load YANG modules. */
1600 for (size_t i
= 0; i
< nmodules
; i
++)
1601 yang_module_load(modules
[i
]->name
);
1603 /* Create a nb_node for all YANG schema nodes. */
1606 /* Load northbound callbacks. */
1607 for (size_t i
= 0; i
< nmodules
; i
++)
1608 nb_load_callbacks(modules
[i
]);
1610 /* Validate northbound callbacks. */
1611 yang_snodes_iterate_all(nb_node_validate
, 0, &errors
);
1614 EC_LIB_NB_CBS_VALIDATION
,
1615 "%s: failed to validate northbound callbacks: %u error(s)",
1620 /* Initialize the northbound database (used for the rollback log). */
1621 if (nb_db_init() != NB_OK
)
1622 flog_warn(EC_LIB_NB_DATABASE
,
1623 "%s: failed to initialize northbound database",
1626 /* Create an empty running configuration. */
1627 running_config
= nb_config_new(NULL
);
1629 /* Initialize the northbound CLI. */
1633 void nb_terminate(void)
1635 /* Terminate the northbound CLI. */
1638 /* Delete all nb_node's from all YANG modules. */
1641 /* Delete the running configuration. */
1642 nb_config_free(running_config
);