blob: a826f78fafe7065a724133d7432ec31cf4a8a389 [file] [log] [blame]
Radek Krejcie7b95092019-05-15 11:03:07 +02001/**
2 * @file tree_data.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
Michal Vasko2b421d92021-05-18 16:33:36 +02004 * @author Michal Vasko <mvasko@cesnet.cz>
Radek Krejcie7b95092019-05-15 11:03:07 +02005 * @brief libyang representation of YANG data trees.
6 *
Michal Vasko495f4502021-04-27 14:48:05 +02007 * Copyright (c) 2015 - 2021 CESNET, z.s.p.o.
Radek Krejcie7b95092019-05-15 11:03:07 +02008 *
9 * This source code is licensed under BSD 3-Clause License (the "License").
10 * You may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * https://opensource.org/licenses/BSD-3-Clause
14 */
15
16#ifndef LY_TREE_DATA_H_
17#define LY_TREE_DATA_H_
18
Michal Vasko2b421d92021-05-18 16:33:36 +020019#include <arpa/inet.h>
20#if defined (__FreeBSD__) || defined (__NetBSD__) || defined (__OpenBSD__)
21#include <netinet/in.h>
22#include <sys/socket.h>
23#endif
Radek Krejcie7b95092019-05-15 11:03:07 +020024#include <stddef.h>
25#include <stdint.h>
Michal Vasko2b421d92021-05-18 16:33:36 +020026#include <time.h>
Radek Krejcie7b95092019-05-15 11:03:07 +020027
Michal Vaskoaa0ee622021-05-11 09:29:25 +020028#include "config.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020029#include "log.h"
Christian Hopps59618972021-02-01 05:01:35 -050030#include "tree.h"
31#include "tree_schema.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020032
Radek Krejcica376bd2020-06-11 16:04:06 +020033#ifdef __cplusplus
34extern "C" {
35#endif
36
Radek Krejcie7b95092019-05-15 11:03:07 +020037struct ly_ctx;
Michal Vasko004d3152020-06-11 19:59:22 +020038struct ly_path;
Radek Krejci535ea9f2020-05-29 16:01:05 +020039struct ly_set;
40struct lyd_node;
41struct lyd_node_opaq;
Radek Krejci47fab892020-11-05 17:02:41 +010042struct lyd_node_term;
Michal Vasko43297a02021-05-19 11:12:37 +020043struct timespec;
aPiecekdf23eee2021-10-07 12:21:50 +020044struct lyxp_var;
Radek Krejcie7b95092019-05-15 11:03:07 +020045
Radek Krejcie7b95092019-05-15 11:03:07 +020046/**
Radek Krejci8678fa42020-08-18 16:07:28 +020047 * @page howtoData Data Instances
48 *
49 * All the nodes in data tree comes are based on ::lyd_node structure. According to the content of the ::lyd_node.schema
50 * it can be cast to several other structures.
51 *
52 * In case the ::lyd_node.schema pointer is NULL, the node is actually __opaq__ and can be safely cast to ::lyd_node_opaq.
53 * The opaq node represent an unknown node which wasn't mapped to any [(compiled) schema](@ref howtoSchema) node in the
54 * context. Such a node can appear in several places in the data tree.
55 * - As a part of the tree structure, but only in the case the ::LYD_PARSE_OPAQ option was used when input data were
56 * [parsed](@ref howtoDataParsers), because unknown data instances are ignored by default. The same way, the opaq nodes can
57 * appear as a node's attributes.
58 * - As a representation of YANG anydata/anyxml content.
59 * - As envelopes of standard data tree instances (RPCs, actions or Notifications).
60 *
61 * In case the data node has its definition in a [compiled schema tree](@ref howtoSchema), the structure of the data node is
62 * actually one of the followings according to the schema node's nodetype (::lysc_node.nodetype).
63 * - ::lyd_node_inner - represents data nodes corresponding to schema nodes matching ::LYD_NODE_INNER nodetypes. They provide
64 * structure of the tree by having children nodes.
65 * - ::lyd_node_term - represents data nodes corresponding to schema nodes matching ::LYD_NODE_TERM nodetypes. The terminal
66 * nodes provide values of the particular configuration/status information. The values are represented as ::lyd_value
Radek Krejci6d5ba0c2021-04-26 07:49:59 +020067 * structure with string representation of the value (retrieved by ::lyd_get_value() and ::lyd_get_meta_value()) and
68 * the type specific data stored in the structure's union according to the real type of the value (::lyd_value.realtype).
69 * The string representation provides canonical representation of the value in case the type has the canonical
70 * representation specified. Otherwise, it is the original value or, in case the value can contain prefixes, the JSON
71 * format is used to make the value unambiguous.
Radek Krejci8678fa42020-08-18 16:07:28 +020072 * - ::lyd_node_any - represents data nodes corresponding to schema nodes matching ::LYD_NODE_ANY nodetypes.
73 *
74 * Despite all the aforementioned structures and their members are available as part of the libyang API and callers can use
75 * it to navigate through the data tree structure or to obtain various information, we recommend to use the following macros
76 * and functions.
77 * - ::lyd_child() (or ::lyd_child_no_keys()) and ::lyd_parent() to get the node's child/parent node.
78 * - ::LYD_CTX to get libyang context from a data node.
Radek Krejci6d5ba0c2021-04-26 07:49:59 +020079 * - ::lyd_get_value()/::lyd_get_meta_value() to get canonical string value from a terminal node/metadata instance.
Radek Krejci8678fa42020-08-18 16:07:28 +020080 * - ::LYD_TREE_DFS_BEGIN and ::LYD_TREE_DFS_END to traverse the data tree (depth-first).
81 * - ::LY_LIST_FOR and ::LY_ARRAY_FOR as described on @ref howtoStructures page.
82 *
83 * Instead of going through the data tree on your own, a specific data node can be also located using a wide set of
84 * \b lyd_find_*() functions.
85 *
86 * More information about specific operations with data instances can be found on the following pages:
87 * - @subpage howtoDataParsers
88 * - @subpage howtoDataValidation
89 * - @subpage howtoDataWD
90 * - @subpage howtoDataManipulation
91 * - @subpage howtoDataPrinters
Radek Krejcif9943642021-04-26 10:18:21 +020092 * - @subpage howtoDataLYB
Radek Krejci8678fa42020-08-18 16:07:28 +020093 *
94 * \note API for this group of functions is described in the [Data Instances module](@ref datatree).
95 *
96 * Functions List (not assigned to above subsections)
97 * --------------------------------------------------
98 * - ::lyd_child()
99 * - ::lyd_child_no_keys()
100 * - ::lyd_parent()
101 * - ::lyd_owner_module()
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200102 * - ::lyd_get_value()
103 * - ::lyd_get_meta_value()
Radek Krejci8678fa42020-08-18 16:07:28 +0200104 * - ::lyd_find_xpath()
Michal Vasko3e1f6552021-01-14 09:27:55 +0100105 * - ::lyd_find_path()
Michal Vaskobb22b182021-06-14 08:14:21 +0200106 * - ::lyd_find_target()
Radek Krejci8678fa42020-08-18 16:07:28 +0200107 * - ::lyd_find_sibling_val()
108 * - ::lyd_find_sibling_first()
Michal Vasko1d4af6c2021-02-22 13:31:26 +0100109 * - ::lyd_find_sibling_opaq_next()
Radek Krejci8678fa42020-08-18 16:07:28 +0200110 * - ::lyd_find_meta()
111 *
112 * - ::lyd_path()
113 * - ::lyd_target()
114 *
115 * - ::lyd_lyb_data_length()
Radek Krejci75104122021-04-01 15:37:45 +0200116 *
117 *
118 * @section howtoDataMetadata Metadata Support
119 *
120 * YANG Metadata annotations are defined in [RFC 7952](https://tools.ietf.org/html/rfc7952) as YANG extension (and libyang
121 * [implements them as internal extension plugin](@ref howtoPluginsExtensions)). In practice, it allows to have XML
122 * attributes (there is also a special encoding for JSON) in YANG modeled data. libyang does not allow to have any XML
123 * attribute without the appropriate annotation definition describing the data as it is done e.g. for leafs. When an
124 * attribute without a matching annotation definition is found in the input data, it is:
125 * - silently dropped (with warning) or
126 * - an error is reported in case the ::LYD_PARSE_STRICT parser option is provided to the
127 * [parser function](@ref howtoDataParsers) or
128 * - stored into a generic ::lyd_attr structure without a connection with any YANG module in case the ::LYD_PARSE_OPAQ
129 * parser options is provided to the [parser function](@ref howtoDataParsers).
130 *
131 * There are some XML attributes, described by [YANG](https://tools.ietf.org/html/rfc7950) and
132 * [NETCONF](https://tools.ietf.org/html/rfc6241) specifications, which are not defined as annotations, but libyang
133 * implements them this way. In case of attributes in the YANG namespace (`insert`, `value` and `key` attributes
134 * for the NETCONF edit-config operation), they are defined in special libyang's internal module `yang`, which is
135 * available in each context and the content of this schema can be printed via
136 * [schema printers](@ref howtoSchemaPrinters).
137 *
138 * In case of the attributes described in [NETCONF specification](https://tools.ietf.org/html/rfc6241), the libyang's
139 * annotations structures are hidden and cannot be printed despite, internally, they are part of the `ietf-netconf`'s
140 * schema structure. Therefore, these attributes are available only when the `ietf-netconf` schema is loaded in the
141 * context. The definitions of these annotations are as follows:
142 *
143 * md:annotation operation {
144 * type enumeration {
145 * enum merge;
146 * enum replace;
147 * enum create;
148 * enum delete;
149 * enum remove;
150 * }
151 * }
152 *
153 * md:annotation type {
154 * type enumeration {
155 * enum subtree;
156 * enum xpath {
157 * if-feature "nc:xpath";
158 * }
159 * }
160 * }
161 *
162 * md:annotation select {
163 * type string;
164 * }
165 *
166 * Note, that, following the specification,
167 * - the `type` and `select` XML attributes are supposed to be unqualified (without namespace) and that
168 * - the `select`'s content is XPath and it is internally transformed by libyang into the format where the
169 * XML namespace prefixes are replaced by the YANG module names.
170 *
171 *
172 * @section howtoDataYangdata yang-data Support
173 *
174 * [RFC 8040](https://tools.ietf.org/html/rfc8040) defines ietf-restconf module, which includes yang-data extension. Despite
175 * the definition in the RESTCONF YANG module, the yang-data concept is quite generic and used even in modules without a
176 * connection to RESTCONF protocol. The extension allows to define a separated YANG trees usable separately from any
177 * datastore.
178 *
179 * libyang implements support for yang-data internally as an [extension plugin](@ref howtoPluginsExtensions). To ease the
180 * use of yang-data with libyang, there are several generic functions, which are usable for yang-data:
181 *
182 * - ::lyd_parse_ext_data()
183 * - ::lyd_parse_ext_op()
184 *
185 * - ::lys_getnext_ext()
186 *
187 * - ::lyd_new_ext_inner()
188 * - ::lyd_new_ext_list()
189 * - ::lyd_new_ext_term()
190 * - ::lyd_new_ext_any()
191 * - ::lyd_new_ext_path()
Radek Krejci8678fa42020-08-18 16:07:28 +0200192 */
193
194/**
195 * @page howtoDataManipulation Manipulating Data
196 *
197 * There are many functions to create or modify an existing data tree. You can add new nodes, reconnect nodes from
198 * one tree to another (or e.g. from one list instance to another) or remove nodes. The functions doesn't allow you
199 * to put a node to a wrong place (by checking the YANG module structure), but not all validation checks can be made directly
200 * (or you have to make a valid change by multiple tree modifications) when the tree is being changed. Therefore,
201 * the [validation process](@ref howtoDataValidation) is expected to be invoked after changing the data tree to make sure
202 * that the changed data tree is valid.
203 *
204 * When inserting a node into data tree (no matter if the node already exists, via ::lyd_insert_child() and
205 * ::lyd_insert_sibling(), or a new node is being created), the node is automatically inserted to the place respecting the
206 * nodes order from the YANG schema. So the node is not inserted to the end or beginning of the siblings list, but after the
207 * existing instance of the closest preceding sibling node from the schema. In case the node is opaq (it is not connected
208 * with any schema node), it is placed to the end of the sibling node in the order they are inserted in. The only situation
209 * when it is possible to influence the order of the nodes is the order of user-ordered list/leaf-list instances. In such
210 * a case the ::lyd_insert_after() or ::lyd_insert_before() can be used.
211 *
212 * Creating data is generally possible in two ways, they can be combined. You can add nodes one-by-one based on
213 * 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 +0100214 * and ::lyd_new_opaq()) or address the nodes using a [simple XPath addressing](@ref howtoXPath) (::lyd_new_path() and
215 * ::lyd_new_path2()). The latter enables to create a whole path of nodes, requires less information
Radek Krejci8678fa42020-08-18 16:07:28 +0200216 * about the modified data, and is generally simpler to use. Actually the third way is duplicating the existing data using
217 * ::lyd_dup_single(), ::lyd_dup_siblings() and ::lyd_dup_meta_single().
218 *
Radek Krejci8a5afc22021-03-12 11:10:47 +0100219 * Note, that in case the node is defined in an extension instance, the functions mentioned above do not work until you
220 * provide parent where the new node is supposed to be inserted. The reason is that all the functions searches for the
221 * top-level nodes directly inside modules. To create a top-level node defined in an extension instance, use
Radek Krejci95ccd1b2021-03-12 14:57:22 +0100222 * ::lyd_new_ext_inner(), ::lyd_new_ext_term(), ::lyd_new_ext_any(), ::lyd_new_ext_list() and ::lyd_new_ext_path()
223 * functions.
Radek Krejci8a5afc22021-03-12 11:10:47 +0100224 *
Radek Krejci75104122021-04-01 15:37:45 +0200225 * The [metadata](@ref howtoDataMetadata) (and attributes in opaq nodes) can be created with ::lyd_new_meta()
Radek Krejci8678fa42020-08-18 16:07:28 +0200226 * and ::lyd_new_attr().
227 *
228 * Changing value of a terminal node (leaf, leaf-list) is possible with ::lyd_change_term(). Similarly, the metadata value
229 * can be changed with ::lyd_change_meta(). Before changing the value, it might be useful to compare the node's value
230 * with a string value (::lyd_value_compare()) or verify that the new string value is correct for the specific data node
231 * (::lyd_value_validate()).
232 *
233 * Working with two existing subtrees can also be performed two ways. Usually, you would use lyd_insert*() functions.
234 * They are generally meant for simple inserts of a node into a data tree. For more complicated inserts and when
235 * merging 2 trees use ::lyd_merge_tree() or ::lyd_merge_siblings(). It offers additional options and is basically a more
236 * powerful insert.
237 *
238 * Besides merging, libyang is also capable to provide information about differences between two data trees. For this purpose,
239 * ::lyd_diff_tree() and ::lyd_diff_siblings() generates annotated data trees which can be, in addition, used to change one
240 * data tree to another one using ::lyd_diff_apply_all(), ::lyd_diff_apply_module() and ::lyd_diff_reverse_all(). Multiple
241 * diff data trees can be also put together for further work using ::lyd_diff_merge_all(), ::lyd_diff_merge_module() and
242 * ::lyd_diff_merge_tree() functions. To just check equivalence of the data nodes, ::lyd_compare_single(),
243 * ::lyd_compare_siblings() and ::lyd_compare_meta() can be used.
244 *
245 * To remove a node or subtree from a data tree, use ::lyd_unlink_tree() and then free the unwanted data using
246 * ::lyd_free_all() (or other \b lyd_free_*() functions).
247 *
248 * Also remember, that when you are creating/inserting a node, all the objects in that operation must belong to the
249 * same context.
250 *
251 * Modifying the single data tree in multiple threads is not safe.
252 *
253 * Functions List
254 * --------------
255 * - ::lyd_new_inner()
256 * - ::lyd_new_term()
Radek Krejci09c77442021-04-26 11:10:34 +0200257 * - ::lyd_new_term_bin()
258 * - ::lyd_new_term_canon()
Radek Krejci8678fa42020-08-18 16:07:28 +0200259 * - ::lyd_new_list()
Michal Vasko208e6d62021-06-28 11:23:50 +0200260 * - ::lyd_new_list_bin()
261 * - ::lyd_new_list_canon()
Radek Krejci8678fa42020-08-18 16:07:28 +0200262 * - ::lyd_new_list2()
263 * - ::lyd_new_any()
264 * - ::lyd_new_opaq()
Michal Vasko8d65f852021-02-17 11:28:13 +0100265 * - ::lyd_new_opaq2()
Radek Krejci8678fa42020-08-18 16:07:28 +0200266 * - ::lyd_new_attr()
Michal Vasko8d65f852021-02-17 11:28:13 +0100267 * - ::lyd_new_attr2()
Radek Krejci8678fa42020-08-18 16:07:28 +0200268 * - ::lyd_new_meta()
269 * - ::lyd_new_path()
270 * - ::lyd_new_path2()
Radek Krejci8678fa42020-08-18 16:07:28 +0200271 *
Radek Krejcidd2a7662021-03-12 11:26:34 +0100272 * - ::lyd_new_ext_inner()
Radek Krejci8a5afc22021-03-12 11:10:47 +0100273 * - ::lyd_new_ext_term()
Radek Krejci8247bae2021-03-12 11:47:02 +0100274 * - ::lyd_new_ext_list()
Radek Krejci0b963da2021-03-12 13:23:44 +0100275 * - ::lyd_new_ext_any()
Radek Krejci95ccd1b2021-03-12 14:57:22 +0100276 * - ::lyd_new_ext_path()
Radek Krejci8a5afc22021-03-12 11:10:47 +0100277 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200278 * - ::lyd_dup_single()
279 * - ::lyd_dup_siblings()
280 * - ::lyd_dup_meta_single()
281 *
282 * - ::lyd_insert_child()
283 * - ::lyd_insert_sibling()
284 * - ::lyd_insert_after()
285 * - ::lyd_insert_before()
286 *
287 * - ::lyd_value_compare()
288 * - ::lyd_value_validate()
289 *
290 * - ::lyd_change_term()
Radek Krejci09c77442021-04-26 11:10:34 +0200291 * - ::lyd_change_term_bin()
292 * - ::lyd_change_term_canon()
Radek Krejci8678fa42020-08-18 16:07:28 +0200293 * - ::lyd_change_meta()
294 *
295 * - ::lyd_compare_single()
296 * - ::lyd_compare_siblings()
297 * - ::lyd_compare_meta()
298 * - ::lyd_diff_tree()
299 * - ::lyd_diff_siblings()
300 * - ::lyd_diff_apply_all()
301 * - ::lyd_diff_apply_module()
302 * - ::lyd_diff_reverse_all()
303 * - ::lyd_diff_merge_all()
304 * - ::lyd_diff_merge_module()
305 * - ::lyd_diff_merge_tree()
306 *
307 * - ::lyd_merge_tree()
308 * - ::lyd_merge_siblings()
Michal Vaskocd3f6172021-05-18 16:14:50 +0200309 * - ::lyd_merge_module()
Radek Krejci8678fa42020-08-18 16:07:28 +0200310 *
311 * - ::lyd_unlink_tree()
312 *
313 * - ::lyd_free_all()
314 * - ::lyd_free_siblings()
315 * - ::lyd_free_tree()
316 * - ::lyd_free_meta_single()
317 * - ::lyd_free_meta_siblings()
318 * - ::lyd_free_attr_single()
319 * - ::lyd_free_attr_siblings()
320 *
Michal Vaskoa820c312021-02-05 16:33:00 +0100321 * - ::lyd_any_value_str()
Radek Krejci8678fa42020-08-18 16:07:28 +0200322 * - ::lyd_any_copy_value()
323 */
324
325/**
326 * @page howtoDataWD Default Values
327 *
328 * libyang provides support for work with default values as defined in [RFC 6243](https://tools.ietf.org/html/rfc6243).
329 * However, libyang context do not contains the *ietf-netconf-with-defaults* module on its own and caller is supposed to
330 * add this YANG module to enable full support of the *with-defaults* features described below. Without presence of the
331 * mentioned module in the context, the default nodes are still present and handled in the data trees, but the metadata
332 * providing the information about the default values cannot be used. It means that when parsing data, the default nodes
333 * marked with the metadata as implicit default nodes are handled as explicit data and when printing data tree, the expected
334 * nodes are printed without the ietf-netconf-with-defaults metadata.
335 *
336 * The RFC document defines 4 modes for handling default nodes in a data tree, libyang adds the fifth mode and use them
337 * via @ref dataprinterflags when printing data trees.
338 * - \b explicit - Only the explicitly set configuration data. But in the case of status data, missing default
339 * data are added into the tree. In libyang, this mode is represented by ::LYD_PRINT_WD_EXPLICIT option.
340 * This is the default with-defaults mode of the printer. The data nodes do not contain any additional
341 * metadata information.
342 * - \b trim - Data nodes containing the default value are removed. This mode is applied with ::LYD_PRINT_WD_TRIM option.
343 * - \b report-all - This mode provides all the default data nodes despite they were explicitly present in source data or
344 * they were added by libyang's [validation process](@ref howtoDataValidation). This mode is activated by
345 * ::LYD_PRINT_WD_ALL option.
346 * - \b report-all-tagged - In this case, all the data nodes (implicit as well the explicit) containing the default value
347 * are printed and tagged (see the note below). Printers accept ::LYD_PRINT_WD_ALL_TAG option for this mode.
348 * - \b report-implicit-tagged - The last mode is similar to the previous one, except only the implicitly added nodes
349 * are tagged. This is the libyang's extension and it is activated by ::LYD_PRINT_WD_IMPL_TAG option.
350 *
351 * Internally, libyang adds the default nodes into the data tree as part of the [validation process](@ref howtoDataValidation).
352 * When [parsing data](@ref howtoDataParsers) from an input source, adding default nodes can be avoided only by avoiding
353 * the whole [validation process](@ref howtoDataValidation). In case the ietf-netconf-with-defaults module is present in the
354 * context, the [parser process](@ref howtoDataParsers) also supports to recognize the implicit default nodes marked with the
355 * appropriate metadata.
356 *
357 * Note, that in a modified data tree (via e.g. \b lyd_insert_*() or \b lyd_free_*() functions), some of the default nodes
358 * can be missing or they can be present by mistake. Such a data tree is again corrected during the next run of the
359 * [validation process](@ref howtoDataValidation) or manualy using \b lyd_new_implicit_*() functions.
360 *
361 * The implicit (default) nodes, created by libyang, are marked with the ::LYD_DEFAULT flag in ::lyd_node.flags member
362 * Note, that besides leafs and leaf-lists, the flag can appear also in containers, where it means that the container
363 * 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
364 * the accessible data tree). When printing data trees, the presence of empty containers (despite they were added
365 * explicitly or implicitly as part of accessible data tree) depends on ::LYD_PRINT_KEEPEMPTYCONT option.
366 *
367 * To get know if the particular leaf or leaf-list node contains default value (despite implicit or explicit), you can
368 * use ::lyd_is_default() function.
369 *
370 * Functions List
371 * --------------
372 * - ::lyd_is_default()
373 * - ::lyd_new_implicit_all()
374 * - ::lyd_new_implicit_module()
375 * - ::lyd_new_implicit_tree()
376 */
377
378/**
Radek Krejcif9943642021-04-26 10:18:21 +0200379 * @page howtoDataLYB LYB Binary Format
380 *
381 * LYB (LibYang Binary) is a proprietary libyang binary data and file format. Its primary purpose is efficient
382 * serialization (printing) and deserialization (parsing). With this goal in mind, every term node value is stored
383 * in its new binary format specification according to its type. Following is the format for all types with explicit
384 * support out-of-the-box (meaning that have a special type plugin). Any derived types inherit the format of its
385 * closest type with explicit support (up to a built-in type).
Radek Krejci09c77442021-04-26 11:10:34 +0200386 *
Michal Vaskof1bcb5c2021-04-30 09:21:25 +0200387 * @section howtoDataLYBTypes Format of specific data type values
Radek Krejcif9943642021-04-26 10:18:21 +0200388 */
389
390/**
Radek Krejci2ff0d572020-05-21 15:27:28 +0200391 * @ingroup trees
Radek Krejci8678fa42020-08-18 16:07:28 +0200392 * @defgroup datatree Data Tree
Radek Krejcie7b95092019-05-15 11:03:07 +0200393 * @{
394 *
395 * Data structures and functions to manipulate and access instance data tree.
396 */
397
Michal Vasko64246d82020-08-19 12:35:00 +0200398/* *INDENT-OFF* */
399
Michal Vaskoa276cd92020-08-10 15:10:08 +0200400/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200401 * @brief Macro to iterate via all elements in a data tree. This is the opening part
402 * to the #LYD_TREE_DFS_END - they always have to be used together.
403 *
404 * The function follows deep-first search algorithm:
405 * <pre>
406 * 1
407 * / \
Michal Vaskoc193ce92020-03-06 11:04:48 +0100408 * 2 4
Radek Krejcie7b95092019-05-15 11:03:07 +0200409 * / / \
Michal Vaskoc193ce92020-03-06 11:04:48 +0100410 * 3 5 6
Radek Krejcie7b95092019-05-15 11:03:07 +0200411 * </pre>
412 *
Radek Krejci0935f412019-08-20 16:15:18 +0200413 * Use the same parameters for #LYD_TREE_DFS_BEGIN and #LYD_TREE_DFS_END. While
Michal Vasko56daf732020-08-10 10:57:18 +0200414 * START can be any of the lyd_node* types, ELEM variable must be a pointer to
415 * the generic struct lyd_node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200416 *
Michal Vasko56daf732020-08-10 10:57:18 +0200417 * To skip a particular subtree, instead of the continue statement, set LYD_TREE_DFS_continue
418 * variable to non-zero value.
Radek Krejcie7b95092019-05-15 11:03:07 +0200419 *
420 * Use with opening curly bracket '{' after the macro.
421 *
422 * @param START Pointer to the starting element processed first.
Radek Krejcie7b95092019-05-15 11:03:07 +0200423 * @param ELEM Iterator intended for use in the block.
424 */
Michal Vasko56daf732020-08-10 10:57:18 +0200425#define LYD_TREE_DFS_BEGIN(START, ELEM) \
Radek Krejci857189e2020-09-01 13:26:36 +0200426 { ly_bool LYD_TREE_DFS_continue = 0; struct lyd_node *LYD_TREE_DFS_next; \
Michal Vasko56daf732020-08-10 10:57:18 +0200427 for ((ELEM) = (LYD_TREE_DFS_next) = (struct lyd_node *)(START); \
Radek Krejcie7b95092019-05-15 11:03:07 +0200428 (ELEM); \
Michal Vasko56daf732020-08-10 10:57:18 +0200429 (ELEM) = (LYD_TREE_DFS_next), LYD_TREE_DFS_continue = 0)
Radek Krejcie7b95092019-05-15 11:03:07 +0200430
431/**
432 * @brief Macro to iterate via all elements in a tree. This is the closing part
433 * to the #LYD_TREE_DFS_BEGIN - they always have to be used together.
434 *
435 * Use the same parameters for #LYD_TREE_DFS_BEGIN and #LYD_TREE_DFS_END. While
Michal Vasko56daf732020-08-10 10:57:18 +0200436 * START can be any of the lyd_node* types, ELEM variable must be a pointer
437 * to the generic struct lyd_node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200438 *
439 * Use with closing curly bracket '}' after the macro.
440 *
441 * @param START Pointer to the starting element processed first.
Radek Krejcie7b95092019-05-15 11:03:07 +0200442 * @param ELEM Iterator intended for use in the block.
443 */
444
Michal Vasko56daf732020-08-10 10:57:18 +0200445#define LYD_TREE_DFS_END(START, ELEM) \
Radek Krejcie7b95092019-05-15 11:03:07 +0200446 /* select element for the next run - children first */ \
Michal Vasko56daf732020-08-10 10:57:18 +0200447 if (LYD_TREE_DFS_continue) { \
448 (LYD_TREE_DFS_next) = NULL; \
449 } else { \
Radek Krejcia1c1e542020-09-29 16:06:52 +0200450 (LYD_TREE_DFS_next) = lyd_child(ELEM); \
Michal Vasko56daf732020-08-10 10:57:18 +0200451 }\
452 if (!(LYD_TREE_DFS_next)) { \
Radek Krejcie7b95092019-05-15 11:03:07 +0200453 /* no children */ \
Michal Vasko9e685082021-01-29 14:49:09 +0100454 if ((ELEM) == (struct lyd_node *)(START)) { \
Radek Krejcie7b95092019-05-15 11:03:07 +0200455 /* we are done, (START) has no children */ \
456 break; \
457 } \
458 /* try siblings */ \
Michal Vasko56daf732020-08-10 10:57:18 +0200459 (LYD_TREE_DFS_next) = (ELEM)->next; \
Radek Krejcie7b95092019-05-15 11:03:07 +0200460 } \
Michal Vasko56daf732020-08-10 10:57:18 +0200461 while (!(LYD_TREE_DFS_next)) { \
Radek Krejcie7b95092019-05-15 11:03:07 +0200462 /* parent is already processed, go to its sibling */ \
Michal Vasko9e685082021-01-29 14:49:09 +0100463 (ELEM) = (struct lyd_node *)(ELEM)->parent; \
Radek Krejcie7b95092019-05-15 11:03:07 +0200464 /* no siblings, go back through parents */ \
465 if ((ELEM)->parent == (START)->parent) { \
466 /* we are done, no next element to process */ \
467 break; \
468 } \
Michal Vasko56daf732020-08-10 10:57:18 +0200469 (LYD_TREE_DFS_next) = (ELEM)->next; \
Christian Hopps59618972021-02-01 05:01:35 -0500470 } }
471
472/**
473 * @brief Macro to iterate via all schema node data instances in data siblings.
474 *
475 * @param START Pointer to the starting sibling. Even if it is not first, all the siblings are searched.
476 * @param SCHEMA Schema node of the searched instances.
477 * @param ELEM Iterator.
478 */
479#define LYD_LIST_FOR_INST(START, SCHEMA, ELEM) \
480 for (lyd_find_sibling_val(START, SCHEMA, NULL, 0, &(ELEM)); \
481 (ELEM) && ((ELEM)->schema == (SCHEMA)); \
482 (ELEM) = (ELEM)->next)
483
484/**
485 * @brief Macro to iterate via all schema node data instances in data siblings allowing to modify the list itself.
486 *
487 * @param START Pointer to the starting sibling. Even if it is not first, all the siblings are searched.
488 * @param SCHEMA Schema node of the searched instances.
489 * @param NEXT Temporary storage to allow removing of the current iterator content.
490 * @param ELEM Iterator.
491 */
492#define LYD_LIST_FOR_INST_SAFE(START, SCHEMA, NEXT, ELEM) \
493 for (lyd_find_sibling_val(START, SCHEMA, NULL, 0, &(ELEM)); \
494 (ELEM) && ((ELEM)->schema == (SCHEMA)) ? ((NEXT) = (ELEM)->next, 1) : 0; \
495 (ELEM) = (NEXT))
Radek Krejcie7b95092019-05-15 11:03:07 +0200496
Michal Vasko64246d82020-08-19 12:35:00 +0200497/* *INDENT-ON* */
498
Radek Krejcie7b95092019-05-15 11:03:07 +0200499/**
Michal Vasko03ff5a72019-09-11 13:49:33 +0200500 * @brief Macro to get context from a data tree node.
501 */
Michal Vasko5c7a8322021-06-25 09:12:05 +0200502#define LYD_CTX(node) ((node)->schema ? (node)->schema->module->ctx : ((const struct lyd_node_opaq *)(node))->ctx)
Michal Vasko03ff5a72019-09-11 13:49:33 +0200503
504/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200505 * @brief Data input/output formats supported by libyang [parser](@ref howtoDataParsers) and
506 * [printer](@ref howtoDataPrinters) functions.
Radek Krejcie7b95092019-05-15 11:03:07 +0200507 */
508typedef enum {
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200509 LYD_UNKNOWN = 0, /**< unknown data format, invalid value */
510 LYD_XML, /**< XML instance data format */
511 LYD_JSON, /**< JSON instance data format */
Michal Vasko69730152020-10-09 16:30:07 +0200512 LYD_LYB /**< LYB instance data format */
Radek Krejcie7b95092019-05-15 11:03:07 +0200513} LYD_FORMAT;
514
515/**
Radek Krejci59583bb2019-09-11 12:57:55 +0200516 * @brief List of possible value types stored in ::lyd_node_any.
Radek Krejcie7b95092019-05-15 11:03:07 +0200517 */
518typedef enum {
Radek Krejci8678fa42020-08-18 16:07:28 +0200519 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 +0200520 is directly connected into the anydata node without duplication, caller is supposed to not manipulate
Radek Krejci8678fa42020-08-18 16:07:28 +0200521 with the data after a successful call (including calling ::lyd_free_all() on the provided data) */
Radek Krejci22ebdba2019-07-25 13:59:43 +0200522 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 +0200523 as string). XML sensitive characters (such as & or \>) are automatically escaped when the anydata
524 is printed in XML format. */
Radek Krejci22ebdba2019-07-25 13:59:43 +0200525 LYD_ANYDATA_XML, /**< Value is a string containing the serialized XML data. */
526 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 +0200527 LYD_ANYDATA_LYB /**< Value is a memory chunk with the serialized data tree in LYB format. */
Radek Krejcie7b95092019-05-15 11:03:07 +0200528} LYD_ANYDATA_VALUETYPE;
529
530/** @} */
531
532/**
533 * @brief YANG data representation
534 */
535struct lyd_value {
Radek Krejci995784f2021-04-26 08:02:13 +0200536 const char *_canonical; /**< Should never be accessed directly, instead ::lyd_get_value() and ::lyd_get_meta_value()
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200537 should be used. Serves as a cache for the canonical value or the JSON
538 representation if no canonical value is defined. */
Michal Vaskoaa0ee622021-05-11 09:29:25 +0200539 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
540 in the schema node of the data node since the type's store plugin can use other types/plugins for
541 storing data. Speaking about built-in types, this is the case of leafref which stores data as its
542 target type. In contrast, union type also uses its subtype's callbacks, but inside an internal data
543 stored in subvalue member of ::lyd_value structure, so here is the pointer to the union type.
544 In general, this type is used to get free callback for this lyd_value structure, so it must reflect
545 the type used to store data directly in the same lyd_value instance. */
Radek Krejci8678fa42020-08-18 16:07:28 +0200546
Radek Krejcie7b95092019-05-15 11:03:07 +0200547 union {
Radek Krejcie7b95092019-05-15 11:03:07 +0200548 int8_t boolean; /**< 0 as false, 1 as true */
549 int64_t dec64; /**< decimal64: value = dec64 / 10^fraction-digits */
Radek Krejci8dc4f2d2019-07-16 12:24:00 +0200550 int8_t int8; /**< 8-bit signed integer */
551 int16_t int16; /**< 16-bit signed integer */
552 int32_t int32; /**< 32-bit signed integer */
553 int64_t int64; /**< 64-bit signed integer */
554 uint8_t uint8; /**< 8-bit unsigned integer */
Michal Vasko7c8439f2020-08-05 13:25:19 +0200555 uint16_t uint16; /**< 16-bit unsigned integer */
556 uint32_t uint32; /**< 32-bit unsigned integer */
557 uint64_t uint64; /**< 64-bit unsigned integer */
Radek Krejcie7b95092019-05-15 11:03:07 +0200558 struct lysc_type_bitenum_item *enum_item; /**< pointer to the definition of the enumeration value */
559 struct lysc_ident *ident; /**< pointer to the schema definition of the identityref value */
Michal Vaskobb22b182021-06-14 08:14:21 +0200560 struct ly_path *target; /**< Instance-identifier target path, use ::lyd_find_target() to evaluate
561 it on data. */
Michal Vasko3ce79712021-05-04 11:44:20 +0200562 struct lyd_value_union *subvalue; /** Union value with some metadata. */
Michal Vaskoaa0ee622021-05-11 09:29:25 +0200563
564 void *dyn_mem; /**< pointer to generic data type value stored in dynamic memory */
565 uint8_t fixed_mem[LYD_VALUE_FIXED_MEM_SIZE]; /**< fixed-size buffer for a generic data type value */
Radek Krejci8678fa42020-08-18 16:07:28 +0200566 }; /**< The union is just a list of shorthands to possible values stored by a type's plugin. libyang itself uses the ::lyd_value.realtype
567 plugin's callbacks to work with the data.*/
Radek Krejcie7b95092019-05-15 11:03:07 +0200568};
569
570/**
Michal Vaskoaa0ee622021-05-11 09:29:25 +0200571 * @brief Get the value in format specific to the type.
572 *
573 * Should be used for any types that do not have their specific representation in the ::lyd_value union.
574 *
575 * @param[in] value Pointer to the value structure to read from (struct ::lyd_value *).
576 * @param[out] type_val Pointer to the type-specific value structure.
577 */
578#define LYD_VALUE_GET(value, type_val) \
579 ((sizeof *(type_val) > LYD_VALUE_FIXED_MEM_SIZE) \
580 ? ((type_val) = (((value)->dyn_mem))) \
581 : ((type_val) = ((void *)((value)->fixed_mem))))
582
583/**
Michal Vasko2b421d92021-05-18 16:33:36 +0200584 * @brief Special lyd_value structure for built-in union values.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200585 *
Michal Vasko3ce79712021-05-04 11:44:20 +0200586 * Represents data with multiple types (union). The ::lyd_value_union.value contains representation according to
587 * one of the union's types. The ::lyd_value_union.prefix_data provides (possible) mappings from prefixes in
Michal Vasko495f4502021-04-27 14:48:05 +0200588 * the original value to YANG modules. These prefixes are necessary to parse original value to the union's subtypes.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200589 */
Michal Vasko3ce79712021-05-04 11:44:20 +0200590struct lyd_value_union {
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200591 struct lyd_value value; /**< representation of the value according to the selected union's subtype
Michal Vasko3ce79712021-05-04 11:44:20 +0200592 (stored as ::lyd_value.realtype here) */
593 void *original; /**< Original value. */
594 size_t orig_len; /**< Original value length. */
Michal Vaskod0c3bac2021-05-11 09:44:43 +0200595 uint32_t hints; /**< [Value hints](@ref lydvalhints) from the parser */
Radek Krejci8df109d2021-04-23 12:19:08 +0200596 LY_VALUE_FORMAT format; /**< Prefix format of the value. However, this information is also used to decide
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200597 whether a value is valid for the specific format or not on later validations
598 (instance-identifier in XML looks different than in JSON). */
Radek Krejci0b013302021-03-29 15:22:32 +0200599 void *prefix_data; /**< Format-specific data for prefix resolution (see ly_resolve_prefix()) */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200600 const struct lysc_node *ctx_node; /**< Context schema node. */
601};
602
603/**
Michal Vasko2b421d92021-05-18 16:33:36 +0200604 * @brief Special lyd_value structure for built-in bits values.
Michal Vasko2724b922021-04-28 13:46:31 +0200605 */
606struct lyd_value_bits {
607 char *bitmap; /**< bitmap of size ::lyplg_type_bits_bitmap_size(), if its value is
608 cast to an integer type of the corresponding size, can be used
609 directly as a bitmap */
610 struct lysc_type_bitenum_item **items; /**< list of set pointers to the specification of the set
611 bits ([sized array](@ref sizedarrays)) */
612};
613
614/**
Michal Vasko2b421d92021-05-18 16:33:36 +0200615 * @brief Special lyd_value structure for built-in binary values.
Michal Vasko495f4502021-04-27 14:48:05 +0200616 */
617struct lyd_value_binary {
Michal Vasko74515d02021-06-11 11:13:11 +0200618 void *data; /**< pointer to the binary value */
619 size_t size; /**< size of @p data value in bytes */
Michal Vasko495f4502021-04-27 14:48:05 +0200620};
621
622/**
Michal Vasko2b421d92021-05-18 16:33:36 +0200623 * @brief Special lyd_value structure for ietf-inet-types ipv4-address-no-zone values.
624 */
625struct lyd_value_ipv4_address_no_zone {
626 struct in_addr addr; /**< IPv4 address in binary */
627};
628
629/**
630 * @brief Special lyd_value structure for ietf-inet-types ipv4-address values.
631 */
632struct lyd_value_ipv4_address {
633 struct in_addr addr; /**< IPv4 address in binary */
634 const char *zone; /**< Optional address zone */
635};
636
637/**
638 * @brief Special lyd_value structure for ietf-inet-types ipv4-prefix values.
639 */
640struct lyd_value_ipv4_prefix {
641 struct in_addr addr; /**< IPv4 host address in binary */
642 uint8_t prefix; /**< prefix length (0 - 32) */
643};
644
645/**
646 * @brief Special lyd_value structure for ietf-inet-types ipv6-address-no-zone values.
647 */
648struct lyd_value_ipv6_address_no_zone {
649 struct in6_addr addr; /**< IPv6 address in binary */
650};
651
652/**
653 * @brief Special lyd_value structure for ietf-inet-types ipv6-address values.
654 */
655struct lyd_value_ipv6_address {
656 struct in6_addr addr; /**< IPv6 address in binary */
657 const char *zone; /**< Optional address zone */
658};
659
660/**
661 * @brief Special lyd_value structure for ietf-inet-types ipv6-prefix values.
662 */
663struct lyd_value_ipv6_prefix {
664 struct in6_addr addr; /**< IPv6 host address in binary */
665 uint8_t prefix; /**< prefix length (0 - 128) */
666};
667
668/**
669 * @brief Special lyd_value structure for ietf-yang-types date-and-time values.
670 */
671struct lyd_value_date_and_time {
672 time_t time; /**< UNIX timestamp */
673 char *fractions_s; /**< Optional fractions of a second */
674};
675
676/**
Michal Vasko9f96a052020-03-10 09:41:45 +0100677 * @brief Metadata structure.
Radek Krejcie7b95092019-05-15 11:03:07 +0200678 *
Michal Vasko9f96a052020-03-10 09:41:45 +0100679 * The structure provides information about metadata of a data element. Such attributes must map to
Radek Krejcie7b95092019-05-15 11:03:07 +0200680 * annotations as specified in RFC 7952. The only exception is the filter type (in NETCONF get operations)
681 * and edit-config's operation attributes. In XML, they are represented as standard XML attributes. In JSON,
682 * they are represented as JSON elements starting with the '@' character (for more information, see the
683 * YANG metadata RFC.
684 *
685 */
Michal Vasko9f96a052020-03-10 09:41:45 +0100686struct lyd_meta {
687 struct lyd_node *parent; /**< data node where the metadata is placed */
688 struct lyd_meta *next; /**< pointer to the next metadata of the same element */
689 struct lysc_ext_instance *annotation; /**< pointer to the annotation's definition */
690 const char *name; /**< metadata name */
691 struct lyd_value value; /**< metadata value representation */
Radek Krejcie7b95092019-05-15 11:03:07 +0200692};
693
Michal Vasko52927e22020-03-16 17:26:14 +0100694/**
695 * @brief Generic prefix and namespace mapping, meaning depends on the format.
Radek Krejci1798aae2020-07-14 13:26:06 +0200696 *
697 * 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 +0200698 * ::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 +0100699 * 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 +0100700 */
Michal Vaskoad92b672020-11-12 13:11:31 +0100701struct ly_opaq_name {
702 const char *name; /**< node name, without prefix if any was defined */
703 const char *prefix; /**< identifier used in the qualified name as the prefix, can be NULL */
Radek Krejci1798aae2020-07-14 13:26:06 +0200704 union {
Radek Krejci8df109d2021-04-23 12:19:08 +0200705 const char *module_ns; /**< format ::LY_VALUE_XML - XML namespace of the node element */
706 const char *module_name; /**< format ::LY_VALUE_JSON - (inherited) name of the module of the element */
Radek Krejci1798aae2020-07-14 13:26:06 +0200707 };
Michal Vasko52927e22020-03-16 17:26:14 +0100708};
709
710/**
711 * @brief Generic attribute structure.
712 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200713struct lyd_attr {
Michal Vasko52927e22020-03-16 17:26:14 +0100714 struct lyd_node_opaq *parent; /**< data node where the attribute is placed */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100715 struct lyd_attr *next; /**< pointer to the next attribute */
Michal Vaskoad92b672020-11-12 13:11:31 +0100716 struct ly_opaq_name name; /**< attribute name with module information */
Michal Vasko501af032020-11-11 20:27:44 +0100717 const char *value; /**< attribute value */
Michal Vaskod0c3bac2021-05-11 09:44:43 +0200718 uint32_t hints; /**< additional information about from the data source, see the [hints list](@ref lydhints) */
Radek Krejci8df109d2021-04-23 12:19:08 +0200719 LY_VALUE_FORMAT format; /**< format of the attribute and any prefixes, ::LY_VALUE_XML or ::LY_VALUE_JSON */
Radek Krejciec9ad602021-01-04 10:46:30 +0100720 void *val_prefix_data; /**< format-specific prefix data */
Michal Vasko52927e22020-03-16 17:26:14 +0100721};
Radek Krejcie7b95092019-05-15 11:03:07 +0200722
Michal Vasko1bf09392020-03-27 12:38:10 +0100723#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 +0200724#define LYD_NODE_TERM (LYS_LEAF|LYS_LEAFLIST) /**< Schema nodetype mask for lyd_node_term */
725#define LYD_NODE_ANY (LYS_ANYDATA) /**< Schema nodetype mask for lyd_node_any */
726
727/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200728 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +0200729 * @defgroup dnodeflags Data node flags
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200730 * @{
731 *
732 * Various flags of data nodes.
733 *
734 * 1 - container 5 - anydata/anyxml
735 * 2 - list 6 - rpc/action
736 * 3 - leaf 7 - notification
737 * 4 - leaflist
738 *
739 * bit name 1 2 3 4 5 6 7
740 * ---------------------+-+-+-+-+-+-+-+
741 * 1 LYD_DEFAULT |x| |x|x| | | |
742 * +-+-+-+-+-+-+-+
Michal Vasko5c4e5892019-11-14 12:31:38 +0100743 * 2 LYD_WHEN_TRUE |x|x|x|x|x| | |
Michal Vasko9b368d32020-02-14 13:53:31 +0100744 * +-+-+-+-+-+-+-+
745 * 3 LYD_NEW |x|x|x|x|x|x|x|
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200746 * ---------------------+-+-+-+-+-+-+-+
747 *
748 */
749
Michal Vasko5c4e5892019-11-14 12:31:38 +0100750#define LYD_DEFAULT 0x01 /**< default (implicit) node */
751#define LYD_WHEN_TRUE 0x02 /**< all when conditions of this node were evaluated to true */
Michal Vasko9b368d32020-02-14 13:53:31 +0100752#define LYD_NEW 0x04 /**< node was created after the last validation, is needed for the next validation */
Michal Vasko52927e22020-03-16 17:26:14 +0100753
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200754/** @} */
755
756/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200757 * @brief Generic structure for a data node.
758 */
759struct lyd_node {
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200760 uint32_t hash; /**< hash of this particular node (module name + schema name + key string values if list or
761 hashes of all nodes of subtree in case of keyless list). Note that while hash can be
762 used to get know that nodes are not equal, it cannot be used to decide that the
763 nodes are equal due to possible collisions. */
764 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100765 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200766 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
767 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
768 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
769 never NULL. If there is no sibling node, pointer points to the node
770 itself. In case of the first node, this pointer points to the last
771 node in the list. */
Michal Vasko9f96a052020-03-10 09:41:45 +0100772 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200773 void *priv; /**< private user data, not used by libyang */
Radek Krejcie7b95092019-05-15 11:03:07 +0200774};
775
776/**
Radek Krejcif3b6fec2019-07-24 15:53:11 +0200777 * @brief Data node structure for the inner data tree nodes - containers, lists, RPCs, actions and Notifications.
Radek Krejcie7b95092019-05-15 11:03:07 +0200778 */
779struct lyd_node_inner {
Michal Vasko9e685082021-01-29 14:49:09 +0100780 union {
781 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
782 struct {
783 uint32_t hash; /**< hash of this particular node (module name + schema name + key string
784 values if list or hashes of all nodes of subtree in case of keyless
785 list). Note that while hash can be used to get know that nodes are
786 not equal, it cannot be used to decide that the nodes are equal due
787 to possible collisions. */
788 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
789 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
790 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
791 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
792 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
793 never NULL. If there is no sibling node, pointer points to the node
794 itself. In case of the first node, this pointer points to the last
795 node in the list. */
796 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
797 void *priv; /**< private user data, not used by libyang */
798 };
799 }; /**< common part corresponding to ::lyd_node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200800
801 struct lyd_node *child; /**< pointer to the first child node. */
802 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 +0200803#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 +0200804};
805
806/**
Michal Vaskof03ed032020-03-04 13:31:44 +0100807 * @brief Data node structure for the terminal data tree nodes - leaves and leaf-lists.
Radek Krejcie7b95092019-05-15 11:03:07 +0200808 */
809struct lyd_node_term {
Michal Vasko9e685082021-01-29 14:49:09 +0100810 union {
811 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
812 struct {
813 uint32_t hash; /**< hash of this particular node (module name + schema name + key string
814 values if list or hashes of all nodes of subtree in case of keyless
815 list). Note that while hash can be used to get know that nodes are
816 not equal, it cannot be used to decide that the nodes are equal due
817 to possible collisions. */
818 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
819 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
820 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
821 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
822 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
823 never NULL. If there is no sibling node, pointer points to the node
824 itself. In case of the first node, this pointer points to the last
825 node in the list. */
826 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
827 void *priv; /**< private user data, not used by libyang */
828 };
829 }; /**< common part corresponding to ::lyd_node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200830
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200831 struct lyd_value value; /**< node's value representation */
Radek Krejcie7b95092019-05-15 11:03:07 +0200832};
833
834/**
Christian Hopps61213e02021-04-12 20:41:32 -0400835 * @brief union for anydata/anyxml value representation.
836 */
837union lyd_any_value {
838 struct lyd_node *tree; /**< data tree */
839 const char *str; /**< Generic string data */
840 const char *xml; /**< Serialized XML data */
841 const char *json; /**< I-JSON encoded string */
842 char *mem; /**< LYD_ANYDATA_LYB memory chunk */
843};
844
845/**
846 * @brief Data node structure for the anydata data tree nodes - anydata or
847 * anyxml.
Radek Krejcie7b95092019-05-15 11:03:07 +0200848 */
849struct lyd_node_any {
Michal Vasko9e685082021-01-29 14:49:09 +0100850 union {
851 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
852 struct {
853 uint32_t hash; /**< hash of this particular node (module name + schema name + key string
854 values if list or hashes of all nodes of subtree in case of keyless
855 list). Note that while hash can be used to get know that nodes are
856 not equal, it cannot be used to decide that the nodes are equal due
857 to possible collisions. */
858 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
859 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
860 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
861 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
862 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
863 never NULL. If there is no sibling node, pointer points to the node
864 itself. In case of the first node, this pointer points to the last
865 node in the list. */
866 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
867 void *priv; /**< private user data, not used by libyang */
868 };
869 }; /**< common part corresponding to ::lyd_node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200870
Christian Hopps61213e02021-04-12 20:41:32 -0400871 union lyd_any_value value; /**< pointer to the stored value representation of the anydata/anyxml node */
Michal Vasko9e685082021-01-29 14:49:09 +0100872 LYD_ANYDATA_VALUETYPE value_type; /**< type of the data stored as ::lyd_node_any.value */
Radek Krejcie7b95092019-05-15 11:03:07 +0200873};
874
875/**
Michal Vasko1d4af6c2021-02-22 13:31:26 +0100876 * @brief Get the name (associated with) of a data node. Works for opaque nodes as well.
877 *
878 * @param[in] node Node to examine.
879 * @return Data node name.
880 */
881#define LYD_NAME(node) ((node)->schema ? (node)->schema->name : ((struct lyd_node_opaq *)node)->name.name)
882
883/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200884 * @ingroup datatree
885 * @defgroup lydvalhints Value format hints.
Radek Krejci1798aae2020-07-14 13:26:06 +0200886 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200887 *
888 * Hints for the type of the data value.
889 *
890 * Any information about value types encoded in the format is hinted by these values.
Radek Krejci1798aae2020-07-14 13:26:06 +0200891 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200892#define LYD_VALHINT_STRING 0x0001 /**< value is allowed to be a string */
893#define LYD_VALHINT_DECNUM 0x0002 /**< value is allowed to be a decimal number */
894#define LYD_VALHINT_OCTNUM 0x0004 /**< value is allowed to be an octal number */
895#define LYD_VALHINT_HEXNUM 0x0008 /**< value is allowed to be a hexadecimal number */
896#define LYD_VALHINT_NUM64 0x0010 /**< value is allowed to be an int64 or uint64 */
897#define LYD_VALHINT_BOOLEAN 0x0020 /**< value is allowed to be a boolean */
898#define LYD_VALHINT_EMPTY 0x0040 /**< value is allowed to be empty */
899/**
900 * @} lydvalhints
901 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200902
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200903/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200904 * @ingroup datatree
905 * @defgroup lydnodehints Node type format hints
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200906 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200907 *
908 * Hints for the type of the data node.
909 *
910 * Any information about node types encoded in the format is hinted by these values.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200911 */
912#define LYD_NODEHINT_LIST 0x0080 /**< node is allowed to be a list instance */
913#define LYD_NODEHINT_LEAFLIST 0x0100 /**< node is allowed to be a leaf-list instance */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200914/**
915 * @} lydnodehints
916 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200917
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200918/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200919 * @ingroup datatree
920 * @defgroup lydhints Value and node type format hints
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200921 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200922 *
923 * Hints for the types of data node and its value.
924 *
925 * Any information about value and node types encoded in the format is hinted by these values.
926 * It combines [value hints](@ref lydvalhints) and [node hints](@ref lydnodehints).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200927 */
928#define LYD_HINT_DATA 0x01F3 /**< special node/value hint to be used for generic data node/value (for cases when
929 there is no encoding or it does not provide any additional information about
930 a node/value type); do not combine with specific [value hints](@ref lydvalhints)
931 or [node hints](@ref lydnodehints). */
932#define LYD_HINT_SCHEMA 0x01FF /**< special node/value hint to be used for generic schema node/value(for cases when
933 there is no encoding or it does not provide any additional information about
934 a node/value type); do not combine with specific [value hints](@ref lydvalhints)
935 or [node hints](@ref lydnodehints). */
936/**
937 * @} lydhints
938 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200939
940/**
Michal Vasko52927e22020-03-16 17:26:14 +0100941 * @brief Data node structure for unparsed (opaque) nodes.
942 */
943struct lyd_node_opaq {
Michal Vasko9e685082021-01-29 14:49:09 +0100944 union {
945 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
946 struct {
947 uint32_t hash; /**< always 0 */
948 uint32_t flags; /**< always 0 */
949 const struct lysc_node *schema; /**< always NULL */
950 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
951 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
952 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
953 never NULL. If there is no sibling node, pointer points to the node
954 itself. In case of the first node, this pointer points to the last
955 node in the list. */
956 struct lyd_meta *meta; /**< always NULL */
957 void *priv; /**< private user data, not used by libyang */
958 };
959 }; /**< common part corresponding to ::lyd_node */
Michal Vasko52927e22020-03-16 17:26:14 +0100960
Michal Vasko501af032020-11-11 20:27:44 +0100961 struct lyd_node *child; /**< pointer to the child node (compatible with ::lyd_node_inner) */
962
Michal Vaskoad92b672020-11-12 13:11:31 +0100963 struct ly_opaq_name name; /**< node name with module information */
Michal Vasko52927e22020-03-16 17:26:14 +0100964 const char *value; /**< original value */
Michal Vaskod0c3bac2021-05-11 09:44:43 +0200965 uint32_t hints; /**< additional information about from the data source, see the [hints list](@ref lydhints) */
Radek Krejci8df109d2021-04-23 12:19:08 +0200966 LY_VALUE_FORMAT format; /**< format of the node and any prefixes, ::LY_VALUE_XML or ::LY_VALUE_JSON */
Radek Krejciec9ad602021-01-04 10:46:30 +0100967 void *val_prefix_data; /**< format-specific prefix data */
Michal Vasko501af032020-11-11 20:27:44 +0100968
Michal Vasko9e685082021-01-29 14:49:09 +0100969 struct lyd_attr *attr; /**< pointer to the list of generic attributes of this node */
Michal Vasko52927e22020-03-16 17:26:14 +0100970 const struct ly_ctx *ctx; /**< libyang context */
971};
972
973/**
Radek Krejcia1c1e542020-09-29 16:06:52 +0200974 * @brief Get the generic parent pointer of a data node.
975 *
976 * @param[in] node Node whose parent pointer to get.
977 * @return Pointer to the parent node of the @p node.
978 * @return NULL in case of the top-level node or if the @p node is NULL itself.
Michal Vasko5bfd4be2020-06-23 13:26:19 +0200979 */
Christian Hopps59618972021-02-01 05:01:35 -0500980static inline struct lyd_node *
981lyd_parent(const struct lyd_node *node)
982{
Michal Vasko9e543402021-06-11 13:55:30 +0200983 if (!node || !node->parent) {
Christian Hopps59618972021-02-01 05:01:35 -0500984 return NULL;
985 }
986
987 return &node->parent->node;
988}
Michal Vasko5bfd4be2020-06-23 13:26:19 +0200989
990/**
Radek Krejcia1c1e542020-09-29 16:06:52 +0200991 * @brief Get the child pointer of a generic data node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200992 *
Radek Krejcia1c1e542020-09-29 16:06:52 +0200993 * Decides the node's type and in case it has a children list, returns it. Supports even the opaq nodes (::lyd_node_opaq).
994 *
995 * If you need to skip key children, use ::lyd_child_no_keys().
996 *
997 * @param[in] node Node to use.
998 * @return Pointer to the first child node (if any) of the @p node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200999 */
Christian Hopps59618972021-02-01 05:01:35 -05001000static inline struct lyd_node *
1001lyd_child(const struct lyd_node *node)
1002{
1003 if (!node) {
1004 return NULL;
1005 }
1006
1007 if (!node->schema) {
1008 /* opaq node */
Michal Vasko5c7a8322021-06-25 09:12:05 +02001009 return ((const struct lyd_node_opaq *)node)->child;
Christian Hopps59618972021-02-01 05:01:35 -05001010 }
1011
1012 switch (node->schema->nodetype) {
1013 case LYS_CONTAINER:
1014 case LYS_LIST:
1015 case LYS_RPC:
1016 case LYS_ACTION:
1017 case LYS_NOTIF:
Michal Vasko5c7a8322021-06-25 09:12:05 +02001018 return ((const struct lyd_node_inner *)node)->child;
Christian Hopps59618972021-02-01 05:01:35 -05001019 default:
1020 return NULL;
1021 }
1022}
Radek Krejcia1c1e542020-09-29 16:06:52 +02001023
1024/**
1025 * @brief Get the child pointer of a generic data node but skip its keys in case it is ::LYS_LIST.
1026 *
1027 * Decides the node's type and in case it has a children list, returns it. Supports even the opaq nodes (::lyd_node_opaq).
1028 *
1029 * If you need to take key children into account, use ::lyd_child().
1030 *
1031 * @param[in] node Node to use.
1032 * @return Pointer to the first child node (if any) of the @p node.
1033 */
1034struct lyd_node *lyd_child_no_keys(const struct lyd_node *node);
Radek Krejcie7b95092019-05-15 11:03:07 +02001035
1036/**
Michal Vaskoc193ce92020-03-06 11:04:48 +01001037 * @brief Get the owner module of the data node. It is the module of the top-level schema node. Generally,
1038 * in case of augments it is the target module, recursively, otherwise it is the module where the data node is defined.
1039 *
Michal Vaskofcdf3012020-11-23 16:57:03 +01001040 * Also works for opaque nodes, if it is possible to resolve the module.
1041 *
Michal Vaskoc193ce92020-03-06 11:04:48 +01001042 * @param[in] node Data node to examine.
1043 * @return Module owner of the node.
1044 */
1045const struct lys_module *lyd_owner_module(const struct lyd_node *node);
1046
1047/**
Radek Krejci19611252020-10-04 13:54:53 +02001048 * @brief Check whether a node value equals to its default one.
1049 *
1050 * @param[in] node Term node to test.
1051 * @return false (no, it is not a default node) or true (yes, it is default)
1052 */
1053ly_bool lyd_is_default(const struct lyd_node *node);
1054
1055/**
Radek Krejcica989142020-11-05 11:32:22 +01001056 * @brief Learn the relative position of a list or leaf-list instance within other instances of the same schema node.
1057 *
1058 * @param[in] instance List or leaf-list instance to get the position of.
Michal Vaskoe78faec2021-04-08 17:24:43 +02001059 * @return 0 on error.
1060 * @return Positive integer of the @p instance position.
Radek Krejcica989142020-11-05 11:32:22 +01001061 */
1062uint32_t lyd_list_pos(const struct lyd_node *instance);
1063
1064/**
Radek Krejci4233f9b2020-11-05 12:38:35 +01001065 * @brief Get the first sibling of the given node.
1066 *
1067 * @param[in] node Node which first sibling is going to be the result.
1068 * @return The first sibling of the given node or the node itself if it is the first child of the parent.
1069 */
Michal Vasko6ae16d62020-11-06 17:23:23 +01001070struct lyd_node *lyd_first_sibling(const struct lyd_node *node);
Radek Krejci4233f9b2020-11-05 12:38:35 +01001071
1072/**
Michal Vasko60ea6352020-06-29 13:39:39 +02001073 * @brief Learn the length of LYB data.
1074 *
1075 * @param[in] data LYB data to examine.
1076 * @return Length of the LYB data chunk,
1077 * @return -1 on error.
1078 */
1079int lyd_lyb_data_length(const char *data);
1080
1081/**
Christian Hopps46bd21b2021-04-27 09:43:58 -04001082 * @brief Get the (canonical) value of a lyd_value.
1083 *
Michal Vasko33876022021-04-27 16:42:24 +02001084 * Whenever possible, ::lyd_get_value() or ::lyd_get_meta_value() should be used instead.
1085 *
Christian Hopps46bd21b2021-04-27 09:43:58 -04001086 * @param[in] ctx Context for the value
Michal Vasko33876022021-04-27 16:42:24 +02001087 * @param[in] value Value structure to use.
Christian Hopps46bd21b2021-04-27 09:43:58 -04001088 * @return Canonical value.
1089 */
1090const char *lyd_value_get_canonical(const struct ly_ctx *ctx, const struct lyd_value *value);
1091
1092/**
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001093 * @brief Get the (canonical) value of a data node.
1094 *
1095 * @param[in] node Data node to use.
1096 * @return Canonical value.
1097 */
Christian Hopps46bd21b2021-04-27 09:43:58 -04001098static inline const char *
1099lyd_get_value(const struct lyd_node *node)
1100{
1101 if (!node) {
1102 return NULL;
1103 }
1104
1105 if (!node->schema) {
Michal Vasko5c7a8322021-06-25 09:12:05 +02001106 return ((const struct lyd_node_opaq *)node)->value;
Christian Hopps46bd21b2021-04-27 09:43:58 -04001107 } else if (node->schema->nodetype & LYD_NODE_TERM) {
Michal Vasko5c7a8322021-06-25 09:12:05 +02001108 const struct lyd_value *value = &((const struct lyd_node_term *)node)->value;
Michal Vasko33876022021-04-27 16:42:24 +02001109 return value->_canonical ? value->_canonical : lyd_value_get_canonical(LYD_CTX(node), value);
Christian Hopps46bd21b2021-04-27 09:43:58 -04001110 }
Michal Vasko33876022021-04-27 16:42:24 +02001111
Christian Hopps46bd21b2021-04-27 09:43:58 -04001112 return NULL;
1113}
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001114
1115/**
1116 * @brief Get the (canonical) value of a metadata node.
1117 *
1118 * @param[in] meta Metadata node to use.
1119 * @return Canonical value.
1120 */
Christian Hopps46bd21b2021-04-27 09:43:58 -04001121static inline const char *
1122lyd_get_meta_value(const struct lyd_meta *meta)
1123{
1124 if (meta) {
1125 const struct lyd_value *value = &meta->value;
Michal Vasko33876022021-04-27 16:42:24 +02001126 return value->_canonical ? value->_canonical : lyd_value_get_canonical(meta->annotation->module->ctx, value);
Christian Hopps46bd21b2021-04-27 09:43:58 -04001127 }
Michal Vasko33876022021-04-27 16:42:24 +02001128
Christian Hopps46bd21b2021-04-27 09:43:58 -04001129 return NULL;
1130}
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001131
1132/**
Michal Vaskoa820c312021-02-05 16:33:00 +01001133 * @brief Get anydata string value.
1134 *
1135 * @param[in] any Anyxml/anydata node to read from.
1136 * @param[out] value_str String representation of the value.
1137 * @return LY_ERR value.
1138 */
1139LY_ERR lyd_any_value_str(const struct lyd_node *any, char **value_str);
1140
1141/**
Michal Vaskoc0004272020-08-06 08:32:34 +02001142 * @brief Copy anydata value from one node to another. Target value is freed first.
1143 *
1144 * @param[in,out] trg Target node.
1145 * @param[in] value Source value, may be NULL when the target value is only freed.
1146 * @param[in] value_type Source value type.
1147 * @return LY_ERR value.
1148 */
1149LY_ERR lyd_any_copy_value(struct lyd_node *trg, const union lyd_any_value *value, LYD_ANYDATA_VALUETYPE value_type);
1150
1151/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001152 * @brief Create a new inner node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001153 *
Radek Krejcidd2a7662021-03-12 11:26:34 +01001154 * To create list, use ::lyd_new_list() or ::lyd_new_list2().
1155 *
1156 * To create a top-level inner node defined in an extension instance, use ::lyd_new_ext_inner().
1157 *
Michal Vasko013a8182020-03-03 10:46:53 +01001158 * @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 +01001159 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001160 * @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 +01001161 * @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
1162 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001163 * @param[out] node Optional created node.
1164 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001165 */
Michal Vasko53587422021-02-05 16:34:13 +01001166LY_ERR lyd_new_inner(struct lyd_node *parent, const struct lys_module *module, const char *name, ly_bool output,
1167 struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001168
1169/**
Radek Krejcidd2a7662021-03-12 11:26:34 +01001170 * @brief Create a new top-level inner node defined in the given extension instance.
1171 *
1172 * To create list, use ::lyd_new_list() or ::lyd_new_list2().
1173 *
1174 * To create an inner node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1175 * node of a standard module's tree, use ::lyd_new_inner().
1176 *
1177 * @param[in] ext Extension instance where the inner node being created is defined.
1178 * @param[in] name Schema node name of the new data node. The node can be #LYS_CONTAINER, #LYS_NOTIF, #LYS_RPC, or #LYS_ACTION.
1179 * @param[out] node The created node.
1180 * @return LY_ERR value.
1181 */
1182LY_ERR lyd_new_ext_inner(const struct lysc_ext_instance *ext, const char *name, struct lyd_node **node);
1183
1184/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001185 * @brief Create a new list node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001186 *
1187 * @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 +01001188 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001189 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
Radek Krejci41ac9942020-11-02 14:47:56 +01001190 * @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
1191 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001192 * @param[out] node Optional created node.
Michal Vasko013a8182020-03-03 10:46:53 +01001193 * @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 +02001194 * or identityref value, the JSON format is expected (module names instead of prefixes). No keys are expected for
1195 * key-less lists.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001196 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001197 */
Radek Krejci55c4bd22021-04-26 08:09:04 +02001198LY_ERR lyd_new_list(struct lyd_node *parent, const struct lys_module *module, const char *name, ly_bool output,
1199 struct lyd_node **node, ...);
Michal Vasko013a8182020-03-03 10:46:53 +01001200
1201/**
Michal Vasko208e6d62021-06-28 11:23:50 +02001202 * @brief Create a new list node in the data tree.
1203 *
1204 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
1205 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
1206 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
1207 * @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
1208 * taken into consideration. Otherwise, the output's data node is going to be created.
1209 * @param[out] node Optional created node.
1210 * @param[in] ... Ordered binary key values of the new list instance, all must be set. Every key value must be followed
1211 * by its length. No keys are expected for key-less lists.
1212 * @return LY_ERR value.
1213 */
1214LY_ERR lyd_new_list_bin(struct lyd_node *parent, const struct lys_module *module, const char *name, ly_bool output,
1215 struct lyd_node **node, ...);
1216
1217/**
1218 * @brief Create a new list node in the data tree.
1219 *
1220 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
1221 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
1222 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
1223 * @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
1224 * taken into consideration. Otherwise, the output's data node is going to be created.
1225 * @param[out] node Optional created node.
1226 * @param[in] ... Ordered canonical key values of the new list instance, all must be set. No keys are expected for
1227 * key-less lists.
1228 * @return LY_ERR value.
1229 */
1230LY_ERR lyd_new_list_canon(struct lyd_node *parent, const struct lys_module *module, const char *name, ly_bool output,
1231 struct lyd_node **node, ...);
1232
1233/**
Radek Krejci8247bae2021-03-12 11:47:02 +01001234 * @brief Create a new top-level list node defined in the given extension instance.
1235 *
1236 * To create a list node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1237 * list node of a standard module's tree, use ::lyd_new_list() or ::lyd_new_list2().
1238 *
1239 * @param[in] ext Extension instance where the list node being created is defined.
1240 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
1241 * @param[out] node The created node.
1242 * @param[in] ... Ordered key values of the new list instance, all must be set. In case of an instance-identifier
1243 * or identityref value, the JSON format is expected (module names instead of prefixes). No keys are expected for
1244 * key-less lists.
1245 * @return LY_ERR value.
1246 */
1247LY_ERR lyd_new_ext_list(const struct lysc_ext_instance *ext, const char *name, struct lyd_node **node, ...);
1248
1249/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001250 * @brief Create a new list node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001251 *
1252 * @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 +01001253 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001254 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
1255 * @param[in] keys All key values predicate in the form of "[key1='val1'][key2='val2']...", they do not have to be ordered.
1256 * 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 +02001257 * Use NULL or string of length 0 in case of key-less list.
Radek Krejci41ac9942020-11-02 14:47:56 +01001258 * @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
1259 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001260 * @param[out] node Optional created node.
1261 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001262 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001263LY_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 +01001264 ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001265
1266/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001267 * @brief Create a new term node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001268 *
Radek Krejci8a5afc22021-03-12 11:10:47 +01001269 * To create a top-level term node defined in an extension instance, use ::lyd_new_ext_term().
1270 *
Michal Vasko013a8182020-03-03 10:46:53 +01001271 * @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 +01001272 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001273 * @param[in] name Schema node name of the new data node. The node can be #LYS_LEAF or #LYS_LEAFLIST.
Radek Krejci09c77442021-04-26 11:10:34 +02001274 * @param[in] val_str String value of the node. If it varies based on the format, ::LY_VALUE_JSON is expected.
Radek Krejci41ac9942020-11-02 14:47:56 +01001275 * @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
1276 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001277 * @param[out] node Optional created node.
1278 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001279 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001280LY_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 +01001281 ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001282
1283/**
Radek Krejci09c77442021-04-26 11:10:34 +02001284 * @brief Create a new term node in the data tree.
1285 *
1286 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
1287 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
1288 * @param[in] name Schema node name of the new data node. The node can be #LYS_LEAF or #LYS_LEAFLIST.
1289 * @param[in] value Binary value of the node. To learn what exactly is expected see @ref howtoDataLYB.
1290 * @param[in] value_len Length of @p value.
1291 * @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
1292 * taken into consideration. Otherwise, the output's data node is going to be created.
1293 * @param[out] node Optional created node.
1294 * @return LY_ERR value.
1295 */
1296LY_ERR lyd_new_term_bin(struct lyd_node *parent, const struct lys_module *module, const char *name, const void *value,
1297 size_t value_len, ly_bool output, struct lyd_node **node);
1298
1299/**
1300 * @brief Create a new term node in the data tree.
1301 *
1302 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
1303 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
1304 * @param[in] name Schema node name of the new data node. The node can be #LYS_LEAF or #LYS_LEAFLIST.
1305 * @param[in] val_str Canonical string value of the node. If it is not, it may lead to unexpected behavior.
1306 * @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
1307 * taken into consideration. Otherwise, the output's data node is going to be created.
1308 * @param[out] node Optional created node.
1309 * @return LY_ERR value.
1310 */
1311LY_ERR lyd_new_term_canon(struct lyd_node *parent, const struct lys_module *module, const char *name,
1312 const char *val_str, ly_bool output, struct lyd_node **node);
1313
1314/**
Radek Krejci8a5afc22021-03-12 11:10:47 +01001315 * @brief Create a new top-level term node defined in the given extension instance.
1316 *
1317 * To create a term node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1318 * node of a standard module's tree, use ::lyd_new_term().
1319 *
1320 * @param[in] ext Extension instance where the term node being created is defined.
1321 * @param[in] name Schema node name of the new data node. The node can be #LYS_LEAF or #LYS_LEAFLIST.
1322 * @param[in] val_str String form of the value of the node being created. In case of an instance-identifier or identityref
1323 * value, the JSON format is expected (module names instead of prefixes).
1324 * @param[out] node The created node.
1325 * @return LY_ERR value.
1326 */
1327LY_ERR lyd_new_ext_term(const struct lysc_ext_instance *ext, const char *name, const char *val_str, struct lyd_node **node);
1328
1329/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001330 * @brief Create a new any node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001331 *
Radek Krejci0b963da2021-03-12 13:23:44 +01001332 * To create a top-level any node defined in an extension instance, use ::lyd_new_ext_any().
1333 *
Michal Vasko013a8182020-03-03 10:46:53 +01001334 * @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 +01001335 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001336 * @param[in] name Schema node name of the new data node. The node can be #LYS_ANYDATA or #LYS_ANYXML.
Michal Vasko2a4ab2b2021-03-04 15:52:40 +01001337 * @param[in] value Value for the node. Expected type is determined by @p value_type.
1338 * @param[in] use_value Whether to directly take @p value and assign it to the node or make a copy.
Michal Vasko013a8182020-03-03 10:46:53 +01001339 * @param[in] value_type Type of the provided value in @p value.
Radek Krejci41ac9942020-11-02 14:47:56 +01001340 * @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
1341 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001342 * @param[out] node Optional created node.
1343 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001344 */
Michal Vasko2a4ab2b2021-03-04 15:52:40 +01001345LY_ERR lyd_new_any(struct lyd_node *parent, const struct lys_module *module, const char *name, const void *value,
1346 ly_bool use_value, LYD_ANYDATA_VALUETYPE value_type, ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001347
1348/**
Radek Krejci0b963da2021-03-12 13:23:44 +01001349 * @brief Create a new top-level any node defined in the given extension instance.
1350 *
1351 * To create an any node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1352 * any node of a standard module's tree, use ::lyd_new_any().
1353 *
1354 * @param[in] ext Extension instance where the any node being created is defined.
1355 * @param[in] name Schema node name of the new data node. The node can be #LYS_ANYDATA or #LYS_ANYXML.
1356 * @param[in] value Value for the node. Expected type is determined by @p value_type.
1357 * @param[in] use_value Whether to directly take @p value and assign it to the node or make a copy.
1358 * @param[in] value_type Type of the provided value in @p value.
1359 * @param[out] node The created node.
1360 * @return LY_ERR value.
1361 */
1362LY_ERR lyd_new_ext_any(const struct lysc_ext_instance *ext, const char *name, const void *value, ly_bool use_value,
1363 LYD_ANYDATA_VALUETYPE value_type, struct lyd_node **node);
1364
1365/**
Michal Vasko871a0252020-11-11 18:35:24 +01001366 * @brief Create new metadata.
Michal Vaskod86997b2020-05-26 15:19:54 +02001367 *
Michal Vasko871a0252020-11-11 18:35:24 +01001368 * @param[in] ctx libyang context,
1369 * @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 +02001370 * @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 +02001371 * @param[in] name Annotation name of the new metadata. It can include the annotation module as the prefix.
1372 * 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 +02001373 * @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 +02001374 * value, the JSON format is expected (module names instead of prefixes).
Michal Vasko871a0252020-11-11 18:35:24 +01001375 * @param[in] clear_dflt Whether to clear the default flag starting from @p parent, recursively all NP containers.
1376 * @param[out] meta Optional created metadata. Must be set if @p parent is NULL.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001377 * @return LY_ERR value.
Michal Vaskod86997b2020-05-26 15:19:54 +02001378 */
Michal Vasko871a0252020-11-11 18:35:24 +01001379LY_ERR lyd_new_meta(const struct ly_ctx *ctx, struct lyd_node *parent, const struct lys_module *module, const char *name,
1380 const char *val_str, ly_bool clear_dflt, struct lyd_meta **meta);
Michal Vaskod86997b2020-05-26 15:19:54 +02001381
1382/**
Michal Vaskoba696702020-11-11 19:12:45 +01001383 * @brief Create new metadata from an opaque node attribute if possible.
1384 *
1385 * @param[in] ctx libyang context.
1386 * @param[in] parent Optional parent node for the metadata being created. Must be set if @p meta is NULL.
1387 * @param[in] clear_dflt Whether to clear the default flag starting from @p parent, recursively all NP containers.
1388 * @param[in] attr Opaque node attribute to parse into metadata.
1389 * @param[out] meta Optional created metadata. Must be set if @p parent is NULL.
1390 * @return LY_SUCCESS on success.
1391 * @return LY_ENOT if the attribute could not be parsed into any metadata.
1392 * @return LY_ERR on error.
1393 */
1394LY_ERR lyd_new_meta2(const struct ly_ctx *ctx, struct lyd_node *parent, ly_bool clear_dflt, const struct lyd_attr *attr,
1395 struct lyd_meta **meta);
1396
1397/**
Michal Vasko8d65f852021-02-17 11:28:13 +01001398 * @brief Create a new JSON opaque node in the data tree. To create an XML opaque node, use ::lyd_new_opaq2().
Michal Vasko00cbf532020-06-15 13:58:47 +02001399 *
aPiecekb0445f22021-06-24 11:34:07 +02001400 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vasko00cbf532020-06-15 13:58:47 +02001401 * @param[in] ctx libyang context. If NULL, @p parent context will be used.
1402 * @param[in] name Node name.
Michal Vasko0ab974d2021-02-24 13:18:26 +01001403 * @param[in] value Optional node value.
1404 * @param[in] prefix Optional node prefix, must be equal to @p module_name if set.
Michal Vasko00cbf532020-06-15 13:58:47 +02001405 * @param[in] module_name Node module name.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001406 * @param[out] node Optional created node.
1407 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +02001408 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001409LY_ERR lyd_new_opaq(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value,
Michal Vasko0ab974d2021-02-24 13:18:26 +01001410 const char *prefix, const char *module_name, struct lyd_node **node);
Michal Vasko00cbf532020-06-15 13:58:47 +02001411
1412/**
Michal Vasko8d65f852021-02-17 11:28:13 +01001413 * @brief Create a new XML opaque node in the data tree. To create a JSON opaque node, use ::lyd_new_opaq().
1414 *
aPiecekb0445f22021-06-24 11:34:07 +02001415 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
Michal Vasko8d65f852021-02-17 11:28:13 +01001416 * @param[in] ctx libyang context. If NULL, @p parent context will be used.
1417 * @param[in] name Node name.
Michal Vasko0ab974d2021-02-24 13:18:26 +01001418 * @param[in] value Optional node value.
1419 * @param[in] prefix Optional node prefix.
Michal Vasko8d65f852021-02-17 11:28:13 +01001420 * @param[in] module_ns Node module namespace.
1421 * @param[out] node Optional created node.
1422 * @return LY_ERR value.
1423 */
1424LY_ERR lyd_new_opaq2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *name, const char *value,
Michal Vasko0ab974d2021-02-24 13:18:26 +01001425 const char *prefix, const char *module_ns, struct lyd_node **node);
Michal Vasko8d65f852021-02-17 11:28:13 +01001426
1427/**
1428 * @brief Create new JSON attribute for an opaque data node. To create an XML attribute, use ::lyd_new_attr2().
Michal Vasko00cbf532020-06-15 13:58:47 +02001429 *
1430 * @param[in] parent Parent opaque node for the attribute being created.
Radek Krejci8678fa42020-08-18 16:07:28 +02001431 * @param[in] module_name Name of the module of the attribute being created. There may be none.
Michal Vasko00cbf532020-06-15 13:58:47 +02001432 * @param[in] name Attribute name. It can include the module name as the prefix.
Michal Vasko8d65f852021-02-17 11:28:13 +01001433 * @param[in] value Attribute value, may be NULL.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001434 * @param[out] attr Optional created attribute.
1435 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +02001436 */
Michal Vasko8d65f852021-02-17 11:28:13 +01001437LY_ERR lyd_new_attr(struct lyd_node *parent, const char *module_name, const char *name, const char *value,
1438 struct lyd_attr **attr);
1439
1440/**
1441 * @brief Create new XML attribute for an opaque data node. To create a JSON attribute, use ::lyd_new_attr().
1442 *
1443 * @param[in] parent Parent opaque node for the attribute being created.
1444 * @param[in] module_ns Namespace of the module of the attribute being created. There may be none.
1445 * @param[in] name Attribute name. It can include an XML prefix.
1446 * @param[in] value Attribute value, may be NULL.
1447 * @param[out] attr Optional created attribute.
1448 * @return LY_ERR value.
1449 */
1450LY_ERR lyd_new_attr2(struct lyd_node *parent, const char *module_ns, const char *name, const char *value,
Radek Krejci0f969882020-08-21 16:56:47 +02001451 struct lyd_attr **attr);
Michal Vasko00cbf532020-06-15 13:58:47 +02001452
1453/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001454 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001455 * @defgroup pathoptions Data path creation options
Michal Vasko00cbf532020-06-15 13:58:47 +02001456 *
1457 * Various options to change lyd_new_path*() behavior.
1458 *
1459 * Default behavior:
1460 * - if the target node already exists (and is not default), an error is returned.
1461 * - the whole path to the target node is created (with any missing parents) if necessary.
1462 * - RPC output schema children are completely ignored in all modules. Input is searched and nodes created normally.
1463 * @{
1464 */
1465
Radek Krejci09c77442021-04-26 11:10:34 +02001466#define LYD_NEW_PATH_UPDATE 0x01 /**< If the target node exists, is a leaf, and it is updated with a new value or its
1467 default flag is changed, it is returned. If the target node exists and is not
1468 a leaf or generally no change occurs in the @p parent tree, NULL is returned and
1469 no error set. */
1470#define LYD_NEW_PATH_OUTPUT 0x02 /**< Changes the behavior to ignoring RPC/action input schema nodes and using only
1471 output ones. */
1472#define LYD_NEW_PATH_OPAQ 0x04 /**< Enables the creation of opaque nodes with some specific rules. If the __last node__
1473 in the path is not uniquely defined ((leaf-)list without a predicate) or has an
1474 invalid value (leaf/leaf-list), it is created as opaque. */
1475#define LYD_NEW_PATH_BIN_VALUE 0x08 /**< Interpret the provided leaf/leaf-list @p value as being in the binary
1476 ::LY_VALUE_LYB format, to learn what exactly is expected see @ref howtoDataLYB. */
1477#define LYD_NEW_PATH_CANON_VALUE 0x10 /**< Interpret the provided leaf/leaf-list @p value as being in the canonical
1478 (or JSON if no defined) ::LY_VALUE_CANON format. If it is not, it may lead
1479 to unexpected behavior. */
Michal Vasko00cbf532020-06-15 13:58:47 +02001480
1481/** @} pathoptions */
1482
1483/**
Michal Vaskod5e67442021-03-04 15:56:31 +01001484 * @brief Create a new node in the data tree based on a path. If creating anyxml/anydata nodes, ::lyd_new_path2
1485 * should be used instead, this function expects the value as string.
Michal Vasko00cbf532020-06-15 13:58:47 +02001486 *
Radek Krejci95ccd1b2021-03-12 14:57:22 +01001487 * If creating data nodes defined inside an extension instance, use ::lyd_new_ext_path().
1488 *
Michal Vaskoa918a632021-07-02 11:53:36 +02001489 * If @p path points to a list key, the key value from the predicate is used and @p value is ignored.
1490 * Also, if a leaf-list is being created and both a predicate is defined in @p path
Michal Vasko00cbf532020-06-15 13:58:47 +02001491 * and @p value is set, the predicate is preferred.
1492 *
Michal Vasko65591ab2021-04-09 14:29:34 +02001493 * For key-less lists and non-configuration leaf-lists, positional predicates should be used. If no predicate is used
1494 * for these nodes, they are always created.
Michal Vasko6741dc62021-02-04 09:27:45 +01001495 *
Michal Vasko104fe962020-11-06 17:23:44 +01001496 * @param[in] parent Data parent to add to/modify, can be NULL. Note that in case a first top-level sibling is used,
1497 * it may no longer be first if @p path is absolute and starts with a non-existing top-level node inserted
1498 * before @p parent. Use ::lyd_first_sibling() to adjust @p parent in these cases.
Michal Vasko00cbf532020-06-15 13:58:47 +02001499 * @param[in] ctx libyang context, must be set if @p parent is NULL.
Michal Vasko104fe962020-11-06 17:23:44 +01001500 * @param[in] path [Path](@ref howtoXPath) to create.
Radek Krejci09c77442021-04-26 11:10:34 +02001501 * @param[in] value String value of the new leaf/leaf-list. If it varies based on the format, ::LY_VALUE_JSON is expected.
1502 * For other node types, it should be NULL.
Michal Vasko00cbf532020-06-15 13:58:47 +02001503 * @param[in] options Bitmask of options, see @ref pathoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001504 * @param[out] node Optional first created node.
1505 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +02001506 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001507LY_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 +02001508 uint32_t options, struct lyd_node **node);
Michal Vasko00cbf532020-06-15 13:58:47 +02001509
1510/**
1511 * @brief Create a new node in the data tree based on a path. All node types can be created.
1512 *
Michal Vasko65591ab2021-04-09 14:29:34 +02001513 * Details are mentioned in ::lyd_new_path().
Michal Vasko6741dc62021-02-04 09:27:45 +01001514 *
Michal Vasko104fe962020-11-06 17:23:44 +01001515 * @param[in] parent Data parent to add to/modify, can be NULL. Note that in case a first top-level sibling is used,
1516 * it may no longer be first if @p path is absolute and starts with a non-existing top-level node inserted
1517 * before @p parent. Use ::lyd_first_sibling() to adjust @p parent in these cases.
Michal Vasko00cbf532020-06-15 13:58:47 +02001518 * @param[in] ctx libyang context, must be set if @p parent is NULL.
Michal Vasko104fe962020-11-06 17:23:44 +01001519 * @param[in] path [Path](@ref howtoXPath) to create.
Radek Krejci09c77442021-04-26 11:10:34 +02001520 * @param[in] value Value of the new leaf/leaf-list (const char *) in ::LY_VALUE_JSON format. If creating an
1521 * anyxml/anydata node, the expected type depends on @p value_type. For other node types, it should be NULL.
1522 * @param[in] value_len Length of @p value in bytes. May be 0 if @p value is a zero-terminated string. Ignored when
1523 * creating anyxml/anydata nodes.
Michal Vasko00cbf532020-06-15 13:58:47 +02001524 * @param[in] value_type Anyxml/anydata node @p value type.
1525 * @param[in] options Bitmask of options, see @ref pathoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001526 * @param[out] new_parent Optional first parent node created. If only one node was created, equals to @p new_node.
1527 * @param[out] new_node Optional last node created.
Michal Vasko00cbf532020-06-15 13:58:47 +02001528 * @return LY_ERR value.
1529 */
1530LY_ERR lyd_new_path2(struct lyd_node *parent, const struct ly_ctx *ctx, const char *path, const void *value,
Radek Krejci09c77442021-04-26 11:10:34 +02001531 size_t value_len, LYD_ANYDATA_VALUETYPE value_type, uint32_t options, struct lyd_node **new_parent,
1532 struct lyd_node **new_node);
Michal Vasko00cbf532020-06-15 13:58:47 +02001533
1534/**
Radek Krejci95ccd1b2021-03-12 14:57:22 +01001535 * @brief Create a new node defined in the given extension instance. In case of anyxml/anydata nodes, this function expects
1536 * the @p value as string.
1537 *
1538 * If creating data nodes defined in a module's standard tree, use ::lyd_new_path() or ::lyd_new_path2().
1539 *
Michal Vasko65591ab2021-04-09 14:29:34 +02001540 * Details are mentioned in ::lyd_new_path().
Radek Krejci95ccd1b2021-03-12 14:57:22 +01001541 *
1542 * @param[in] parent Data parent to add to/modify, can be NULL. Note that in case a first top-level sibling is used,
1543 * it may no longer be first if @p path is absolute and starts with a non-existing top-level node inserted
1544 * before @p parent. Use ::lyd_first_sibling() to adjust @p parent in these cases.
1545 * @param[in] ext Extension instance where the node being created is defined.
1546 * @param[in] path [Path](@ref howtoXPath) to create.
Radek Krejci09c77442021-04-26 11:10:34 +02001547 * @param[in] value Value of the new leaf/leaf-list. For other node types, it should be NULL.
Radek Krejci95ccd1b2021-03-12 14:57:22 +01001548 * @param[in] options Bitmask of options, see @ref pathoptions.
1549 * @param[out] node Optional first created node.
1550 * @return LY_ERR value.
1551 */
1552LY_ERR lyd_new_ext_path(struct lyd_node *parent, const struct lysc_ext_instance *ext, const char *path, const void *value,
1553 uint32_t options, struct lyd_node **node);
1554
1555/**
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001556 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001557 * @defgroup implicitoptions Implicit node creation options
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001558 *
1559 * Various options to change lyd_new_implicit*() behavior.
1560 *
1561 * Default behavior:
1562 * - both configuration and state missing implicit nodes are added.
Michal Vasko630d9892020-12-08 17:11:08 +01001563 * - for existing RPC/action nodes, input implicit nodes are added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001564 * - all implicit node types are added (non-presence containers, default leaves, and default leaf-lists).
1565 * @{
1566 */
1567
Michal Vasko44b19a12020-08-07 09:21:30 +02001568#define LYD_IMPLICIT_NO_STATE 0x01 /**< Do not add any implicit state nodes. */
1569#define LYD_IMPLICIT_NO_CONFIG 0x02 /**< Do not add any implicit config nodes. */
Michal Vasko630d9892020-12-08 17:11:08 +01001570#define LYD_IMPLICIT_OUTPUT 0x04 /**< For RPC/action nodes, add output implicit nodes instead of input. */
1571#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 +02001572 containers. */
1573
1574/** @} implicitoptions */
1575
1576/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001577 * @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 +02001578 *
1579 * @param[in] tree Tree to add implicit nodes into.
1580 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1581 * @param[out] diff Optional diff with any created nodes.
1582 * @return LY_ERR value.
1583 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001584LY_ERR lyd_new_implicit_tree(struct lyd_node *tree, uint32_t implicit_options, struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001585
1586/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001587 * @brief Add any missing implicit nodes. Default nodes with a false "when" are not added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001588 *
Michal Vaskod3bb12f2020-12-04 14:33:09 +01001589 * @param[in,out] tree Tree to add implicit nodes into. Note that in case a first top-level sibling is used,
1590 * it may no longer be first if an implicit node was inserted before @p tree. Use ::lyd_first_sibling() to
1591 * adjust @p tree in these cases.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001592 * @param[in] ctx libyang context, must be set only if @p tree is an empty tree.
1593 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1594 * @param[out] diff Optional diff with any created nodes.
1595 * @return LY_ERR value.
1596 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001597LY_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 +02001598
1599/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001600 * @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 +02001601 *
Michal Vaskod3bb12f2020-12-04 14:33:09 +01001602 * @param[in,out] tree Tree to add implicit nodes into. Note that in case a first top-level sibling is used,
1603 * it may no longer be first if an implicit node was inserted before @p tree. Use ::lyd_first_sibling() to
1604 * adjust @p tree in these cases.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001605 * @param[in] module Module whose implicit nodes to create.
1606 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1607 * @param[out] diff Optional diff with any created nodes.
1608 * @return LY_ERR value.
1609 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001610LY_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 +02001611 struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001612
1613/**
Radek Krejci09c77442021-04-26 11:10:34 +02001614 * @brief Change the value of a term (leaf or leaf-list) node to a string value.
Michal Vasko00cbf532020-06-15 13:58:47 +02001615 *
1616 * Node changed this way is always considered explicitly set, meaning its default flag
1617 * is always cleared.
1618 *
1619 * @param[in] term Term node to change.
1620 * @param[in] val_str New value to set, any prefixes are expected in JSON format.
1621 * @return LY_SUCCESS if value was changed,
1622 * @return LY_EEXIST if value was the same and only the default flag was cleared,
aPiecekb0445f22021-06-24 11:34:07 +02001623 * @return LY_ENOT if the values were equal and no change occurred,
Michal Vasko00cbf532020-06-15 13:58:47 +02001624 * @return LY_ERR value on other errors.
1625 */
1626LY_ERR lyd_change_term(struct lyd_node *term, const char *val_str);
1627
1628/**
Radek Krejci09c77442021-04-26 11:10:34 +02001629 * @brief Change the value of a term (leaf or leaf-list) node to a binary value.
1630 *
1631 * Node changed this way is always considered explicitly set, meaning its default flag
1632 * is always cleared.
1633 *
1634 * @param[in] term Term node to change.
1635 * @param[in] value New value to set in binary format, see @ref howtoDataLYB.
1636 * @param[in] value_len Length of @p value.
1637 * @return LY_SUCCESS if value was changed,
1638 * @return LY_EEXIST if value was the same and only the default flag was cleared,
aPiecekb0445f22021-06-24 11:34:07 +02001639 * @return LY_ENOT if the values were equal and no change occurred,
Radek Krejci09c77442021-04-26 11:10:34 +02001640 * @return LY_ERR value on other errors.
1641 */
1642LY_ERR lyd_change_term_bin(struct lyd_node *term, const void *value, size_t value_len);
1643
1644/**
1645 * @brief Change the value of a term (leaf or leaf-list) node to a canonical string value.
1646 *
1647 * Node changed this way is always considered explicitly set, meaning its default flag
1648 * is always cleared.
1649 *
1650 * @param[in] term Term node to change.
1651 * @param[in] val_str New value to set in canonical (or JSON if no defined) format. If the value is not
1652 * canonical, it may lead to unexpected behavior.
1653 * @return LY_SUCCESS if value was changed,
1654 * @return LY_EEXIST if value was the same and only the default flag was cleared,
aPiecekb0445f22021-06-24 11:34:07 +02001655 * @return LY_ENOT if the values were equal and no change occurred,
Radek Krejci09c77442021-04-26 11:10:34 +02001656 * @return LY_ERR value on other errors.
1657 */
1658LY_ERR lyd_change_term_canon(struct lyd_node *term, const char *val_str);
1659
1660/**
Michal Vasko41586352020-07-13 13:54:25 +02001661 * @brief Change the value of a metadata instance.
1662 *
Michal Vasko41586352020-07-13 13:54:25 +02001663 * @param[in] meta Metadata to change.
1664 * @param[in] val_str New value to set, any prefixes are expected in JSON format.
1665 * @return LY_SUCCESS if value was changed,
aPiecekb0445f22021-06-24 11:34:07 +02001666 * @return LY_ENOT if the values were equal and no change occurred,
Michal Vasko41586352020-07-13 13:54:25 +02001667 * @return LY_ERR value on other errors.
1668 */
1669LY_ERR lyd_change_meta(struct lyd_meta *meta, const char *val_str);
1670
1671/**
Michal Vaskob104f112020-07-17 09:54:54 +02001672 * @brief Insert a child into a parent.
Michal Vaskof03ed032020-03-04 13:31:44 +01001673 *
1674 * - if the node is part of some other tree, it is automatically unlinked.
1675 * - if the node is the first node of a node list (with no parent), all the subsequent nodes are also inserted.
1676 *
1677 * @param[in] parent Parent node to insert into.
1678 * @param[in] node Node to insert.
1679 * @return LY_SUCCESS on success.
1680 * @return LY_ERR error on error.
1681 */
Michal Vaskob104f112020-07-17 09:54:54 +02001682LY_ERR lyd_insert_child(struct lyd_node *parent, struct lyd_node *node);
Michal Vaskof03ed032020-03-04 13:31:44 +01001683
1684/**
Michal Vaskob104f112020-07-17 09:54:54 +02001685 * @brief Insert a node into siblings.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001686 *
1687 * - if the node is part of some other tree, it is automatically unlinked.
1688 * - if the node is the first node of a node list (with no parent), all the subsequent nodes are also inserted.
1689 *
Michal Vaskob104f112020-07-17 09:54:54 +02001690 * @param[in] sibling Siblings to insert into, can even be NULL.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001691 * @param[in] node Node to insert.
Michal Vaskob104f112020-07-17 09:54:54 +02001692 * @param[out] first Optionally return the first sibling after insertion. Can be the address of @p sibling.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001693 * @return LY_SUCCESS on success.
1694 * @return LY_ERR error on error.
1695 */
Michal Vaskob104f112020-07-17 09:54:54 +02001696LY_ERR lyd_insert_sibling(struct lyd_node *sibling, struct lyd_node *node, struct lyd_node **first);
Michal Vaskob1b5c262020-03-05 14:29:47 +01001697
1698/**
Michal Vaskob104f112020-07-17 09:54:54 +02001699 * @brief Insert a node before another node, can be used only for user-ordered nodes.
Michal Vasko4bc2ce32020-12-08 10:06:16 +01001700 * If inserting several siblings, each of them must be inserted individually.
Michal Vaskof03ed032020-03-04 13:31:44 +01001701 *
1702 * - if the node is part of some other tree, it is automatically unlinked.
Michal Vaskof03ed032020-03-04 13:31:44 +01001703 *
1704 * @param[in] sibling Sibling node to insert before.
1705 * @param[in] node Node to insert.
1706 * @return LY_SUCCESS on success.
1707 * @return LY_ERR error on error.
1708 */
1709LY_ERR lyd_insert_before(struct lyd_node *sibling, struct lyd_node *node);
1710
1711/**
Michal Vaskob104f112020-07-17 09:54:54 +02001712 * @brief Insert a node after another node, can be used only for user-ordered nodes.
Michal Vasko4bc2ce32020-12-08 10:06:16 +01001713 * If inserting several siblings, each of them must be inserted individually.
Michal Vaskof03ed032020-03-04 13:31:44 +01001714 *
1715 * - if the node is part of some other tree, it is automatically unlinked.
Michal Vaskof03ed032020-03-04 13:31:44 +01001716 *
1717 * @param[in] sibling Sibling node to insert after.
1718 * @param[in] node Node to insert.
1719 * @return LY_SUCCESS on success.
1720 * @return LY_ERR error on error.
1721 */
1722LY_ERR lyd_insert_after(struct lyd_node *sibling, struct lyd_node *node);
1723
1724/**
Michal Vasko66d508c2021-07-21 16:07:09 +02001725 * @brief Unlink the specified node with all the following siblings.
1726 *
1727 * @param[in] node Data tree node to be unlinked (together with all the children and following siblings).
1728 */
1729void lyd_unlink_siblings(struct lyd_node *node);
1730
1731/**
Michal Vaskof03ed032020-03-04 13:31:44 +01001732 * @brief Unlink the specified data subtree.
1733 *
1734 * @param[in] node Data tree node to be unlinked (together with all the children).
1735 */
1736void lyd_unlink_tree(struct lyd_node *node);
1737
1738/**
Radek Krejcib0849a22019-07-25 12:31:04 +02001739 * @brief Free all the nodes (even parents of the node) in the data tree.
Radek Krejcie7b95092019-05-15 11:03:07 +02001740 *
1741 * @param[in] node Any of the nodes inside the tree.
1742 */
1743void lyd_free_all(struct lyd_node *node);
1744
1745/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001746 * @brief Free all the sibling nodes (preceding as well as succeeding).
Radek Krejcib0849a22019-07-25 12:31:04 +02001747 *
1748 * @param[in] node Any of the sibling nodes to free.
1749 */
Michal Vaskof03ed032020-03-04 13:31:44 +01001750void lyd_free_siblings(struct lyd_node *node);
Radek Krejcib0849a22019-07-25 12:31:04 +02001751
1752/**
Radek Krejcie7b95092019-05-15 11:03:07 +02001753 * @brief Free (and unlink) the specified data (sub)tree.
1754 *
Radek Krejcie7b95092019-05-15 11:03:07 +02001755 * @param[in] node Root of the (sub)tree to be freed.
1756 */
1757void lyd_free_tree(struct lyd_node *node);
1758
1759/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001760 * @brief Free a single metadata instance.
Radek Krejcie7b95092019-05-15 11:03:07 +02001761 *
Michal Vasko3a41dff2020-07-15 14:30:28 +02001762 * @param[in] meta Metadata to free.
Radek Krejcie7b95092019-05-15 11:03:07 +02001763 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001764void lyd_free_meta_single(struct lyd_meta *meta);
Michal Vasko52927e22020-03-16 17:26:14 +01001765
1766/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001767 * @brief Free the metadata instance with any following instances.
1768 *
1769 * @param[in] meta Metadata to free.
1770 */
1771void lyd_free_meta_siblings(struct lyd_meta *meta);
1772
1773/**
1774 * @brief Free a single attribute.
Michal Vasko52927e22020-03-16 17:26:14 +01001775 *
1776 * @param[in] ctx Context where the attributes were created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001777 * @param[in] attr Attribute to free.
Michal Vasko52927e22020-03-16 17:26:14 +01001778 */
Radek Krejci011e4aa2020-09-04 15:22:31 +02001779void lyd_free_attr_single(const struct ly_ctx *ctx, struct lyd_attr *attr);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001780
1781/**
1782 * @brief Free the attribute with any following attributes.
1783 *
1784 * @param[in] ctx Context where the attributes were created.
1785 * @param[in] attr First attribute to free.
1786 */
Radek Krejci011e4aa2020-09-04 15:22:31 +02001787void lyd_free_attr_siblings(const struct ly_ctx *ctx, struct lyd_attr *attr);
Radek Krejcie7b95092019-05-15 11:03:07 +02001788
Radek Krejci084289f2019-07-09 17:35:30 +02001789/**
1790 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
1791 *
1792 * The given node is not modified in any way - it is just checked if the @p value can be set to the node.
1793 *
Radek Krejci084289f2019-07-09 17:35:30 +02001794 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
Michal Vaskoaebbce02021-04-06 09:23:37 +02001795 * @param[in] schema Schema node of the @p value.
Michal Vaskof937cfe2020-08-03 16:07:12 +02001796 * @param[in] value String value to be checked, it is expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02001797 * @param[in] value_len Length of the given @p value (mandatory).
Michal Vaskoaebbce02021-04-06 09:23:37 +02001798 * @param[in] ctx_node Optional data tree context node for the value (leafref target, instance-identifier).
1799 * If not set and is required for the validation to complete, ::LY_EINCOMPLETE is be returned.
1800 * @param[out] realtype Optional real type of @p value.
1801 * @param[out] canonical Optional canonical value of @p value (in the dictionary).
Radek Krejci084289f2019-07-09 17:35:30 +02001802 * @return LY_SUCCESS on success
Michal Vaskoaebbce02021-04-06 09:23:37 +02001803 * @return LY_EINCOMPLETE in case the @p ctx_node is not provided and it was needed to finish the validation
1804 * (e.g. due to require-instance).
Radek Krejci084289f2019-07-09 17:35:30 +02001805 * @return LY_ERR value if an error occurred.
1806 */
Michal Vaskoaebbce02021-04-06 09:23:37 +02001807LY_ERR lyd_value_validate(const struct ly_ctx *ctx, const struct lysc_node *schema, const char *value, size_t value_len,
1808 const struct lyd_node *ctx_node, const struct lysc_type **realtype, const char **canonical);
Radek Krejci084289f2019-07-09 17:35:30 +02001809
1810/**
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001811 * @brief Compare the node's value with the given string value. The string value is first validated according to
1812 * the (current) node's type.
Radek Krejci084289f2019-07-09 17:35:30 +02001813 *
1814 * @param[in] node Data node to compare.
1815 * @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 +02001816 * it is validated and canonized if possible. But it is expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02001817 * @param[in] value_len Length of the given @p value (mandatory).
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001818 * @return LY_SUCCESS on success,
1819 * @return LY_ENOT if the values do not match,
Radek Krejci084289f2019-07-09 17:35:30 +02001820 * @return LY_ERR value if an error occurred.
1821 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001822LY_ERR lyd_value_compare(const struct lyd_node_term *node, const char *value, size_t value_len);
Radek Krejci084289f2019-07-09 17:35:30 +02001823
Radek Krejci576b23f2019-07-12 14:06:32 +02001824/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001825 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001826 * @defgroup datacompareoptions Data compare options
1827 * @{
1828 * Various options to change the ::lyd_compare_single() and ::lyd_compare_siblings() behavior.
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001829 */
1830#define LYD_COMPARE_FULL_RECURSION 0x01 /* lists and containers are the same only in case all they children
1831 (subtree, so direct as well as indirect children) are the same. By default,
1832 containers are the same in case of the same schema node and lists are the same
1833 in case of equal keys (keyless lists do the full recursion comparison all the time). */
1834#define LYD_COMPARE_DEFAULTS 0x02 /* By default, implicit and explicit default nodes are considered to be equal. This flag
1835 changes this behavior and implicit (automatically created default node) and explicit
1836 (explicitly created node with the default value) default nodes are considered different. */
Michal Vasko60ea6352020-06-29 13:39:39 +02001837/** @} datacompareoptions */
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001838
1839/**
1840 * @brief Compare 2 data nodes if they are equivalent.
1841 *
1842 * @param[in] node1 The first node to compare.
1843 * @param[in] node2 The second node to compare.
Radek Krejcic5ad9652019-09-11 11:31:51 +02001844 * @param[in] options Various @ref datacompareoptions.
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001845 * @return LY_SUCCESS if the nodes are equivalent.
1846 * @return LY_ENOT if the nodes are not equivalent.
1847 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001848LY_ERR lyd_compare_single(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
Michal Vasko8f359bf2020-07-28 10:41:15 +02001849
1850/**
1851 * @brief Compare 2 lists of siblings if they are equivalent.
1852 *
1853 * @param[in] node1 The first sibling list to compare.
1854 * @param[in] node2 The second sibling list to compare.
1855 * @param[in] options Various @ref datacompareoptions.
1856 * @return LY_SUCCESS if all the siblings are equivalent.
1857 * @return LY_ENOT if the siblings are not equivalent.
1858 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001859LY_ERR lyd_compare_siblings(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001860
1861/**
Michal Vasko21725742020-06-29 11:49:25 +02001862 * @brief Compare 2 metadata.
1863 *
1864 * @param[in] meta1 First metadata.
1865 * @param[in] meta2 Second metadata.
1866 * @return LY_SUCCESS if the metadata are equivalent.
1867 * @return LY_ENOT if not.
1868 */
1869LY_ERR lyd_compare_meta(const struct lyd_meta *meta1, const struct lyd_meta *meta2);
1870
1871/**
Radek Krejci22ebdba2019-07-25 13:59:43 +02001872 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001873 * @defgroup dupoptions Data duplication options
Radek Krejci22ebdba2019-07-25 13:59:43 +02001874 *
Michal Vaskoe78faec2021-04-08 17:24:43 +02001875 * Various options to change ::lyd_dup_single() and ::lyd_dup_siblings() behavior.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001876 *
1877 * Default behavior:
1878 * - only the specified node is duplicated without siblings, parents, or children.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001879 * - all the metadata of the duplicated nodes are also duplicated.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001880 * @{
1881 */
1882
1883#define LYD_DUP_RECURSIVE 0x01 /**< Duplicate not just the node but also all the children. Note that
1884 list's keys are always duplicated. */
Michal Vasko9cf62422021-07-01 13:29:32 +02001885#define LYD_DUP_NO_META 0x02 /**< Do not duplicate metadata (or attributes) of any node. */
Radek Krejci22ebdba2019-07-25 13:59:43 +02001886#define LYD_DUP_WITH_PARENTS 0x04 /**< If a nested node is being duplicated, duplicate also all the parents.
1887 Keys are also duplicated for lists. Return value does not change! */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001888#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 +02001889 its validation/default node state. */
Radek Krejci22ebdba2019-07-25 13:59:43 +02001890
1891/** @} dupoptions */
1892
1893/**
1894 * @brief Create a copy of the specified data tree \p node. Schema references are kept the same.
1895 *
Radek Krejci22ebdba2019-07-25 13:59:43 +02001896 * @param[in] node Data tree node to be duplicated.
1897 * @param[in] parent Optional parent node where to connect the duplicated node(s).
Michal Vasko3a41dff2020-07-15 14:30:28 +02001898 * If set in combination with LYD_DUP_WITH_PARENTS, the parents chain is duplicated until it comes to and connects with
1899 * the @p parent.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001900 * @param[in] options Bitmask of options flags, see @ref dupoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001901 * @param[out] dup Optional created copy of the node. Note that in case the parents chain is duplicated for the duplicated
1902 * node(s) (when LYD_DUP_WITH_PARENTS used), the first duplicated node is still returned.
1903 * @return LY_ERR value.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001904 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001905LY_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 +02001906
1907/**
1908 * @brief Create a copy of the specified data tree \p node with any following siblings. Schema references are kept the same.
1909 *
1910 * @param[in] node Data tree node to be duplicated.
1911 * @param[in] parent Optional parent node where to connect the duplicated node(s).
1912 * If set in combination with LYD_DUP_WITH_PARENTS, the parents chain is duplicated until it comes to and connects with
1913 * the @p parent.
1914 * @param[in] options Bitmask of options flags, see @ref dupoptions.
1915 * @param[out] dup Optional created copy of the node. Note that in case the parents chain is duplicated for the duplicated
1916 * node(s) (when LYD_DUP_WITH_PARENTS used), the first duplicated node is still returned.
1917 * @return LY_ERR value.
1918 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001919LY_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 +02001920
1921/**
Michal Vasko25a32822020-07-09 15:48:22 +02001922 * @brief Create a copy of the metadata.
1923 *
1924 * @param[in] meta Metadata to copy.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001925 * @param[in] parent Node where to append the new metadata.
1926 * @param[out] dup Optional created metadata copy.
1927 * @return LY_ERR value.
Michal Vasko25a32822020-07-09 15:48:22 +02001928 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001929LY_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 +02001930
1931/**
Michal Vasko4490d312020-06-16 13:08:55 +02001932 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001933 * @defgroup mergeoptions Data merge options.
Radek Krejci576b23f2019-07-12 14:06:32 +02001934 *
Michal Vaskocd3f6172021-05-18 16:14:50 +02001935 * Various options to change ::lyd_merge_tree(), ::lyd_merge_siblings(), and ::lyd_merge_module() behavior.
Michal Vasko4490d312020-06-16 13:08:55 +02001936 *
1937 * Default behavior:
1938 * - source data tree is not modified in any way,
Michal Vasko745d6f62021-04-12 16:55:23 +02001939 * - any default nodes in the source are ignored if there are explicit nodes in the target,
1940 * - any metadata are ignored - those present in the target are kept, those in the source are not merged.
Michal Vasko7e8315b2021-08-03 17:01:06 +02001941 * - any merged nodes flags are set as non-validated.
Michal Vasko4490d312020-06-16 13:08:55 +02001942 * @{
1943 */
1944
1945#define LYD_MERGE_DESTRUCT 0x01 /**< Spend source data tree in the function, it cannot be used afterwards! */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001946#define LYD_MERGE_DEFAULTS 0x02 /**< Default nodes in the source tree replace even explicit nodes in the target. */
Michal Vasko7e8315b2021-08-03 17:01:06 +02001947#define LYD_MERGE_WITH_FLAGS 0x04 /**< Merged nodes (those missing in the source) keep their exact flags. */
Michal Vasko4490d312020-06-16 13:08:55 +02001948
1949/** @} mergeoptions */
1950
1951/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001952 * @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 +02001953 * is called on the resulting data tree (data from more cases may be present, default and non-default values).
1954 *
Michal Vasko2f510942020-11-13 10:26:25 +01001955 * Example input:
1956 *
1957 * source (A1) - A2 - A3 target (B1) - B2 - B3
1958 * /\ /\ /\ /\ /\ /\
1959 * .... .... .... .... .... ....
1960 *
1961 * result target (A1) - B1 - B2 - B3
1962 * /\ /\ /\ /\
1963 * .... .... .... ....
1964 *
Michal Vasko4490d312020-06-16 13:08:55 +02001965 * @param[in,out] target Target data tree to merge into, must be a top-level tree.
1966 * @param[in] source Source data tree to merge, must be a top-level tree.
1967 * @param[in] options Bitmask of option flags, see @ref mergeoptions.
1968 * @return LY_SUCCESS on success,
1969 * @return LY_ERR value on error.
1970 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001971LY_ERR lyd_merge_tree(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001972
1973/**
1974 * @brief Merge the source data tree with any following siblings into the target data tree. Merge may not be
1975 * complete until validation called on the resulting data tree (data from more cases may be present, default
1976 * and non-default values).
1977 *
Michal Vasko2f510942020-11-13 10:26:25 +01001978 * Example input:
1979 *
1980 * source (A1) - A2 - A3 target (B1) - B2 - B3
1981 * /\ /\ /\ /\ /\ /\
1982 * .... .... .... .... .... ....
1983 *
1984 * result target (A1) - A2 - A3 - B1 - B2 - B3
1985 * /\ /\ /\ /\ /\ /\
1986 * .... .... .... .... .... ....
1987 *
Michal Vasko3a41dff2020-07-15 14:30:28 +02001988 * @param[in,out] target Target data tree to merge into, must be a top-level tree.
1989 * @param[in] source Source data tree to merge, must be a top-level tree.
1990 * @param[in] options Bitmask of option flags, see @ref mergeoptions.
1991 * @return LY_SUCCESS on success,
1992 * @return LY_ERR value on error.
1993 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001994LY_ERR lyd_merge_siblings(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
Michal Vasko4490d312020-06-16 13:08:55 +02001995
1996/**
Michal Vaskocd3f6172021-05-18 16:14:50 +02001997 * @brief Callback for matching merge nodes.
1998 *
1999 * @param[in] trg_node Target data node.
2000 * @param[in] src_node Source data node, is NULL if it was actually duplicated (no target node found) and
2001 * its copy is @p trg_node.
2002 * @param[in] cb_data Arbitrary callback data.
2003 * @return LY_ERR value.
2004 */
2005typedef LY_ERR (*lyd_merge_cb)(struct lyd_node *trg_node, const struct lyd_node *src_node, void *cb_data);
2006
2007/**
2008 * @brief Merge all the nodes of a module from source data tree into the target data tree. Merge may not be
2009 * complete until validation called on the resulting data tree (data from more cases may be present, default
2010 * and non-default values).
2011 *
2012 * @param[in,out] target Target data tree to merge into, must be a top-level tree.
2013 * @param[in] source Source data tree to merge, must be a top-level tree.
2014 * @param[in] mod Module, whose source data only to consider, NULL for all modules.
Michal Vasko807557c2021-05-25 08:50:52 +02002015 * @param[in] merge_cb Optional merge callback that will be called for every merged node, before merging its descendants.
Michal Vaskocd3f6172021-05-18 16:14:50 +02002016 * If a subtree is being added into target (no matching node found), callback is called only once with the subtree root.
2017 * @param[in] cb_data Arbitrary callback data.
2018 * @param[in] options Bitmask of option flags, see @ref mergeoptions.
2019 * @return LY_SUCCESS on success,
2020 * @return LY_ERR value on error.
2021 */
2022LY_ERR lyd_merge_module(struct lyd_node **target, const struct lyd_node *source, const struct lys_module *mod,
2023 lyd_merge_cb merge_cb, void *cb_data, uint16_t options);
2024
2025/**
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002026 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02002027 * @defgroup diffoptions Data diff options.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002028 *
Radek Krejci8678fa42020-08-18 16:07:28 +02002029 * Various options to change ::lyd_diff_tree() and ::lyd_diff_siblings() behavior.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002030 *
2031 * Default behavior:
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002032 * - any default nodes are treated as non-existent and ignored.
2033 * @{
2034 */
2035
Michal Vasko3a41dff2020-07-15 14:30:28 +02002036#define LYD_DIFF_DEFAULTS 0x01 /**< Default nodes in the trees are not ignored but treated similarly to explicit
2037 nodes. Also, leaves and leaf-lists are added into diff even in case only their
2038 default flag (state) was changed. */
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002039
2040/** @} diffoptions */
2041
2042/**
2043 * @brief Learn the differences between 2 data trees.
2044 *
2045 * The resulting diff is represented as a data tree with specific metadata from the internal 'yang'
2046 * module. Most importantly, every node has an effective 'operation' metadata. If there is none
2047 * defined on the node, it inherits the operation from the nearest parent. Top-level nodes must
2048 * always have the 'operation' metadata defined. Additional metadata ('orig-default', 'value',
2049 * 'orig-value', 'key', 'orig-key') are used for storing more information about the value in the first
2050 * or the second tree.
2051 *
2052 * The diff tree is completely independent on the @p first and @p second trees, meaning all
2053 * the information about the change is stored in the diff and the trees are not needed.
2054 *
Michal Vaskoff857812021-03-05 17:03:52 +01002055 * __!! Caution !!__
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002056 * The diff tree should never be validated because it may easily not be valid! For example,
2057 * when data from one case branch are deleted and data from another branch created - data from both
2058 * branches are then stored in the diff tree simultaneously.
2059 *
2060 * @param[in] first First data tree.
2061 * @param[in] second Second data tree.
2062 * @param[in] options Bitmask of options flags, see @ref diffoptions.
2063 * @param[out] diff Generated diff.
2064 * @return LY_SUCCESS on success,
2065 * @return LY_ERR on error.
2066 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02002067LY_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 +02002068
2069/**
2070 * @brief Learn the differences between 2 data trees including all the following siblings.
2071 *
Michal Vaskoff857812021-03-05 17:03:52 +01002072 * Details are mentioned in ::lyd_diff_tree().
2073 *
Michal Vasko3a41dff2020-07-15 14:30:28 +02002074 * @param[in] first First data tree.
2075 * @param[in] second Second data tree.
2076 * @param[in] options Bitmask of options flags, see @ref diffoptions.
2077 * @param[out] diff Generated diff.
2078 * @return LY_SUCCESS on success,
2079 * @return LY_ERR on error.
2080 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02002081LY_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 +02002082
2083/**
2084 * @brief Callback for diff nodes.
2085 *
2086 * @param[in] diff_node Diff node.
2087 * @param[in] data_node Matching node in data.
2088 * @param[in] cb_data Arbitrary callback data.
2089 * @return LY_ERR value.
2090 */
2091typedef LY_ERR (*lyd_diff_cb)(const struct lyd_node *diff_node, struct lyd_node *data_node, void *cb_data);
2092
2093/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02002094 * @brief Apply the whole diff on a data tree but restrict the operation to one module.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002095 *
Michal Vaskoa98dcba2021-03-05 17:04:14 +01002096 * __!! Caution !!__
2097 * If applying a diff that was created __without__ the ::LYD_DIFF_DEFAULTS flag, there may be some duplicate values
2098 * created. Unless the resulting tree is validated (and default values thus consolidated), using it further
2099 * (such as applying another diff) may cause unexpected results or errors.
2100 *
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002101 * @param[in,out] data Data to apply the diff on.
2102 * @param[in] diff Diff to apply.
2103 * @param[in] mod Module, whose diff/data only to consider, NULL for all modules.
2104 * @param[in] diff_cb Optional diff callback that will be called for every changed node.
2105 * @param[in] cb_data Arbitrary callback data.
2106 * @return LY_SUCCESS on success,
2107 * @return LY_ERR on error.
2108 */
2109LY_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 +02002110 lyd_diff_cb diff_cb, void *cb_data);
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002111
2112/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02002113 * @brief Apply the whole diff tree on a data tree.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002114 *
Michal Vaskoff857812021-03-05 17:03:52 +01002115 * Details are mentioned in ::lyd_diff_apply_module().
2116 *
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002117 * @param[in,out] data Data to apply the diff on.
2118 * @param[in] diff Diff to apply.
2119 * @return LY_SUCCESS on success,
2120 * @return LY_ERR on error.
2121 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02002122LY_ERR lyd_diff_apply_all(struct lyd_node **data, const struct lyd_node *diff);
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002123
2124/**
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002125 * @ingroup datatree
2126 * @defgroup diffmergeoptions Data diff merge options.
2127 *
2128 * Various options to change ::lyd_diff_merge_module(), ::lyd_diff_merge_tree(), and ::lyd_diff_merge_all() behavior.
2129 *
2130 * Default behavior:
2131 * - any default nodes are expected to be a result of validation corrections and not explicitly modified.
2132 * @{
2133 */
2134
2135#define LYD_DIFF_MERGE_DEFAULTS 0x01 /**< Default nodes in the diffs are treated as possibly explicitly modified. */
2136
Michal Vaskoff857812021-03-05 17:03:52 +01002137/** @} diffmergeoptions */
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002138
2139/**
Michal Vaskoe6323f62020-07-09 15:49:02 +02002140 * @brief Merge 2 diffs into each other but restrict the operation to one module.
2141 *
2142 * The diffs must be possible to be merged, which is guaranteed only if the source diff was
2143 * created on data that had the target diff applied on them. In other words, this sequence is legal
2144 *
Michal Vaskoff857812021-03-05 17:03:52 +01002145 * 1) get diff1 from data1 and data2 -> get data11 from apply diff1 on data1 -> get diff2 from data11 and data3 ->
2146 * -> get data 33 from apply diff2 on data1
Michal Vaskoe6323f62020-07-09 15:49:02 +02002147 *
2148 * and reusing these diffs
2149 *
Michal Vaskoff857812021-03-05 17:03:52 +01002150 * 2) get diff11 from merge diff1 and diff2 -> get data33 from apply diff11 on data1
Michal Vaskoe6323f62020-07-09 15:49:02 +02002151 *
Michal Vaskofb737aa2020-08-06 13:53:53 +02002152 * @param[in,out] diff Target diff to merge into.
Michal Vaskoe6323f62020-07-09 15:49:02 +02002153 * @param[in] src_diff Source diff.
2154 * @param[in] mod Module, whose diff only to consider, NULL for all modules.
Michal Vaskoe2af8412020-12-03 14:11:38 +01002155 * @param[in] diff_cb Optional diff callback that will be called for every merged node. Param @p diff_node is the source
2156 * diff node while @p data_node is the updated target diff node. In case a whole subtree is added, the callback is
2157 * called on the root with @p diff_node being NULL.
Michal Vaskoe6323f62020-07-09 15:49:02 +02002158 * @param[in] cb_data Arbitrary callback data.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002159 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vaskoe6323f62020-07-09 15:49:02 +02002160 * @return LY_SUCCESS on success,
2161 * @return LY_ERR on error.
2162 */
Michal Vaskofb737aa2020-08-06 13:53:53 +02002163LY_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 +01002164 lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
Michal Vaskoe6323f62020-07-09 15:49:02 +02002165
2166/**
Michal Vasko04f85912020-08-07 12:14:58 +02002167 * @brief Merge 2 diff trees into each other.
2168 *
Michal Vaskoff857812021-03-05 17:03:52 +01002169 * Details are mentioned in ::lyd_diff_merge_module().
2170 *
Michal Vasko04f85912020-08-07 12:14:58 +02002171 * @param[in,out] diff_first Target diff first sibling to merge into.
2172 * @param[in] diff_parent Target diff parent to merge into.
2173 * @param[in] src_sibling Source diff sibling to merge.
Michal Vaskoe2af8412020-12-03 14:11:38 +01002174 * @param[in] diff_cb Optional diff callback that will be called for every merged node. Param @p diff_node is the source
2175 * diff node while @p data_node is the updated target diff node. In case a whole subtree is added, the callback is
2176 * called on the root with @p diff_node being NULL.
Michal Vasko04f85912020-08-07 12:14:58 +02002177 * @param[in] cb_data Arbitrary callback data.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002178 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vasko04f85912020-08-07 12:14:58 +02002179 * @return LY_SUCCESS on success,
2180 * @return LY_ERR on error.
2181 */
2182LY_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 +01002183 lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
Michal Vasko04f85912020-08-07 12:14:58 +02002184
2185/**
Michal Vaskoe6323f62020-07-09 15:49:02 +02002186 * @brief Merge 2 diffs into each other.
2187 *
Michal Vaskoff857812021-03-05 17:03:52 +01002188 * Details are mentioned in ::lyd_diff_merge_module().
2189 *
Michal Vaskoe6323f62020-07-09 15:49:02 +02002190 * @param[in,out] diff Target diff to merge into.
Michal Vaskofb737aa2020-08-06 13:53:53 +02002191 * @param[in] src_diff Source diff.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002192 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vaskoe6323f62020-07-09 15:49:02 +02002193 * @return LY_SUCCESS on success,
2194 * @return LY_ERR on error.
2195 */
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002196LY_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 +02002197
2198/**
Michal Vasko4231fb62020-07-13 13:54:47 +02002199 * @brief Reverse a diff and make the opposite changes. Meaning change create to delete, delete to create,
2200 * or move from place A to B to move from B to A and so on.
2201 *
2202 * @param[in] src_diff Diff to reverse.
2203 * @param[out] diff Reversed diff.
2204 * @return LY_SUCCESS on success.
2205 * @return LY_ERR on error.
2206 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02002207LY_ERR lyd_diff_reverse_all(const struct lyd_node *src_diff, struct lyd_node **diff);
Michal Vasko4231fb62020-07-13 13:54:47 +02002208
2209/**
Michal Vaskobb22b182021-06-14 08:14:21 +02002210 * @brief Deprecated, use ::lyd_find_target() instead.
Michal Vasko4490d312020-06-16 13:08:55 +02002211 *
2212 * @param[in] path Compiled path structure.
Michal Vaskof03ed032020-03-04 13:31:44 +01002213 * @param[in] tree Data tree to be searched.
Michal Vasko4490d312020-06-16 13:08:55 +02002214 * @return Found target node,
2215 * @return NULL if not found.
Radek Krejci576b23f2019-07-12 14:06:32 +02002216 */
Michal Vasko004d3152020-06-11 19:59:22 +02002217const struct lyd_node_term *lyd_target(const struct ly_path *path, const struct lyd_node *tree);
Radek Krejci084289f2019-07-09 17:35:30 +02002218
Michal Vasko5ec7cda2019-09-11 13:43:08 +02002219/**
Michal Vasko5ec7cda2019-09-11 13:43:08 +02002220 * @brief Types of the different data paths.
2221 */
2222typedef enum {
Radek Krejci635d2b82021-01-04 11:26:51 +01002223 LYD_PATH_STD, /**< Generic data path used for logging, node searching (::lyd_find_xpath(), ::lys_find_path()) as well as
Radek Krejci95ccd1b2021-03-12 14:57:22 +01002224 creating new nodes (::lyd_new_path(), ::lyd_new_path2(), ::lyd_new_ext_path()). */
Radek Krejci635d2b82021-01-04 11:26:51 +01002225 LYD_PATH_STD_NO_LAST_PRED /**< Similar to ::LYD_PATH_STD except there is never a predicate on the last node. While it
2226 can be used to search for nodes, do not use it to create new data nodes (lists). */
Michal Vasko5ec7cda2019-09-11 13:43:08 +02002227} LYD_PATH_TYPE;
2228
2229/**
2230 * @brief Generate path of the given node in the requested format.
2231 *
Radek Krejci635d2b82021-01-04 11:26:51 +01002232 * @param[in] node Data path of this node will be generated.
Michal Vasko5ec7cda2019-09-11 13:43:08 +02002233 * @param[in] pathtype Format of the path to generate.
2234 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
2235 * If NULL, memory for the complete path is allocated.
2236 * @param[in] buflen Size of the provided @p buffer.
2237 * @return NULL in case of memory allocation error, path of the node otherwise.
2238 * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it.
2239 */
2240char *lyd_path(const struct lyd_node *node, LYD_PATH_TYPE pathtype, char *buffer, size_t buflen);
2241
Michal Vaskoe444f752020-02-10 12:20:06 +01002242/**
Michal Vasko25a32822020-07-09 15:48:22 +02002243 * @brief Find a specific metadata.
2244 *
2245 * @param[in] first First metadata to consider.
2246 * @param[in] module Module of the metadata definition, may be NULL if @p name includes a prefix.
2247 * @param[in] name Name of the metadata to find, may not include a prefix (module name) if @p module is set.
2248 * @return Found metadata,
2249 * @return NULL if not found.
2250 */
2251struct lyd_meta *lyd_find_meta(const struct lyd_meta *first, const struct lys_module *module, const char *name);
2252
2253/**
Michal Vaskoda859032020-07-14 12:20:14 +02002254 * @brief Search in the given siblings (NOT recursively) for the first target instance with the same value.
Michal Vaskoe444f752020-02-10 12:20:06 +01002255 * Uses hashes - should be used whenever possible for best performance.
2256 *
2257 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
2258 * @param[in] target Target node to find.
Michal Vasko9b368d32020-02-14 13:53:31 +01002259 * @param[out] match Can be NULL, otherwise the found data node.
Michal Vaskoe444f752020-02-10 12:20:06 +01002260 * @return LY_SUCCESS on success, @p match set.
2261 * @return LY_ENOTFOUND if not found, @p match set to NULL.
2262 * @return LY_ERR value if another error occurred.
2263 */
2264LY_ERR lyd_find_sibling_first(const struct lyd_node *siblings, const struct lyd_node *target, struct lyd_node **match);
2265
2266/**
Michal Vaskoe444f752020-02-10 12:20:06 +01002267 * @brief Search in the given siblings for the first schema instance.
2268 * Uses hashes - should be used whenever possible for best performance.
2269 *
2270 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
2271 * @param[in] schema Schema node of the data node to find.
Michal Vaskob104f112020-07-17 09:54:54 +02002272 * @param[in] key_or_value If it is NULL, the first schema node data instance is found. For nodes with many
2273 * instances, it can be set based on the type of @p schema:
Michal Vaskoe444f752020-02-10 12:20:06 +01002274 * LYS_LEAFLIST:
2275 * Searched instance value.
2276 * LYS_LIST:
Michal Vasko90932a92020-02-12 14:33:03 +01002277 * Searched instance key values in the form of "[key1='val1'][key2='val2']...".
2278 * The keys do not have to be ordered but all of them must be set.
2279 *
2280 * Note that any explicit values (leaf-list or list key values) will be canonized first
2281 * before comparison. But values that do not have a canonical value are expected to be in the
2282 * JSON format!
Michal Vaskof03ed032020-03-04 13:31:44 +01002283 * @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 +01002284 * @param[out] match Can be NULL, otherwise the found data node.
Michal Vaskoe444f752020-02-10 12:20:06 +01002285 * @return LY_SUCCESS on success, @p match set.
2286 * @return LY_ENOTFOUND if not found, @p match set to NULL.
2287 * @return LY_EINVAL if @p schema is a key-less list.
2288 * @return LY_ERR value if another error occurred.
2289 */
2290LY_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 +02002291 size_t val_len, struct lyd_node **match);
Michal Vaskoe444f752020-02-10 12:20:06 +01002292
Michal Vaskoccc02342020-05-21 10:09:21 +02002293/**
Michal Vaskoe78faec2021-04-08 17:24:43 +02002294 * @brief Search the given siblings for all the exact same instances of a specific node instance. Accepts only nodes
2295 * that are allowed to have several exact same instances. Uses hashes to whatever extent possible.
2296 *
2297 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
2298 * @param[in] target Target node instance to find.
2299 * @param[out] set Set with all the found instances. The first item is always the first instance.
2300 * @return LY_SUCCESS on success, @p set returned.
2301 * @return LY_ENOTFOUND if not found, empty @p set returned.
2302 * @return LY_ERR value if another error occurred.
2303 */
2304LY_ERR lyd_find_sibling_dup_inst_set(const struct lyd_node *siblings, const struct lyd_node *target, struct ly_set **set);
2305
2306/**
Michal Vasko1d4af6c2021-02-22 13:31:26 +01002307 * @brief Search the given siblings for an opaque node with a specific name.
2308 *
2309 * @param[in] first First sibling to consider.
2310 * @param[in] name Opaque node name to find.
2311 * @param[out] match Can be NULL, otherwise the found data node.
2312 * @return LY_SUCCESS on success, @p match set.
2313 * @return LY_ENOTFOUND if not found, @p match set to NULL.
2314 * @return LY_ERR value is an error occurred.
2315 */
2316LY_ERR lyd_find_sibling_opaq_next(const struct lyd_node *first, const char *name, struct lyd_node **match);
2317
2318/**
aPiecekdf23eee2021-10-07 12:21:50 +02002319 * @brief Set a new XPath variable to @p vars.
2320 *
2321 * @param[in,out] vars Pointer to [sized array](@ref sizedarrays) of XPath variables.
2322 * To create a new array, set the @p vars target pointer to NULL.
2323 * Otherwise variable named @p name with a value @p value will be added to the @p vars
2324 * or its value will be changed if the variable is already defined.
2325 * @param[in] name Name of the added/edited variable.
2326 * @param[in] value Value of the variable.
2327 * @return LY_ERR value.
2328 */
2329LY_ERR lyxp_vars_set(struct lyxp_var **vars, const char *name, const char *value);
2330
2331/**
2332 * @brief Free the XPath variables.
2333 *
2334 * @param[in] vars [Sized array](@ref sizedarrays) of XPath variables.
2335 */
2336void lyxp_vars_free(struct lyxp_var *vars);
2337
2338/**
Michal Vaskoccc02342020-05-21 10:09:21 +02002339 * @brief Search in the given data for instances of nodes matching the provided XPath.
2340 *
Michal Vasko19a30602020-05-25 10:40:19 +02002341 * If a list instance is being selected with all its key values specified (but not necessarily ordered)
2342 * in the form `list[key1='val1'][key2='val2'][key3='val3']` or a leaf-list instance in the form
2343 * `leaf-list[.='val']`, these instances are found using hashes with constant (*O(1)*) complexity
2344 * (unless they are defined in top-level). Other predicates can still follow the aforementioned ones.
2345 *
Michal Vaskoccc02342020-05-21 10:09:21 +02002346 * @param[in] ctx_node XPath context node.
Michal Vasko3e1f6552021-01-14 09:27:55 +01002347 * @param[in] xpath [XPath](@ref howtoXPath) to select.
Michal Vaskoccc02342020-05-21 10:09:21 +02002348 * @param[out] set Set of found data nodes. In case the result is a number, a string, or a boolean,
2349 * the returned set is empty.
2350 * @return LY_SUCCESS on success, @p set is returned.
2351 * @return LY_ERR value if an error occurred.
2352 */
2353LY_ERR lyd_find_xpath(const struct lyd_node *ctx_node, const char *xpath, struct ly_set **set);
2354
Michal Vasko3e1f6552021-01-14 09:27:55 +01002355/**
aPiecekfba75362021-10-07 12:39:48 +02002356 * @brief Search in the given data for instances of nodes matching the provided XPath.
2357 *
2358 * It is just lyd_find_xpath() with @p vars added.
2359 *
2360 * @param[in] ctx_node XPath context node.
2361 * @param[in] xpath [XPath](@ref howtoXPath) to select.
2362 * @param[in] vars [Sized array](@ref sizedarrays) of XPath variables.
2363 * @param[out] set Set of found data nodes. In case the result is a number, a string, or a boolean,
2364 * the returned set is empty.
2365 * @return LY_SUCCESS on success, @p set is returned.
2366 * @return LY_ERR value if an error occurred.
2367 */
2368LY_ERR lyd_find_xpath2(const struct lyd_node *ctx_node, const char *xpath,
2369 const struct lyxp_var *vars, struct ly_set **set);
2370
2371/**
Michal Vaskoc9eb3ca2021-07-16 10:20:37 +02002372 * @brief Evaluate an XPath on data and return the result converted to boolean.
2373 *
2374 * Optimizations similar as in ::lyd_find_xpath().
2375 *
2376 * @param[in] ctx_node XPath context node.
2377 * @param[in] xpath [XPath](@ref howtoXPath) to select.
Michal Vasko080155c2021-10-14 09:22:16 +02002378 * @param[out] result Expression result converted to boolean.
Michal Vaskoc9eb3ca2021-07-16 10:20:37 +02002379 * @return LY_SUCCESS on success, @p result is returned.
2380 * @return LY_ERR value if an error occurred.
2381 */
2382LY_ERR lyd_eval_xpath(const struct lyd_node *ctx_node, const char *xpath, ly_bool *result);
2383
2384/**
aPiecekfba75362021-10-07 12:39:48 +02002385 * @brief Evaluate an XPath on data and return the result converted to boolean.
2386 *
2387 * The lyd_eval_xpath() with @p vars added.
2388 *
2389 * @param[in] ctx_node XPath context node.
2390 * @param[in] xpath [XPath](@ref howtoXPath) to select.
2391 * @param[in] vars [Sized array](@ref sizedarrays) of XPath variables.
Michal Vasko080155c2021-10-14 09:22:16 +02002392 * @param[out] result Expression result converted to boolean.
aPiecekfba75362021-10-07 12:39:48 +02002393 * @return LY_SUCCESS on success, @p result is returned.
2394 * @return LY_ERR value if an error occurred.
2395 */
2396LY_ERR lyd_eval_xpath2(const struct lyd_node *ctx_node, const char *xpath,
2397 const struct lyxp_var *vars, ly_bool *result);
2398
2399/**
Michal Vaskoc84c9962021-05-18 16:16:29 +02002400 * @brief Search in given data for a node uniquely identified by a path.
Michal Vasko3e1f6552021-01-14 09:27:55 +01002401 *
Michal Vasko257bdcf2021-01-14 13:15:30 +01002402 * Always works in constant (*O(1)*) complexity. To be exact, it is *O(n)* where *n* is the depth
2403 * of the path used.
2404 *
Michal Vasko3e1f6552021-01-14 09:27:55 +01002405 * @param[in] ctx_node Path context node.
2406 * @param[in] path [Path](@ref howtoXPath) to find.
2407 * @param[in] output Whether to search in RPC/action output nodes or in input nodes.
2408 * @param[out] match Can be NULL, otherwise the found data node.
2409 * @return LY_SUCCESS on success, @p match is set to the found node.
2410 * @return LY_EINCOMPLETE if only a parent of the node was found, @p match is set to this parent node.
2411 * @return LY_ENOTFOUND if no nodes in the path were found.
2412 * @return LY_ERR on other errors.
2413 */
2414LY_ERR lyd_find_path(const struct lyd_node *ctx_node, const char *path, ly_bool output, struct lyd_node **match);
2415
Michal Vasko43297a02021-05-19 11:12:37 +02002416/**
Michal Vaskobb22b182021-06-14 08:14:21 +02002417 * @brief Find the target node of a compiled path (::lyd_value instance-identifier).
2418 *
2419 * @param[in] path Compiled path structure.
2420 * @param[in] tree Data tree to be searched.
2421 * @param[out] match Can be NULL, otherwise the found data node.
2422 * @return LY_SUCCESS on success, @p match is set to the found node.
2423 * @return LY_ENOTFOUND if no match was found.
2424 * @return LY_ERR on other errors.
2425 */
2426LY_ERR lyd_find_target(const struct ly_path *path, const struct lyd_node *tree, struct lyd_node **match);
2427
2428/**
Michal Vasko43297a02021-05-19 11:12:37 +02002429 * @brief Convert date-and-time from string to UNIX timestamp and fractions of a second.
2430 *
2431 * @param[in] value Valid string date-and-time value.
2432 * @param[out] time UNIX timestamp.
2433 * @param[out] fractions_s Optional fractions of a second, set to NULL if none.
2434 * @return LY_ERR value.
2435 */
2436LY_ERR ly_time_str2time(const char *value, time_t *time, char **fractions_s);
2437
2438/**
2439 * @brief Convert UNIX timestamp and fractions of a second into canonical date-and-time string value.
2440 *
2441 * @param[in] time UNIX timestamp.
2442 * @param[in] fractions_s Fractions of a second, if any.
Michal Vaskoc515a2b2021-05-19 11:55:00 +02002443 * @param[out] str String date-and-time value in the local timezone.
Michal Vasko43297a02021-05-19 11:12:37 +02002444 * @return LY_ERR value.
2445 */
2446LY_ERR ly_time_time2str(time_t time, const char *fractions_s, char **str);
2447
2448/**
2449 * @brief Convert date-and-time from string to timespec.
2450 *
2451 * @param[in] value Valid string date-and-time value.
2452 * @param[out] ts Timespec.
2453 * @return LY_ERR value.
2454 */
2455LY_ERR ly_time_str2ts(const char *value, struct timespec *ts);
2456
2457/**
2458 * @brief Convert timespec into date-and-time string value.
2459 *
2460 * @param[in] ts Timespec.
Michal Vaskoc515a2b2021-05-19 11:55:00 +02002461 * @param[out] str String date-and-time value in the local timezone.
Michal Vasko43297a02021-05-19 11:12:37 +02002462 * @return LY_ERR value.
2463 */
2464LY_ERR ly_time_ts2str(const struct timespec *ts, char **str);
2465
Radek Krejcie7b95092019-05-15 11:03:07 +02002466#ifdef __cplusplus
2467}
2468#endif
2469
2470#endif /* LY_TREE_DATA_H_ */