blob: bb8e27a586c82ed5acee574b238135b90b3010ca [file] [log] [blame]
Radek Krejcie7b95092019-05-15 11:03:07 +02001/**
2 * @file tree_data_internal.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief internal functions for YANG schema trees.
5 *
Michal Vasko60ea6352020-06-29 13:39:39 +02006 * Copyright (c) 2015 - 2020 CESNET, z.s.p.o.
Radek Krejcie7b95092019-05-15 11:03:07 +02007 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_TREE_DATA_INTERNAL_H_
16#define LY_TREE_DATA_INTERNAL_H_
17
Radek Krejci857189e2020-09-01 13:26:36 +020018#include "log.h"
Michal Vasko60ea6352020-06-29 13:39:39 +020019#include "lyb.h"
Radek Krejciaca74032019-06-04 08:53:06 +020020#include "plugins_types.h"
Michal Vasko60ea6352020-06-29 13:39:39 +020021#include "set.h"
22#include "tree_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020023
Michal Vasko52927e22020-03-16 17:26:14 +010024#include <stddef.h>
25
Michal Vasko004d3152020-06-11 19:59:22 +020026struct ly_path_predicate;
Michal Vaskoa6669ba2020-08-06 16:14:26 +020027struct lysc_module;
Michal Vasko004d3152020-06-11 19:59:22 +020028
Radek Krejcie7b95092019-05-15 11:03:07 +020029/**
Michal Vasko60ea6352020-06-29 13:39:39 +020030 * @brief Internal data parser flags.
31 */
32#define LYD_INTOPT_RPC 0x01 /**< RPC/action invocation is being parsed */
33#define LYD_INTOPT_NOTIF 0x02 /**< notification is being parsed */
34#define LYD_INTOPT_REPLY 0x04 /**< RPC/action reply is being parsed */
35
36/**
37 * @brief Hash schema sibling to be used for LYB data.
38 *
39 * @param[in] sibling Sibling to hash.
40 * @param[in] collision_id Collision ID of the hash to generate.
41 * @return Generated hash.
42 */
43LYB_HASH lyb_hash(struct lysc_node *sibling, uint8_t collision_id);
44
45/**
Radek Krejci857189e2020-09-01 13:26:36 +020046 * @brief Check whether a sibling's module is in a module array.
Michal Vasko60ea6352020-06-29 13:39:39 +020047 *
48 * @param[in] sibling Sibling to check.
49 * @param[in] models Modules in a sized array.
50 * @return non-zero if the module was found,
Radek Krejci857189e2020-09-01 13:26:36 +020051 * @return Boolean value whether @p sibling's module found in the given @p models array.
Michal Vasko60ea6352020-06-29 13:39:39 +020052 */
Radek Krejci857189e2020-09-01 13:26:36 +020053ly_bool lyb_has_schema_model(const struct lysc_node *sibling, const struct lys_module **models);
Michal Vasko60ea6352020-06-29 13:39:39 +020054
55/**
Michal Vaskob1b5c262020-03-05 14:29:47 +010056 * @brief Check whether a node to be deleted is the first top-level sibling.
57 *
58 * @param[in] first First sibling.
59 * @param[in] to_del Node to be deleted.
60 */
61#define LYD_DEL_IS_ROOT(first, to_del) (((first) == (to_del)) && !(first)->parent && !(first)->prev->next)
62
63/**
Radek Krejcie7b95092019-05-15 11:03:07 +020064 * @brief Get address of a node's child pointer if any.
65 *
Radek Krejcie7b95092019-05-15 11:03:07 +020066 * @param[in] node Node to check.
Michal Vasko9b368d32020-02-14 13:53:31 +010067 * @return Address of the node's child member,
68 * @return NULL if there is no child pointer.
Radek Krejcie7b95092019-05-15 11:03:07 +020069 */
70struct lyd_node **lyd_node_children_p(struct lyd_node *node);
71
72/**
Radek Krejci8678fa42020-08-18 16:07:28 +020073 * @brief Just like ::lys_getnext() but iterates over all data instances of the schema nodes.
Michal Vaskoa6669ba2020-08-06 16:14:26 +020074 *
75 * @param[in] last Last returned data node.
76 * @param[in] sibling Data node sibling to search in.
77 * @param[in,out] slast Schema last node, set to NULL for first call and do not change afterwards.
78 * May not be set if the function is used only for any suitable node existence check (such as the existence
79 * of any choice case data).
80 * @param[in] parent Schema parent of the iterated children nodes.
81 * @param[in] module Schema module of the iterated top-level nodes.
82 * @return Next matching data node,
83 * @return NULL if last data node was already returned.
84 */
85struct lyd_node *lys_getnext_data(const struct lyd_node *last, const struct lyd_node *sibling,
Radek Krejci0f969882020-08-21 16:56:47 +020086 const struct lysc_node **slast, const struct lysc_node *parent,
87 const struct lysc_module *module);
Michal Vaskoa6669ba2020-08-06 16:14:26 +020088
89/**
Michal Vasko9b368d32020-02-14 13:53:31 +010090 * @brief Create a term (leaf/leaf-list) node from a string value.
91 *
92 * Hash is calculated and new node flag is set.
Michal Vasko90932a92020-02-12 14:33:03 +010093 *
94 * @param[in] schema Schema node of the new data node.
95 * @param[in] value String value to be parsed.
Michal Vaskof03ed032020-03-04 13:31:44 +010096 * @param[in] value_len Length of @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +010097 * @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 +010098 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +020099 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200100 * @param[in] hints [Value hints](@ref lydvalhints) from the parser regarding the value type.
101 * @param[out] incomplete Whether the value needs to be resolved.
Michal Vasko90932a92020-02-12 14:33:03 +0100102 * @param[out] node Created node.
103 * @return LY_SUCCESS on success.
104 * @return LY_EINCOMPLETE in case data tree is needed to finish the validation.
105 * @return LY_ERR value if an error occurred.
106 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200107LY_ERR lyd_create_term(const struct lysc_node *schema, const char *value, size_t value_len, ly_bool *dynamic,
108 LY_PREFIX_FORMAT format, void *prefix_data, uint32_t hints, ly_bool *incomplete, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100109
110/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100111 * @brief Create a term (leaf/leaf-list) node from a parsed value by duplicating it.
112 *
113 * Hash is calculated and new node flag is set.
114 *
115 * @param[in] schema Schema node of the new data node.
116 * @param[in] val Parsed value to use.
117 * @param[out] node Created node.
118 * @return LY_SUCCESS on success.
119 * @return LY_ERR value if an error occurred.
120 */
121LY_ERR lyd_create_term2(const struct lysc_node *schema, const struct lyd_value *val, struct lyd_node **node);
122
123/**
124 * @brief Create an inner (container/list/RPC/action/notification) node.
125 *
126 * Hash is calculated and new node flag is set except
127 * for list with keys, when the hash is not calculated!
128 * Also, non-presence container has its default flag set.
Michal Vasko90932a92020-02-12 14:33:03 +0100129 *
130 * @param[in] schema Schema node of the new data node.
131 * @param[out] node Created node.
132 * @return LY_SUCCESS on success.
133 * @return LY_ERR value if an error occurred.
134 */
135LY_ERR lyd_create_inner(const struct lysc_node *schema, struct lyd_node **node);
136
137/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100138 * @brief Create a list with all its keys (cannot be used for key-less list).
139 *
140 * Hash is calculated and new node flag is set.
Michal Vasko90932a92020-02-12 14:33:03 +0100141 *
142 * @param[in] schema Schema node of the new data node.
Michal Vasko004d3152020-06-11 19:59:22 +0200143 * @param[in] predicates Compiled key list predicates.
Michal Vasko90932a92020-02-12 14:33:03 +0100144 * @param[out] node Created node.
145 * @return LY_SUCCESS on success.
146 * @return LY_ERR value if an error occurred.
147 */
Michal Vasko004d3152020-06-11 19:59:22 +0200148LY_ERR lyd_create_list(const struct lysc_node *schema, const struct ly_path_predicate *predicates, struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100149
150/**
Michal Vasko9b368d32020-02-14 13:53:31 +0100151 * @brief Create an anyxml/anydata node.
152 *
153 * Hash is calculated and flags are properly set based on @p is_valid.
Michal Vasko90932a92020-02-12 14:33:03 +0100154 *
155 * @param[in] schema Schema node of the new data node.
156 * @param[in] value Value of the any node, is directly assigned into the data node.
157 * @param[in] value_type Value type of the value.
158 * @param[out] node Created node.
159 * @return LY_SUCCESS on success.
160 * @return LY_ERR value if an error occurred.
161 */
Michal Vasko9b368d32020-02-14 13:53:31 +0100162LY_ERR lyd_create_any(const struct lysc_node *schema, const void *value, LYD_ANYDATA_VALUETYPE value_type,
Radek Krejci0f969882020-08-21 16:56:47 +0200163 struct lyd_node **node);
Michal Vasko90932a92020-02-12 14:33:03 +0100164
165/**
Michal Vasko52927e22020-03-16 17:26:14 +0100166 * @brief Create an opaque node.
167 *
168 * @param[in] ctx libyang context.
169 * @param[in] name Element name.
170 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko52927e22020-03-16 17:26:14 +0100171 * @param[in] prefix Element prefix.
172 * @param[in] pref_len Length of @p prefix, must be set correctly.
Radek Krejci1798aae2020-07-14 13:26:06 +0200173 * @param[in] module_key Mandatory key to reference module, can be namespace or name.
174 * @param[in] module_key_len Length of @p module_key, must be set correctly.
Michal Vasko501af032020-11-11 20:27:44 +0100175 * @param[in] value String value to be parsed.
176 * @param[in] value_len Length of @p value, must be set correctly.
177 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
178 * @param[in] format Input format of @p value and @p ns.
179 * @param[in] val_prefix_data Format-specific prefix data, param is spent (even in case the function fails).
180 * @param[in] hints [Hints](@ref lydhints) from the parser regarding the node/value type.
Michal Vasko52927e22020-03-16 17:26:14 +0100181 * @param[out] node Created node.
182 * @return LY_SUCCESS on success.
183 * @return LY_ERR value if an error occurred.
184 */
Michal Vasko501af032020-11-11 20:27:44 +0100185LY_ERR lyd_create_opaq(const struct ly_ctx *ctx, const char *name, size_t name_len, const char *prefix, size_t pref_len,
186 const char *module_key, size_t module_key_len, const char *value, size_t value_len, ly_bool *dynamic,
187 LY_PREFIX_FORMAT format, void *val_prefix_data, uint32_t hints, struct lyd_node **node);
Michal Vasko52927e22020-03-16 17:26:14 +0100188
189/**
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200190 * @brief Check the existence and create any non-existing implicit siblings, recursively for the created nodes.
191 *
192 * @param[in] parent Parent of the potential default values, NULL for top-level siblings.
193 * @param[in,out] first First sibling.
194 * @param[in] sparent Schema parent of the siblings, NULL if schema of @p parent can be used.
195 * @param[in] mod Module of the default values, NULL for nested siblings.
196 * @param[in] node_types Optional set to add nodes with unresolved types into.
197 * @param[in] node_when Optional set to add nodes with "when" conditions into.
198 * @param[in] impl_opts Implicit options (@ref implicitoptions).
199 * @param[in,out] diff Validation diff.
200 * @return LY_ERR value.
201 */
202LY_ERR lyd_new_implicit_r(struct lyd_node *parent, struct lyd_node **first, const struct lysc_node *sparent,
Radek Krejci0f969882020-08-21 16:56:47 +0200203 const struct lys_module *mod, struct ly_set *node_types, struct ly_set *node_when,
Radek Krejci1deb5be2020-08-26 16:43:36 +0200204 uint32_t impl_opts, struct lyd_node **diff);
Michal Vaskoa6669ba2020-08-06 16:14:26 +0200205
206/**
Michal Vaskob104f112020-07-17 09:54:54 +0200207 * @brief Find the next node, before which to insert the new node.
Michal Vasko90932a92020-02-12 14:33:03 +0100208 *
Michal Vaskob104f112020-07-17 09:54:54 +0200209 * @param[in] first_sibling First sibling of the nodes to consider.
210 * @param[in] new_node Node that will be inserted.
211 * @return Node to insert after.
212 * @return NULL if the new node should be first.
Michal Vasko90932a92020-02-12 14:33:03 +0100213 */
Michal Vaskob104f112020-07-17 09:54:54 +0200214struct 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 +0100215
216/**
Michal Vaskob104f112020-07-17 09:54:54 +0200217 * @brief Insert a node into parent/siblings. Order and hashes are fully handled.
Michal Vasko90932a92020-02-12 14:33:03 +0100218 *
Michal Vasko9b368d32020-02-14 13:53:31 +0100219 * @param[in] parent Parent to insert into, NULL for top-level sibling.
220 * @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 +0100221 * @param[in] node Individual node (without siblings) to insert.
222 */
Michal Vasko9b368d32020-02-14 13:53:31 +0100223void lyd_insert_node(struct lyd_node *parent, struct lyd_node **first_sibling, struct lyd_node *node);
Michal Vasko90932a92020-02-12 14:33:03 +0100224
225/**
Michal Vaskoa5da3292020-08-12 13:10:50 +0200226 * @brief Insert a metadata (last) into a parent
227 *
228 * @param[in] parent Parent of the metadata.
229 * @param[in] meta Metadata (list) to be added into the @p parent.
Michal Vasko871a0252020-11-11 18:35:24 +0100230 * @param[in] clear_dflt Whether to clear dflt flag starting from @p parent, recursively all NP containers.
Michal Vaskoa5da3292020-08-12 13:10:50 +0200231 */
Michal Vasko871a0252020-11-11 18:35:24 +0100232void lyd_insert_meta(struct lyd_node *parent, struct lyd_meta *meta, ly_bool clear_dflt);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200233
234/**
Michal Vasko52927e22020-03-16 17:26:14 +0100235 * @brief Create and insert a metadata (last) into a parent.
Michal Vasko90932a92020-02-12 14:33:03 +0100236 *
Michal Vasko52927e22020-03-16 17:26:14 +0100237 * @param[in] parent Parent of the metadata, can be NULL.
Michal Vasko9f96a052020-03-10 09:41:45 +0100238 * @param[in,out] meta Metadata list to add at its end if @p parent is NULL, returned created attribute.
239 * @param[in] mod Metadata module (with the annotation definition).
Michal Vasko90932a92020-02-12 14:33:03 +0100240 * @param[in] name Attribute name.
Michal Vaskof03ed032020-03-04 13:31:44 +0100241 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100242 * @param[in] value String value to be parsed.
Michal Vaskof03ed032020-03-04 13:31:44 +0100243 * @param[in] value_len Length of @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100244 * @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 +0100245 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200246 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200247 * @param[in] hints [Value hints](@ref lydvalhints) from the parser regarding the value type.
Michal Vasko871a0252020-11-11 18:35:24 +0100248 * @param[in] clear_dflt Whether to clear dflt flag starting from @p parent, recursively all NP containers.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200249 * @param[out] incomplete Whether the value needs to be resolved.
Michal Vasko90932a92020-02-12 14:33:03 +0100250 * @return LY_SUCCESS on success.
251 * @return LY_EINCOMPLETE in case data tree is needed to finish the validation.
252 * @return LY_ERR value if an error occurred.
253 */
Michal Vasko9f96a052020-03-10 09:41:45 +0100254LY_ERR lyd_create_meta(struct lyd_node *parent, struct lyd_meta **meta, const struct lys_module *mod, const char *name,
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200255 size_t name_len, const char *value, size_t value_len, ly_bool *dynamic, LY_PREFIX_FORMAT format,
Michal Vasko871a0252020-11-11 18:35:24 +0100256 void *prefix_data, uint32_t hints, ly_bool clear_dlft, ly_bool *incomplete);
Radek Krejci1798aae2020-07-14 13:26:06 +0200257
258/**
Michal Vaskoa5da3292020-08-12 13:10:50 +0200259 * @brief Insert an attribute (last) into a parent
Radek Krejci1798aae2020-07-14 13:26:06 +0200260 *
Michal Vaskoa5da3292020-08-12 13:10:50 +0200261 * @param[in] parent Parent of the attributes.
262 * @param[in] attr Attribute (list) to be added into the @p parent.
Radek Krejci1798aae2020-07-14 13:26:06 +0200263 */
Michal Vaskoa5da3292020-08-12 13:10:50 +0200264void lyd_insert_attr(struct lyd_node *parent, struct lyd_attr *attr);
Michal Vasko90932a92020-02-12 14:33:03 +0100265
266/**
Michal Vasko52927e22020-03-16 17:26:14 +0100267 * @brief Create and insert a generic attribute (last) into a parent.
268 *
269 * @param[in] parent Parent of the attribute, can be NULL.
270 * @param[in,out] attr Attribute list to add at its end if @p parent is NULL, returned created attribute.
271 * @param[in] ctx libyang context.
272 * @param[in] name Attribute name.
273 * @param[in] name_len Length of @p name, must be set correctly.
Michal Vasko52927e22020-03-16 17:26:14 +0100274 * @param[in] prefix Attribute prefix.
275 * @param[in] prefix_len Attribute prefix length.
Radek Krejci1798aae2020-07-14 13:26:06 +0200276 * @param[in] module_key Mandatory key to reference module, can be namespace or name.
277 * @param[in] module_key_len Length of @p module_key, must be set correctly.
Michal Vasko501af032020-11-11 20:27:44 +0100278 * @param[in] value String value to be parsed.
279 * @param[in] value_len Length of @p value, must be set correctly.
280 * @param[in,out] dynamic Flag if @p value is dynamically allocated, is adjusted when @p value is consumed.
281 * @param[in] format Input format of @p value and @p ns.
282 * @param[in] val_prefix_data Format-specific prefix data, param is spent (even in case the function fails).
283 * @param[in] hints [Hints](@ref lydhints) from the parser regarding the node/value type.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200284 * @return LY_SUCCESS on success,
285 * @return LY_ERR value on error.
Michal Vasko52927e22020-03-16 17:26:14 +0100286 */
Radek Krejci1798aae2020-07-14 13:26:06 +0200287LY_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 +0100288 size_t name_len, const char *prefix, size_t prefix_len, const char *module_key, size_t module_key_len,
289 const char *value, size_t value_len, ly_bool *dynamic, LY_PREFIX_FORMAT format, void *val_prefix_data, uint32_t hints);
Radek Krejci1798aae2020-07-14 13:26:06 +0200290
291/**
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200292 * @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 +0200293 *
Michal Vasko8d544252020-03-02 10:19:52 +0100294 * @param[in] ctx libyang context.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200295 * @param[in,out] val Storage for the value.
296 * @param[in] type Type of the value.
Radek Krejci38d85362019-09-05 16:26:38 +0200297 * @param[in] value String value to be parsed, must not be NULL.
Michal Vaskof03ed032020-03-04 13:31:44 +0100298 * @param[in] value_len Length of the give @p value, must be set correctly.
Michal Vasko90932a92020-02-12 14:33:03 +0100299 * @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 +0200300 * @param[in] format Input format of @p value.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200301 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200302 * @param[in] hints [Value hints](@ref lydvalhints) from the parser.
303 * @param[in] ctx_node Context schema node.
304 * @param[out] incomplete Optional, set if the value also needs to be resolved.
305 * @param[in] log_elem_type Elem type for logging.
306 * @param[in] log_elem Elem for logging.
307 * @return LY_SUCCESS on success,
308 * @return LY_ERR value on error.
Radek Krejci38d85362019-09-05 16:26:38 +0200309 */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200310LY_ERR lyd_value_store(const struct ly_ctx *ctx, struct lyd_value *val, const struct lysc_type *type, const char *value,
311 size_t value_len, ly_bool *dynamic, LY_PREFIX_FORMAT format, void *prefix_data, uint32_t hints,
312 const struct lysc_node *ctx_node, ly_bool *incomplete, enum LY_VLOG_ELEM log_elem_type, const void *log_elem);
313
314/**
315 * @brief Validate previously incompletely stored value.
316 *
317 * @param[in] ctx libyang context.
318 * @param[in] type Schema type of the value (not the stored one, but the original one).
319 * @param[in,out] val Stored value to resolve.
320 * @param[in] ctx_node Context node for the resolution.
321 * @param[in] tree Data tree for the resolution.
322 * @param[in] log_elem_type Elem type for logging.
323 * @param[in] log_elem Elem for logging.
324 * @return LY_SUCCESS on success,
325 * @return LY_ERR value on error.
326 */
327LY_ERR lyd_value_validate_incomplete(const struct ly_ctx *ctx, const struct lysc_type *type, struct lyd_value *val,
328 const struct lyd_node *ctx_node, const struct lyd_node *tree, enum LY_VLOG_ELEM log_elem_type, const void *log_elem);
Radek Krejci38d85362019-09-05 16:26:38 +0200329
Michal Vaskof937cfe2020-08-03 16:07:12 +0200330/* generic function lys_value_validate */
331LY_ERR _lys_value_validate(const struct ly_ctx *ctx, const struct lysc_node *node, const char *value, size_t value_len,
Radek Krejci0f969882020-08-21 16:56:47 +0200332 LY_PREFIX_FORMAT format, void *prefix_data);
Michal Vaskof937cfe2020-08-03 16:07:12 +0200333
Radek Krejci38d85362019-09-05 16:26:38 +0200334/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200335 * @defgroup datahash Data nodes hash manipulation
336 * @ingroup datatree
337 */
338
339/**
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200340 * @brief Generate hash for the node.
341 *
342 * @param[in] node Data node to (re)generate hash value.
343 * @return LY_ERR value.
344 */
345LY_ERR lyd_hash(struct lyd_node *node);
346
347/**
348 * @brief Insert hash of the node into the hash table of its parent.
349 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200350 * @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 +0200351 * @return LY_ERR value.
352 */
353LY_ERR lyd_insert_hash(struct lyd_node *node);
354
355/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200356 * @brief Maintain node's parent's children hash table when unlinking the node.
357 *
358 * When completely freeing data tree, it is expected to free the parent's children hash table first, at once.
359 *
360 * @param[in] node The data node being unlinked from its parent.
361 */
362void lyd_unlink_hash(struct lyd_node *node);
363
364/** @} datahash */
365
Radek Krejci084289f2019-07-09 17:35:30 +0200366/**
Michal Vaskob1b5c262020-03-05 14:29:47 +0100367 * @brief Iterate over implemented modules for functions that accept specific modules or the whole context.
368 *
369 * @param[in] tree Data tree.
Michal Vasko26e80012020-07-08 10:55:46 +0200370 * @param[in] module Selected module, NULL for all.
Michal Vaskob1b5c262020-03-05 14:29:47 +0100371 * @param[in] ctx Context, NULL for selected modules.
372 * @param[in,out] i Iterator, set to 0 on first call.
373 * @param[out] first First sibling of the returned module.
374 * @return Next module.
375 * @return NULL if all modules were traversed.
376 */
Michal Vasko26e80012020-07-08 10:55:46 +0200377const struct lys_module *lyd_mod_next_module(struct lyd_node *tree, const struct lys_module *module,
Radek Krejci0f969882020-08-21 16:56:47 +0200378 const struct ly_ctx *ctx, uint32_t *i, struct lyd_node **first);
Michal Vaskob1b5c262020-03-05 14:29:47 +0100379
380/**
381 * @brief Iterate over modules for functions that want to traverse all the top-level data.
382 *
383 * @param[in,out] next Pointer to the next module data, set to first top-level sibling on first call.
384 * @param[out] first First sibling of the returned module.
385 * @return Next module.
386 * @return NULL if all modules were traversed.
387 */
388const struct lys_module *lyd_data_next_module(struct lyd_node **next, struct lyd_node **first);
389
Michal Vasko9f96a052020-03-10 09:41:45 +0100390/**
391 * @brief Check that a list has all its keys.
392 *
393 * @param[in] node List to check.
Michal Vasko44685da2020-03-17 15:38:06 +0100394 * @return LY_SUCCESS on success.
395 * @return LY_ENOT on a missing key.
Michal Vasko9f96a052020-03-10 09:41:45 +0100396 */
397LY_ERR lyd_parse_check_keys(struct lyd_node *node);
398
Michal Vasko60ea6352020-06-29 13:39:39 +0200399/**
400 * @brief Set data flags for a newly parsed node.
401 *
402 * @param[in] node Node to use.
403 * @param[in] when_check Set of nodes with unresolved when.
404 * @param[in,out] meta Node metadata, may be removed from.
405 * @param[in] options Parse options.
406 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200407void lyd_parse_set_data_flags(struct lyd_node *node, struct ly_set *when_check, struct lyd_meta **meta, uint32_t options);
Michal Vasko60ea6352020-06-29 13:39:39 +0200408
409/**
Michal Vaskod59035b2020-07-08 12:00:06 +0200410 * @brief Append all list key predicates to path.
411 *
412 * @param[in] node Node with keys to print.
413 * @param[in,out] buffer Buffer to print to.
414 * @param[in,out] buflen Current buffer length.
415 * @param[in,out] bufused Current number of characters used in @p buffer.
416 * @param[in] is_static Whether buffer is static or can be reallocated.
417 * @return LY_ERR
418 */
Radek Krejci857189e2020-09-01 13:26:36 +0200419LY_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 +0200420
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100421/**
422 * @brief Free stored prefix data.
423 *
424 * @param[in] format Format of the prefixes.
425 * @param[in] prefix_data Prefix data to free.
426 */
427void ly_free_prefix_data(LY_PREFIX_FORMAT format, void *prefix_data);
428
429/**
430 * @brief Duplicate prefix data.
431 *
432 * @param[in] ctx libyang context.
433 * @param[in] format Format of the prefixes in the value.
434 * @param[in] prefix_data Prefix data to duplicate.
435 * @param[out] prefix_data_p Duplicated prefix data.
436 * @return LY_ERR value.
437 */
438LY_ERR ly_dup_prefix_data(const struct ly_ctx *ctx, LY_PREFIX_FORMAT format, const void *prefix_data, void **prefix_data_p);
439
440/**
441 * @brief Store used prefixes in a value.
442 *
443 * @param[in] ctx libyang context.
444 * @param[in] value Value string to be parsed.
445 * @param[in] value_len Length of the @p value string.
446 * @param[in] format Format of the prefixes in the value.
447 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
448 * @param[out] format_p Resulting format of the prefixes.
449 * @param[out] prefix_data_p Resulting prefix data for the value in format @p format_p.
450 * @return LY_ERR value.
451 */
452LY_ERR ly_store_prefix_data(const struct ly_ctx *ctx, const char *value, size_t value_len, LY_PREFIX_FORMAT format,
453 void *prefix_data, LY_PREFIX_FORMAT *format_p, void **prefix_data_p);
454
Radek Krejcie7b95092019-05-15 11:03:07 +0200455#endif /* LY_TREE_DATA_INTERNAL_H_ */