blob: a9f836aa5303fbc06e3f48cb5e925fcedef9879c [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;
Radek Krejcie7b95092019-05-15 11:03:07 +020044
Radek Krejcie7b95092019-05-15 11:03:07 +020045/**
Radek Krejci8678fa42020-08-18 16:07:28 +020046 * @page howtoData Data Instances
47 *
48 * All the nodes in data tree comes are based on ::lyd_node structure. According to the content of the ::lyd_node.schema
49 * it can be cast to several other structures.
50 *
51 * In case the ::lyd_node.schema pointer is NULL, the node is actually __opaq__ and can be safely cast to ::lyd_node_opaq.
52 * The opaq node represent an unknown node which wasn't mapped to any [(compiled) schema](@ref howtoSchema) node in the
53 * context. Such a node can appear in several places in the data tree.
54 * - As a part of the tree structure, but only in the case the ::LYD_PARSE_OPAQ option was used when input data were
55 * [parsed](@ref howtoDataParsers), because unknown data instances are ignored by default. The same way, the opaq nodes can
56 * appear as a node's attributes.
57 * - As a representation of YANG anydata/anyxml content.
58 * - As envelopes of standard data tree instances (RPCs, actions or Notifications).
59 *
60 * In case the data node has its definition in a [compiled schema tree](@ref howtoSchema), the structure of the data node is
61 * actually one of the followings according to the schema node's nodetype (::lysc_node.nodetype).
62 * - ::lyd_node_inner - represents data nodes corresponding to schema nodes matching ::LYD_NODE_INNER nodetypes. They provide
63 * structure of the tree by having children nodes.
64 * - ::lyd_node_term - represents data nodes corresponding to schema nodes matching ::LYD_NODE_TERM nodetypes. The terminal
65 * nodes provide values of the particular configuration/status information. The values are represented as ::lyd_value
Radek Krejci6d5ba0c2021-04-26 07:49:59 +020066 * structure with string representation of the value (retrieved by ::lyd_get_value() and ::lyd_get_meta_value()) and
67 * the type specific data stored in the structure's union according to the real type of the value (::lyd_value.realtype).
68 * The string representation provides canonical representation of the value in case the type has the canonical
69 * representation specified. Otherwise, it is the original value or, in case the value can contain prefixes, the JSON
70 * format is used to make the value unambiguous.
Radek Krejci8678fa42020-08-18 16:07:28 +020071 * - ::lyd_node_any - represents data nodes corresponding to schema nodes matching ::LYD_NODE_ANY nodetypes.
72 *
73 * Despite all the aforementioned structures and their members are available as part of the libyang API and callers can use
74 * it to navigate through the data tree structure or to obtain various information, we recommend to use the following macros
75 * and functions.
76 * - ::lyd_child() (or ::lyd_child_no_keys()) and ::lyd_parent() to get the node's child/parent node.
77 * - ::LYD_CTX to get libyang context from a data node.
Radek Krejci6d5ba0c2021-04-26 07:49:59 +020078 * - ::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 +020079 * - ::LYD_TREE_DFS_BEGIN and ::LYD_TREE_DFS_END to traverse the data tree (depth-first).
80 * - ::LY_LIST_FOR and ::LY_ARRAY_FOR as described on @ref howtoStructures page.
81 *
82 * Instead of going through the data tree on your own, a specific data node can be also located using a wide set of
83 * \b lyd_find_*() functions.
84 *
85 * More information about specific operations with data instances can be found on the following pages:
86 * - @subpage howtoDataParsers
87 * - @subpage howtoDataValidation
88 * - @subpage howtoDataWD
89 * - @subpage howtoDataManipulation
90 * - @subpage howtoDataPrinters
Radek Krejcif9943642021-04-26 10:18:21 +020091 * - @subpage howtoDataLYB
Radek Krejci8678fa42020-08-18 16:07:28 +020092 *
93 * \note API for this group of functions is described in the [Data Instances module](@ref datatree).
94 *
95 * Functions List (not assigned to above subsections)
96 * --------------------------------------------------
97 * - ::lyd_child()
98 * - ::lyd_child_no_keys()
99 * - ::lyd_parent()
100 * - ::lyd_owner_module()
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200101 * - ::lyd_get_value()
102 * - ::lyd_get_meta_value()
Radek Krejci8678fa42020-08-18 16:07:28 +0200103 * - ::lyd_find_xpath()
Michal Vasko3e1f6552021-01-14 09:27:55 +0100104 * - ::lyd_find_path()
Michal Vaskobb22b182021-06-14 08:14:21 +0200105 * - ::lyd_find_target()
Radek Krejci8678fa42020-08-18 16:07:28 +0200106 * - ::lyd_find_sibling_val()
107 * - ::lyd_find_sibling_first()
Michal Vasko1d4af6c2021-02-22 13:31:26 +0100108 * - ::lyd_find_sibling_opaq_next()
Radek Krejci8678fa42020-08-18 16:07:28 +0200109 * - ::lyd_find_meta()
110 *
111 * - ::lyd_path()
112 * - ::lyd_target()
113 *
114 * - ::lyd_lyb_data_length()
Radek Krejci75104122021-04-01 15:37:45 +0200115 *
116 *
117 * @section howtoDataMetadata Metadata Support
118 *
119 * YANG Metadata annotations are defined in [RFC 7952](https://tools.ietf.org/html/rfc7952) as YANG extension (and libyang
120 * [implements them as internal extension plugin](@ref howtoPluginsExtensions)). In practice, it allows to have XML
121 * attributes (there is also a special encoding for JSON) in YANG modeled data. libyang does not allow to have any XML
122 * attribute without the appropriate annotation definition describing the data as it is done e.g. for leafs. When an
123 * attribute without a matching annotation definition is found in the input data, it is:
124 * - silently dropped (with warning) or
125 * - an error is reported in case the ::LYD_PARSE_STRICT parser option is provided to the
126 * [parser function](@ref howtoDataParsers) or
127 * - stored into a generic ::lyd_attr structure without a connection with any YANG module in case the ::LYD_PARSE_OPAQ
128 * parser options is provided to the [parser function](@ref howtoDataParsers).
129 *
130 * There are some XML attributes, described by [YANG](https://tools.ietf.org/html/rfc7950) and
131 * [NETCONF](https://tools.ietf.org/html/rfc6241) specifications, which are not defined as annotations, but libyang
132 * implements them this way. In case of attributes in the YANG namespace (`insert`, `value` and `key` attributes
133 * for the NETCONF edit-config operation), they are defined in special libyang's internal module `yang`, which is
134 * available in each context and the content of this schema can be printed via
135 * [schema printers](@ref howtoSchemaPrinters).
136 *
137 * In case of the attributes described in [NETCONF specification](https://tools.ietf.org/html/rfc6241), the libyang's
138 * annotations structures are hidden and cannot be printed despite, internally, they are part of the `ietf-netconf`'s
139 * schema structure. Therefore, these attributes are available only when the `ietf-netconf` schema is loaded in the
140 * context. The definitions of these annotations are as follows:
141 *
142 * md:annotation operation {
143 * type enumeration {
144 * enum merge;
145 * enum replace;
146 * enum create;
147 * enum delete;
148 * enum remove;
149 * }
150 * }
151 *
152 * md:annotation type {
153 * type enumeration {
154 * enum subtree;
155 * enum xpath {
156 * if-feature "nc:xpath";
157 * }
158 * }
159 * }
160 *
161 * md:annotation select {
162 * type string;
163 * }
164 *
165 * Note, that, following the specification,
166 * - the `type` and `select` XML attributes are supposed to be unqualified (without namespace) and that
167 * - the `select`'s content is XPath and it is internally transformed by libyang into the format where the
168 * XML namespace prefixes are replaced by the YANG module names.
169 *
170 *
171 * @section howtoDataYangdata yang-data Support
172 *
173 * [RFC 8040](https://tools.ietf.org/html/rfc8040) defines ietf-restconf module, which includes yang-data extension. Despite
174 * the definition in the RESTCONF YANG module, the yang-data concept is quite generic and used even in modules without a
175 * connection to RESTCONF protocol. The extension allows to define a separated YANG trees usable separately from any
176 * datastore.
177 *
178 * libyang implements support for yang-data internally as an [extension plugin](@ref howtoPluginsExtensions). To ease the
179 * use of yang-data with libyang, there are several generic functions, which are usable for yang-data:
180 *
181 * - ::lyd_parse_ext_data()
182 * - ::lyd_parse_ext_op()
183 *
184 * - ::lys_getnext_ext()
185 *
186 * - ::lyd_new_ext_inner()
187 * - ::lyd_new_ext_list()
188 * - ::lyd_new_ext_term()
189 * - ::lyd_new_ext_any()
190 * - ::lyd_new_ext_path()
Radek Krejci8678fa42020-08-18 16:07:28 +0200191 */
192
193/**
194 * @page howtoDataManipulation Manipulating Data
195 *
196 * There are many functions to create or modify an existing data tree. You can add new nodes, reconnect nodes from
197 * one tree to another (or e.g. from one list instance to another) or remove nodes. The functions doesn't allow you
198 * to put a node to a wrong place (by checking the YANG module structure), but not all validation checks can be made directly
199 * (or you have to make a valid change by multiple tree modifications) when the tree is being changed. Therefore,
200 * the [validation process](@ref howtoDataValidation) is expected to be invoked after changing the data tree to make sure
201 * that the changed data tree is valid.
202 *
203 * When inserting a node into data tree (no matter if the node already exists, via ::lyd_insert_child() and
204 * ::lyd_insert_sibling(), or a new node is being created), the node is automatically inserted to the place respecting the
205 * nodes order from the YANG schema. So the node is not inserted to the end or beginning of the siblings list, but after the
206 * existing instance of the closest preceding sibling node from the schema. In case the node is opaq (it is not connected
207 * with any schema node), it is placed to the end of the sibling node in the order they are inserted in. The only situation
208 * when it is possible to influence the order of the nodes is the order of user-ordered list/leaf-list instances. In such
209 * a case the ::lyd_insert_after() or ::lyd_insert_before() can be used.
210 *
211 * Creating data is generally possible in two ways, they can be combined. You can add nodes one-by-one based on
212 * 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 +0100213 * and ::lyd_new_opaq()) or address the nodes using a [simple XPath addressing](@ref howtoXPath) (::lyd_new_path() and
214 * ::lyd_new_path2()). The latter enables to create a whole path of nodes, requires less information
Radek Krejci8678fa42020-08-18 16:07:28 +0200215 * about the modified data, and is generally simpler to use. Actually the third way is duplicating the existing data using
216 * ::lyd_dup_single(), ::lyd_dup_siblings() and ::lyd_dup_meta_single().
217 *
Radek Krejci8a5afc22021-03-12 11:10:47 +0100218 * Note, that in case the node is defined in an extension instance, the functions mentioned above do not work until you
219 * provide parent where the new node is supposed to be inserted. The reason is that all the functions searches for the
220 * 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 +0100221 * ::lyd_new_ext_inner(), ::lyd_new_ext_term(), ::lyd_new_ext_any(), ::lyd_new_ext_list() and ::lyd_new_ext_path()
222 * functions.
Radek Krejci8a5afc22021-03-12 11:10:47 +0100223 *
Radek Krejci75104122021-04-01 15:37:45 +0200224 * The [metadata](@ref howtoDataMetadata) (and attributes in opaq nodes) can be created with ::lyd_new_meta()
Radek Krejci8678fa42020-08-18 16:07:28 +0200225 * and ::lyd_new_attr().
226 *
227 * Changing value of a terminal node (leaf, leaf-list) is possible with ::lyd_change_term(). Similarly, the metadata value
228 * can be changed with ::lyd_change_meta(). Before changing the value, it might be useful to compare the node's value
229 * with a string value (::lyd_value_compare()) or verify that the new string value is correct for the specific data node
230 * (::lyd_value_validate()).
231 *
232 * Working with two existing subtrees can also be performed two ways. Usually, you would use lyd_insert*() functions.
233 * They are generally meant for simple inserts of a node into a data tree. For more complicated inserts and when
234 * merging 2 trees use ::lyd_merge_tree() or ::lyd_merge_siblings(). It offers additional options and is basically a more
235 * powerful insert.
236 *
237 * Besides merging, libyang is also capable to provide information about differences between two data trees. For this purpose,
238 * ::lyd_diff_tree() and ::lyd_diff_siblings() generates annotated data trees which can be, in addition, used to change one
239 * data tree to another one using ::lyd_diff_apply_all(), ::lyd_diff_apply_module() and ::lyd_diff_reverse_all(). Multiple
240 * diff data trees can be also put together for further work using ::lyd_diff_merge_all(), ::lyd_diff_merge_module() and
241 * ::lyd_diff_merge_tree() functions. To just check equivalence of the data nodes, ::lyd_compare_single(),
242 * ::lyd_compare_siblings() and ::lyd_compare_meta() can be used.
243 *
244 * To remove a node or subtree from a data tree, use ::lyd_unlink_tree() and then free the unwanted data using
245 * ::lyd_free_all() (or other \b lyd_free_*() functions).
246 *
247 * Also remember, that when you are creating/inserting a node, all the objects in that operation must belong to the
248 * same context.
249 *
250 * Modifying the single data tree in multiple threads is not safe.
251 *
252 * Functions List
253 * --------------
254 * - ::lyd_new_inner()
255 * - ::lyd_new_term()
Radek Krejci09c77442021-04-26 11:10:34 +0200256 * - ::lyd_new_term_bin()
257 * - ::lyd_new_term_canon()
Radek Krejci8678fa42020-08-18 16:07:28 +0200258 * - ::lyd_new_list()
259 * - ::lyd_new_list2()
260 * - ::lyd_new_any()
261 * - ::lyd_new_opaq()
Michal Vasko8d65f852021-02-17 11:28:13 +0100262 * - ::lyd_new_opaq2()
Radek Krejci8678fa42020-08-18 16:07:28 +0200263 * - ::lyd_new_attr()
Michal Vasko8d65f852021-02-17 11:28:13 +0100264 * - ::lyd_new_attr2()
Radek Krejci8678fa42020-08-18 16:07:28 +0200265 * - ::lyd_new_meta()
266 * - ::lyd_new_path()
267 * - ::lyd_new_path2()
Radek Krejci8678fa42020-08-18 16:07:28 +0200268 *
Radek Krejcidd2a7662021-03-12 11:26:34 +0100269 * - ::lyd_new_ext_inner()
Radek Krejci8a5afc22021-03-12 11:10:47 +0100270 * - ::lyd_new_ext_term()
Radek Krejci8247bae2021-03-12 11:47:02 +0100271 * - ::lyd_new_ext_list()
Radek Krejci0b963da2021-03-12 13:23:44 +0100272 * - ::lyd_new_ext_any()
Radek Krejci95ccd1b2021-03-12 14:57:22 +0100273 * - ::lyd_new_ext_path()
Radek Krejci8a5afc22021-03-12 11:10:47 +0100274 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200275 * - ::lyd_dup_single()
276 * - ::lyd_dup_siblings()
277 * - ::lyd_dup_meta_single()
278 *
279 * - ::lyd_insert_child()
280 * - ::lyd_insert_sibling()
281 * - ::lyd_insert_after()
282 * - ::lyd_insert_before()
283 *
284 * - ::lyd_value_compare()
285 * - ::lyd_value_validate()
286 *
287 * - ::lyd_change_term()
Radek Krejci09c77442021-04-26 11:10:34 +0200288 * - ::lyd_change_term_bin()
289 * - ::lyd_change_term_canon()
Radek Krejci8678fa42020-08-18 16:07:28 +0200290 * - ::lyd_change_meta()
291 *
292 * - ::lyd_compare_single()
293 * - ::lyd_compare_siblings()
294 * - ::lyd_compare_meta()
295 * - ::lyd_diff_tree()
296 * - ::lyd_diff_siblings()
297 * - ::lyd_diff_apply_all()
298 * - ::lyd_diff_apply_module()
299 * - ::lyd_diff_reverse_all()
300 * - ::lyd_diff_merge_all()
301 * - ::lyd_diff_merge_module()
302 * - ::lyd_diff_merge_tree()
303 *
304 * - ::lyd_merge_tree()
305 * - ::lyd_merge_siblings()
Michal Vaskocd3f6172021-05-18 16:14:50 +0200306 * - ::lyd_merge_module()
Radek Krejci8678fa42020-08-18 16:07:28 +0200307 *
308 * - ::lyd_unlink_tree()
309 *
310 * - ::lyd_free_all()
311 * - ::lyd_free_siblings()
312 * - ::lyd_free_tree()
313 * - ::lyd_free_meta_single()
314 * - ::lyd_free_meta_siblings()
315 * - ::lyd_free_attr_single()
316 * - ::lyd_free_attr_siblings()
317 *
Michal Vaskoa820c312021-02-05 16:33:00 +0100318 * - ::lyd_any_value_str()
Radek Krejci8678fa42020-08-18 16:07:28 +0200319 * - ::lyd_any_copy_value()
320 */
321
322/**
323 * @page howtoDataWD Default Values
324 *
325 * libyang provides support for work with default values as defined in [RFC 6243](https://tools.ietf.org/html/rfc6243).
326 * However, libyang context do not contains the *ietf-netconf-with-defaults* module on its own and caller is supposed to
327 * add this YANG module to enable full support of the *with-defaults* features described below. Without presence of the
328 * mentioned module in the context, the default nodes are still present and handled in the data trees, but the metadata
329 * providing the information about the default values cannot be used. It means that when parsing data, the default nodes
330 * marked with the metadata as implicit default nodes are handled as explicit data and when printing data tree, the expected
331 * nodes are printed without the ietf-netconf-with-defaults metadata.
332 *
333 * The RFC document defines 4 modes for handling default nodes in a data tree, libyang adds the fifth mode and use them
334 * via @ref dataprinterflags when printing data trees.
335 * - \b explicit - Only the explicitly set configuration data. But in the case of status data, missing default
336 * data are added into the tree. In libyang, this mode is represented by ::LYD_PRINT_WD_EXPLICIT option.
337 * This is the default with-defaults mode of the printer. The data nodes do not contain any additional
338 * metadata information.
339 * - \b trim - Data nodes containing the default value are removed. This mode is applied with ::LYD_PRINT_WD_TRIM option.
340 * - \b report-all - This mode provides all the default data nodes despite they were explicitly present in source data or
341 * they were added by libyang's [validation process](@ref howtoDataValidation). This mode is activated by
342 * ::LYD_PRINT_WD_ALL option.
343 * - \b report-all-tagged - In this case, all the data nodes (implicit as well the explicit) containing the default value
344 * are printed and tagged (see the note below). Printers accept ::LYD_PRINT_WD_ALL_TAG option for this mode.
345 * - \b report-implicit-tagged - The last mode is similar to the previous one, except only the implicitly added nodes
346 * are tagged. This is the libyang's extension and it is activated by ::LYD_PRINT_WD_IMPL_TAG option.
347 *
348 * Internally, libyang adds the default nodes into the data tree as part of the [validation process](@ref howtoDataValidation).
349 * When [parsing data](@ref howtoDataParsers) from an input source, adding default nodes can be avoided only by avoiding
350 * the whole [validation process](@ref howtoDataValidation). In case the ietf-netconf-with-defaults module is present in the
351 * context, the [parser process](@ref howtoDataParsers) also supports to recognize the implicit default nodes marked with the
352 * appropriate metadata.
353 *
354 * Note, that in a modified data tree (via e.g. \b lyd_insert_*() or \b lyd_free_*() functions), some of the default nodes
355 * can be missing or they can be present by mistake. Such a data tree is again corrected during the next run of the
356 * [validation process](@ref howtoDataValidation) or manualy using \b lyd_new_implicit_*() functions.
357 *
358 * The implicit (default) nodes, created by libyang, are marked with the ::LYD_DEFAULT flag in ::lyd_node.flags member
359 * Note, that besides leafs and leaf-lists, the flag can appear also in containers, where it means that the container
360 * 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
361 * the accessible data tree). When printing data trees, the presence of empty containers (despite they were added
362 * explicitly or implicitly as part of accessible data tree) depends on ::LYD_PRINT_KEEPEMPTYCONT option.
363 *
364 * To get know if the particular leaf or leaf-list node contains default value (despite implicit or explicit), you can
365 * use ::lyd_is_default() function.
366 *
367 * Functions List
368 * --------------
369 * - ::lyd_is_default()
370 * - ::lyd_new_implicit_all()
371 * - ::lyd_new_implicit_module()
372 * - ::lyd_new_implicit_tree()
373 */
374
375/**
Radek Krejcif9943642021-04-26 10:18:21 +0200376 * @page howtoDataLYB LYB Binary Format
377 *
378 * LYB (LibYang Binary) is a proprietary libyang binary data and file format. Its primary purpose is efficient
379 * serialization (printing) and deserialization (parsing). With this goal in mind, every term node value is stored
380 * in its new binary format specification according to its type. Following is the format for all types with explicit
381 * support out-of-the-box (meaning that have a special type plugin). Any derived types inherit the format of its
382 * closest type with explicit support (up to a built-in type).
Radek Krejci09c77442021-04-26 11:10:34 +0200383 *
Michal Vaskof1bcb5c2021-04-30 09:21:25 +0200384 * @section howtoDataLYBTypes Format of specific data type values
Radek Krejcif9943642021-04-26 10:18:21 +0200385 */
386
387/**
Radek Krejci2ff0d572020-05-21 15:27:28 +0200388 * @ingroup trees
Radek Krejci8678fa42020-08-18 16:07:28 +0200389 * @defgroup datatree Data Tree
Radek Krejcie7b95092019-05-15 11:03:07 +0200390 * @{
391 *
392 * Data structures and functions to manipulate and access instance data tree.
393 */
394
Michal Vasko64246d82020-08-19 12:35:00 +0200395/* *INDENT-OFF* */
396
Michal Vaskoa276cd92020-08-10 15:10:08 +0200397/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200398 * @brief Macro to iterate via all elements in a data tree. This is the opening part
399 * to the #LYD_TREE_DFS_END - they always have to be used together.
400 *
401 * The function follows deep-first search algorithm:
402 * <pre>
403 * 1
404 * / \
Michal Vaskoc193ce92020-03-06 11:04:48 +0100405 * 2 4
Radek Krejcie7b95092019-05-15 11:03:07 +0200406 * / / \
Michal Vaskoc193ce92020-03-06 11:04:48 +0100407 * 3 5 6
Radek Krejcie7b95092019-05-15 11:03:07 +0200408 * </pre>
409 *
Radek Krejci0935f412019-08-20 16:15:18 +0200410 * Use the same parameters for #LYD_TREE_DFS_BEGIN and #LYD_TREE_DFS_END. While
Michal Vasko56daf732020-08-10 10:57:18 +0200411 * START can be any of the lyd_node* types, ELEM variable must be a pointer to
412 * the generic struct lyd_node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200413 *
Michal Vasko56daf732020-08-10 10:57:18 +0200414 * To skip a particular subtree, instead of the continue statement, set LYD_TREE_DFS_continue
415 * variable to non-zero value.
Radek Krejcie7b95092019-05-15 11:03:07 +0200416 *
417 * Use with opening curly bracket '{' after the macro.
418 *
419 * @param START Pointer to the starting element processed first.
Radek Krejcie7b95092019-05-15 11:03:07 +0200420 * @param ELEM Iterator intended for use in the block.
421 */
Michal Vasko56daf732020-08-10 10:57:18 +0200422#define LYD_TREE_DFS_BEGIN(START, ELEM) \
Radek Krejci857189e2020-09-01 13:26:36 +0200423 { ly_bool LYD_TREE_DFS_continue = 0; struct lyd_node *LYD_TREE_DFS_next; \
Michal Vasko56daf732020-08-10 10:57:18 +0200424 for ((ELEM) = (LYD_TREE_DFS_next) = (struct lyd_node *)(START); \
Radek Krejcie7b95092019-05-15 11:03:07 +0200425 (ELEM); \
Michal Vasko56daf732020-08-10 10:57:18 +0200426 (ELEM) = (LYD_TREE_DFS_next), LYD_TREE_DFS_continue = 0)
Radek Krejcie7b95092019-05-15 11:03:07 +0200427
428/**
429 * @brief Macro to iterate via all elements in a tree. This is the closing part
430 * to the #LYD_TREE_DFS_BEGIN - they always have to be used together.
431 *
432 * Use the same parameters for #LYD_TREE_DFS_BEGIN and #LYD_TREE_DFS_END. While
Michal Vasko56daf732020-08-10 10:57:18 +0200433 * START can be any of the lyd_node* types, ELEM variable must be a pointer
434 * to the generic struct lyd_node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200435 *
436 * Use with closing curly bracket '}' after the macro.
437 *
438 * @param START Pointer to the starting element processed first.
Radek Krejcie7b95092019-05-15 11:03:07 +0200439 * @param ELEM Iterator intended for use in the block.
440 */
441
Michal Vasko56daf732020-08-10 10:57:18 +0200442#define LYD_TREE_DFS_END(START, ELEM) \
Radek Krejcie7b95092019-05-15 11:03:07 +0200443 /* select element for the next run - children first */ \
Michal Vasko56daf732020-08-10 10:57:18 +0200444 if (LYD_TREE_DFS_continue) { \
445 (LYD_TREE_DFS_next) = NULL; \
446 } else { \
Radek Krejcia1c1e542020-09-29 16:06:52 +0200447 (LYD_TREE_DFS_next) = lyd_child(ELEM); \
Michal Vasko56daf732020-08-10 10:57:18 +0200448 }\
449 if (!(LYD_TREE_DFS_next)) { \
Radek Krejcie7b95092019-05-15 11:03:07 +0200450 /* no children */ \
Michal Vasko9e685082021-01-29 14:49:09 +0100451 if ((ELEM) == (struct lyd_node *)(START)) { \
Radek Krejcie7b95092019-05-15 11:03:07 +0200452 /* we are done, (START) has no children */ \
453 break; \
454 } \
455 /* try siblings */ \
Michal Vasko56daf732020-08-10 10:57:18 +0200456 (LYD_TREE_DFS_next) = (ELEM)->next; \
Radek Krejcie7b95092019-05-15 11:03:07 +0200457 } \
Michal Vasko56daf732020-08-10 10:57:18 +0200458 while (!(LYD_TREE_DFS_next)) { \
Radek Krejcie7b95092019-05-15 11:03:07 +0200459 /* parent is already processed, go to its sibling */ \
Michal Vasko9e685082021-01-29 14:49:09 +0100460 (ELEM) = (struct lyd_node *)(ELEM)->parent; \
Radek Krejcie7b95092019-05-15 11:03:07 +0200461 /* no siblings, go back through parents */ \
462 if ((ELEM)->parent == (START)->parent) { \
463 /* we are done, no next element to process */ \
464 break; \
465 } \
Michal Vasko56daf732020-08-10 10:57:18 +0200466 (LYD_TREE_DFS_next) = (ELEM)->next; \
Christian Hopps59618972021-02-01 05:01:35 -0500467 } }
468
469/**
470 * @brief Macro to iterate via all schema node data instances in data siblings.
471 *
472 * @param START Pointer to the starting sibling. Even if it is not first, all the siblings are searched.
473 * @param SCHEMA Schema node of the searched instances.
474 * @param ELEM Iterator.
475 */
476#define LYD_LIST_FOR_INST(START, SCHEMA, ELEM) \
477 for (lyd_find_sibling_val(START, SCHEMA, NULL, 0, &(ELEM)); \
478 (ELEM) && ((ELEM)->schema == (SCHEMA)); \
479 (ELEM) = (ELEM)->next)
480
481/**
482 * @brief Macro to iterate via all schema node data instances in data siblings allowing to modify the list itself.
483 *
484 * @param START Pointer to the starting sibling. Even if it is not first, all the siblings are searched.
485 * @param SCHEMA Schema node of the searched instances.
486 * @param NEXT Temporary storage to allow removing of the current iterator content.
487 * @param ELEM Iterator.
488 */
489#define LYD_LIST_FOR_INST_SAFE(START, SCHEMA, NEXT, ELEM) \
490 for (lyd_find_sibling_val(START, SCHEMA, NULL, 0, &(ELEM)); \
491 (ELEM) && ((ELEM)->schema == (SCHEMA)) ? ((NEXT) = (ELEM)->next, 1) : 0; \
492 (ELEM) = (NEXT))
Radek Krejcie7b95092019-05-15 11:03:07 +0200493
Michal Vasko64246d82020-08-19 12:35:00 +0200494/* *INDENT-ON* */
495
Radek Krejcie7b95092019-05-15 11:03:07 +0200496/**
Michal Vasko03ff5a72019-09-11 13:49:33 +0200497 * @brief Macro to get context from a data tree node.
498 */
Michal Vaskob7be7a82020-08-20 09:09:04 +0200499#define LYD_CTX(node) ((node)->schema ? (node)->schema->module->ctx : ((struct lyd_node_opaq *)(node))->ctx)
Michal Vasko03ff5a72019-09-11 13:49:33 +0200500
501/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200502 * @brief Data input/output formats supported by libyang [parser](@ref howtoDataParsers) and
503 * [printer](@ref howtoDataPrinters) functions.
Radek Krejcie7b95092019-05-15 11:03:07 +0200504 */
505typedef enum {
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200506 LYD_UNKNOWN = 0, /**< unknown data format, invalid value */
507 LYD_XML, /**< XML instance data format */
508 LYD_JSON, /**< JSON instance data format */
Michal Vasko69730152020-10-09 16:30:07 +0200509 LYD_LYB /**< LYB instance data format */
Radek Krejcie7b95092019-05-15 11:03:07 +0200510} LYD_FORMAT;
511
512/**
Radek Krejci59583bb2019-09-11 12:57:55 +0200513 * @brief List of possible value types stored in ::lyd_node_any.
Radek Krejcie7b95092019-05-15 11:03:07 +0200514 */
515typedef enum {
Radek Krejci8678fa42020-08-18 16:07:28 +0200516 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 +0200517 is directly connected into the anydata node without duplication, caller is supposed to not manipulate
Radek Krejci8678fa42020-08-18 16:07:28 +0200518 with the data after a successful call (including calling ::lyd_free_all() on the provided data) */
Radek Krejci22ebdba2019-07-25 13:59:43 +0200519 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 +0200520 as string). XML sensitive characters (such as & or \>) are automatically escaped when the anydata
521 is printed in XML format. */
Radek Krejci22ebdba2019-07-25 13:59:43 +0200522 LYD_ANYDATA_XML, /**< Value is a string containing the serialized XML data. */
523 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 +0200524 LYD_ANYDATA_LYB /**< Value is a memory chunk with the serialized data tree in LYB format. */
Radek Krejcie7b95092019-05-15 11:03:07 +0200525} LYD_ANYDATA_VALUETYPE;
526
527/** @} */
528
529/**
530 * @brief YANG data representation
531 */
532struct lyd_value {
Radek Krejci995784f2021-04-26 08:02:13 +0200533 const char *_canonical; /**< Should never be accessed directly, instead ::lyd_get_value() and ::lyd_get_meta_value()
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200534 should be used. Serves as a cache for the canonical value or the JSON
535 representation if no canonical value is defined. */
Michal Vaskoaa0ee622021-05-11 09:29:25 +0200536 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
537 in the schema node of the data node since the type's store plugin can use other types/plugins for
538 storing data. Speaking about built-in types, this is the case of leafref which stores data as its
539 target type. In contrast, union type also uses its subtype's callbacks, but inside an internal data
540 stored in subvalue member of ::lyd_value structure, so here is the pointer to the union type.
541 In general, this type is used to get free callback for this lyd_value structure, so it must reflect
542 the type used to store data directly in the same lyd_value instance. */
Radek Krejci8678fa42020-08-18 16:07:28 +0200543
Radek Krejcie7b95092019-05-15 11:03:07 +0200544 union {
Radek Krejcie7b95092019-05-15 11:03:07 +0200545 int8_t boolean; /**< 0 as false, 1 as true */
546 int64_t dec64; /**< decimal64: value = dec64 / 10^fraction-digits */
Radek Krejci8dc4f2d2019-07-16 12:24:00 +0200547 int8_t int8; /**< 8-bit signed integer */
548 int16_t int16; /**< 16-bit signed integer */
549 int32_t int32; /**< 32-bit signed integer */
550 int64_t int64; /**< 64-bit signed integer */
551 uint8_t uint8; /**< 8-bit unsigned integer */
Michal Vasko7c8439f2020-08-05 13:25:19 +0200552 uint16_t uint16; /**< 16-bit unsigned integer */
553 uint32_t uint32; /**< 32-bit unsigned integer */
554 uint64_t uint64; /**< 64-bit unsigned integer */
Radek Krejcie7b95092019-05-15 11:03:07 +0200555 struct lysc_type_bitenum_item *enum_item; /**< pointer to the definition of the enumeration value */
556 struct lysc_ident *ident; /**< pointer to the schema definition of the identityref value */
Michal Vaskobb22b182021-06-14 08:14:21 +0200557 struct ly_path *target; /**< Instance-identifier target path, use ::lyd_find_target() to evaluate
558 it on data. */
Michal Vasko3ce79712021-05-04 11:44:20 +0200559 struct lyd_value_union *subvalue; /** Union value with some metadata. */
Michal Vaskoaa0ee622021-05-11 09:29:25 +0200560
561 void *dyn_mem; /**< pointer to generic data type value stored in dynamic memory */
562 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 +0200563 }; /**< The union is just a list of shorthands to possible values stored by a type's plugin. libyang itself uses the ::lyd_value.realtype
564 plugin's callbacks to work with the data.*/
Radek Krejcie7b95092019-05-15 11:03:07 +0200565};
566
567/**
Michal Vaskoaa0ee622021-05-11 09:29:25 +0200568 * @brief Get the value in format specific to the type.
569 *
570 * Should be used for any types that do not have their specific representation in the ::lyd_value union.
571 *
572 * @param[in] value Pointer to the value structure to read from (struct ::lyd_value *).
573 * @param[out] type_val Pointer to the type-specific value structure.
574 */
575#define LYD_VALUE_GET(value, type_val) \
576 ((sizeof *(type_val) > LYD_VALUE_FIXED_MEM_SIZE) \
577 ? ((type_val) = (((value)->dyn_mem))) \
578 : ((type_val) = ((void *)((value)->fixed_mem))))
579
580/**
Michal Vasko2b421d92021-05-18 16:33:36 +0200581 * @brief Special lyd_value structure for built-in union values.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200582 *
Michal Vasko3ce79712021-05-04 11:44:20 +0200583 * Represents data with multiple types (union). The ::lyd_value_union.value contains representation according to
584 * 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 +0200585 * 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 +0200586 */
Michal Vasko3ce79712021-05-04 11:44:20 +0200587struct lyd_value_union {
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200588 struct lyd_value value; /**< representation of the value according to the selected union's subtype
Michal Vasko3ce79712021-05-04 11:44:20 +0200589 (stored as ::lyd_value.realtype here) */
590 void *original; /**< Original value. */
591 size_t orig_len; /**< Original value length. */
Michal Vaskod0c3bac2021-05-11 09:44:43 +0200592 uint32_t hints; /**< [Value hints](@ref lydvalhints) from the parser */
Radek Krejci8df109d2021-04-23 12:19:08 +0200593 LY_VALUE_FORMAT format; /**< Prefix format of the value. However, this information is also used to decide
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200594 whether a value is valid for the specific format or not on later validations
595 (instance-identifier in XML looks different than in JSON). */
Radek Krejci0b013302021-03-29 15:22:32 +0200596 void *prefix_data; /**< Format-specific data for prefix resolution (see ly_resolve_prefix()) */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200597 const struct lysc_node *ctx_node; /**< Context schema node. */
598};
599
600/**
Michal Vasko2b421d92021-05-18 16:33:36 +0200601 * @brief Special lyd_value structure for built-in bits values.
Michal Vasko2724b922021-04-28 13:46:31 +0200602 */
603struct lyd_value_bits {
604 char *bitmap; /**< bitmap of size ::lyplg_type_bits_bitmap_size(), if its value is
605 cast to an integer type of the corresponding size, can be used
606 directly as a bitmap */
607 struct lysc_type_bitenum_item **items; /**< list of set pointers to the specification of the set
608 bits ([sized array](@ref sizedarrays)) */
609};
610
611/**
Michal Vasko2b421d92021-05-18 16:33:36 +0200612 * @brief Special lyd_value structure for built-in binary values.
Michal Vasko495f4502021-04-27 14:48:05 +0200613 */
614struct lyd_value_binary {
Michal Vasko74515d02021-06-11 11:13:11 +0200615 void *data; /**< pointer to the binary value */
616 size_t size; /**< size of @p data value in bytes */
Michal Vasko495f4502021-04-27 14:48:05 +0200617};
618
619/**
Michal Vasko2b421d92021-05-18 16:33:36 +0200620 * @brief Special lyd_value structure for ietf-inet-types ipv4-address-no-zone values.
621 */
622struct lyd_value_ipv4_address_no_zone {
623 struct in_addr addr; /**< IPv4 address in binary */
624};
625
626/**
627 * @brief Special lyd_value structure for ietf-inet-types ipv4-address values.
628 */
629struct lyd_value_ipv4_address {
630 struct in_addr addr; /**< IPv4 address in binary */
631 const char *zone; /**< Optional address zone */
632};
633
634/**
635 * @brief Special lyd_value structure for ietf-inet-types ipv4-prefix values.
636 */
637struct lyd_value_ipv4_prefix {
638 struct in_addr addr; /**< IPv4 host address in binary */
639 uint8_t prefix; /**< prefix length (0 - 32) */
640};
641
642/**
643 * @brief Special lyd_value structure for ietf-inet-types ipv6-address-no-zone values.
644 */
645struct lyd_value_ipv6_address_no_zone {
646 struct in6_addr addr; /**< IPv6 address in binary */
647};
648
649/**
650 * @brief Special lyd_value structure for ietf-inet-types ipv6-address values.
651 */
652struct lyd_value_ipv6_address {
653 struct in6_addr addr; /**< IPv6 address in binary */
654 const char *zone; /**< Optional address zone */
655};
656
657/**
658 * @brief Special lyd_value structure for ietf-inet-types ipv6-prefix values.
659 */
660struct lyd_value_ipv6_prefix {
661 struct in6_addr addr; /**< IPv6 host address in binary */
662 uint8_t prefix; /**< prefix length (0 - 128) */
663};
664
665/**
666 * @brief Special lyd_value structure for ietf-yang-types date-and-time values.
667 */
668struct lyd_value_date_and_time {
669 time_t time; /**< UNIX timestamp */
670 char *fractions_s; /**< Optional fractions of a second */
671};
672
673/**
Michal Vasko9f96a052020-03-10 09:41:45 +0100674 * @brief Metadata structure.
Radek Krejcie7b95092019-05-15 11:03:07 +0200675 *
Michal Vasko9f96a052020-03-10 09:41:45 +0100676 * The structure provides information about metadata of a data element. Such attributes must map to
Radek Krejcie7b95092019-05-15 11:03:07 +0200677 * annotations as specified in RFC 7952. The only exception is the filter type (in NETCONF get operations)
678 * and edit-config's operation attributes. In XML, they are represented as standard XML attributes. In JSON,
679 * they are represented as JSON elements starting with the '@' character (for more information, see the
680 * YANG metadata RFC.
681 *
682 */
Michal Vasko9f96a052020-03-10 09:41:45 +0100683struct lyd_meta {
684 struct lyd_node *parent; /**< data node where the metadata is placed */
685 struct lyd_meta *next; /**< pointer to the next metadata of the same element */
686 struct lysc_ext_instance *annotation; /**< pointer to the annotation's definition */
687 const char *name; /**< metadata name */
688 struct lyd_value value; /**< metadata value representation */
Radek Krejcie7b95092019-05-15 11:03:07 +0200689};
690
Michal Vasko52927e22020-03-16 17:26:14 +0100691/**
692 * @brief Generic prefix and namespace mapping, meaning depends on the format.
Radek Krejci1798aae2020-07-14 13:26:06 +0200693 *
694 * 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 +0200695 * ::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 +0100696 * 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 +0100697 */
Michal Vaskoad92b672020-11-12 13:11:31 +0100698struct ly_opaq_name {
699 const char *name; /**< node name, without prefix if any was defined */
700 const char *prefix; /**< identifier used in the qualified name as the prefix, can be NULL */
Radek Krejci1798aae2020-07-14 13:26:06 +0200701 union {
Radek Krejci8df109d2021-04-23 12:19:08 +0200702 const char *module_ns; /**< format ::LY_VALUE_XML - XML namespace of the node element */
703 const char *module_name; /**< format ::LY_VALUE_JSON - (inherited) name of the module of the element */
Radek Krejci1798aae2020-07-14 13:26:06 +0200704 };
Michal Vasko52927e22020-03-16 17:26:14 +0100705};
706
707/**
708 * @brief Generic attribute structure.
709 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200710struct lyd_attr {
Michal Vasko52927e22020-03-16 17:26:14 +0100711 struct lyd_node_opaq *parent; /**< data node where the attribute is placed */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100712 struct lyd_attr *next; /**< pointer to the next attribute */
Michal Vaskoad92b672020-11-12 13:11:31 +0100713 struct ly_opaq_name name; /**< attribute name with module information */
Michal Vasko501af032020-11-11 20:27:44 +0100714 const char *value; /**< attribute value */
Michal Vaskod0c3bac2021-05-11 09:44:43 +0200715 uint32_t hints; /**< additional information about from the data source, see the [hints list](@ref lydhints) */
Radek Krejci8df109d2021-04-23 12:19:08 +0200716 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 +0100717 void *val_prefix_data; /**< format-specific prefix data */
Michal Vasko52927e22020-03-16 17:26:14 +0100718};
Radek Krejcie7b95092019-05-15 11:03:07 +0200719
Michal Vasko1bf09392020-03-27 12:38:10 +0100720#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 +0200721#define LYD_NODE_TERM (LYS_LEAF|LYS_LEAFLIST) /**< Schema nodetype mask for lyd_node_term */
722#define LYD_NODE_ANY (LYS_ANYDATA) /**< Schema nodetype mask for lyd_node_any */
723
724/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200725 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +0200726 * @defgroup dnodeflags Data node flags
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200727 * @{
728 *
729 * Various flags of data nodes.
730 *
731 * 1 - container 5 - anydata/anyxml
732 * 2 - list 6 - rpc/action
733 * 3 - leaf 7 - notification
734 * 4 - leaflist
735 *
736 * bit name 1 2 3 4 5 6 7
737 * ---------------------+-+-+-+-+-+-+-+
738 * 1 LYD_DEFAULT |x| |x|x| | | |
739 * +-+-+-+-+-+-+-+
Michal Vasko5c4e5892019-11-14 12:31:38 +0100740 * 2 LYD_WHEN_TRUE |x|x|x|x|x| | |
Michal Vasko9b368d32020-02-14 13:53:31 +0100741 * +-+-+-+-+-+-+-+
742 * 3 LYD_NEW |x|x|x|x|x|x|x|
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200743 * ---------------------+-+-+-+-+-+-+-+
744 *
745 */
746
Michal Vasko5c4e5892019-11-14 12:31:38 +0100747#define LYD_DEFAULT 0x01 /**< default (implicit) node */
748#define LYD_WHEN_TRUE 0x02 /**< all when conditions of this node were evaluated to true */
Michal Vasko9b368d32020-02-14 13:53:31 +0100749#define LYD_NEW 0x04 /**< node was created after the last validation, is needed for the next validation */
Michal Vasko52927e22020-03-16 17:26:14 +0100750
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200751/** @} */
752
753/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200754 * @brief Generic structure for a data node.
755 */
756struct lyd_node {
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200757 uint32_t hash; /**< hash of this particular node (module name + schema name + key string values if list or
758 hashes of all nodes of subtree in case of keyless list). Note that while hash can be
759 used to get know that nodes are not equal, it cannot be used to decide that the
760 nodes are equal due to possible collisions. */
761 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
Radek Krejci2a9fc652021-01-22 17:44:34 +0100762 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200763 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
764 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
765 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
766 never NULL. If there is no sibling node, pointer points to the node
767 itself. In case of the first node, this pointer points to the last
768 node in the list. */
Michal Vasko9f96a052020-03-10 09:41:45 +0100769 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200770 void *priv; /**< private user data, not used by libyang */
Radek Krejcie7b95092019-05-15 11:03:07 +0200771};
772
773/**
Radek Krejcif3b6fec2019-07-24 15:53:11 +0200774 * @brief Data node structure for the inner data tree nodes - containers, lists, RPCs, actions and Notifications.
Radek Krejcie7b95092019-05-15 11:03:07 +0200775 */
776struct lyd_node_inner {
Michal Vasko9e685082021-01-29 14:49:09 +0100777 union {
778 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
779 struct {
780 uint32_t hash; /**< hash of this particular node (module name + schema name + key string
781 values if list or hashes of all nodes of subtree in case of keyless
782 list). Note that while hash can be used to get know that nodes are
783 not equal, it cannot be used to decide that the nodes are equal due
784 to possible collisions. */
785 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
786 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
787 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
788 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
789 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
790 never NULL. If there is no sibling node, pointer points to the node
791 itself. In case of the first node, this pointer points to the last
792 node in the list. */
793 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
794 void *priv; /**< private user data, not used by libyang */
795 };
796 }; /**< common part corresponding to ::lyd_node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200797
798 struct lyd_node *child; /**< pointer to the first child node. */
799 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 +0200800#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 +0200801};
802
803/**
Michal Vaskof03ed032020-03-04 13:31:44 +0100804 * @brief Data node structure for the terminal data tree nodes - leaves and leaf-lists.
Radek Krejcie7b95092019-05-15 11:03:07 +0200805 */
806struct lyd_node_term {
Michal Vasko9e685082021-01-29 14:49:09 +0100807 union {
808 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
809 struct {
810 uint32_t hash; /**< hash of this particular node (module name + schema name + key string
811 values if list or hashes of all nodes of subtree in case of keyless
812 list). Note that while hash can be used to get know that nodes are
813 not equal, it cannot be used to decide that the nodes are equal due
814 to possible collisions. */
815 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
816 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
817 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
818 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
819 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
820 never NULL. If there is no sibling node, pointer points to the node
821 itself. In case of the first node, this pointer points to the last
822 node in the list. */
823 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
824 void *priv; /**< private user data, not used by libyang */
825 };
826 }; /**< common part corresponding to ::lyd_node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200827
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200828 struct lyd_value value; /**< node's value representation */
Radek Krejcie7b95092019-05-15 11:03:07 +0200829};
830
831/**
Christian Hopps61213e02021-04-12 20:41:32 -0400832 * @brief union for anydata/anyxml value representation.
833 */
834union lyd_any_value {
835 struct lyd_node *tree; /**< data tree */
836 const char *str; /**< Generic string data */
837 const char *xml; /**< Serialized XML data */
838 const char *json; /**< I-JSON encoded string */
839 char *mem; /**< LYD_ANYDATA_LYB memory chunk */
840};
841
842/**
843 * @brief Data node structure for the anydata data tree nodes - anydata or
844 * anyxml.
Radek Krejcie7b95092019-05-15 11:03:07 +0200845 */
846struct lyd_node_any {
Michal Vasko9e685082021-01-29 14:49:09 +0100847 union {
848 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
849 struct {
850 uint32_t hash; /**< hash of this particular node (module name + schema name + key string
851 values if list or hashes of all nodes of subtree in case of keyless
852 list). Note that while hash can be used to get know that nodes are
853 not equal, it cannot be used to decide that the nodes are equal due
854 to possible collisions. */
855 uint32_t flags; /**< [data node flags](@ref dnodeflags) */
856 const struct lysc_node *schema; /**< pointer to the schema definition of this node */
857 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
858 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
859 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
860 never NULL. If there is no sibling node, pointer points to the node
861 itself. In case of the first node, this pointer points to the last
862 node in the list. */
863 struct lyd_meta *meta; /**< pointer to the list of metadata of this node */
864 void *priv; /**< private user data, not used by libyang */
865 };
866 }; /**< common part corresponding to ::lyd_node */
Radek Krejcie7b95092019-05-15 11:03:07 +0200867
Christian Hopps61213e02021-04-12 20:41:32 -0400868 union lyd_any_value value; /**< pointer to the stored value representation of the anydata/anyxml node */
Michal Vasko9e685082021-01-29 14:49:09 +0100869 LYD_ANYDATA_VALUETYPE value_type; /**< type of the data stored as ::lyd_node_any.value */
Radek Krejcie7b95092019-05-15 11:03:07 +0200870};
871
872/**
Michal Vasko1d4af6c2021-02-22 13:31:26 +0100873 * @brief Get the name (associated with) of a data node. Works for opaque nodes as well.
874 *
875 * @param[in] node Node to examine.
876 * @return Data node name.
877 */
878#define LYD_NAME(node) ((node)->schema ? (node)->schema->name : ((struct lyd_node_opaq *)node)->name.name)
879
880/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200881 * @ingroup datatree
882 * @defgroup lydvalhints Value format hints.
Radek Krejci1798aae2020-07-14 13:26:06 +0200883 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200884 *
885 * Hints for the type of the data value.
886 *
887 * Any information about value types encoded in the format is hinted by these values.
Radek Krejci1798aae2020-07-14 13:26:06 +0200888 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200889#define LYD_VALHINT_STRING 0x0001 /**< value is allowed to be a string */
890#define LYD_VALHINT_DECNUM 0x0002 /**< value is allowed to be a decimal number */
891#define LYD_VALHINT_OCTNUM 0x0004 /**< value is allowed to be an octal number */
892#define LYD_VALHINT_HEXNUM 0x0008 /**< value is allowed to be a hexadecimal number */
893#define LYD_VALHINT_NUM64 0x0010 /**< value is allowed to be an int64 or uint64 */
894#define LYD_VALHINT_BOOLEAN 0x0020 /**< value is allowed to be a boolean */
895#define LYD_VALHINT_EMPTY 0x0040 /**< value is allowed to be empty */
896/**
897 * @} lydvalhints
898 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200899
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200900/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200901 * @ingroup datatree
902 * @defgroup lydnodehints Node type format hints
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200903 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200904 *
905 * Hints for the type of the data node.
906 *
907 * Any information about node types encoded in the format is hinted by these values.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200908 */
909#define LYD_NODEHINT_LIST 0x0080 /**< node is allowed to be a list instance */
910#define LYD_NODEHINT_LEAFLIST 0x0100 /**< node is allowed to be a leaf-list instance */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200911/**
912 * @} lydnodehints
913 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200914
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200915/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200916 * @ingroup datatree
917 * @defgroup lydhints Value and node type format hints
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200918 * @{
Radek Krejci8678fa42020-08-18 16:07:28 +0200919 *
920 * Hints for the types of data node and its value.
921 *
922 * Any information about value and node types encoded in the format is hinted by these values.
923 * It combines [value hints](@ref lydvalhints) and [node hints](@ref lydnodehints).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200924 */
925#define LYD_HINT_DATA 0x01F3 /**< special node/value hint to be used for generic data node/value (for cases when
926 there is no encoding or it does not provide any additional information about
927 a node/value type); do not combine with specific [value hints](@ref lydvalhints)
928 or [node hints](@ref lydnodehints). */
929#define LYD_HINT_SCHEMA 0x01FF /**< special node/value hint to be used for generic schema node/value(for cases when
930 there is no encoding or it does not provide any additional information about
931 a node/value type); do not combine with specific [value hints](@ref lydvalhints)
932 or [node hints](@ref lydnodehints). */
933/**
934 * @} lydhints
935 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200936
937/**
Michal Vasko52927e22020-03-16 17:26:14 +0100938 * @brief Data node structure for unparsed (opaque) nodes.
939 */
940struct lyd_node_opaq {
Michal Vasko9e685082021-01-29 14:49:09 +0100941 union {
942 struct lyd_node node; /**< implicit cast for the members compatible with ::lyd_node */
943 struct {
944 uint32_t hash; /**< always 0 */
945 uint32_t flags; /**< always 0 */
946 const struct lysc_node *schema; /**< always NULL */
947 struct lyd_node_inner *parent; /**< pointer to the parent node, NULL in case of root node */
948 struct lyd_node *next; /**< pointer to the next sibling node (NULL if there is no one) */
949 struct lyd_node *prev; /**< pointer to the previous sibling node \note Note that this pointer is
950 never NULL. If there is no sibling node, pointer points to the node
951 itself. In case of the first node, this pointer points to the last
952 node in the list. */
953 struct lyd_meta *meta; /**< always NULL */
954 void *priv; /**< private user data, not used by libyang */
955 };
956 }; /**< common part corresponding to ::lyd_node */
Michal Vasko52927e22020-03-16 17:26:14 +0100957
Michal Vasko501af032020-11-11 20:27:44 +0100958 struct lyd_node *child; /**< pointer to the child node (compatible with ::lyd_node_inner) */
959
Michal Vaskoad92b672020-11-12 13:11:31 +0100960 struct ly_opaq_name name; /**< node name with module information */
Michal Vasko52927e22020-03-16 17:26:14 +0100961 const char *value; /**< original value */
Michal Vaskod0c3bac2021-05-11 09:44:43 +0200962 uint32_t hints; /**< additional information about from the data source, see the [hints list](@ref lydhints) */
Radek Krejci8df109d2021-04-23 12:19:08 +0200963 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 +0100964 void *val_prefix_data; /**< format-specific prefix data */
Michal Vasko501af032020-11-11 20:27:44 +0100965
Michal Vasko9e685082021-01-29 14:49:09 +0100966 struct lyd_attr *attr; /**< pointer to the list of generic attributes of this node */
Michal Vasko52927e22020-03-16 17:26:14 +0100967 const struct ly_ctx *ctx; /**< libyang context */
968};
969
970/**
Radek Krejcia1c1e542020-09-29 16:06:52 +0200971 * @brief Get the generic parent pointer of a data node.
972 *
973 * @param[in] node Node whose parent pointer to get.
974 * @return Pointer to the parent node of the @p node.
975 * @return NULL in case of the top-level node or if the @p node is NULL itself.
Michal Vasko5bfd4be2020-06-23 13:26:19 +0200976 */
Christian Hopps59618972021-02-01 05:01:35 -0500977static inline struct lyd_node *
978lyd_parent(const struct lyd_node *node)
979{
Michal Vasko9e543402021-06-11 13:55:30 +0200980 if (!node || !node->parent) {
Christian Hopps59618972021-02-01 05:01:35 -0500981 return NULL;
982 }
983
984 return &node->parent->node;
985}
Michal Vasko5bfd4be2020-06-23 13:26:19 +0200986
987/**
Radek Krejcia1c1e542020-09-29 16:06:52 +0200988 * @brief Get the child pointer of a generic data node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200989 *
Radek Krejcia1c1e542020-09-29 16:06:52 +0200990 * Decides the node's type and in case it has a children list, returns it. Supports even the opaq nodes (::lyd_node_opaq).
991 *
992 * If you need to skip key children, use ::lyd_child_no_keys().
993 *
994 * @param[in] node Node to use.
995 * @return Pointer to the first child node (if any) of the @p node.
Radek Krejcie7b95092019-05-15 11:03:07 +0200996 */
Christian Hopps59618972021-02-01 05:01:35 -0500997static inline struct lyd_node *
998lyd_child(const struct lyd_node *node)
999{
1000 if (!node) {
1001 return NULL;
1002 }
1003
1004 if (!node->schema) {
1005 /* opaq node */
1006 return ((struct lyd_node_opaq *)node)->child;
1007 }
1008
1009 switch (node->schema->nodetype) {
1010 case LYS_CONTAINER:
1011 case LYS_LIST:
1012 case LYS_RPC:
1013 case LYS_ACTION:
1014 case LYS_NOTIF:
1015 return ((struct lyd_node_inner *)node)->child;
1016 default:
1017 return NULL;
1018 }
1019}
Radek Krejcia1c1e542020-09-29 16:06:52 +02001020
1021/**
1022 * @brief Get the child pointer of a generic data node but skip its keys in case it is ::LYS_LIST.
1023 *
1024 * Decides the node's type and in case it has a children list, returns it. Supports even the opaq nodes (::lyd_node_opaq).
1025 *
1026 * If you need to take key children into account, use ::lyd_child().
1027 *
1028 * @param[in] node Node to use.
1029 * @return Pointer to the first child node (if any) of the @p node.
1030 */
1031struct lyd_node *lyd_child_no_keys(const struct lyd_node *node);
Radek Krejcie7b95092019-05-15 11:03:07 +02001032
1033/**
Michal Vaskoc193ce92020-03-06 11:04:48 +01001034 * @brief Get the owner module of the data node. It is the module of the top-level schema node. Generally,
1035 * in case of augments it is the target module, recursively, otherwise it is the module where the data node is defined.
1036 *
Michal Vaskofcdf3012020-11-23 16:57:03 +01001037 * Also works for opaque nodes, if it is possible to resolve the module.
1038 *
Michal Vaskoc193ce92020-03-06 11:04:48 +01001039 * @param[in] node Data node to examine.
1040 * @return Module owner of the node.
1041 */
1042const struct lys_module *lyd_owner_module(const struct lyd_node *node);
1043
1044/**
Radek Krejci19611252020-10-04 13:54:53 +02001045 * @brief Check whether a node value equals to its default one.
1046 *
1047 * @param[in] node Term node to test.
1048 * @return false (no, it is not a default node) or true (yes, it is default)
1049 */
1050ly_bool lyd_is_default(const struct lyd_node *node);
1051
1052/**
Radek Krejcica989142020-11-05 11:32:22 +01001053 * @brief Learn the relative position of a list or leaf-list instance within other instances of the same schema node.
1054 *
1055 * @param[in] instance List or leaf-list instance to get the position of.
Michal Vaskoe78faec2021-04-08 17:24:43 +02001056 * @return 0 on error.
1057 * @return Positive integer of the @p instance position.
Radek Krejcica989142020-11-05 11:32:22 +01001058 */
1059uint32_t lyd_list_pos(const struct lyd_node *instance);
1060
1061/**
Radek Krejci4233f9b2020-11-05 12:38:35 +01001062 * @brief Get the first sibling of the given node.
1063 *
1064 * @param[in] node Node which first sibling is going to be the result.
1065 * @return The first sibling of the given node or the node itself if it is the first child of the parent.
1066 */
Michal Vasko6ae16d62020-11-06 17:23:23 +01001067struct lyd_node *lyd_first_sibling(const struct lyd_node *node);
Radek Krejci4233f9b2020-11-05 12:38:35 +01001068
1069/**
Michal Vasko60ea6352020-06-29 13:39:39 +02001070 * @brief Learn the length of LYB data.
1071 *
1072 * @param[in] data LYB data to examine.
1073 * @return Length of the LYB data chunk,
1074 * @return -1 on error.
1075 */
1076int lyd_lyb_data_length(const char *data);
1077
1078/**
Christian Hopps46bd21b2021-04-27 09:43:58 -04001079 * @brief Get the (canonical) value of a lyd_value.
1080 *
Michal Vasko33876022021-04-27 16:42:24 +02001081 * Whenever possible, ::lyd_get_value() or ::lyd_get_meta_value() should be used instead.
1082 *
Christian Hopps46bd21b2021-04-27 09:43:58 -04001083 * @param[in] ctx Context for the value
Michal Vasko33876022021-04-27 16:42:24 +02001084 * @param[in] value Value structure to use.
Christian Hopps46bd21b2021-04-27 09:43:58 -04001085 * @return Canonical value.
1086 */
1087const char *lyd_value_get_canonical(const struct ly_ctx *ctx, const struct lyd_value *value);
1088
1089/**
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001090 * @brief Get the (canonical) value of a data node.
1091 *
1092 * @param[in] node Data node to use.
1093 * @return Canonical value.
1094 */
Christian Hopps46bd21b2021-04-27 09:43:58 -04001095static inline const char *
1096lyd_get_value(const struct lyd_node *node)
1097{
1098 if (!node) {
1099 return NULL;
1100 }
1101
1102 if (!node->schema) {
1103 return ((struct lyd_node_opaq *)node)->value;
1104 } else if (node->schema->nodetype & LYD_NODE_TERM) {
1105 const struct lyd_value *value = &((struct lyd_node_term *)node)->value;
Michal Vasko33876022021-04-27 16:42:24 +02001106 return value->_canonical ? value->_canonical : lyd_value_get_canonical(LYD_CTX(node), value);
Christian Hopps46bd21b2021-04-27 09:43:58 -04001107 }
Michal Vasko33876022021-04-27 16:42:24 +02001108
Christian Hopps46bd21b2021-04-27 09:43:58 -04001109 return NULL;
1110}
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001111
1112/**
1113 * @brief Get the (canonical) value of a metadata node.
1114 *
1115 * @param[in] meta Metadata node to use.
1116 * @return Canonical value.
1117 */
Christian Hopps46bd21b2021-04-27 09:43:58 -04001118static inline const char *
1119lyd_get_meta_value(const struct lyd_meta *meta)
1120{
1121 if (meta) {
1122 const struct lyd_value *value = &meta->value;
Michal Vasko33876022021-04-27 16:42:24 +02001123 return value->_canonical ? value->_canonical : lyd_value_get_canonical(meta->annotation->module->ctx, value);
Christian Hopps46bd21b2021-04-27 09:43:58 -04001124 }
Michal Vasko33876022021-04-27 16:42:24 +02001125
Christian Hopps46bd21b2021-04-27 09:43:58 -04001126 return NULL;
1127}
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001128
1129/**
Michal Vaskoa820c312021-02-05 16:33:00 +01001130 * @brief Get anydata string value.
1131 *
1132 * @param[in] any Anyxml/anydata node to read from.
1133 * @param[out] value_str String representation of the value.
1134 * @return LY_ERR value.
1135 */
1136LY_ERR lyd_any_value_str(const struct lyd_node *any, char **value_str);
1137
1138/**
Michal Vaskoc0004272020-08-06 08:32:34 +02001139 * @brief Copy anydata value from one node to another. Target value is freed first.
1140 *
1141 * @param[in,out] trg Target node.
1142 * @param[in] value Source value, may be NULL when the target value is only freed.
1143 * @param[in] value_type Source value type.
1144 * @return LY_ERR value.
1145 */
1146LY_ERR lyd_any_copy_value(struct lyd_node *trg, const union lyd_any_value *value, LYD_ANYDATA_VALUETYPE value_type);
1147
1148/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001149 * @brief Create a new inner node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001150 *
Radek Krejcidd2a7662021-03-12 11:26:34 +01001151 * To create list, use ::lyd_new_list() or ::lyd_new_list2().
1152 *
1153 * To create a top-level inner node defined in an extension instance, use ::lyd_new_ext_inner().
1154 *
Michal Vasko013a8182020-03-03 10:46:53 +01001155 * @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 +01001156 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001157 * @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 +01001158 * @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
1159 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001160 * @param[out] node Optional created node.
1161 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001162 */
Michal Vasko53587422021-02-05 16:34:13 +01001163LY_ERR lyd_new_inner(struct lyd_node *parent, const struct lys_module *module, const char *name, ly_bool output,
1164 struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001165
1166/**
Radek Krejcidd2a7662021-03-12 11:26:34 +01001167 * @brief Create a new top-level inner node defined in the given extension instance.
1168 *
1169 * To create list, use ::lyd_new_list() or ::lyd_new_list2().
1170 *
1171 * To create an inner node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1172 * node of a standard module's tree, use ::lyd_new_inner().
1173 *
1174 * @param[in] ext Extension instance where the inner node being created is defined.
1175 * @param[in] name Schema node name of the new data node. The node can be #LYS_CONTAINER, #LYS_NOTIF, #LYS_RPC, or #LYS_ACTION.
1176 * @param[out] node The created node.
1177 * @return LY_ERR value.
1178 */
1179LY_ERR lyd_new_ext_inner(const struct lysc_ext_instance *ext, const char *name, struct lyd_node **node);
1180
1181/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001182 * @brief Create a new list node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001183 *
1184 * @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 +01001185 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001186 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
Radek Krejci41ac9942020-11-02 14:47:56 +01001187 * @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
1188 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001189 * @param[out] node Optional created node.
Michal Vasko013a8182020-03-03 10:46:53 +01001190 * @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 +02001191 * or identityref value, the JSON format is expected (module names instead of prefixes). No keys are expected for
1192 * key-less lists.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001193 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001194 */
Radek Krejci55c4bd22021-04-26 08:09:04 +02001195LY_ERR lyd_new_list(struct lyd_node *parent, const struct lys_module *module, const char *name, ly_bool output,
1196 struct lyd_node **node, ...);
Michal Vasko013a8182020-03-03 10:46:53 +01001197
1198/**
Radek Krejci8247bae2021-03-12 11:47:02 +01001199 * @brief Create a new top-level list node defined in the given extension instance.
1200 *
1201 * To create a list node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1202 * list node of a standard module's tree, use ::lyd_new_list() or ::lyd_new_list2().
1203 *
1204 * @param[in] ext Extension instance where the list node being created is defined.
1205 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
1206 * @param[out] node The created node.
1207 * @param[in] ... Ordered key values of the new list instance, all must be set. In case of an instance-identifier
1208 * or identityref value, the JSON format is expected (module names instead of prefixes). No keys are expected for
1209 * key-less lists.
1210 * @return LY_ERR value.
1211 */
1212LY_ERR lyd_new_ext_list(const struct lysc_ext_instance *ext, const char *name, struct lyd_node **node, ...);
1213
1214/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001215 * @brief Create a new list node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001216 *
1217 * @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 +01001218 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001219 * @param[in] name Schema node name of the new data node. The node must be #LYS_LIST.
1220 * @param[in] keys All key values predicate in the form of "[key1='val1'][key2='val2']...", they do not have to be ordered.
1221 * 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 +02001222 * Use NULL or string of length 0 in case of key-less list.
Radek Krejci41ac9942020-11-02 14:47:56 +01001223 * @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.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001225 * @param[out] node Optional created node.
1226 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001227 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001228LY_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 +01001229 ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001230
1231/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001232 * @brief Create a new term node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001233 *
Radek Krejci8a5afc22021-03-12 11:10:47 +01001234 * To create a top-level term node defined in an extension instance, use ::lyd_new_ext_term().
1235 *
Michal Vasko013a8182020-03-03 10:46:53 +01001236 * @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 +01001237 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001238 * @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 +02001239 * @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 +01001240 * @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
1241 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001242 * @param[out] node Optional created node.
1243 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001244 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001245LY_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 +01001246 ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001247
1248/**
Radek Krejci09c77442021-04-26 11:10:34 +02001249 * @brief Create a new term node in the data tree.
1250 *
1251 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
1252 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
1253 * @param[in] name Schema node name of the new data node. The node can be #LYS_LEAF or #LYS_LEAFLIST.
1254 * @param[in] value Binary value of the node. To learn what exactly is expected see @ref howtoDataLYB.
1255 * @param[in] value_len Length of @p value.
1256 * @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
1257 * taken into consideration. Otherwise, the output's data node is going to be created.
1258 * @param[out] node Optional created node.
1259 * @return LY_ERR value.
1260 */
1261LY_ERR lyd_new_term_bin(struct lyd_node *parent, const struct lys_module *module, const char *name, const void *value,
1262 size_t value_len, ly_bool output, struct lyd_node **node);
1263
1264/**
1265 * @brief Create a new term node in the data tree.
1266 *
1267 * @param[in] parent Parent node for the node being created. NULL in case of creating a top level element.
1268 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
1269 * @param[in] name Schema node name of the new data node. The node can be #LYS_LEAF or #LYS_LEAFLIST.
1270 * @param[in] val_str Canonical string value of the node. If it is not, it may lead to unexpected behavior.
1271 * @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
1272 * taken into consideration. Otherwise, the output's data node is going to be created.
1273 * @param[out] node Optional created node.
1274 * @return LY_ERR value.
1275 */
1276LY_ERR lyd_new_term_canon(struct lyd_node *parent, const struct lys_module *module, const char *name,
1277 const char *val_str, ly_bool output, struct lyd_node **node);
1278
1279/**
Radek Krejci8a5afc22021-03-12 11:10:47 +01001280 * @brief Create a new top-level term node defined in the given extension instance.
1281 *
1282 * To create a term node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1283 * node of a standard module's tree, use ::lyd_new_term().
1284 *
1285 * @param[in] ext Extension instance where the term node being created is defined.
1286 * @param[in] name Schema node name of the new data node. The node can be #LYS_LEAF or #LYS_LEAFLIST.
1287 * @param[in] val_str String form of the value of the node being created. In case of an instance-identifier or identityref
1288 * value, the JSON format is expected (module names instead of prefixes).
1289 * @param[out] node The created node.
1290 * @return LY_ERR value.
1291 */
1292LY_ERR lyd_new_ext_term(const struct lysc_ext_instance *ext, const char *name, const char *val_str, struct lyd_node **node);
1293
1294/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001295 * @brief Create a new any node in the data tree.
Michal Vasko013a8182020-03-03 10:46:53 +01001296 *
Radek Krejci0b963da2021-03-12 13:23:44 +01001297 * To create a top-level any node defined in an extension instance, use ::lyd_new_ext_any().
1298 *
Michal Vasko013a8182020-03-03 10:46:53 +01001299 * @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 +01001300 * @param[in] module Module of the node being created. If NULL, @p parent module will be used.
Michal Vasko013a8182020-03-03 10:46:53 +01001301 * @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 +01001302 * @param[in] value Value for the node. Expected type is determined by @p value_type.
1303 * @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 +01001304 * @param[in] value_type Type of the provided value in @p value.
Radek Krejci41ac9942020-11-02 14:47:56 +01001305 * @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
1306 * taken into consideration. Otherwise, the output's data node is going to be created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001307 * @param[out] node Optional created node.
1308 * @return LY_ERR value.
Michal Vasko013a8182020-03-03 10:46:53 +01001309 */
Michal Vasko2a4ab2b2021-03-04 15:52:40 +01001310LY_ERR lyd_new_any(struct lyd_node *parent, const struct lys_module *module, const char *name, const void *value,
1311 ly_bool use_value, LYD_ANYDATA_VALUETYPE value_type, ly_bool output, struct lyd_node **node);
Michal Vasko013a8182020-03-03 10:46:53 +01001312
1313/**
Radek Krejci0b963da2021-03-12 13:23:44 +01001314 * @brief Create a new top-level any node defined in the given extension instance.
1315 *
1316 * To create an any node with parent (no matter if defined inside extension instance or a standard tree) or a top-level
1317 * any node of a standard module's tree, use ::lyd_new_any().
1318 *
1319 * @param[in] ext Extension instance where the any node being created is defined.
1320 * @param[in] name Schema node name of the new data node. The node can be #LYS_ANYDATA or #LYS_ANYXML.
1321 * @param[in] value Value for the node. Expected type is determined by @p value_type.
1322 * @param[in] use_value Whether to directly take @p value and assign it to the node or make a copy.
1323 * @param[in] value_type Type of the provided value in @p value.
1324 * @param[out] node The created node.
1325 * @return LY_ERR value.
1326 */
1327LY_ERR lyd_new_ext_any(const struct lysc_ext_instance *ext, const char *name, const void *value, ly_bool use_value,
1328 LYD_ANYDATA_VALUETYPE value_type, struct lyd_node **node);
1329
1330/**
Michal Vasko871a0252020-11-11 18:35:24 +01001331 * @brief Create new metadata.
Michal Vaskod86997b2020-05-26 15:19:54 +02001332 *
Michal Vasko871a0252020-11-11 18:35:24 +01001333 * @param[in] ctx libyang context,
1334 * @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 +02001335 * @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 +02001336 * @param[in] name Annotation name of the new metadata. It can include the annotation module as the prefix.
1337 * 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 +02001338 * @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 +02001339 * value, the JSON format is expected (module names instead of prefixes).
Michal Vasko871a0252020-11-11 18:35:24 +01001340 * @param[in] clear_dflt Whether to clear the default flag starting from @p parent, recursively all NP containers.
1341 * @param[out] meta Optional created metadata. Must be set if @p parent is NULL.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001342 * @return LY_ERR value.
Michal Vaskod86997b2020-05-26 15:19:54 +02001343 */
Michal Vasko871a0252020-11-11 18:35:24 +01001344LY_ERR lyd_new_meta(const struct ly_ctx *ctx, struct lyd_node *parent, const struct lys_module *module, const char *name,
1345 const char *val_str, ly_bool clear_dflt, struct lyd_meta **meta);
Michal Vaskod86997b2020-05-26 15:19:54 +02001346
1347/**
Michal Vaskoba696702020-11-11 19:12:45 +01001348 * @brief Create new metadata from an opaque node attribute if possible.
1349 *
1350 * @param[in] ctx libyang context.
1351 * @param[in] parent Optional parent node for the metadata being created. Must be set if @p meta is NULL.
1352 * @param[in] clear_dflt Whether to clear the default flag starting from @p parent, recursively all NP containers.
1353 * @param[in] attr Opaque node attribute to parse into metadata.
1354 * @param[out] meta Optional created metadata. Must be set if @p parent is NULL.
1355 * @return LY_SUCCESS on success.
1356 * @return LY_ENOT if the attribute could not be parsed into any metadata.
1357 * @return LY_ERR on error.
1358 */
1359LY_ERR lyd_new_meta2(const struct ly_ctx *ctx, struct lyd_node *parent, ly_bool clear_dflt, const struct lyd_attr *attr,
1360 struct lyd_meta **meta);
1361
1362/**
Michal Vasko8d65f852021-02-17 11:28:13 +01001363 * @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 +02001364 *
1365 * @param[in] parent Parent node for the node beaing created. NULL in case of creating a top level element.
1366 * @param[in] ctx libyang context. If NULL, @p parent context will be used.
1367 * @param[in] name Node name.
Michal Vasko0ab974d2021-02-24 13:18:26 +01001368 * @param[in] value Optional node value.
1369 * @param[in] prefix Optional node prefix, must be equal to @p module_name if set.
Michal Vasko00cbf532020-06-15 13:58:47 +02001370 * @param[in] module_name Node module name.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001371 * @param[out] node Optional created node.
1372 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +02001373 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001374LY_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 +01001375 const char *prefix, const char *module_name, struct lyd_node **node);
Michal Vasko00cbf532020-06-15 13:58:47 +02001376
1377/**
Michal Vasko8d65f852021-02-17 11:28:13 +01001378 * @brief Create a new XML opaque node in the data tree. To create a JSON opaque node, use ::lyd_new_opaq().
1379 *
1380 * @param[in] parent Parent node for the node beaing created. NULL in case of creating a top level element.
1381 * @param[in] ctx libyang context. If NULL, @p parent context will be used.
1382 * @param[in] name Node name.
Michal Vasko0ab974d2021-02-24 13:18:26 +01001383 * @param[in] value Optional node value.
1384 * @param[in] prefix Optional node prefix.
Michal Vasko8d65f852021-02-17 11:28:13 +01001385 * @param[in] module_ns Node module namespace.
1386 * @param[out] node Optional created node.
1387 * @return LY_ERR value.
1388 */
1389LY_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 +01001390 const char *prefix, const char *module_ns, struct lyd_node **node);
Michal Vasko8d65f852021-02-17 11:28:13 +01001391
1392/**
1393 * @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 +02001394 *
1395 * @param[in] parent Parent opaque node for the attribute being created.
Radek Krejci8678fa42020-08-18 16:07:28 +02001396 * @param[in] module_name Name of the module of the attribute being created. There may be none.
Michal Vasko00cbf532020-06-15 13:58:47 +02001397 * @param[in] name Attribute name. It can include the module name as the prefix.
Michal Vasko8d65f852021-02-17 11:28:13 +01001398 * @param[in] value Attribute value, may be NULL.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001399 * @param[out] attr Optional created attribute.
1400 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +02001401 */
Michal Vasko8d65f852021-02-17 11:28:13 +01001402LY_ERR lyd_new_attr(struct lyd_node *parent, const char *module_name, const char *name, const char *value,
1403 struct lyd_attr **attr);
1404
1405/**
1406 * @brief Create new XML attribute for an opaque data node. To create a JSON attribute, use ::lyd_new_attr().
1407 *
1408 * @param[in] parent Parent opaque node for the attribute being created.
1409 * @param[in] module_ns Namespace of the module of the attribute being created. There may be none.
1410 * @param[in] name Attribute name. It can include an XML prefix.
1411 * @param[in] value Attribute value, may be NULL.
1412 * @param[out] attr Optional created attribute.
1413 * @return LY_ERR value.
1414 */
1415LY_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 +02001416 struct lyd_attr **attr);
Michal Vasko00cbf532020-06-15 13:58:47 +02001417
1418/**
Michal Vasko00cbf532020-06-15 13:58:47 +02001419 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001420 * @defgroup pathoptions Data path creation options
Michal Vasko00cbf532020-06-15 13:58:47 +02001421 *
1422 * Various options to change lyd_new_path*() behavior.
1423 *
1424 * Default behavior:
1425 * - if the target node already exists (and is not default), an error is returned.
1426 * - the whole path to the target node is created (with any missing parents) if necessary.
1427 * - RPC output schema children are completely ignored in all modules. Input is searched and nodes created normally.
1428 * @{
1429 */
1430
Radek Krejci09c77442021-04-26 11:10:34 +02001431#define LYD_NEW_PATH_UPDATE 0x01 /**< If the target node exists, is a leaf, and it is updated with a new value or its
1432 default flag is changed, it is returned. If the target node exists and is not
1433 a leaf or generally no change occurs in the @p parent tree, NULL is returned and
1434 no error set. */
1435#define LYD_NEW_PATH_OUTPUT 0x02 /**< Changes the behavior to ignoring RPC/action input schema nodes and using only
1436 output ones. */
1437#define LYD_NEW_PATH_OPAQ 0x04 /**< Enables the creation of opaque nodes with some specific rules. If the __last node__
1438 in the path is not uniquely defined ((leaf-)list without a predicate) or has an
1439 invalid value (leaf/leaf-list), it is created as opaque. */
1440#define LYD_NEW_PATH_BIN_VALUE 0x08 /**< Interpret the provided leaf/leaf-list @p value as being in the binary
1441 ::LY_VALUE_LYB format, to learn what exactly is expected see @ref howtoDataLYB. */
1442#define LYD_NEW_PATH_CANON_VALUE 0x10 /**< Interpret the provided leaf/leaf-list @p value as being in the canonical
1443 (or JSON if no defined) ::LY_VALUE_CANON format. If it is not, it may lead
1444 to unexpected behavior. */
Michal Vasko00cbf532020-06-15 13:58:47 +02001445
1446/** @} pathoptions */
1447
1448/**
Michal Vaskod5e67442021-03-04 15:56:31 +01001449 * @brief Create a new node in the data tree based on a path. If creating anyxml/anydata nodes, ::lyd_new_path2
1450 * should be used instead, this function expects the value as string.
Michal Vasko00cbf532020-06-15 13:58:47 +02001451 *
Radek Krejci95ccd1b2021-03-12 14:57:22 +01001452 * If creating data nodes defined inside an extension instance, use ::lyd_new_ext_path().
1453 *
Michal Vasko00cbf532020-06-15 13:58:47 +02001454 * If @p path points to a list key and the list instance does not exist, the key value from the predicate is used
1455 * and @p value is ignored. Also, if a leaf-list is being created and both a predicate is defined in @p path
1456 * and @p value is set, the predicate is preferred.
1457 *
Michal Vasko65591ab2021-04-09 14:29:34 +02001458 * For key-less lists and non-configuration leaf-lists, positional predicates should be used. If no predicate is used
1459 * for these nodes, they are always created.
Michal Vasko6741dc62021-02-04 09:27:45 +01001460 *
Michal Vasko104fe962020-11-06 17:23:44 +01001461 * @param[in] parent Data parent to add to/modify, can be NULL. Note that in case a first top-level sibling is used,
1462 * it may no longer be first if @p path is absolute and starts with a non-existing top-level node inserted
1463 * before @p parent. Use ::lyd_first_sibling() to adjust @p parent in these cases.
Michal Vasko00cbf532020-06-15 13:58:47 +02001464 * @param[in] ctx libyang context, must be set if @p parent is NULL.
Michal Vasko104fe962020-11-06 17:23:44 +01001465 * @param[in] path [Path](@ref howtoXPath) to create.
Radek Krejci09c77442021-04-26 11:10:34 +02001466 * @param[in] value String value of the new leaf/leaf-list. If it varies based on the format, ::LY_VALUE_JSON is expected.
1467 * For other node types, it should be NULL.
Michal Vasko00cbf532020-06-15 13:58:47 +02001468 * @param[in] options Bitmask of options, see @ref pathoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001469 * @param[out] node Optional first created node.
1470 * @return LY_ERR value.
Michal Vasko00cbf532020-06-15 13:58:47 +02001471 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001472LY_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 +02001473 uint32_t options, struct lyd_node **node);
Michal Vasko00cbf532020-06-15 13:58:47 +02001474
1475/**
1476 * @brief Create a new node in the data tree based on a path. All node types can be created.
1477 *
Michal Vasko65591ab2021-04-09 14:29:34 +02001478 * Details are mentioned in ::lyd_new_path().
Michal Vasko6741dc62021-02-04 09:27:45 +01001479 *
Michal Vasko104fe962020-11-06 17:23:44 +01001480 * @param[in] parent Data parent to add to/modify, can be NULL. Note that in case a first top-level sibling is used,
1481 * it may no longer be first if @p path is absolute and starts with a non-existing top-level node inserted
1482 * before @p parent. Use ::lyd_first_sibling() to adjust @p parent in these cases.
Michal Vasko00cbf532020-06-15 13:58:47 +02001483 * @param[in] ctx libyang context, must be set if @p parent is NULL.
Michal Vasko104fe962020-11-06 17:23:44 +01001484 * @param[in] path [Path](@ref howtoXPath) to create.
Radek Krejci09c77442021-04-26 11:10:34 +02001485 * @param[in] value Value of the new leaf/leaf-list (const char *) in ::LY_VALUE_JSON format. If creating an
1486 * anyxml/anydata node, the expected type depends on @p value_type. For other node types, it should be NULL.
1487 * @param[in] value_len Length of @p value in bytes. May be 0 if @p value is a zero-terminated string. Ignored when
1488 * creating anyxml/anydata nodes.
Michal Vasko00cbf532020-06-15 13:58:47 +02001489 * @param[in] value_type Anyxml/anydata node @p value type.
1490 * @param[in] options Bitmask of options, see @ref pathoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001491 * @param[out] new_parent Optional first parent node created. If only one node was created, equals to @p new_node.
1492 * @param[out] new_node Optional last node created.
Michal Vasko00cbf532020-06-15 13:58:47 +02001493 * @return LY_ERR value.
1494 */
1495LY_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 +02001496 size_t value_len, LYD_ANYDATA_VALUETYPE value_type, uint32_t options, struct lyd_node **new_parent,
1497 struct lyd_node **new_node);
Michal Vasko00cbf532020-06-15 13:58:47 +02001498
1499/**
Radek Krejci95ccd1b2021-03-12 14:57:22 +01001500 * @brief Create a new node defined in the given extension instance. In case of anyxml/anydata nodes, this function expects
1501 * the @p value as string.
1502 *
1503 * If creating data nodes defined in a module's standard tree, use ::lyd_new_path() or ::lyd_new_path2().
1504 *
Michal Vasko65591ab2021-04-09 14:29:34 +02001505 * Details are mentioned in ::lyd_new_path().
Radek Krejci95ccd1b2021-03-12 14:57:22 +01001506 *
1507 * @param[in] parent Data parent to add to/modify, can be NULL. Note that in case a first top-level sibling is used,
1508 * it may no longer be first if @p path is absolute and starts with a non-existing top-level node inserted
1509 * before @p parent. Use ::lyd_first_sibling() to adjust @p parent in these cases.
1510 * @param[in] ext Extension instance where the node being created is defined.
1511 * @param[in] path [Path](@ref howtoXPath) to create.
Radek Krejci09c77442021-04-26 11:10:34 +02001512 * @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 +01001513 * @param[in] options Bitmask of options, see @ref pathoptions.
1514 * @param[out] node Optional first created node.
1515 * @return LY_ERR value.
1516 */
1517LY_ERR lyd_new_ext_path(struct lyd_node *parent, const struct lysc_ext_instance *ext, const char *path, const void *value,
1518 uint32_t options, struct lyd_node **node);
1519
1520/**
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001521 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001522 * @defgroup implicitoptions Implicit node creation options
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001523 *
1524 * Various options to change lyd_new_implicit*() behavior.
1525 *
1526 * Default behavior:
1527 * - both configuration and state missing implicit nodes are added.
Michal Vasko630d9892020-12-08 17:11:08 +01001528 * - for existing RPC/action nodes, input implicit nodes are added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001529 * - all implicit node types are added (non-presence containers, default leaves, and default leaf-lists).
1530 * @{
1531 */
1532
Michal Vasko44b19a12020-08-07 09:21:30 +02001533#define LYD_IMPLICIT_NO_STATE 0x01 /**< Do not add any implicit state nodes. */
1534#define LYD_IMPLICIT_NO_CONFIG 0x02 /**< Do not add any implicit config nodes. */
Michal Vasko630d9892020-12-08 17:11:08 +01001535#define LYD_IMPLICIT_OUTPUT 0x04 /**< For RPC/action nodes, add output implicit nodes instead of input. */
1536#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 +02001537 containers. */
1538
1539/** @} implicitoptions */
1540
1541/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001542 * @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 +02001543 *
1544 * @param[in] tree Tree to add implicit nodes into.
1545 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1546 * @param[out] diff Optional diff with any created nodes.
1547 * @return LY_ERR value.
1548 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001549LY_ERR lyd_new_implicit_tree(struct lyd_node *tree, uint32_t implicit_options, struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001550
1551/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001552 * @brief Add any missing implicit nodes. Default nodes with a false "when" are not added.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001553 *
Michal Vaskod3bb12f2020-12-04 14:33:09 +01001554 * @param[in,out] tree Tree to add implicit nodes into. Note that in case a first top-level sibling is used,
1555 * it may no longer be first if an implicit node was inserted before @p tree. Use ::lyd_first_sibling() to
1556 * adjust @p tree in these cases.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001557 * @param[in] ctx libyang context, must be set only if @p tree is an empty tree.
1558 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1559 * @param[out] diff Optional diff with any created nodes.
1560 * @return LY_ERR value.
1561 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001562LY_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 +02001563
1564/**
Michal Vasko3488ada2020-12-03 14:18:19 +01001565 * @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 +02001566 *
Michal Vaskod3bb12f2020-12-04 14:33:09 +01001567 * @param[in,out] tree Tree to add implicit nodes into. Note that in case a first top-level sibling is used,
1568 * it may no longer be first if an implicit node was inserted before @p tree. Use ::lyd_first_sibling() to
1569 * adjust @p tree in these cases.
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001570 * @param[in] module Module whose implicit nodes to create.
1571 * @param[in] implicit_options Options for implicit node creation, see @ref implicitoptions.
1572 * @param[out] diff Optional diff with any created nodes.
1573 * @return LY_ERR value.
1574 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001575LY_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 +02001576 struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +02001577
1578/**
Radek Krejci09c77442021-04-26 11:10:34 +02001579 * @brief Change the value of a term (leaf or leaf-list) node to a string value.
Michal Vasko00cbf532020-06-15 13:58:47 +02001580 *
1581 * Node changed this way is always considered explicitly set, meaning its default flag
1582 * is always cleared.
1583 *
1584 * @param[in] term Term node to change.
1585 * @param[in] val_str New value to set, any prefixes are expected in JSON format.
1586 * @return LY_SUCCESS if value was changed,
1587 * @return LY_EEXIST if value was the same and only the default flag was cleared,
1588 * @return LY_ENOT if the values were equal and no change occured,
1589 * @return LY_ERR value on other errors.
1590 */
1591LY_ERR lyd_change_term(struct lyd_node *term, const char *val_str);
1592
1593/**
Radek Krejci09c77442021-04-26 11:10:34 +02001594 * @brief Change the value of a term (leaf or leaf-list) node to a binary value.
1595 *
1596 * Node changed this way is always considered explicitly set, meaning its default flag
1597 * is always cleared.
1598 *
1599 * @param[in] term Term node to change.
1600 * @param[in] value New value to set in binary format, see @ref howtoDataLYB.
1601 * @param[in] value_len Length of @p value.
1602 * @return LY_SUCCESS if value was changed,
1603 * @return LY_EEXIST if value was the same and only the default flag was cleared,
1604 * @return LY_ENOT if the values were equal and no change occured,
1605 * @return LY_ERR value on other errors.
1606 */
1607LY_ERR lyd_change_term_bin(struct lyd_node *term, const void *value, size_t value_len);
1608
1609/**
1610 * @brief Change the value of a term (leaf or leaf-list) node to a canonical string value.
1611 *
1612 * Node changed this way is always considered explicitly set, meaning its default flag
1613 * is always cleared.
1614 *
1615 * @param[in] term Term node to change.
1616 * @param[in] val_str New value to set in canonical (or JSON if no defined) format. If the value is not
1617 * canonical, it may lead to unexpected behavior.
1618 * @return LY_SUCCESS if value was changed,
1619 * @return LY_EEXIST if value was the same and only the default flag was cleared,
1620 * @return LY_ENOT if the values were equal and no change occured,
1621 * @return LY_ERR value on other errors.
1622 */
1623LY_ERR lyd_change_term_canon(struct lyd_node *term, const char *val_str);
1624
1625/**
Michal Vasko41586352020-07-13 13:54:25 +02001626 * @brief Change the value of a metadata instance.
1627 *
Michal Vasko41586352020-07-13 13:54:25 +02001628 * @param[in] meta Metadata to change.
1629 * @param[in] val_str New value to set, any prefixes are expected in JSON format.
1630 * @return LY_SUCCESS if value was changed,
1631 * @return LY_ENOT if the values were equal and no change occured,
1632 * @return LY_ERR value on other errors.
1633 */
1634LY_ERR lyd_change_meta(struct lyd_meta *meta, const char *val_str);
1635
1636/**
Michal Vaskob104f112020-07-17 09:54:54 +02001637 * @brief Insert a child into a parent.
Michal Vaskof03ed032020-03-04 13:31:44 +01001638 *
1639 * - if the node is part of some other tree, it is automatically unlinked.
1640 * - if the node is the first node of a node list (with no parent), all the subsequent nodes are also inserted.
1641 *
1642 * @param[in] parent Parent node to insert into.
1643 * @param[in] node Node to insert.
1644 * @return LY_SUCCESS on success.
1645 * @return LY_ERR error on error.
1646 */
Michal Vaskob104f112020-07-17 09:54:54 +02001647LY_ERR lyd_insert_child(struct lyd_node *parent, struct lyd_node *node);
Michal Vaskof03ed032020-03-04 13:31:44 +01001648
1649/**
Michal Vaskob104f112020-07-17 09:54:54 +02001650 * @brief Insert a node into siblings.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001651 *
1652 * - if the node is part of some other tree, it is automatically unlinked.
1653 * - if the node is the first node of a node list (with no parent), all the subsequent nodes are also inserted.
1654 *
Michal Vaskob104f112020-07-17 09:54:54 +02001655 * @param[in] sibling Siblings to insert into, can even be NULL.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001656 * @param[in] node Node to insert.
Michal Vaskob104f112020-07-17 09:54:54 +02001657 * @param[out] first Optionally return the first sibling after insertion. Can be the address of @p sibling.
Michal Vaskob1b5c262020-03-05 14:29:47 +01001658 * @return LY_SUCCESS on success.
1659 * @return LY_ERR error on error.
1660 */
Michal Vaskob104f112020-07-17 09:54:54 +02001661LY_ERR lyd_insert_sibling(struct lyd_node *sibling, struct lyd_node *node, struct lyd_node **first);
Michal Vaskob1b5c262020-03-05 14:29:47 +01001662
1663/**
Michal Vaskob104f112020-07-17 09:54:54 +02001664 * @brief Insert a node before another node, can be used only for user-ordered nodes.
Michal Vasko4bc2ce32020-12-08 10:06:16 +01001665 * If inserting several siblings, each of them must be inserted individually.
Michal Vaskof03ed032020-03-04 13:31:44 +01001666 *
1667 * - if the node is part of some other tree, it is automatically unlinked.
Michal Vaskof03ed032020-03-04 13:31:44 +01001668 *
1669 * @param[in] sibling Sibling node to insert before.
1670 * @param[in] node Node to insert.
1671 * @return LY_SUCCESS on success.
1672 * @return LY_ERR error on error.
1673 */
1674LY_ERR lyd_insert_before(struct lyd_node *sibling, struct lyd_node *node);
1675
1676/**
Michal Vaskob104f112020-07-17 09:54:54 +02001677 * @brief Insert a node after another node, can be used only for user-ordered nodes.
Michal Vasko4bc2ce32020-12-08 10:06:16 +01001678 * If inserting several siblings, each of them must be inserted individually.
Michal Vaskof03ed032020-03-04 13:31:44 +01001679 *
1680 * - if the node is part of some other tree, it is automatically unlinked.
Michal Vaskof03ed032020-03-04 13:31:44 +01001681 *
1682 * @param[in] sibling Sibling node to insert after.
1683 * @param[in] node Node to insert.
1684 * @return LY_SUCCESS on success.
1685 * @return LY_ERR error on error.
1686 */
1687LY_ERR lyd_insert_after(struct lyd_node *sibling, struct lyd_node *node);
1688
1689/**
1690 * @brief Unlink the specified data subtree.
1691 *
1692 * @param[in] node Data tree node to be unlinked (together with all the children).
1693 */
1694void lyd_unlink_tree(struct lyd_node *node);
1695
1696/**
Radek Krejcib0849a22019-07-25 12:31:04 +02001697 * @brief Free all the nodes (even parents of the node) in the data tree.
Radek Krejcie7b95092019-05-15 11:03:07 +02001698 *
1699 * @param[in] node Any of the nodes inside the tree.
1700 */
1701void lyd_free_all(struct lyd_node *node);
1702
1703/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001704 * @brief Free all the sibling nodes (preceding as well as succeeding).
Radek Krejcib0849a22019-07-25 12:31:04 +02001705 *
1706 * @param[in] node Any of the sibling nodes to free.
1707 */
Michal Vaskof03ed032020-03-04 13:31:44 +01001708void lyd_free_siblings(struct lyd_node *node);
Radek Krejcib0849a22019-07-25 12:31:04 +02001709
1710/**
Radek Krejcie7b95092019-05-15 11:03:07 +02001711 * @brief Free (and unlink) the specified data (sub)tree.
1712 *
Radek Krejcie7b95092019-05-15 11:03:07 +02001713 * @param[in] node Root of the (sub)tree to be freed.
1714 */
1715void lyd_free_tree(struct lyd_node *node);
1716
1717/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001718 * @brief Free a single metadata instance.
Radek Krejcie7b95092019-05-15 11:03:07 +02001719 *
Michal Vasko3a41dff2020-07-15 14:30:28 +02001720 * @param[in] meta Metadata to free.
Radek Krejcie7b95092019-05-15 11:03:07 +02001721 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001722void lyd_free_meta_single(struct lyd_meta *meta);
Michal Vasko52927e22020-03-16 17:26:14 +01001723
1724/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001725 * @brief Free the metadata instance with any following instances.
1726 *
1727 * @param[in] meta Metadata to free.
1728 */
1729void lyd_free_meta_siblings(struct lyd_meta *meta);
1730
1731/**
1732 * @brief Free a single attribute.
Michal Vasko52927e22020-03-16 17:26:14 +01001733 *
1734 * @param[in] ctx Context where the attributes were created.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001735 * @param[in] attr Attribute to free.
Michal Vasko52927e22020-03-16 17:26:14 +01001736 */
Radek Krejci011e4aa2020-09-04 15:22:31 +02001737void lyd_free_attr_single(const struct ly_ctx *ctx, struct lyd_attr *attr);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001738
1739/**
1740 * @brief Free the attribute with any following attributes.
1741 *
1742 * @param[in] ctx Context where the attributes were created.
1743 * @param[in] attr First attribute to free.
1744 */
Radek Krejci011e4aa2020-09-04 15:22:31 +02001745void lyd_free_attr_siblings(const struct ly_ctx *ctx, struct lyd_attr *attr);
Radek Krejcie7b95092019-05-15 11:03:07 +02001746
Radek Krejci084289f2019-07-09 17:35:30 +02001747/**
1748 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value.
1749 *
1750 * The given node is not modified in any way - it is just checked if the @p value can be set to the node.
1751 *
Radek Krejci084289f2019-07-09 17:35:30 +02001752 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
Michal Vaskoaebbce02021-04-06 09:23:37 +02001753 * @param[in] schema Schema node of the @p value.
Michal Vaskof937cfe2020-08-03 16:07:12 +02001754 * @param[in] value String value to be checked, it is expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02001755 * @param[in] value_len Length of the given @p value (mandatory).
Michal Vaskoaebbce02021-04-06 09:23:37 +02001756 * @param[in] ctx_node Optional data tree context node for the value (leafref target, instance-identifier).
1757 * If not set and is required for the validation to complete, ::LY_EINCOMPLETE is be returned.
1758 * @param[out] realtype Optional real type of @p value.
1759 * @param[out] canonical Optional canonical value of @p value (in the dictionary).
Radek Krejci084289f2019-07-09 17:35:30 +02001760 * @return LY_SUCCESS on success
Michal Vaskoaebbce02021-04-06 09:23:37 +02001761 * @return LY_EINCOMPLETE in case the @p ctx_node is not provided and it was needed to finish the validation
1762 * (e.g. due to require-instance).
Radek Krejci084289f2019-07-09 17:35:30 +02001763 * @return LY_ERR value if an error occurred.
1764 */
Michal Vaskoaebbce02021-04-06 09:23:37 +02001765LY_ERR lyd_value_validate(const struct ly_ctx *ctx, const struct lysc_node *schema, const char *value, size_t value_len,
1766 const struct lyd_node *ctx_node, const struct lysc_type **realtype, const char **canonical);
Radek Krejci084289f2019-07-09 17:35:30 +02001767
1768/**
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001769 * @brief Compare the node's value with the given string value. The string value is first validated according to
1770 * the (current) node's type.
Radek Krejci084289f2019-07-09 17:35:30 +02001771 *
1772 * @param[in] node Data node to compare.
1773 * @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 +02001774 * it is validated and canonized if possible. But it is expected to be in JSON format.
Radek Krejci084289f2019-07-09 17:35:30 +02001775 * @param[in] value_len Length of the given @p value (mandatory).
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001776 * @return LY_SUCCESS on success,
1777 * @return LY_ENOT if the values do not match,
Radek Krejci084289f2019-07-09 17:35:30 +02001778 * @return LY_ERR value if an error occurred.
1779 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +02001780LY_ERR lyd_value_compare(const struct lyd_node_term *node, const char *value, size_t value_len);
Radek Krejci084289f2019-07-09 17:35:30 +02001781
Radek Krejci576b23f2019-07-12 14:06:32 +02001782/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001783 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001784 * @defgroup datacompareoptions Data compare options
1785 * @{
1786 * Various options to change the ::lyd_compare_single() and ::lyd_compare_siblings() behavior.
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001787 */
1788#define LYD_COMPARE_FULL_RECURSION 0x01 /* lists and containers are the same only in case all they children
1789 (subtree, so direct as well as indirect children) are the same. By default,
1790 containers are the same in case of the same schema node and lists are the same
1791 in case of equal keys (keyless lists do the full recursion comparison all the time). */
1792#define LYD_COMPARE_DEFAULTS 0x02 /* By default, implicit and explicit default nodes are considered to be equal. This flag
1793 changes this behavior and implicit (automatically created default node) and explicit
1794 (explicitly created node with the default value) default nodes are considered different. */
Michal Vasko60ea6352020-06-29 13:39:39 +02001795/** @} datacompareoptions */
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001796
1797/**
1798 * @brief Compare 2 data nodes if they are equivalent.
1799 *
1800 * @param[in] node1 The first node to compare.
1801 * @param[in] node2 The second node to compare.
Radek Krejcic5ad9652019-09-11 11:31:51 +02001802 * @param[in] options Various @ref datacompareoptions.
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001803 * @return LY_SUCCESS if the nodes are equivalent.
1804 * @return LY_ENOT if the nodes are not equivalent.
1805 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001806LY_ERR lyd_compare_single(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
Michal Vasko8f359bf2020-07-28 10:41:15 +02001807
1808/**
1809 * @brief Compare 2 lists of siblings if they are equivalent.
1810 *
1811 * @param[in] node1 The first sibling list to compare.
1812 * @param[in] node2 The second sibling list to compare.
1813 * @param[in] options Various @ref datacompareoptions.
1814 * @return LY_SUCCESS if all the siblings are equivalent.
1815 * @return LY_ENOT if the siblings are not equivalent.
1816 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001817LY_ERR lyd_compare_siblings(const struct lyd_node *node1, const struct lyd_node *node2, uint32_t options);
Radek Krejci1f05b6a2019-07-18 16:15:06 +02001818
1819/**
Michal Vasko21725742020-06-29 11:49:25 +02001820 * @brief Compare 2 metadata.
1821 *
1822 * @param[in] meta1 First metadata.
1823 * @param[in] meta2 Second metadata.
1824 * @return LY_SUCCESS if the metadata are equivalent.
1825 * @return LY_ENOT if not.
1826 */
1827LY_ERR lyd_compare_meta(const struct lyd_meta *meta1, const struct lyd_meta *meta2);
1828
1829/**
Radek Krejci22ebdba2019-07-25 13:59:43 +02001830 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001831 * @defgroup dupoptions Data duplication options
Radek Krejci22ebdba2019-07-25 13:59:43 +02001832 *
Michal Vaskoe78faec2021-04-08 17:24:43 +02001833 * Various options to change ::lyd_dup_single() and ::lyd_dup_siblings() behavior.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001834 *
1835 * Default behavior:
1836 * - only the specified node is duplicated without siblings, parents, or children.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001837 * - all the metadata of the duplicated nodes are also duplicated.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001838 * @{
1839 */
1840
1841#define LYD_DUP_RECURSIVE 0x01 /**< Duplicate not just the node but also all the children. Note that
1842 list's keys are always duplicated. */
Michal Vaskoa29a5762020-06-23 13:28:49 +02001843#define LYD_DUP_NO_META 0x02 /**< Do not duplicate metadata of any node. */
Radek Krejci22ebdba2019-07-25 13:59:43 +02001844#define LYD_DUP_WITH_PARENTS 0x04 /**< If a nested node is being duplicated, duplicate also all the parents.
1845 Keys are also duplicated for lists. Return value does not change! */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001846#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 +02001847 its validation/default node state. */
Radek Krejci22ebdba2019-07-25 13:59:43 +02001848
1849/** @} dupoptions */
1850
1851/**
1852 * @brief Create a copy of the specified data tree \p node. Schema references are kept the same.
1853 *
Radek Krejci22ebdba2019-07-25 13:59:43 +02001854 * @param[in] node Data tree node to be duplicated.
1855 * @param[in] parent Optional parent node where to connect the duplicated node(s).
Michal Vasko3a41dff2020-07-15 14:30:28 +02001856 * If set in combination with LYD_DUP_WITH_PARENTS, the parents chain is duplicated until it comes to and connects with
1857 * the @p parent.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001858 * @param[in] options Bitmask of options flags, see @ref dupoptions.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001859 * @param[out] dup Optional created copy of the node. Note that in case the parents chain is duplicated for the duplicated
1860 * node(s) (when LYD_DUP_WITH_PARENTS used), the first duplicated node is still returned.
1861 * @return LY_ERR value.
Radek Krejci22ebdba2019-07-25 13:59:43 +02001862 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001863LY_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 +02001864
1865/**
1866 * @brief Create a copy of the specified data tree \p node with any following siblings. Schema references are kept the same.
1867 *
1868 * @param[in] node Data tree node to be duplicated.
1869 * @param[in] parent Optional parent node where to connect the duplicated node(s).
1870 * If set in combination with LYD_DUP_WITH_PARENTS, the parents chain is duplicated until it comes to and connects with
1871 * the @p parent.
1872 * @param[in] options Bitmask of options flags, see @ref dupoptions.
1873 * @param[out] dup Optional created copy of the node. Note that in case the parents chain is duplicated for the duplicated
1874 * node(s) (when LYD_DUP_WITH_PARENTS used), the first duplicated node is still returned.
1875 * @return LY_ERR value.
1876 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001877LY_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 +02001878
1879/**
Michal Vasko25a32822020-07-09 15:48:22 +02001880 * @brief Create a copy of the metadata.
1881 *
1882 * @param[in] meta Metadata to copy.
Michal Vasko3a41dff2020-07-15 14:30:28 +02001883 * @param[in] parent Node where to append the new metadata.
1884 * @param[out] dup Optional created metadata copy.
1885 * @return LY_ERR value.
Michal Vasko25a32822020-07-09 15:48:22 +02001886 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001887LY_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 +02001888
1889/**
Michal Vasko4490d312020-06-16 13:08:55 +02001890 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001891 * @defgroup mergeoptions Data merge options.
Radek Krejci576b23f2019-07-12 14:06:32 +02001892 *
Michal Vaskocd3f6172021-05-18 16:14:50 +02001893 * Various options to change ::lyd_merge_tree(), ::lyd_merge_siblings(), and ::lyd_merge_module() behavior.
Michal Vasko4490d312020-06-16 13:08:55 +02001894 *
1895 * Default behavior:
1896 * - source data tree is not modified in any way,
Michal Vasko745d6f62021-04-12 16:55:23 +02001897 * - any default nodes in the source are ignored if there are explicit nodes in the target,
1898 * - any metadata are ignored - those present in the target are kept, those in the source are not merged.
Michal Vasko4490d312020-06-16 13:08:55 +02001899 * @{
1900 */
1901
1902#define LYD_MERGE_DESTRUCT 0x01 /**< Spend source data tree in the function, it cannot be used afterwards! */
Michal Vasko3a41dff2020-07-15 14:30:28 +02001903#define LYD_MERGE_DEFAULTS 0x02 /**< Default nodes in the source tree replace even explicit nodes in the target. */
Michal Vasko4490d312020-06-16 13:08:55 +02001904
1905/** @} mergeoptions */
1906
1907/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02001908 * @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 +02001909 * is called on the resulting data tree (data from more cases may be present, default and non-default values).
1910 *
Michal Vasko2f510942020-11-13 10:26:25 +01001911 * Example input:
1912 *
1913 * source (A1) - A2 - A3 target (B1) - B2 - B3
1914 * /\ /\ /\ /\ /\ /\
1915 * .... .... .... .... .... ....
1916 *
1917 * result target (A1) - B1 - B2 - B3
1918 * /\ /\ /\ /\
1919 * .... .... .... ....
1920 *
Michal Vasko4490d312020-06-16 13:08:55 +02001921 * @param[in,out] target Target data tree to merge into, must be a top-level tree.
1922 * @param[in] source Source data tree to merge, must be a top-level tree.
1923 * @param[in] options Bitmask of option flags, see @ref mergeoptions.
1924 * @return LY_SUCCESS on success,
1925 * @return LY_ERR value on error.
1926 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001927LY_ERR lyd_merge_tree(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
Michal Vasko3a41dff2020-07-15 14:30:28 +02001928
1929/**
1930 * @brief Merge the source data tree with any following siblings into the target data tree. Merge may not be
1931 * complete until validation called on the resulting data tree (data from more cases may be present, default
1932 * and non-default values).
1933 *
Michal Vasko2f510942020-11-13 10:26:25 +01001934 * Example input:
1935 *
1936 * source (A1) - A2 - A3 target (B1) - B2 - B3
1937 * /\ /\ /\ /\ /\ /\
1938 * .... .... .... .... .... ....
1939 *
1940 * result target (A1) - A2 - A3 - B1 - B2 - B3
1941 * /\ /\ /\ /\ /\ /\
1942 * .... .... .... .... .... ....
1943 *
Michal Vasko3a41dff2020-07-15 14:30:28 +02001944 * @param[in,out] target Target data tree to merge into, must be a top-level tree.
1945 * @param[in] source Source data tree to merge, must be a top-level tree.
1946 * @param[in] options Bitmask of option flags, see @ref mergeoptions.
1947 * @return LY_SUCCESS on success,
1948 * @return LY_ERR value on error.
1949 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02001950LY_ERR lyd_merge_siblings(struct lyd_node **target, const struct lyd_node *source, uint16_t options);
Michal Vasko4490d312020-06-16 13:08:55 +02001951
1952/**
Michal Vaskocd3f6172021-05-18 16:14:50 +02001953 * @brief Callback for matching merge nodes.
1954 *
1955 * @param[in] trg_node Target data node.
1956 * @param[in] src_node Source data node, is NULL if it was actually duplicated (no target node found) and
1957 * its copy is @p trg_node.
1958 * @param[in] cb_data Arbitrary callback data.
1959 * @return LY_ERR value.
1960 */
1961typedef LY_ERR (*lyd_merge_cb)(struct lyd_node *trg_node, const struct lyd_node *src_node, void *cb_data);
1962
1963/**
1964 * @brief Merge all the nodes of a module from source data tree into the target data tree. Merge may not be
1965 * complete until validation called on the resulting data tree (data from more cases may be present, default
1966 * and non-default values).
1967 *
1968 * @param[in,out] target Target data tree to merge into, must be a top-level tree.
1969 * @param[in] source Source data tree to merge, must be a top-level tree.
1970 * @param[in] mod Module, whose source data only to consider, NULL for all modules.
Michal Vasko807557c2021-05-25 08:50:52 +02001971 * @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 +02001972 * If a subtree is being added into target (no matching node found), callback is called only once with the subtree root.
1973 * @param[in] cb_data Arbitrary callback data.
1974 * @param[in] options Bitmask of option flags, see @ref mergeoptions.
1975 * @return LY_SUCCESS on success,
1976 * @return LY_ERR value on error.
1977 */
1978LY_ERR lyd_merge_module(struct lyd_node **target, const struct lyd_node *source, const struct lys_module *mod,
1979 lyd_merge_cb merge_cb, void *cb_data, uint16_t options);
1980
1981/**
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001982 * @ingroup datatree
Radek Krejci8678fa42020-08-18 16:07:28 +02001983 * @defgroup diffoptions Data diff options.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001984 *
Radek Krejci8678fa42020-08-18 16:07:28 +02001985 * Various options to change ::lyd_diff_tree() and ::lyd_diff_siblings() behavior.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001986 *
1987 * Default behavior:
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001988 * - any default nodes are treated as non-existent and ignored.
1989 * @{
1990 */
1991
Michal Vasko3a41dff2020-07-15 14:30:28 +02001992#define LYD_DIFF_DEFAULTS 0x01 /**< Default nodes in the trees are not ignored but treated similarly to explicit
1993 nodes. Also, leaves and leaf-lists are added into diff even in case only their
1994 default flag (state) was changed. */
Michal Vaskoe893ddd2020-06-23 13:35:20 +02001995
1996/** @} diffoptions */
1997
1998/**
1999 * @brief Learn the differences between 2 data trees.
2000 *
2001 * The resulting diff is represented as a data tree with specific metadata from the internal 'yang'
2002 * module. Most importantly, every node has an effective 'operation' metadata. If there is none
2003 * defined on the node, it inherits the operation from the nearest parent. Top-level nodes must
2004 * always have the 'operation' metadata defined. Additional metadata ('orig-default', 'value',
2005 * 'orig-value', 'key', 'orig-key') are used for storing more information about the value in the first
2006 * or the second tree.
2007 *
2008 * The diff tree is completely independent on the @p first and @p second trees, meaning all
2009 * the information about the change is stored in the diff and the trees are not needed.
2010 *
Michal Vaskoff857812021-03-05 17:03:52 +01002011 * __!! Caution !!__
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002012 * The diff tree should never be validated because it may easily not be valid! For example,
2013 * when data from one case branch are deleted and data from another branch created - data from both
2014 * branches are then stored in the diff tree simultaneously.
2015 *
2016 * @param[in] first First data tree.
2017 * @param[in] second Second data tree.
2018 * @param[in] options Bitmask of options flags, see @ref diffoptions.
2019 * @param[out] diff Generated diff.
2020 * @return LY_SUCCESS on success,
2021 * @return LY_ERR on error.
2022 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02002023LY_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 +02002024
2025/**
2026 * @brief Learn the differences between 2 data trees including all the following siblings.
2027 *
Michal Vaskoff857812021-03-05 17:03:52 +01002028 * Details are mentioned in ::lyd_diff_tree().
2029 *
Michal Vasko3a41dff2020-07-15 14:30:28 +02002030 * @param[in] first First data tree.
2031 * @param[in] second Second data tree.
2032 * @param[in] options Bitmask of options flags, see @ref diffoptions.
2033 * @param[out] diff Generated diff.
2034 * @return LY_SUCCESS on success,
2035 * @return LY_ERR on error.
2036 */
Radek Krejci1deb5be2020-08-26 16:43:36 +02002037LY_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 +02002038
2039/**
2040 * @brief Callback for diff nodes.
2041 *
2042 * @param[in] diff_node Diff node.
2043 * @param[in] data_node Matching node in data.
2044 * @param[in] cb_data Arbitrary callback data.
2045 * @return LY_ERR value.
2046 */
2047typedef LY_ERR (*lyd_diff_cb)(const struct lyd_node *diff_node, struct lyd_node *data_node, void *cb_data);
2048
2049/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02002050 * @brief Apply the whole diff on a data tree but restrict the operation to one module.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002051 *
Michal Vaskoa98dcba2021-03-05 17:04:14 +01002052 * __!! Caution !!__
2053 * If applying a diff that was created __without__ the ::LYD_DIFF_DEFAULTS flag, there may be some duplicate values
2054 * created. Unless the resulting tree is validated (and default values thus consolidated), using it further
2055 * (such as applying another diff) may cause unexpected results or errors.
2056 *
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002057 * @param[in,out] data Data to apply the diff on.
2058 * @param[in] diff Diff to apply.
2059 * @param[in] mod Module, whose diff/data only to consider, NULL for all modules.
2060 * @param[in] diff_cb Optional diff callback that will be called for every changed node.
2061 * @param[in] cb_data Arbitrary callback data.
2062 * @return LY_SUCCESS on success,
2063 * @return LY_ERR on error.
2064 */
2065LY_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 +02002066 lyd_diff_cb diff_cb, void *cb_data);
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002067
2068/**
Michal Vasko3a41dff2020-07-15 14:30:28 +02002069 * @brief Apply the whole diff tree on a data tree.
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002070 *
Michal Vaskoff857812021-03-05 17:03:52 +01002071 * Details are mentioned in ::lyd_diff_apply_module().
2072 *
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002073 * @param[in,out] data Data to apply the diff on.
2074 * @param[in] diff Diff to apply.
2075 * @return LY_SUCCESS on success,
2076 * @return LY_ERR on error.
2077 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02002078LY_ERR lyd_diff_apply_all(struct lyd_node **data, const struct lyd_node *diff);
Michal Vaskoe893ddd2020-06-23 13:35:20 +02002079
2080/**
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002081 * @ingroup datatree
2082 * @defgroup diffmergeoptions Data diff merge options.
2083 *
2084 * Various options to change ::lyd_diff_merge_module(), ::lyd_diff_merge_tree(), and ::lyd_diff_merge_all() behavior.
2085 *
2086 * Default behavior:
2087 * - any default nodes are expected to be a result of validation corrections and not explicitly modified.
2088 * @{
2089 */
2090
2091#define LYD_DIFF_MERGE_DEFAULTS 0x01 /**< Default nodes in the diffs are treated as possibly explicitly modified. */
2092
Michal Vaskoff857812021-03-05 17:03:52 +01002093/** @} diffmergeoptions */
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002094
2095/**
Michal Vaskoe6323f62020-07-09 15:49:02 +02002096 * @brief Merge 2 diffs into each other but restrict the operation to one module.
2097 *
2098 * The diffs must be possible to be merged, which is guaranteed only if the source diff was
2099 * created on data that had the target diff applied on them. In other words, this sequence is legal
2100 *
Michal Vaskoff857812021-03-05 17:03:52 +01002101 * 1) get diff1 from data1 and data2 -> get data11 from apply diff1 on data1 -> get diff2 from data11 and data3 ->
2102 * -> get data 33 from apply diff2 on data1
Michal Vaskoe6323f62020-07-09 15:49:02 +02002103 *
2104 * and reusing these diffs
2105 *
Michal Vaskoff857812021-03-05 17:03:52 +01002106 * 2) get diff11 from merge diff1 and diff2 -> get data33 from apply diff11 on data1
Michal Vaskoe6323f62020-07-09 15:49:02 +02002107 *
Michal Vaskofb737aa2020-08-06 13:53:53 +02002108 * @param[in,out] diff Target diff to merge into.
Michal Vaskoe6323f62020-07-09 15:49:02 +02002109 * @param[in] src_diff Source diff.
2110 * @param[in] mod Module, whose diff only to consider, NULL for all modules.
Michal Vaskoe2af8412020-12-03 14:11:38 +01002111 * @param[in] diff_cb Optional diff callback that will be called for every merged node. Param @p diff_node is the source
2112 * diff node while @p data_node is the updated target diff node. In case a whole subtree is added, the callback is
2113 * called on the root with @p diff_node being NULL.
Michal Vaskoe6323f62020-07-09 15:49:02 +02002114 * @param[in] cb_data Arbitrary callback data.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002115 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vaskoe6323f62020-07-09 15:49:02 +02002116 * @return LY_SUCCESS on success,
2117 * @return LY_ERR on error.
2118 */
Michal Vaskofb737aa2020-08-06 13:53:53 +02002119LY_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 +01002120 lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
Michal Vaskoe6323f62020-07-09 15:49:02 +02002121
2122/**
Michal Vasko04f85912020-08-07 12:14:58 +02002123 * @brief Merge 2 diff trees into each other.
2124 *
Michal Vaskoff857812021-03-05 17:03:52 +01002125 * Details are mentioned in ::lyd_diff_merge_module().
2126 *
Michal Vasko04f85912020-08-07 12:14:58 +02002127 * @param[in,out] diff_first Target diff first sibling to merge into.
2128 * @param[in] diff_parent Target diff parent to merge into.
2129 * @param[in] src_sibling Source diff sibling to merge.
Michal Vaskoe2af8412020-12-03 14:11:38 +01002130 * @param[in] diff_cb Optional diff callback that will be called for every merged node. Param @p diff_node is the source
2131 * diff node while @p data_node is the updated target diff node. In case a whole subtree is added, the callback is
2132 * called on the root with @p diff_node being NULL.
Michal Vasko04f85912020-08-07 12:14:58 +02002133 * @param[in] cb_data Arbitrary callback data.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002134 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vasko04f85912020-08-07 12:14:58 +02002135 * @return LY_SUCCESS on success,
2136 * @return LY_ERR on error.
2137 */
2138LY_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 +01002139 lyd_diff_cb diff_cb, void *cb_data, uint16_t options);
Michal Vasko04f85912020-08-07 12:14:58 +02002140
2141/**
Michal Vaskoe6323f62020-07-09 15:49:02 +02002142 * @brief Merge 2 diffs into each other.
2143 *
Michal Vaskoff857812021-03-05 17:03:52 +01002144 * Details are mentioned in ::lyd_diff_merge_module().
2145 *
Michal Vaskoe6323f62020-07-09 15:49:02 +02002146 * @param[in,out] diff Target diff to merge into.
Michal Vaskofb737aa2020-08-06 13:53:53 +02002147 * @param[in] src_diff Source diff.
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002148 * @param[in] options Bitmask of options flags, see @ref diffmergeoptions.
Michal Vaskoe6323f62020-07-09 15:49:02 +02002149 * @return LY_SUCCESS on success,
2150 * @return LY_ERR on error.
2151 */
Michal Vaskoc0e58e82020-11-11 19:04:33 +01002152LY_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 +02002153
2154/**
Michal Vasko4231fb62020-07-13 13:54:47 +02002155 * @brief Reverse a diff and make the opposite changes. Meaning change create to delete, delete to create,
2156 * or move from place A to B to move from B to A and so on.
2157 *
2158 * @param[in] src_diff Diff to reverse.
2159 * @param[out] diff Reversed diff.
2160 * @return LY_SUCCESS on success.
2161 * @return LY_ERR on error.
2162 */
Michal Vasko3a41dff2020-07-15 14:30:28 +02002163LY_ERR lyd_diff_reverse_all(const struct lyd_node *src_diff, struct lyd_node **diff);
Michal Vasko4231fb62020-07-13 13:54:47 +02002164
2165/**
Michal Vaskobb22b182021-06-14 08:14:21 +02002166 * @brief Deprecated, use ::lyd_find_target() instead.
Michal Vasko4490d312020-06-16 13:08:55 +02002167 *
2168 * @param[in] path Compiled path structure.
Michal Vaskof03ed032020-03-04 13:31:44 +01002169 * @param[in] tree Data tree to be searched.
Michal Vasko4490d312020-06-16 13:08:55 +02002170 * @return Found target node,
2171 * @return NULL if not found.
Radek Krejci576b23f2019-07-12 14:06:32 +02002172 */
Michal Vasko004d3152020-06-11 19:59:22 +02002173const struct lyd_node_term *lyd_target(const struct ly_path *path, const struct lyd_node *tree);
Radek Krejci084289f2019-07-09 17:35:30 +02002174
Michal Vasko5ec7cda2019-09-11 13:43:08 +02002175/**
Michal Vasko5ec7cda2019-09-11 13:43:08 +02002176 * @brief Types of the different data paths.
2177 */
2178typedef enum {
Radek Krejci635d2b82021-01-04 11:26:51 +01002179 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 +01002180 creating new nodes (::lyd_new_path(), ::lyd_new_path2(), ::lyd_new_ext_path()). */
Radek Krejci635d2b82021-01-04 11:26:51 +01002181 LYD_PATH_STD_NO_LAST_PRED /**< Similar to ::LYD_PATH_STD except there is never a predicate on the last node. While it
2182 can be used to search for nodes, do not use it to create new data nodes (lists). */
Michal Vasko5ec7cda2019-09-11 13:43:08 +02002183} LYD_PATH_TYPE;
2184
2185/**
2186 * @brief Generate path of the given node in the requested format.
2187 *
Radek Krejci635d2b82021-01-04 11:26:51 +01002188 * @param[in] node Data path of this node will be generated.
Michal Vasko5ec7cda2019-09-11 13:43:08 +02002189 * @param[in] pathtype Format of the path to generate.
2190 * @param[in,out] buffer Prepared buffer of the @p buflen length to store the generated path.
2191 * If NULL, memory for the complete path is allocated.
2192 * @param[in] buflen Size of the provided @p buffer.
2193 * @return NULL in case of memory allocation error, path of the node otherwise.
2194 * In case the @p buffer is NULL, the returned string is dynamically allocated and caller is responsible to free it.
2195 */
2196char *lyd_path(const struct lyd_node *node, LYD_PATH_TYPE pathtype, char *buffer, size_t buflen);
2197
Michal Vaskoe444f752020-02-10 12:20:06 +01002198/**
Michal Vasko25a32822020-07-09 15:48:22 +02002199 * @brief Find a specific metadata.
2200 *
2201 * @param[in] first First metadata to consider.
2202 * @param[in] module Module of the metadata definition, may be NULL if @p name includes a prefix.
2203 * @param[in] name Name of the metadata to find, may not include a prefix (module name) if @p module is set.
2204 * @return Found metadata,
2205 * @return NULL if not found.
2206 */
2207struct lyd_meta *lyd_find_meta(const struct lyd_meta *first, const struct lys_module *module, const char *name);
2208
2209/**
Michal Vaskoda859032020-07-14 12:20:14 +02002210 * @brief Search in the given siblings (NOT recursively) for the first target instance with the same value.
Michal Vaskoe444f752020-02-10 12:20:06 +01002211 * Uses hashes - should be used whenever possible for best performance.
2212 *
2213 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
2214 * @param[in] target Target node to find.
Michal Vasko9b368d32020-02-14 13:53:31 +01002215 * @param[out] match Can be NULL, otherwise the found data node.
Michal Vaskoe444f752020-02-10 12:20:06 +01002216 * @return LY_SUCCESS on success, @p match set.
2217 * @return LY_ENOTFOUND if not found, @p match set to NULL.
2218 * @return LY_ERR value if another error occurred.
2219 */
2220LY_ERR lyd_find_sibling_first(const struct lyd_node *siblings, const struct lyd_node *target, struct lyd_node **match);
2221
2222/**
Michal Vaskoe444f752020-02-10 12:20:06 +01002223 * @brief Search in the given siblings for the first schema instance.
2224 * Uses hashes - should be used whenever possible for best performance.
2225 *
2226 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
2227 * @param[in] schema Schema node of the data node to find.
Michal Vaskob104f112020-07-17 09:54:54 +02002228 * @param[in] key_or_value If it is NULL, the first schema node data instance is found. For nodes with many
2229 * instances, it can be set based on the type of @p schema:
Michal Vaskoe444f752020-02-10 12:20:06 +01002230 * LYS_LEAFLIST:
2231 * Searched instance value.
2232 * LYS_LIST:
Michal Vasko90932a92020-02-12 14:33:03 +01002233 * Searched instance key values in the form of "[key1='val1'][key2='val2']...".
2234 * The keys do not have to be ordered but all of them must be set.
2235 *
2236 * Note that any explicit values (leaf-list or list key values) will be canonized first
2237 * before comparison. But values that do not have a canonical value are expected to be in the
2238 * JSON format!
Michal Vaskof03ed032020-03-04 13:31:44 +01002239 * @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 +01002240 * @param[out] match Can be NULL, otherwise the found data node.
Michal Vaskoe444f752020-02-10 12:20:06 +01002241 * @return LY_SUCCESS on success, @p match set.
2242 * @return LY_ENOTFOUND if not found, @p match set to NULL.
2243 * @return LY_EINVAL if @p schema is a key-less list.
2244 * @return LY_ERR value if another error occurred.
2245 */
2246LY_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 +02002247 size_t val_len, struct lyd_node **match);
Michal Vaskoe444f752020-02-10 12:20:06 +01002248
Michal Vaskoccc02342020-05-21 10:09:21 +02002249/**
Michal Vaskoe78faec2021-04-08 17:24:43 +02002250 * @brief Search the given siblings for all the exact same instances of a specific node instance. Accepts only nodes
2251 * that are allowed to have several exact same instances. Uses hashes to whatever extent possible.
2252 *
2253 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
2254 * @param[in] target Target node instance to find.
2255 * @param[out] set Set with all the found instances. The first item is always the first instance.
2256 * @return LY_SUCCESS on success, @p set returned.
2257 * @return LY_ENOTFOUND if not found, empty @p set returned.
2258 * @return LY_ERR value if another error occurred.
2259 */
2260LY_ERR lyd_find_sibling_dup_inst_set(const struct lyd_node *siblings, const struct lyd_node *target, struct ly_set **set);
2261
2262/**
Michal Vasko1d4af6c2021-02-22 13:31:26 +01002263 * @brief Search the given siblings for an opaque node with a specific name.
2264 *
2265 * @param[in] first First sibling to consider.
2266 * @param[in] name Opaque node name to find.
2267 * @param[out] match Can be NULL, otherwise the found data node.
2268 * @return LY_SUCCESS on success, @p match set.
2269 * @return LY_ENOTFOUND if not found, @p match set to NULL.
2270 * @return LY_ERR value is an error occurred.
2271 */
2272LY_ERR lyd_find_sibling_opaq_next(const struct lyd_node *first, const char *name, struct lyd_node **match);
2273
2274/**
Michal Vaskoccc02342020-05-21 10:09:21 +02002275 * @brief Search in the given data for instances of nodes matching the provided XPath.
2276 *
Michal Vasko19a30602020-05-25 10:40:19 +02002277 * If a list instance is being selected with all its key values specified (but not necessarily ordered)
2278 * in the form `list[key1='val1'][key2='val2'][key3='val3']` or a leaf-list instance in the form
2279 * `leaf-list[.='val']`, these instances are found using hashes with constant (*O(1)*) complexity
2280 * (unless they are defined in top-level). Other predicates can still follow the aforementioned ones.
2281 *
Michal Vaskoccc02342020-05-21 10:09:21 +02002282 * @param[in] ctx_node XPath context node.
Michal Vasko3e1f6552021-01-14 09:27:55 +01002283 * @param[in] xpath [XPath](@ref howtoXPath) to select.
Michal Vaskoccc02342020-05-21 10:09:21 +02002284 * @param[out] set Set of found data nodes. In case the result is a number, a string, or a boolean,
2285 * the returned set is empty.
2286 * @return LY_SUCCESS on success, @p set is returned.
2287 * @return LY_ERR value if an error occurred.
2288 */
2289LY_ERR lyd_find_xpath(const struct lyd_node *ctx_node, const char *xpath, struct ly_set **set);
2290
Michal Vasko3e1f6552021-01-14 09:27:55 +01002291/**
Michal Vaskoc84c9962021-05-18 16:16:29 +02002292 * @brief Search in given data for a node uniquely identified by a path.
Michal Vasko3e1f6552021-01-14 09:27:55 +01002293 *
Michal Vasko257bdcf2021-01-14 13:15:30 +01002294 * Always works in constant (*O(1)*) complexity. To be exact, it is *O(n)* where *n* is the depth
2295 * of the path used.
2296 *
Michal Vasko3e1f6552021-01-14 09:27:55 +01002297 * @param[in] ctx_node Path context node.
2298 * @param[in] path [Path](@ref howtoXPath) to find.
2299 * @param[in] output Whether to search in RPC/action output nodes or in input nodes.
2300 * @param[out] match Can be NULL, otherwise the found data node.
2301 * @return LY_SUCCESS on success, @p match is set to the found node.
2302 * @return LY_EINCOMPLETE if only a parent of the node was found, @p match is set to this parent node.
2303 * @return LY_ENOTFOUND if no nodes in the path were found.
2304 * @return LY_ERR on other errors.
2305 */
2306LY_ERR lyd_find_path(const struct lyd_node *ctx_node, const char *path, ly_bool output, struct lyd_node **match);
2307
Michal Vasko43297a02021-05-19 11:12:37 +02002308/**
Michal Vaskobb22b182021-06-14 08:14:21 +02002309 * @brief Find the target node of a compiled path (::lyd_value instance-identifier).
2310 *
2311 * @param[in] path Compiled path structure.
2312 * @param[in] tree Data tree to be searched.
2313 * @param[out] match Can be NULL, otherwise the found data node.
2314 * @return LY_SUCCESS on success, @p match is set to the found node.
2315 * @return LY_ENOTFOUND if no match was found.
2316 * @return LY_ERR on other errors.
2317 */
2318LY_ERR lyd_find_target(const struct ly_path *path, const struct lyd_node *tree, struct lyd_node **match);
2319
2320/**
Michal Vasko43297a02021-05-19 11:12:37 +02002321 * @brief Convert date-and-time from string to UNIX timestamp and fractions of a second.
2322 *
2323 * @param[in] value Valid string date-and-time value.
2324 * @param[out] time UNIX timestamp.
2325 * @param[out] fractions_s Optional fractions of a second, set to NULL if none.
2326 * @return LY_ERR value.
2327 */
2328LY_ERR ly_time_str2time(const char *value, time_t *time, char **fractions_s);
2329
2330/**
2331 * @brief Convert UNIX timestamp and fractions of a second into canonical date-and-time string value.
2332 *
2333 * @param[in] time UNIX timestamp.
2334 * @param[in] fractions_s Fractions of a second, if any.
Michal Vaskoc515a2b2021-05-19 11:55:00 +02002335 * @param[out] str String date-and-time value in the local timezone.
Michal Vasko43297a02021-05-19 11:12:37 +02002336 * @return LY_ERR value.
2337 */
2338LY_ERR ly_time_time2str(time_t time, const char *fractions_s, char **str);
2339
2340/**
2341 * @brief Convert date-and-time from string to timespec.
2342 *
2343 * @param[in] value Valid string date-and-time value.
2344 * @param[out] ts Timespec.
2345 * @return LY_ERR value.
2346 */
2347LY_ERR ly_time_str2ts(const char *value, struct timespec *ts);
2348
2349/**
2350 * @brief Convert timespec into date-and-time string value.
2351 *
2352 * @param[in] ts Timespec.
Michal Vaskoc515a2b2021-05-19 11:55:00 +02002353 * @param[out] str String date-and-time value in the local timezone.
Michal Vasko43297a02021-05-19 11:12:37 +02002354 * @return LY_ERR value.
2355 */
2356LY_ERR ly_time_ts2str(const struct timespec *ts, char **str);
2357
Radek Krejcie7b95092019-05-15 11:03:07 +02002358#ifdef __cplusplus
2359}
2360#endif
2361
2362#endif /* LY_TREE_DATA_H_ */