blob: 40bc56297ea1b62ba15b1d15bf7441aad51cc5a2 [file] [log] [blame]
Radek Krejcie7b95092019-05-15 11:03:07 +02001/**
2 * @file tree_data_internal.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
Michal Vaskodbf3e652022-10-21 08:46:25 +02004 * @author Michal Vasko <mvasko@cesnet.cz>
Radek Krejcie7b95092019-05-15 11:03:07 +02005 * @brief internal functions for YANG schema trees.
6 *
Michal Vasko271d2e32023-01-31 15:43:19 +01007 * Copyright (c) 2015 - 2023 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_INTERNAL_H_
17#define LY_TREE_DATA_INTERNAL_H_
18
Radek Krejci857189e2020-09-01 13:26:36 +020019#include "log.h"
Radek Krejciaca74032019-06-04 08:53:06 +020020#include "plugins_types.h"
Michal Vasko60ea6352020-06-29 13:39:39 +020021#include "tree_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020022
Michal Vasko52927e22020-03-16 17:26:14 +010023#include <stddef.h>
24
Michal Vasko004d3152020-06-11 19:59:22 +020025struct ly_path_predicate;
Michal Vasko8cc3f662022-03-29 11:25:51 +020026struct lyd_ctx;
Michal Vaskoa6669ba2020-08-06 16:14:26 +020027struct lysc_module;
Michal Vasko004d3152020-06-11 19:59:22 +020028
Radek Krejcif13b87b2020-12-01 22:02:17 +010029#define LY_XML_SUFFIX ".xml"
30#define LY_XML_SUFFIX_LEN 4
31#define LY_JSON_SUFFIX ".json"
32#define LY_JSON_SUFFIX_LEN 5
33#define LY_LYB_SUFFIX ".lyb"
34#define LY_LYB_SUFFIX_LEN 4
35
Radek Krejcie7b95092019-05-15 11:03:07 +020036/**
Michal Vasko271d2e32023-01-31 15:43:19 +010037 * @brief Internal item structure for remembering "used" instances of duplicate node instances.
Michal Vaskod7c048c2021-05-18 16:12:55 +020038 */
39struct lyd_dup_inst {
Michal Vasko271d2e32023-01-31 15:43:19 +010040 struct ly_set *set;
Michal Vaskod7c048c2021-05-18 16:12:55 +020041 uint32_t used;
42};
43
44/**
Michal Vasko271d2e32023-01-31 15:43:19 +010045 * @brief Update a found inst using a duplicate instance cache hash table. Needs to be called for every "used"
Michal Vaskod7c048c2021-05-18 16:12:55 +020046 * (that should not be considered next time) instance.
47 *
48 * @param[in,out] inst Found instance, is updated so that the same instance is not returned twice.
49 * @param[in] siblings Siblings where @p inst was found.
Michal Vasko271d2e32023-01-31 15:43:19 +010050 * @param[in] dup_inst_ht Duplicate instance cache hash table.
Michal Vaskod7c048c2021-05-18 16:12:55 +020051 * @return LY_ERR value.
52 */
53LY_ERR lyd_dup_inst_next(struct lyd_node **inst, const struct lyd_node *siblings,
Michal Vasko271d2e32023-01-31 15:43:19 +010054 struct hash_table **dup_inst_ht);
Michal Vaskod7c048c2021-05-18 16:12:55 +020055
56/**
57 * @brief Free duplicate instance cache.
58 *
Michal Vasko271d2e32023-01-31 15:43:19 +010059 * @param[in] dup_inst Duplicate instance cache hash table to free.
Michal Vaskod7c048c2021-05-18 16:12:55 +020060 */
Michal Vasko271d2e32023-01-31 15:43:19 +010061void lyd_dup_inst_free(struct hash_table *dup_inst_ht);
Michal Vaskod7c048c2021-05-18 16:12:55 +020062
63/**
Radek Krejci8678fa42020-08-18 16:07:28 +020064 * @brief Just like ::lys_getnext() but iterates over all data instances of the schema nodes.
Michal Vaskoa6669ba2020-08-06 16:14:26 +020065 *
66 * @param[in] last Last returned data node.
67 * @param[in] sibling Data node sibling to search in.
68 * @param[in,out] slast Schema last node, set to NULL for first call and do not change afterwards.
69 * May not be set if the function is used only for any suitable node existence check (such as the existence
70 * of any choice case data).
71 * @param[in] parent Schema parent of the iterated children nodes.
72 * @param[in] module Schema module of the iterated top-level nodes.
73 * @return Next matching data node,
74 * @return NULL if last data node was already returned.
75 */
76struct lyd_node *lys_getnext_data(const struct lyd_node *last, const struct lyd_node *sibling,
Michal Vasko106f0862021-11-02 11:49:27 +010077 const struct lysc_node **slast, const struct lysc_node *parent, const struct lysc_module *module);
78
79/**
80 * @brief Get address of a node's child pointer if any.
81 *
82 * @param[in] node Node to check.
83 * @return Address of the node's child member,
84 * @return NULL if there is no child pointer.
85 */
86struct lyd_node **lyd_node_child_p(struct lyd_node *node);
87
88/**
89 * @brief Update node pointer to point to the first data node of a module, leave unchanged if there is none.
90 *
91 * @param[in,out] node Node pointer, may be updated.
92 * @param[in] mod Module whose data to search for.
93 */
94void lyd_first_module_sibling(struct lyd_node **node, const struct lys_module *mod);
95
96/**
97 * @brief Iterate over implemented modules for functions that accept specific modules or the whole context.
98 *
99 * @param[in] tree Data tree.
100 * @param[in] module Selected module, NULL for all.
101 * @param[in] ctx Context, NULL for selected modules.
102 * @param[in,out] i Iterator, set to 0 on first call.
103 * @param[out] first First sibling of the returned module.
104 * @return Next module.
105 * @return NULL if all modules were traversed.
106 */
107const struct lys_module *lyd_mod_next_module(struct lyd_node *tree, const struct lys_module *module,
108 const struct ly_ctx *ctx, uint32_t *i, struct lyd_node **first);
109
110/**
111 * @brief Iterate over modules for functions that want to traverse all the top-level data.
112 *
113 * @param[in,out] next Pointer to the next module data, set to first top-level sibling on first call.
114 * @param[out] first First sibling of the returned module.
115 * @return Next module.
116 * @return NULL if all modules were traversed.
117 */
118const struct lys_module *lyd_data_next_module(struct lyd_node **next, struct lyd_node **first);
119
120/**
Michal Vasko106f0862021-11-02 11:49:27 +0100121 * @brief Get schema node of a data node. Useful especially for opaque nodes.
122 *
123 * @param[in] node Data node to use.
124 * @return Schema node represented by data @p node, NULL if there is none.
125 */
126const struct lysc_node *lyd_node_schema(const struct lyd_node *node);
127
128/**
Michal Vasko4754d4a2022-12-01 10:11:21 +0100129 * @brief Set dflt flag for a NP container if applicable, recursively for parents.
130 *
131 * @param[in] node Node whose criteria for the dflt flag has changed.
132 */
133void lyd_cont_set_dflt(struct lyd_node *node);
134
135/**
Michal Vasko59892dd2022-05-13 11:02:30 +0200136 * @brief Search in the given siblings (NOT recursively) for the first schema node data instance.
137 * Uses hashes - should be used whenever possible for best performance.
138 *
139 * @param[in] siblings Siblings to search in including preceding and succeeding nodes.
140 * @param[in] schema Target data node schema to find.
141 * @param[out] match Can be NULL, otherwise the found data node.
142 * @return LY_SUCCESS on success, @p match set.
143 * @return LY_ENOTFOUND if not found, @p match set to NULL.
144 * @return LY_ERR value if another error occurred.
145 */
146LY_ERR lyd_find_sibling_schema(const struct lyd_node *siblings, const struct lysc_node *schema, struct lyd_node **match);
147
148/**
Michal Vasko106f0862021-11-02 11:49:27 +0100149 * @brief Check whether a node to be deleted is the root node, move it if it is.
150 *
151 * @param[in] root Root sibling.
152 * @param[in] to_del Node to be deleted.
153 * @param[in] mod If set, it is expected @p tree should point to the first node of @p mod. Otherwise it will simply be
154 * the first top-level sibling.
155 */
156void lyd_del_move_root(struct lyd_node **root, const struct lyd_node *to_del, const struct lys_module *mod);
157
158/**
Michal Vasko8cc3f662022-03-29 11:25:51 +0200159 * @brief Try to get schema node for data with a parent based on an extension instance.
160 *
161 * @param[in] parent Parsed parent data node. Set if @p sparent is NULL.
162 * @param[in] sparent Schema parent node. Set if @p sparent is NULL.
163 * @param[in] prefix Element prefix, if any.
164 * @param[in] prefix_len Length of @p prefix.
165 * @param[in] format Format of @p prefix.
166 * @param[in] prefix_data Format-specific data.
167 * @param[in] name Element name.
168 * @param[in] name_len Length of @p name.
169 * @param[out] snode Found schema node, NULL if no suitable was found.
Michal Vasko66330fc2022-11-21 15:52:24 +0100170 * @param[out] ext Optional extension instance that provided @p snode.
Michal Vasko8cc3f662022-03-29 11:25:51 +0200171 * @return LY_SUCCESS on success;
172 * @return LY_ENOT if no extension instance parsed the data;
173 * @return LY_ERR on error.
174 */
175LY_ERR ly_nested_ext_schema(const struct lyd_node *parent, const struct lysc_node *sparent, const char *prefix,
176 size_t prefix_len, LY_VALUE_FORMAT format, void *prefix_data, const char *name, size_t name_len,
177 const struct lysc_node **snode, struct lysc_ext_instance **ext);
178
179/**
Michal Vasko106f0862021-11-02 11:49:27 +0100180 * @brief Free stored prefix data.
181 *
182 * @param[in] format Format of the prefixes.
183 * @param[in] prefix_data Format-specific data to free:
184 * LY_PREF_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
185 * LY_PREF_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
186 * LY_PREF_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
187 * LY_PREF_JSON - NULL
188 */
189void ly_free_prefix_data(LY_VALUE_FORMAT format, void *prefix_data);
190
191/**
192 * @brief Duplicate prefix data.
193 *
194 * @param[in] ctx libyang context.
195 * @param[in] format Format of the prefixes in the value.
196 * @param[in] prefix_data Prefix data to duplicate.
197 * @param[out] prefix_data_p Duplicated prefix data.
198 * @return LY_ERR value.
199 */
200LY_ERR ly_dup_prefix_data(const struct ly_ctx *ctx, LY_VALUE_FORMAT format, const void *prefix_data, void **prefix_data_p);
201
202/**
203 * @brief Store used prefixes in a string.
204 *
205 * If @p prefix_data_p are non-NULL, they are treated as valid according to the @p format_p and new possible
206 * prefixes are simply added. This way it is possible to store prefix data for several strings together.
207 *
208 * @param[in] ctx libyang context.
209 * @param[in] value Value to be parsed.
210 * @param[in] value_len Length of the @p value.
211 * @param[in] format Format of the prefixes in the value.
212 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
213 * @param[in,out] format_p Resulting format of the prefixes.
214 * @param[in,out] prefix_data_p Resulting prefix data for the value in format @p format_p.
215 * @return LY_ERR value.
216 */
217LY_ERR ly_store_prefix_data(const struct ly_ctx *ctx, const void *value, size_t value_len, LY_VALUE_FORMAT format,
218 const void *prefix_data, LY_VALUE_FORMAT *format_p, void **prefix_data_p);
219
220/**
221 * @brief Get string name of the format.
222 *
223 * @param[in] format Format whose name to get.
224 * @return Format string name.
225 */
226const char *ly_format2str(LY_VALUE_FORMAT format);
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200227
228/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100229 * @brief Create a term (leaf/leaf-list) node from a string value.
230 *
231 * Hash is calculated and new node flag is set.
Michal Vasko90932a92020-02-12 14:33:03 +0100232 *
233 * @param[in] schema Schema node of the new data node.
234 * @param[in] value String value to be parsed.
Michal Vaskof03ed032020-03-04 13:31:44 +0100235 * @param[in] value_len Length of @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100236 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
Michal Vasko90932a92020-02-12 14:33:03 +0100237 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200238 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200239 * @param[in] hints [Value hints](@ref lydvalhints) from the parser regarding the value type.
240 * @param[out] incomplete Whether the value needs to be resolved.
Michal Vasko90932a92020-02-12 14:33:03 +0100241 * @param[out] node Created node.
242 * @return LY_SUCCESS on success.
243 * @return LY_EINCOMPLETE in case data tree is needed to finish the validation.
244 * @return LY_ERR value if an error occurred.
245 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200246LY_ERR lyd_create_term(const struct lysc_node *schema, const char *value, size_t value_len, ly_bool *dynamic,
Radek Krejci8df109d2021-04-23 12:19:08 +0200247 LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints, ly_bool *incomplete, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100248
249/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100250 * @brief Create a term (leaf/leaf-list) node from a parsed value by duplicating it.
251 *
252 * Hash is calculated and new node flag is set.
253 *
254 * @param[in] schema Schema node of the new data node.
255 * @param[in] val Parsed value to use.
256 * @param[out] node Created node.
257 * @return LY_SUCCESS on success.
258 * @return LY_ERR value if an error occurred.
259 */
260LY_ERR lyd_create_term2(const struct lysc_node *schema, const struct lyd_value *val, struct lyd_node **node);
261
262/**
263 * @brief Create an inner (container/list/RPC/action/notification) node.
264 *
265 * Hash is calculated and new node flag is set except
266 * for list with keys, when the hash is not calculated!
267 * Also, non-presence container has its default flag set.
Michal Vasko90932a92020-02-12 14:33:03 +0100268 *
269 * @param[in] schema Schema node of the new data node.
270 * @param[out] node Created node.
271 * @return LY_SUCCESS on success.
272 * @return LY_ERR value if an error occurred.
273 */
274LY_ERR lyd_create_inner(const struct lysc_node *schema, struct lyd_node **node);
275
276/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100277 * @brief Create a list with all its keys (cannot be used for key-less list).
278 *
279 * Hash is calculated and new node flag is set.
Michal Vasko90932a92020-02-12 14:33:03 +0100280 *
281 * @param[in] schema Schema node of the new data node.
Michal Vasko004d3152020-06-11 19:59:22 +0200282 * @param[in] predicates Compiled key list predicates.
Michal Vasko90189962023-02-28 12:10:34 +0100283 * @param[in] vars Array of defined variables to use in predicates, may be NULL.
Michal Vasko90932a92020-02-12 14:33:03 +0100284 * @param[out] node Created node.
285 * @return LY_SUCCESS on success.
286 * @return LY_ERR value if an error occurred.
287 */
Michal Vasko90189962023-02-28 12:10:34 +0100288LY_ERR lyd_create_list(const struct lysc_node *schema, const struct ly_path_predicate *predicates,
289 const struct lyxp_var *vars, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100290
291/**
Michal Vasko59892dd2022-05-13 11:02:30 +0200292 * @brief Create a list with all its keys (cannot be used for key-less list).
293 *
294 * Hash is calculated and new node flag is set.
295 *
296 * @param[in] schema Schema node of the new data node.
297 * @param[in] keys Key list predicates.
298 * @param[in] keys_len Length of @p keys.
299 * @param[out] node Created node.
300 * @return LY_SUCCESS on success.
301 * @return LY_ERR value if an error occurred.
302 */
303LY_ERR lyd_create_list2(const struct lysc_node *schema, const char *keys, size_t keys_len, struct lyd_node **node);
304
305/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100306 * @brief Create an anyxml/anydata node.
307 *
308 * Hash is calculated and flags are properly set based on @p is_valid.
Michal Vasko90932a92020-02-12 14:33:03 +0100309 *
310 * @param[in] schema Schema node of the new data node.
Michal Vasko366a4a12020-12-04 16:23:57 +0100311 * @param[in] value Value of the any node.
Michal Vasko90932a92020-02-12 14:33:03 +0100312 * @param[in] value_type Value type of the value.
Michal Vasko742a5b12022-02-24 16:07:27 +0100313 * @param[in] use_value Whether to use dynamic @p value or duplicate it.
Michal Vasko90932a92020-02-12 14:33:03 +0100314 * @param[out] node Created node.
315 * @return LY_SUCCESS on success.
316 * @return LY_ERR value if an error occurred.
317 */
Michal Vasko9b368d32020-02-14 13:53:31 +0100318LY_ERR lyd_create_any(const struct lysc_node *schema, const void *value, LYD_ANYDATA_VALUETYPE value_type,
Michal Vasko366a4a12020-12-04 16:23:57 +0100319 ly_bool use_value, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100320
321/**
Michal Vasko52927e22020-03-16 17:26:14 +0100322 * @brief Create an opaque node.
323 *
324 * @param[in] ctx libyang context.
325 * @param[in] name Element name.
326 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko52927e22020-03-16 17:26:14 +0100327 * @param[in] prefix Element prefix.
328 * @param[in] pref_len Length of @p prefix, must be set correctly.
Radek Krejci1798aae2020-07-14 13:26:06 +0200329 * @param[in] module_key Mandatory key to reference module, can be namespace or name.
330 * @param[in] module_key_len Length of @p module_key, must be set correctly.
Michal Vasko501af032020-11-11 20:27:44 +0100331 * @param[in] value String value to be parsed.
332 * @param[in] value_len Length of @p value, must be set correctly.
333 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
334 * @param[in] format Input format of @p value and @p ns.
Radek Krejciec9ad602021-01-04 10:46:30 +0100335 * @param[in] val_prefix_data Format-specific prefix data, param is spent (even in case the function fails):
336 * LY_PREF_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
337 * LY_PREF_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
338 * LY_PREF_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
339 * LY_PREF_JSON - NULL
Michal Vasko501af032020-11-11 20:27:44 +0100340 * @param[in] hints [Hints](@ref lydhints) from the parser regarding the node/value type.
Michal Vasko52927e22020-03-16 17:26:14 +0100341 * @param[out] node Created node.
342 * @return LY_SUCCESS on success.
343 * @return LY_ERR value if an error occurred.
344 */
Michal Vasko501af032020-11-11 20:27:44 +0100345LY_ERR lyd_create_opaq(const struct ly_ctx *ctx, const char *name, size_t name_len, const char *prefix, size_t pref_len,
346 const char *module_key, size_t module_key_len, const char *value, size_t value_len, ly_bool *dynamic,
Radek Krejci8df109d2021-04-23 12:19:08 +0200347 LY_VALUE_FORMAT format, void *val_prefix_data, uint32_t hints, struct lyd_node **node);
Michal Vasko52927e22020-03-16 17:26:14 +0100348
349/**
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200350 * @brief Check the existence and create any non-existing implicit siblings, recursively for the created nodes.
351 *
352 * @param[in] parent Parent of the potential default values, NULL for top-level siblings.
353 * @param[in,out] first First sibling.
354 * @param[in] sparent Schema parent of the siblings, NULL if schema of @p parent can be used.
355 * @param[in] mod Module of the default values, NULL for nested siblings.
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200356 * @param[in] node_when Optional set to add nodes with "when" conditions into.
Michal Vaskoc43c8ab2021-03-05 13:32:44 +0100357 * @param[in] node_types Optional set to add nodes with unresolved types into.
Michal Vaskofcbd78f2022-08-26 08:34:15 +0200358 * @param[in] ext_node Optional set to add nodes with extension instance node callbacks into.
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200359 * @param[in] impl_opts Implicit options (@ref implicitoptions).
360 * @param[in,out] diff Validation diff.
361 * @return LY_ERR value.
362 */
363LY_ERR lyd_new_implicit_r(struct lyd_node *parent, struct lyd_node **first, const struct lysc_node *sparent,
Michal Vaskofcbd78f2022-08-26 08:34:15 +0200364 const struct lys_module *mod, struct ly_set *node_when, struct ly_set *node_types, struct ly_set *ext_node,
365 uint32_t impl_opts, struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200366
367/**
Michal Vaskob104f112020-07-17 09:54:54 +0200368 * @brief Find the next node, before which to insert the new node.
Michal Vasko90932a92020-02-12 14:33:03 +0100369 *
Michal Vaskob104f112020-07-17 09:54:54 +0200370 * @param[in] first_sibling First sibling of the nodes to consider.
371 * @param[in] new_node Node that will be inserted.
372 * @return Node to insert after.
373 * @return NULL if the new node should be first.
Michal Vasko90932a92020-02-12 14:33:03 +0100374 */
Michal Vaskob104f112020-07-17 09:54:54 +0200375struct lyd_node *lyd_insert_get_next_anchor(const struct lyd_node *first_sibling, const struct lyd_node *new_node);
Michal Vasko90932a92020-02-12 14:33:03 +0100376
377/**
Michal Vaskoc61dd062022-06-07 11:01:28 +0200378 * @brief Insert node after a sibling.
379 *
380 * Handles inserting into NP containers and key-less lists.
381 *
382 * @param[in] sibling Sibling to insert after.
383 * @param[in] node Node to insert.
384 */
385void lyd_insert_after_node(struct lyd_node *sibling, struct lyd_node *node);
386
387/**
388 * @brief Insert node before a sibling.
389 *
390 * Handles inserting into NP containers and key-less lists.
391 *
392 * @param[in] sibling Sibling to insert before.
393 * @param[in] node Node to insert.
394 */
395void lyd_insert_before_node(struct lyd_node *sibling, struct lyd_node *node);
396
397/**
Michal Vaskob104f112020-07-17 09:54:54 +0200398 * @brief Insert a node into parent/siblings. Order and hashes are fully handled.
Michal Vasko90932a92020-02-12 14:33:03 +0100399 *
Michal Vasko9b368d32020-02-14 13:53:31 +0100400 * @param[in] parent Parent to insert into, NULL for top-level sibling.
401 * @param[in,out] first_sibling First sibling, NULL if no top-level sibling exist yet. Can be also NULL if @p parent is set.
Michal Vasko90932a92020-02-12 14:33:03 +0100402 * @param[in] node Individual node (without siblings) to insert.
Michal Vasko6ee6f432021-07-16 09:49:14 +0200403 * @param[in] last If set, do not search for the correct anchor but always insert at the end.
Michal Vasko90932a92020-02-12 14:33:03 +0100404 */
Michal Vasko6ee6f432021-07-16 09:49:14 +0200405void lyd_insert_node(struct lyd_node *parent, struct lyd_node **first_sibling, struct lyd_node *node, ly_bool last);
Michal Vasko90932a92020-02-12 14:33:03 +0100406
407/**
Michal Vaskoa5da3292020-08-12 13:10:50 +0200408 * @brief Insert a metadata (last) into a parent
409 *
410 * @param[in] parent Parent of the metadata.
411 * @param[in] meta Metadata (list) to be added into the @p parent.
Michal Vasko871a0252020-11-11 18:35:24 +0100412 * @param[in] clear_dflt Whether to clear dflt flag starting from @p parent, recursively all NP containers.
Michal Vaskoa5da3292020-08-12 13:10:50 +0200413 */
Michal Vasko871a0252020-11-11 18:35:24 +0100414void lyd_insert_meta(struct lyd_node *parent, struct lyd_meta *meta, ly_bool clear_dflt);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200415
416/**
Michal Vasko52927e22020-03-16 17:26:14 +0100417 * @brief Create and insert a metadata (last) into a parent.
Michal Vasko90932a92020-02-12 14:33:03 +0100418 *
Michal Vasko52927e22020-03-16 17:26:14 +0100419 * @param[in] parent Parent of the metadata, can be NULL.
Michal Vasko9f96a052020-03-10 09:41:45 +0100420 * @param[in,out] meta Metadata list to add at its end if @p parent is NULL, returned created attribute.
421 * @param[in] mod Metadata module (with the annotation definition).
Michal Vasko90932a92020-02-12 14:33:03 +0100422 * @param[in] name Attribute name.
Michal Vaskof03ed032020-03-04 13:31:44 +0100423 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100424 * @param[in] value String value to be parsed.
Michal Vaskof03ed032020-03-04 13:31:44 +0100425 * @param[in] value_len Length of @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100426 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
Michal Vasko90932a92020-02-12 14:33:03 +0100427 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200428 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200429 * @param[in] hints [Value hints](@ref lydvalhints) from the parser regarding the value type.
Michal Vaskoddd76592022-01-17 13:34:48 +0100430 * @param[in] ctx_node Value context node, may be NULL for metadata.
Michal Vasko871a0252020-11-11 18:35:24 +0100431 * @param[in] clear_dflt Whether to clear dflt flag starting from @p parent, recursively all NP containers.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200432 * @param[out] incomplete Whether the value needs to be resolved.
Michal Vasko90932a92020-02-12 14:33:03 +0100433 * @return LY_SUCCESS on success.
434 * @return LY_EINCOMPLETE in case data tree is needed to finish the validation.
435 * @return LY_ERR value if an error occurred.
436 */
Michal Vasko9f96a052020-03-10 09:41:45 +0100437LY_ERR lyd_create_meta(struct lyd_node *parent, struct lyd_meta **meta, const struct lys_module *mod, const char *name,
Radek Krejci8df109d2021-04-23 12:19:08 +0200438 size_t name_len, const char *value, size_t value_len, ly_bool *dynamic, LY_VALUE_FORMAT format,
Michal Vaskoddd76592022-01-17 13:34:48 +0100439 void *prefix_data, uint32_t hints, const struct lysc_node *ctx_node, ly_bool clear_dflt, ly_bool *incomplete);
Radek Krejci1798aae2020-07-14 13:26:06 +0200440
441/**
Michal Vaskoa5da3292020-08-12 13:10:50 +0200442 * @brief Insert an attribute (last) into a parent
Radek Krejci1798aae2020-07-14 13:26:06 +0200443 *
Michal Vaskoa5da3292020-08-12 13:10:50 +0200444 * @param[in] parent Parent of the attributes.
445 * @param[in] attr Attribute (list) to be added into the @p parent.
Radek Krejci1798aae2020-07-14 13:26:06 +0200446 */
Michal Vaskoa5da3292020-08-12 13:10:50 +0200447void lyd_insert_attr(struct lyd_node *parent, struct lyd_attr *attr);
Michal Vasko90932a92020-02-12 14:33:03 +0100448
449/**
Michal Vasko52927e22020-03-16 17:26:14 +0100450 * @brief Create and insert a generic attribute (last) into a parent.
451 *
452 * @param[in] parent Parent of the attribute, can be NULL.
453 * @param[in,out] attr Attribute list to add at its end if @p parent is NULL, returned created attribute.
454 * @param[in] ctx libyang context.
455 * @param[in] name Attribute name.
456 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko52927e22020-03-16 17:26:14 +0100457 * @param[in] prefix Attribute prefix.
458 * @param[in] prefix_len Attribute prefix length.
Radek Krejci1798aae2020-07-14 13:26:06 +0200459 * @param[in] module_key Mandatory key to reference module, can be namespace or name.
460 * @param[in] module_key_len Length of @p module_key, must be set correctly.
Michal Vasko501af032020-11-11 20:27:44 +0100461 * @param[in] value String value to be parsed.
462 * @param[in] value_len Length of @p value, must be set correctly.
463 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
464 * @param[in] format Input format of @p value and @p ns.
465 * @param[in] val_prefix_data Format-specific prefix data, param is spent (even in case the function fails).
466 * @param[in] hints [Hints](@ref lydhints) from the parser regarding the node/value type.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200467 * @return LY_SUCCESS on success,
468 * @return LY_ERR value on error.
Michal Vasko52927e22020-03-16 17:26:14 +0100469 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200470LY_ERR lyd_create_attr(struct lyd_node *parent, struct lyd_attr **attr, const struct ly_ctx *ctx, const char *name,
Michal Vasko501af032020-11-11 20:27:44 +0100471 size_t name_len, const char *prefix, size_t prefix_len, const char *module_key, size_t module_key_len,
Radek Krejci8df109d2021-04-23 12:19:08 +0200472 const char *value, size_t value_len, ly_bool *dynamic, LY_VALUE_FORMAT format, void *val_prefix_data, uint32_t hints);
Radek Krejci1798aae2020-07-14 13:26:06 +0200473
474/**
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200475 * @brief Store and canonize the given @p value into @p val according to the schema node type rules.
Radek Krejci38d85362019-09-05 16:26:38 +0200476 *
Michal Vasko8d544252020-03-02 10:19:52 +0100477 * @param[in] ctx libyang context.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200478 * @param[in,out] val Storage for the value.
479 * @param[in] type Type of the value.
Radek Krejcif9943642021-04-26 10:18:21 +0200480 * @param[in] value Value to be parsed, must not be NULL.
Michal Vaskof03ed032020-03-04 13:31:44 +0100481 * @param[in] value_len Length of the give @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100482 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200483 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200484 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200485 * @param[in] hints [Value hints](@ref lydvalhints) from the parser.
486 * @param[in] ctx_node Context schema node.
487 * @param[out] incomplete Optional, set if the value also needs to be resolved.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200488 * @return LY_SUCCESS on success,
489 * @return LY_ERR value on error.
Radek Krejci38d85362019-09-05 16:26:38 +0200490 */
Radek Krejcif9943642021-04-26 10:18:21 +0200491LY_ERR lyd_value_store(const struct ly_ctx *ctx, struct lyd_value *val, const struct lysc_type *type, const void *value,
Radek Krejci8df109d2021-04-23 12:19:08 +0200492 size_t value_len, ly_bool *dynamic, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints,
Radek Krejci2efc45b2020-12-22 16:25:44 +0100493 const struct lysc_node *ctx_node, ly_bool *incomplete);
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200494
495/**
496 * @brief Validate previously incompletely stored value.
497 *
498 * @param[in] ctx libyang context.
499 * @param[in] type Schema type of the value (not the stored one, but the original one).
500 * @param[in,out] val Stored value to resolve.
501 * @param[in] ctx_node Context node for the resolution.
502 * @param[in] tree Data tree for the resolution.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200503 * @return LY_SUCCESS on success,
504 * @return LY_ERR value on error.
505 */
506LY_ERR lyd_value_validate_incomplete(const struct ly_ctx *ctx, const struct lysc_type *type, struct lyd_value *val,
Radek Krejci2efc45b2020-12-22 16:25:44 +0100507 const struct lyd_node *ctx_node, const struct lyd_node *tree);
Radek Krejci38d85362019-09-05 16:26:38 +0200508
Michal Vaskoaebbce02021-04-06 09:23:37 +0200509/**
510 * @brief Check type restrictions applicable to the particular leaf/leaf-list with the given string @p value coming
511 * from a schema.
512 *
513 * This function check just the type's restriction, if you want to check also the data tree context (e.g. in case of
514 * require-instance restriction), use ::lyd_value_validate().
515 *
516 * @param[in] ctx libyang context for logging (function does not log errors when @p ctx is NULL)
517 * @param[in] node Schema node for the @p value.
518 * @param[in] value String value to be checked, expected to be in JSON format.
519 * @param[in] value_len Length of the given @p value (mandatory).
520 * @param[in] format Value prefix format.
521 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
522 * @return LY_SUCCESS on success
523 * @return LY_ERR value if an error occurred.
524 */
525LY_ERR lys_value_validate(const struct ly_ctx *ctx, const struct lysc_node *node, const char *value, size_t value_len,
Radek Krejci8df109d2021-04-23 12:19:08 +0200526 LY_VALUE_FORMAT format, void *prefix_data);
Michal Vaskof937cfe2020-08-03 16:07:12 +0200527
Radek Krejci38d85362019-09-05 16:26:38 +0200528/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200529 * @defgroup datahash Data nodes hash manipulation
530 * @ingroup datatree
Michal Vasko8081a812021-07-15 09:19:43 +0200531 * @{
Radek Krejcie7b95092019-05-15 11:03:07 +0200532 */
533
534/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200535 * @brief Generate hash for the node.
536 *
537 * @param[in] node Data node to (re)generate hash value.
538 * @return LY_ERR value.
539 */
540LY_ERR lyd_hash(struct lyd_node *node);
541
542/**
543 * @brief Insert hash of the node into the hash table of its parent.
544 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200545 * @param[in] node Data node which hash will be inserted into the ::lyd_node_inner.children_ht hash table of its parent.
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200546 * @return LY_ERR value.
547 */
548LY_ERR lyd_insert_hash(struct lyd_node *node);
549
550/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200551 * @brief Maintain node's parent's children hash table when unlinking the node.
552 *
553 * When completely freeing data tree, it is expected to free the parent's children hash table first, at once.
554 *
555 * @param[in] node The data node being unlinked from its parent.
556 */
557void lyd_unlink_hash(struct lyd_node *node);
558
559/** @} datahash */
560
Radek Krejci084289f2019-07-09 17:35:30 +0200561/**
Michal Vaskod59035b2020-07-08 12:00:06 +0200562 * @brief Append all list key predicates to path.
563 *
564 * @param[in] node Node with keys to print.
565 * @param[in,out] buffer Buffer to print to.
566 * @param[in,out] buflen Current buffer length.
567 * @param[in,out] bufused Current number of characters used in @p buffer.
568 * @param[in] is_static Whether buffer is static or can be reallocated.
Michal Vaskodbf3e652022-10-21 08:46:25 +0200569 * @return LY_ERR value.
Michal Vaskod59035b2020-07-08 12:00:06 +0200570 */
Radek Krejci857189e2020-09-01 13:26:36 +0200571LY_ERR lyd_path_list_predicate(const struct lyd_node *node, char **buffer, size_t *buflen, size_t *bufused, ly_bool is_static);
Michal Vaskod59035b2020-07-08 12:00:06 +0200572
Michal Vasko413af592021-12-13 11:50:51 +0100573/**
Michal Vaskodbf3e652022-10-21 08:46:25 +0200574 * @brief Generate a path similar to ::lyd_path() except read the parents from a set.
575 *
576 * @param[in] dnodes Set with the data nodes, from parent to the last descendant.
577 * @param[in] pathtype Type of data path to generate.
578 * @return Generated data path.
579 */
580char *lyd_path_set(const struct ly_set *dnodes, LYD_PATH_TYPE pathtype);
581
582/**
Michal Vasko413af592021-12-13 11:50:51 +0100583 * @brief Remove an object on the specific set index keeping the order of the other objects.
584 *
585 * @param[in] set Set from which a node will be removed.
586 * @param[in] index Index of the object to remove in the \p set.
587 * @param[in] destructor Optional function to free the objects being removed.
Michal Vaskodbf3e652022-10-21 08:46:25 +0200588 * @return LY_ERR value.
Michal Vasko413af592021-12-13 11:50:51 +0100589 */
590LY_ERR ly_set_rm_index_ordered(struct ly_set *set, uint32_t index, void (*destructor)(void *obj));
591
Radek Krejcie7b95092019-05-15 11:03:07 +0200592#endif /* LY_TREE_DATA_INTERNAL_H_ */