blob: 65e582c3a93d3a9f308f80d2db077ed4cc03594c [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
Radek Krejci47fab892020-11-05 17:02:41 +010022#include "dict.h"
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020023#include "log.h"
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020024#include "set.h"
Radek Krejci47fab892020-11-05 17:02:41 +010025#include "tree.h"
Radek Krejci859a15a2021-03-05 20:56:59 +010026#include "tree_edit.h"
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020027#include "tree_schema.h"
28
Radek Krejci47fab892020-11-05 17:02:41 +010029struct lyxp_expr;
30
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020031/**
Radek Krejci5f9a3672021-03-05 21:35:22 +010032 * @brief YANG schema compilation context.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020033 */
34struct lysc_ctx {
Radek Krejci5f9a3672021-03-05 21:35:22 +010035 struct ly_ctx *ctx; /**< libyang context */
Michal Vaskob8df5762021-01-12 15:15:53 +010036 struct lys_module *cur_mod; /**< module currently being compiled,
37 - identifier/path - used as the current module for unprefixed nodes
38 - augment - module where the augment is defined
39 - deviation - module where the deviation is defined
40 - uses - module where the uses is defined */
41 struct lysp_module *pmod; /**< parsed module being processed,
42 - identifier/path - used for searching imports to resolve prefixed nodes
43 - augment - module where the augment is defined
44 - deviation - module where the deviation is defined
45 - uses - module where the grouping is defined */
Radek Krejci6b88a462021-02-17 12:39:34 +010046 struct lysc_ext_instance *ext; /**< extension instance being processed and serving as a source for its substatements
47 instead of the module itself */
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020048 struct ly_set groupings; /**< stack for groupings circular check */
Radek Krejci5f9a3672021-03-05 21:35:22 +010049 struct ly_set tpdf_chain; /**< stack for typedefs circular check */
Radek Krejci5f9a3672021-03-05 21:35:22 +010050 struct ly_set augs; /**< set of compiled non-applied top-level augments (stored ::lysc_augment *) */
51 struct ly_set devs; /**< set of compiled non-applied deviations (stored ::lysc_deviation *) */
52 struct ly_set uses_augs; /**< set of compiled non-applied uses augments (stored ::lysc_augment *) */
53 struct ly_set uses_rfns; /**< set of compiled non-applied uses refines (stored ::lysc_refine *) */
Michal Vaskof4258e12021-06-15 12:11:42 +020054 struct lys_depset_unres *unres; /**< dependency set unres sets */
Radek Krejci5f9a3672021-03-05 21:35:22 +010055 uint32_t path_len; /**< number of path bytes used */
Michal Vasko7c565922021-06-10 14:58:27 +020056 uint32_t compile_opts; /**< various @ref scflags. */
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020057#define LYSC_CTX_BUFSIZE 4078
Radek Krejci5f9a3672021-03-05 21:35:22 +010058 char path[LYSC_CTX_BUFSIZE];/**< Path identifying the schema node currently being processed */
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020059};
60
61/**
Michal Vaskof4258e12021-06-15 12:11:42 +020062 * @brief Structure for unresolved items that may depend on any implemented module data in the dependency set
63 * so their resolution can only be performed after the whole dep set compilation is done.
Michal Vasko405cc9e2020-12-01 12:01:27 +010064 */
Michal Vaskof4258e12021-06-15 12:11:42 +020065struct lys_depset_unres {
aPiecekc6526b42021-07-12 15:21:39 +020066 struct ly_set xpath; /**< when/must to check */
67 struct ly_set leafrefs; /**< to validate target of leafrefs */
68 struct ly_set dflts; /**< set of incomplete default values */
69 struct ly_set disabled; /**< set of compiled nodes whose if-feature(s) was not satisfied (stored ::lysc_node *) */
70 struct ly_set disabled_leafrefs; /**< subset of the lys_depset_unres.disabled to validate target of disabled leafrefs */
Michal Vasko405cc9e2020-12-01 12:01:27 +010071};
72
73/**
Michal Vaskof4258e12021-06-15 12:11:42 +020074 * @brief Unres structure global for compilation.
75 */
76struct lys_glob_unres {
Michal Vasko709f9a52021-07-21 10:51:59 +020077 struct ly_set dep_sets; /**< set of dependency sets of modules, see ::lys_compile_depset_all() */
Michal Vaskof4258e12021-06-15 12:11:42 +020078 struct ly_set implementing; /**< set of YANG schemas being atomically implemented (compiled); the first added
Radek Krejci84d7fd72021-07-14 18:32:21 +020079 module is always the explicitly implemented module, the other ones are dependencies */
Michal Vaskof4258e12021-06-15 12:11:42 +020080 struct ly_set creating; /**< set of YANG schemas being atomically created (parsed); it is a subset of implemented
81 and all these modules are freed if any error occurs */
82 struct lys_depset_unres ds_unres; /**< unres specific for the current dependency set */
83};
84
85/**
Michal Vasko1a7a7bd2020-10-16 14:39:15 +020086 * @brief Structure for remembering default values of leaves and leaf-lists. They are resolved at schema compilation
87 * end when the whole schema tree is available.
88 */
89struct lysc_unres_dflt {
90 union {
91 struct lysc_node_leaf *leaf;
92 struct lysc_node_leaflist *llist;
93 };
94 struct lysp_qname *dflt;
95 struct lysp_qname *dflts; /**< this is a sized array */
96};
97
98/**
99 * @brief Duplicate string into dictionary
100 * @param[in] CTX libyang context of the dictionary.
101 * @param[in] ORIG String to duplicate.
102 * @param[out] DUP Where to store the result.
Radek Krejci84d7fd72021-07-14 18:32:21 +0200103 * @param[out] RET Where to store the return code.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200104 */
105#define DUP_STRING(CTX, ORIG, DUP, RET) if (ORIG) {RET = lydict_insert(CTX, ORIG, 0, &DUP);}
Radek Krejci771928a2021-01-19 13:42:36 +0100106#define DUP_STRING_RET(CTX, ORIG, DUP) if (ORIG) {LY_ERR __ret = lydict_insert(CTX, ORIG, 0, &DUP); LY_CHECK_RET(__ret);}
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200107#define DUP_STRING_GOTO(CTX, ORIG, DUP, RET, GOTO) if (ORIG) {LY_CHECK_GOTO(RET = lydict_insert(CTX, ORIG, 0, &DUP), GOTO);}
108
109#define DUP_ARRAY(CTX, ORIG_ARRAY, NEW_ARRAY, DUP_FUNC) \
110 if (ORIG_ARRAY) { \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100111 LY_ARRAY_COUNT_TYPE __u; \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200112 LY_ARRAY_CREATE_RET(CTX, NEW_ARRAY, LY_ARRAY_COUNT(ORIG_ARRAY), LY_EMEM); \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100113 LY_ARRAY_FOR(ORIG_ARRAY, __u) { \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200114 LY_ARRAY_INCREMENT(NEW_ARRAY); \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100115 LY_CHECK_RET(DUP_FUNC(CTX, &(NEW_ARRAY)[__u], &(ORIG_ARRAY)[__u])); \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200116 } \
117 }
118
Michal Vasko5347e3a2020-11-03 17:14:57 +0100119#define COMPILE_OP_ARRAY_GOTO(CTX, ARRAY_P, ARRAY_C, PARENT, FUNC, USES_STATUS, RET, GOTO) \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200120 if (ARRAY_P) { \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100121 LY_ARRAY_COUNT_TYPE __u = (ARRAY_C) ? LY_ARRAY_COUNT(ARRAY_C) : 0; \
122 LY_ARRAY_CREATE_GOTO((CTX)->ctx, ARRAY_C, __u + LY_ARRAY_COUNT(ARRAY_P), RET, GOTO); \
123 LY_ARRAY_FOR(ARRAY_P, __u) { \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200124 LY_ARRAY_INCREMENT(ARRAY_C); \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100125 RET = FUNC(CTX, &(ARRAY_P)[__u], PARENT, &(ARRAY_C)[LY_ARRAY_COUNT(ARRAY_C) - 1], USES_STATUS); \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200126 if (RET == LY_EDENIED) { \
127 LY_ARRAY_DECREMENT(ARRAY_C); \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100128 RET = LY_SUCCESS; \
129 } else if (RET) { \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200130 goto GOTO; \
131 } \
132 } \
133 }
134
Michal Vasko5347e3a2020-11-03 17:14:57 +0100135#define COMPILE_ARRAY_GOTO(CTX, ARRAY_P, ARRAY_C, FUNC, RET, GOTO) \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200136 if (ARRAY_P) { \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100137 LY_ARRAY_COUNT_TYPE __u = (ARRAY_C) ? LY_ARRAY_COUNT(ARRAY_C) : 0; \
138 LY_ARRAY_CREATE_GOTO((CTX)->ctx, ARRAY_C, __u + LY_ARRAY_COUNT(ARRAY_P), RET, GOTO); \
139 LY_ARRAY_FOR(ARRAY_P, __u) { \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200140 LY_ARRAY_INCREMENT(ARRAY_C); \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100141 RET = FUNC(CTX, &(ARRAY_P)[__u], &(ARRAY_C)[LY_ARRAY_COUNT(ARRAY_C) - 1]); \
142 LY_CHECK_GOTO(RET, GOTO); \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200143 } \
144 }
145
Radek Krejciab430862021-03-02 20:13:40 +0100146#define COMPILE_EXTS_GOTO(CTX, EXTS_P, EXT_C, PARENT, RET, GOTO) \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200147 if (EXTS_P) { \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100148 LY_ARRAY_COUNT_TYPE __u = (EXT_C) ? LY_ARRAY_COUNT(EXT_C) : 0; \
149 LY_ARRAY_CREATE_GOTO((CTX)->ctx, EXT_C, __u + LY_ARRAY_COUNT(EXTS_P), RET, GOTO); \
150 LY_ARRAY_FOR(EXTS_P, __u) { \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200151 LY_ARRAY_INCREMENT(EXT_C); \
Radek Krejciab430862021-03-02 20:13:40 +0100152 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 +0100153 if (RET == LY_ENOT) { \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100154 LY_ARRAY_DECREMENT(EXT_C); \
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100155 RET = LY_SUCCESS; \
Michal Vasko5347e3a2020-11-03 17:14:57 +0100156 } else if (RET) { \
157 goto GOTO; \
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100158 } \
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200159 } \
160 }
161
162/**
163 * @brief Fill in the prepared compiled extension instance structure according to the parsed extension instance.
164 *
165 * @param[in] ctx Compilation context.
166 * @param[in] ext_p Parsed extension instance.
167 * @param[in,out] ext Prepared compiled extension instance.
168 * @param[in] parent Extension instance parent.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200169 * @param[in] ext_mod Optional module with the extension instance extension definition, set only for internal annotations.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100170 * @return LY_SUCCESS on success.
171 * @return LY_ENOT if the extension is disabled and should be ignored.
172 * @return LY_ERR on error.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200173 */
174LY_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 +0100175 const struct lys_module *ext_mod);
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200176
177/**
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200178 * @brief Compile information from the identity statement
179 *
Radek Krejci8678fa42020-08-18 16:07:28 +0200180 * The backlinks to the identities derived from this one are supposed to be filled later via ::lys_compile_identity_bases().
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200181 *
182 * @param[in] ctx_sc Compile context - alternative to the combination of @p ctx and @p parsed_mod.
183 * @param[in] ctx libyang context.
184 * @param[in] parsed_mod Module with the identities.
185 * @param[in] identities_p Array of the parsed identity definitions to precompile.
186 * @param[in,out] identities Pointer to the storage of the (pre)compiled identities array where the new identities are
187 * supposed to be added. The storage is supposed to be initiated to NULL when the first parsed identities are going
188 * to be processed.
189 * @return LY_ERR value.
190 */
191LY_ERR lys_identity_precompile(struct lysc_ctx *ctx_sc, struct ly_ctx *ctx, struct lysp_module *parsed_mod,
192 struct lysp_ident *identities_p, struct lysc_ident **identities);
193
194/**
195 * @brief Find and process the referenced base identities from another identity or identityref
196 *
197 * For bases in identity set backlinks to them from the base identities. For identityref, store
198 * the array of pointers to the base identities. So one of the ident or bases parameter must be set
199 * to distinguish these two use cases.
200 *
201 * @param[in] ctx Compile context, not only for logging but also to get the current module to resolve prefixes.
202 * @param[in] base_pmod Module where to resolve @p bases_p prefixes.
203 * @param[in] bases_p Array of names (including prefix if necessary) of base identities.
204 * @param[in] ident Referencing identity to work with, NULL for identityref.
205 * @param[in] bases Array of bases of identityref to fill in.
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100206 * @param[in] enabled Whether the base is disabled, must be set if @p ident is set.
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200207 * @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,
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100210 struct lysc_ident *ident, struct lysc_ident ***bases, ly_bool *enabled);
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200211
212/**
Michal Vaskoa9f807e2021-06-15 12:07:16 +0200213 * @brief Compile schema into a validated schema linking all the references. Must have been implemented before.
214 *
215 * @param[in] mod Pointer to the schema structure holding pointers to both schema structure types. The ::lys_module#parsed
216 * member is used as input and ::lys_module#compiled is used to hold the result of the compilation.
217 * @param[in,out] unres Dep set unres structure to add to.
218 * @return LY_SUCCESS on success.
219 * @return LY_ERR on error.
220 */
221LY_ERR lys_compile(struct lys_module *mod, struct lys_depset_unres *unres);
222
223/**
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200224 * @brief Check statement's status for invalid combination.
225 *
226 * The modX parameters are used just to determine if both flags are in the same module,
227 * so any of the schema module structure can be used, but both modules must be provided
228 * in the same type.
229 *
230 * @param[in] ctx Compile context for logging.
231 * @param[in] flags1 Flags of the referencing node.
232 * @param[in] mod1 Module of the referencing node,
233 * @param[in] name1 Schema node name of the referencing node.
234 * @param[in] flags2 Flags of the referenced node.
235 * @param[in] mod2 Module of the referenced node,
236 * @param[in] name2 Schema node name of the referenced node.
237 * @return LY_ERR value
238 */
239LY_ERR lysc_check_status(struct lysc_ctx *ctx, uint16_t flags1, void *mod1, const char *name1, uint16_t flags2,
240 void *mod2, const char *name2);
241
242/**
Michal Vasko25d6ad02020-10-22 12:20:22 +0200243 * @brief Check parsed expression for any prefixes of unimplemented modules.
244 *
245 * @param[in] ctx libyang context.
246 * @param[in] expr Parsed expression.
247 * @param[in] format Prefix format.
248 * @param[in] prefix_data Format-specific data (see ::ly_resolve_prefix()).
249 * @param[in] implement Whether all the non-implemented modules should are implemented or the first
250 * non-implemented module, if any, returned in @p mod_p.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100251 * @param[in,out] unres Global unres structure of newly implemented modules.
Michal Vasko25d6ad02020-10-22 12:20:22 +0200252 * @param[out] mod_p Module that is not implemented.
253 * @return LY_SUCCESS on success.
Michal Vasko40c158c2021-04-28 17:01:03 +0200254 * @return LY_ERECOMPILE if @p implement is set.
Michal Vasko25d6ad02020-10-22 12:20:22 +0200255 * @return LY_ERR on error.
256 */
Radek Krejci8df109d2021-04-23 12:19:08 +0200257LY_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 +0100258 void *prefix_data, ly_bool implement, struct lys_glob_unres *unres, const struct lys_module **mod_p);
259
260/**
Michal Vaskof4258e12021-06-15 12:11:42 +0200261 * @brief Compile all flagged modules in a dependency set, recursively if recompilation is needed.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100262 *
Michal Vasko50bc09a2021-06-17 17:31:56 +0200263 * Steps taken when adding a new module (::ly_ctx_load_module(), ::lys_parse()):
264 *
265 * 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 +0200266 * (::lys_parse_load(), ::lys_parse_in(), lys_parse_localfile() - static)
Michal Vasko50bc09a2021-06-17 17:31:56 +0200267 * 2) implement it (perform one-time compilation tasks - compile identities and add reference to augment/deviation
268 * target modules, implement those as well, ::_lys_set_implemented())
269 * 3) create dep set of the module (::lys_unres_dep_sets_create())
270 * 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 +0200271 * 5) resolve unres (lys_compile_unres_depset() - static), new modules may be implemented like in 2) and if
272 * require recompilation, free all compiled modules and do 4)
Michal Vasko50bc09a2021-06-17 17:31:56 +0200273 * 6) all modules that needed to be (re)compiled are now, with all their dependencies
274 *
275 * What can cause new modules to be implemented when resolving unres in 5):
276 * - leafref
277 * - when, must
Michal Vasko41369bd2021-06-23 12:03:23 +0200278 * - identityref, instance-identifier default value
Michal Vasko50bc09a2021-06-17 17:31:56 +0200279 * - new implemented module augments, deviations
280 *
Michal Vasko405cc9e2020-12-01 12:01:27 +0100281 * @param[in] ctx libyang context.
Michal Vaskof4258e12021-06-15 12:11:42 +0200282 * @param[in,out] unres Global unres to use.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100283 * @return LY_ERR value.
284 */
Michal Vasko709f9a52021-07-21 10:51:59 +0200285LY_ERR lys_compile_depset_all(struct ly_ctx *ctx, struct lys_glob_unres *unres);
Michal Vasko916aefb2020-11-02 15:43:16 +0100286
287/**
Michal Vaskoa9f807e2021-06-15 12:07:16 +0200288 * @brief Implement a single module. Does not actually compile, only marks to_compile!
Michal Vasko65333882021-06-10 14:12:16 +0200289 *
290 * @param[in] mod Module to implement.
291 * @param[in] features Features to set, see ::lys_set_features().
Michal Vaskoa9f807e2021-06-15 12:07:16 +0200292 * @param[in,out] unres Global unres to use.
293 * @return LY_ERR value.
Michal Vasko65333882021-06-10 14:12:16 +0200294 */
295LY_ERR lys_implement(struct lys_module *mod, const char **features, struct lys_glob_unres *unres);
Michal Vasko1a7a7bd2020-10-16 14:39:15 +0200296
297#endif /* LY_SCHEMA_COMPILE_H_ */