blob: a64e66802b46b856122f7bad0f0b3c46705cb591 [file] [log] [blame]
Michal Vasko004d3152020-06-11 19:59:22 +02001/**
2 * @file path.c
3 * @author Michal Vasko <mvasko@cesnet.cz>
4 * @brief Path functions
5 *
6 * Copyright (c) 2020 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#define _ISOC99_SOURCE /* strtoull */
15
16#include "path.h"
17
18#include <assert.h>
19#include <ctype.h>
20#include <stdlib.h>
Radek Krejciad97c5f2020-06-30 09:19:28 +020021#include <string.h>
Michal Vasko004d3152020-06-11 19:59:22 +020022
23#include "common.h"
Michal Vasko5aa44c02020-06-29 11:47:02 +020024#include "compat.h"
Michal Vasko004d3152020-06-11 19:59:22 +020025#include "log.h"
26#include "plugins_types.h"
Radek Krejciad97c5f2020-06-30 09:19:28 +020027#include "set.h"
Michal Vasko4c583e82020-07-17 12:16:14 +020028#include "tree.h"
Michal Vasko004d3152020-06-11 19:59:22 +020029#include "tree_data_internal.h"
Radek Krejciad97c5f2020-06-30 09:19:28 +020030#include "tree_schema.h"
Michal Vasko004d3152020-06-11 19:59:22 +020031#include "tree_schema_internal.h"
32#include "xpath.h"
33
Radek Krejcic0c66412020-08-21 13:53:50 +020034#define LOGVAL_P(CTX, CUR_NODE, CODE, ...) ly_vlog(CTX, (CUR_NODE) ? LY_VLOG_LYSC : LY_VLOG_NONE, CUR_NODE, CODE, ##__VA_ARGS__)
Michal Vasko6b26e742020-07-17 15:02:10 +020035
Michal Vasko004d3152020-06-11 19:59:22 +020036/**
37 * @brief Check predicate syntax.
38 *
39 * @param[in] ctx libyang context.
Michal Vasko6b26e742020-07-17 15:02:10 +020040 * @param[in] cur_node Current (original context) node.
Michal Vasko004d3152020-06-11 19:59:22 +020041 * @param[in] exp Parsed predicate.
42 * @param[in,out] tok_idx Index in @p exp, is adjusted.
43 * @param[in] prefix Prefix option.
44 * @param[in] pred Predicate option.
45 * @return LY_ERR value.
46 */
47static LY_ERR
Michal Vasko6b26e742020-07-17 15:02:10 +020048ly_path_check_predicate(const struct ly_ctx *ctx, const struct lysc_node *cur_node, const struct lyxp_expr *exp,
Radek Krejci0f969882020-08-21 16:56:47 +020049 uint16_t *tok_idx, uint8_t prefix, uint8_t pred)
Michal Vasko004d3152020-06-11 19:59:22 +020050{
Radek Krejciba03a5a2020-08-27 14:40:41 +020051 LY_ERR ret = LY_SUCCESS;
Michal Vasko004d3152020-06-11 19:59:22 +020052 struct ly_set *set = NULL;
53 uint32_t i;
54 const char *name;
55 size_t name_len;
56
Michal Vasko004d3152020-06-11 19:59:22 +020057 if (!lyxp_next_token(NULL, exp, tok_idx, LYXP_TOKEN_BRACK1)) {
Radek Krejcif6a11002020-08-21 13:29:07 +020058 /* '[' */
59
Michal Vasko69730152020-10-09 16:30:07 +020060 if (((pred == LY_PATH_PRED_SIMPLE) || (pred == LY_PATH_PRED_KEYS)) &&
61 !lyxp_check_token(NULL, exp, *tok_idx, LYXP_TOKEN_NAMETEST)) {
Radek Krejciba03a5a2020-08-27 14:40:41 +020062 ret = ly_set_new(&set);
63 LY_CHECK_GOTO(ret, cleanup);
Michal Vasko004d3152020-06-11 19:59:22 +020064
65 do {
66 /* NameTest is always expected here */
Radek Krejciba03a5a2020-08-27 14:40:41 +020067 LY_CHECK_GOTO(lyxp_check_token(ctx, exp, *tok_idx, LYXP_TOKEN_NAMETEST), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +020068
69 /* check prefix based on the options */
70 name = strnstr(exp->expr + exp->tok_pos[*tok_idx], ":", exp->tok_len[*tok_idx]);
71 if ((prefix == LY_PATH_PREFIX_MANDATORY) && !name) {
Michal Vasko6b26e742020-07-17 15:02:10 +020072 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Prefix missing for \"%.*s\" in path.", exp->tok_len[*tok_idx],
Michal Vasko69730152020-10-09 16:30:07 +020073 exp->expr + exp->tok_pos[*tok_idx]);
Radek Krejciba03a5a2020-08-27 14:40:41 +020074 goto token_error;
Michal Vasko8b06a5e2020-08-06 12:13:08 +020075 } else if ((prefix == LY_PATH_PREFIX_STRICT_INHERIT) && name) {
76 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Redundant prefix for \"%.*s\" in path.", exp->tok_len[*tok_idx],
Michal Vasko69730152020-10-09 16:30:07 +020077 exp->expr + exp->tok_pos[*tok_idx]);
Radek Krejciba03a5a2020-08-27 14:40:41 +020078 goto token_error;
Michal Vasko004d3152020-06-11 19:59:22 +020079 }
80 if (!name) {
81 name = exp->expr + exp->tok_pos[*tok_idx];
82 name_len = exp->tok_len[*tok_idx];
83 } else {
84 ++name;
85 name_len = exp->tok_len[*tok_idx] - (name - (exp->expr + exp->tok_pos[*tok_idx]));
86 }
87
88 /* check whether it was not already specified */
89 for (i = 0; i < set->count; ++i) {
90 /* all the keys must be from the same module so this comparison should be fine */
91 if (!strncmp(set->objs[i], name, name_len) && !isalpha(((char *)set->objs[i])[name_len])) {
Michal Vasko6b26e742020-07-17 15:02:10 +020092 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Duplicate predicate key \"%.*s\" in path.", name_len, name);
Radek Krejciba03a5a2020-08-27 14:40:41 +020093 goto token_error;
Michal Vasko004d3152020-06-11 19:59:22 +020094 }
95 }
96
97 /* add it into the set */
Radek Krejci3d92e442020-10-12 12:48:13 +020098 ret = ly_set_add(set, (void *)name, 1, NULL);
Radek Krejciba03a5a2020-08-27 14:40:41 +020099 LY_CHECK_GOTO(ret, cleanup);
Michal Vasko004d3152020-06-11 19:59:22 +0200100
101 /* NameTest */
102 ++(*tok_idx);
103
104 /* '=' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200105 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_OPER_EQUAL), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200106
107 /* Literal */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200108 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_LITERAL), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200109
110 /* ']' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200111 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_BRACK2), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200112
Radek Krejci0f969882020-08-21 16:56:47 +0200113 /* '[' */
Michal Vasko004d3152020-06-11 19:59:22 +0200114 } while (!lyxp_next_token(NULL, exp, tok_idx, LYXP_TOKEN_BRACK1));
115
Michal Vasko004d3152020-06-11 19:59:22 +0200116 } else if ((pred == LY_PATH_PRED_SIMPLE) && !lyxp_next_token(NULL, exp, tok_idx, LYXP_TOKEN_DOT)) {
Radek Krejcif6a11002020-08-21 13:29:07 +0200117 /* '.' */
118
Michal Vasko004d3152020-06-11 19:59:22 +0200119 /* '=' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200120 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_OPER_EQUAL), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200121
122 /* Literal */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200123 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_LITERAL), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200124
125 /* ']' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200126 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_BRACK2), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200127
Michal Vasko004d3152020-06-11 19:59:22 +0200128 } else if ((pred == LY_PATH_PRED_SIMPLE) && !lyxp_next_token(NULL, exp, tok_idx, LYXP_TOKEN_NUMBER)) {
Radek Krejcif6a11002020-08-21 13:29:07 +0200129 /* Number */
Michal Vasko004d3152020-06-11 19:59:22 +0200130
131 /* ']' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200132 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_BRACK2), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200133
134 } else if ((pred == LY_PATH_PRED_LEAFREF) && !lyxp_check_token(NULL, exp, *tok_idx, LYXP_TOKEN_NAMETEST)) {
135 assert(prefix == LY_PATH_PREFIX_OPTIONAL);
Radek Krejciba03a5a2020-08-27 14:40:41 +0200136 ret = ly_set_new(&set);
137 LY_CHECK_GOTO(ret, cleanup);
Michal Vasko004d3152020-06-11 19:59:22 +0200138
139 do {
140 /* NameTest is always expected here */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200141 LY_CHECK_GOTO(lyxp_check_token(ctx, exp, *tok_idx, LYXP_TOKEN_NAMETEST), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200142
143 name = strnstr(exp->expr + exp->tok_pos[*tok_idx], ":", exp->tok_len[*tok_idx]);
144 if (!name) {
145 name = exp->expr + exp->tok_pos[*tok_idx];
146 name_len = exp->tok_len[*tok_idx];
147 } else {
148 ++name;
149 name_len = exp->tok_len[*tok_idx] - (name - (exp->expr + exp->tok_pos[*tok_idx]));
150 }
151
152 /* check whether it was not already specified */
153 for (i = 0; i < set->count; ++i) {
154 /* all the keys must be from the same module so this comparison should be fine */
155 if (!strncmp(set->objs[i], name, name_len) && !isalpha(((char *)set->objs[i])[name_len])) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200156 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Duplicate predicate key \"%.*s\" in path.", name_len, name);
Radek Krejciba03a5a2020-08-27 14:40:41 +0200157 goto token_error;
Michal Vasko004d3152020-06-11 19:59:22 +0200158 }
159 }
160
161 /* add it into the set */
Radek Krejci3d92e442020-10-12 12:48:13 +0200162 ret = ly_set_add(set, (void *)name, 1, NULL);
Radek Krejciba03a5a2020-08-27 14:40:41 +0200163 LY_CHECK_GOTO(ret, cleanup);
Michal Vasko004d3152020-06-11 19:59:22 +0200164
165 /* NameTest */
166 ++(*tok_idx);
167
168 /* '=' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200169 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_OPER_EQUAL), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200170
171 /* FuncName */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200172 LY_CHECK_GOTO(lyxp_check_token(ctx, exp, *tok_idx, LYXP_TOKEN_FUNCNAME), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200173 if ((exp->tok_len[*tok_idx] != 7) || strncmp(exp->expr + exp->tok_pos[*tok_idx], "current", 7)) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200174 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Invalid function \"%.*s\" invocation in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200175 exp->tok_len[*tok_idx], exp->expr + exp->tok_pos[*tok_idx]);
Radek Krejciba03a5a2020-08-27 14:40:41 +0200176 goto token_error;
Michal Vasko004d3152020-06-11 19:59:22 +0200177 }
178 ++(*tok_idx);
179
180 /* '(' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200181 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_PAR1), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200182
183 /* ')' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200184 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_PAR2), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200185
186 /* '/' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200187 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_OPER_PATH), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200188
189 /* '..' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200190 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_DDOT), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200191 do {
192 /* '/' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200193 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_OPER_PATH), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200194 } while (!lyxp_next_token(NULL, exp, tok_idx, LYXP_TOKEN_DDOT));
195
196 /* NameTest */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200197 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_NAMETEST), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200198
199 /* '/' */
200 while (!lyxp_next_token(NULL, exp, tok_idx, LYXP_TOKEN_OPER_PATH)) {
201 /* NameTest */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200202 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_NAMETEST), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200203 }
204
205 /* ']' */
Radek Krejciba03a5a2020-08-27 14:40:41 +0200206 LY_CHECK_GOTO(lyxp_next_token(ctx, exp, tok_idx, LYXP_TOKEN_BRACK2), token_error);
Michal Vasko004d3152020-06-11 19:59:22 +0200207
Radek Krejci0f969882020-08-21 16:56:47 +0200208 /* '[' */
Michal Vasko004d3152020-06-11 19:59:22 +0200209 } while (!lyxp_next_token(NULL, exp, tok_idx, LYXP_TOKEN_BRACK1));
210
211 } else {
Michal Vasko6b26e742020-07-17 15:02:10 +0200212 LOGVAL_P(ctx, cur_node, LY_VCODE_XP_INTOK, lyxp_print_token(exp->tokens[*tok_idx]),
Michal Vasko69730152020-10-09 16:30:07 +0200213 exp->expr + exp->tok_pos[*tok_idx]);
Radek Krejciba03a5a2020-08-27 14:40:41 +0200214 goto token_error;
Michal Vasko004d3152020-06-11 19:59:22 +0200215 }
216 }
217
Radek Krejciba03a5a2020-08-27 14:40:41 +0200218cleanup:
Michal Vasko004d3152020-06-11 19:59:22 +0200219 ly_set_free(set, NULL);
Radek Krejciba03a5a2020-08-27 14:40:41 +0200220 return ret;
Michal Vasko004d3152020-06-11 19:59:22 +0200221
Radek Krejciba03a5a2020-08-27 14:40:41 +0200222token_error:
Michal Vasko004d3152020-06-11 19:59:22 +0200223 ly_set_free(set, NULL);
224 return LY_EVALID;
225}
226
227LY_ERR
Michal Vasko6b26e742020-07-17 15:02:10 +0200228ly_path_parse(const struct ly_ctx *ctx, const struct lysc_node *ctx_node, const char *str_path, size_t path_len,
Radek Krejci0f969882020-08-21 16:56:47 +0200229 uint8_t begin, uint8_t lref, uint8_t prefix, uint8_t pred, struct lyxp_expr **expr)
Michal Vasko004d3152020-06-11 19:59:22 +0200230{
Radek Krejcif03a9e22020-09-18 20:09:31 +0200231 LY_ERR ret = LY_SUCCESS;
232 struct lyxp_expr *exp = NULL;
Michal Vasko8b06a5e2020-08-06 12:13:08 +0200233 uint16_t tok_idx, cur_len;
234 const char *cur_node, *prev_prefix = NULL, *ptr;
Michal Vasko004d3152020-06-11 19:59:22 +0200235
236 assert((begin == LY_PATH_BEGIN_ABSOLUTE) || (begin == LY_PATH_BEGIN_EITHER));
237 assert((lref == LY_PATH_LREF_TRUE) || (lref == LY_PATH_LREF_FALSE));
Michal Vasko69730152020-10-09 16:30:07 +0200238 assert((prefix == LY_PATH_PREFIX_OPTIONAL) || (prefix == LY_PATH_PREFIX_MANDATORY) ||
239 (prefix == LY_PATH_PREFIX_STRICT_INHERIT));
Michal Vasko004d3152020-06-11 19:59:22 +0200240 assert((pred == LY_PATH_PRED_KEYS) || (pred == LY_PATH_PRED_SIMPLE) || (pred == LY_PATH_PRED_LEAFREF));
241
242 /* parse as a generic XPath expression */
Radek Krejcif03a9e22020-09-18 20:09:31 +0200243 LY_CHECK_GOTO(ret = lyxp_expr_parse(ctx, str_path, path_len, 1, &exp), error);
Michal Vasko004d3152020-06-11 19:59:22 +0200244 tok_idx = 0;
245
246 if (begin == LY_PATH_BEGIN_EITHER) {
247 /* is the path relative? */
248 if (lyxp_next_token(NULL, exp, &tok_idx, LYXP_TOKEN_OPER_PATH)) {
Michal Vaskocb8c6d42020-10-16 11:58:30 +0200249 /* relative path check specific to leafref */
250 if (lref == LY_PATH_LREF_TRUE) {
251 /* mandatory '..' */
252 LY_CHECK_ERR_GOTO(lyxp_next_token(ctx, exp, &tok_idx, LYXP_TOKEN_DDOT), ret = LY_EVALID, error);
253
254 do {
255 /* '/' */
256 LY_CHECK_ERR_GOTO(lyxp_next_token(ctx, exp, &tok_idx, LYXP_TOKEN_OPER_PATH), ret = LY_EVALID, error);
257
258 /* optional '..' */
259 } while (!lyxp_next_token(NULL, exp, &tok_idx, LYXP_TOKEN_DDOT));
Michal Vasko004d3152020-06-11 19:59:22 +0200260 }
261 }
262 } else {
263 /* '/' */
Radek Krejcif03a9e22020-09-18 20:09:31 +0200264 LY_CHECK_ERR_GOTO(lyxp_next_token(ctx, exp, &tok_idx, LYXP_TOKEN_OPER_PATH), ret = LY_EVALID, error);
Michal Vasko004d3152020-06-11 19:59:22 +0200265 }
266
267 do {
268 /* NameTest */
Radek Krejcif03a9e22020-09-18 20:09:31 +0200269 LY_CHECK_ERR_GOTO(lyxp_check_token(ctx, exp, tok_idx, LYXP_TOKEN_NAMETEST), ret = LY_EVALID, error);
Michal Vasko004d3152020-06-11 19:59:22 +0200270
271 /* check prefix based on the options */
Michal Vasko8b06a5e2020-08-06 12:13:08 +0200272 cur_node = exp->expr + exp->tok_pos[tok_idx];
273 cur_len = exp->tok_len[tok_idx];
274 if (prefix == LY_PATH_PREFIX_MANDATORY) {
275 if (!strnstr(cur_node, ":", cur_len)) {
276 LOGVAL_P(ctx, ctx_node, LYVE_XPATH, "Prefix missing for \"%.*s\" in path.", cur_len, cur_node);
Radek Krejcif03a9e22020-09-18 20:09:31 +0200277 ret = LY_EVALID;
Michal Vasko8b06a5e2020-08-06 12:13:08 +0200278 goto error;
279 }
280 } else if (prefix == LY_PATH_PREFIX_STRICT_INHERIT) {
281 if (!prev_prefix) {
282 /* the first node must have a prefix */
283 if (!strnstr(cur_node, ":", cur_len)) {
284 LOGVAL_P(ctx, ctx_node, LYVE_XPATH, "Prefix missing for \"%.*s\" in path.", cur_len, cur_node);
Radek Krejcif03a9e22020-09-18 20:09:31 +0200285 ret = LY_EVALID;
Michal Vasko8b06a5e2020-08-06 12:13:08 +0200286 goto error;
287 }
288
289 /* remember the first prefix */
290 prev_prefix = cur_node;
291 } else {
292 /* the prefix must be different, if any */
293 ptr = strnstr(cur_node, ":", cur_len);
294 if (ptr) {
295 if (!strncmp(prev_prefix, cur_node, ptr - cur_node) && (prev_prefix[ptr - cur_node] == ':')) {
296 LOGVAL_P(ctx, ctx_node, LYVE_XPATH, "Duplicate prefix for \"%.*s\" in path.", cur_len, cur_node);
Radek Krejcif03a9e22020-09-18 20:09:31 +0200297 ret = LY_EVALID;
Michal Vasko8b06a5e2020-08-06 12:13:08 +0200298 goto error;
299 }
300
301 /* remember this next prefix */
302 prev_prefix = cur_node;
303 }
304 }
Michal Vasko004d3152020-06-11 19:59:22 +0200305 }
306
307 ++tok_idx;
308
309 /* Predicate* */
Radek Krejcif03a9e22020-09-18 20:09:31 +0200310 LY_CHECK_GOTO(ret = ly_path_check_predicate(ctx, ctx_node, exp, &tok_idx, prefix, pred), error);
Michal Vasko004d3152020-06-11 19:59:22 +0200311
Radek Krejci0f969882020-08-21 16:56:47 +0200312 /* '/' */
Michal Vasko004d3152020-06-11 19:59:22 +0200313 } while (!lyxp_next_token(NULL, exp, &tok_idx, LYXP_TOKEN_OPER_PATH));
314
315 /* trailing token check */
316 if (exp->used > tok_idx) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200317 LOGVAL_P(ctx, ctx_node, LYVE_XPATH, "Unparsed characters \"%s\" left at the end of path.",
Michal Vasko69730152020-10-09 16:30:07 +0200318 exp->expr + exp->tok_pos[tok_idx]);
Radek Krejcif03a9e22020-09-18 20:09:31 +0200319 ret = LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200320 goto error;
321 }
322
323 *expr = exp;
324 return LY_SUCCESS;
325
326error:
327 lyxp_expr_free(ctx, exp);
Radek Krejcif03a9e22020-09-18 20:09:31 +0200328 return ret;
Michal Vasko004d3152020-06-11 19:59:22 +0200329}
330
331LY_ERR
Michal Vasko6b26e742020-07-17 15:02:10 +0200332ly_path_parse_predicate(const struct ly_ctx *ctx, const struct lysc_node *cur_node, const char *str_path,
Radek Krejci0f969882020-08-21 16:56:47 +0200333 size_t path_len, uint8_t prefix, uint8_t pred, struct lyxp_expr **expr)
Michal Vasko004d3152020-06-11 19:59:22 +0200334{
Radek Krejcif03a9e22020-09-18 20:09:31 +0200335 LY_ERR ret = LY_SUCCESS;
336 struct lyxp_expr *exp = NULL;
Michal Vasko004d3152020-06-11 19:59:22 +0200337 uint16_t tok_idx;
338
339 assert((prefix == LY_PATH_PREFIX_OPTIONAL) || (prefix == LY_PATH_PREFIX_MANDATORY));
340 assert((pred == LY_PATH_PRED_KEYS) || (pred == LY_PATH_PRED_SIMPLE) || (pred == LY_PATH_PRED_LEAFREF));
341
342 /* parse as a generic XPath expression */
Radek Krejcif03a9e22020-09-18 20:09:31 +0200343 LY_CHECK_GOTO(ret = lyxp_expr_parse(ctx, str_path, path_len, 0, &exp), error);
Michal Vasko004d3152020-06-11 19:59:22 +0200344 tok_idx = 0;
345
Radek Krejcif03a9e22020-09-18 20:09:31 +0200346 LY_CHECK_GOTO(ret = ly_path_check_predicate(ctx, cur_node, exp, &tok_idx, prefix, pred), error);
Michal Vasko004d3152020-06-11 19:59:22 +0200347
348 /* trailing token check */
349 if (exp->used > tok_idx) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200350 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Unparsed characters \"%s\" left at the end of predicate.",
Michal Vasko69730152020-10-09 16:30:07 +0200351 exp->expr + exp->tok_pos[tok_idx]);
Radek Krejcif03a9e22020-09-18 20:09:31 +0200352 ret = LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200353 goto error;
354 }
355
356 *expr = exp;
357 return LY_SUCCESS;
358
359error:
360 lyxp_expr_free(ctx, exp);
Radek Krejcif03a9e22020-09-18 20:09:31 +0200361 return ret;
Michal Vasko004d3152020-06-11 19:59:22 +0200362}
363
364/**
365 * @brief Parse prefix from a NameTest, if any, and node name, and return expected module of the node.
366 *
Michal Vasko00cbf532020-06-15 13:58:47 +0200367 * @param[in] ctx libyang context.
Michal Vasko6b26e742020-07-17 15:02:10 +0200368 * @param[in] cur_node Optional current (original context) node.
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200369 * @param[in] cur_mod Current module of the path (where the path is "instantiated"). Needed for ::LY_PREF_SCHEMA*.
370 * @param[in] prev_ctx_node Previous context node. Needed for ::LY_PREF_JSON.
Michal Vasko004d3152020-06-11 19:59:22 +0200371 * @param[in] expr Parsed path.
372 * @param[in] tok_idx Index in @p expr.
373 * @param[in] lref Lref option.
Michal Vasko004d3152020-06-11 19:59:22 +0200374 * @param[in] format Format of the path.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200375 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vasko004d3152020-06-11 19:59:22 +0200376 * @param[out] mod Resolved module.
377 * @param[out] name Parsed node name.
378 * @param[out] name_len Length of @p name.
379 * @return LY_ERR value.
380 */
381static LY_ERR
Michal Vasko6b26e742020-07-17 15:02:10 +0200382ly_path_compile_prefix(const struct ly_ctx *ctx, const struct lysc_node *cur_node, const struct lys_module *cur_mod,
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200383 const struct lysc_node *prev_ctx_node, const struct lyxp_expr *expr, uint16_t tok_idx, uint8_t lref,
384 LY_PREFIX_FORMAT format, void *prefix_data, const struct lys_module **mod, const char **name, size_t *name_len)
Michal Vasko004d3152020-06-11 19:59:22 +0200385{
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200386 const char *pref;
Michal Vasko004d3152020-06-11 19:59:22 +0200387 size_t len;
388
389 assert(expr->tokens[tok_idx] == LYXP_TOKEN_NAMETEST);
390
391 /* get prefix */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200392 if ((pref = strnstr(expr->expr + expr->tok_pos[tok_idx], ":", expr->tok_len[tok_idx]))) {
393 len = pref - (expr->expr + expr->tok_pos[tok_idx]);
394 pref = expr->expr + expr->tok_pos[tok_idx];
395 } else {
396 len = 0;
397 }
Michal Vasko004d3152020-06-11 19:59:22 +0200398
399 /* find next node module */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200400 if (pref) {
401 *mod = ly_resolve_prefix(ctx, pref, len, format, prefix_data);
Michal Vasko004d3152020-06-11 19:59:22 +0200402 if (!*mod) {
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200403 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Prefix \"%.*s\" not found of a module in path.", len, pref);
Radek Krejci8de005f2020-06-25 17:02:07 +0200404 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200405 } else if (!(*mod)->implemented) {
406 if (lref == LY_PATH_LREF_FALSE) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200407 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Not implemented module \"%s\" in path.", (*mod)->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200408 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200409 }
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100410 LY_CHECK_RET(lys_set_implemented((struct lys_module *)*mod, NULL));
Michal Vasko004d3152020-06-11 19:59:22 +0200411 }
412 } else {
413 switch (format) {
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200414 case LY_PREF_SCHEMA:
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200415 case LY_PREF_SCHEMA_RESOLVED:
416 if (!cur_mod) {
417 LOGINT_RET(ctx);
418 }
419 /* use current module */
Michal Vasko004d3152020-06-11 19:59:22 +0200420 *mod = cur_mod;
421 break;
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200422 case LY_PREF_JSON:
Michal Vasko004d3152020-06-11 19:59:22 +0200423 if (!prev_ctx_node) {
Michal Vasko00cbf532020-06-15 13:58:47 +0200424 LOGINT_RET(ctx);
Michal Vasko004d3152020-06-11 19:59:22 +0200425 }
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200426 /* inherit module of the previous node */
Michal Vasko004d3152020-06-11 19:59:22 +0200427 *mod = prev_ctx_node->module;
428 break;
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200429 case LY_PREF_XML:
Michal Vasko004d3152020-06-11 19:59:22 +0200430 /* not really defined */
Michal Vasko00cbf532020-06-15 13:58:47 +0200431 LOGINT_RET(ctx);
Michal Vasko004d3152020-06-11 19:59:22 +0200432 }
433 }
434
435 /* set name */
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200436 if (pref) {
437 *name = pref + len + 1;
Michal Vasko004d3152020-06-11 19:59:22 +0200438 *name_len = expr->tok_len[tok_idx] - len - 1;
439 } else {
440 *name = expr->expr + expr->tok_pos[tok_idx];
441 *name_len = expr->tok_len[tok_idx];
442 }
443
444 return LY_SUCCESS;
445}
446
447LY_ERR
Michal Vasko6b26e742020-07-17 15:02:10 +0200448ly_path_compile_predicate(const struct ly_ctx *ctx, const struct lysc_node *cur_node, const struct lys_module *cur_mod,
Michal Vasko5d24f6c2020-10-13 13:49:06 +0200449 const struct lysc_node *ctx_node, const struct lyxp_expr *expr, uint16_t *tok_idx, LY_PREFIX_FORMAT format,
450 void *prefix_data, struct ly_path_predicate **predicates, enum ly_path_pred_type *pred_type)
Michal Vasko004d3152020-06-11 19:59:22 +0200451{
452 struct ly_path_predicate *p;
453 const struct lysc_node *key;
Radek Krejci2b18bf12020-11-06 11:20:20 +0100454 const struct lys_module *mod = NULL;
Michal Vasko004d3152020-06-11 19:59:22 +0200455 const char *name;
456 size_t name_len, key_count;
457
Michal Vasko00cbf532020-06-15 13:58:47 +0200458 assert(ctx && ctx_node);
459
Michal Vasko004d3152020-06-11 19:59:22 +0200460 *pred_type = 0;
461
Michal Vasko004d3152020-06-11 19:59:22 +0200462 if (lyxp_next_token(NULL, expr, tok_idx, LYXP_TOKEN_BRACK1)) {
Radek Krejcif6a11002020-08-21 13:29:07 +0200463 /* '[', no predicate */
Michal Vasko004d3152020-06-11 19:59:22 +0200464 return LY_SUCCESS;
465 }
466
467 if (expr->tokens[*tok_idx] == LYXP_TOKEN_NAMETEST) {
468 if (ctx_node->nodetype != LYS_LIST) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200469 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "List predicate defined for %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200470 lys_nodetype2str(ctx_node->nodetype), ctx_node->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200471 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200472 } else if (ctx_node->flags & LYS_KEYLESS) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200473 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "List predicate defined for keyless %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200474 lys_nodetype2str(ctx_node->nodetype), ctx_node->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200475 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200476 }
477
478 do {
479 /* NameTest, find the key */
Michal Vasko6b26e742020-07-17 15:02:10 +0200480 LY_CHECK_RET(ly_path_compile_prefix(ctx, cur_node, cur_mod, ctx_node, expr, *tok_idx, LY_PATH_LREF_FALSE,
Michal Vasko69730152020-10-09 16:30:07 +0200481 format, prefix_data, &mod, &name, &name_len));
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100482 key = lys_find_child(ctx_node, mod, name, name_len, 0, 0);
Michal Vasko004d3152020-06-11 19:59:22 +0200483 if (!key) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200484 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Not found node \"%.*s\" in path.", name_len, name);
Michal Vasko3a41dff2020-07-15 14:30:28 +0200485 return LY_ENOTFOUND;
Michal Vasko004d3152020-06-11 19:59:22 +0200486 } else if ((key->nodetype != LYS_LEAF) || !(key->flags & LYS_KEY)) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200487 LOGVAL_P(ctx, cur_node ? cur_node : key, LYVE_XPATH, "Key expected instead of %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200488 lys_nodetype2str(key->nodetype), key->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200489 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200490 }
491 ++(*tok_idx);
492
Michal Vasko004d3152020-06-11 19:59:22 +0200493 if (!*pred_type) {
Radek Krejcif6a11002020-08-21 13:29:07 +0200494 /* new predicate */
Michal Vasko004d3152020-06-11 19:59:22 +0200495 *pred_type = LY_PATH_PREDTYPE_LIST;
496 }
497 assert(*pred_type == LY_PATH_PREDTYPE_LIST);
Michal Vasko00cbf532020-06-15 13:58:47 +0200498 LY_ARRAY_NEW_RET(ctx, *predicates, p, LY_EMEM);
Michal Vasko004d3152020-06-11 19:59:22 +0200499 p->key = key;
500
501 /* '=' */
502 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_OPER_EQUAL);
503 ++(*tok_idx);
504
505 /* Literal */
506 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_LITERAL);
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200507 LY_CHECK_RET(lyd_value_store(ctx, &p->value, ((struct lysc_node_leaf *)key)->type,
508 expr->expr + expr->tok_pos[*tok_idx] + 1, expr->tok_len[*tok_idx] - 2, NULL, format, prefix_data,
509 LYD_HINT_DATA, key, NULL, LY_VLOG_LYSC, key));
Michal Vasko004d3152020-06-11 19:59:22 +0200510 ++(*tok_idx);
511
Michal Vaskoae875662020-10-21 10:33:17 +0200512 /* "allocate" the type to avoid problems when freeing the value after the type was freed */
513 ++((struct lysc_type *)p->value.realtype)->refcount;
514
Michal Vasko004d3152020-06-11 19:59:22 +0200515 /* ']' */
516 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_BRACK2);
517 ++(*tok_idx);
518
519 /* another predicate follows? */
520 } while (!lyxp_next_token(NULL, expr, tok_idx, LYXP_TOKEN_BRACK1));
521
522 /* check that all keys were set */
523 key_count = 0;
524 for (key = lysc_node_children(ctx_node, 0); key && (key->flags & LYS_KEY); key = key->next) {
525 ++key_count;
526 }
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200527 if (LY_ARRAY_COUNT(*predicates) != key_count) {
Michal Vasko004d3152020-06-11 19:59:22 +0200528 /* names (keys) are unique - it was checked when parsing */
Michal Vasko6b26e742020-07-17 15:02:10 +0200529 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Predicate missing for a key of %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200530 lys_nodetype2str(ctx_node->nodetype), ctx_node->name);
Michal Vaskof7e16e22020-10-21 09:24:39 +0200531 ly_path_predicates_free(ctx, LY_PATH_PREDTYPE_LIST, *predicates);
Michal Vasko004d3152020-06-11 19:59:22 +0200532 *predicates = NULL;
Radek Krejci8de005f2020-06-25 17:02:07 +0200533 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200534 }
535
536 } else if (expr->tokens[*tok_idx] == LYXP_TOKEN_DOT) {
537 if (ctx_node->nodetype != LYS_LEAFLIST) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200538 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Leaf-list predicate defined for %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200539 lys_nodetype2str(ctx_node->nodetype), ctx_node->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200540 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200541 }
542 ++(*tok_idx);
543
544 /* new predicate */
545 *pred_type = LY_PATH_PREDTYPE_LEAFLIST;
Michal Vasko00cbf532020-06-15 13:58:47 +0200546 LY_ARRAY_NEW_RET(ctx, *predicates, p, LY_EMEM);
Michal Vasko004d3152020-06-11 19:59:22 +0200547
548 /* '=' */
549 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_OPER_EQUAL);
550 ++(*tok_idx);
551
552 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_LITERAL);
553 /* store the value */
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200554 LY_CHECK_RET(lyd_value_store(ctx, &p->value, ((struct lysc_node_leaflist *)ctx_node)->type,
555 expr->expr + expr->tok_pos[*tok_idx] + 1, expr->tok_len[*tok_idx] - 2, NULL, format, prefix_data,
556 LYD_HINT_DATA, ctx_node, NULL, LY_VLOG_LYSC, ctx_node));
Michal Vasko004d3152020-06-11 19:59:22 +0200557 ++(*tok_idx);
558
Michal Vaskoae875662020-10-21 10:33:17 +0200559 /* "allocate" the type to avoid problems when freeing the value after the type was freed */
560 ++((struct lysc_type *)p->value.realtype)->refcount;
561
Michal Vasko004d3152020-06-11 19:59:22 +0200562 /* ']' */
563 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_BRACK2);
564 ++(*tok_idx);
565 } else {
566 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_NUMBER);
567 if (!(ctx_node->nodetype & (LYS_LEAFLIST | LYS_LIST))) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200568 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Positional predicate defined for %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200569 lys_nodetype2str(ctx_node->nodetype), ctx_node->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200570 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200571 } else if (ctx_node->flags & LYS_CONFIG_W) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200572 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Positional predicate defined for configuration %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200573 lys_nodetype2str(ctx_node->nodetype), ctx_node->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200574 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200575 }
Michal Vasko004d3152020-06-11 19:59:22 +0200576
577 /* new predicate */
578 *pred_type = LY_PATH_PREDTYPE_POSITION;
Michal Vasko00cbf532020-06-15 13:58:47 +0200579 LY_ARRAY_NEW_RET(ctx, *predicates, p, LY_EMEM);
Michal Vasko004d3152020-06-11 19:59:22 +0200580
581 /* syntax was already checked */
582 p->position = strtoull(expr->expr + expr->tok_pos[*tok_idx], (char **)&name, 10);
Michal Vasko00cbf532020-06-15 13:58:47 +0200583 ++(*tok_idx);
Michal Vasko004d3152020-06-11 19:59:22 +0200584
585 /* ']' */
586 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_BRACK2);
587 ++(*tok_idx);
588 }
589
590 return LY_SUCCESS;
591}
592
593/**
594 * @brief Compile leafref predicate. Actually, it is only checked.
595 *
596 * @param[in] ctx_node Context node, node for which the predicate is defined.
597 * @param[in] cur_node Current (original context) node.
598 * @param[in] expr Parsed path.
599 * @param[in,out] tok_idx Index in @p expr, is adjusted for parsed tokens.
Michal Vasko004d3152020-06-11 19:59:22 +0200600 * @param[in] format Format of the path.
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200601 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Michal Vasko004d3152020-06-11 19:59:22 +0200602 * @return LY_ERR value.
603 */
604static LY_ERR
605ly_path_compile_predicate_leafref(const struct lysc_node *ctx_node, const struct lysc_node *cur_node,
Radek Krejci0f969882020-08-21 16:56:47 +0200606 const struct lyxp_expr *expr, uint16_t *tok_idx, LY_PREFIX_FORMAT format, void *prefix_data)
Michal Vasko004d3152020-06-11 19:59:22 +0200607{
608 const struct lysc_node *key, *node, *node2;
609 const struct lys_module *mod;
610 const char *name;
611 size_t name_len;
612
Michal Vasko004d3152020-06-11 19:59:22 +0200613 if (lyxp_next_token(NULL, expr, tok_idx, LYXP_TOKEN_BRACK1)) {
Radek Krejcif6a11002020-08-21 13:29:07 +0200614 /* '[', no predicate */
Michal Vasko004d3152020-06-11 19:59:22 +0200615 return LY_SUCCESS;
616 }
617
618 if (ctx_node->nodetype != LYS_LIST) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200619 LOGVAL_P(cur_node->module->ctx, cur_node, LYVE_XPATH, "List predicate defined for %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200620 lys_nodetype2str(ctx_node->nodetype), ctx_node->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200621 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200622 } else if (ctx_node->flags & LYS_KEYLESS) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200623 LOGVAL_P(cur_node->module->ctx, cur_node, LYVE_XPATH, "List predicate defined for keyless %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200624 lys_nodetype2str(ctx_node->nodetype), ctx_node->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200625 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200626 }
627
628 do {
629 /* NameTest, find the key */
Michal Vasko6b26e742020-07-17 15:02:10 +0200630 LY_CHECK_RET(ly_path_compile_prefix(cur_node->module->ctx, cur_node, cur_node->module, ctx_node, expr, *tok_idx,
Michal Vasko69730152020-10-09 16:30:07 +0200631 LY_PATH_LREF_TRUE, format, prefix_data, &mod, &name, &name_len));
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100632 key = lys_find_child(ctx_node, mod, name, name_len, 0, 0);
Michal Vasko004d3152020-06-11 19:59:22 +0200633 if (!key) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200634 LOGVAL_P(cur_node->module->ctx, cur_node, LYVE_XPATH, "Not found node \"%.*s\" in path.", name_len, name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200635 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200636 } else if ((key->nodetype != LYS_LEAF) || !(key->flags & LYS_KEY)) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200637 LOGVAL_P(cur_node->module->ctx, cur_node, LYVE_XPATH, "Key expected instead of %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200638 lys_nodetype2str(key->nodetype), key->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200639 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200640 }
641 ++(*tok_idx);
642
643 /* we are not actually compiling, throw the key away */
644 (void)key;
645
646 /* '=' */
647 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_OPER_EQUAL);
648 ++(*tok_idx);
649
650 /* FuncName */
651 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_FUNCNAME);
652 ++(*tok_idx);
653
654 /* evaluating from the "current()" node */
655 node = cur_node;
656
657 /* '(' */
658 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_PAR1);
659 ++(*tok_idx);
660
661 /* ')' */
662 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_PAR2);
663 ++(*tok_idx);
664
665 do {
666 /* '/' */
667 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_OPER_PATH);
668 ++(*tok_idx);
669
670 /* go to parent */
671 if (!node) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200672 LOGVAL_P(cur_node->module->ctx, cur_node, LYVE_XPATH, "Too many parent references in path.");
Radek Krejci8de005f2020-06-25 17:02:07 +0200673 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200674 }
675 node = lysc_data_parent(node);
676
677 /* '..' */
678 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_DDOT);
679 ++(*tok_idx);
680 } while (expr->tokens[*tok_idx + 1] == LYXP_TOKEN_DDOT);
681
682 do {
683 /* '/' */
684 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_OPER_PATH);
685 ++(*tok_idx);
686
687 /* NameTest */
688 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_NAMETEST);
Michal Vasko6b26e742020-07-17 15:02:10 +0200689 LY_CHECK_RET(ly_path_compile_prefix(cur_node->module->ctx, cur_node, cur_node->module, node, expr, *tok_idx,
Michal Vasko69730152020-10-09 16:30:07 +0200690 LY_PATH_LREF_TRUE, format, prefix_data, &mod, &name, &name_len));
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100691 node2 = lys_find_child(node, mod, name, name_len, 0, 0);
Michal Vasko004d3152020-06-11 19:59:22 +0200692 if (!node2) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200693 LOGVAL_P(cur_node->module->ctx, cur_node, LYVE_XPATH, "Not found node \"%.*s\" in path.", name_len, name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200694 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200695 }
696 node = node2;
697 ++(*tok_idx);
698 } while ((*tok_idx + 1 < expr->used) && (expr->tokens[*tok_idx + 1] == LYXP_TOKEN_NAMETEST));
699
700 /* check the last target node */
701 if (node->nodetype != LYS_LEAF) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200702 LOGVAL_P(cur_node->module->ctx, cur_node, LYVE_XPATH,
Michal Vasko69730152020-10-09 16:30:07 +0200703 "Leaf expected instead of %s \"%s\" in leafref predicate in path.",
704 lys_nodetype2str(node->nodetype), node->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200705 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200706 }
707
708 /* we are not actually compiling, throw the rightside node away */
709 (void)node;
710
711 /* ']' */
712 assert(expr->tokens[*tok_idx] == LYXP_TOKEN_BRACK2);
713 ++(*tok_idx);
714
Radek Krejci0f969882020-08-21 16:56:47 +0200715 /* another predicate follows? */
Michal Vasko004d3152020-06-11 19:59:22 +0200716 } while (!lyxp_next_token(NULL, expr, tok_idx, LYXP_TOKEN_BRACK1));
717
718 return LY_SUCCESS;
719}
720
721LY_ERR
Michal Vasko00cbf532020-06-15 13:58:47 +0200722ly_path_compile(const struct ly_ctx *ctx, const struct lys_module *cur_mod, const struct lysc_node *ctx_node,
Radek Krejci0f969882020-08-21 16:56:47 +0200723 const struct lyxp_expr *expr, uint8_t lref, uint8_t oper, uint8_t target, LY_PREFIX_FORMAT format,
724 void *prefix_data, struct ly_path **path)
Michal Vasko004d3152020-06-11 19:59:22 +0200725{
726 LY_ERR ret = LY_SUCCESS;
727 uint16_t tok_idx = 0;
Radek Krejci2b18bf12020-11-06 11:20:20 +0100728 const struct lys_module *mod = NULL;
Michal Vasko6b26e742020-07-17 15:02:10 +0200729 const struct lysc_node *node2, *cur_node, *op;
Michal Vasko00cbf532020-06-15 13:58:47 +0200730 struct ly_path *p = NULL;
Radek Krejci1deb5be2020-08-26 16:43:36 +0200731 uint32_t getnext_opts;
Michal Vasko004d3152020-06-11 19:59:22 +0200732 const char *name;
733 size_t name_len;
734
Michal Vasko00cbf532020-06-15 13:58:47 +0200735 assert(ctx);
Michal Vasko6b26e742020-07-17 15:02:10 +0200736 assert((lref == LY_PATH_LREF_FALSE) || ctx_node);
Michal Vasko004d3152020-06-11 19:59:22 +0200737 assert((lref == LY_PATH_LREF_TRUE) || (lref == LY_PATH_LREF_FALSE));
Michal Vasko00cbf532020-06-15 13:58:47 +0200738 assert((oper == LY_PATH_OPER_INPUT) || (oper == LY_PATH_OPER_OUTPUT));
739 assert((target == LY_PATH_TARGET_SINGLE) || (target == LY_PATH_TARGET_MANY));
Michal Vasko004d3152020-06-11 19:59:22 +0200740
Michal Vasko6b26e742020-07-17 15:02:10 +0200741 /* find operation, if we are in any */
Radek Krejci1e008d22020-08-17 11:37:37 +0200742 for (op = ctx_node; op && !(op->nodetype & (LYS_RPC | LYS_ACTION | LYS_NOTIF)); op = op->parent) {}
Michal Vasko6b26e742020-07-17 15:02:10 +0200743
744 /* remember original context node */
745 cur_node = ctx_node;
746
Michal Vasko004d3152020-06-11 19:59:22 +0200747 *path = NULL;
748
Michal Vasko00cbf532020-06-15 13:58:47 +0200749 if (oper == LY_PATH_OPER_OUTPUT) {
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100750 getnext_opts = LYS_GETNEXT_OUTPUT;
Michal Vasko00cbf532020-06-15 13:58:47 +0200751 } else {
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100752 getnext_opts = 0;
Michal Vasko00cbf532020-06-15 13:58:47 +0200753 }
754
Michal Vasko004d3152020-06-11 19:59:22 +0200755 if (expr->tokens[tok_idx] == LYXP_TOKEN_OPER_PATH) {
756 /* absolute path */
757 ctx_node = NULL;
758
759 ++tok_idx;
760 } else {
761 /* relative path */
762 while ((lref == LY_PATH_LREF_TRUE) && (expr->tokens[tok_idx] == LYXP_TOKEN_DDOT)) {
763 if (!ctx_node) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200764 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Too many parent references in path.");
Radek Krejci8de005f2020-06-25 17:02:07 +0200765 return LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200766 }
767
768 /* get parent */
769 ctx_node = lysc_data_parent(ctx_node);
770
771 ++tok_idx;
772
773 assert(expr->tokens[tok_idx] == LYXP_TOKEN_OPER_PATH);
774 ++tok_idx;
775 }
776
Michal Vasko00cbf532020-06-15 13:58:47 +0200777 /* we are not storing the parent */
778 (void)ctx_node;
Michal Vasko004d3152020-06-11 19:59:22 +0200779 }
780
781 do {
Michal Vasko00cbf532020-06-15 13:58:47 +0200782 /* check last compiled inner node, whether it is uniquely identified (even key-less list) */
783 if (p && (lref == LY_PATH_LREF_FALSE) && (p->node->nodetype == LYS_LIST) && !p->predicates) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200784 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Predicate missing for %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200785 lys_nodetype2str(p->node->nodetype), p->node->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200786 return LY_EVALID;
Michal Vasko00cbf532020-06-15 13:58:47 +0200787 }
788
Michal Vasko004d3152020-06-11 19:59:22 +0200789 /* get module and node name */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200790 LY_CHECK_GOTO(ret = ly_path_compile_prefix(ctx, cur_node, cur_mod, ctx_node, expr, tok_idx, lref, format,
Michal Vasko69730152020-10-09 16:30:07 +0200791 prefix_data, &mod, &name, &name_len), cleanup);
Michal Vasko004d3152020-06-11 19:59:22 +0200792 ++tok_idx;
793
794 /* find the next node */
Michal Vasko00cbf532020-06-15 13:58:47 +0200795 node2 = lys_find_child(ctx_node, mod, name, name_len, 0, getnext_opts);
Michal Vasko6b26e742020-07-17 15:02:10 +0200796 if (!node2 || ((node2->nodetype & (LYS_RPC | LYS_ACTION | LYS_NOTIF)) && (node2 != op))) {
797 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Not found node \"%.*s\" in path.", name_len, name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200798 ret = LY_EVALID;
Michal Vasko004d3152020-06-11 19:59:22 +0200799 goto cleanup;
800 }
801 ctx_node = node2;
802
803 /* new path segment */
Michal Vasko00cbf532020-06-15 13:58:47 +0200804 LY_ARRAY_NEW_GOTO(ctx, *path, p, ret, cleanup);
Michal Vasko004d3152020-06-11 19:59:22 +0200805 p->node = ctx_node;
806
807 /* compile any predicates */
808 if (lref == LY_PATH_LREF_TRUE) {
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200809 ret = ly_path_compile_predicate_leafref(ctx_node, cur_node, expr, &tok_idx, format, prefix_data);
Michal Vasko004d3152020-06-11 19:59:22 +0200810 } else {
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200811 ret = ly_path_compile_predicate(ctx, cur_node, cur_mod, ctx_node, expr, &tok_idx, format, prefix_data,
Michal Vasko69730152020-10-09 16:30:07 +0200812 &p->predicates, &p->pred_type);
Michal Vasko004d3152020-06-11 19:59:22 +0200813 }
814 LY_CHECK_GOTO(ret, cleanup);
Michal Vasko004d3152020-06-11 19:59:22 +0200815 } while (!lyxp_next_token(NULL, expr, &tok_idx, LYXP_TOKEN_OPER_PATH));
816
Michal Vasko00cbf532020-06-15 13:58:47 +0200817 /* check last compiled node */
Michal Vasko69730152020-10-09 16:30:07 +0200818 if ((lref == LY_PATH_LREF_FALSE) && (target == LY_PATH_TARGET_SINGLE) &&
819 (p->node->nodetype & (LYS_LIST | LYS_LEAFLIST)) && !p->predicates) {
Michal Vasko6b26e742020-07-17 15:02:10 +0200820 LOGVAL_P(ctx, cur_node, LYVE_XPATH, "Predicate missing for %s \"%s\" in path.",
Michal Vasko69730152020-10-09 16:30:07 +0200821 lys_nodetype2str(p->node->nodetype), p->node->name);
Radek Krejci8de005f2020-06-25 17:02:07 +0200822 return LY_EVALID;
Michal Vasko00cbf532020-06-15 13:58:47 +0200823 }
824
Michal Vasko004d3152020-06-11 19:59:22 +0200825cleanup:
826 if (ret) {
Michal Vasko00cbf532020-06-15 13:58:47 +0200827 ly_path_free(ctx, *path);
Michal Vasko004d3152020-06-11 19:59:22 +0200828 *path = NULL;
829 }
830 return ret;
831}
832
833LY_ERR
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200834ly_path_eval_partial(const struct ly_path *path, const struct lyd_node *start, LY_ARRAY_COUNT_TYPE *path_idx,
Radek Krejci0f969882020-08-21 16:56:47 +0200835 struct lyd_node **match)
Michal Vasko004d3152020-06-11 19:59:22 +0200836{
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200837 LY_ARRAY_COUNT_TYPE u;
Michal Vasko00cbf532020-06-15 13:58:47 +0200838 struct lyd_node *prev_node = NULL, *node, *target;
Michal Vasko004d3152020-06-11 19:59:22 +0200839 uint64_t pos;
840
841 assert(path && start);
842
843 if (lysc_data_parent(path[0].node)) {
844 /* relative path, start from the parent children */
Radek Krejcia1c1e542020-09-29 16:06:52 +0200845 start = lyd_child(start);
Michal Vasko004d3152020-06-11 19:59:22 +0200846 } else {
847 /* absolute path, start from the first top-level sibling */
848 while (start->parent) {
849 start = (struct lyd_node *)start->parent;
850 }
851 while (start->prev->next) {
852 start = start->prev;
853 }
854 }
855
856 LY_ARRAY_FOR(path, u) {
857 switch (path[u].pred_type) {
858 case LY_PATH_PREDTYPE_POSITION:
859 /* we cannot use hashes and want an instance on a specific position */
860 pos = 1;
Michal Vasko4c583e82020-07-17 12:16:14 +0200861 LYD_LIST_FOR_INST(start, path[u].node, node) {
Michal Vasko004d3152020-06-11 19:59:22 +0200862 if (pos == path[u].predicates[0].position) {
863 break;
864 }
865 ++pos;
866 }
867 break;
868 case LY_PATH_PREDTYPE_LEAFLIST:
869 /* we will use hashes to find one leaf-list instance */
870 LY_CHECK_RET(lyd_create_term2(path[u].node, &path[u].predicates[0].value, &target));
871 lyd_find_sibling_first(start, target, &node);
872 lyd_free_tree(target);
873 break;
874 case LY_PATH_PREDTYPE_LIST:
875 /* we will use hashes to find one list instance */
876 LY_CHECK_RET(lyd_create_list(path[u].node, path[u].predicates, &target));
877 lyd_find_sibling_first(start, target, &node);
878 lyd_free_tree(target);
879 break;
880 case LY_PATH_PREDTYPE_NONE:
881 /* we will use hashes to find one any/container/leaf instance */
882 lyd_find_sibling_val(start, path[u].node, NULL, 0, &node);
883 break;
884 }
885
886 if (!node) {
887 /* no matching nodes */
888 break;
889 }
890
Michal Vasko00cbf532020-06-15 13:58:47 +0200891 /* rememeber previous node */
892 prev_node = node;
893
Michal Vasko004d3152020-06-11 19:59:22 +0200894 /* next path segment, if any */
Radek Krejcia1c1e542020-09-29 16:06:52 +0200895 start = lyd_child(node);
Michal Vasko004d3152020-06-11 19:59:22 +0200896 }
897
Michal Vasko004d3152020-06-11 19:59:22 +0200898 if (node) {
Michal Vasko00cbf532020-06-15 13:58:47 +0200899 /* we have found the full path */
900 if (path_idx) {
901 *path_idx = u;
902 }
903 if (match) {
904 *match = node;
905 }
Michal Vasko004d3152020-06-11 19:59:22 +0200906 return LY_SUCCESS;
Michal Vasko00cbf532020-06-15 13:58:47 +0200907
908 } else if (prev_node) {
909 /* we have found only some partial match */
910 if (path_idx) {
911 *path_idx = u - 1;
912 }
913 if (match) {
914 *match = prev_node;
915 }
916 return LY_EINCOMPLETE;
917 }
918
919 /* we have not found any nodes */
920 if (path_idx) {
921 *path_idx = 0;
922 }
923 if (match) {
924 *match = NULL;
925 }
926 return LY_ENOTFOUND;
927}
928
929LY_ERR
930ly_path_eval(const struct ly_path *path, const struct lyd_node *start, struct lyd_node **match)
931{
932 LY_ERR ret;
933 struct lyd_node *m;
934
935 ret = ly_path_eval_partial(path, start, NULL, &m);
936
937 if (ret == LY_SUCCESS) {
938 /* last node was found */
939 if (match) {
940 *match = m;
941 }
942 return LY_SUCCESS;
943 }
944
945 /* not a full match */
946 if (match) {
947 *match = NULL;
Michal Vasko004d3152020-06-11 19:59:22 +0200948 }
949 return LY_ENOTFOUND;
950}
951
952LY_ERR
953ly_path_dup(const struct ly_ctx *ctx, const struct ly_path *path, struct ly_path **dup)
954{
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200955 LY_ARRAY_COUNT_TYPE u, v;
Michal Vasko004d3152020-06-11 19:59:22 +0200956
957 if (!path) {
958 return LY_SUCCESS;
959 }
960
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200961 LY_ARRAY_CREATE_RET(ctx, *dup, LY_ARRAY_COUNT(path), LY_EMEM);
Michal Vasko004d3152020-06-11 19:59:22 +0200962 LY_ARRAY_FOR(path, u) {
963 LY_ARRAY_INCREMENT(*dup);
964 (*dup)[u].node = path[u].node;
965 if (path[u].predicates) {
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200966 LY_ARRAY_CREATE_RET(ctx, (*dup)[u].predicates, LY_ARRAY_COUNT(path[u].predicates), LY_EMEM);
Michal Vasko004d3152020-06-11 19:59:22 +0200967 (*dup)[u].pred_type = path[u].pred_type;
968 LY_ARRAY_FOR(path[u].predicates, v) {
969 struct ly_path_predicate *pred = &path[u].predicates[v];
970
971 LY_ARRAY_INCREMENT((*dup)[u].predicates);
972 switch (path[u].pred_type) {
973 case LY_PATH_PREDTYPE_POSITION:
974 /* position-predicate */
975 (*dup)[u].predicates[v].position = pred->position;
976 break;
977 case LY_PATH_PREDTYPE_LIST:
978 case LY_PATH_PREDTYPE_LEAFLIST:
979 /* key-predicate or leaf-list-predicate */
980 (*dup)[u].predicates[v].key = pred->key;
Michal Vasko004d3152020-06-11 19:59:22 +0200981 pred->value.realtype->plugin->duplicate(ctx, &pred->value, &(*dup)[u].predicates[v].value);
Michal Vaskoae875662020-10-21 10:33:17 +0200982 ++((struct lysc_type *)pred->value.realtype)->refcount;
Michal Vasko004d3152020-06-11 19:59:22 +0200983 break;
984 case LY_PATH_PREDTYPE_NONE:
985 break;
986 }
987 }
988 }
989 }
990
991 return LY_SUCCESS;
992}
993
994void
Michal Vaskof7e16e22020-10-21 09:24:39 +0200995ly_path_predicates_free(const struct ly_ctx *ctx, enum ly_path_pred_type pred_type, struct ly_path_predicate *predicates)
Michal Vasko004d3152020-06-11 19:59:22 +0200996{
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200997 LY_ARRAY_COUNT_TYPE u;
Michal Vasko004d3152020-06-11 19:59:22 +0200998
999 if (!predicates) {
1000 return;
1001 }
1002
1003 LY_ARRAY_FOR(predicates, u) {
1004 switch (pred_type) {
1005 case LY_PATH_PREDTYPE_POSITION:
1006 case LY_PATH_PREDTYPE_NONE:
1007 /* nothing to free */
1008 break;
1009 case LY_PATH_PREDTYPE_LIST:
Michal Vasko004d3152020-06-11 19:59:22 +02001010 case LY_PATH_PREDTYPE_LEAFLIST:
Michal Vaskoae875662020-10-21 10:33:17 +02001011 if (predicates[u].value.realtype) {
1012 predicates[u].value.realtype->plugin->free(ctx, &predicates[u].value);
1013 lysc_type_free((struct ly_ctx *)ctx, (struct lysc_type *)predicates[u].value.realtype);
1014 }
Michal Vasko004d3152020-06-11 19:59:22 +02001015 break;
1016 }
1017 }
1018 LY_ARRAY_FREE(predicates);
1019}
1020
1021void
1022ly_path_free(const struct ly_ctx *ctx, struct ly_path *path)
1023{
Michal Vaskofd69e1d2020-07-03 11:57:17 +02001024 LY_ARRAY_COUNT_TYPE u;
Michal Vasko004d3152020-06-11 19:59:22 +02001025
1026 LY_ARRAY_FOR(path, u) {
Michal Vaskof7e16e22020-10-21 09:24:39 +02001027 ly_path_predicates_free(ctx, path[u].pred_type, path[u].predicates);
Michal Vasko004d3152020-06-11 19:59:22 +02001028 }
1029 LY_ARRAY_FREE(path);
1030}