blob: 3dde057ad37efe7e2e3697cb0e728fcfd053667b [file] [log] [blame]
Radek Krejcie7b95092019-05-15 11:03:07 +02001/**
2 * @file tree_data.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief libyang representation of YANG data trees.
5 *
6 * Copyright (c) 2015 - 2019 CESNET, z.s.p.o.
7 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_TREE_DATA_H_
16#define LY_TREE_DATA_H_
17
18#include <stddef.h>
19#include <stdint.h>
20
21#include "log.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020022
Radek Krejcica376bd2020-06-11 16:04:06 +020023#ifdef __cplusplus
24extern "C" {
25#endif
26
Radek Krejcie7b95092019-05-15 11:03:07 +020027struct ly_ctx;
Michal Vasko004d3152020-06-11 19:59:22 +020028struct ly_path;
Radek Krejci535ea9f2020-05-29 16:01:05 +020029struct ly_set;
30struct lyd_node;
31struct lyd_node_opaq;
Radek Krejci47fab892020-11-05 17:02:41 +010032struct lyd_node_term;
Radek Krejci535ea9f2020-05-29 16:01:05 +020033struct lys_module;
34struct lysc_node;
Radek Krejci47fab892020-11-05 17:02:41 +010035struct lysc_type;
Radek Krejcie7b95092019-05-15 11:03:07 +020036
Radek Krejcie7b95092019-05-15 11:03:07 +020037/**
Radek Krejci8678fa42020-08-18 16:07:28 +020038 * @page howtoData Data Instances
39 *
40 * All the nodes in data tree comes are based on ::lyd_node structure. According to the content of the ::lyd_node.schema
41 * it can be cast to several other structures.
42 *
43 * In case the ::lyd_node.schema pointer is NULL, the node is actually __opaq__ and can be safely cast to ::lyd_node_opaq.
44 * The opaq node represent an unknown node which wasn't mapped to any [(compiled) schema](@ref howtoSchema) node in the
45 * context. Such a node can appear in several places in the data tree.
46 * - As a part of the tree structure, but only in the case the ::LYD_PARSE_OPAQ option was used when input data were
47 * [parsed](@ref howtoDataParsers), because unknown data instances are ignored by default. The same way, the opaq nodes can
48 * appear as a node's attributes.
49 * - As a representation of YANG anydata/anyxml content.
50 * - As envelopes of standard data tree instances (RPCs, actions or Notifications).
51 *
52 * In case the data node has its definition in a [compiled schema tree](@ref howtoSchema), the structure of the data node is
53 * actually one of the followings according to the schema node's nodetype (::lysc_node.nodetype).
54 * - ::lyd_node_inner - represents data nodes corresponding to schema nodes matching ::LYD_NODE_INNER nodetypes. They provide
55 * structure of the tree by having children nodes.
56 * - ::lyd_node_term - represents data nodes corresponding to schema nodes matching ::LYD_NODE_TERM nodetypes. The terminal
57 * nodes provide values of the particular configuration/status information. The values are represented as ::lyd_value
58 * structure with string representation of the value (::lyd_value.canonical) and the type specific data stored in the
59 * structure's union according to the real type of the value (::lyd_value.realtype). The string representation provides
60 * canonical representation of the value in case the type has the canonical representation specified. Otherwise, it is the
61 * original value or, in case the value can contain prefixes, the JSON format is used to make the value unambiguous.
62 * - ::lyd_node_any - represents data nodes corresponding to schema nodes matching ::LYD_NODE_ANY nodetypes.
63 *
64 * Despite all the aforementioned structures and their members are available as part of the libyang API and callers can use
65 * it to navigate through the data tree structure or to obtain various information, we recommend to use the following macros
66 * and functions.
67 * - ::lyd_child() (or ::lyd_child_no_keys()) and ::lyd_parent() to get the node's child/parent node.
68 * - ::LYD_CTX to get libyang context from a data node.
69 * - ::LYD_CANON_VALUE to get canonical string value from a terminal node.
70 * - ::LYD_TREE_DFS_BEGIN and ::LYD_TREE_DFS_END to traverse the data tree (depth-first).
71 * - ::LY_LIST_FOR and ::LY_ARRAY_FOR as described on @ref howtoStructures page.
72 *
73 * Instead of going through the data tree on your own, a specific data node can be also located using a wide set of
74 * \b lyd_find_*() functions.
75 *
76 * More information about specific operations with data instances can be found on the following pages:
77 * - @subpage howtoDataParsers
78 * - @subpage howtoDataValidation
79 * - @subpage howtoDataWD
80 * - @subpage howtoDataManipulation
81 * - @subpage howtoDataPrinters
82 *
83 * \note API for this group of functions is described in the [Data Instances module](@ref datatree).
84 *
85 * Functions List (not assigned to above subsections)
86 * --------------------------------------------------
87 * - ::lyd_child()
88 * - ::lyd_child_no_keys()
89 * - ::lyd_parent()
90 * - ::lyd_owner_module()
91 * - ::lyd_find_xpath()
92 * - ::lyd_find_sibling_val()
93 * - ::lyd_find_sibling_first()
94 * - ::lyd_find_meta()
95 *
96 * - ::lyd_path()
97 * - ::lyd_target()
98 *
99 * - ::lyd_lyb_data_length()
100 */
101
102/**
103 * @page howtoDataManipulation Manipulating Data
104 *
105 * There are many functions to create or modify an existing data tree. You can add new nodes, reconnect nodes from
106 * one tree to another (or e.g. from one list instance to another) or remove nodes. The functions doesn't allow you
107 * to put a node to a wrong place (by checking the YANG module structure), but not all validation checks can be made directly
108 * (or you have to make a valid change by multiple tree modifications) when the tree is being changed. Therefore,
109 * the [validation process](@ref howtoDataValidation) is expected to be invoked after changing the data tree to make sure
110 * that the changed data tree is valid.
111 *
112 * When inserting a node into data tree (no matter if the node already exists, via ::lyd_insert_child() and
113 * ::lyd_insert_sibling(), or a new node is being created), the node is automatically inserted to the place respecting the
114 * nodes order from the YANG schema. So the node is not inserted to the end or beginning of the siblings list, but after the
115 * existing instance of the closest preceding sibling node from the schema. In case the node is opaq (it is not connected
116 * with any schema node), it is placed to the end of the sibling node in the order they are inserted in. The only situation
117 * when it is possible to influence the order of the nodes is the order of user-ordered list/leaf-list instances. In such
118 * a case the ::lyd_insert_after() or ::lyd_insert_before() can be used.
119 *
120 * Creating data is generally possible in two ways, they can be combined. You can add nodes one-by-one based on
121 * the node name and/or its parent (::lyd_new_inner(), ::lyd_new_term(), ::lyd_new_any(), ::lyd_new_list(), ::lyd_new_list2()
Michal Vasko493900b2020-12-08 10:23:41 +0100122 * and ::lyd_new_opaq()) or address the nodes using a [simple XPath addressing](@ref howtoXPath) (::lyd_new_path() and
123 * ::lyd_new_path2()). The latter enables to create a whole path of nodes, requires less information
Radek Krejci8678fa42020-08-18 16:07:28 +0200124 * about the modified data, and is generally simpler to use. Actually the third way is duplicating the existing data using
125 * ::lyd_dup_single(), ::lyd_dup_siblings() and ::lyd_dup_meta_single().
126 *
127 * The [metadata](@ref howtoPluginsExtensionsMetadata) (and attributes in opaq nodes) can be created with ::lyd_new_meta()
128 * and ::lyd_new_attr().
129 *
130 * Changing value of a terminal node (leaf, leaf-list) is possible with ::lyd_change_term(). Similarly, the metadata value
131 * can be changed with ::lyd_change_meta(). Before changing the value, it might be useful to compare the node's value
132 * with a string value (::lyd_value_compare()) or verify that the new string value is correct for the specific data node
133 * (::lyd_value_validate()).
134 *
135 * Working with two existing subtrees can also be performed two ways. Usually, you would use lyd_insert*() functions.
136 * They are generally meant for simple inserts of a node into a data tree. For more complicated inserts and when
137 * merging 2 trees use ::lyd_merge_tree() or ::lyd_merge_siblings(). It offers additional options and is basically a more
138 * powerful insert.
139 *
140 * Besides merging, libyang is also capable to provide information about differences between two data trees. For this purpose,
141 * ::lyd_diff_tree() and ::lyd_diff_siblings() generates annotated data trees which can be, in addition, used to change one
142 * data tree to another one using ::lyd_diff_apply_all(), ::lyd_diff_apply_module() and ::lyd_diff_reverse_all(). Multiple
143 * diff data trees can be also put together for further work using ::lyd_diff_merge_all(), ::lyd_diff_merge_module() and
144 * ::lyd_diff_merge_tree() functions. To just check equivalence of the data nodes, ::lyd_compare_single(),
145 * ::lyd_compare_siblings() and ::lyd_compare_meta() can be used.
146 *
147 * To remove a node or subtree from a data tree, use ::lyd_unlink_tree() and then free the unwanted data using
148 * ::lyd_free_all() (or other \b lyd_free_*() functions).
149 *
150 * Also remember, that when you are creating/inserting a node, all the objects in that operation must belong to the
151 * same context.
152 *
153 * Modifying the single data tree in multiple threads is not safe.
154 *
155 * Functions List
156 * --------------
157 * - ::lyd_new_inner()
158 * - ::lyd_new_term()
159 * - ::lyd_new_list()
160 * - ::lyd_new_list2()
161 * - ::lyd_new_any()
162 * - ::lyd_new_opaq()
163 * - ::lyd_new_attr()
164 * - ::lyd_new_meta()
165 * - ::lyd_new_path()
166 * - ::lyd_new_path2()
Radek Krejci8678fa42020-08-18 16:07:28 +0200167 *
168 * - ::lyd_dup_single()
169 * - ::lyd_dup_siblings()
170 * - ::lyd_dup_meta_single()
171 *
172 * - ::lyd_insert_child()
173 * - ::lyd_insert_sibling()
174 * - ::lyd_insert_after()
175 * - ::lyd_insert_before()
176 *
177 * - ::lyd_value_compare()
178 * - ::lyd_value_validate()
179 *
180 * - ::lyd_change_term()
181 * - ::lyd_change_meta()
182 *
183 * - ::lyd_compare_single()
184 * - ::lyd_compare_siblings()
185 * - ::lyd_compare_meta()
186 * - ::lyd_diff_tree()
187 * - ::lyd_diff_siblings()
188 * - ::lyd_diff_apply_all()
189 * - ::lyd_diff_apply_module()
190 * - ::lyd_diff_reverse_all()
191 * - ::lyd_diff_merge_all()
192 * - ::lyd_diff_merge_module()
193 * - ::lyd_diff_merge_tree()
194 *
195 * - ::lyd_merge_tree()
196 * - ::lyd_merge_siblings()
197 *
198 * - ::lyd_unlink_tree()
199 *
200 * - ::lyd_free_all()
201 * - ::lyd_free_siblings()
202 * - ::lyd_free_tree()
203 * - ::lyd_free_meta_single()
204 * - ::lyd_free_meta_siblings()
205 * - ::lyd_free_attr_single()
206 * - ::lyd_free_attr_siblings()
207 *
208 * - ::lyd_any_copy_value()
209 */
210
211/**
212 * @page howtoDataWD Default Values
213 *
214 * libyang provides support for work with default values as defined in [RFC 6243](https://tools.ietf.org/html/rfc6243).
215 * However, libyang context do not contains the *ietf-netconf-with-defaults* module on its own and caller is supposed to
216 * add this YANG module to enable full support of the *with-defaults* features described below. Without presence of the
217 * mentioned module in the context, the default nodes are still present and handled in the data trees, but the metadata
218 * providing the information about the default values cannot be used. It means that when parsing data, the default nodes
219 * marked with the metadata as implicit default nodes are handled as explicit data and when printing data tree, the expected
220 * nodes are printed without the ietf-netconf-with-defaults metadata.
221 *
222 * The RFC document defines 4 modes for handling default nodes in a data tree, libyang adds the fifth mode and use them
223 * via @ref dataprinterflags when printing data trees.
224 * - \b explicit - Only the explicitly set configuration data. But in the case of status data, missing default
225 * data are added into the tree. In libyang, this mode is represented by ::LYD_PRINT_WD_EXPLICIT option.
226 * This is the default with-defaults mode of the printer. The data nodes do not contain any additional
227 * metadata information.
228 * - \b trim - Data nodes containing the default value are removed. This mode is applied with ::LYD_PRINT_WD_TRIM option.
229 * - \b report-all - This mode provides all the default data nodes despite they were explicitly present in source data or
230 * they were added by libyang's [validation process](@ref howtoDataValidation). This mode is activated by
231 * ::LYD_PRINT_WD_ALL option.
232 * - \b report-all-tagged - In this case, all the data nodes (implicit as well the explicit) containing the default value
233 * are printed and tagged (see the note below). Printers accept ::LYD_PRINT_WD_ALL_TAG option for this mode.
234 * - \b report-implicit-tagged - The last mode is similar to the previous one, except only the implicitly added nodes
235 * are tagged. This is the libyang's extension and it is activated by ::LYD_PRINT_WD_IMPL_TAG option.
236 *
237 * Internally, libyang adds the default nodes into the data tree as part of the [validation process](@ref howtoDataValidation).
238 * When [parsing data](@ref howtoDataParsers) from an input source, adding default nodes can be avoided only by avoiding
239 * the whole [validation process](@ref howtoDataValidation). In case the ietf-netconf-with-defaults module is present in the
240 * context, the [parser process](@ref howtoDataParsers) also supports to recognize the implicit default nodes marked with the
241 * appropriate metadata.
242 *
243 * Note, that in a modified data tree (via e.g. \b lyd_insert_*() or \b lyd_free_*() functions), some of the default nodes
244 * can be missing or they can be present by mistake. Such a data tree is again corrected during the next run of the
245 * [validation process](@ref howtoDataValidation) or manualy using \b lyd_new_implicit_*() functions.
246 *
247 * The implicit (default) nodes, created by libyang, are marked with the ::LYD_DEFAULT flag in ::lyd_node.flags member
248 * Note, that besides leafs and leaf-lists, the flag can appear also in containers, where it means that the container
249 * holds only a default node(s) or it is implicitly added empty container (according to YANG 1.1 spec, all such containers are part of
250 * the accessible data tree). When printing data trees, the presence of empty containers (despite they were added
251 * explicitly or implicitly as part of accessible data tree) depends on ::LYD_PRINT_KEEPEMPTYCONT option.
252 *
253 * To get know if the particular leaf or leaf-list node contains default value (despite implicit or explicit), you can
254 * use ::lyd_is_default() function.
255 *
256 * Functions List
257 * --------------
258 * - ::lyd_is_default()
259 * - ::lyd_new_implicit_all()
260 * - ::lyd_new_implicit_module()
261 * - ::lyd_new_implicit_tree()
262 */
263
264/**
Radek Krejci2ff0d572020-05-21 15:27:28 +0200265 * @ingroup trees
Radek Krejci8678fa42020-08-18 16:07:28 +0200266 * @defgroup datatree Data Tree
Radek Krejcie7b95092019-05-15 11:03:07 +0200267 * @{
268 *
269 * Data structures and functions to manipulate and access instance data tree.
270 */
271
Michal Vasko64246d82020-08-19 12:35:00 +0200272/* *INDENT-OFF* */
273
Michal Vaskoa276cd92020-08-10 15:10:08 +0200274/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200275 * @brief Macro to iterate via all elements in a data tree. This is the opening part
276 * to the #LYD_TREE_DFS_END - they always have to be used together.
277 *
278 * The function follows deep-first search algorithm:
279 * <pre>
280 * 1
281 * / \
Michal Vaskoc193ce92020-03-06 11:04:48 +0100282 * 2 4
Radek Krejcie7b95092019-05-15 11:03:07 +0200283 * / / \
Michal Vaskoc193ce92020-03-06 11:04:48 +0100284 * 3 5 6
Radek Krejcie7b95092019-05-15 11:03:07 +0200285 * </pre>
286 *
Radek Krejci0935f412019-08-20 16:15:18 +0200287 * Use the same parameters for #LYD_TREE_DFS_BEGIN and #LYD_TREE_DFS_END. While
Michal Vasko56daf732020-08-10 10:57:18 +0200288 * START can be any of the lyd_node* types, ELEM variable must be a pointer to
289 * the generic struct lyd_node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200290 *
Michal Vasko56daf732020-08-10 10:57:18 +0200291 * To skip a particular subtree, instead of the continue statement, set LYD_TREE_DFS_continue
292 * variable to non-zero value.
Radek Krejcie7b95092019-05-15 11:03:07 +0200293 *
294 * Use with opening curly bracket '{' after the macro.
295 *
296 * @param START Pointer to the starting element processed first.
Radek Krejcie7b95092019-05-15 11:03:07 +0200297 * @param ELEM Iterator intended for use in the block.
298 */
Michal Vasko56daf732020-08-10 10:57:18 +0200299#define LYD_TREE_DFS_BEGIN(START, ELEM) \
Radek Krejci857189e2020-09-01 13:26:36 +0200300 { ly_bool LYD_TREE_DFS_continue = 0; struct lyd_node *LYD_TREE_DFS_next; \
Michal Vasko56daf732020-08-10 10:57:18 +0200301 for ((ELEM) = (LYD_TREE_DFS_next) = (struct lyd_node *)(START); \
Radek Krejcie7b95092019-05-15 11:03:07 +0200302 (ELEM); \
Michal Vasko56daf732020-08-10 10:57:18 +0200303 (ELEM) = (LYD_TREE_DFS_next), LYD_TREE_DFS_continue = 0)
Radek Krejcie7b95092019-05-15 11:03:07 +0200304
305/**
306 * @brief Macro to iterate via all elements in a tree. This is the closing part
307 * to the #LYD_TREE_DFS_BEGIN - they always have to be used together.
308 *
309 * Use the same parameters for #LYD_TREE_DFS_BEGIN and #LYD_TREE_DFS_END. While
Michal Vasko56daf732020-08-10 10:57:18 +0200310 * START can be any of the lyd_node* types, ELEM variable must be a pointer
311 * to the generic struct lyd_node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200312 *
313 * Use with closing curly bracket '}' after the macro.
314 *
315 * @param START Pointer to the starting element processed first.
Radek Krejcie7b95092019-05-15 11:03:07 +0200316 * @param ELEM Iterator intended for use in the block.
317 */
318
Michal Vasko56daf732020-08-10 10:57:18 +0200319#define LYD_TREE_DFS_END(START, ELEM) \
Radek Krejcie7b95092019-05-15 11:03:07 +0200320 /* select element for the next run - children first */ \
Michal Vasko56daf732020-08-10 10:57:18 +0200321 if (LYD_TREE_DFS_continue) { \
322 (LYD_TREE_DFS_next) = NULL; \
323 } else { \
Radek Krejcia1c1e542020-09-29 16:06:52 +0200324 (LYD_TREE_DFS_next) = lyd_child(ELEM); \
Michal Vasko56daf732020-08-10 10:57:18 +0200325 }\
326 if (!(LYD_TREE_DFS_next)) { \
Radek Krejcie7b95092019-05-15 11:03:07 +0200327 /* no children */ \
328 if ((ELEM) == (struct lyd_node*)(START)) { \
329 /* we are done, (START) has no children */ \
330 break; \
331 } \
332 /* try siblings */ \
Michal Vasko56daf732020-08-10 10:57:18 +0200333 (LYD_TREE_DFS_next) = (ELEM)->next; \
Radek Krejcie7b95092019-05-15 11:03:07 +0200334 } \
Michal Vasko56daf732020-08-10 10:57:18 +0200335 while (!(LYD_TREE_DFS_next)) { \
Radek Krejcie7b95092019-05-15 11:03:07 +0200336 /* parent is already processed, go to its sibling */ \
337 (ELEM) = (struct lyd_node*)(ELEM)->parent; \
338 /* no siblings, go back through parents */ \
339 if ((ELEM)->parent == (START)->parent) { \
340 /* we are done, no next element to process */ \
341 break; \
342 } \
Michal Vasko56daf732020-08-10 10:57:18 +0200343 (LYD_TREE_DFS_next) = (ELEM)->next; \
344 } } \
Radek Krejcie7b95092019-05-15 11:03:07 +0200345
Michal Vasko64246d82020-08-19 12:35:00 +0200346/* *INDENT-ON* */
347
Radek Krejcie7b95092019-05-15 11:03:07 +0200348/**
Michal Vasko03ff5a72019-09-11 13:49:33 +0200349 * @brief Macro to get context from a data tree node.
350 */
Michal Vaskob7be7a82020-08-20 09:09:04 +0200351#define LYD_CTX(node) ((node)->schema ? (node)->schema->module->ctx : ((struct lyd_node_opaq *)(node))->ctx)
Michal Vasko03ff5a72019-09-11 13:49:33 +0200352
353/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200354 * @brief Data input/output formats supported by libyang [parser](@ref howtoDataParsers) and
355 * [printer](@ref howtoDataPrinters) functions.
Radek Krejcie7b95092019-05-15 11:03:07 +0200356 */
357typedef enum {
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200358 LYD_UNKNOWN = 0, /**< unknown data format, invalid value */
359 LYD_XML, /**< XML instance data format */
360 LYD_JSON, /**< JSON instance data format */
Michal Vasko69730152020-10-09 16:30:07 +0200361 LYD_LYB /**< LYB instance data format */
Radek Krejcie7b95092019-05-15 11:03:07 +0200362} LYD_FORMAT;
363
364/**
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200365 * @brief All kinds of supported prefix mappings to modules.
366 */
367typedef enum {
368 LY_PREF_SCHEMA, /**< value prefixes map to YANG import prefixes */
Michal Vaskoc9795582020-10-08 16:22:17 +0200369 LY_PREF_SCHEMA_RESOLVED, /**< value prefixes map to module structures directly */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200370 LY_PREF_XML, /**< value prefixes map to XML namespace prefixes */
Michal Vasko69730152020-10-09 16:30:07 +0200371 LY_PREF_JSON /**< value prefixes map to module names */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200372} LY_PREFIX_FORMAT;
373
374/**
Radek Krejci59583bb2019-09-11 12:57:55 +0200375 * @brief List of possible value types stored in ::lyd_node_any.
Radek Krejcie7b95092019-05-15 11:03:07 +0200376 */
377typedef enum {
Radek Krejci8678fa42020-08-18 16:07:28 +0200378 LYD_ANYDATA_DATATREE, /**< Value is a pointer to ::lyd_node structure (first sibling). When provided as input parameter, the pointer
Radek Krejciee4cab22019-07-17 17:07:47 +0200379 is directly connected into the anydata node without duplication, caller is supposed to not manipulate
Radek Krejci8678fa42020-08-18 16:07:28 +0200380 with the data after a successful call (including calling ::lyd_free_all() on the provided data) */
Radek Krejci22ebdba2019-07-25 13:59:43 +0200381 LYD_ANYDATA_STRING, /**< Value is a generic string without any knowledge about its format (e.g. anyxml value in JSON encoded
Radek Krejciee4cab22019-07-17 17:07:47 +0200382 as string). XML sensitive characters (such as & or \>) are automatically escaped when the anydata
383 is printed in XML format. */
Radek Krejci22ebdba2019-07-25 13:59:43 +0200384 LYD_ANYDATA_XML, /**< Value is a string containing the serialized XML data. */
385 LYD_ANYDATA_JSON, /**< Value is a string containing the data modeled by YANG and encoded as I-JSON. */
Michal Vasko69730152020-10-09 16:30:07 +0200386 LYD_ANYDATA_LYB /**< Value is a memory chunk with the serialized data tree in LYB format. */
Radek Krejcie7b95092019-05-15 11:03:07 +0200387} LYD_ANYDATA_VALUETYPE;
388
389/** @} */
390
391/**
392 * @brief YANG data representation
393 */
394struct lyd_value {
Michal Vaskoba99a3e2020-08-18 15:50:05 +0200395 const char *canonical; /**< Canonical string representation of the value in the dictionary. It is never
396 NULL and in case of no canonical value, its JSON representation is used instead. */
Radek Krejci8678fa42020-08-18 16:07:28 +0200397
Radek Krejcie7b95092019-05-15 11:03:07 +0200398 union {
Radek Krejcie7b95092019-05-15 11:03:07 +0200399 int8_t boolean; /**< 0 as false, 1 as true */
400 int64_t dec64; /**< decimal64: value = dec64 / 10^fraction-digits */
Radek Krejci8dc4f2d2019-07-16 12:24:00 +0200401 int8_t int8; /**< 8-bit signed integer */
402 int16_t int16; /**< 16-bit signed integer */
403 int32_t int32; /**< 32-bit signed integer */
404 int64_t int64; /**< 64-bit signed integer */
405 uint8_t uint8; /**< 8-bit unsigned integer */
Michal Vasko7c8439f2020-08-05 13:25:19 +0200406 uint16_t uint16; /**< 16-bit unsigned integer */
407 uint32_t uint32; /**< 32-bit unsigned integer */
408 uint64_t uint64; /**< 64-bit unsigned integer */
Radek Krejcie7b95092019-05-15 11:03:07 +0200409 struct lysc_type_bitenum_item *enum_item; /**< pointer to the definition of the enumeration value */
Radek Krejci849a62a2019-05-22 15:29:05 +0200410 struct lysc_type_bitenum_item **bits_items; /**< list of set pointers to the specification of the set bits ([sized array](@ref sizedarrays)) */
Radek Krejcie7b95092019-05-15 11:03:07 +0200411 struct lysc_ident *ident; /**< pointer to the schema definition of the identityref value */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200412 struct ly_path *target; /**< Instance-identifier target path. */
413 struct lyd_value_subvalue *subvalue; /** Union value with some metadata. */
Radek Krejcie7b95092019-05-15 11:03:07 +0200414 void *ptr; /**< generic data type structure used to store the data */
Radek Krejci8678fa42020-08-18 16:07:28 +0200415 }; /**< The union is just a list of shorthands to possible values stored by a type's plugin. libyang itself uses the ::lyd_value.realtype
416 plugin's callbacks to work with the data.*/
Radek Krejci084289f2019-07-09 17:35:30 +0200417
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200418 const struct lysc_type *realtype; /**< pointer to the real type of the data stored in the value structure. This type can differ from the type
Radek Krejci8678fa42020-08-18 16:07:28 +0200419 in the schema node of the data node since the type's store plugin can use other types/plugins for
420 storing data. Speaking about built-in types, this is the case of leafref which stores data as its
421 target type. In contrast, union type also uses its subtype's callbacks, but inside an internal data
422 stored in subvalue member of ::lyd_value structure, so here is the pointer to the union type.
423 In general, this type is used to get free callback for this lyd_value structure, so it must reflect
424 the type used to store data directly in the same lyd_value instance. */
Radek Krejcie7b95092019-05-15 11:03:07 +0200425};
426
427/**
Michal Vaskoba99a3e2020-08-18 15:50:05 +0200428 * @brief Macro for getting the string canonical value from a term node.
429 *
430 * @param[in] node Term node with the value.
431 * @return Canonical value.
432 */
Michal Vaskob7be7a82020-08-20 09:09:04 +0200433#define LYD_CANON_VALUE(node) ((struct lyd_node_term *)(node))->value.canonical
Michal Vaskoba99a3e2020-08-18 15:50:05 +0200434
435/**
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200436 * @brief Special lyd_value structure for union.
437 *
438 * Represents data with multiple types (union). Original value is stored in the main lyd_value:canonical_cache while
Radek Krejci8678fa42020-08-18 16:07:28 +0200439 * the ::lyd_value_subvalue.value contains representation according to one of the union's types.
440 * The ::lyd_value_subvalue.prefix_data provides (possible) mappings from prefixes in the original value to YANG modules.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200441 * These prefixes are necessary to parse original value to the union's subtypes.
442 */
443struct lyd_value_subvalue {
444 struct lyd_value value; /**< representation of the value according to the selected union's subtype
Radek Krejci8678fa42020-08-18 16:07:28 +0200445 (stored as ::lyd_value.realtype here, in subvalue structure */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200446 const char *original; /**< Original value in the dictionary. */
447 LY_PREFIX_FORMAT format; /**< Prefix format of the value. However, this information is also used to decide
448 whether a value is valid for the specific format or not on later validations
449 (instance-identifier in XML looks different than in JSON). */
Radek Krejci8678fa42020-08-18 16:07:28 +0200450 void *prefix_data; /**< Format-specific data for prefix resolution (see ::ly_type_store_resolve_prefix()) */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200451 uint32_t hints; /**< [Value hints](@ref lydvalhints) from the parser */
452 const struct lysc_node *ctx_node; /**< Context schema node. */
453};
454
455/**
Michal Vasko9f96a052020-03-10 09:41:45 +0100456 * @brief Metadata structure.
Radek Krejcie7b95092019-05-15 11:03:07 +0200457 *
Michal Vasko9f96a052020-03-10 09:41:45 +0100458 * The structure provides information about metadata of a data element. Such attributes must map to
Radek Krejcie7b95092019-05-15 11:03:07 +0200459 * annotations as specified in RFC 7952. The only exception is the filter type (in NETCONF get operations)
460 * and edit-config's operation attributes. In XML, they are represented as standard XML attributes. In JSON,
461 * they are represented as JSON elements starting with the '@' character (for more information, see the
462 * YANG metadata RFC.
463 *
464 */
Michal Vasko9f96a052020-03-10 09:41:45 +0100465struct lyd_meta {
466 struct lyd_node *parent; /**< data node where the metadata is placed */
467 struct lyd_meta *next; /**< pointer to the next metadata of the same element */
468 struct lysc_ext_instance *annotation; /**< pointer to the annotation's definition */
469 const char *name; /**< metadata name */
470 struct lyd_value value; /**< metadata value representation */
Radek Krejcie7b95092019-05-15 11:03:07 +0200471};
472
Michal Vasko52927e22020-03-16 17:26:14 +0100473/**
474 * @brief Generic prefix and namespace mapping, meaning depends on the format.
Radek Krejci1798aae2020-07-14 13:26:06 +0200475 *
476 * The union is used as a reference to the data's module and according to the format, it can be used as a key for
Radek Krejci8678fa42020-08-18 16:07:28 +0200477 * ::ly_ctx_get_module_implemented_ns() or ::ly_ctx_get_module_implemented(). While the module reference is always present,
Michal Vaskoad92b672020-11-12 13:11:31 +0100478 * the prefix member can be omitted in case it is not present in the source data as a reference to the default module/namespace.
Michal Vasko52927e22020-03-16 17:26:14 +0100479 */
Michal Vaskoad92b672020-11-12 13:11:31 +0100480struct ly_opaq_name {
481 const char *name; /**< node name, without prefix if any was defined */
482 const char *prefix; /**< identifier used in the qualified name as the prefix, can be NULL */
Radek Krejci1798aae2020-07-14 13:26:06 +0200483 union {
Michal Vaskoad92b672020-11-12 13:11:31 +0100484 const char *module_ns; /**< format ::LY_PREF_XML - XML namespace of the node element */
485 const char *module_name; /**< format ::LY_PREF_JSON - (inherited) name of the module of the element */
Radek Krejci1798aae2020-07-14 13:26:06 +0200486 };
Michal Vasko52927e22020-03-16 17:26:14 +0100487};
488
489/**
490 * @brief Generic attribute structure.
491 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200492struct lyd_attr {
Michal Vasko52927e22020-03-16 17:26:14 +0100493 struct lyd_node_opaq *parent; /**< data node where the attribute is placed */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100494 struct lyd_attr *next; /**< pointer to the next attribute */
Michal Vaskoad92b672020-11-12 13:11:31 +0100495 struct ly_opaq_name name; /**< attribute name with module information */
Michal Vasko501af032020-11-11 20:27:44 +0100496 const char *value; /**< attribute value */
497 LY_PREFIX_FORMAT format; /**< format of the attribute and any prefixes, ::LY_PREF_XML or ::LY_PREF_JSON */
498 void *val_prefix_data; /**< format-specific prefix data (see ::ly_resolve_prefix()) */
499 uint32_t hints; /**< additional information about from the data source, see the [hints list](@ref lydhints) */
Michal Vasko52927e22020-03-16 17:26:14 +0100500
501};
Radek Krejcie7b95092019-05-15 11:03:07 +0200502
Michal Vasko1bf09392020-03-27 12:38:10 +0100503#define LYD_NODE_INNER (LYS_CONTAINER|LYS_LIST|LYS_RPC|LYS_ACTION|LYS_NOTIF) /**< Schema nodetype mask for lyd_node_inner */
Radek Krejcie7b95092019-05-15 11:03:07 +0200504#define LYD_NODE_TERM (LYS_LEAF|LYS_LEAFLIST) /**< Schema nodetype mask for lyd_node_term */
505#define LYD_NODE_ANY (LYS_ANYDATA) /**< Schema nodetype mask for lyd_node_any */
506
507/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200508 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +0200509 * @defgroup dnodeflags Data node flags
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200510 * @{
511 *
512 * Various flags of data nodes.
513 *
514 * 1 - container 5 - anydata/anyxml
515 * 2 - list 6 - rpc/action
516 * 3 - leaf 7 - notification
517 * 4 - leaflist
518 *
519 * bit name 1 2 3 4 5 6 7
520 * ---------------------+-+-+-+-+-+-+-+
521 * 1 LYD_DEFAULT |x| |x|x| | | |
522 * +-+-+-+-+-+-+-+
Michal Vasko5c4e5892019-11-14 12:31:38 +0100523 * 2 LYD_WHEN_TRUE |x|x|x|x|x| | |
Michal Vasko9b368d32020-02-14 13:53:31 +0100524 * +-+-+-+-+-+-+-+
525 * 3 LYD_NEW |x|x|x|x|x|x|x|
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200526 * ---------------------+-+-+-+-+-+-+-+
527 *
528 */
529
Michal Vasko5c4e5892019-11-14 12:31:38 +0100530#define LYD_DEFAULT 0x01 /**< default (implicit) node */
531#define LYD_WHEN_TRUE 0x02 /**< all when conditions of this node were evaluated to true */
Michal Vasko9b368d32020-02-14 13:53:31 +0100532#define LYD_NEW 0x04 /**< node was created after the last validation, is needed for the next validation */
Michal Vasko52927e22020-03-16 17:26:14 +0100533
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200534/** @} */
535
536/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200537 * @brief Generic structure for a data node.
538 */
539struct lyd_node {
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200540 uint32_t hash; /**< hash of this particular node (module name + schema name + key string values if list or
541 hashes of all nodes of subtree in case of keyless list). Note that while hash can be
542 used to get know that nodes are not equal, it cannot be used to decide that the
543 nodes are equal due to possible collisions. */
544 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
Michal Vaskoecd62de2019-11-13 12:35:11 +0100545 const struct lysc_node *schema; /**< pointer to the schema definition of this node, note that the target can be not just
Radek Krejci8678fa42020-08-18 16:07:28 +0200546 ::lysc_node but ::lysc_action or ::lysc_notif as well */
Radek Krejcie7b95092019-05-15 11:03:07 +0200547 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
548 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
549 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
550 never NULL. If there is no sibling node, pointer points to the node
551 itself. In case of the first node, this pointer points to the last
552 node in the list. */
Michal Vasko9f96a052020-03-10 09:41:45 +0100553 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200554
555#ifdef LY_ENABLED_LYD_PRIV
556 void *priv; /**< private user data, not used by libyang */
557#endif
558};
559
560/**
Radek Krejcif3b6fec2019-07-24 15:53:11 +0200561 * @brief Data node structure for the inner data tree nodes - containers, lists, RPCs, actions and Notifications.
Radek Krejcie7b95092019-05-15 11:03:07 +0200562 */
563struct lyd_node_inner {
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200564 uint32_t hash; /**< hash of this particular node (module name + schema name + key string values if list or
565 hashes of all nodes of subtree in case of keyless list). Note that while hash can be
566 used to get know that nodes are not equal, it cannot be used to decide that the
567 nodes are equal due to possible collisions. */
568 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
Radek Krejcie7b95092019-05-15 11:03:07 +0200569 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
570 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
571 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
572 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
573 never NULL. If there is no sibling node, pointer points to the node
574 itself. In case of the first node, this pointer points to the last
575 node in the list. */
Michal Vasko9f96a052020-03-10 09:41:45 +0100576 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200577
578#ifdef LY_ENABLED_LYD_PRIV
579 void *priv; /**< private user data, not used by libyang */
580#endif
581
582 struct lyd_node *child; /**< pointer to the first child node. */
583 struct hash_table *children_ht; /**< hash table with all the direct children (except keys for a list, lists without keys) */
Radek Krejci8678fa42020-08-18 16:07:28 +0200584#define LYD_HT_MIN_ITEMS 4 /**< minimal number of children to create ::lyd_node_inner.children_ht hash table. */
Radek Krejcie7b95092019-05-15 11:03:07 +0200585};
586
587/**
Michal Vaskof03ed032020-03-04 13:31:44 +0100588 * @brief Data node structure for the terminal data tree nodes - leaves and leaf-lists.
Radek Krejcie7b95092019-05-15 11:03:07 +0200589 */
590struct lyd_node_term {
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200591 uint32_t hash; /**< hash of this particular node (module name + schema name + key string values if list or
592 hashes of all nodes of subtree in case of keyless list). Note that while hash can be
593 used to get know that nodes are not equal, it cannot be used to decide that the
594 nodes are equal due to possible collisions. */
595 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
Radek Krejcie7b95092019-05-15 11:03:07 +0200596 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
597 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
598 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
599 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
600 never NULL. If there is no sibling node, pointer points to the node
601 itself. In case of the first node, this pointer points to the last
602 node in the list. */
Michal Vasko9f96a052020-03-10 09:41:45 +0100603 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200604
605#ifdef LY_ENABLED_LYD_PRIV
606 void *priv; /**< private user data, not used by libyang */
607#endif
608
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200609 struct lyd_value value; /**< node's value representation */
Radek Krejcie7b95092019-05-15 11:03:07 +0200610};
611
612/**
613 * @brief Data node structure for the anydata data tree nodes - anydatas and anyxmls.
614 */
615struct lyd_node_any {
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200616 uint32_t hash; /**< hash of this particular node (module name + schema name + key string values if list or
617 hashes of all nodes of subtree in case of keyless list). Note that while hash can be
618 used to get know that nodes are not equal, it cannot be used to decide that the
619 nodes are equal due to possible collisions. */
620 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
Radek Krejcie7b95092019-05-15 11:03:07 +0200621 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
622 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
623 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
624 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
625 never NULL. If there is no sibling node, pointer points to the node
626 itself. In case of the first node, this pointer points to the last
627 node in the list. */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200628 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200629
630#ifdef LY_ENABLED_LYD_PRIV
631 void *priv; /**< private user data, not used by libyang */
632#endif
633
Michal Vasko00cbf532020-06-15 13:58:47 +0200634 union lyd_any_value {
Radek Krejciee4cab22019-07-17 17:07:47 +0200635 struct lyd_node *tree; /**< data tree */
636 const char *str; /**< Generic string data */
637 const char *xml; /**< Serialized XML data */
638 const char *json; /**< I-JSON encoded string */
639 char *mem; /**< LYD_ANYDATA_LYB memory chunk */
640 } value; /**< pointer to the stored value representation of the anydata/anyxml node */
Radek Krejci8678fa42020-08-18 16:07:28 +0200641 LYD_ANYDATA_VALUETYPE value_type;/**< type of the data stored as ::lyd_node_any.value */
Radek Krejcie7b95092019-05-15 11:03:07 +0200642};
643
644/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200645 * @ingroup datatree
646 * @defgroup lydvalhints Value format hints.
Radek Krejci1798aae2020-07-14 13:26:06 +0200647 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200648 *
649 * Hints for the type of the data value.
650 *
651 * Any information about value types encoded in the format is hinted by these values.
Radek Krejci1798aae2020-07-14 13:26:06 +0200652 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200653#define LYD_VALHINT_STRING 0x0001 /**< value is allowed to be a string */
654#define LYD_VALHINT_DECNUM 0x0002 /**< value is allowed to be a decimal number */
655#define LYD_VALHINT_OCTNUM 0x0004 /**< value is allowed to be an octal number */
656#define LYD_VALHINT_HEXNUM 0x0008 /**< value is allowed to be a hexadecimal number */
657#define LYD_VALHINT_NUM64 0x0010 /**< value is allowed to be an int64 or uint64 */
658#define LYD_VALHINT_BOOLEAN 0x0020 /**< value is allowed to be a boolean */
659#define LYD_VALHINT_EMPTY 0x0040 /**< value is allowed to be empty */
660/**
661 * @} lydvalhints
662 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200663
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200664/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200665 * @ingroup datatree
666 * @defgroup lydnodehints Node type format hints
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200667 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200668 *
669 * Hints for the type of the data node.
670 *
671 * Any information about node types encoded in the format is hinted by these values.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200672 */
673#define LYD_NODEHINT_LIST 0x0080 /**< node is allowed to be a list instance */
674#define LYD_NODEHINT_LEAFLIST 0x0100 /**< node is allowed to be a leaf-list instance */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200675/**
676 * @} lydnodehints
677 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200678
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200679/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200680 * @ingroup datatree
681 * @defgroup lydhints Value and node type format hints
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200682 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200683 *
684 * Hints for the types of data node and its value.
685 *
686 * Any information about value and node types encoded in the format is hinted by these values.
687 * It combines [value hints](@ref lydvalhints) and [node hints](@ref lydnodehints).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200688 */
689#define LYD_HINT_DATA 0x01F3 /**< special node/value hint to be used for generic data node/value (for cases when
690 there is no encoding or it does not provide any additional information about
691 a node/value type); do not combine with specific [value hints](@ref lydvalhints)
692 or [node hints](@ref lydnodehints). */
693#define LYD_HINT_SCHEMA 0x01FF /**< special node/value hint to be used for generic schema node/value(for cases when
694 there is no encoding or it does not provide any additional information about
695 a node/value type); do not combine with specific [value hints](@ref lydvalhints)
696 or [node hints](@ref lydnodehints). */
697/**
698 * @} lydhints
699 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200700
701/**
Michal Vasko52927e22020-03-16 17:26:14 +0100702 * @brief Data node structure for unparsed (opaque) nodes.
703 */
704struct lyd_node_opaq {
705 uint32_t hash; /**< always 0 */
706 uint32_t flags; /**< always 0 */
707 const struct lysc_node *schema; /**< always NULL */
708 struct lyd_node *parent; /**< pointer to the parent node (NULL in case of root node) */
709 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
710 struct lyd_node *prev; /**< pointer to the previous sibling node (last sibling if there is none) */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200711 struct lyd_attr *attr; /**< pointer to the list of generic attributes of this node */
Michal Vasko52927e22020-03-16 17:26:14 +0100712
713#ifdef LY_ENABLED_LYD_PRIV
714 void *priv; /**< private user data, not used by libyang */
715#endif
716
Michal Vasko501af032020-11-11 20:27:44 +0100717 struct lyd_node *child; /**< pointer to the child node (compatible with ::lyd_node_inner) */
718
Michal Vaskoad92b672020-11-12 13:11:31 +0100719 struct ly_opaq_name name; /**< node name with module information */
Michal Vasko52927e22020-03-16 17:26:14 +0100720 const char *value; /**< original value */
Michal Vasko501af032020-11-11 20:27:44 +0100721 LY_PREFIX_FORMAT format; /**< format of the node and any prefixes, ::LY_PREF_XML or ::LY_PREF_JSON */
722 void *val_prefix_data; /**< format-specific prefix data (see ::ly_resolve_prefix()) */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200723 uint32_t hints; /**< additional information about from the data source, see the [hints list](@ref lydhints) */
Michal Vasko501af032020-11-11 20:27:44 +0100724
Michal Vasko52927e22020-03-16 17:26:14 +0100725 const struct ly_ctx *ctx; /**< libyang context */
726};
727
728/**
Radek Krejcia1c1e542020-09-29 16:06:52 +0200729 * @brief Get the generic parent pointer of a data node.
730 *
731 * @param[in] node Node whose parent pointer to get.
732 * @return Pointer to the parent node of the @p node.
733 * @return NULL in case of the top-level node or if the @p node is NULL itself.
Michal Vasko5bfd4be2020-06-23 13:26:19 +0200734 */
Radek Krejcia1c1e542020-09-29 16:06:52 +0200735struct lyd_node *lyd_parent(const struct lyd_node *node);
Michal Vasko5bfd4be2020-06-23 13:26:19 +0200736
737/**
Radek Krejcia1c1e542020-09-29 16:06:52 +0200738 * @brief Get the child pointer of a generic data node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200739 *
Radek Krejcia1c1e542020-09-29 16:06:52 +0200740 * Decides the node's type and in case it has a children list, returns it. Supports even the opaq nodes (::lyd_node_opaq).
741 *
742 * If you need to skip key children, use ::lyd_child_no_keys().
743 *
744 * @param[in] node Node to use.
745 * @return Pointer to the first child node (if any) of the @p node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200746 */
Radek Krejcia1c1e542020-09-29 16:06:52 +0200747struct lyd_node *lyd_child(const struct lyd_node *node);
748
749/**
750 * @brief Get the child pointer of a generic data node but skip its keys in case it is ::LYS_LIST.
751 *
752 * Decides the node's type and in case it has a children list, returns it. Supports even the opaq nodes (::lyd_node_opaq).
753 *
754 * If you need to take key children into account, use ::lyd_child().
755 *
756 * @param[in] node Node to use.
757 * @return Pointer to the first child node (if any) of the @p node.
758 */
759struct lyd_node *lyd_child_no_keys(const struct lyd_node *node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200760
761/**
Michal Vaskoc193ce92020-03-06 11:04:48 +0100762 * @brief Get the owner module of the data node. It is the module of the top-level schema node. Generally,
763 * in case of augments it is the target module, recursively, otherwise it is the module where the data node is defined.
764 *
Michal Vaskofcdf3012020-11-23 16:57:03 +0100765 * Also works for opaque nodes, if it is possible to resolve the module.
766 *
Michal Vaskoc193ce92020-03-06 11:04:48 +0100767 * @param[in] node Data node to examine.
768 * @return Module owner of the node.
769 */
770const struct lys_module *lyd_owner_module(const struct lyd_node *node);
771
772/**
Radek Krejci19611252020-10-04 13:54:53 +0200773 * @brief Check whether a node value equals to its default one.
774 *
775 * @param[in] node Term node to test.
776 * @return false (no, it is not a default node) or true (yes, it is default)
777 */
778ly_bool lyd_is_default(const struct lyd_node *node);
779
780/**
Radek Krejcica989142020-11-05 11:32:22 +0100781 * @brief Learn the relative position of a list or leaf-list instance within other instances of the same schema node.
782 *
783 * @param[in] instance List or leaf-list instance to get the position of.
784 * return 0 on error.
785 * return Positive integer of the @p instance position.
786 */
787uint32_t lyd_list_pos(const struct lyd_node *instance);
788
789/**
Radek Krejci4233f9b2020-11-05 12:38:35 +0100790 * @brief Get the first sibling of the given node.
791 *
792 * @param[in] node Node which first sibling is going to be the result.
793 * @return The first sibling of the given node or the node itself if it is the first child of the parent.
794 */
Michal Vasko6ae16d62020-11-06 17:23:23 +0100795struct lyd_node *lyd_first_sibling(const struct lyd_node *node);
Radek Krejci4233f9b2020-11-05 12:38:35 +0100796
797/**
Michal Vasko60ea6352020-06-29 13:39:39 +0200798 * @brief Learn the length of LYB data.
799 *
800 * @param[in] data LYB data to examine.
801 * @return Length of the LYB data chunk,
802 * @return -1 on error.
803 */
804int lyd_lyb_data_length(const char *data);
805
806/**
Michal Vaskoc0004272020-08-06 08:32:34 +0200807 * @brief Copy anydata value from one node to another. Target value is freed first.
808 *
809 * @param[in,out] trg Target node.
810 * @param[in] value Source value, may be NULL when the target value is only freed.
811 * @param[in] value_type Source value type.
812 * @return LY_ERR value.
813 */
814LY_ERR lyd_any_copy_value(struct lyd_node *trg, const union lyd_any_value *value, LYD_ANYDATA_VALUETYPE value_type);
815
816/**
Michal Vasko00cbf532020-06-15 13:58:47 +0200817 * @brief Create a new inner node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +0100818 *
819 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vaskof03ed032020-03-04 13:31:44 +0100820 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +0100821 * @param[in] name Schema node name of the new data node. The node can be #LYS_CONTAINER, #LYS_NOTIF, #LYS_RPC, or #LYS_ACTION.
Radek Krejci41ac9942020-11-02 14:47:56 +0100822 * @param[in] output Flag in case the @p parent is RPC/Action. If value is 0, the input's data nodes of the RPC/Action are
823 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200824 * @param[out] node Optional created node.
825 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +0100826 */
Radek Krejci41ac9942020-11-02 14:47:56 +0100827LY_ERR lyd_new_inner(struct lyd_node *parent, const struct lys_module *module, const char *name, ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +0100828
829/**
Michal Vasko00cbf532020-06-15 13:58:47 +0200830 * @brief Create a new list node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +0100831 *
832 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vaskof03ed032020-03-04 13:31:44 +0100833 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +0100834 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
Radek Krejci41ac9942020-11-02 14:47:56 +0100835 * @param[in] output Flag in case the @p parent is RPC/Action. If value is 0, the input's data nodes of the RPC/Action are
836 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200837 * @param[out] node Optional created node.
Michal Vasko013a8182020-03-03 10:46:53 +0100838 * @param[in] ... Ordered key values of the new list instance, all must be set. In case of an instance-identifier
Michal Vasko004d3152020-06-11 19:59:22 +0200839 * or identityref value, the JSON format is expected (module names instead of prefixes). No keys are expected for
840 * key-less lists.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200841 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +0100842 */
Radek Krejci41ac9942020-11-02 14:47:56 +0100843LY_ERR lyd_new_list(struct lyd_node *parent, const struct lys_module *module, const char *name, ly_bool output, struct lyd_node **node, ...);
Michal Vasko013a8182020-03-03 10:46:53 +0100844
845/**
Michal Vasko00cbf532020-06-15 13:58:47 +0200846 * @brief Create a new list node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +0100847 *
848 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vaskof03ed032020-03-04 13:31:44 +0100849 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +0100850 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
851 * @param[in] keys All key values predicate in the form of "[key1='val1'][key2='val2']...", they do not have to be ordered.
852 * In case of an instance-identifier or identityref value, the JSON format is expected (module names instead of prefixes).
Michal Vasko004d3152020-06-11 19:59:22 +0200853 * Use NULL or string of length 0 in case of key-less list.
Radek Krejci41ac9942020-11-02 14:47:56 +0100854 * @param[in] output Flag in case the @p parent is RPC/Action. If value is 0, the input's data nodes of the RPC/Action are
855 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200856 * @param[out] node Optional created node.
857 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +0100858 */
Michal Vasko3a41dff2020-07-15 14:30:28 +0200859LY_ERR lyd_new_list2(struct lyd_node *parent, const struct lys_module *module, const char *name, const char *keys,
Radek Krejci41ac9942020-11-02 14:47:56 +0100860 ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +0100861
862/**
Michal Vasko00cbf532020-06-15 13:58:47 +0200863 * @brief Create a new term node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +0100864 *
865 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vaskof03ed032020-03-04 13:31:44 +0100866 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +0100867 * @param[in] name Schema node name of the new data node. The node can be #LYS_LEAF or #LYS_LEAFLIST.
868 * @param[in] val_str String form of the value of the node being created. In case of an instance-identifier or identityref
869 * value, the JSON format is expected (module names instead of prefixes).
Radek Krejci41ac9942020-11-02 14:47:56 +0100870 * @param[in] output Flag in case the @p parent is RPC/Action. If value is 0, the input's data nodes of the RPC/Action are
871 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200872 * @param[out] node Optional created node.
873 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +0100874 */
Michal Vasko3a41dff2020-07-15 14:30:28 +0200875LY_ERR lyd_new_term(struct lyd_node *parent, const struct lys_module *module, const char *name, const char *val_str,
Radek Krejci41ac9942020-11-02 14:47:56 +0100876 ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +0100877
878/**
Michal Vasko00cbf532020-06-15 13:58:47 +0200879 * @brief Create a new any node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +0100880 *
881 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vaskof03ed032020-03-04 13:31:44 +0100882 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +0100883 * @param[in] name Schema node name of the new data node. The node can be #LYS_ANYDATA or #LYS_ANYXML.
884 * @param[in] value Value to be directly assigned to the node. Expected type is determined by @p value_type.
885 * @param[in] value_type Type of the provided value in @p value.
Radek Krejci41ac9942020-11-02 14:47:56 +0100886 * @param[in] output Flag in case the @p parent is RPC/Action. If value is 0, the input's data nodes of the RPC/Action are
887 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200888 * @param[out] node Optional created node.
889 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +0100890 */
Michal Vasko219006c2020-12-04 16:26:52 +0100891LY_ERR lyd_new_any(struct lyd_node *parent, const struct lys_module *module, const char *name, void *value,
Radek Krejci41ac9942020-11-02 14:47:56 +0100892 LYD_ANYDATA_VALUETYPE value_type, ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +0100893
894/**
Michal Vasko871a0252020-11-11 18:35:24 +0100895 * @brief Create new metadata.
Michal Vaskod86997b2020-05-26 15:19:54 +0200896 *
Michal Vasko871a0252020-11-11 18:35:24 +0100897 * @param[in] ctx libyang context,
898 * @param[in] parent Optional parent node for the metadata being created. Must be set if @p meta is NULL.
Michal Vasko00cbf532020-06-15 13:58:47 +0200899 * @param[in] module Module of the metadata being created. If NULL, @p name must include module name as the prefix.
Michal Vaskod86997b2020-05-26 15:19:54 +0200900 * @param[in] name Annotation name of the new metadata. It can include the annotation module as the prefix.
901 * If the prefix is specified it is always used but if not specified, @p module must be set.
Michal Vasko00cbf532020-06-15 13:58:47 +0200902 * @param[in] val_str String form of the value of the metadata. In case of an instance-identifier or identityref
Michal Vaskod86997b2020-05-26 15:19:54 +0200903 * value, the JSON format is expected (module names instead of prefixes).
Michal Vasko871a0252020-11-11 18:35:24 +0100904 * @param[in] clear_dflt Whether to clear the default flag starting from @p parent, recursively all NP containers.
905 * @param[out] meta Optional created metadata. Must be set if @p parent is NULL.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200906 * @return LY_ERR value.
Michal Vaskod86997b2020-05-26 15:19:54 +0200907 */
Michal Vasko871a0252020-11-11 18:35:24 +0100908LY_ERR lyd_new_meta(const struct ly_ctx *ctx, struct lyd_node *parent, const struct lys_module *module, const char *name,
909 const char *val_str, ly_bool clear_dflt, struct lyd_meta **meta);
Michal Vaskod86997b2020-05-26 15:19:54 +0200910
911/**
Michal Vaskoba696702020-11-11 19:12:45 +0100912 * @brief Create new metadata from an opaque node attribute if possible.
913 *
914 * @param[in] ctx libyang context.
915 * @param[in] parent Optional parent node for the metadata being created. Must be set if @p meta is NULL.
916 * @param[in] clear_dflt Whether to clear the default flag starting from @p parent, recursively all NP containers.
917 * @param[in] attr Opaque node attribute to parse into metadata.
918 * @param[out] meta Optional created metadata. Must be set if @p parent is NULL.
919 * @return LY_SUCCESS on success.
920 * @return LY_ENOT if the attribute could not be parsed into any metadata.
921 * @return LY_ERR on error.
922 */
923LY_ERR lyd_new_meta2(const struct ly_ctx *ctx, struct lyd_node *parent, ly_bool clear_dflt, const struct lyd_attr *attr,
924 struct lyd_meta **meta);
925
926/**
Michal Vasko00cbf532020-06-15 13:58:47 +0200927 * @brief Create a new opaque node in the data tree.
928 *
929 * @param[in] parent Parent node for the node beaing created. NULL in case of creating a top level element.
930 * @param[in] ctx libyang context. If NULL, @p parent context will be used.
931 * @param[in] name Node name.
932 * @param[in] value Node value, may be NULL.
933 * @param[in] module_name Node module name.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200934 * @param[out] node Optional created node.
935 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +0200936 */
Michal Vasko3a41dff2020-07-15 14:30:28 +0200937LY_ERR lyd_new_opaq(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value,
Radek Krejci0f969882020-08-21 16:56:47 +0200938 const char *module_name, struct lyd_node **node);
Michal Vasko00cbf532020-06-15 13:58:47 +0200939
940/**
941 * @brief Create new attribute for an opaque data node.
942 *
943 * @param[in] parent Parent opaque node for the attribute being created.
Radek Krejci8678fa42020-08-18 16:07:28 +0200944 * @param[in] module_name Name of the module of the attribute being created. There may be none.
Michal Vasko00cbf532020-06-15 13:58:47 +0200945 * @param[in] name Attribute name. It can include the module name as the prefix.
946 * @param[in] val_str String value of the attribute. Is stored directly.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200947 * @param[out] attr Optional created attribute.
948 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +0200949 */
Michal Vasko3a41dff2020-07-15 14:30:28 +0200950LY_ERR lyd_new_attr(struct lyd_node *parent, const char *module_name, const char *name, const char *val_str,
Radek Krejci0f969882020-08-21 16:56:47 +0200951 struct lyd_attr **attr);
Michal Vasko00cbf532020-06-15 13:58:47 +0200952
953/**
Michal Vasko00cbf532020-06-15 13:58:47 +0200954 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +0200955 * @defgroup pathoptions Data path creation options
Michal Vasko00cbf532020-06-15 13:58:47 +0200956 *
957 * Various options to change lyd_new_path*() behavior.
958 *
959 * Default behavior:
960 * - if the target node already exists (and is not default), an error is returned.
961 * - the whole path to the target node is created (with any missing parents) if necessary.
962 * - RPC output schema children are completely ignored in all modules. Input is searched and nodes created normally.
963 * @{
964 */
965
Radek Krejci092e33c2020-10-12 15:33:10 +0200966#define LYD_NEW_PATH_UPDATE 0x01 /**< If the target node exists, is a leaf, and it is updated with a new value or its
967 default flag is changed, it is returned. If the target node exists and is not
968 a leaf or generally no change occurs in the @p parent tree, NULL is returned and
969 no error set. */
970#define LYD_NEW_PATH_OUTPUT 0x02 /**< Changes the behavior to ignoring RPC/action input schema nodes and using only
971 output ones. */
972#define LYD_NEW_PATH_OPAQ 0x04 /**< Enables the creation of opaque nodes with some specific rules. If the __last node__
973 in the path is not uniquely defined ((leaf-)list without a predicate) or has an
974 invalid value (leaf/leaf-list), it is created as opaque. */
Michal Vasko00cbf532020-06-15 13:58:47 +0200975
976/** @} pathoptions */
977
978/**
979 * @brief Create a new node in the data tree based on a path. Cannot be used for anyxml/anydata nodes,
Michal Vasko493900b2020-12-08 10:23:41 +0100980 * for those use ::lyd_new_path2.
Michal Vasko00cbf532020-06-15 13:58:47 +0200981 *
982 * If @p path points to a list key and the list instance does not exist, the key value from the predicate is used
983 * and @p value is ignored. Also, if a leaf-list is being created and both a predicate is defined in @p path
984 * and @p value is set, the predicate is preferred.
985 *
Michal Vasko104fe962020-11-06 17:23:44 +0100986 * @param[in] parent Data parent to add to/modify, can be NULL. Note that in case a first top-level sibling is used,
987 * it may no longer be first if @p path is absolute and starts with a non-existing top-level node inserted
988 * before @p parent. Use ::lyd_first_sibling() to adjust @p parent in these cases.
Michal Vasko00cbf532020-06-15 13:58:47 +0200989 * @param[in] ctx libyang context, must be set if @p parent is NULL.
Michal Vasko104fe962020-11-06 17:23:44 +0100990 * @param[in] path [Path](@ref howtoXPath) to create.
Michal Vasko00cbf532020-06-15 13:58:47 +0200991 * @param[in] value Value of the new leaf/leaf-list. For other node types, it is ignored.
992 * @param[in] options Bitmask of options, see @ref pathoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +0200993 * @param[out] node Optional first created node.
994 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +0200995 */
Michal Vasko3a41dff2020-07-15 14:30:28 +0200996LY_ERR lyd_new_path(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const char *value,
Radek Krejci1deb5be2020-08-26 16:43:36 +0200997 uint32_t options, struct lyd_node **node);
Michal Vasko00cbf532020-06-15 13:58:47 +0200998
999/**
1000 * @brief Create a new node in the data tree based on a path. All node types can be created.
1001 *
1002 * If @p path points to a list key and the list instance does not exist, the key value from the predicate is used
1003 * and @p value is ignored. Also, if a leaf-list is being created and both a predicate is defined in @p path
1004 * and @p value is set, the predicate is preferred.
1005 *
Michal Vasko104fe962020-11-06 17:23:44 +01001006 * @param[in] parent Data parent to add to/modify, can be NULL. Note that in case a first top-level sibling is used,
1007 * it may no longer be first if @p path is absolute and starts with a non-existing top-level node inserted
1008 * before @p parent. Use ::lyd_first_sibling() to adjust @p parent in these cases.
Michal Vasko00cbf532020-06-15 13:58:47 +02001009 * @param[in] ctx libyang context, must be set if @p parent is NULL.
Michal Vasko104fe962020-11-06 17:23:44 +01001010 * @param[in] path [Path](@ref howtoXPath) to create.
Michal Vasko00cbf532020-06-15 13:58:47 +02001011 * @param[in] value Value of the new leaf/leaf-list/anyxml/anydata. For other node types, it is ignored.
1012 * @param[in] value_type Anyxml/anydata node @p value type.
1013 * @param[in] options Bitmask of options, see @ref pathoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001014 * @param[out] new_parent Optional first parent node created. If only one node was created, equals to @p new_node.
1015 * @param[out] new_node Optional last node created.
Michal Vasko00cbf532020-06-15 13:58:47 +02001016 * @return LY_ERR value.
1017 */
1018LY_ERR lyd_new_path2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const void *value,
Radek Krejci1deb5be2020-08-26 16:43:36 +02001019 LYD_ANYDATA_VALUETYPE value_type, uint32_t options, struct lyd_node **new_parent, struct lyd_node **new_node);
Michal Vasko00cbf532020-06-15 13:58:47 +02001020
1021/**
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001022 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001023 * @defgroup implicitoptions Implicit node creation options
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001024 *
1025 * Various options to change lyd_new_implicit*() behavior.
1026 *
1027 * Default behavior:
1028 * - both configuration and state missing implicit nodes are added.
Michal Vasko630d9892020-12-08 17:11:08 +01001029 * - for existing RPC/action nodes, input implicit nodes are added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001030 * - all implicit node types are added (non-presence containers, default leaves, and default leaf-lists).
1031 * @{
1032 */
1033
Michal Vasko44b19a12020-08-07 09:21:30 +02001034#define LYD_IMPLICIT_NO_STATE 0x01 /**< Do not add any implicit state nodes. */
1035#define LYD_IMPLICIT_NO_CONFIG 0x02 /**< Do not add any implicit config nodes. */
Michal Vasko630d9892020-12-08 17:11:08 +01001036#define LYD_IMPLICIT_OUTPUT 0x04 /**< For RPC/action nodes, add output implicit nodes instead of input. */
1037#define LYD_IMPLICIT_NO_DEFAULTS 0x08 /**< Do not add any default nodes (leaves/leaf-lists), only non-presence
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001038 containers. */
1039
1040/** @} implicitoptions */
1041
1042/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001043 * @brief Add any missing implicit nodes into a data subtree. Default nodes with a false "when" are not added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001044 *
1045 * @param[in] tree Tree to add implicit nodes into.
1046 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1047 * @param[out] diff Optional diff with any created nodes.
1048 * @return LY_ERR value.
1049 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001050LY_ERR lyd_new_implicit_tree(struct lyd_node *tree, uint32_t implicit_options, struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001051
1052/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001053 * @brief Add any missing implicit nodes. Default nodes with a false "when" are not added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001054 *
Michal Vaskod3bb12f2020-12-04 14:33:09 +01001055 * @param[in,out] tree Tree to add implicit nodes into. Note that in case a first top-level sibling is used,
1056 * it may no longer be first if an implicit node was inserted before @p tree. Use ::lyd_first_sibling() to
1057 * adjust @p tree in these cases.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001058 * @param[in] ctx libyang context, must be set only if @p tree is an empty tree.
1059 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1060 * @param[out] diff Optional diff with any created nodes.
1061 * @return LY_ERR value.
1062 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001063LY_ERR lyd_new_implicit_all(struct lyd_node **tree, const struct ly_ctx *ctx, uint32_t implicit_options, struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001064
1065/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001066 * @brief Add any missing implicit nodes of one module. Default nodes with a false "when" are not added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001067 *
Michal Vaskod3bb12f2020-12-04 14:33:09 +01001068 * @param[in,out] tree Tree to add implicit nodes into. Note that in case a first top-level sibling is used,
1069 * it may no longer be first if an implicit node was inserted before @p tree. Use ::lyd_first_sibling() to
1070 * adjust @p tree in these cases.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001071 * @param[in] module Module whose implicit nodes to create.
1072 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1073 * @param[out] diff Optional diff with any created nodes.
1074 * @return LY_ERR value.
1075 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001076LY_ERR lyd_new_implicit_module(struct lyd_node **tree, const struct lys_module *module, uint32_t implicit_options,
Radek Krejci0f969882020-08-21 16:56:47 +02001077 struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001078
1079/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001080 * @brief Change the value of a term (leaf or leaf-list) node.
1081 *
1082 * Node changed this way is always considered explicitly set, meaning its default flag
1083 * is always cleared.
1084 *
1085 * @param[in] term Term node to change.
1086 * @param[in] val_str New value to set, any prefixes are expected in JSON format.
1087 * @return LY_SUCCESS if value was changed,
1088 * @return LY_EEXIST if value was the same and only the default flag was cleared,
1089 * @return LY_ENOT if the values were equal and no change occured,
1090 * @return LY_ERR value on other errors.
1091 */
1092LY_ERR lyd_change_term(struct lyd_node *term, const char *val_str);
1093
1094/**
Michal Vasko41586352020-07-13 13:54:25 +02001095 * @brief Change the value of a metadata instance.
1096 *
Michal Vasko41586352020-07-13 13:54:25 +02001097 * @param[in] meta Metadata to change.
1098 * @param[in] val_str New value to set, any prefixes are expected in JSON format.
1099 * @return LY_SUCCESS if value was changed,
1100 * @return LY_ENOT if the values were equal and no change occured,
1101 * @return LY_ERR value on other errors.
1102 */
1103LY_ERR lyd_change_meta(struct lyd_meta *meta, const char *val_str);
1104
1105/**
Michal Vaskob104f112020-07-17 09:54:54 +02001106 * @brief Insert a child into a parent.
Michal Vaskof03ed032020-03-04 13:31:44 +01001107 *
1108 * - if the node is part of some other tree, it is automatically unlinked.
1109 * - if the node is the first node of a node list (with no parent), all the subsequent nodes are also inserted.
1110 *
1111 * @param[in] parent Parent node to insert into.
1112 * @param[in] node Node to insert.
1113 * @return LY_SUCCESS on success.
1114 * @return LY_ERR error on error.
1115 */
Michal Vaskob104f112020-07-17 09:54:54 +02001116LY_ERR lyd_insert_child(struct lyd_node *parent, struct lyd_node *node);
Michal Vaskof03ed032020-03-04 13:31:44 +01001117
1118/**
Michal Vaskob104f112020-07-17 09:54:54 +02001119 * @brief Insert a node into siblings.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001120 *
1121 * - if the node is part of some other tree, it is automatically unlinked.
1122 * - if the node is the first node of a node list (with no parent), all the subsequent nodes are also inserted.
1123 *
Michal Vaskob104f112020-07-17 09:54:54 +02001124 * @param[in] sibling Siblings to insert into, can even be NULL.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001125 * @param[in] node Node to insert.
Michal Vaskob104f112020-07-17 09:54:54 +02001126 * @param[out] first Optionally return the first sibling after insertion. Can be the address of @p sibling.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001127 * @return LY_SUCCESS on success.
1128 * @return LY_ERR error on error.
1129 */
Michal Vaskob104f112020-07-17 09:54:54 +02001130LY_ERR lyd_insert_sibling(struct lyd_node *sibling, struct lyd_node *node, struct lyd_node **first);
Michal Vaskob1b5c262020-03-05 14:29:47 +01001131
1132/**
Michal Vaskob104f112020-07-17 09:54:54 +02001133 * @brief Insert a node before another node, can be used only for user-ordered nodes.
Michal Vasko4bc2ce32020-12-08 10:06:16 +01001134 * If inserting several siblings, each of them must be inserted individually.
Michal Vaskof03ed032020-03-04 13:31:44 +01001135 *
1136 * - if the node is part of some other tree, it is automatically unlinked.
Michal Vaskof03ed032020-03-04 13:31:44 +01001137 *
1138 * @param[in] sibling Sibling node to insert before.
1139 * @param[in] node Node to insert.
1140 * @return LY_SUCCESS on success.
1141 * @return LY_ERR error on error.
1142 */
1143LY_ERR lyd_insert_before(struct lyd_node *sibling, struct lyd_node *node);
1144
1145/**
Michal Vaskob104f112020-07-17 09:54:54 +02001146 * @brief Insert a node after another node, can be used only for user-ordered nodes.
Michal Vasko4bc2ce32020-12-08 10:06:16 +01001147 * If inserting several siblings, each of them must be inserted individually.
Michal Vaskof03ed032020-03-04 13:31:44 +01001148 *
1149 * - if the node is part of some other tree, it is automatically unlinked.
Michal Vaskof03ed032020-03-04 13:31:44 +01001150 *
1151 * @param[in] sibling Sibling node to insert after.
1152 * @param[in] node Node to insert.
1153 * @return LY_SUCCESS on success.
1154 * @return LY_ERR error on error.
1155 */
1156LY_ERR lyd_insert_after(struct lyd_node *sibling, struct lyd_node *node);
1157
1158/**
1159 * @brief Unlink the specified data subtree.
1160 *
1161 * @param[in] node Data tree node to be unlinked (together with all the children).
1162 */
1163void lyd_unlink_tree(struct lyd_node *node);
1164
1165/**
Radek Krejcib0849a22019-07-25 12:31:04 +02001166 * @brief Free all the nodes (even parents of the node) in the data tree.
Radek Krejcie7b95092019-05-15 11:03:07 +02001167 *
1168 * @param[in] node Any of the nodes inside the tree.
1169 */
1170void lyd_free_all(struct lyd_node *node);
1171
1172/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001173 * @brief Free all the sibling nodes (preceding as well as succeeding).
Radek Krejcib0849a22019-07-25 12:31:04 +02001174 *
1175 * @param[in] node Any of the sibling nodes to free.
1176 */
Michal Vaskof03ed032020-03-04 13:31:44 +01001177void lyd_free_siblings(struct lyd_node *node);
Radek Krejcib0849a22019-07-25 12:31:04 +02001178
1179/**
Radek Krejcie7b95092019-05-15 11:03:07 +02001180 * @brief Free (and unlink) the specified data (sub)tree.
1181 *
Radek Krejcie7b95092019-05-15 11:03:07 +02001182 * @param[in] node Root of the (sub)tree to be freed.
1183 */
1184void lyd_free_tree(struct lyd_node *node);
1185
1186/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001187 * @brief Free a single metadata instance.
Radek Krejcie7b95092019-05-15 11:03:07 +02001188 *
Michal Vasko3a41dff2020-07-15 14:30:28 +02001189 * @param[in] meta Metadata to free.
Radek Krejcie7b95092019-05-15 11:03:07 +02001190 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001191void lyd_free_meta_single(struct lyd_meta *meta);
Michal Vasko52927e22020-03-16 17:26:14 +01001192
1193/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001194 * @brief Free the metadata instance with any following instances.
1195 *
1196 * @param[in] meta Metadata to free.
1197 */
1198void lyd_free_meta_siblings(struct lyd_meta *meta);
1199
1200/**
1201 * @brief Free a single attribute.
Michal Vasko52927e22020-03-16 17:26:14 +01001202 *
1203 * @param[in] ctx Context where the attributes were created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001204 * @param[in] attr Attribute to free.
Michal Vasko52927e22020-03-16 17:26:14 +01001205 */
Radek Krejci011e4aa2020-09-04 15:22:31 +02001206void lyd_free_attr_single(const struct ly_ctx *ctx, struct lyd_attr *attr);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001207
1208/**
1209 * @brief Free the attribute with any following attributes.
1210 *
1211 * @param[in] ctx Context where the attributes were created.
1212 * @param[in] attr First attribute to free.
1213 */
Radek Krejci011e4aa2020-09-04 15:22:31 +02001214void lyd_free_attr_siblings(const struct ly_ctx *ctx, struct lyd_attr *attr);
Radek Krejcie7b95092019-05-15 11:03:07 +02001215
Radek Krejci084289f2019-07-09 17:35:30 +02001216/**
1217 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
1218 *
1219 * The given node is not modified in any way - it is just checked if the @p value can be set to the node.
1220 *
1221 * If there is no data node instance and you are fine with checking just the type's restrictions without the
Radek Krejci8678fa42020-08-18 16:07:28 +02001222 * data tree context (e.g. for the case of require-instance restriction), use ::lys_value_validate().
Radek Krejci084289f2019-07-09 17:35:30 +02001223 *
1224 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
1225 * @param[in] node Data node for the @p value.
Michal Vaskof937cfe2020-08-03 16:07:12 +02001226 * @param[in] value String value to be checked, it is expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02001227 * @param[in] value_len Length of the given @p value (mandatory).
Michal Vaskof03ed032020-03-04 13:31:44 +01001228 * @param[in] tree Data tree (e.g. when validating RPC/Notification) where the required data instance (leafref target,
1229 * instance-identifier) can be placed. NULL in case the data tree is not yet complete,
1230 * then LY_EINCOMPLETE can be returned.
Michal Vasko3701af52020-08-03 14:29:38 +02001231 * @param[out] realtype Optional real type of the value.
Radek Krejci084289f2019-07-09 17:35:30 +02001232 * @return LY_SUCCESS on success
1233 * @return LY_EINCOMPLETE in case the @p trees is not provided and it was needed to finish the validation (e.g. due to require-instance).
1234 * @return LY_ERR value if an error occurred.
1235 */
Michal Vasko44685da2020-03-17 15:38:06 +01001236LY_ERR lyd_value_validate(const struct ly_ctx *ctx, const struct lyd_node_term *node, const char *value, size_t value_len,
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001237 const struct lyd_node *tree, const struct lysc_type **realtype);
Radek Krejci084289f2019-07-09 17:35:30 +02001238
1239/**
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001240 * @brief Compare the node's value with the given string value. The string value is first validated according to
1241 * the (current) node's type.
Radek Krejci084289f2019-07-09 17:35:30 +02001242 *
1243 * @param[in] node Data node to compare.
1244 * @param[in] value String value to be compared. It does not need to be in a canonical form - as part of the process,
Michal Vaskof937cfe2020-08-03 16:07:12 +02001245 * it is validated and canonized if possible. But it is expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02001246 * @param[in] value_len Length of the given @p value (mandatory).
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001247 * @return LY_SUCCESS on success,
1248 * @return LY_ENOT if the values do not match,
Radek Krejci084289f2019-07-09 17:35:30 +02001249 * @return LY_ERR value if an error occurred.
1250 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001251LY_ERR lyd_value_compare(const struct lyd_node_term *node, const char *value, size_t value_len);
Radek Krejci084289f2019-07-09 17:35:30 +02001252
Radek Krejci576b23f2019-07-12 14:06:32 +02001253/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001254 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001255 * @defgroup datacompareoptions Data compare options
1256 * @{
1257 * Various options to change the ::lyd_compare_single() and ::lyd_compare_siblings() behavior.
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001258 */
1259#define LYD_COMPARE_FULL_RECURSION 0x01 /* lists and containers are the same only in case all they children
1260 (subtree, so direct as well as indirect children) are the same. By default,
1261 containers are the same in case of the same schema node and lists are the same
1262 in case of equal keys (keyless lists do the full recursion comparison all the time). */
1263#define LYD_COMPARE_DEFAULTS 0x02 /* By default, implicit and explicit default nodes are considered to be equal. This flag
1264 changes this behavior and implicit (automatically created default node) and explicit
1265 (explicitly created node with the default value) default nodes are considered different. */
Michal Vasko60ea6352020-06-29 13:39:39 +02001266/** @} datacompareoptions */
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001267
1268/**
1269 * @brief Compare 2 data nodes if they are equivalent.
1270 *
1271 * @param[in] node1 The first node to compare.
1272 * @param[in] node2 The second node to compare.
Radek Krejcic5ad9652019-09-11 11:31:51 +02001273 * @param[in] options Various @ref datacompareoptions.
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001274 * @return LY_SUCCESS if the nodes are equivalent.
1275 * @return LY_ENOT if the nodes are not equivalent.
1276 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001277LY_ERR lyd_compare_single(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
Michal Vasko8f359bf2020-07-28 10:41:15 +02001278
1279/**
1280 * @brief Compare 2 lists of siblings if they are equivalent.
1281 *
1282 * @param[in] node1 The first sibling list to compare.
1283 * @param[in] node2 The second sibling list to compare.
1284 * @param[in] options Various @ref datacompareoptions.
1285 * @return LY_SUCCESS if all the siblings are equivalent.
1286 * @return LY_ENOT if the siblings are not equivalent.
1287 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001288LY_ERR lyd_compare_siblings(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001289
1290/**
Michal Vasko21725742020-06-29 11:49:25 +02001291 * @brief Compare 2 metadata.
1292 *
1293 * @param[in] meta1 First metadata.
1294 * @param[in] meta2 Second metadata.
1295 * @return LY_SUCCESS if the metadata are equivalent.
1296 * @return LY_ENOT if not.
1297 */
1298LY_ERR lyd_compare_meta(const struct lyd_meta *meta1, const struct lyd_meta *meta2);
1299
1300/**
Radek Krejci22ebdba2019-07-25 13:59:43 +02001301 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001302 * @defgroup dupoptions Data duplication options
Radek Krejci22ebdba2019-07-25 13:59:43 +02001303 *
Radek Krejci8678fa42020-08-18 16:07:28 +02001304 * Various options to change ::lyd_dup_single(), ::lyd_dup_siblings() and ::lyd_dup_meta_single() behavior.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001305 *
1306 * Default behavior:
1307 * - only the specified node is duplicated without siblings, parents, or children.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001308 * - all the metadata of the duplicated nodes are also duplicated.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001309 * @{
1310 */
1311
1312#define LYD_DUP_RECURSIVE 0x01 /**< Duplicate not just the node but also all the children. Note that
1313 list's keys are always duplicated. */
Michal Vaskoa29a5762020-06-23 13:28:49 +02001314#define LYD_DUP_NO_META 0x02 /**< Do not duplicate metadata of any node. */
Radek Krejci22ebdba2019-07-25 13:59:43 +02001315#define LYD_DUP_WITH_PARENTS 0x04 /**< If a nested node is being duplicated, duplicate also all the parents.
1316 Keys are also duplicated for lists. Return value does not change! */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001317#define LYD_DUP_WITH_FLAGS 0x08 /**< Also copy any data node flags. That will cause the duplicated data to preserve
Michal Vaskof6df0a02020-06-16 13:08:34 +02001318 its validation/default node state. */
Radek Krejci22ebdba2019-07-25 13:59:43 +02001319
1320/** @} dupoptions */
1321
1322/**
1323 * @brief Create a copy of the specified data tree \p node. Schema references are kept the same.
1324 *
Radek Krejci22ebdba2019-07-25 13:59:43 +02001325 * @param[in] node Data tree node to be duplicated.
1326 * @param[in] parent Optional parent node where to connect the duplicated node(s).
Michal Vasko3a41dff2020-07-15 14:30:28 +02001327 * If set in combination with LYD_DUP_WITH_PARENTS, the parents chain is duplicated until it comes to and connects with
1328 * the @p parent.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001329 * @param[in] options Bitmask of options flags, see @ref dupoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001330 * @param[out] dup Optional created copy of the node. Note that in case the parents chain is duplicated for the duplicated
1331 * node(s) (when LYD_DUP_WITH_PARENTS used), the first duplicated node is still returned.
1332 * @return LY_ERR value.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001333 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001334LY_ERR lyd_dup_single(const struct lyd_node *node, struct lyd_node_inner *parent, uint32_t options, struct lyd_node **dup);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001335
1336/**
1337 * @brief Create a copy of the specified data tree \p node with any following siblings. Schema references are kept the same.
1338 *
1339 * @param[in] node Data tree node to be duplicated.
1340 * @param[in] parent Optional parent node where to connect the duplicated node(s).
1341 * If set in combination with LYD_DUP_WITH_PARENTS, the parents chain is duplicated until it comes to and connects with
1342 * the @p parent.
1343 * @param[in] options Bitmask of options flags, see @ref dupoptions.
1344 * @param[out] dup Optional created copy of the node. Note that in case the parents chain is duplicated for the duplicated
1345 * node(s) (when LYD_DUP_WITH_PARENTS used), the first duplicated node is still returned.
1346 * @return LY_ERR value.
1347 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001348LY_ERR lyd_dup_siblings(const struct lyd_node *node, struct lyd_node_inner *parent, uint32_t options, struct lyd_node **dup);
Radek Krejci22ebdba2019-07-25 13:59:43 +02001349
1350/**
Michal Vasko25a32822020-07-09 15:48:22 +02001351 * @brief Create a copy of the metadata.
1352 *
1353 * @param[in] meta Metadata to copy.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001354 * @param[in] parent Node where to append the new metadata.
1355 * @param[out] dup Optional created metadata copy.
1356 * @return LY_ERR value.
Michal Vasko25a32822020-07-09 15:48:22 +02001357 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001358LY_ERR lyd_dup_meta_single(const struct lyd_meta *meta, struct lyd_node *parent, struct lyd_meta **dup);
Michal Vasko25a32822020-07-09 15:48:22 +02001359
1360/**
Michal Vasko4490d312020-06-16 13:08:55 +02001361 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001362 * @defgroup mergeoptions Data merge options.
Radek Krejci576b23f2019-07-12 14:06:32 +02001363 *
Radek Krejci8678fa42020-08-18 16:07:28 +02001364 * Various options to change ::lyd_merge_tree() and ::lyd_merge_siblings() behavior.
Michal Vasko4490d312020-06-16 13:08:55 +02001365 *
1366 * Default behavior:
1367 * - source data tree is not modified in any way,
Michal Vasko3a41dff2020-07-15 14:30:28 +02001368 * - any default nodes in the source are ignored if there are explicit nodes in the target.
Michal Vasko4490d312020-06-16 13:08:55 +02001369 * @{
1370 */
1371
1372#define LYD_MERGE_DESTRUCT 0x01 /**< Spend source data tree in the function, it cannot be used afterwards! */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001373#define LYD_MERGE_DEFAULTS 0x02 /**< Default nodes in the source tree replace even explicit nodes in the target. */
Michal Vasko4490d312020-06-16 13:08:55 +02001374
1375/** @} mergeoptions */
1376
1377/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001378 * @brief Merge the source data subtree into the target data tree. Merge may not be complete until validation
Michal Vasko4490d312020-06-16 13:08:55 +02001379 * is called on the resulting data tree (data from more cases may be present, default and non-default values).
1380 *
Michal Vasko2f510942020-11-13 10:26:25 +01001381 * Example input:
1382 *
1383 * source (A1) - A2 - A3 target (B1) - B2 - B3
1384 * /\ /\ /\ /\ /\ /\
1385 * .... .... .... .... .... ....
1386 *
1387 * result target (A1) - B1 - B2 - B3
1388 * /\ /\ /\ /\
1389 * .... .... .... ....
1390 *
Michal Vasko4490d312020-06-16 13:08:55 +02001391 * @param[in,out] target Target data tree to merge into, must be a top-level tree.
1392 * @param[in] source Source data tree to merge, must be a top-level tree.
1393 * @param[in] options Bitmask of option flags, see @ref mergeoptions.
1394 * @return LY_SUCCESS on success,
1395 * @return LY_ERR value on error.
1396 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001397LY_ERR lyd_merge_tree(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001398
1399/**
1400 * @brief Merge the source data tree with any following siblings into the target data tree. Merge may not be
1401 * complete until validation called on the resulting data tree (data from more cases may be present, default
1402 * and non-default values).
1403 *
Michal Vasko2f510942020-11-13 10:26:25 +01001404 * Example input:
1405 *
1406 * source (A1) - A2 - A3 target (B1) - B2 - B3
1407 * /\ /\ /\ /\ /\ /\
1408 * .... .... .... .... .... ....
1409 *
1410 * result target (A1) - A2 - A3 - B1 - B2 - B3
1411 * /\ /\ /\ /\ /\ /\
1412 * .... .... .... .... .... ....
1413 *
Michal Vasko3a41dff2020-07-15 14:30:28 +02001414 * @param[in,out] target Target data tree to merge into, must be a top-level tree.
1415 * @param[in] source Source data tree to merge, must be a top-level tree.
1416 * @param[in] options Bitmask of option flags, see @ref mergeoptions.
1417 * @return LY_SUCCESS on success,
1418 * @return LY_ERR value on error.
1419 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001420LY_ERR lyd_merge_siblings(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
Michal Vasko4490d312020-06-16 13:08:55 +02001421
1422/**
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001423 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001424 * @defgroup diffoptions Data diff options.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001425 *
Radek Krejci8678fa42020-08-18 16:07:28 +02001426 * Various options to change ::lyd_diff_tree() and ::lyd_diff_siblings() behavior.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001427 *
1428 * Default behavior:
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001429 * - any default nodes are treated as non-existent and ignored.
1430 * @{
1431 */
1432
Michal Vasko3a41dff2020-07-15 14:30:28 +02001433#define LYD_DIFF_DEFAULTS 0x01 /**< Default nodes in the trees are not ignored but treated similarly to explicit
1434 nodes. Also, leaves and leaf-lists are added into diff even in case only their
1435 default flag (state) was changed. */
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001436
1437/** @} diffoptions */
1438
1439/**
1440 * @brief Learn the differences between 2 data trees.
1441 *
1442 * The resulting diff is represented as a data tree with specific metadata from the internal 'yang'
1443 * module. Most importantly, every node has an effective 'operation' metadata. If there is none
1444 * defined on the node, it inherits the operation from the nearest parent. Top-level nodes must
1445 * always have the 'operation' metadata defined. Additional metadata ('orig-default', 'value',
1446 * 'orig-value', 'key', 'orig-key') are used for storing more information about the value in the first
1447 * or the second tree.
1448 *
1449 * The diff tree is completely independent on the @p first and @p second trees, meaning all
1450 * the information about the change is stored in the diff and the trees are not needed.
1451 *
1452 * !! Caution !!
1453 * The diff tree should never be validated because it may easily not be valid! For example,
1454 * when data from one case branch are deleted and data from another branch created - data from both
1455 * branches are then stored in the diff tree simultaneously.
1456 *
1457 * @param[in] first First data tree.
1458 * @param[in] second Second data tree.
1459 * @param[in] options Bitmask of options flags, see @ref diffoptions.
1460 * @param[out] diff Generated diff.
1461 * @return LY_SUCCESS on success,
1462 * @return LY_ERR on error.
1463 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001464LY_ERR lyd_diff_tree(const struct lyd_node *first, const struct lyd_node *second, uint16_t options, struct lyd_node **diff);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001465
1466/**
1467 * @brief Learn the differences between 2 data trees including all the following siblings.
1468 *
1469 * @param[in] first First data tree.
1470 * @param[in] second Second data tree.
1471 * @param[in] options Bitmask of options flags, see @ref diffoptions.
1472 * @param[out] diff Generated diff.
1473 * @return LY_SUCCESS on success,
1474 * @return LY_ERR on error.
1475 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001476LY_ERR lyd_diff_siblings(const struct lyd_node *first, const struct lyd_node *second, uint16_t options, struct lyd_node **diff);
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001477
1478/**
1479 * @brief Callback for diff nodes.
1480 *
1481 * @param[in] diff_node Diff node.
1482 * @param[in] data_node Matching node in data.
1483 * @param[in] cb_data Arbitrary callback data.
1484 * @return LY_ERR value.
1485 */
1486typedef LY_ERR (*lyd_diff_cb)(const struct lyd_node *diff_node, struct lyd_node *data_node, void *cb_data);
1487
1488/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001489 * @brief Apply the whole diff on a data tree but restrict the operation to one module.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001490 *
1491 * @param[in,out] data Data to apply the diff on.
1492 * @param[in] diff Diff to apply.
1493 * @param[in] mod Module, whose diff/data only to consider, NULL for all modules.
1494 * @param[in] diff_cb Optional diff callback that will be called for every changed node.
1495 * @param[in] cb_data Arbitrary callback data.
1496 * @return LY_SUCCESS on success,
1497 * @return LY_ERR on error.
1498 */
1499LY_ERR lyd_diff_apply_module(struct lyd_node **data, const struct lyd_node *diff, const struct lys_module *mod,
Radek Krejci0f969882020-08-21 16:56:47 +02001500 lyd_diff_cb diff_cb, void *cb_data);
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001501
1502/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001503 * @brief Apply the whole diff tree on a data tree.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001504 *
1505 * @param[in,out] data Data to apply the diff on.
1506 * @param[in] diff Diff to apply.
1507 * @return LY_SUCCESS on success,
1508 * @return LY_ERR on error.
1509 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001510LY_ERR lyd_diff_apply_all(struct lyd_node **data, const struct lyd_node *diff);
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001511
1512/**
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001513 * @ingroup datatree
1514 * @defgroup diffmergeoptions Data diff merge options.
1515 *
1516 * Various options to change ::lyd_diff_merge_module(), ::lyd_diff_merge_tree(), and ::lyd_diff_merge_all() behavior.
1517 *
1518 * Default behavior:
1519 * - any default nodes are expected to be a result of validation corrections and not explicitly modified.
1520 * @{
1521 */
1522
1523#define LYD_DIFF_MERGE_DEFAULTS 0x01 /**< Default nodes in the diffs are treated as possibly explicitly modified. */
1524
1525/** @} diffoptions */
1526
1527/**
Michal Vaskoe6323f62020-07-09 15:49:02 +02001528 * @brief Merge 2 diffs into each other but restrict the operation to one module.
1529 *
1530 * The diffs must be possible to be merged, which is guaranteed only if the source diff was
1531 * created on data that had the target diff applied on them. In other words, this sequence is legal
1532 *
Michal Vasko04f85912020-08-07 12:14:58 +02001533 * 1) diff1 from data1 and data2 -> data11 from apply diff1 on data1 -> diff2 from data11 and data3 ->
1534 * -> data 33 from apply diff2 on data1
Michal Vaskoe6323f62020-07-09 15:49:02 +02001535 *
1536 * and reusing these diffs
1537 *
Michal Vasko04f85912020-08-07 12:14:58 +02001538 * 2) diff11 from merge diff1 and diff2 -> data33 from apply diff11 on data1
Michal Vaskoe6323f62020-07-09 15:49:02 +02001539 *
Michal Vaskofb737aa2020-08-06 13:53:53 +02001540 * @param[in,out] diff Target diff to merge into.
Michal Vaskoe6323f62020-07-09 15:49:02 +02001541 * @param[in] src_diff Source diff.
1542 * @param[in] mod Module, whose diff only to consider, NULL for all modules.
Michal Vaskoe2af8412020-12-03 14:11:38 +01001543 * @param[in] diff_cb Optional diff callback that will be called for every merged node. Param @p diff_node is the source
1544 * diff node while @p data_node is the updated target diff node. In case a whole subtree is added, the callback is
1545 * called on the root with @p diff_node being NULL.
Michal Vaskoe6323f62020-07-09 15:49:02 +02001546 * @param[in] cb_data Arbitrary callback data.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001547 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vaskoe6323f62020-07-09 15:49:02 +02001548 * @return LY_SUCCESS on success,
1549 * @return LY_ERR on error.
1550 */
Michal Vaskofb737aa2020-08-06 13:53:53 +02001551LY_ERR lyd_diff_merge_module(struct lyd_node **diff, const struct lyd_node *src_diff, const struct lys_module *mod,
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001552 lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
Michal Vaskoe6323f62020-07-09 15:49:02 +02001553
1554/**
Michal Vasko04f85912020-08-07 12:14:58 +02001555 * @brief Merge 2 diff trees into each other.
1556 *
1557 * @param[in,out] diff_first Target diff first sibling to merge into.
1558 * @param[in] diff_parent Target diff parent to merge into.
1559 * @param[in] src_sibling Source diff sibling to merge.
Michal Vaskoe2af8412020-12-03 14:11:38 +01001560 * @param[in] diff_cb Optional diff callback that will be called for every merged node. Param @p diff_node is the source
1561 * diff node while @p data_node is the updated target diff node. In case a whole subtree is added, the callback is
1562 * called on the root with @p diff_node being NULL.
Michal Vasko04f85912020-08-07 12:14:58 +02001563 * @param[in] cb_data Arbitrary callback data.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001564 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vasko04f85912020-08-07 12:14:58 +02001565 * @return LY_SUCCESS on success,
1566 * @return LY_ERR on error.
1567 */
1568LY_ERR lyd_diff_merge_tree(struct lyd_node **diff_first, struct lyd_node *diff_parent, const struct lyd_node *src_sibling,
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001569 lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
Michal Vasko04f85912020-08-07 12:14:58 +02001570
1571/**
Michal Vaskoe6323f62020-07-09 15:49:02 +02001572 * @brief Merge 2 diffs into each other.
1573 *
Michal Vaskoe6323f62020-07-09 15:49:02 +02001574 * @param[in,out] diff Target diff to merge into.
Michal Vaskofb737aa2020-08-06 13:53:53 +02001575 * @param[in] src_diff Source diff.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001576 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vaskoe6323f62020-07-09 15:49:02 +02001577 * @return LY_SUCCESS on success,
1578 * @return LY_ERR on error.
1579 */
Michal Vaskoc0e58e82020-11-11 19:04:33 +01001580LY_ERR lyd_diff_merge_all(struct lyd_node **diff, const struct lyd_node *src_diff, uint16_t options);
Michal Vaskoe6323f62020-07-09 15:49:02 +02001581
1582/**
Michal Vasko4231fb62020-07-13 13:54:47 +02001583 * @brief Reverse a diff and make the opposite changes. Meaning change create to delete, delete to create,
1584 * or move from place A to B to move from B to A and so on.
1585 *
1586 * @param[in] src_diff Diff to reverse.
1587 * @param[out] diff Reversed diff.
1588 * @return LY_SUCCESS on success.
1589 * @return LY_ERR on error.
1590 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001591LY_ERR lyd_diff_reverse_all(const struct lyd_node *src_diff, struct lyd_node **diff);
Michal Vasko4231fb62020-07-13 13:54:47 +02001592
1593/**
Radek Krejcifba9c622020-10-30 08:28:54 +01001594 * @brief Find the target in data of a compiled instance-identifier path (the target member in ::lyd_value).
Michal Vasko4490d312020-06-16 13:08:55 +02001595 *
1596 * @param[in] path Compiled path structure.
Michal Vaskof03ed032020-03-04 13:31:44 +01001597 * @param[in] tree Data tree to be searched.
Michal Vasko4490d312020-06-16 13:08:55 +02001598 * @return Found target node,
1599 * @return NULL if not found.
Radek Krejci576b23f2019-07-12 14:06:32 +02001600 */
Michal Vasko004d3152020-06-11 19:59:22 +02001601const struct lyd_node_term *lyd_target(const struct ly_path *path, const struct lyd_node *tree);
Radek Krejci084289f2019-07-09 17:35:30 +02001602
Michal Vasko5ec7cda2019-09-11 13:43:08 +02001603/**
Michal Vasko5ec7cda2019-09-11 13:43:08 +02001604 * @brief Types of the different data paths.
1605 */
1606typedef enum {
Michal Vasko14654712020-02-06 08:35:21 +01001607 LYD_PATH_LOG, /**< Descriptive path format used in log messages */
Michal Vasko69730152020-10-09 16:30:07 +02001608 LYD_PATH_LOG_NO_LAST_PRED /**< Similar to ::LYD_PATH_LOG except there is never a predicate on the last node */
Michal Vasko5ec7cda2019-09-11 13:43:08 +02001609} LYD_PATH_TYPE;
1610
1611/**
1612 * @brief Generate path of the given node in the requested format.
1613 *
1614 * @param[in] node Schema path of this node will be generated.
1615 * @param[in] pathtype Format of the path to generate.
1616 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
1617 * If NULL, memory for the complete path is allocated.
1618 * @param[in] buflen Size of the provided @p buffer.
1619 * @return NULL in case of memory allocation error, path of the node otherwise.
1620 * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it.
1621 */
1622char *lyd_path(const struct lyd_node *node, LYD_PATH_TYPE pathtype, char *buffer, size_t buflen);
1623
Michal Vaskoe444f752020-02-10 12:20:06 +01001624/**
Michal Vasko25a32822020-07-09 15:48:22 +02001625 * @brief Find a specific metadata.
1626 *
1627 * @param[in] first First metadata to consider.
1628 * @param[in] module Module of the metadata definition, may be NULL if @p name includes a prefix.
1629 * @param[in] name Name of the metadata to find, may not include a prefix (module name) if @p module is set.
1630 * @return Found metadata,
1631 * @return NULL if not found.
1632 */
1633struct lyd_meta *lyd_find_meta(const struct lyd_meta *first, const struct lys_module *module, const char *name);
1634
1635/**
Michal Vaskoda859032020-07-14 12:20:14 +02001636 * @brief Search in the given siblings (NOT recursively) for the first target instance with the same value.
Michal Vaskoe444f752020-02-10 12:20:06 +01001637 * Uses hashes - should be used whenever possible for best performance.
1638 *
1639 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
1640 * @param[in] target Target node to find.
Michal Vasko9b368d32020-02-14 13:53:31 +01001641 * @param[out] match Can be NULL, otherwise the found data node.
Michal Vaskoe444f752020-02-10 12:20:06 +01001642 * @return LY_SUCCESS on success, @p match set.
1643 * @return LY_ENOTFOUND if not found, @p match set to NULL.
1644 * @return LY_ERR value if another error occurred.
1645 */
1646LY_ERR lyd_find_sibling_first(const struct lyd_node *siblings, const struct lyd_node *target, struct lyd_node **match);
1647
1648/**
Michal Vaskoe444f752020-02-10 12:20:06 +01001649 * @brief Search in the given siblings for the first schema instance.
1650 * Uses hashes - should be used whenever possible for best performance.
1651 *
1652 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
1653 * @param[in] schema Schema node of the data node to find.
Michal Vaskob104f112020-07-17 09:54:54 +02001654 * @param[in] key_or_value If it is NULL, the first schema node data instance is found. For nodes with many
1655 * instances, it can be set based on the type of @p schema:
Michal Vaskoe444f752020-02-10 12:20:06 +01001656 * LYS_LEAFLIST:
1657 * Searched instance value.
1658 * LYS_LIST:
Michal Vasko90932a92020-02-12 14:33:03 +01001659 * Searched instance key values in the form of "[key1='val1'][key2='val2']...".
1660 * The keys do not have to be ordered but all of them must be set.
1661 *
1662 * Note that any explicit values (leaf-list or list key values) will be canonized first
1663 * before comparison. But values that do not have a canonical value are expected to be in the
1664 * JSON format!
Michal Vaskof03ed032020-03-04 13:31:44 +01001665 * @param[in] val_len Optional length of @p key_or_value in case it is not 0-terminated.
Michal Vasko9b368d32020-02-14 13:53:31 +01001666 * @param[out] match Can be NULL, otherwise the found data node.
Michal Vaskoe444f752020-02-10 12:20:06 +01001667 * @return LY_SUCCESS on success, @p match set.
1668 * @return LY_ENOTFOUND if not found, @p match set to NULL.
1669 * @return LY_EINVAL if @p schema is a key-less list.
1670 * @return LY_ERR value if another error occurred.
1671 */
1672LY_ERR lyd_find_sibling_val(const struct lyd_node *siblings, const struct lysc_node *schema, const char *key_or_value,
Radek Krejci0f969882020-08-21 16:56:47 +02001673 size_t val_len, struct lyd_node **match);
Michal Vaskoe444f752020-02-10 12:20:06 +01001674
Michal Vaskoccc02342020-05-21 10:09:21 +02001675/**
1676 * @brief Search in the given data for instances of nodes matching the provided XPath.
1677 *
Michal Vaskob104f112020-07-17 09:54:54 +02001678 * The expected format of the expression is ::LYD_JSON, meaning the first node in every path
Michal Vasko61ac2f62020-05-25 12:39:51 +02001679 * must have its module name as prefix or be the special `*` value for all the nodes.
1680 *
Michal Vasko19a30602020-05-25 10:40:19 +02001681 * If a list instance is being selected with all its key values specified (but not necessarily ordered)
1682 * in the form `list[key1='val1'][key2='val2'][key3='val3']` or a leaf-list instance in the form
1683 * `leaf-list[.='val']`, these instances are found using hashes with constant (*O(1)*) complexity
1684 * (unless they are defined in top-level). Other predicates can still follow the aforementioned ones.
1685 *
Michal Vaskoccc02342020-05-21 10:09:21 +02001686 * @param[in] ctx_node XPath context node.
1687 * @param[in] xpath Data XPath expression filtering the matching nodes. ::LYD_JSON format is expected.
1688 * @param[out] set Set of found data nodes. In case the result is a number, a string, or a boolean,
1689 * the returned set is empty.
1690 * @return LY_SUCCESS on success, @p set is returned.
1691 * @return LY_ERR value if an error occurred.
1692 */
1693LY_ERR lyd_find_xpath(const struct lyd_node *ctx_node, const char *xpath, struct ly_set **set);
1694
Radek Krejcie7b95092019-05-15 11:03:07 +02001695#ifdef __cplusplus
1696}
1697#endif
1698
1699#endif /* LY_TREE_DATA_H_ */