blob: 1d9ff5d75952335c55e56d14eff2c69e25ec0495 [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 Krejcid33273d2018-10-25 14:55:52 +020018#define LOGVAL_YANG(CTX, ...) LOGVAL((CTX)->ctx, LY_VLOG_LINE, &(CTX)->line, __VA_ARGS__)
19
Radek Krejcia9026eb2018-12-12 16:04:47 +010020/* These 2 macros checks YANG's identifier grammar rule */
21#define is_yangidentstartchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || c == '_')
22#define is_yangidentchar(c) ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || \
23 c == '_' || c == '-' || c == '.')
24
Radek Krejci70853c52018-10-15 14:46:16 +020025/**
Radek Krejcie3846472018-10-15 15:24:51 +020026 * @brief List of YANG statement groups - the (sub)module's substatements
27 */
28enum yang_module_stmt {
29 Y_MOD_MODULE_HEADER,
30 Y_MOD_LINKAGE,
31 Y_MOD_META,
32 Y_MOD_REVISION,
33 Y_MOD_BODY
34};
35
36/**
37 * @brief Types of arguments of YANG statements
38 */
39enum yang_arg {
40 Y_IDENTIF_ARG, /**< YANG "identifier-arg-str" rule */
Radek Krejcia9026eb2018-12-12 16:04:47 +010041 Y_PREF_IDENTIF_ARG, /**< YANG "identifier-ref-arg-str" or node-identifier rule */
Radek Krejcie3846472018-10-15 15:24:51 +020042 Y_STR_ARG, /**< YANG "string" rule */
43 Y_MAYBE_STR_ARG /**< optional YANG "string" rule */
44};
45
46/**
Radek Krejci70853c52018-10-15 14:46:16 +020047 * @brief internal context for schema parsers
48 */
49struct ly_parser_ctx {
50 struct ly_ctx *ctx;
Radek Krejcibbe09a92018-11-08 09:36:54 +010051 struct ly_set tpdfs_nodes;
52 struct ly_set grps_nodes;
53 uint64_t line; /**< line number */
54 uint64_t indent; /**< current position on the line for YANG indentation */
Radek Krejci0bcdaed2019-01-10 10:21:34 +010055 uint8_t mod_version; /**< module's version */
Radek Krejci70853c52018-10-15 14:46:16 +020056};
57
58/**
Radek Krejci4f28eda2018-11-12 11:46:16 +010059 * @brief internal context for compilation
60 */
61struct lysc_ctx {
62 struct ly_ctx *ctx;
63 struct lys_module *mod;
Radek Krejci0af46292019-01-11 16:02:31 +010064 struct lys_module *mod_def; /**< context module for the definitions of the nodes being currently
65 processed - groupings are supposed to be evaluated in place where
66 defined, but its content instances are supposed to be placed into
67 the target module (mod) */
68 struct ly_set groupings; /**< stack for groupings circular check */
69 struct ly_set unres; /**< to validate leafref's target and xpath of when/must */
Radek Krejci4f28eda2018-11-12 11:46:16 +010070 uint16_t path_len;
71#define LYSC_CTX_BUFSIZE 4078
72 char path[LYSC_CTX_BUFSIZE];
Radek Krejci70853c52018-10-15 14:46:16 +020073};
74
75/**
76 * @brief Check the currently present prefixes in the module for collision with the new one.
77 *
Radek Krejcibbe09a92018-11-08 09:36:54 +010078 * @param[in] ctx Context for logging.
Radek Krejci0bcdaed2019-01-10 10:21:34 +010079 * @param[in] imports List of current imports of the module to check prefix collision.
80 * @param[in] module_prefix Prefix of the module to check collision.
Radek Krejci70853c52018-10-15 14:46:16 +020081 * @param[in] value Newly added prefix value (including its location to distinguish collision with itself).
82 * @return LY_EEXIST when prefix is already used in the module, LY_SUCCESS otherwise
83 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +010084LY_ERR lysp_check_prefix(struct ly_parser_ctx *ctx, struct lysp_import *imports, const char *module_prefix, const char **value);
Radek Krejci70853c52018-10-15 14:46:16 +020085
Radek Krejci86d106e2018-10-18 09:53:19 +020086/**
87 * @brief Check date string (4DIGIT "-" 2DIGIT "-" 2DIGIT)
88 *
Radek Krejcibbe09a92018-11-08 09:36:54 +010089 * @param[in] ctx Optional context for logging.
Radek Krejci86d106e2018-10-18 09:53:19 +020090 * @param[in] date Date string to check (non-necessarily terminated by \0)
91 * @param[in] date_len Length of the date string, 10 expected.
92 * @param[in] stmt Statement name for error message.
93 * @return LY_ERR value.
94 */
Radek Krejcibbe09a92018-11-08 09:36:54 +010095LY_ERR lysp_check_date(struct ly_parser_ctx *ctx, const char *date, int date_len, const char *stmt);
96
97/**
98 * @brief Check names of typedefs in the parsed module to detect collisions.
99 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100100 * @param[in] ctx Parser context for logging and to maintain tpdfs_nodes
101 * @param[in] mod Module where the type is being defined.
Radek Krejcibbe09a92018-11-08 09:36:54 +0100102 * @return LY_ERR value.
103 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100104LY_ERR lysp_check_typedefs(struct ly_parser_ctx *ctx, struct lysp_module *mod);
Radek Krejci86d106e2018-10-18 09:53:19 +0200105
106/**
107 * @brief Just move the newest revision into the first position, does not sort the rest
108 * @param[in] revs Sized-array of the revisions in a printable schema tree.
109 */
110void lysp_sort_revisions(struct lysp_revision *revs);
111
112/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100113 * @brief Find type specified type definition
114 *
115 * @param[in] id Name of the type including possible prefix. Module where the prefix is being searched is start_module.
116 * @param[in] start_node Context node where the type is being instantiated to be able to search typedefs in parents.
117 * @param[in] start_module Module where the type is being instantiated for search for typedefs.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100118 * @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 +0100119 * @param[out] tpdf Found type definition.
120 * @param[out] node Node where the found typedef is defined, NULL in case of a top-level typedef.
121 * @param[out] module Module where the found typedef is being defined, NULL in case of built-in YANG types.
122 */
123LY_ERR lysp_type_find(const char *id, struct lysp_node *start_node, struct lysp_module *start_module,
Radek Krejci4f28eda2018-11-12 11:46:16 +0100124 LY_DATA_TYPE *type, const struct lysp_tpdf **tpdf, struct lysp_node **node, struct lysp_module **module);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100125
126/**
Radek Krejci086c7132018-10-26 15:29:04 +0200127 * @brief Find and parse module of the given name.
128 *
129 * @param[in] ctx libyang context.
130 * @param[in] name Name of the module to load.
131 * @param[in] revison Optional revision of the module to load. If NULL, the newest revision is loaded.
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100132 * @param[in] implement Flag if the loaded module is supposed to be marked as implemented.
133 * @param[in] require_parsed Flag to require parsed module structure in case the module is already in the context,
134 * but only the compiled structure is available.
Radek Krejci086c7132018-10-26 15:29:04 +0200135 * @param[out] mod Parsed module structure.
136 * @return LY_ERR value.
137 */
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100138LY_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 +0200139
140/**
Radek Krejcid33273d2018-10-25 14:55:52 +0200141 * @brief Parse included submodule into the simply parsed YANG module.
142 *
Radek Krejci3b1f9292018-11-08 10:58:35 +0100143 * @param[in] ctx parser context
Radek Krejcid33273d2018-10-25 14:55:52 +0200144 * @param[in] mod Module including a submodule.
Radek Krejcid33273d2018-10-25 14:55:52 +0200145 * @param[in,out] inc Include structure holding all available information about the include statement, the parsed
146 * submodule is stored into this structure.
147 * @return LY_ERR value.
148 */
Radek Krejci3b1f9292018-11-08 10:58:35 +0100149LY_ERR lysp_load_submodule(struct ly_parser_ctx *ctx, struct lysp_module *mod, struct lysp_include *inc);
Radek Krejcid33273d2018-10-25 14:55:52 +0200150
151/**
Radek Krejci096235c2019-01-11 11:12:19 +0100152 * @defgroup scflags Schema compile flags
153 * @ingroup schematree
154 *
155 * @{
156 */
157#define LYSC_OPT_FREE_SP 1 /**< Free the input printable schema */
Radek Krejci95710c92019-02-11 15:49:55 +0100158#define LYSC_OPT_INTERNAL 2 /**< Internal compilation caused by dependency */
Radek Krejci096235c2019-01-11 11:12:19 +0100159/** @} scflags */
160
161/**
162 * @brief Compile printable schema into a validated schema linking all the references.
163 *
164 * @param[in, out] mod Schema structure holding pointers to both schema structure types. The ::lys_module#parsed
165 * member is used as input and ::lys_module#compiled is used to hold the result of the compilation.
166 * @param[in] options Various options to modify compiler behavior, see [compile flags](@ref scflags).
167 * @return LY_ERR value - LY_SUCCESS or LY_EVALID.
168 */
169LY_ERR lys_compile(struct lys_module *mod, int options);
170
171/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100172 * @brief Get address of a node's actions list if any.
173 *
174 * Decides the node's type and in case it has an actions list, returns its address.
175 * @param[in] node Node to check.
176 * @return Address of the node's actions member if any, NULL otherwise.
177 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100178struct lysp_action **lysp_node_actions_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100179
180/**
181 * @brief Get address of a node's notifications list if any.
182 *
183 * Decides the node's type and in case it has a notifications list, returns its address.
184 * @param[in] node Node to check.
185 * @return Address of the node's notifs member if any, NULL otherwise.
186 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100187struct lysp_notif **lysp_node_notifs_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100188
189/**
190 * @brief Get address of a node's child pointer if any.
191 *
192 * Decides the node's type and in case it has a children list, returns its address.
193 * @param[in] node Node to check.
194 * @return Address of the node's child member if any, NULL otherwise.
195 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100196struct lysp_node **lysp_node_children_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100197
198/**
199 * @brief Get address of a node's child pointer if any.
200 *
201 * Decides the node's type and in case it has a children list, returns its address.
202 * @param[in] node Node to check.
203 * @return Address of the node's child member if any, NULL otherwise.
204 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100205struct lysc_node **lysc_node_children_p(const struct lysc_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100206
207/**
Radek Krejci96a0bfd2018-11-22 15:25:06 +0100208 * @brief Get the covering schema module structure for the given parsed module structure.
209 * @param[in] ctx libyang context to search.
210 * @param[in] mod Parsed schema structure.
211 * @return Corresponding lys_module structure for the given parsed schema structure.
212 */
213struct lys_module *lysp_find_module(struct ly_ctx *ctx, const struct lysp_module *mod);
214
215/**
Radek Krejcice8c1592018-10-29 15:35:51 +0100216 * @brief Find the module referenced by prefix in the provided parsed mod.
217 *
218 * @param[in] mod Schema module where the prefix was used.
219 * @param[in] prefix Prefix used to reference a module.
220 * @param[in] len Length of the prefix since it is not necessary NULL-terminated.
221 * @return Pointer to the module or NULL if the module is not found.
222 */
Radek Krejcia3045382018-11-22 14:30:31 +0100223struct lysp_module *lysp_module_find_prefix(const struct lysp_module *mod, const char *prefix, size_t len);
Radek Krejcice8c1592018-10-29 15:35:51 +0100224
225/**
226 * @brief Find the module referenced by prefix in the provided compiled mod.
227 *
228 * @param[in] mod Schema module where the prefix was used.
229 * @param[in] prefix Prefix used to reference a module.
230 * @param[in] len Length of the prefix since it is not necessary NULL-terminated.
231 * @return Pointer to the module or NULL if the module is not found.
232 */
Radek Krejcia3045382018-11-22 14:30:31 +0100233struct lysc_module *lysc_module_find_prefix(const struct lysc_module *mod, const char *prefix, size_t len);
Radek Krejcice8c1592018-10-29 15:35:51 +0100234
235/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100236 * @brief Check statement's status for invalid combination.
237 *
238 * The modX parameters are used just to determine if both flags are in the same module,
239 * so any of the schema module structure can be used, but both modules must be provided
240 * in the same type.
241 *
242 * @param[in] ctx Compile context for logging.
243 * @param[in] flags1 Flags of the referencing node.
244 * @param[in] mod1 Module of the referencing node,
245 * @param[in] name1 Schema node name of the referencing node.
246 * @param[in] flags2 Flags of the referenced node.
247 * @param[in] mod2 Module of the referenced node,
248 * @param[in] name2 Schema node name of the referenced node.
249 * @return LY_ERR value
250 */
251LY_ERR lysc_check_status(struct lysc_ctx *ctx,
252 uint16_t flags1, void *mod1, const char *name1,
253 uint16_t flags2, void *mod2, const char *name2);
254
255/**
Radek Krejcia3045382018-11-22 14:30:31 +0100256 * @brief Parse a node-identifier.
257 *
258 * node-identifier = [prefix ":"] identifier
259 *
260 * @param[in, out] id Identifier to parse. When returned, it points to the first character which is not part of the identifier.
261 * @param[out] prefix Node's prefix, NULL if there is not any.
262 * @param[out] prefix_len Length of the node's prefix, 0 if there is not any.
263 * @param[out] name Node's name.
264 * @param[out] nam_len Length of the node's name.
265 * @return LY_ERR value: LY_SUCCESS or LY_EINVAL in case of invalid character in the id.
266 */
267LY_ERR lys_parse_nodeid(const char **id, const char **prefix, size_t *prefix_len, const char **name, size_t *name_len);
268
269/**
Radek Krejci95710c92019-02-11 15:49:55 +0100270 * @brief Find the node according to the given descendant/absolute schema nodeid.
271 * Used in unique, refine and augment statements.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100272 *
273 * @param[in] ctx Compile context
274 * @param[in] nodeid Descendant-schema-nodeid (according to the YANG grammar)
275 * @param[in] nodeid_len Length of the given nodeid, if it is not NULL-terminated string.
276 * @param[in] context_node Node where the nodeid is specified to correctly resolve prefixes and to start searching.
Radek Krejci95710c92019-02-11 15:49:55 +0100277 * If no context node is provided, the nodeid is actually expected to be the absolute schema node id and the module
278 * to resolve prefixes and to start searching is taken from ctx's mod_def.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100279 * @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 +0100280 * the given nodetype, LY_EDENIED is returned (and target is provided), but no error message is printed.
281 * The value can be even an ORed value to allow multiple nodetypes.
282 * @param[in] implement Flag if the modules mentioned in the nodeid are supposed to be made implemented.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100283 * @param[out] target Found target node if any.
284 * @return LY_ERR values - LY_ENOTFOUND, LY_EVALID, LY_EDENIED or LY_SUCCESS.
285 */
Radek Krejci95710c92019-02-11 15:49:55 +0100286LY_ERR lys_resolve_schema_nodeid(struct lysc_ctx *ctx, const char *nodeid, size_t nodeid_len, const struct lysc_node *context_node,
287 int nodetype, int implement, const struct lysc_node **target);
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100288
289/**
Radek Krejci151a5b72018-10-19 14:21:44 +0200290 * @brief Find the module referenced by prefix in the provided mod.
291 *
292 * @param[in] mod Schema module where the prefix was used.
293 * @param[in] prefix Prefix used to reference a module.
294 * @param[in] len Length of the prefix since it is not necessary NULL-terminated.
295 * @return Pointer to the module or NULL if the module is not found.
296 */
Radek Krejcia3045382018-11-22 14:30:31 +0100297struct lys_module *lys_module_find_prefix(const struct lys_module *mod, const char *prefix, size_t len);
298
299/**
300 * @brief Stringify schema nodetype.
301 * @param[in] nodetype Nodetype to stringify.
302 * @return Constant string with the name of the node's type.
303 */
304const char *lys_nodetype2str(uint16_t nodetype);
Radek Krejci151a5b72018-10-19 14:21:44 +0200305
306/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100307 * @brief Parse YANG module from a string.
Radek Krejcid33273d2018-10-25 14:55:52 +0200308 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100309 * The modules are added into the context and the latest_revision flag is updated.
Radek Krejcid33273d2018-10-25 14:55:52 +0200310 *
311 * @param[in] ctx libyang context where to process the data model.
312 * @param[in] data The string containing the dumped data model in the specified
313 * format.
314 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejcid33273d2018-10-25 14:55:52 +0200315 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100316 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
317 * @param[in] check_data Caller's data to pass to the custom_check callback.
Radek Krejcid33273d2018-10-25 14:55:52 +0200318 * @return Pointer to the data model structure or NULL on error.
319 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100320struct lys_module *lys_parse_mem_module(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format, int implement,
321 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
322 void *check_data);
Radek Krejcid33273d2018-10-25 14:55:52 +0200323
324/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100325 * @brief Parse YANG submodule from a string.
Radek Krejcid33273d2018-10-25 14:55:52 +0200326 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100327 * The latest_revision flag of submodule is updated.
328 *
329 * @param[in] ctx libyang context where to process the data model.
330 * @param[in] data The string containing the dumped data model in the specified
331 * format.
332 * @param[in] format Format of the input data (YANG or YIN).
333 * @param[in] main_ctx Parser context of the main module.
334 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
335 * @param[in] check_data Caller's data to pass to the custom_check callback.
336 * @return Pointer to the data model structure or NULL on error.
337 */
338struct lysp_submodule *lys_parse_mem_submodule(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format, struct ly_parser_ctx *main_ctx,
339 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
340 void *check_data);
341
342/**
343 * @brief Parse YANG module or submodule from a file descriptor.
344 *
345 * 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 +0200346 *
347 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
348 *
349 * @param[in] ctx libyang context where to process the data model.
350 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
351 * in the specified format.
352 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejcid33273d2018-10-25 14:55:52 +0200353 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100354 * @param[in] main_ctx Parser context of the main module in case of parsing submodule. This flag decides if the module
355 * or submodule was expected to be parsed.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100356 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
357 * @param[in] check_data Caller's data to pass to the custom_check callback.
Radek Krejcid33273d2018-10-25 14:55:52 +0200358 * @return Pointer to the data model structure or NULL on error.
359 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100360void *lys_parse_fd_(struct ly_ctx *ctx, int fd, LYS_INFORMAT format, int implement, struct ly_parser_ctx *main_ctx,
361 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *data),
362 void *check_data);
Radek Krejcid33273d2018-10-25 14:55:52 +0200363
364/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100365 * @brief Parse YANG module from a file descriptor.
Radek Krejcid33273d2018-10-25 14:55:52 +0200366 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100367 * The modules are added into the context. The latest_revision flag is updated.
Radek Krejcid33273d2018-10-25 14:55:52 +0200368 *
369 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
370 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100371 * @param[in] ctx libyang context where to process the data model.
372 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
373 * in the specified format.
374 * @param[in] format Format of the input data (YANG or YIN).
375 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
376 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
377 * @param[in] check_data Caller's data to pass to the custom_check callback.
378 * @return Pointer to the data model structure or NULL on error.
379 */
380struct lys_module *lys_parse_fd_module(struct ly_ctx *ctx, int fd, LYS_INFORMAT format, int implement,
381 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
382 void *check_data);
383
384/**
385 * @brief Parse YANG submodule from a file descriptor.
386 *
387 * The latest_revision flag of submodules is updated.
388 *
389 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
390 *
391 * @param[in] ctx libyang context where to process the data model.
392 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
393 * in the specified format.
394 * @param[in] format Format of the input data (YANG or YIN).
395 * @param[in] main_ctx Parser context of the main module.
396 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
397 * @param[in] check_data Caller's data to pass to the custom_check callback.
398 * @return Pointer to the data model structure or NULL on error.
399 */
400struct lysp_submodule *lys_parse_fd_submodule(struct ly_ctx *ctx, int fd, LYS_INFORMAT format, struct ly_parser_ctx *main_ctx,
401 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
402 void *check_data);
403
404/**
405 * @brief Parse YANG module from a filepath.
406 *
407 * The modules are added into the context. The latest_revision flag is updated.
408 *
409 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
Radek Krejcid33273d2018-10-25 14:55:52 +0200410 *
411 * @param[in] ctx libyang context where to process the data model.
412 * @param[in] path Path to the file with the model in the specified format.
413 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejcid33273d2018-10-25 14:55:52 +0200414 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100415 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
416 * @param[in] check_data Caller's data to pass to the custom_check callback.
Radek Krejcid33273d2018-10-25 14:55:52 +0200417 * @return Pointer to the data model structure or NULL on error.
418 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100419struct lys_module *lys_parse_path_(struct ly_ctx *ctx, const char *path, LYS_INFORMAT format, int implement,
420 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *data),
421 void *check_data);
Radek Krejcid33273d2018-10-25 14:55:52 +0200422
423/**
424 * @brief Load the (sub)module into the context.
425 *
426 * This function does not check the presence of the (sub)module in context, it should be done before calling this function.
427 *
428 * module_name and submodule_name are alternatives - only one of the
429 *
430 * @param[in] ctx libyang context where to work.
431 * @param[in] name Name of the (sub)module to load.
432 * @param[in] revision Optional revision of the (sub)module to load, if NULL the newest revision is being loaded.
433 * @param[in] implement Flag if the (sub)module is supposed to be marked as implemented.
Radek Krejci3b1f9292018-11-08 10:58:35 +0100434 * @param[in] main_ctx Parser context of the main module in case of loading submodule.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100435 * @param[out] result Parsed YANG schema tree of the requested module (struct lys_module*) or submodule (struct lysp_submodule*).
436 * If it is a module, it is already in the context!
Radek Krejcid33273d2018-10-25 14:55:52 +0200437 * @return LY_ERR value, in case of LY_SUCCESS, the \arg result is always provided.
438 */
Radek Krejci3b1f9292018-11-08 10:58:35 +0100439LY_ERR lys_module_localfile(struct ly_ctx *ctx, const char *name, const char *revision, int implement, struct ly_parser_ctx *main_ctx,
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100440 void **result);
Radek Krejci086c7132018-10-26 15:29:04 +0200441
442/**
Radek Krejci0af46292019-01-11 16:02:31 +0100443 * @brief Create pre-compiled features array.
444 *
445 * Features are compiled in two steps to allow forward references between them via their if-feature statements.
446 * In case of not implemented schemas, the precompiled list of features is stored in lys_module structure and
447 * the compilation is not finished (if-feature and extensions are missing) and all the features are permanently
448 * disabled without a chance to change it. The list is used as target for any if-feature statement in any
449 * implemented module to get valid data to evaluate its result. The compilation is finished via
450 * lys_feature_precompile_finish() in implemented modules. In case a not implemented module becomes implemented,
451 * the precompiled list is reused to finish the compilation to preserve pointers already used in various compiled
452 * if-feature structures.
453 *
454 * @param[in] ctx libyang context.
455 * @param[in] features_p Array if the parsed features definitions to precompile.
456 * @param[in,out] features Pointer to the storage of the (pre)compiled features array where the new features are
457 * supposed to be added. The storage is supposed to be initiated to NULL when the first parsed features are going
458 * to be processed.
459 * @return LY_ERR value.
Radek Krejci086c7132018-10-26 15:29:04 +0200460 */
Radek Krejci0af46292019-01-11 16:02:31 +0100461LY_ERR lys_feature_precompile(struct ly_ctx *ctx, struct lysp_feature *features_p, struct lysc_feature **features);
462
463/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100464 * @brief Free the parsed submodule structure.
465 * @param[in] ctx libyang context where the string data resides in a dictionary.
466 * @param[in,out] submod Parsed schema submodule structure to free.
Radek Krejci086c7132018-10-26 15:29:04 +0200467 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100468void lysp_submodule_free(struct ly_ctx *ctx, struct lysp_submodule *submod);
Radek Krejci086c7132018-10-26 15:29:04 +0200469
Radek Krejcid33273d2018-10-25 14:55:52 +0200470/**
Radek Krejcicdfecd92018-11-26 11:27:32 +0100471 * @brief Free the compiled type structure.
472 * @param[in] ctx libyang context where the string data resides in a dictionary.
473 * @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.
474 */
475void lysc_type_free(struct ly_ctx *ctx, struct lysc_type *type);
476
477/**
Radek Krejci0af46292019-01-11 16:02:31 +0100478 * @brief Free the compiled if-feature structure.
479 * @param[in] ctx libyang context where the string data resides in a dictionary.
480 * @param[in,out] iff Compiled if-feature structure to be cleaned.
481 * Since the structure is typically part of the sized array, the structure itself is not freed.
482 */
483void lysc_iffeature_free(struct ly_ctx *ctx, struct lysc_iffeature *iff);
484
485/**
486 * @brief Free the compiled extension instance structure.
487 * @param[in] ctx libyang context where the string data resides in a dictionary.
488 * @param[in,out] ext Compiled extension instance structure to be cleaned.
489 * Since the structure is typically part of the sized array, the structure itself is not freed.
490 */
491void lysc_ext_instance_free(struct ly_ctx *ctx, struct lysc_ext_instance *ext);
492
493/**
Radek Krejci19a96102018-11-15 13:38:09 +0100494 * @brief Free the compiled node structure.
495 * @param[in] ctx libyang context where the string data resides in a dictionary.
496 * @param[in,out] node Compiled node structure to be freed.
497 */
498void lysc_node_free(struct ly_ctx *ctx, struct lysc_node *node);
499
500/**
501 * @brief Free the compiled schema structure.
502 * @param[in,out] module Compiled schema module structure to free.
503 * @param[in] private_destructor Function to remove private data from the compiled schema tree.
504 */
505void lysc_module_free(struct lysc_module *module, void (*private_destructor)(const struct lysc_node *node, void *priv));
Radek Krejci86d106e2018-10-18 09:53:19 +0200506
507/**
508 * @brief Free the schema structure. It just frees, it does not remove the schema from its context.
Radek Krejci70853c52018-10-15 14:46:16 +0200509 * @param[in,out] module Schema module structure to free.
510 * @param[in] private_destructor Function to remove private data from the compiled schema tree.
511 */
512void lys_module_free(struct lys_module *module, void (*private_destructor)(const struct lysc_node *node, void *priv));
513
514/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100515 * @brief Parse submodule from YANG data.
516 * @param[in] ctx Parser context.
517 * @param[in] data Input data to be parsed.
518 * @param[out] submod Pointer to the parsed submodule structure.
519 * @return LY_ERR value - LY_SUCCESS, LY_EINVAL or LY_EVALID.
Radek Krejci70853c52018-10-15 14:46:16 +0200520 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100521LY_ERR yang_parse_submodule(struct ly_parser_ctx *ctx, const char *data, struct lysp_submodule **submod);
522
523/**
524 * @brief Parse module from YANG data.
525 * @param[in] ctx Parser context.
526 * @param[in] data Input data to be parsed.
527 * @param[in, out] mod Prepared module structure where the parsed information, including the parsed
528 * module structure, will be filled in.
529 * @return LY_ERR value - LY_SUCCESS, LY_EINVAL or LY_EVALID.
530 */
531LY_ERR yang_parse_module(struct ly_parser_ctx *ctx, const char *data, struct lys_module *mod);
Radek Krejci70853c52018-10-15 14:46:16 +0200532
Radek Krejci95710c92019-02-11 15:49:55 +0100533/**
534 * @brief Make the specific module implemented, use the provided value as flag.
535 *
536 * @param[in] ctx libyang context to change.
537 * @param[in] mod Module from the given context to make implemented. It is not an error
538 * to provide already implemented module, it just does nothing.
539 * @param[in] implemented Flag value for the ::lys_module#implemented item.
540 * @return LY_SUCCESS or LY_EDENIED in case the context contains some other revision of the
541 * same module which is already implemented.
542 */
543LY_ERR ly_ctx_module_implement_internal(struct ly_ctx *ctx, struct lys_module *mod, uint8_t implemented);
Radek Krejci70853c52018-10-15 14:46:16 +0200544
David Sedlák18e494b2018-12-17 03:58:39 +0100545/**
546 * @brief match yang keyword
547 */
548enum yang_keyword match_keyword(const char *data);
Radek Krejci70853c52018-10-15 14:46:16 +0200549#endif /* LY_TREE_SCHEMA_INTERNAL_H_ */