blob: ff41115d8950c44c96173bdd07f996ee73fa5335 [file] [log] [blame]
Michal Vasko1a7a7bd2020-10-16 14:39:15 +02001/**
2 * @file schema_compile.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
Michal Vasko19a09022021-06-15 11:54:08 +02004 * @author Michal Vasko <mvasko@cesnet.cz>
Michal Vasko1a7a7bd2020-10-16 14:39:15 +02005 * @brief Header for schema compilation.
6 *
Michal Vasko19a09022021-06-15 11:54:08 +02007 * Copyright (c) 2015 - 2021 CESNET, z.s.p.o.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +02008 *
9 * This source code is licensed under BSD 3-Clause License (the "License").
10 * You may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * https://opensource.org/licenses/BSD-3-Clause
14 */
15
16#ifndef LY_SCHEMA_COMPILE_H_
17#define LY_SCHEMA_COMPILE_H_
18
Radek Krejci47fab892020-11-05 17:02:41 +010019#include <stddef.h>
20#include <stdint.h>
21
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020022#include "log.h"
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020023#include "set.h"
Radek Krejci47fab892020-11-05 17:02:41 +010024#include "tree.h"
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020025#include "tree_schema.h"
26
Radek Krejci47fab892020-11-05 17:02:41 +010027struct lyxp_expr;
28
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020029/**
Radek Krejci5f9a3672021-03-05 21:35:22 +010030 * @brief YANG schema compilation context.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020031 */
32struct lysc_ctx {
Radek Krejci5f9a3672021-03-05 21:35:22 +010033 struct ly_ctx *ctx; /**< libyang context */
Michal Vaskob8df5762021-01-12 15:15:53 +010034 struct lys_module *cur_mod; /**< module currently being compiled,
35 - identifier/path - used as the current module for unprefixed nodes
36 - augment - module where the augment is defined
37 - deviation - module where the deviation is defined
38 - uses - module where the uses is defined */
39 struct lysp_module *pmod; /**< parsed module being processed,
40 - identifier/path - used for searching imports to resolve prefixed nodes
41 - augment - module where the augment is defined
42 - deviation - module where the deviation is defined
43 - uses - module where the grouping is defined */
Radek Krejci6b88a462021-02-17 12:39:34 +010044 struct lysc_ext_instance *ext; /**< extension instance being processed and serving as a source for its substatements
45 instead of the module itself */
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020046 struct ly_set groupings; /**< stack for groupings circular check */
Radek Krejci5f9a3672021-03-05 21:35:22 +010047 struct ly_set tpdf_chain; /**< stack for typedefs circular check */
Radek Krejci5f9a3672021-03-05 21:35:22 +010048 struct ly_set augs; /**< set of compiled non-applied top-level augments (stored ::lysc_augment *) */
49 struct ly_set devs; /**< set of compiled non-applied deviations (stored ::lysc_deviation *) */
50 struct ly_set uses_augs; /**< set of compiled non-applied uses augments (stored ::lysc_augment *) */
51 struct ly_set uses_rfns; /**< set of compiled non-applied uses refines (stored ::lysc_refine *) */
Michal Vaskof4258e12021-06-15 12:11:42 +020052 struct lys_depset_unres *unres; /**< dependency set unres sets */
Radek Krejci5f9a3672021-03-05 21:35:22 +010053 uint32_t path_len; /**< number of path bytes used */
Michal Vasko7c565922021-06-10 14:58:27 +020054 uint32_t compile_opts; /**< various @ref scflags. */
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020055#define LYSC_CTX_BUFSIZE 4078
Radek Krejci5f9a3672021-03-05 21:35:22 +010056 char path[LYSC_CTX_BUFSIZE];/**< Path identifying the schema node currently being processed */
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020057};
58
59/**
Michal Vaskof4258e12021-06-15 12:11:42 +020060 * @brief Structure for unresolved items that may depend on any implemented module data in the dependency set
61 * so their resolution can only be performed after the whole dep set compilation is done.
Michal Vasko405cc9e2020-12-01 12:01:27 +010062 */
Michal Vaskof4258e12021-06-15 12:11:42 +020063struct lys_depset_unres {
Michal Vaskoc130e162021-10-19 11:30:00 +020064 struct ly_set whens; /**< nodes with when to check */
65 struct ly_set musts; /**< set of musts to check */
aPiecekc6526b42021-07-12 15:21:39 +020066 struct ly_set leafrefs; /**< to validate target of leafrefs */
67 struct ly_set dflts; /**< set of incomplete default values */
Michal Vaskof4fa90d2021-11-11 15:05:19 +010068 struct ly_set disabled; /**< set of compiled nodes whose if-feature(s) was not satisfied
69 (stored ::lysc_node *) */
aPiecekc6526b42021-07-12 15:21:39 +020070 struct ly_set disabled_leafrefs; /**< subset of the lys_depset_unres.disabled to validate target of disabled leafrefs */
Michal Vaskof4fa90d2021-11-11 15:05:19 +010071 struct ly_set disabled_bitenums; /**< set of enumation/bits leaves/leaf-lists with bits/enums to disable
72 (stored ::lysc_node_leaf *) */
Michal Vasko405cc9e2020-12-01 12:01:27 +010073};
74
75/**
Michal Vaskof4258e12021-06-15 12:11:42 +020076 * @brief Unres structure global for compilation.
77 */
78struct lys_glob_unres {
Michal Vasko709f9a52021-07-21 10:51:59 +020079 struct ly_set dep_sets; /**< set of dependency sets of modules, see ::lys_compile_depset_all() */
Michal Vaskof4258e12021-06-15 12:11:42 +020080 struct ly_set implementing; /**< set of YANG schemas being atomically implemented (compiled); the first added
Radek Krejci84d7fd72021-07-14 18:32:21 +020081 module is always the explicitly implemented module, the other ones are dependencies */
Michal Vaskof4258e12021-06-15 12:11:42 +020082 struct ly_set creating; /**< set of YANG schemas being atomically created (parsed); it is a subset of implemented
83 and all these modules are freed if any error occurs */
84 struct lys_depset_unres ds_unres; /**< unres specific for the current dependency set */
85};
86
87/**
Michal Vaskoc130e162021-10-19 11:30:00 +020088 * @brief Structure for storing schema nodes with must expressions and local module for each of them.
89 */
90struct lysc_unres_must {
91 struct lysc_node *node; /**< node with the must expression(s) */
92 const struct lysp_module **local_mods; /**< sized array of local modules for must(s) */
93};
94
95/**
96 * @brief Structure for storing leafref node and its local module.
97 */
98struct lysc_unres_leafref {
99 struct lysc_node *node; /**< leaf/leaf-list node with leafref type */
100 const struct lysp_module *local_mod; /**< local module of the leafref type */
101};
102
103/**
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200104 * @brief Structure for remembering default values of leaves and leaf-lists. They are resolved at schema compilation
105 * end when the whole schema tree is available.
106 */
107struct lysc_unres_dflt {
108 union {
109 struct lysc_node_leaf *leaf;
110 struct lysc_node_leaflist *llist;
111 };
112 struct lysp_qname *dflt;
113 struct lysp_qname *dflts; /**< this is a sized array */
114};
115
116/**
117 * @brief Duplicate string into dictionary
118 * @param[in] CTX libyang context of the dictionary.
119 * @param[in] ORIG String to duplicate.
120 * @param[out] DUP Where to store the result.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200121 * @param[out] RET Where to store the return code.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200122 */
Michal Vasko899c7ce2022-02-18 09:18:37 +0100123#define DUP_STRING(CTX, ORIG, DUP, RET) RET = lydict_insert(CTX, ORIG, 0, &(DUP))
124#define DUP_STRING_RET(CTX, ORIG, DUP) LY_CHECK_RET(lydict_insert(CTX, ORIG, 0, &(DUP)))
125#define DUP_STRING_GOTO(CTX, ORIG, DUP, RET, GOTO) LY_CHECK_GOTO(RET = lydict_insert(CTX, ORIG, 0, &(DUP)), GOTO)
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200126
127#define DUP_ARRAY(CTX, ORIG_ARRAY, NEW_ARRAY, DUP_FUNC) \
128 if (ORIG_ARRAY) { \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100129 LY_ARRAY_COUNT_TYPE __u; \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200130 LY_ARRAY_CREATE_RET(CTX, NEW_ARRAY, LY_ARRAY_COUNT(ORIG_ARRAY), LY_EMEM); \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100131 LY_ARRAY_FOR(ORIG_ARRAY, __u) { \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200132 LY_ARRAY_INCREMENT(NEW_ARRAY); \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100133 LY_CHECK_RET(DUP_FUNC(CTX, &(NEW_ARRAY)[__u], &(ORIG_ARRAY)[__u])); \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200134 } \
135 }
136
Michal Vasko5347e3a2020-11-03 17:14:57 +0100137#define COMPILE_OP_ARRAY_GOTO(CTX, ARRAY_P, ARRAY_C, PARENT, FUNC, USES_STATUS, RET, GOTO) \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200138 if (ARRAY_P) { \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100139 LY_ARRAY_COUNT_TYPE __u = (ARRAY_C) ? LY_ARRAY_COUNT(ARRAY_C) : 0; \
140 LY_ARRAY_CREATE_GOTO((CTX)->ctx, ARRAY_C, __u + LY_ARRAY_COUNT(ARRAY_P), RET, GOTO); \
141 LY_ARRAY_FOR(ARRAY_P, __u) { \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200142 LY_ARRAY_INCREMENT(ARRAY_C); \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100143 RET = FUNC(CTX, &(ARRAY_P)[__u], PARENT, &(ARRAY_C)[LY_ARRAY_COUNT(ARRAY_C) - 1], USES_STATUS); \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200144 if (RET == LY_EDENIED) { \
145 LY_ARRAY_DECREMENT(ARRAY_C); \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100146 RET = LY_SUCCESS; \
147 } else if (RET) { \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200148 goto GOTO; \
149 } \
150 } \
151 }
152
Michal Vasko5347e3a2020-11-03 17:14:57 +0100153#define COMPILE_ARRAY_GOTO(CTX, ARRAY_P, ARRAY_C, FUNC, RET, GOTO) \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200154 if (ARRAY_P) { \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100155 LY_ARRAY_COUNT_TYPE __u = (ARRAY_C) ? LY_ARRAY_COUNT(ARRAY_C) : 0; \
156 LY_ARRAY_CREATE_GOTO((CTX)->ctx, ARRAY_C, __u + LY_ARRAY_COUNT(ARRAY_P), RET, GOTO); \
157 LY_ARRAY_FOR(ARRAY_P, __u) { \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200158 LY_ARRAY_INCREMENT(ARRAY_C); \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100159 RET = FUNC(CTX, &(ARRAY_P)[__u], &(ARRAY_C)[LY_ARRAY_COUNT(ARRAY_C) - 1]); \
160 LY_CHECK_GOTO(RET, GOTO); \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200161 } \
162 }
163
Radek Krejciab430862021-03-02 20:13:40 +0100164#define COMPILE_EXTS_GOTO(CTX, EXTS_P, EXT_C, PARENT, RET, GOTO) \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200165 if (EXTS_P) { \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100166 LY_ARRAY_COUNT_TYPE __u = (EXT_C) ? LY_ARRAY_COUNT(EXT_C) : 0; \
167 LY_ARRAY_CREATE_GOTO((CTX)->ctx, EXT_C, __u + LY_ARRAY_COUNT(EXTS_P), RET, GOTO); \
168 LY_ARRAY_FOR(EXTS_P, __u) { \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200169 LY_ARRAY_INCREMENT(EXT_C); \
Radek Krejciab430862021-03-02 20:13:40 +0100170 RET = lys_compile_ext(CTX, &(EXTS_P)[__u], &(EXT_C)[LY_ARRAY_COUNT(EXT_C) - 1], PARENT, NULL); \
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100171 if (RET == LY_ENOT) { \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100172 LY_ARRAY_DECREMENT(EXT_C); \
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100173 RET = LY_SUCCESS; \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100174 } else if (RET) { \
175 goto GOTO; \
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100176 } \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200177 } \
178 }
179
180/**
181 * @brief Fill in the prepared compiled extension instance structure according to the parsed extension instance.
182 *
183 * @param[in] ctx Compilation context.
184 * @param[in] ext_p Parsed extension instance.
185 * @param[in,out] ext Prepared compiled extension instance.
186 * @param[in] parent Extension instance parent.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200187 * @param[in] ext_mod Optional module with the extension instance extension definition, set only for internal annotations.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100188 * @return LY_SUCCESS on success.
189 * @return LY_ENOT if the extension is disabled and should be ignored.
190 * @return LY_ERR on error.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200191 */
192LY_ERR lys_compile_ext(struct lysc_ctx *ctx, struct lysp_ext_instance *ext_p, struct lysc_ext_instance *ext, void *parent,
Radek Krejciab430862021-03-02 20:13:40 +0100193 const struct lys_module *ext_mod);
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200194
195/**
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200196 * @brief Find and process the referenced base identities from another identity or identityref
197 *
198 * For bases in identity set backlinks to them from the base identities. For identityref, store
199 * the array of pointers to the base identities. So one of the ident or bases parameter must be set
200 * to distinguish these two use cases.
201 *
202 * @param[in] ctx Compile context, not only for logging but also to get the current module to resolve prefixes.
203 * @param[in] base_pmod Module where to resolve @p bases_p prefixes.
204 * @param[in] bases_p Array of names (including prefix if necessary) of base identities.
205 * @param[in] ident Referencing identity to work with, NULL for identityref.
206 * @param[in] bases Array of bases of identityref to fill in.
207 * @return LY_ERR value.
208 */
209LY_ERR lys_compile_identity_bases(struct lysc_ctx *ctx, const struct lysp_module *base_pmod, const char **bases_p,
aPiecekf4a0a192021-08-03 15:14:17 +0200210 struct lysc_ident *ident, struct lysc_ident ***bases);
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200211
212/**
aPiecek6b3d5422021-07-30 15:55:43 +0200213 * @brief Perform a complet compilation of identites in a module and all its submodules.
214 *
215 * @param[in] mod Module to process.
216 * @return LY_ERR value.
217 */
218LY_ERR lys_compile_identities(struct lys_module *mod);
219
220/**
Michal Vaskoa9f807e2021-06-15 12:07:16 +0200221 * @brief Compile schema into a validated schema linking all the references. Must have been implemented before.
222 *
223 * @param[in] mod Pointer to the schema structure holding pointers to both schema structure types. The ::lys_module#parsed
224 * member is used as input and ::lys_module#compiled is used to hold the result of the compilation.
225 * @param[in,out] unres Dep set unres structure to add to.
226 * @return LY_SUCCESS on success.
227 * @return LY_ERR on error.
228 */
229LY_ERR lys_compile(struct lys_module *mod, struct lys_depset_unres *unres);
230
231/**
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200232 * @brief Check statement's status for invalid combination.
233 *
234 * The modX parameters are used just to determine if both flags are in the same module,
235 * so any of the schema module structure can be used, but both modules must be provided
236 * in the same type.
237 *
238 * @param[in] ctx Compile context for logging.
239 * @param[in] flags1 Flags of the referencing node.
240 * @param[in] mod1 Module of the referencing node,
241 * @param[in] name1 Schema node name of the referencing node.
242 * @param[in] flags2 Flags of the referenced node.
243 * @param[in] mod2 Module of the referenced node,
244 * @param[in] name2 Schema node name of the referenced node.
245 * @return LY_ERR value
246 */
247LY_ERR lysc_check_status(struct lysc_ctx *ctx, uint16_t flags1, void *mod1, const char *name1, uint16_t flags2,
248 void *mod2, const char *name2);
249
250/**
Michal Vasko25d6ad02020-10-22 12:20:22 +0200251 * @brief Check parsed expression for any prefixes of unimplemented modules.
252 *
253 * @param[in] ctx libyang context.
254 * @param[in] expr Parsed expression.
255 * @param[in] format Prefix format.
256 * @param[in] prefix_data Format-specific data (see ::ly_resolve_prefix()).
257 * @param[in] implement Whether all the non-implemented modules should are implemented or the first
258 * non-implemented module, if any, returned in @p mod_p.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100259 * @param[in,out] unres Global unres structure of newly implemented modules.
Michal Vasko25d6ad02020-10-22 12:20:22 +0200260 * @param[out] mod_p Module that is not implemented.
261 * @return LY_SUCCESS on success.
Michal Vasko40c158c2021-04-28 17:01:03 +0200262 * @return LY_ERECOMPILE if @p implement is set.
Michal Vasko25d6ad02020-10-22 12:20:22 +0200263 * @return LY_ERR on error.
264 */
Radek Krejci8df109d2021-04-23 12:19:08 +0200265LY_ERR lys_compile_expr_implement(const struct ly_ctx *ctx, const struct lyxp_expr *expr, LY_VALUE_FORMAT format,
Michal Vasko405cc9e2020-12-01 12:01:27 +0100266 void *prefix_data, ly_bool implement, struct lys_glob_unres *unres, const struct lys_module **mod_p);
267
268/**
Michal Vaskof4258e12021-06-15 12:11:42 +0200269 * @brief Compile all flagged modules in a dependency set, recursively if recompilation is needed.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100270 *
Michal Vasko50bc09a2021-06-17 17:31:56 +0200271 * Steps taken when adding a new module (::ly_ctx_load_module(), ::lys_parse()):
272 *
273 * 1) parse module and add it into context with all imports and includes also parsed and in context
Michal Vasko65988242021-07-15 09:19:16 +0200274 * (::lys_parse_load(), ::lys_parse_in(), lys_parse_localfile() - static)
Michal Vasko50bc09a2021-06-17 17:31:56 +0200275 * 2) implement it (perform one-time compilation tasks - compile identities and add reference to augment/deviation
276 * target modules, implement those as well, ::_lys_set_implemented())
277 * 3) create dep set of the module (::lys_unres_dep_sets_create())
278 * 4) (re)compile all the modules in the dep set and collect unres (::lys_compile_dep_set_r())
Michal Vasko65988242021-07-15 09:19:16 +0200279 * 5) resolve unres (lys_compile_unres_depset() - static), new modules may be implemented like in 2) and if
280 * require recompilation, free all compiled modules and do 4)
Michal Vasko50bc09a2021-06-17 17:31:56 +0200281 * 6) all modules that needed to be (re)compiled are now, with all their dependencies
282 *
283 * What can cause new modules to be implemented when resolving unres in 5):
284 * - leafref
285 * - when, must
Michal Vasko41369bd2021-06-23 12:03:23 +0200286 * - identityref, instance-identifier default value
Michal Vasko50bc09a2021-06-17 17:31:56 +0200287 * - new implemented module augments, deviations
288 *
Michal Vasko405cc9e2020-12-01 12:01:27 +0100289 * @param[in] ctx libyang context.
Michal Vaskof4258e12021-06-15 12:11:42 +0200290 * @param[in,out] unres Global unres to use.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100291 * @return LY_ERR value.
292 */
Michal Vasko709f9a52021-07-21 10:51:59 +0200293LY_ERR lys_compile_depset_all(struct ly_ctx *ctx, struct lys_glob_unres *unres);
Michal Vasko916aefb2020-11-02 15:43:16 +0100294
295/**
Michal Vaskoa9f807e2021-06-15 12:07:16 +0200296 * @brief Implement a single module. Does not actually compile, only marks to_compile!
Michal Vasko65333882021-06-10 14:12:16 +0200297 *
298 * @param[in] mod Module to implement.
299 * @param[in] features Features to set, see ::lys_set_features().
Michal Vaskoa9f807e2021-06-15 12:07:16 +0200300 * @param[in,out] unres Global unres to use.
301 * @return LY_ERR value.
Michal Vasko65333882021-06-10 14:12:16 +0200302 */
303LY_ERR lys_implement(struct lys_module *mod, const char **features, struct lys_glob_unres *unres);
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200304
305#endif /* LY_SCHEMA_COMPILE_H_ */