blob: 2ef08172284c60767d4cf55f3d56b8602560c0f0 [file] [log] [blame]
Radek Krejci70853c52018-10-15 14:46:16 +02001/**
2 * @file tree_schema_internal.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief internal functions for YANG schema trees.
5 *
6 * Copyright (c) 2015 - 2018 CESNET, z.s.p.o.
7 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_TREE_SCHEMA_INTERNAL_H_
16#define LY_TREE_SCHEMA_INTERNAL_H_
17
Radek Krejci2d7a47b2019-05-16 13:34:10 +020018#include <stdint.h>
19
20#include "set.h"
21#include "tree_schema.h"
22
Radek Krejcid33273d2018-10-25 14:55:52 +020023#define LOGVAL_YANG(CTX, ...) LOGVAL((CTX)->ctx, LY_VLOG_LINE, &(CTX)->line, __VA_ARGS__)
24
Radek Krejcia9026eb2018-12-12 16:04:47 +010025/* These 2 macros checks YANG's identifier grammar rule */
26#define is_yangidentstartchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || c == '_')
27#define is_yangidentchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || \
28 c == '_' || c == '-' || c == '.')
29
Radek Krejci70853c52018-10-15 14:46:16 +020030/**
Radek Krejcie3846472018-10-15 15:24:51 +020031 * @brief List of YANG statement groups - the (sub)module's substatements
32 */
33enum yang_module_stmt {
34 Y_MOD_MODULE_HEADER,
35 Y_MOD_LINKAGE,
36 Y_MOD_META,
37 Y_MOD_REVISION,
38 Y_MOD_BODY
39};
40
41/**
42 * @brief Types of arguments of YANG statements
43 */
44enum yang_arg {
45 Y_IDENTIF_ARG, /**< YANG "identifier-arg-str" rule */
Radek Krejcia9026eb2018-12-12 16:04:47 +010046 Y_PREF_IDENTIF_ARG, /**< YANG "identifier-ref-arg-str" or node-identifier rule */
Radek Krejcie3846472018-10-15 15:24:51 +020047 Y_STR_ARG, /**< YANG "string" rule */
48 Y_MAYBE_STR_ARG /**< optional YANG "string" rule */
49};
50
51/**
Radek Krejci70853c52018-10-15 14:46:16 +020052 * @brief internal context for schema parsers
53 */
Radek Krejcie7b95092019-05-15 11:03:07 +020054struct lys_parser_ctx {
Radek Krejci70853c52018-10-15 14:46:16 +020055 struct ly_ctx *ctx;
Radek Krejcibbe09a92018-11-08 09:36:54 +010056 struct ly_set tpdfs_nodes;
57 struct ly_set grps_nodes;
58 uint64_t line; /**< line number */
59 uint64_t indent; /**< current position on the line for YANG indentation */
Radek Krejci0bcdaed2019-01-10 10:21:34 +010060 uint8_t mod_version; /**< module's version */
Radek Krejci70853c52018-10-15 14:46:16 +020061};
62
63/**
Radek Krejci4f28eda2018-11-12 11:46:16 +010064 * @brief internal context for compilation
65 */
66struct lysc_ctx {
67 struct ly_ctx *ctx;
68 struct lys_module *mod;
Radek Krejci0af46292019-01-11 16:02:31 +010069 struct lys_module *mod_def; /**< context module for the definitions of the nodes being currently
70 processed - groupings are supposed to be evaluated in place where
71 defined, but its content instances are supposed to be placed into
72 the target module (mod) */
73 struct ly_set groupings; /**< stack for groupings circular check */
74 struct ly_set unres; /**< to validate leafref's target and xpath of when/must */
Radek Krejci99b5b2a2019-04-30 16:57:04 +020075 struct ly_set tpdf_chain;
Radek Krejci4f28eda2018-11-12 11:46:16 +010076 uint16_t path_len;
Radek Krejciec4da802019-05-02 13:02:41 +020077 int options; /**< various @ref scflags. */
Radek Krejci4f28eda2018-11-12 11:46:16 +010078#define LYSC_CTX_BUFSIZE 4078
79 char path[LYSC_CTX_BUFSIZE];
80};
81
82/**
Radek Krejci70853c52018-10-15 14:46:16 +020083 * @brief Check the currently present prefixes in the module for collision with the new one.
84 *
Radek Krejcibbe09a92018-11-08 09:36:54 +010085 * @param[in] ctx Context for logging.
Radek Krejci0bcdaed2019-01-10 10:21:34 +010086 * @param[in] imports List of current imports of the module to check prefix collision.
87 * @param[in] module_prefix Prefix of the module to check collision.
Radek Krejci70853c52018-10-15 14:46:16 +020088 * @param[in] value Newly added prefix value (including its location to distinguish collision with itself).
89 * @return LY_EEXIST when prefix is already used in the module, LY_SUCCESS otherwise
90 */
Radek Krejcie7b95092019-05-15 11:03:07 +020091LY_ERR lysp_check_prefix(struct lys_parser_ctx *ctx, struct lysp_import *imports, const char *module_prefix, const char **value);
Radek Krejci70853c52018-10-15 14:46:16 +020092
Radek Krejci86d106e2018-10-18 09:53:19 +020093/**
94 * @brief Check date string (4DIGIT "-" 2DIGIT "-" 2DIGIT)
95 *
Radek Krejcibbe09a92018-11-08 09:36:54 +010096 * @param[in] ctx Optional context for logging.
Radek Krejci86d106e2018-10-18 09:53:19 +020097 * @param[in] date Date string to check (non-necessarily terminated by \0)
98 * @param[in] date_len Length of the date string, 10 expected.
99 * @param[in] stmt Statement name for error message.
100 * @return LY_ERR value.
101 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200102LY_ERR lysp_check_date(struct lys_parser_ctx *ctx, const char *date, int date_len, const char *stmt);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100103
104/**
105 * @brief Check names of typedefs in the parsed module to detect collisions.
106 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100107 * @param[in] ctx Parser context for logging and to maintain tpdfs_nodes
108 * @param[in] mod Module where the type is being defined.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100109 * @return LY_ERR value.
110 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200111LY_ERR lysp_check_typedefs(struct lys_parser_ctx *ctx, struct lysp_module *mod);
Radek Krejci86d106e2018-10-18 09:53:19 +0200112
113/**
114 * @brief Just move the newest revision into the first position, does not sort the rest
115 * @param[in] revs Sized-array of the revisions in a printable schema tree.
116 */
117void lysp_sort_revisions(struct lysp_revision *revs);
118
119/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100120 * @brief Find type specified type definition
121 *
122 * @param[in] id Name of the type including possible prefix. Module where the prefix is being searched is start_module.
123 * @param[in] start_node Context node where the type is being instantiated to be able to search typedefs in parents.
124 * @param[in] start_module Module where the type is being instantiated for search for typedefs.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100125 * @param[out] type Built-in type identifier of the id. If #LY_TYPE_UNKNOWN, tpdf is expected to contain found YANG schema typedef statement.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100126 * @param[out] tpdf Found type definition.
127 * @param[out] node Node where the found typedef is defined, NULL in case of a top-level typedef.
128 * @param[out] module Module where the found typedef is being defined, NULL in case of built-in YANG types.
129 */
130LY_ERR lysp_type_find(const char *id, struct lysp_node *start_node, struct lysp_module *start_module,
Radek Krejci4f28eda2018-11-12 11:46:16 +0100131 LY_DATA_TYPE *type, const struct lysp_tpdf **tpdf, struct lysp_node **node, struct lysp_module **module);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100132
133/**
Radek Krejci086c7132018-10-26 15:29:04 +0200134 * @brief Find and parse module of the given name.
135 *
136 * @param[in] ctx libyang context.
137 * @param[in] name Name of the module to load.
138 * @param[in] revison Optional revision of the module to load. If NULL, the newest revision is loaded.
Radek Krejcied5acc52019-04-25 15:57:04 +0200139 * @param[in] implement Flag if the loaded module is supposed to be marked as implemented. If revision is NULL and implement flag set,
140 * the implemented module in the context is returned despite it might not be of the latest revision, because in this case the module
141 * of the latest revision can not be made implemented.
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100142 * @param[in] require_parsed Flag to require parsed module structure in case the module is already in the context,
143 * but only the compiled structure is available.
Radek Krejci086c7132018-10-26 15:29:04 +0200144 * @param[out] mod Parsed module structure.
145 * @return LY_ERR value.
146 */
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100147LY_ERR lysp_load_module(struct ly_ctx *ctx, const char *name, const char *revision, int implement, int require_parsed, struct lys_module **mod);
Radek Krejci086c7132018-10-26 15:29:04 +0200148
149/**
Radek Krejcid33273d2018-10-25 14:55:52 +0200150 * @brief Parse included submodule into the simply parsed YANG module.
151 *
Radek Krejci3b1f9292018-11-08 10:58:35 +0100152 * @param[in] ctx parser context
Radek Krejcid33273d2018-10-25 14:55:52 +0200153 * @param[in] mod Module including a submodule.
Radek Krejcid33273d2018-10-25 14:55:52 +0200154 * @param[in,out] inc Include structure holding all available information about the include statement, the parsed
155 * submodule is stored into this structure.
156 * @return LY_ERR value.
157 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200158LY_ERR lysp_load_submodule(struct lys_parser_ctx *ctx, struct lysp_module *mod, struct lysp_include *inc);
Radek Krejcid33273d2018-10-25 14:55:52 +0200159
160/**
Radek Krejci096235c2019-01-11 11:12:19 +0100161 * @defgroup scflags Schema compile flags
162 * @ingroup schematree
163 *
164 * @{
165 */
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100166#define LYSC_OPT_RPC_INPUT LYS_CONFIG_W /**< Internal option when compiling schema tree of RPC/action input */
167#define LYSC_OPT_RPC_OUTPUT LYS_CONFIG_R /**< Internal option when compiling schema tree of RPC/action output */
Radek Krejcifc11bd72019-04-11 16:00:05 +0200168#define LYSC_OPT_RPC_MASK LYS_CONFIG_MASK /**< mask for the internal RPC options */
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100169#define LYSC_OPT_FREE_SP 0x04 /**< Free the input printable schema */
170#define LYSC_OPT_INTERNAL 0x08 /**< Internal compilation caused by dependency */
171#define LYSC_OPT_NOTIFICATION 0x10 /**< Internal option when compiling schema tree of Notification */
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200172
173#define LYSC_OPT_GROUPING 0x20 /** Compiling (validation) of a non-instantiated grouping.
174 In this case not all the restrictions are checked since they can be valid only
175 in the real placement of the grouping. TODO - what specifically is not done */
Radek Krejci096235c2019-01-11 11:12:19 +0100176/** @} scflags */
177
178/**
179 * @brief Compile printable schema into a validated schema linking all the references.
180 *
181 * @param[in, out] mod Schema structure holding pointers to both schema structure types. The ::lys_module#parsed
182 * member is used as input and ::lys_module#compiled is used to hold the result of the compilation.
183 * @param[in] options Various options to modify compiler behavior, see [compile flags](@ref scflags).
184 * @return LY_ERR value - LY_SUCCESS or LY_EVALID.
185 */
186LY_ERR lys_compile(struct lys_module *mod, int options);
187
188/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100189 * @brief Get address of a node's actions list if any.
190 *
191 * Decides the node's type and in case it has an actions list, returns its address.
192 * @param[in] node Node to check.
193 * @return Address of the node's actions member if any, NULL otherwise.
194 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100195struct lysp_action **lysp_node_actions_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100196
197/**
198 * @brief Get address of a node's notifications list if any.
199 *
200 * Decides the node's type and in case it has a notifications list, returns its address.
201 * @param[in] node Node to check.
202 * @return Address of the node's notifs member if any, NULL otherwise.
203 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100204struct lysp_notif **lysp_node_notifs_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100205
206/**
207 * @brief Get address of a node's child pointer if any.
208 *
209 * Decides the node's type and in case it has a children list, returns its address.
210 * @param[in] node Node to check.
211 * @return Address of the node's child member if any, NULL otherwise.
212 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100213struct lysp_node **lysp_node_children_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100214
215/**
216 * @brief Get address of a node's child pointer if any.
217 *
218 * Decides the node's type and in case it has a children list, returns its address.
219 * @param[in] node Node to check.
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100220 * @param[in] flags Config flag to distinguish input (LYS_CONFIG_W) and output (LYS_CONFIG_R) data in case of RPC/action node.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100221 * @return Address of the node's child member if any, NULL otherwise.
222 */
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100223struct lysc_node **lysc_node_children_p(const struct lysc_node *node, uint16_t flags);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100224
225/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200226 * @brief Get address of a node's notifs pointer if any.
227 *
228 * Decides the node's type and in case it has a notifs array, returns its address.
229 * @param[in] node Node to check.
230 * @return Address of the node's notifs member if any, NULL otherwise.
231 */
232struct lysc_notif **lysc_node_notifs_p(struct lysc_node *node);
233
234/**
235 * @brief Get address of a node's actions pointer if any.
236 *
237 * Decides the node's type and in case it has a actions array, returns its address.
238 * @param[in] node Node to check.
239 * @return Address of the node's actions member if any, NULL otherwise.
240 */
241struct lysc_action **lysc_node_actions_p(struct lysc_node *node);
242
243/**
Radek Krejcid3ca0632019-04-16 16:54:54 +0200244 * @brief Iterate over the specified type of the extension instances
245 *
246 * @param[in] ext ([Sized array](@ref sizedarrays)) of extensions to explore
247 * @param[in] index Index in the \p ext array where to start searching (first call with 0, the consequent calls with
248 * the returned index increased by 1 (until the iteration is not terminated by returning LY_ARRAY_SIZE(ext).
249 * @param[in] substmt Type of the extension (its belongins to the specific substatement) to iterate, use
250 * #LYEXT_SUBSTMT_ALL to go through all the extensions in the array
251 * @result index in the ext array, LY_ARRAY_SIZE(ext) value if not present.
252 */
253unsigned int lysp_ext_instance_iter(struct lysp_ext_instance *ext, unsigned int index, LYEXT_SUBSTMT substmt);
254
255/**
Radek Krejci96a0bfd2018-11-22 15:25:06 +0100256 * @brief Get the covering schema module structure for the given parsed module structure.
257 * @param[in] ctx libyang context to search.
258 * @param[in] mod Parsed schema structure.
259 * @return Corresponding lys_module structure for the given parsed schema structure.
260 */
261struct lys_module *lysp_find_module(struct ly_ctx *ctx, const struct lysp_module *mod);
262
263/**
Radek Krejcice8c1592018-10-29 15:35:51 +0100264 * @brief Find the module referenced by prefix in the provided parsed mod.
265 *
266 * @param[in] mod Schema module where the prefix was used.
267 * @param[in] prefix Prefix used to reference a module.
268 * @param[in] len Length of the prefix since it is not necessary NULL-terminated.
269 * @return Pointer to the module or NULL if the module is not found.
270 */
Radek Krejcia3045382018-11-22 14:30:31 +0100271struct lysp_module *lysp_module_find_prefix(const struct lysp_module *mod, const char *prefix, size_t len);
Radek Krejcice8c1592018-10-29 15:35:51 +0100272
273/**
274 * @brief Find the module referenced by prefix in the provided compiled mod.
275 *
276 * @param[in] mod Schema module where the prefix was used.
277 * @param[in] prefix Prefix used to reference a module.
278 * @param[in] len Length of the prefix since it is not necessary NULL-terminated.
279 * @return Pointer to the module or NULL if the module is not found.
280 */
Radek Krejcia3045382018-11-22 14:30:31 +0100281struct lysc_module *lysc_module_find_prefix(const struct lysc_module *mod, const char *prefix, size_t len);
Radek Krejcice8c1592018-10-29 15:35:51 +0100282
283/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100284 * @brief Check statement's status for invalid combination.
285 *
286 * The modX parameters are used just to determine if both flags are in the same module,
287 * so any of the schema module structure can be used, but both modules must be provided
288 * in the same type.
289 *
290 * @param[in] ctx Compile context for logging.
291 * @param[in] flags1 Flags of the referencing node.
292 * @param[in] mod1 Module of the referencing node,
293 * @param[in] name1 Schema node name of the referencing node.
294 * @param[in] flags2 Flags of the referenced node.
295 * @param[in] mod2 Module of the referenced node,
296 * @param[in] name2 Schema node name of the referenced node.
297 * @return LY_ERR value
298 */
299LY_ERR lysc_check_status(struct lysc_ctx *ctx,
300 uint16_t flags1, void *mod1, const char *name1,
301 uint16_t flags2, void *mod2, const char *name2);
302
303/**
Radek Krejcia3045382018-11-22 14:30:31 +0100304 * @brief Parse a node-identifier.
305 *
306 * node-identifier = [prefix ":"] identifier
307 *
308 * @param[in, out] id Identifier to parse. When returned, it points to the first character which is not part of the identifier.
309 * @param[out] prefix Node's prefix, NULL if there is not any.
310 * @param[out] prefix_len Length of the node's prefix, 0 if there is not any.
311 * @param[out] name Node's name.
312 * @param[out] nam_len Length of the node's name.
313 * @return LY_ERR value: LY_SUCCESS or LY_EINVAL in case of invalid character in the id.
314 */
315LY_ERR lys_parse_nodeid(const char **id, const char **prefix, size_t *prefix_len, const char **name, size_t *name_len);
316
317/**
Radek Krejci95710c92019-02-11 15:49:55 +0100318 * @brief Find the node according to the given descendant/absolute schema nodeid.
319 * Used in unique, refine and augment statements.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100320 *
321 * @param[in] ctx Compile context
322 * @param[in] nodeid Descendant-schema-nodeid (according to the YANG grammar)
323 * @param[in] nodeid_len Length of the given nodeid, if it is not NULL-terminated string.
324 * @param[in] context_node Node where the nodeid is specified to correctly resolve prefixes and to start searching.
Radek Krejci7af64242019-02-18 13:07:53 +0100325 * If no context node is provided, the nodeid is actually expected to be the absolute schema node .
326 * @param[in] context_module Explicit module to resolve prefixes in @nodeid.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100327 * @param[in] nodetype Optional (can be 0) restriction for target's nodetype. If target exists, but does not match
Radek Krejci95710c92019-02-11 15:49:55 +0100328 * the given nodetype, LY_EDENIED is returned (and target is provided), but no error message is printed.
329 * The value can be even an ORed value to allow multiple nodetypes.
330 * @param[in] implement Flag if the modules mentioned in the nodeid are supposed to be made implemented.
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100331 * @param[out] target Found target node if any. In case of RPC/action input/output node, LYS_ACTION node is actually returned
332 * since the input/output has not a standalone node structure and it is part of ::lysc_action which is better compatible with ::lysc_node.
333 * @param[out] result_flag Output parameter to announce if the schema nodeid goes through the action's input/output or a Notification.
334 * The LYSC_OPT_RPC_INPUT, LYSC_OPT_RPC_OUTPUT and LYSC_OPT_NOTIFICATION are used as flags.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100335 * @return LY_ERR values - LY_ENOTFOUND, LY_EVALID, LY_EDENIED or LY_SUCCESS.
336 */
Radek Krejci95710c92019-02-11 15:49:55 +0100337LY_ERR lys_resolve_schema_nodeid(struct lysc_ctx *ctx, const char *nodeid, size_t nodeid_len, const struct lysc_node *context_node,
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100338 const struct lys_module *context_module, int nodetype, int implement,
339 const struct lysc_node **target, uint16_t *result_flag);
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100340
341/**
Radek Krejci151a5b72018-10-19 14:21:44 +0200342 * @brief Find the module referenced by prefix in the provided mod.
343 *
Radek Krejci693262f2019-04-29 15:23:20 +0200344 * Reverse function to lys_prefix_find_module().
345 *
Radek Krejci151a5b72018-10-19 14:21:44 +0200346 * @param[in] mod Schema module where the prefix was used.
347 * @param[in] prefix Prefix used to reference a module.
348 * @param[in] len Length of the prefix since it is not necessary NULL-terminated.
349 * @return Pointer to the module or NULL if the module is not found.
350 */
Radek Krejcia3045382018-11-22 14:30:31 +0100351struct lys_module *lys_module_find_prefix(const struct lys_module *mod, const char *prefix, size_t len);
352
353/**
Radek Krejci693262f2019-04-29 15:23:20 +0200354 * @brief Find the prefix used to referenced the import module in the provided mod.
355 *
356 * Reverse function to lys_module_find_prefix().
357 *
358 * Note that original prefixes are present only in the parsed schema. In case it is not available
359 * (only compiled schema available), the own prefix of the import module is returned instead.
360 *
361 * @param[in] mod Schema module where the import module was used.
362 * @param[in] import Module referenced in mod.
363 * @return Prefix of the import module.
364 */
365const char *lys_prefix_find_module(const struct lys_module *mod, const struct lys_module *import);
366
367/**
Radek Krejcia3045382018-11-22 14:30:31 +0100368 * @brief Stringify schema nodetype.
369 * @param[in] nodetype Nodetype to stringify.
370 * @return Constant string with the name of the node's type.
371 */
372const char *lys_nodetype2str(uint16_t nodetype);
Radek Krejci151a5b72018-10-19 14:21:44 +0200373
374/**
Radek Krejci693262f2019-04-29 15:23:20 +0200375 * @brief Stringify YANG built-in type.
376 * @param[in] basetype Built-in tyep ID to stringify.
377 * @return Constant string with the name of the built-in type.
378 */
379const char *lys_datatype2str(LY_DATA_TYPE basetype);
380
381/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100382 * @brief Parse YANG module from a string.
Radek Krejcid33273d2018-10-25 14:55:52 +0200383 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100384 * The modules are added into the context and the latest_revision flag is updated.
Radek Krejcid33273d2018-10-25 14:55:52 +0200385 *
386 * @param[in] ctx libyang context where to process the data model.
387 * @param[in] data The string containing the dumped data model in the specified
388 * format.
389 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejcid33273d2018-10-25 14:55:52 +0200390 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100391 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
392 * @param[in] check_data Caller's data to pass to the custom_check callback.
Radek Krejcid33273d2018-10-25 14:55:52 +0200393 * @return Pointer to the data model structure or NULL on error.
394 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100395struct lys_module *lys_parse_mem_module(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format, int implement,
396 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
397 void *check_data);
Radek Krejcid33273d2018-10-25 14:55:52 +0200398
399/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100400 * @brief Parse YANG submodule from a string.
Radek Krejcid33273d2018-10-25 14:55:52 +0200401 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100402 * The latest_revision flag of submodule is updated.
403 *
404 * @param[in] ctx libyang context where to process the data model.
405 * @param[in] data The string containing the dumped data model in the specified
406 * format.
407 * @param[in] format Format of the input data (YANG or YIN).
408 * @param[in] main_ctx Parser context of the main module.
409 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
410 * @param[in] check_data Caller's data to pass to the custom_check callback.
411 * @return Pointer to the data model structure or NULL on error.
412 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200413struct lysp_submodule *lys_parse_mem_submodule(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format, struct lys_parser_ctx *main_ctx,
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100414 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
415 void *check_data);
416
417/**
418 * @brief Parse YANG module or submodule from a file descriptor.
419 *
420 * The modules are added into the context, submodules not. The latest_revision flag is updated in both cases.
Radek Krejcid33273d2018-10-25 14:55:52 +0200421 *
422 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
423 *
424 * @param[in] ctx libyang context where to process the data model.
425 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
426 * in the specified format.
427 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejcid33273d2018-10-25 14:55:52 +0200428 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100429 * @param[in] main_ctx Parser context of the main module in case of parsing submodule. This flag decides if the module
430 * or submodule was expected to be parsed.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100431 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
432 * @param[in] check_data Caller's data to pass to the custom_check callback.
Radek Krejcid33273d2018-10-25 14:55:52 +0200433 * @return Pointer to the data model structure or NULL on error.
434 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200435void *lys_parse_fd_(struct ly_ctx *ctx, int fd, LYS_INFORMAT format, int implement, struct lys_parser_ctx *main_ctx,
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100436 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *data),
437 void *check_data);
Radek Krejcid33273d2018-10-25 14:55:52 +0200438
439/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100440 * @brief Parse YANG module from a file descriptor.
Radek Krejcid33273d2018-10-25 14:55:52 +0200441 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100442 * The modules are added into the context. The latest_revision flag is updated.
Radek Krejcid33273d2018-10-25 14:55:52 +0200443 *
444 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
445 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100446 * @param[in] ctx libyang context where to process the data model.
447 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
448 * in the specified format.
449 * @param[in] format Format of the input data (YANG or YIN).
450 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
451 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
452 * @param[in] check_data Caller's data to pass to the custom_check callback.
453 * @return Pointer to the data model structure or NULL on error.
454 */
455struct lys_module *lys_parse_fd_module(struct ly_ctx *ctx, int fd, LYS_INFORMAT format, int implement,
456 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
457 void *check_data);
458
459/**
460 * @brief Parse YANG submodule from a file descriptor.
461 *
462 * The latest_revision flag of submodules is updated.
463 *
464 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
465 *
466 * @param[in] ctx libyang context where to process the data model.
467 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
468 * in the specified format.
469 * @param[in] format Format of the input data (YANG or YIN).
470 * @param[in] main_ctx Parser context of the main module.
471 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
472 * @param[in] check_data Caller's data to pass to the custom_check callback.
473 * @return Pointer to the data model structure or NULL on error.
474 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200475struct lysp_submodule *lys_parse_fd_submodule(struct ly_ctx *ctx, int fd, LYS_INFORMAT format, struct lys_parser_ctx *main_ctx,
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100476 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
477 void *check_data);
478
479/**
480 * @brief Parse YANG module from a filepath.
481 *
482 * The modules are added into the context. The latest_revision flag is updated.
483 *
484 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
Radek Krejcid33273d2018-10-25 14:55:52 +0200485 *
486 * @param[in] ctx libyang context where to process the data model.
487 * @param[in] path Path to the file with the model in the specified format.
488 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejcid33273d2018-10-25 14:55:52 +0200489 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100490 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
491 * @param[in] check_data Caller's data to pass to the custom_check callback.
Radek Krejcid33273d2018-10-25 14:55:52 +0200492 * @return Pointer to the data model structure or NULL on error.
493 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100494struct lys_module *lys_parse_path_(struct ly_ctx *ctx, const char *path, LYS_INFORMAT format, int implement,
495 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *data),
496 void *check_data);
Radek Krejcid33273d2018-10-25 14:55:52 +0200497
498/**
499 * @brief Load the (sub)module into the context.
500 *
501 * This function does not check the presence of the (sub)module in context, it should be done before calling this function.
502 *
503 * module_name and submodule_name are alternatives - only one of the
504 *
505 * @param[in] ctx libyang context where to work.
506 * @param[in] name Name of the (sub)module to load.
507 * @param[in] revision Optional revision of the (sub)module to load, if NULL the newest revision is being loaded.
508 * @param[in] implement Flag if the (sub)module is supposed to be marked as implemented.
Radek Krejci3b1f9292018-11-08 10:58:35 +0100509 * @param[in] main_ctx Parser context of the main module in case of loading submodule.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100510 * @param[out] result Parsed YANG schema tree of the requested module (struct lys_module*) or submodule (struct lysp_submodule*).
511 * If it is a module, it is already in the context!
Radek Krejcid33273d2018-10-25 14:55:52 +0200512 * @return LY_ERR value, in case of LY_SUCCESS, the \arg result is always provided.
513 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200514LY_ERR lys_module_localfile(struct ly_ctx *ctx, const char *name, const char *revision, int implement, struct lys_parser_ctx *main_ctx,
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100515 void **result);
Radek Krejci086c7132018-10-26 15:29:04 +0200516
517/**
Radek Krejci0af46292019-01-11 16:02:31 +0100518 * @brief Create pre-compiled features array.
519 *
520 * Features are compiled in two steps to allow forward references between them via their if-feature statements.
521 * In case of not implemented schemas, the precompiled list of features is stored in lys_module structure and
522 * the compilation is not finished (if-feature and extensions are missing) and all the features are permanently
523 * disabled without a chance to change it. The list is used as target for any if-feature statement in any
524 * implemented module to get valid data to evaluate its result. The compilation is finished via
525 * lys_feature_precompile_finish() in implemented modules. In case a not implemented module becomes implemented,
526 * the precompiled list is reused to finish the compilation to preserve pointers already used in various compiled
527 * if-feature structures.
528 *
529 * @param[in] ctx libyang context.
Radek Krejci693262f2019-04-29 15:23:20 +0200530 * @param[in] module Module of the features.
Radek Krejci0af46292019-01-11 16:02:31 +0100531 * @param[in] features_p Array if the parsed features definitions to precompile.
532 * @param[in,out] features Pointer to the storage of the (pre)compiled features array where the new features are
533 * supposed to be added. The storage is supposed to be initiated to NULL when the first parsed features are going
534 * to be processed.
535 * @return LY_ERR value.
536 */
Radek Krejci693262f2019-04-29 15:23:20 +0200537LY_ERR lys_feature_precompile(struct ly_ctx *ctx, struct lys_module *module, struct lysp_feature *features_p, struct lysc_feature **features);
538
539/**
540 * @brief Get the @ref ifftokens from the given position in the 2bits array
541 * (libyang format of the if-feature expression).
542 * @param[in] list The 2bits array with the compiled if-feature expression.
543 * @param[in] pos Position (0-based) to specify from which position get the operator.
544 */
545uint8_t lysc_iff_getop(uint8_t *list, int pos);
Radek Krejci0af46292019-01-11 16:02:31 +0100546
547/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200548 * @brief Macro to free [sized array](@ref sizedarrays) of items using the provided free function. The ARRAY itself is also freed,
549 * but the memory is not sanitized.
550 */
551#define FREE_ARRAY(CTX, ARRAY, FUNC) {uint64_t c__; LY_ARRAY_FOR(ARRAY, c__){FUNC(CTX, &(ARRAY)[c__]);}LY_ARRAY_FREE(ARRAY);}
552
553/**
554 * @brief Macro to free the specified MEMBER of a structure using the provided free function. The memory is not sanitized.
555 */
556#define FREE_MEMBER(CTX, MEMBER, FUNC) if (MEMBER) {FUNC(CTX, MEMBER);free(MEMBER);}
557
558/**
559 * @brief Macro to free [sized array](@ref sizedarrays) of strings stored in the context's dictionary. The ARRAY itself is also freed,
560 * but the memory is not sanitized.
561 */
562#define FREE_STRINGS(CTX, ARRAY) {uint64_t c__; LY_ARRAY_FOR(ARRAY, c__){FREE_STRING(CTX, ARRAY[c__]);}LY_ARRAY_FREE(ARRAY);}
563
564/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100565 * @brief Free the parsed submodule structure.
566 * @param[in] ctx libyang context where the string data resides in a dictionary.
567 * @param[in,out] submod Parsed schema submodule structure to free.
Radek Krejci086c7132018-10-26 15:29:04 +0200568 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100569void lysp_submodule_free(struct ly_ctx *ctx, struct lysp_submodule *submod);
Radek Krejci086c7132018-10-26 15:29:04 +0200570
Radek Krejcid33273d2018-10-25 14:55:52 +0200571/**
Radek Krejcicdfecd92018-11-26 11:27:32 +0100572 * @brief Free the compiled type structure.
573 * @param[in] ctx libyang context where the string data resides in a dictionary.
574 * @param[in,out] type Compiled type structure to be freed. The structure has refcount, so it is freed only in case the value is decreased to 0.
575 */
576void lysc_type_free(struct ly_ctx *ctx, struct lysc_type *type);
577
578/**
Radek Krejci0af46292019-01-11 16:02:31 +0100579 * @brief Free the compiled if-feature structure.
580 * @param[in] ctx libyang context where the string data resides in a dictionary.
581 * @param[in,out] iff Compiled if-feature structure to be cleaned.
582 * Since the structure is typically part of the sized array, the structure itself is not freed.
583 */
584void lysc_iffeature_free(struct ly_ctx *ctx, struct lysc_iffeature *iff);
585
586/**
Radek Krejciccd20f12019-02-15 14:12:27 +0100587 * @brief Free the compiled must structure.
588 * @param[in] ctx libyang context where the string data resides in a dictionary.
589 * @param[in,out] must Compiled must structure to be cleaned.
590 * Since the structure is typically part of the sized array, the structure itself is not freed.
591 */
592void lysc_must_free(struct ly_ctx *ctx, struct lysc_must *must);
593
594/**
Radek Krejcif538ce52019-03-05 10:46:14 +0100595 * @brief Free the data inside compiled input/output structure.
596 * @param[in] ctx libyang context where the string data resides in a dictionary.
597 * @param[in,out] inout Compiled inout structure to be cleaned.
598 * Since the structure is part of the RPC/action structure, it is not freed itself.
599 */
600void lysc_action_inout_free(struct ly_ctx *ctx, struct lysc_action_inout *inout);
601
602/**
603 * @brief Free the data inside compiled RPC/action structure.
604 * @param[in] ctx libyang context where the string data resides in a dictionary.
605 * @param[in,out] action Compiled action structure to be cleaned.
606 * Since the structure is typically part of the sized array, the structure itself is not freed.
607 */
608void lysc_action_free(struct ly_ctx *ctx, struct lysc_action *action);
609
610/**
Radek Krejcifc11bd72019-04-11 16:00:05 +0200611 * @brief Free the items inside the compiled Notification structure.
612 * @param[in] ctx libyang context where the string data resides in a dictionary.
613 * @param[in,out] action Compiled Notification structure to be cleaned.
614 * Since the structure is typically part of the sized array, the structure itself is not freed.
615 */
616void lysc_notif_free(struct ly_ctx *ctx, struct lysc_notif *notif);
617
618/**
Radek Krejci0af46292019-01-11 16:02:31 +0100619 * @brief Free the compiled extension instance structure.
620 * @param[in] ctx libyang context where the string data resides in a dictionary.
621 * @param[in,out] ext Compiled extension instance structure to be cleaned.
622 * Since the structure is typically part of the sized array, the structure itself is not freed.
623 */
624void lysc_ext_instance_free(struct ly_ctx *ctx, struct lysc_ext_instance *ext);
625
626/**
Radek Krejci19a96102018-11-15 13:38:09 +0100627 * @brief Free the compiled node structure.
628 * @param[in] ctx libyang context where the string data resides in a dictionary.
629 * @param[in,out] node Compiled node structure to be freed.
630 */
631void lysc_node_free(struct ly_ctx *ctx, struct lysc_node *node);
632
633/**
Radek Krejcif2de0ed2019-05-02 14:13:18 +0200634 * @brief Free the compiled container node structure.
635 *
636 * Only the container-specific members are freed, for generic node free function,
637 * use lysc_node_free().
638 *
639 * @param[in] ctx libyang context where the string data resides in a dictionary.
640 * @param[in,out] node Compiled container node structure to be freed.
641 */
642void lysc_node_container_free(struct ly_ctx *ctx, struct lysc_node_container *node);
643
644/**
Radek Krejci19a96102018-11-15 13:38:09 +0100645 * @brief Free the compiled schema structure.
646 * @param[in,out] module Compiled schema module structure to free.
647 * @param[in] private_destructor Function to remove private data from the compiled schema tree.
648 */
649void lysc_module_free(struct lysc_module *module, void (*private_destructor)(const struct lysc_node *node, void *priv));
650
651/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200652 * @brief Free the schema structure. It just frees, it does not remove the schema from its context.
653 * @param[in,out] module Schema module structure to free.
654 * @param[in] private_destructor Function to remove private data from the compiled schema tree.
655 */
656void lys_module_free(struct lys_module *module, void (*private_destructor)(const struct lysc_node *node, void *priv));
657
658/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100659 * @brief Parse submodule from YANG data.
660 * @param[in] ctx Parser context.
661 * @param[in] data Input data to be parsed.
662 * @param[out] submod Pointer to the parsed submodule structure.
663 * @return LY_ERR value - LY_SUCCESS, LY_EINVAL or LY_EVALID.
Radek Krejci86d106e2018-10-18 09:53:19 +0200664 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200665LY_ERR yang_parse_submodule(struct lys_parser_ctx *ctx, const char *data, struct lysp_submodule **submod);
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100666
667/**
668 * @brief Parse module from YANG data.
669 * @param[in] ctx Parser context.
670 * @param[in] data Input data to be parsed.
671 * @param[in, out] mod Prepared module structure where the parsed information, including the parsed
672 * module structure, will be filled in.
673 * @return LY_ERR value - LY_SUCCESS, LY_EINVAL or LY_EVALID.
674 */
Radek Krejcie7b95092019-05-15 11:03:07 +0200675LY_ERR yang_parse_module(struct lys_parser_ctx *ctx, const char *data, struct lys_module *mod);
Radek Krejci86d106e2018-10-18 09:53:19 +0200676
Radek Krejci95710c92019-02-11 15:49:55 +0100677/**
678 * @brief Make the specific module implemented, use the provided value as flag.
679 *
680 * @param[in] ctx libyang context to change.
681 * @param[in] mod Module from the given context to make implemented. It is not an error
682 * to provide already implemented module, it just does nothing.
683 * @param[in] implemented Flag value for the ::lys_module#implemented item.
684 * @return LY_SUCCESS or LY_EDENIED in case the context contains some other revision of the
685 * same module which is already implemented.
686 */
687LY_ERR ly_ctx_module_implement_internal(struct ly_ctx *ctx, struct lys_module *mod, uint8_t implemented);
688
Radek Krejci70853c52018-10-15 14:46:16 +0200689#endif /* LY_TREE_SCHEMA_INTERNAL_H_ */