2 * Copyright (C) 2018 NetDEF, Inc.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; either version 2 of the License, or (at your option)
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; see the file COPYING; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 #include <libyang/libyang.h>
30 #include "yang_wrappers.h"
32 DECLARE_MTYPE(YANG_MODULE
)
33 DECLARE_MTYPE(YANG_DATA
)
35 /* Maximum XPath length. */
36 #define XPATH_MAXLEN 256
38 /* Maximum list key length. */
39 #define LIST_MAXKEYS 8
41 /* Maximum list key length. */
42 #define LIST_MAXKEYLEN 128
44 /* Maximum string length of an YANG value. */
45 #define YANG_VALUE_MAXLEN 1024
47 struct yang_module_embed
{
48 struct yang_module_embed
*next
;
49 const char *mod_name
, *mod_rev
;
55 RB_ENTRY(yang_module
) entry
;
57 const struct lys_module
*info
;
62 sr_subscription_ctx_t
*sr_subscription
;
65 RB_HEAD(yang_modules
, yang_module
);
66 RB_PROTOTYPE(yang_modules
, yang_module
, entry
, yang_module_compare
);
69 /* XPath identifier of the data element. */
70 char xpath
[XPATH_MAXLEN
];
72 /* Value encoded as a raw string. */
76 struct yang_list_keys
{
77 /* Number os keys (max: LIST_MAXKEYS). */
80 /* Value encoded as a raw string. */
81 char key
[LIST_MAXKEYS
][LIST_MAXKEYLEN
];
89 enum yang_iter_flags
{
90 /* Filter non-presence containers. */
91 YANG_ITER_FILTER_NPCONTAINERS
= (1<<0),
93 /* Filter list keys (leafs). */
94 YANG_ITER_FILTER_LIST_KEYS
= (1<<1),
96 /* Filter RPC input/output nodes. */
97 YANG_ITER_FILTER_INPUT_OUTPUT
= (1<<2),
99 /* Filter implicitely created nodes. */
100 YANG_ITER_FILTER_IMPLICIT
= (1<<3),
103 /* Callback used by the yang_snodes_iterate_*() family of functions. */
104 typedef int (*yang_iterate_cb
)(const struct lys_node
*snode
, void *arg
);
106 /* Return values of the 'yang_iterate_cb' callback. */
107 #define YANG_ITER_CONTINUE 0
108 #define YANG_ITER_STOP -1
110 /* Global libyang context for native FRR models. */
111 extern struct ly_ctx
*ly_native_ctx
;
113 /* Tree of all loaded YANG modules. */
114 extern struct yang_modules yang_modules
;
117 * Create a new YANG module and load it using libyang. If the YANG module is not
118 * found in the YANG_MODELS_PATH directory, the program will exit with an error.
119 * Once loaded, a YANG module can't be unloaded anymore.
122 * Name of the YANG module.
125 * Pointer to newly created YANG module.
127 extern struct yang_module
*yang_module_load(const char *module_name
);
130 * Load all FRR native YANG models.
132 extern void yang_module_load_all(void);
135 * Find a YANG module by its name.
138 * Name of the YANG module.
141 * Pointer to YANG module if found, NULL otherwise.
143 extern struct yang_module
*yang_module_find(const char *module_name
);
146 * Register a YANG module embedded in the binary file. Should be called
147 * from a constructor function.
150 * YANG module embedding structure to register. (static global provided
153 extern void yang_module_embed(struct yang_module_embed
*embed
);
156 * Iterate recursively over all children of a schema node.
159 * YANG schema node to operate on.
162 * Function to call with each schema node.
165 * YANG_ITER_* flags to control how the iteration is performed.
168 * Arbitrary argument passed as the second parameter in each call to 'cb'.
171 * The return value of the last called callback.
173 extern int yang_snodes_iterate_subtree(const struct lys_node
*snode
,
174 yang_iterate_cb cb
, uint16_t flags
,
178 * Iterate over all libyang schema nodes from the given YANG module.
181 * YANG module to operate on.
184 * Function to call with each schema node.
187 * YANG_ITER_* flags to control how the iteration is performed.
190 * Arbitrary argument passed as the second parameter in each call to 'cb'.
193 * The return value of the last called callback.
195 extern int yang_snodes_iterate_module(const struct lys_module
*module
,
196 yang_iterate_cb cb
, uint16_t flags
,
200 * Iterate over all libyang schema nodes from all loaded YANG modules.
203 * Function to call with each schema node.
206 * YANG_ITER_* flags to control how the iteration is performed.
209 * Arbitrary argument passed as the second parameter in each call to 'cb'.
212 * The return value of the last called callback.
214 extern int yang_snodes_iterate_all(yang_iterate_cb cb
, uint16_t flags
,
218 * Build schema path or data path of the schema node.
221 * libyang schema node to be processed.
224 * Specify whether a schema path or a data path should be built.
227 * Pointer to previously allocated buffer.
230 * Size of the xpath buffer.
232 extern void yang_snode_get_path(const struct lys_node
*snode
,
233 enum yang_path_type type
, char *xpath
,
237 * Find first parent schema node which is a presence-container or a list
238 * (non-presence containers are ignored).
241 * libyang schema node to operate on.
244 * The parent libyang schema node if found, or NULL if not found.
246 extern struct lys_node
*yang_snode_real_parent(const struct lys_node
*snode
);
249 * Find first parent schema node which is a list.
252 * libyang schema node to operate on.
255 * The parent libyang schema node (list) if found, or NULL if not found.
257 extern struct lys_node
*yang_snode_parent_list(const struct lys_node
*snode
);
260 * Check if the libyang schema node represents typeless data (e.g. containers,
261 * leafs of type empty, etc).
264 * libyang schema node to operate on.
267 * true if the schema node represents typeless data, false otherwise.
269 extern bool yang_snode_is_typeless_data(const struct lys_node
*snode
);
272 * Get the default value associated to a YANG leaf or leaf-list.
275 * libyang schema node to operate on.
278 * The default value if it exists, NULL otherwise.
280 extern const char *yang_snode_get_default(const struct lys_node
*snode
);
283 * Get the type structure of a leaf of leaf-list. If the type is a leafref, the
284 * final (if there is a chain of leafrefs) target's type is found.
287 * libyang schema node to operate on.
290 * The found type if the schema node represents a leaf or a leaf-list, NULL
293 extern const struct lys_type
*yang_snode_get_type(const struct lys_node
*snode
);
296 * Build data path of the data node.
299 * libyang data node to be processed.
302 * Pointer to previously allocated buffer.
305 * Size of the xpath buffer.
307 extern void yang_dnode_get_path(const struct lyd_node
*dnode
, char *xpath
,
311 * Find a libyang data node by its YANG data path.
314 * Base libyang data node to operate on.
317 * XPath expression (absolute or relative).
320 * The libyang data node if found, or NULL if not found.
322 extern struct lyd_node
*yang_dnode_get(const struct lyd_node
*dnode
,
323 const char *xpath_fmt
, ...);
326 * Check if a libyang data node exists.
329 * Base libyang data node to operate on.
332 * XPath expression (absolute or relative).
335 * true if the libyang data node was found, false otherwise.
337 extern bool yang_dnode_exists(const struct lyd_node
*dnode
,
338 const char *xpath_fmt
, ...);
341 * Check if the libyang data node contains a default value. Non-presence
342 * containers are assumed to always contain a default value.
345 * Base libyang data node to operate on.
348 * Optional XPath expression (absolute or relative) to specify a different
349 * data node to operate on in the same data tree.
352 * true if the data node contains the default value, false otherwise.
354 extern bool yang_dnode_is_default(const struct lyd_node
*dnode
,
355 const char *xpath_fmt
, ...);
358 * Check if the libyang data node and all of its children contain default
359 * values. Non-presence containers are assumed to always contain a default
363 * libyang data node to operate on.
366 * true if the data node and all of its children contain default values,
369 extern bool yang_dnode_is_default_recursive(const struct lyd_node
*dnode
);
372 * Change the value of a libyang leaf node.
375 * libyang data node to operate on.
378 * String representing the new value.
380 extern void yang_dnode_change_leaf(struct lyd_node
*dnode
, const char *value
);
383 * Set the libyang private pointer to a user pointer. Can only be used on YANG
384 * lists and containers.
387 * libyang data node to operate on.
390 * Arbitrary user-specified pointer.
392 extern void yang_dnode_set_entry(const struct lyd_node
*dnode
, void *entry
);
395 * Find the closest data node that contains an user pointer and return it.
398 * libyang data node to operate on.
401 * User pointer if found, NULL otherwise.
403 extern void *yang_dnode_get_entry(const struct lyd_node
*dnode
);
406 * Create a new libyang data node.
409 * libyang context to operate on.
412 * Specify whether the data node will contain only configuration data (true)
413 * or both configuration data and state data (false).
416 * Pointer to newly created libyang data node.
418 extern struct lyd_node
*yang_dnode_new(struct ly_ctx
*ly_ctx
, bool config_only
);
421 * Duplicate a libyang data node.
424 * libyang data node to duplicate.
427 * Pointer to duplicated libyang data node.
429 extern struct lyd_node
*yang_dnode_dup(const struct lyd_node
*dnode
);
432 * Delete a libyang data node.
435 * Pointer to the libyang data node that is going to be deleted.
437 extern void yang_dnode_free(struct lyd_node
*dnode
);
440 * Create a new yang_data structure.
443 * Data path of the YANG data.
446 * String representing the value of the YANG data.
449 * Pointer to newly created yang_data structure.
451 extern struct yang_data
*yang_data_new(const char *xpath
, const char *value
);
454 * Delete a yang_data structure.
457 * yang_data to delete.
459 extern void yang_data_free(struct yang_data
*data
);
462 * Create a new linked list of yang_data structures. The list 'del' callback is
463 * initialized appropriately so that the entire list can be deleted safely with
464 * list_delete_and_null().
467 * Pointer to newly created linked list.
469 extern struct list
*yang_data_list_new(void);
472 * Initialize the YANG subsystem. Should be called only once during the
473 * daemon initialization process.
475 extern void yang_init(void);
478 * Finish the YANG subsystem gracefully. Should be called only when the daemon
481 extern void yang_terminate(void);
483 #endif /* _FRR_YANG_H_ */