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
20 #ifndef _FRR_NORTHBOUND_H_
21 #define _FRR_NORTHBOUND_H_
26 #include "openbsd-tree.h"
28 #include "yang_translator.h"
34 /* Forward declaration(s). */
38 /* Northbound events. */
41 * The configuration callback is supposed to verify that the changes are
42 * valid and can be applied.
47 * The configuration callback is supposed to prepare all resources
48 * required to apply the changes.
53 * Transaction has failed, the configuration callback needs to release
54 * all resources previously allocated.
59 * The configuration changes need to be applied. The changes can't be
60 * rejected at this point (errors are logged and ignored).
66 * Northbound operations.
68 * Refer to the documentation comments of nb_callbacks for more details.
90 * Northbound callbacks parameters.
93 struct nb_cb_create_args
{
94 /* Context of the configuration transaction. */
95 struct nb_context
*context
;
98 * The transaction phase. Refer to the documentation comments of
99 * nb_event for more details.
103 /* libyang data node that is being created. */
104 const struct lyd_node
*dnode
;
107 * Pointer to store resource(s) allocated during the NB_EV_PREPARE
108 * phase. The same pointer can be used during the NB_EV_ABORT and
109 * NB_EV_APPLY phases to either release or make use of the allocated
110 * resource(s). It's set to NULL when the event is NB_EV_VALIDATE.
112 union nb_resource
*resource
;
114 /* Buffer to store human-readable error message in case of error. */
117 /* Size of errmsg. */
121 struct nb_cb_modify_args
{
122 /* Context of the configuration transaction. */
123 struct nb_context
*context
;
126 * The transaction phase. Refer to the documentation comments of
127 * nb_event for more details.
131 /* libyang data node that is being modified. */
132 const struct lyd_node
*dnode
;
135 * Pointer to store resource(s) allocated during the NB_EV_PREPARE
136 * phase. The same pointer can be used during the NB_EV_ABORT and
137 * NB_EV_APPLY phases to either release or make use of the allocated
138 * resource(s). It's set to NULL when the event is NB_EV_VALIDATE.
140 union nb_resource
*resource
;
142 /* Buffer to store human-readable error message in case of error. */
145 /* Size of errmsg. */
149 struct nb_cb_destroy_args
{
150 /* Context of the configuration transaction. */
151 struct nb_context
*context
;
154 * The transaction phase. Refer to the documentation comments of
155 * nb_event for more details.
159 /* libyang data node that is being deleted. */
160 const struct lyd_node
*dnode
;
162 /* Buffer to store human-readable error message in case of error. */
165 /* Size of errmsg. */
169 struct nb_cb_move_args
{
170 /* Context of the configuration transaction. */
171 struct nb_context
*context
;
174 * The transaction phase. Refer to the documentation comments of
175 * nb_event for more details.
179 /* libyang data node that is being moved. */
180 const struct lyd_node
*dnode
;
182 /* Buffer to store human-readable error message in case of error. */
185 /* Size of errmsg. */
189 struct nb_cb_pre_validate_args
{
190 /* Context of the configuration transaction. */
191 struct nb_context
*context
;
193 /* libyang data node associated with the 'pre_validate' callback. */
194 const struct lyd_node
*dnode
;
196 /* Buffer to store human-readable error message in case of error. */
199 /* Size of errmsg. */
203 struct nb_cb_apply_finish_args
{
204 /* Context of the configuration transaction. */
205 struct nb_context
*context
;
207 /* libyang data node associated with the 'apply_finish' callback. */
208 const struct lyd_node
*dnode
;
210 /* Buffer to store human-readable error message in case of error. */
213 /* Size of errmsg. */
217 struct nb_cb_get_elem_args
{
218 /* YANG data path of the data we want to get. */
221 /* Pointer to list entry (might be NULL). */
222 const void *list_entry
;
225 struct nb_cb_get_next_args
{
226 /* Pointer to parent list entry. */
227 const void *parent_list_entry
;
229 /* Pointer to (leaf-)list entry. */
230 const void *list_entry
;
233 struct nb_cb_get_keys_args
{
234 /* Pointer to list entry. */
235 const void *list_entry
;
238 * Structure to be filled based on the attributes of the provided list
241 struct yang_list_keys
*keys
;
244 struct nb_cb_lookup_entry_args
{
245 /* Pointer to parent list entry. */
246 const void *parent_list_entry
;
248 /* Structure containing the keys of the list entry. */
249 const struct yang_list_keys
*keys
;
252 struct nb_cb_rpc_args
{
253 /* XPath of the YANG RPC or action. */
256 /* Read-only list of input parameters. */
257 const struct list
*input
;
259 /* List of output parameters to be populated by the callback. */
262 /* Buffer to store human-readable error message in case of error. */
265 /* Size of errmsg. */
270 * Set of configuration callbacks that can be associated to a northbound node.
272 struct nb_callbacks
{
274 * Configuration callback.
276 * A presence container, list entry, leaf-list entry or leaf of type
277 * empty has been created.
279 * For presence-containers and list entries, the callback is supposed to
280 * initialize the default values of its children (if any) from the YANG
284 * Refer to the documentation comments of nb_cb_create_args for
288 * - NB_OK on success.
289 * - NB_ERR_VALIDATION when a validation error occurred.
290 * - NB_ERR_RESOURCE when the callback failed to allocate a resource.
291 * - NB_ERR_INCONSISTENCY when an inconsistency was detected.
292 * - NB_ERR for other errors.
294 int (*create
)(struct nb_cb_create_args
*args
);
297 * Configuration callback.
299 * The value of a leaf has been modified.
301 * List keys don't need to implement this callback. When a list key is
302 * modified, the northbound treats this as if the list was deleted and a
303 * new one created with the updated key value.
306 * Refer to the documentation comments of nb_cb_modify_args for
310 * - NB_OK on success.
311 * - NB_ERR_VALIDATION when a validation error occurred.
312 * - NB_ERR_RESOURCE when the callback failed to allocate a resource.
313 * - NB_ERR_INCONSISTENCY when an inconsistency was detected.
314 * - NB_ERR for other errors.
316 int (*modify
)(struct nb_cb_modify_args
*args
);
319 * Configuration callback.
321 * A presence container, list entry, leaf-list entry or optional leaf
324 * The callback is supposed to delete the entire configuration object,
325 * including its children when they exist.
328 * Refer to the documentation comments of nb_cb_destroy_args for
332 * - NB_OK on success.
333 * - NB_ERR_VALIDATION when a validation error occurred.
334 * - NB_ERR_INCONSISTENCY when an inconsistency was detected.
335 * - NB_ERR for other errors.
337 int (*destroy
)(struct nb_cb_destroy_args
*args
);
340 * Configuration callback.
342 * A list entry or leaf-list entry has been moved. Only applicable when
343 * the "ordered-by user" statement is present.
346 * Refer to the documentation comments of nb_cb_move_args for
350 * - NB_OK on success.
351 * - NB_ERR_VALIDATION when a validation error occurred.
352 * - NB_ERR_INCONSISTENCY when an inconsistency was detected.
353 * - NB_ERR for other errors.
355 int (*move
)(struct nb_cb_move_args
*args
);
358 * Optional configuration callback.
360 * This callback can be used to validate subsections of the
361 * configuration being committed before validating the configuration
362 * changes themselves. It's useful to perform more complex validations
363 * that depend on the relationship between multiple nodes.
366 * Refer to the documentation comments of nb_cb_pre_validate_args for
370 * - NB_OK on success.
371 * - NB_ERR_VALIDATION when a validation error occurred.
373 int (*pre_validate
)(struct nb_cb_pre_validate_args
*args
);
376 * Optional configuration callback.
378 * The 'apply_finish' callbacks are called after all other callbacks
379 * during the apply phase (NB_EV_APPLY). These callbacks are called only
380 * under one of the following two cases:
381 * - The data node has been created or modified (but not deleted);
382 * - Any change was made within the descendants of the data node (e.g. a
383 * child leaf was modified, created or deleted).
385 * In the second case above, the 'apply_finish' callback is called only
386 * once even if multiple changes occurred within the descendants of the
390 * Refer to the documentation comments of nb_cb_apply_finish_args for
393 void (*apply_finish
)(struct nb_cb_apply_finish_args
*args
);
396 * Operational data callback.
398 * The callback function should return the value of a specific leaf,
399 * leaf-list entry or inform if a typeless value (presence containers or
400 * leafs of type empty) exists or not.
403 * Refer to the documentation comments of nb_cb_get_elem_args for
407 * Pointer to newly created yang_data structure, or NULL to indicate
408 * the absence of data.
410 struct yang_data
*(*get_elem
)(struct nb_cb_get_elem_args
*args
);
413 * Operational data callback for YANG lists and leaf-lists.
415 * The callback function should return the next entry in the list or
416 * leaf-list. The 'list_entry' parameter will be NULL on the first
420 * Refer to the documentation comments of nb_cb_get_next_args for
424 * Pointer to the next entry in the (leaf-)list, or NULL to signal
425 * that the end of the (leaf-)list was reached.
427 const void *(*get_next
)(struct nb_cb_get_next_args
*args
);
430 * Operational data callback for YANG lists.
432 * The callback function should fill the 'keys' parameter based on the
433 * given list_entry. Keyless lists don't need to implement this
437 * Refer to the documentation comments of nb_cb_get_keys_args for
441 * NB_OK on success, NB_ERR otherwise.
443 int (*get_keys
)(struct nb_cb_get_keys_args
*args
);
446 * Operational data callback for YANG lists.
448 * The callback function should return a list entry based on the list
449 * keys given as a parameter. Keyless lists don't need to implement this
453 * Refer to the documentation comments of nb_cb_lookup_entry_args for
457 * Pointer to the list entry if found, or NULL if not found.
459 const void *(*lookup_entry
)(struct nb_cb_lookup_entry_args
*args
);
462 * RPC and action callback.
464 * Both 'input' and 'output' are lists of 'yang_data' structures. The
465 * callback should fetch all the input parameters from the 'input' list,
466 * and add output parameters to the 'output' list if necessary.
469 * Refer to the documentation comments of nb_cb_rpc_args for details.
472 * NB_OK on success, NB_ERR otherwise.
474 int (*rpc
)(struct nb_cb_rpc_args
*args
);
477 * Optional callback to compare the data nodes when printing
478 * the CLI commands associated with them.
481 * The first data node to compare.
484 * The second data node to compare.
487 * <0 when the CLI command for the dnode1 should be printed first
488 * >0 when the CLI command for the dnode2 should be printed first
489 * 0 when there is no difference
491 int (*cli_cmp
)(struct lyd_node
*dnode1
, struct lyd_node
*dnode2
);
494 * Optional callback to show the CLI command associated to the given
498 * The vty terminal to dump the configuration to.
501 * libyang data node that should be shown in the form of a CLI
505 * Specify whether to display default configuration values or not.
506 * This parameter can be ignored most of the time since the
507 * northbound doesn't call this callback for default leaves or
508 * non-presence containers that contain only default child nodes.
509 * The exception are commands associated to multiple configuration
510 * nodes, in which case it might be desirable to hide one or more
511 * parts of the command when this parameter is set to false.
513 void (*cli_show
)(struct vty
*vty
, struct lyd_node
*dnode
,
517 * Optional callback to show the CLI node end for lists or containers.
520 * The vty terminal to dump the configuration to.
523 * libyang data node that should be shown in the form of a CLI
526 void (*cli_show_end
)(struct vty
*vty
, struct lyd_node
*dnode
);
529 struct nb_dependency_callbacks
{
530 void (*get_dependant_xpath
)(const struct lyd_node
*dnode
, char *xpath
);
531 void (*get_dependency_xpath
)(const struct lyd_node
*dnode
, char *xpath
);
535 * Northbound-specific data that is allocated for each schema node of the native
539 /* Back pointer to the libyang schema node. */
540 const struct lys_node
*snode
;
542 /* Data path of this YANG node. */
543 char xpath
[XPATH_MAXLEN
];
545 /* Priority - lower priorities are processed first. */
548 struct nb_dependency_callbacks dep_cbs
;
550 /* Callbacks implemented for this node. */
551 struct nb_callbacks cbs
;
554 * Pointer to the parent node (disconsidering non-presence containers).
556 struct nb_node
*parent
;
558 /* Pointer to the nearest parent list, if any. */
559 struct nb_node
*parent_list
;
565 /* ConfD hash value corresponding to this YANG path. */
569 /* The YANG container or list contains only config data. */
570 #define F_NB_NODE_CONFIG_ONLY 0x01
571 /* The YANG list doesn't contain key leafs. */
572 #define F_NB_NODE_KEYLESS_LIST 0x02
575 * HACK: old gcc versions (< 5.x) have a bug that prevents C99 flexible arrays
576 * from working properly on shared libraries. For those compilers, use a fixed
577 * size array to work around the problem.
579 #define YANG_MODULE_MAX_NODES 2000
581 struct frr_yang_module_info
{
582 /* YANG module name. */
585 /* Northbound callbacks. */
587 /* Data path of this YANG node. */
590 /* Callbacks implemented for this node. */
591 struct nb_callbacks cbs
;
593 /* Priority - lower priorities are processed first. */
595 #if defined(__GNUC__) && ((__GNUC__ - 0) < 5) && !defined(__clang__)
596 } nodes
[YANG_MODULE_MAX_NODES
+ 1];
602 /* Northbound error codes. */
611 NB_ERR_INCONSISTENCY
,
614 /* Default priority. */
615 #define NB_DFLT_PRIORITY (UINT32_MAX / 2)
617 /* Default maximum of configuration rollbacks to store. */
618 #define NB_DLFT_MAX_CONFIG_ROLLBACKS 20
620 /* Northbound clients. */
630 /* Northbound context. */
632 /* Northbound client. */
633 enum nb_client client
;
635 /* Northbound user (can be NULL). */
638 /* Client-specific data. */
655 /* Northbound configuration. */
657 struct lyd_node
*dnode
;
661 /* Northbound configuration callback. */
662 struct nb_config_cb
{
663 RB_ENTRY(nb_config_cb
) entry
;
664 enum nb_operation operation
;
666 const struct nb_node
*nb_node
;
667 const struct lyd_node
*dnode
;
669 RB_HEAD(nb_config_cbs
, nb_config_cb
);
670 RB_PROTOTYPE(nb_config_cbs
, nb_config_cb
, entry
, nb_config_cb_compare
);
672 /* Northbound configuration change. */
673 struct nb_config_change
{
674 struct nb_config_cb cb
;
675 union nb_resource resource
;
679 /* Northbound configuration transaction. */
680 struct nb_transaction
{
681 struct nb_context
*context
;
683 struct nb_config
*config
;
684 struct nb_config_cbs changes
;
687 /* Callback function used by nb_oper_data_iterate(). */
688 typedef int (*nb_oper_data_cb
)(const struct lys_node
*snode
,
689 struct yang_translator
*translator
,
690 struct yang_data
*data
, void *arg
);
692 /* Iterate over direct child nodes only. */
693 #define NB_OPER_DATA_ITER_NORECURSE 0x0001
696 DECLARE_HOOK(nb_notification_send
, (const char *xpath
, struct list
*arguments
),
698 DECLARE_HOOK(nb_client_debug_config_write
, (struct vty
*vty
), (vty
));
699 DECLARE_HOOK(nb_client_debug_set_all
, (uint32_t flags
, bool set
), (flags
, set
));
701 /* Northbound debugging records */
702 extern struct debug nb_dbg_cbs_config
;
703 extern struct debug nb_dbg_cbs_state
;
704 extern struct debug nb_dbg_cbs_rpc
;
705 extern struct debug nb_dbg_notif
;
706 extern struct debug nb_dbg_events
;
708 /* Global running configuration. */
709 extern struct nb_config
*running_config
;
711 /* Wrappers for the northbound callbacks. */
712 extern struct yang_data
*nb_callback_get_elem(const struct nb_node
*nb_node
,
714 const void *list_entry
);
715 extern const void *nb_callback_get_next(const struct nb_node
*nb_node
,
716 const void *parent_list_entry
,
717 const void *list_entry
);
718 extern int nb_callback_get_keys(const struct nb_node
*nb_node
,
719 const void *list_entry
,
720 struct yang_list_keys
*keys
);
721 extern const void *nb_callback_lookup_entry(const struct nb_node
*nb_node
,
722 const void *parent_list_entry
,
723 const struct yang_list_keys
*keys
);
724 extern int nb_callback_rpc(const struct nb_node
*nb_node
, const char *xpath
,
725 const struct list
*input
, struct list
*output
,
726 char *errmsg
, size_t errmsg_len
);
729 * Create a northbound node for all YANG schema nodes.
731 void nb_nodes_create(void);
734 * Delete all northbound nodes from all YANG schema nodes.
736 void nb_nodes_delete(void);
739 * Find the northbound node corresponding to a YANG data path.
742 * XPath to search for (with or without predicates).
745 * Pointer to northbound node if found, NULL otherwise.
747 extern struct nb_node
*nb_node_find(const char *xpath
);
749 extern void nb_node_set_dependency_cbs(const char *dependency_xpath
,
750 const char *dependant_xpath
,
751 struct nb_dependency_callbacks
*cbs
);
753 bool nb_node_has_dependency(struct nb_node
*node
);
756 * Create a new northbound configuration.
759 * Pointer to a libyang data node containing the configuration data. If NULL
760 * is given, an empty configuration will be created.
763 * Pointer to newly created northbound configuration.
765 extern struct nb_config
*nb_config_new(struct lyd_node
*dnode
);
768 * Delete a northbound configuration.
771 * Pointer to the config that is going to be deleted.
773 extern void nb_config_free(struct nb_config
*config
);
776 * Duplicate a northbound configuration.
779 * Northbound configuration to duplicate.
782 * Pointer to duplicated configuration.
784 extern struct nb_config
*nb_config_dup(const struct nb_config
*config
);
787 * Merge one configuration into another.
790 * Configuration to merge to.
793 * Configuration to merge config_dst with.
796 * Specify whether config_src should be deleted or not after the merge
800 * NB_OK on success, NB_ERR otherwise.
802 extern int nb_config_merge(struct nb_config
*config_dst
,
803 struct nb_config
*config_src
, bool preserve_source
);
806 * Replace one configuration by another.
809 * Configuration to be replaced.
812 * Configuration to replace config_dst.
815 * Specify whether config_src should be deleted or not after the replace
818 extern void nb_config_replace(struct nb_config
*config_dst
,
819 struct nb_config
*config_src
,
820 bool preserve_source
);
823 * Edit a candidate configuration.
826 * Candidate configuration to edit.
829 * Northbound node associated to the configuration being edited.
832 * Operation to apply.
835 * XPath of the configuration node being edited.
838 * Previous value of the configuration node. Should be used only when the
839 * operation is NB_OP_MOVE, otherwise this parameter is ignored.
842 * New value of the configuration node.
845 * - NB_OK on success.
846 * - NB_ERR_NOT_FOUND when the element to be deleted was not found.
847 * - NB_ERR for other errors.
849 extern int nb_candidate_edit(struct nb_config
*candidate
,
850 const struct nb_node
*nb_node
,
851 enum nb_operation operation
, const char *xpath
,
852 const struct yang_data
*previous
,
853 const struct yang_data
*data
);
856 * Check if a candidate configuration is outdated and needs to be updated.
859 * Candidate configuration to check.
862 * true if the candidate is outdated, false otherwise.
864 extern bool nb_candidate_needs_update(const struct nb_config
*candidate
);
867 * Update a candidate configuration by rebasing the changes on top of the latest
868 * running configuration. Resolve conflicts automatically by giving preference
869 * to the changes done in the candidate configuration.
872 * Candidate configuration to update.
875 * NB_OK on success, NB_ERR otherwise.
877 extern int nb_candidate_update(struct nb_config
*candidate
);
880 * Validate a candidate configuration. Perform both YANG syntactic/semantic
881 * validation and code-level validation using the northbound callbacks.
883 * WARNING: the candidate can be modified as part of the validation process
884 * (e.g. add default nodes).
887 * Context of the northbound transaction.
890 * Candidate configuration to validate.
893 * Buffer to store human-readable error message in case of error.
899 * NB_OK on success, NB_ERR_VALIDATION otherwise.
901 extern int nb_candidate_validate(struct nb_context
*context
,
902 struct nb_config
*candidate
, char *errmsg
,
906 * Create a new configuration transaction but do not commit it yet. Only
907 * validate the candidate and prepare all resources required to apply the
908 * configuration changes.
911 * Context of the northbound transaction.
914 * Candidate configuration to commit.
917 * Optional comment describing the commit.
920 * Output parameter providing the created transaction when one is created
921 * successfully. In this case, it must be either aborted using
922 * nb_candidate_commit_abort() or committed using
923 * nb_candidate_commit_apply().
926 * Buffer to store human-readable error message in case of error.
932 * - NB_OK on success.
933 * - NB_ERR_NO_CHANGES when the candidate is identical to the running
935 * - NB_ERR_LOCKED when there's already another transaction in progress.
936 * - NB_ERR_VALIDATION when the candidate fails the validation checks.
937 * - NB_ERR_RESOURCE when the system fails to allocate resources to apply
938 * the candidate configuration.
939 * - NB_ERR for other errors.
941 extern int nb_candidate_commit_prepare(struct nb_context
*context
,
942 struct nb_config
*candidate
,
944 struct nb_transaction
**transaction
,
945 char *errmsg
, size_t errmsg_len
);
948 * Abort a previously created configuration transaction, releasing all resources
949 * allocated during the preparation phase.
952 * Candidate configuration to abort. It's consumed by this function.
955 * Buffer to store human-readable error message in case of error.
960 extern void nb_candidate_commit_abort(struct nb_transaction
*transaction
,
961 char *errmsg
, size_t errmsg_len
);
964 * Commit a previously created configuration transaction.
967 * Configuration transaction to commit. It's consumed by this function.
970 * Specify whether the transaction should be recorded in the transactions log
974 * Optional output parameter providing the ID of the committed transaction.
977 * Buffer to store human-readable error message in case of error.
982 extern void nb_candidate_commit_apply(struct nb_transaction
*transaction
,
983 bool save_transaction
,
984 uint32_t *transaction_id
, char *errmsg
,
988 * Create a new transaction to commit a candidate configuration. This is a
989 * convenience function that performs the two-phase commit protocol
990 * transparently to the user. The cost is reduced flexibility, since
991 * network-wide and multi-daemon transactions require the network manager to
992 * take into account the results of the preparation phase of multiple managed
996 * Context of the northbound transaction.
999 * Candidate configuration to commit. It's preserved regardless if the commit
1000 * operation fails or not.
1003 * Specify whether the transaction should be recorded in the transactions log
1007 * Optional comment describing the commit.
1010 * Optional output parameter providing the ID of the committed transaction.
1013 * Buffer to store human-readable error message in case of error.
1019 * - NB_OK on success.
1020 * - NB_ERR_NO_CHANGES when the candidate is identical to the running
1022 * - NB_ERR_LOCKED when there's already another transaction in progress.
1023 * - NB_ERR_VALIDATION when the candidate fails the validation checks.
1024 * - NB_ERR_RESOURCE when the system fails to allocate resources to apply
1025 * the candidate configuration.
1026 * - NB_ERR for other errors.
1028 extern int nb_candidate_commit(struct nb_context
*context
,
1029 struct nb_config
*candidate
,
1030 bool save_transaction
, const char *comment
,
1031 uint32_t *transaction_id
, char *errmsg
,
1035 * Lock the running configuration.
1038 * Northbound client.
1041 * Northbound user (can be NULL).
1044 * 0 on success, -1 when the running configuration is already locked.
1046 extern int nb_running_lock(enum nb_client client
, const void *user
);
1049 * Unlock the running configuration.
1052 * Northbound client.
1055 * Northbound user (can be NULL).
1058 * 0 on success, -1 when the running configuration is already unlocked or
1059 * locked by another client/user.
1061 extern int nb_running_unlock(enum nb_client client
, const void *user
);
1064 * Check if the running configuration is locked or not for the given
1068 * Northbound client.
1071 * Northbound user (can be NULL).
1074 * 0 if the running configuration is unlocked or if the client/user owns the
1075 * lock, -1 otherwise.
1077 extern int nb_running_lock_check(enum nb_client client
, const void *user
);
1080 * Iterate over operational data.
1083 * Data path of the YANG data we want to iterate over.
1086 * YANG module translator (might be NULL).
1089 * NB_OPER_DATA_ITER_ flags to control how the iteration is performed.
1092 * Function to call with each data node.
1095 * Arbitrary argument passed as the fourth parameter in each call to 'cb'.
1098 * NB_OK on success, NB_ERR otherwise.
1100 extern int nb_oper_data_iterate(const char *xpath
,
1101 struct yang_translator
*translator
,
1102 uint32_t flags
, nb_oper_data_cb cb
, void *arg
);
1105 * Validate if the northbound operation is valid for the given node.
1108 * Operation we want to check.
1111 * libyang schema node we want to check.
1114 * true if the operation is valid, false otherwise.
1116 extern bool nb_operation_is_valid(enum nb_operation operation
,
1117 const struct lys_node
*snode
);
1120 * Send a YANG notification. This is a no-op unless the 'nb_notification_send'
1121 * hook was registered by a northbound plugin.
1124 * XPath of the YANG notification.
1127 * Linked list containing the arguments that should be sent. This list is
1128 * deleted after being used.
1131 * NB_OK on success, NB_ERR otherwise.
1133 extern int nb_notification_send(const char *xpath
, struct list
*arguments
);
1136 * Associate a user pointer to a configuration node.
1138 * This should be called by northbound 'create' callbacks in the NB_EV_APPLY
1142 * libyang data node - only its XPath is used.
1145 * Arbitrary user-specified pointer.
1147 extern void nb_running_set_entry(const struct lyd_node
*dnode
, void *entry
);
1150 * Move an entire tree of user pointer nodes.
1152 * Suppose we have xpath A/B/C/D, with user pointers associated to C and D. We
1153 * need to move B to be under Z, so the new xpath is Z/B/C/D. Because user
1154 * pointers are indexed with their absolute path, We need to move all user
1155 * pointers at and below B to their new absolute paths; this function does
1159 * base xpath of tree to move (A/B)
1162 * base xpath of new location of tree (Z/B)
1164 extern void nb_running_move_tree(const char *xpath_from
, const char *xpath_to
);
1167 * Unset the user pointer associated to a configuration node.
1169 * This should be called by northbound 'destroy' callbacks in the NB_EV_APPLY
1173 * libyang data node - only its XPath is used.
1176 * The user pointer that was unset.
1178 extern void *nb_running_unset_entry(const struct lyd_node
*dnode
);
1181 * Find the user pointer (if any) associated to a configuration node.
1183 * The XPath associated to the configuration node can be provided directly or
1184 * indirectly through a libyang data node.
1186 * If an user point is not found, this function follows the parent nodes in the
1187 * running configuration until an user pointer is found or until the root node
1191 * libyang data node - only its XPath is used (can be NULL if 'xpath' is
1195 * XPath of the configuration node (can be NULL if 'dnode' is provided).
1197 * abort_if_not_found
1198 * When set to true, abort the program if no user pointer is found.
1200 * As a rule of thumb, this parameter should be set to true in the following
1202 * - Calling this function from any northbound configuration callback during
1203 * the NB_EV_APPLY phase.
1204 * - Calling this function from a 'delete' northbound configuration callback
1207 * In both the above cases, the given configuration node should contain an
1208 * user pointer except when there's a bug in the code, in which case it's
1209 * better to abort the program right away and eliminate the need for
1210 * unnecessary NULL checks.
1212 * In all other cases, this parameter should be set to false and the caller
1213 * should check if the function returned NULL or not.
1216 * User pointer if found, NULL otherwise.
1218 extern void *nb_running_get_entry(const struct lyd_node
*dnode
,
1219 const char *xpath
, bool abort_if_not_found
);
1222 * Same as 'nb_running_get_entry', but doesn't search within parent nodes
1223 * recursively if an user point is not found.
1225 extern void *nb_running_get_entry_non_rec(const struct lyd_node
*dnode
,
1227 bool abort_if_not_found
);
1230 * Return a human-readable string representing a northbound event.
1236 * String representation of the given northbound event.
1238 extern const char *nb_event_name(enum nb_event event
);
1241 * Return a human-readable string representing a northbound operation.
1244 * Northbound operation.
1247 * String representation of the given northbound operation.
1249 extern const char *nb_operation_name(enum nb_operation operation
);
1252 * Return a human-readable string representing a northbound error.
1258 * String representation of the given northbound error.
1260 extern const char *nb_err_name(enum nb_error error
);
1263 * Return a human-readable string representing a northbound client.
1266 * Northbound client.
1269 * String representation of the given northbound client.
1271 extern const char *nb_client_name(enum nb_client client
);
1274 * Validate all northbound callbacks.
1276 * Some errors, like missing callbacks or invalid priorities, are fatal and
1277 * can't be recovered from. Other errors, like unneeded callbacks, are logged
1278 * but otherwise ignored.
1280 * Whenever a YANG module is loaded after startup, *all* northbound callbacks
1281 * need to be validated and not only the callbacks from the newly loaded module.
1282 * This is because augmentations can change the properties of the augmented
1283 * module, making mandatory the implementation of additional callbacks.
1285 void nb_validate_callbacks(void);
1288 * Load a YANG module with its corresponding northbound callbacks.
1291 * Pointer to structure containing the module name and its northbound
1294 void nb_load_module(const struct frr_yang_module_info
*module_info
);
1297 * Initialize the northbound layer. Should be called only once during the
1298 * daemon initialization process.
1301 * Array of YANG modules to parse and initialize.
1304 * Size of the modules array.
1307 * Set this to record the transactions in the transaction log.
1309 extern void nb_init(struct thread_master
*tm
,
1310 const struct frr_yang_module_info
*const modules
[],
1311 size_t nmodules
, bool db_enabled
);
1314 * Finish the northbound layer gracefully. Should be called only when the daemon
1317 extern void nb_terminate(void);
1323 #endif /* _FRR_NORTHBOUND_H_ */