blob: 9c59550e484402da5a02f99dfce712d54996d9f1 [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 */
David Sedlák72d46e22019-03-08 14:11:00 +010084LY_ERR lysp_check_prefix(struct ly_ctx *ctx, uint64_t *line, 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 */
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100157#define LYSC_OPT_RPC_INPUT LYS_CONFIG_W /**< Internal option when compiling schema tree of RPC/action input */
158#define LYSC_OPT_RPC_OUTPUT LYS_CONFIG_R /**< Internal option when compiling schema tree of RPC/action output */
159#define LYSC_OPT_RPC_MASK LYS_CONFIG_MASK
160#define LYSC_OPT_FREE_SP 0x04 /**< Free the input printable schema */
161#define LYSC_OPT_INTERNAL 0x08 /**< Internal compilation caused by dependency */
162#define LYSC_OPT_NOTIFICATION 0x10 /**< Internal option when compiling schema tree of Notification */
Radek Krejci096235c2019-01-11 11:12:19 +0100163/** @} scflags */
164
165/**
166 * @brief Compile printable schema into a validated schema linking all the references.
167 *
168 * @param[in, out] mod Schema structure holding pointers to both schema structure types. The ::lys_module#parsed
169 * member is used as input and ::lys_module#compiled is used to hold the result of the compilation.
170 * @param[in] options Various options to modify compiler behavior, see [compile flags](@ref scflags).
171 * @return LY_ERR value - LY_SUCCESS or LY_EVALID.
172 */
173LY_ERR lys_compile(struct lys_module *mod, int options);
174
175/**
Radek Krejcibbe09a92018-11-08 09:36:54 +0100176 * @brief Get address of a node's actions list if any.
177 *
178 * Decides the node's type and in case it has an actions list, returns its address.
179 * @param[in] node Node to check.
180 * @return Address of the node's actions member if any, NULL otherwise.
181 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100182struct lysp_action **lysp_node_actions_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100183
184/**
185 * @brief Get address of a node's notifications list if any.
186 *
187 * Decides the node's type and in case it has a notifications list, returns its address.
188 * @param[in] node Node to check.
189 * @return Address of the node's notifs member if any, NULL otherwise.
190 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100191struct lysp_notif **lysp_node_notifs_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100192
193/**
194 * @brief Get address of a node's child pointer if any.
195 *
196 * Decides the node's type and in case it has a children list, returns its address.
197 * @param[in] node Node to check.
198 * @return Address of the node's child member if any, NULL otherwise.
199 */
Radek Krejci056d0a82018-12-06 16:57:25 +0100200struct lysp_node **lysp_node_children_p(struct lysp_node *node);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100201
202/**
203 * @brief Get address of a node's child pointer if any.
204 *
205 * Decides the node's type and in case it has a children list, returns its address.
206 * @param[in] node Node to check.
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100207 * @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 +0100208 * @return Address of the node's child member if any, NULL otherwise.
209 */
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100210struct lysc_node **lysc_node_children_p(const struct lysc_node *node, uint16_t flags);
Radek Krejcibbe09a92018-11-08 09:36:54 +0100211
212/**
Radek Krejci96a0bfd2018-11-22 15:25:06 +0100213 * @brief Get the covering schema module structure for the given parsed module structure.
214 * @param[in] ctx libyang context to search.
215 * @param[in] mod Parsed schema structure.
216 * @return Corresponding lys_module structure for the given parsed schema structure.
217 */
218struct lys_module *lysp_find_module(struct ly_ctx *ctx, const struct lysp_module *mod);
219
220/**
Radek Krejcice8c1592018-10-29 15:35:51 +0100221 * @brief Find the module referenced by prefix in the provided parsed mod.
222 *
223 * @param[in] mod Schema module where the prefix was used.
224 * @param[in] prefix Prefix used to reference a module.
225 * @param[in] len Length of the prefix since it is not necessary NULL-terminated.
226 * @return Pointer to the module or NULL if the module is not found.
227 */
Radek Krejcia3045382018-11-22 14:30:31 +0100228struct lysp_module *lysp_module_find_prefix(const struct lysp_module *mod, const char *prefix, size_t len);
Radek Krejcice8c1592018-10-29 15:35:51 +0100229
230/**
231 * @brief Find the module referenced by prefix in the provided compiled mod.
232 *
233 * @param[in] mod Schema module where the prefix was used.
234 * @param[in] prefix Prefix used to reference a module.
235 * @param[in] len Length of the prefix since it is not necessary NULL-terminated.
236 * @return Pointer to the module or NULL if the module is not found.
237 */
Radek Krejcia3045382018-11-22 14:30:31 +0100238struct lysc_module *lysc_module_find_prefix(const struct lysc_module *mod, const char *prefix, size_t len);
Radek Krejcice8c1592018-10-29 15:35:51 +0100239
240/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100241 * @brief Check statement's status for invalid combination.
242 *
243 * The modX parameters are used just to determine if both flags are in the same module,
244 * so any of the schema module structure can be used, but both modules must be provided
245 * in the same type.
246 *
247 * @param[in] ctx Compile context for logging.
248 * @param[in] flags1 Flags of the referencing node.
249 * @param[in] mod1 Module of the referencing node,
250 * @param[in] name1 Schema node name of the referencing node.
251 * @param[in] flags2 Flags of the referenced node.
252 * @param[in] mod2 Module of the referenced node,
253 * @param[in] name2 Schema node name of the referenced node.
254 * @return LY_ERR value
255 */
256LY_ERR lysc_check_status(struct lysc_ctx *ctx,
257 uint16_t flags1, void *mod1, const char *name1,
258 uint16_t flags2, void *mod2, const char *name2);
259
260/**
Radek Krejcia3045382018-11-22 14:30:31 +0100261 * @brief Parse a node-identifier.
262 *
263 * node-identifier = [prefix ":"] identifier
264 *
265 * @param[in, out] id Identifier to parse. When returned, it points to the first character which is not part of the identifier.
266 * @param[out] prefix Node's prefix, NULL if there is not any.
267 * @param[out] prefix_len Length of the node's prefix, 0 if there is not any.
268 * @param[out] name Node's name.
269 * @param[out] nam_len Length of the node's name.
270 * @return LY_ERR value: LY_SUCCESS or LY_EINVAL in case of invalid character in the id.
271 */
272LY_ERR lys_parse_nodeid(const char **id, const char **prefix, size_t *prefix_len, const char **name, size_t *name_len);
273
274/**
Radek Krejci95710c92019-02-11 15:49:55 +0100275 * @brief Find the node according to the given descendant/absolute schema nodeid.
276 * Used in unique, refine and augment statements.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100277 *
278 * @param[in] ctx Compile context
279 * @param[in] nodeid Descendant-schema-nodeid (according to the YANG grammar)
280 * @param[in] nodeid_len Length of the given nodeid, if it is not NULL-terminated string.
281 * @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 +0100282 * If no context node is provided, the nodeid is actually expected to be the absolute schema node .
283 * @param[in] context_module Explicit module to resolve prefixes in @nodeid.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100284 * @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 +0100285 * the given nodetype, LY_EDENIED is returned (and target is provided), but no error message is printed.
286 * The value can be even an ORed value to allow multiple nodetypes.
287 * @param[in] implement Flag if the modules mentioned in the nodeid are supposed to be made implemented.
Radek Krejci6eeb58f2019-02-22 16:29:37 +0100288 * @param[out] target Found target node if any. In case of RPC/action input/output node, LYS_ACTION node is actually returned
289 * since the input/output has not a standalone node structure and it is part of ::lysc_action which is better compatible with ::lysc_node.
290 * @param[out] result_flag Output parameter to announce if the schema nodeid goes through the action's input/output or a Notification.
291 * The LYSC_OPT_RPC_INPUT, LYSC_OPT_RPC_OUTPUT and LYSC_OPT_NOTIFICATION are used as flags.
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100292 * @return LY_ERR values - LY_ENOTFOUND, LY_EVALID, LY_EDENIED or LY_SUCCESS.
293 */
Radek Krejci95710c92019-02-11 15:49:55 +0100294LY_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 +0100295 const struct lys_module *context_module, int nodetype, int implement,
296 const struct lysc_node **target, uint16_t *result_flag);
Radek Krejci9bb94eb2018-12-04 16:48:35 +0100297
298/**
Radek Krejci151a5b72018-10-19 14:21:44 +0200299 * @brief Find the module referenced by prefix in the provided mod.
300 *
301 * @param[in] mod Schema module where the prefix was used.
302 * @param[in] prefix Prefix used to reference a module.
303 * @param[in] len Length of the prefix since it is not necessary NULL-terminated.
304 * @return Pointer to the module or NULL if the module is not found.
305 */
Radek Krejcia3045382018-11-22 14:30:31 +0100306struct lys_module *lys_module_find_prefix(const struct lys_module *mod, const char *prefix, size_t len);
307
308/**
309 * @brief Stringify schema nodetype.
310 * @param[in] nodetype Nodetype to stringify.
311 * @return Constant string with the name of the node's type.
312 */
313const char *lys_nodetype2str(uint16_t nodetype);
Radek Krejci151a5b72018-10-19 14:21:44 +0200314
315/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100316 * @brief Parse YANG module from a string.
Radek Krejcid33273d2018-10-25 14:55:52 +0200317 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100318 * The modules are added into the context and the latest_revision flag is updated.
Radek Krejcid33273d2018-10-25 14:55:52 +0200319 *
320 * @param[in] ctx libyang context where to process the data model.
321 * @param[in] data The string containing the dumped data model in the specified
322 * format.
323 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejcid33273d2018-10-25 14:55:52 +0200324 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100325 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
326 * @param[in] check_data Caller's data to pass to the custom_check callback.
Radek Krejcid33273d2018-10-25 14:55:52 +0200327 * @return Pointer to the data model structure or NULL on error.
328 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100329struct lys_module *lys_parse_mem_module(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format, int implement,
330 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
331 void *check_data);
Radek Krejcid33273d2018-10-25 14:55:52 +0200332
333/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100334 * @brief Parse YANG submodule from a string.
Radek Krejcid33273d2018-10-25 14:55:52 +0200335 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100336 * The latest_revision flag of submodule is updated.
337 *
338 * @param[in] ctx libyang context where to process the data model.
339 * @param[in] data The string containing the dumped data model in the specified
340 * format.
341 * @param[in] format Format of the input data (YANG or YIN).
342 * @param[in] main_ctx Parser context of the main module.
343 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
344 * @param[in] check_data Caller's data to pass to the custom_check callback.
345 * @return Pointer to the data model structure or NULL on error.
346 */
347struct lysp_submodule *lys_parse_mem_submodule(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format, struct ly_parser_ctx *main_ctx,
348 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
349 void *check_data);
350
351/**
352 * @brief Parse YANG module or submodule from a file descriptor.
353 *
354 * 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 +0200355 *
356 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
357 *
358 * @param[in] ctx libyang context where to process the data model.
359 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
360 * in the specified format.
361 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejcid33273d2018-10-25 14:55:52 +0200362 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100363 * @param[in] main_ctx Parser context of the main module in case of parsing submodule. This flag decides if the module
364 * or submodule was expected to be parsed.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100365 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
366 * @param[in] check_data Caller's data to pass to the custom_check callback.
Radek Krejcid33273d2018-10-25 14:55:52 +0200367 * @return Pointer to the data model structure or NULL on error.
368 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100369void *lys_parse_fd_(struct ly_ctx *ctx, int fd, LYS_INFORMAT format, int implement, struct ly_parser_ctx *main_ctx,
370 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *data),
371 void *check_data);
Radek Krejcid33273d2018-10-25 14:55:52 +0200372
373/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100374 * @brief Parse YANG module from a file descriptor.
Radek Krejcid33273d2018-10-25 14:55:52 +0200375 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100376 * The modules are added into the context. The latest_revision flag is updated.
Radek Krejcid33273d2018-10-25 14:55:52 +0200377 *
378 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
379 *
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100380 * @param[in] ctx libyang context where to process the data model.
381 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
382 * in the specified format.
383 * @param[in] format Format of the input data (YANG or YIN).
384 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
385 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
386 * @param[in] check_data Caller's data to pass to the custom_check callback.
387 * @return Pointer to the data model structure or NULL on error.
388 */
389struct lys_module *lys_parse_fd_module(struct ly_ctx *ctx, int fd, LYS_INFORMAT format, int implement,
390 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
391 void *check_data);
392
393/**
394 * @brief Parse YANG submodule from a file descriptor.
395 *
396 * The latest_revision flag of submodules is updated.
397 *
398 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
399 *
400 * @param[in] ctx libyang context where to process the data model.
401 * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
402 * in the specified format.
403 * @param[in] format Format of the input data (YANG or YIN).
404 * @param[in] main_ctx Parser context of the main module.
405 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
406 * @param[in] check_data Caller's data to pass to the custom_check callback.
407 * @return Pointer to the data model structure or NULL on error.
408 */
409struct lysp_submodule *lys_parse_fd_submodule(struct ly_ctx *ctx, int fd, LYS_INFORMAT format, struct ly_parser_ctx *main_ctx,
410 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *check_data),
411 void *check_data);
412
413/**
414 * @brief Parse YANG module from a filepath.
415 *
416 * The modules are added into the context. The latest_revision flag is updated.
417 *
418 * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
Radek Krejcid33273d2018-10-25 14:55:52 +0200419 *
420 * @param[in] ctx libyang context where to process the data model.
421 * @param[in] path Path to the file with the model in the specified format.
422 * @param[in] format Format of the input data (YANG or YIN).
Radek Krejcid33273d2018-10-25 14:55:52 +0200423 * @param[in] implement Flag if the schema is supposed to be marked as implemented.
Radek Krejci9ed7a192018-10-31 16:23:51 +0100424 * @param[in] custom_check Callback to check the parsed schema before it is accepted.
425 * @param[in] check_data Caller's data to pass to the custom_check callback.
Radek Krejcid33273d2018-10-25 14:55:52 +0200426 * @return Pointer to the data model structure or NULL on error.
427 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100428struct lys_module *lys_parse_path_(struct ly_ctx *ctx, const char *path, LYS_INFORMAT format, int implement,
429 LY_ERR (*custom_check)(struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *data),
430 void *check_data);
Radek Krejcid33273d2018-10-25 14:55:52 +0200431
432/**
433 * @brief Load the (sub)module into the context.
434 *
435 * This function does not check the presence of the (sub)module in context, it should be done before calling this function.
436 *
437 * module_name and submodule_name are alternatives - only one of the
438 *
439 * @param[in] ctx libyang context where to work.
440 * @param[in] name Name of the (sub)module to load.
441 * @param[in] revision Optional revision of the (sub)module to load, if NULL the newest revision is being loaded.
442 * @param[in] implement Flag if the (sub)module is supposed to be marked as implemented.
Radek Krejci3b1f9292018-11-08 10:58:35 +0100443 * @param[in] main_ctx Parser context of the main module in case of loading submodule.
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100444 * @param[out] result Parsed YANG schema tree of the requested module (struct lys_module*) or submodule (struct lysp_submodule*).
445 * If it is a module, it is already in the context!
Radek Krejcid33273d2018-10-25 14:55:52 +0200446 * @return LY_ERR value, in case of LY_SUCCESS, the \arg result is always provided.
447 */
Radek Krejci3b1f9292018-11-08 10:58:35 +0100448LY_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 +0100449 void **result);
Radek Krejci086c7132018-10-26 15:29:04 +0200450
451/**
Radek Krejci0af46292019-01-11 16:02:31 +0100452 * @brief Create pre-compiled features array.
453 *
454 * Features are compiled in two steps to allow forward references between them via their if-feature statements.
455 * In case of not implemented schemas, the precompiled list of features is stored in lys_module structure and
456 * the compilation is not finished (if-feature and extensions are missing) and all the features are permanently
457 * disabled without a chance to change it. The list is used as target for any if-feature statement in any
458 * implemented module to get valid data to evaluate its result. The compilation is finished via
459 * lys_feature_precompile_finish() in implemented modules. In case a not implemented module becomes implemented,
460 * the precompiled list is reused to finish the compilation to preserve pointers already used in various compiled
461 * if-feature structures.
462 *
463 * @param[in] ctx libyang context.
464 * @param[in] features_p Array if the parsed features definitions to precompile.
465 * @param[in,out] features Pointer to the storage of the (pre)compiled features array where the new features are
466 * supposed to be added. The storage is supposed to be initiated to NULL when the first parsed features are going
467 * to be processed.
468 * @return LY_ERR value.
Radek Krejci086c7132018-10-26 15:29:04 +0200469 */
Radek Krejci0af46292019-01-11 16:02:31 +0100470LY_ERR lys_feature_precompile(struct ly_ctx *ctx, struct lysp_feature *features_p, struct lysc_feature **features);
471
472/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100473 * @brief Free the parsed submodule structure.
474 * @param[in] ctx libyang context where the string data resides in a dictionary.
475 * @param[in,out] submod Parsed schema submodule structure to free.
Radek Krejci086c7132018-10-26 15:29:04 +0200476 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100477void lysp_submodule_free(struct ly_ctx *ctx, struct lysp_submodule *submod);
Radek Krejci086c7132018-10-26 15:29:04 +0200478
Radek Krejcid33273d2018-10-25 14:55:52 +0200479/**
Radek Krejcicdfecd92018-11-26 11:27:32 +0100480 * @brief Free the compiled type structure.
481 * @param[in] ctx libyang context where the string data resides in a dictionary.
482 * @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.
483 */
484void lysc_type_free(struct ly_ctx *ctx, struct lysc_type *type);
485
486/**
Radek Krejci0af46292019-01-11 16:02:31 +0100487 * @brief Free the compiled if-feature structure.
488 * @param[in] ctx libyang context where the string data resides in a dictionary.
489 * @param[in,out] iff Compiled if-feature structure to be cleaned.
490 * Since the structure is typically part of the sized array, the structure itself is not freed.
491 */
492void lysc_iffeature_free(struct ly_ctx *ctx, struct lysc_iffeature *iff);
493
494/**
Radek Krejciccd20f12019-02-15 14:12:27 +0100495 * @brief Free the compiled must structure.
496 * @param[in] ctx libyang context where the string data resides in a dictionary.
497 * @param[in,out] must Compiled must structure to be cleaned.
498 * Since the structure is typically part of the sized array, the structure itself is not freed.
499 */
500void lysc_must_free(struct ly_ctx *ctx, struct lysc_must *must);
501
502/**
Radek Krejcif538ce52019-03-05 10:46:14 +0100503 * @brief Free the data inside compiled input/output structure.
504 * @param[in] ctx libyang context where the string data resides in a dictionary.
505 * @param[in,out] inout Compiled inout structure to be cleaned.
506 * Since the structure is part of the RPC/action structure, it is not freed itself.
507 */
508void lysc_action_inout_free(struct ly_ctx *ctx, struct lysc_action_inout *inout);
509
510/**
511 * @brief Free the data inside compiled RPC/action structure.
512 * @param[in] ctx libyang context where the string data resides in a dictionary.
513 * @param[in,out] action Compiled action structure to be cleaned.
514 * Since the structure is typically part of the sized array, the structure itself is not freed.
515 */
516void lysc_action_free(struct ly_ctx *ctx, struct lysc_action *action);
517
518/**
Radek Krejci0af46292019-01-11 16:02:31 +0100519 * @brief Free the compiled extension instance structure.
520 * @param[in] ctx libyang context where the string data resides in a dictionary.
521 * @param[in,out] ext Compiled extension instance structure to be cleaned.
522 * Since the structure is typically part of the sized array, the structure itself is not freed.
523 */
524void lysc_ext_instance_free(struct ly_ctx *ctx, struct lysc_ext_instance *ext);
525
526/**
Radek Krejci19a96102018-11-15 13:38:09 +0100527 * @brief Free the compiled node structure.
528 * @param[in] ctx libyang context where the string data resides in a dictionary.
529 * @param[in,out] node Compiled node structure to be freed.
530 */
531void lysc_node_free(struct ly_ctx *ctx, struct lysc_node *node);
532
533/**
534 * @brief Free the compiled schema structure.
535 * @param[in,out] module Compiled schema module structure to free.
536 * @param[in] private_destructor Function to remove private data from the compiled schema tree.
537 */
538void lysc_module_free(struct lysc_module *module, void (*private_destructor)(const struct lysc_node *node, void *priv));
Radek Krejci86d106e2018-10-18 09:53:19 +0200539
540/**
541 * @brief Free the schema structure. It just frees, it does not remove the schema from its context.
Radek Krejci70853c52018-10-15 14:46:16 +0200542 * @param[in,out] module Schema module structure to free.
543 * @param[in] private_destructor Function to remove private data from the compiled schema tree.
544 */
545void lys_module_free(struct lys_module *module, void (*private_destructor)(const struct lysc_node *node, void *priv));
546
547/**
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100548 * @brief Parse submodule from YANG data.
549 * @param[in] ctx Parser context.
550 * @param[in] data Input data to be parsed.
551 * @param[out] submod Pointer to the parsed submodule structure.
552 * @return LY_ERR value - LY_SUCCESS, LY_EINVAL or LY_EVALID.
Radek Krejci70853c52018-10-15 14:46:16 +0200553 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100554LY_ERR yang_parse_submodule(struct ly_parser_ctx *ctx, const char *data, struct lysp_submodule **submod);
555
556/**
557 * @brief Parse module from YANG data.
558 * @param[in] ctx Parser context.
559 * @param[in] data Input data to be parsed.
560 * @param[in, out] mod Prepared module structure where the parsed information, including the parsed
561 * module structure, will be filled in.
562 * @return LY_ERR value - LY_SUCCESS, LY_EINVAL or LY_EVALID.
563 */
564LY_ERR yang_parse_module(struct ly_parser_ctx *ctx, const char *data, struct lys_module *mod);
Radek Krejci70853c52018-10-15 14:46:16 +0200565
Radek Krejci95710c92019-02-11 15:49:55 +0100566/**
567 * @brief Make the specific module implemented, use the provided value as flag.
568 *
569 * @param[in] ctx libyang context to change.
570 * @param[in] mod Module from the given context to make implemented. It is not an error
571 * to provide already implemented module, it just does nothing.
572 * @param[in] implemented Flag value for the ::lys_module#implemented item.
573 * @return LY_SUCCESS or LY_EDENIED in case the context contains some other revision of the
574 * same module which is already implemented.
575 */
576LY_ERR ly_ctx_module_implement_internal(struct ly_ctx *ctx, struct lys_module *mod, uint8_t implemented);
Radek Krejci70853c52018-10-15 14:46:16 +0200577
David Sedlák18e494b2018-12-17 03:58:39 +0100578/**
579 * @brief match yang keyword
580 */
David Sedlák92206122019-02-15 12:39:17 +0100581enum yang_keyword match_keyword(const char *data, size_t len);
Radek Krejci70853c52018-10-15 14:46:16 +0200582#endif /* LY_TREE_SCHEMA_INTERNAL_H_ */