blob: dc2cf6e22c8e28c46f4166c09cc33317bd262347 [file] [log] [blame]
/**
* @file tree_schema.c
* @author Radek Krejci <rkrejci@cesnet.cz>
* @brief Schema tree implementation
*
* Copyright (c) 2015 - 2018 CESNET, z.s.p.o.
*
* This source code is licensed under BSD 3-Clause License (the "License").
* You may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*/
#define _GNU_SOURCE
#include "tree_schema.h"
#include <assert.h>
#include <dirent.h>
#include <errno.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
#include "common.h"
#include "compat.h"
#include "context.h"
#include "dict.h"
#include "log.h"
#include "parser.h"
#include "parser_internal.h"
#include "parser_schema.h"
#include "set.h"
#include "tree.h"
#include "tree_schema_internal.h"
#include "xpath.h"
API const struct lysc_node *
lys_getnext(const struct lysc_node *last, const struct lysc_node *parent, const struct lysc_module *module, uint32_t options)
{
const struct lysc_node *next = NULL;
struct lysc_node **snode;
ly_bool action_flag = 0, notif_flag = 0;
const struct lysc_action *actions;
const struct lysc_notif *notifs;
LY_ARRAY_COUNT_TYPE u;
LY_CHECK_ARG_RET(NULL, parent || module, NULL);
next:
if (!last) {
/* first call */
/* get know where to start */
if (parent) {
/* schema subtree */
if (parent->nodetype == LYS_CHOICE && (options & LYS_GETNEXT_WITHCASE)) {
if (((struct lysc_node_choice *)parent)->cases) {
next = last = (const struct lysc_node *)&((struct lysc_node_choice *)parent)->cases[0];
}
} else {
snode = lysc_node_children_p(parent, (options & LYS_GETNEXT_OUTPUT) ? LYS_CONFIG_R : LYS_CONFIG_W);
/* do not return anything if the node does not have any children */
if (snode && *snode) {
next = last = *snode;
}
}
} else {
/* top level data */
next = last = module->data;
}
if (!next) {
/* try to get action or notification */
goto repeat;
}
/* test if the next can be returned */
goto check;
} else if (last->nodetype & (LYS_RPC | LYS_ACTION)) {
action_flag = 1;
if (last->parent) {
actions = lysc_node_actions(last->parent);
} else {
actions = module->rpcs;
}
LY_ARRAY_FOR(actions, u) {
if (&actions[u] == (struct lysc_action *)last) {
break;
}
}
if (u + 1 < LY_ARRAY_COUNT(actions)) {
next = (struct lysc_node *)(&actions[u + 1]);
}
goto repeat;
} else if (last->nodetype == LYS_NOTIF) {
action_flag = notif_flag = 1;
if (last->parent) {
notifs = lysc_node_notifs(last->parent);
} else {
notifs = module->notifs;
}
LY_ARRAY_FOR(notifs, u) {
if (&notifs[u] == (struct lysc_notif *)last) {
break;
}
}
if (u + 1 < LY_ARRAY_COUNT(notifs)) {
next = (struct lysc_node *)(&notifs[u + 1]);
}
goto repeat;
} else {
next = last->next;
}
repeat:
if (next && parent && parent->nodetype == LYS_CASE && next->parent != parent) {
/* inside case (as an explicit parent, not when diving into it from choice),
* limit the list of children only to the specific case */
next = NULL;
}
if (!next) {
/* possibly go back to parent */
if (last && last->parent != parent) {
last = last->parent;
goto next;
} else if (!action_flag) {
action_flag = 1;
next = parent ? (struct lysc_node *)lysc_node_actions(parent) : (struct lysc_node *)module->rpcs;
} else if (!notif_flag) {
notif_flag = 1;
next = parent ? (struct lysc_node *)lysc_node_notifs(parent) : (struct lysc_node *)module->notifs;
} else {
return NULL;
}
goto repeat;
}
check:
switch (next->nodetype) {
case LYS_RPC:
case LYS_ACTION:
case LYS_NOTIF:
case LYS_LEAF:
case LYS_ANYXML:
case LYS_ANYDATA:
case LYS_LIST:
case LYS_LEAFLIST:
break;
case LYS_CASE:
if (options & LYS_GETNEXT_WITHCASE) {
break;
} else {
/* go into */
next = ((struct lysc_node_case *)next)->child;
}
goto repeat;
case LYS_CONTAINER:
if (!(((struct lysc_node_container *)next)->flags & LYS_PRESENCE) && (options & LYS_GETNEXT_INTONPCONT)) {
if (((struct lysc_node_container *)next)->child) {
/* go into */
next = ((struct lysc_node_container *)next)->child;
} else {
next = next->next;
}
goto repeat;
}
break;
case LYS_CHOICE:
if (options & LYS_GETNEXT_WITHCHOICE) {
break;
} else if ((options & LYS_GETNEXT_NOCHOICE) || !((struct lysc_node_choice *)next)->cases) {
next = next->next;
} else {
/* go into */
if (options & LYS_GETNEXT_WITHCASE) {
next = (struct lysc_node *)((struct lysc_node_choice *)next)->cases;
} else {
next = ((struct lysc_node_choice *)next)->cases->child;
}
}
goto repeat;
default:
/* we should not be here */
LOGINT(module ? module->mod->ctx : parent->module->ctx);
return NULL;
}
if (!(options & LYS_GETNEXT_NOSTATECHECK)) {
/* check if the node is disabled by if-feature */
if (lysc_node_is_disabled(next, 0)) {
next = next->next;
goto repeat;
}
}
return next;
}
API const struct lysc_node *
lys_find_node(struct ly_ctx *ctx, const struct lysc_node *context_node, const char *qpath)
{
const char *id = qpath;
const char *prefix, *name;
size_t prefix_len, name_len;
const struct lysc_node *node = context_node;
struct lys_module *mod = NULL;
LY_CHECK_ARG_RET(ctx, qpath, NULL);
while (*id) {
if (id[0] == '/') {
++id;
}
/* precess ".." in relative paths */
while (!strncmp("../", id, 3)) {
id += 3;
if (!node) {
LOGERR(ctx, LY_EINVAL, "Invalid qpath \"%s\" - too many \"..\" in the path.", qpath);
return NULL;
}
node = node->parent;
}
if (ly_parse_nodeid(&id, &prefix, &prefix_len, &name, &name_len) != LY_SUCCESS) {
LOGERR(ctx, LY_EINVAL, "Invalid qpath \"%s\" - invalid nodeid \"%.*s\".", qpath, id - qpath, qpath);
return NULL;
}
if (prefix) {
if (context_node) {
mod = lys_module_find_prefix(context_node->module, prefix, prefix_len);
} else {
for (uint32_t u = 0; u < ctx->list.count; ++u) {
if (!ly_strncmp(((struct lys_module *)ctx->list.objs[u])->name, prefix, prefix_len)) {
struct lys_module *m = (struct lys_module *)ctx->list.objs[u];
if (mod) {
if (m->implemented) {
mod = m;
break;
} else if (m->latest_revision) {
mod = m;
}
} else {
mod = m;
}
}
}
}
}
if (!mod) {
LOGERR(ctx, LY_EINVAL, "Invalid qpath - unable to find module connected with the prefix of the node \"%.*s\".",
id - qpath, qpath);
return NULL;
}
node = lys_find_child(node, mod, name, name_len, 0, LYS_GETNEXT_NOSTATECHECK);
if (!node) {
LOGERR(ctx, LY_EINVAL, "Invalid qpath - unable to find \"%.*s\".", id - qpath, qpath);
return NULL;
}
}
return node;
}
API const struct lysc_node *
lys_find_child(const struct lysc_node *parent, const struct lys_module *module, const char *name, size_t name_len,
uint16_t nodetype, uint32_t options)
{
const struct lysc_node *node = NULL;
LY_CHECK_ARG_RET(NULL, module, name, NULL);
if (!nodetype) {
nodetype = 0xffff;
}
while ((node = lys_getnext(node, parent, module->compiled, options))) {
if (!(node->nodetype & nodetype)) {
continue;
}
if (node->module != module) {
continue;
}
if (name_len) {
if (!ly_strncmp(node->name, name, name_len)) {
return node;
}
} else {
if (!strcmp(node->name, name)) {
return node;
}
}
}
return NULL;
}
API LY_ERR
lys_atomize_xpath(const struct lysc_node *ctx_node, const char *xpath, uint32_t options, struct ly_set **set)
{
LY_ERR ret = LY_SUCCESS;
struct lyxp_set xp_set;
struct lyxp_expr *exp;
uint32_t i;
LY_CHECK_ARG_RET(NULL, ctx_node, xpath, set, LY_EINVAL);
if (!(options & LYXP_SCNODE_ALL)) {
options = LYXP_SCNODE;
}
memset(&xp_set, 0, sizeof xp_set);
/* compile expression */
exp = lyxp_expr_parse(ctx_node->module->ctx, xpath, 0, 1);
LY_CHECK_ERR_GOTO(!exp, ret = LY_EINVAL, cleanup);
/* atomize expression */
ret = lyxp_atomize(exp, LY_PREF_JSON, ctx_node->module, ctx_node, LYXP_NODE_ELEM, &xp_set, options);
LY_CHECK_GOTO(ret, cleanup);
/* allocate return set */
ret = ly_set_new(set);
LY_CHECK_GOTO(ret, cleanup);
/* transform into ly_set */
(*set)->objs = malloc(xp_set.used * sizeof *(*set)->objs);
LY_CHECK_ERR_GOTO(!(*set)->objs, LOGMEM(ctx_node->module->ctx); ret = LY_EMEM, cleanup);
(*set)->size = xp_set.used;
for (i = 0; i < xp_set.used; ++i) {
if (xp_set.val.scnodes[i].type == LYXP_NODE_ELEM) {
ret = ly_set_add(*set, xp_set.val.scnodes[i].scnode, LY_SET_OPT_USEASLIST, NULL);
LY_CHECK_GOTO(ret, cleanup);
}
}
cleanup:
lyxp_set_free_content(&xp_set);
lyxp_expr_free(ctx_node->module->ctx, exp);
return ret;
}
API LY_ERR
lys_find_xpath(const struct lysc_node *ctx_node, const char *xpath, uint32_t options, struct ly_set **set)
{
LY_ERR ret = LY_SUCCESS;
struct lyxp_set xp_set;
struct lyxp_expr *exp;
uint32_t i;
LY_CHECK_ARG_RET(NULL, ctx_node, xpath, set, LY_EINVAL);
if (!(options & LYXP_SCNODE_ALL)) {
options = LYXP_SCNODE;
}
memset(&xp_set, 0, sizeof xp_set);
/* compile expression */
exp = lyxp_expr_parse(ctx_node->module->ctx, xpath, 0, 1);
LY_CHECK_ERR_GOTO(!exp, ret = LY_EINVAL, cleanup);
/* atomize expression */
ret = lyxp_atomize(exp, LY_PREF_JSON, ctx_node->module, ctx_node, LYXP_NODE_ELEM, &xp_set, options);
LY_CHECK_GOTO(ret, cleanup);
/* allocate return set */
ret = ly_set_new(set);
LY_CHECK_GOTO(ret, cleanup);
/* transform into ly_set */
(*set)->objs = malloc(xp_set.used * sizeof *(*set)->objs);
LY_CHECK_ERR_GOTO(!(*set)->objs, LOGMEM(ctx_node->module->ctx); ret = LY_EMEM, cleanup);
(*set)->size = xp_set.used;
for (i = 0; i < xp_set.used; ++i) {
if ((xp_set.val.scnodes[i].type == LYXP_NODE_ELEM) && (xp_set.val.scnodes[i].in_ctx == 1)) {
ret = ly_set_add(*set, xp_set.val.scnodes[i].scnode, LY_SET_OPT_USEASLIST, NULL);
LY_CHECK_GOTO(ret, cleanup);
}
}
cleanup:
lyxp_set_free_content(&xp_set);
lyxp_expr_free(ctx_node->module->ctx, exp);
return ret;
}
char *
lysc_path_until(const struct lysc_node *node, const struct lysc_node *parent, LYSC_PATH_TYPE pathtype, char *buffer,
size_t buflen)
{
const struct lysc_node *iter;
char *path = NULL;
int len = 0;
LY_CHECK_ARG_RET(NULL, node, NULL);
if (buffer) {
LY_CHECK_ARG_RET(node->module->ctx, buflen > 1, NULL);
}
switch (pathtype) {
case LYSC_PATH_LOG:
case LYSC_PATH_DATA:
for (iter = node; iter && (iter != parent) && (len >= 0); iter = iter->parent) {
char *s, *id;
const char *slash;
if ((pathtype == LYSC_PATH_DATA) && (iter->nodetype & (LYS_CHOICE | LYS_CASE))) {
/* schema-only node */
continue;
}
s = buffer ? strdup(buffer) : path;
id = strdup(iter->name);
if (parent && (iter->parent == parent)) {
slash = "";
} else {
slash = "/";
}
if (!iter->parent || iter->parent->module != iter->module) {
/* print prefix */
if (buffer) {
len = snprintf(buffer, buflen, "%s%s:%s%s", slash, iter->module->name, id, s ? s : "");
} else {
len = asprintf(&path, "%s%s:%s%s", slash, iter->module->name, id, s ? s : "");
}
} else {
/* prefix is the same as in parent */
if (buffer) {
len = snprintf(buffer, buflen, "%s%s%s", slash, id, s ? s : "");
} else {
len = asprintf(&path, "%s%s%s", slash, id, s ? s : "");
}
}
free(s);
free(id);
if (buffer && buflen <= (size_t)len) {
/* not enough space in buffer */
break;
}
}
if (len < 0) {
free(path);
path = NULL;
} else if (len == 0) {
if (buffer) {
strcpy(buffer, "/");
} else {
path = strdup("/");
}
}
break;
}
if (buffer) {
return buffer;
} else {
return path;
}
}
API char *
lysc_path(const struct lysc_node *node, LYSC_PATH_TYPE pathtype, char *buffer, size_t buflen)
{
return lysc_path_until(node, NULL, pathtype, buffer, buflen);
}
API LY_ERR
lysc_feature_value(const struct lysc_feature *feature)
{
LY_CHECK_ARG_RET(NULL, feature, LY_EINVAL);
return feature->flags & LYS_FENABLED ? LY_SUCCESS : LY_ENOT;
}
uint8_t
lysc_iff_getop(uint8_t *list, size_t pos)
{
uint8_t *item;
uint8_t mask = 3, result;
item = &list[pos / 4];
result = (*item) & (mask << 2 * (pos % 4));
return result >> 2 * (pos % 4);
}
static LY_ERR
lysc_iffeature_value_(const struct lysc_iffeature *iff, size_t *index_e, size_t *index_f)
{
uint8_t op;
LY_ERR a, b;
op = lysc_iff_getop(iff->expr, *index_e);
(*index_e)++;
switch (op) {
case LYS_IFF_F:
/* resolve feature */
return lysc_feature_value(iff->features[(*index_f)++]);
case LYS_IFF_NOT:
/* invert result */
return lysc_iffeature_value_(iff, index_e, index_f) == LY_SUCCESS ? LY_ENOT : LY_SUCCESS;
case LYS_IFF_AND:
case LYS_IFF_OR:
a = lysc_iffeature_value_(iff, index_e, index_f);
b = lysc_iffeature_value_(iff, index_e, index_f);
if (op == LYS_IFF_AND) {
if ((a == LY_SUCCESS) && (b == LY_SUCCESS)) {
return LY_SUCCESS;
} else {
return LY_ENOT;
}
} else { /* LYS_IFF_OR */
if ((a == LY_SUCCESS) || (b == LY_SUCCESS)) {
return LY_SUCCESS;
} else {
return LY_ENOT;
}
}
}
return 0;
}
API LY_ERR
lysc_iffeature_value(const struct lysc_iffeature *iff)
{
size_t index_e = 0, index_f = 0;
LY_CHECK_ARG_RET(NULL, iff, -1);
if (iff->expr) {
return lysc_iffeature_value_(iff, &index_e, &index_f);
}
return 0;
}
/**
* @brief Enable/Disable the specified feature in the module.
*
* If the feature is already set to the desired value, LY_SUCCESS is returned.
* By changing the feature, also all the feature which depends on it via their
* if-feature statements are again evaluated (disabled if a if-feature statemen
* evaluates to false).
*
* @param[in] mod Module where to set (search for) the feature.
* @param[in] name Name of the feature to set. Asterisk ('*') can be used to
* set all the features in the module.
* @param[in] value Desired value of the feature: 1 (enable) or 0 (disable).
* @param[in] skip_checks Flag to skip checking of if-features and just set @p value of the feature.
* @return LY_ERR value.
*/
static LY_ERR
lys_feature_change(const struct lys_module *mod, const char *name, ly_bool value, ly_bool skip_checks)
{
LY_ERR ret = LY_SUCCESS;
ly_bool all = 0;
LY_ARRAY_COUNT_TYPE u, disabled_count;
uint32_t changed_count;
struct lysc_feature *f, **df;
struct lysc_iffeature *iff;
struct ly_set *changed;
struct ly_ctx *ctx = mod->ctx; /* shortcut */
if (!strcmp(name, "*")) {
/* enable all */
all = 1;
}
if (!mod->compiled) {
LOGERR(ctx, LY_EINVAL, "Module \"%s\" is not implemented so all its features are permanently disabled without a chance to change it.",
mod->name);
return LY_EINVAL;
}
if (!mod->compiled->features) {
if (all) {
/* no feature to enable */
return LY_SUCCESS;
}
LOGERR(ctx, LY_EINVAL, "Unable to switch feature since the module \"%s\" has no features.", mod->name);
return LY_ENOTFOUND;
}
LY_CHECK_RET(ly_set_new(&changed));
changed_count = 0;
run:
for (disabled_count = u = 0; u < LY_ARRAY_COUNT(mod->compiled->features); ++u) {
f = &mod->compiled->features[u];
if (all || !strcmp(f->name, name)) {
if ((value && (f->flags & LYS_FENABLED)) || (!value && !(f->flags & LYS_FENABLED))) {
if (all) {
/* skip already set features */
continue;
} else {
/* feature already set correctly */
goto cleanup;
}
}
if (value) { /* enable */
if (!skip_checks) {
/* check referenced features if they are enabled */
LY_ARRAY_FOR(f->iffeatures, struct lysc_iffeature, iff) {
if (lysc_iffeature_value(iff) == LY_ENOT) {
if (all) {
++disabled_count;
goto next;
} else {
LOGERR(ctx, LY_EDENIED,
"Feature \"%s\" cannot be enabled since it is disabled by its if-feature condition(s).",
f->name);
ret = LY_EDENIED;
goto cleanup;
}
}
}
}
/* enable the feature */
f->flags |= LYS_FENABLED;
} else { /* disable */
/* disable the feature */
f->flags &= ~LYS_FENABLED;
}
/* remember the changed feature */
ret = ly_set_add(changed, f, LY_SET_OPT_USEASLIST, NULL);
LY_CHECK_GOTO(ret, cleanup);
if (!all) {
/* stop in case changing a single feature */
break;
}
}
next:
;
}
if (!all && !changed->count) {
LOGERR(ctx, LY_EINVAL, "Feature \"%s\" not found in module \"%s\".", name, mod->name);
ret = LY_ENOTFOUND;
goto cleanup;
}
if (value && all && disabled_count) {
if (changed_count == changed->count) {
/* no change in last run -> not able to enable all ... */
/* ... print errors */
for (u = 0; disabled_count && u < LY_ARRAY_COUNT(mod->compiled->features); ++u) {
if (!(mod->compiled->features[u].flags & LYS_FENABLED)) {
LOGERR(ctx, LY_EDENIED,
"Feature \"%s\" cannot be enabled since it is disabled by its if-feature condition(s).",
mod->compiled->features[u].name);
--disabled_count;
}
}
/* ... restore the original state */
for (u = 0; u < changed->count; ++u) {
f = changed->objs[u];
/* re-disable the feature */
f->flags &= ~LYS_FENABLED;
}
ret = LY_EDENIED;
goto cleanup;
} else {
/* we did some change in last run, try it again */
changed_count = changed->count;
goto run;
}
}
/* reflect change(s) in the dependent features */
for (u = 0; !skip_checks && (u < changed->count); ++u) {
/* If a dependent feature is enabled, it can be now changed by the change (to false) of the value of
* its if-feature statements. The reverse logic, automatically enable feature when its feature is enabled
* is not done - by default, features are disabled and must be explicitely enabled. */
f = changed->objs[u];
LY_ARRAY_FOR(f->depfeatures, struct lysc_feature *, df) {
if (!((*df)->flags & LYS_FENABLED)) {
/* not enabled, nothing to do */
continue;
}
/* check the feature's if-features which could change by the previous change of our feature */
LY_ARRAY_FOR((*df)->iffeatures, struct lysc_iffeature, iff) {
if (lysc_iffeature_value(iff) == LY_ENOT) {
/* the feature must be disabled now */
(*df)->flags &= ~LYS_FENABLED;
/* add the feature into the list of changed features */
ret = ly_set_add(changed, *df, LY_SET_OPT_USEASLIST, NULL);
LY_CHECK_GOTO(ret, cleanup);
break;
}
}
}
}
cleanup:
ly_set_free(changed, NULL);
return ret;
}
API LY_ERR
lys_feature_enable(const struct lys_module *module, const char *feature)
{
LY_CHECK_ARG_RET(NULL, module, feature, LY_EINVAL);
return lys_feature_change((struct lys_module *)module, feature, 1, 0);
}
API LY_ERR
lys_feature_disable(const struct lys_module *module, const char *feature)
{
LY_CHECK_ARG_RET(NULL, module, feature, LY_EINVAL);
return lys_feature_change((struct lys_module *)module, feature, 0, 0);
}
API LY_ERR
lys_feature_enable_force(const struct lys_module *module, const char *feature)
{
LY_CHECK_ARG_RET(NULL, module, feature, LY_EINVAL);
return lys_feature_change((struct lys_module *)module, feature, 1, 1);
}
API LY_ERR
lys_feature_disable_force(const struct lys_module *module, const char *feature)
{
LY_CHECK_ARG_RET(NULL, module, feature, LY_EINVAL);
return lys_feature_change((struct lys_module *)module, feature, 0, 1);
}
API LY_ERR
lys_feature_value(const struct lys_module *module, const char *feature)
{
struct lysc_feature *f = NULL;
struct lysc_module *mod;
LY_ARRAY_COUNT_TYPE u;
LY_CHECK_ARG_RET(NULL, module, module->compiled, feature, -1);
mod = module->compiled;
/* search for the specified feature */
LY_ARRAY_FOR(mod->features, u) {
f = &mod->features[u];
if (!strcmp(f->name, feature)) {
break;
}
}
/* feature definition not found */
if (!f) {
return LY_ENOTFOUND;
}
/* feature disabled */
if (!(f->flags & LYS_FENABLED)) {
return LY_ENOT;
}
/* check referenced features if they are enabled */
LY_ARRAY_FOR(f->iffeatures, u) {
if (lysc_iffeature_value(&f->iffeatures[u]) == LY_ENOT) {
/* if-feature disabled */
return LY_ENOT;
}
}
/* feature enabled */
return LY_SUCCESS;
}
API const struct lysc_node *
lysc_node_is_disabled(const struct lysc_node *node, ly_bool recursive)
{
LY_ARRAY_COUNT_TYPE u;
LY_CHECK_ARG_RET(NULL, node, NULL);
do {
if (node->iffeatures) {
/* check local if-features */
LY_ARRAY_FOR(node->iffeatures, u) {
if (lysc_iffeature_value(&node->iffeatures[u]) == LY_ENOT) {
return node;
}
}
}
if (!recursive) {
return NULL;
}
/* go through schema-only parents */
node = node->parent;
} while (node && (node->nodetype & (LYS_CASE | LYS_CHOICE)));
return NULL;
}
API LY_ERR
lysc_node_set_private(const struct lysc_node *node, void *priv, void **prev_priv_p)
{
LY_CHECK_ARG_RET(NULL, node, LY_EINVAL);
if (prev_priv_p) {
*prev_priv_p = node->priv;
}
((struct lysc_node *)node)->priv = priv;
return LY_SUCCESS;
}
LY_ERR
lys_set_implemented_internal(struct lys_module *mod, uint8_t value)
{
struct lys_module *m;
LY_CHECK_ARG_RET(NULL, mod, LY_EINVAL);
if (mod->implemented) {
return LY_SUCCESS;
}
/* we have module from the current context */
m = ly_ctx_get_module_implemented(mod->ctx, mod->name);
if (m) {
if (m != mod) {
/* check collision with other implemented revision */
LOGERR(mod->ctx, LY_EDENIED, "Module \"%s\" is present in the context in other implemented revision (%s).",
mod->name, mod->revision ? mod->revision : "module without revision");
return LY_EDENIED;
} else {
/* mod is already implemented */
return LY_SUCCESS;
}
}
/* mark the module implemented, check for collision was already done */
mod->implemented = value;
/* compile the schema */
LY_CHECK_RET(lys_compile(mod, LYSC_OPT_INTERNAL));
return LY_SUCCESS;
}
API LY_ERR
lys_set_implemented(struct lys_module *mod)
{
return lys_set_implemented_internal(mod, 1);
}
static LY_ERR
lys_resolve_import_include(struct lys_parser_ctx *pctx, struct lysp_module *modp)
{
struct lysp_import *imp;
struct lysp_include *inc;
LY_ARRAY_COUNT_TYPE u, v;
modp->parsing = 1;
LY_ARRAY_FOR(modp->imports, u) {
imp = &modp->imports[u];
if (!imp->module) {
LY_CHECK_RET(lysp_load_module(PARSER_CTX(pctx), imp->name, imp->rev[0] ? imp->rev : NULL, 0, 0, &imp->module));
}
/* check for importing the same module twice */
for (v = 0; v < u; ++v) {
if (imp->module == modp->imports[v].module) {
LOGWRN(PARSER_CTX(pctx), "Single revision of the module \"%s\" imported twice.", imp->name);
}
}
}
LY_ARRAY_FOR(modp->includes, u) {
inc = &modp->includes[u];
if (!inc->submodule) {
LY_CHECK_RET(lysp_load_submodule(pctx, inc));
}
}
modp->parsing = 0;
return LY_SUCCESS;
}
LY_ERR
lys_parse_submodule(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format, struct lys_parser_ctx *main_ctx,
LY_ERR (*custom_check)(const struct ly_ctx *, struct lysp_module *, struct lysp_submodule *, void *),
void *check_data, struct lysp_submodule **submodule)
{
LY_ERR ret;
struct lysp_submodule *submod = NULL, *latest_sp;
struct lys_yang_parser_ctx *yangctx = NULL;
struct lys_yin_parser_ctx *yinctx = NULL;
struct lys_parser_ctx *pctx;
LY_CHECK_ARG_RET(ctx, ctx, in, LY_EINVAL);
switch (format) {
case LYS_IN_YIN:
ret = yin_parse_submodule(&yinctx, ctx, main_ctx, in, &submod);
pctx = (struct lys_parser_ctx *)yinctx;
break;
case LYS_IN_YANG:
ret = yang_parse_submodule(&yangctx, ctx, main_ctx, in, &submod);
pctx = (struct lys_parser_ctx *)yangctx;
break;
default:
LOGERR(ctx, LY_EINVAL, "Invalid schema input format.");
ret = LY_EINVAL;
break;
}
LY_CHECK_GOTO(ret, error);
/* make sure that the newest revision is at position 0 */
lysp_sort_revisions(submod->revs);
/* decide the latest revision */
latest_sp = ly_ctx_get_submodule(ctx, submod->belongsto, submod->name, NULL);
if (latest_sp) {
if (submod->revs) {
if (!latest_sp->revs) {
/* latest has no revision, so mod is anyway newer */
submod->latest_revision = latest_sp->latest_revision;
/* the latest_sp is zeroed later when the new module is being inserted into the context */
} else if (strcmp(submod->revs[0].date, latest_sp->revs[0].date) > 0) {
submod->latest_revision = latest_sp->latest_revision;
/* the latest_sp is zeroed later when the new module is being inserted into the context */
} else {
latest_sp = NULL;
}
} else {
latest_sp = NULL;
}
} else {
submod->latest_revision = 1;
}
if (custom_check) {
LY_CHECK_GOTO(ret = custom_check(ctx, NULL, submod, check_data), error);
}
if (latest_sp) {
latest_sp->latest_revision = 0;
}
lys_parser_fill_filepath(ctx, in, &submod->filepath);
/* resolve imports and includes */
LY_CHECK_GOTO(ret = lys_resolve_import_include(pctx, (struct lysp_module *)submod), error);
/* remap possibly changed and reallocated typedefs and groupings list back to the main context */
memcpy(&main_ctx->tpdfs_nodes, &pctx->tpdfs_nodes, sizeof main_ctx->tpdfs_nodes);
memcpy(&main_ctx->grps_nodes, &pctx->grps_nodes, sizeof main_ctx->grps_nodes);
if (format == LYS_IN_YANG) {
yang_parser_ctx_free(yangctx);
} else {
yin_parser_ctx_free(yinctx);
}
*submodule = submod;
return LY_SUCCESS;
error:
lysp_submodule_free(ctx, submod);
if (format == LYS_IN_YANG) {
yang_parser_ctx_free(yangctx);
} else {
yin_parser_ctx_free(yinctx);
}
return ret;
}
LY_ERR
lys_create_module(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format, ly_bool implement,
LY_ERR (*custom_check)(const struct ly_ctx *ctx, struct lysp_module *mod, struct lysp_submodule *submod, void *data),
void *check_data, struct lys_module **module)
{
struct lys_module *mod = NULL, *latest, *mod_dup;
LY_ERR ret;
LY_ARRAY_COUNT_TYPE u;
struct lys_yang_parser_ctx *yangctx = NULL;
struct lys_yin_parser_ctx *yinctx = NULL;
struct lys_parser_ctx *pctx = NULL;
char *filename, *rev, *dot;
size_t len;
LY_CHECK_ARG_RET(ctx, ctx, in, LY_EINVAL);
if (module) {
*module = NULL;
}
mod = calloc(1, sizeof *mod);
LY_CHECK_ERR_RET(!mod, LOGMEM(ctx), LY_EMEM);
mod->ctx = ctx;
switch (format) {
case LYS_IN_YIN:
ret = yin_parse_module(&yinctx, in, mod);
pctx = (struct lys_parser_ctx *)yinctx;
break;
case LYS_IN_YANG:
ret = yang_parse_module(&yangctx, in, mod);
pctx = (struct lys_parser_ctx *)yangctx;
break;
default:
LOGERR(ctx, LY_EINVAL, "Invalid schema input format.");
ret = LY_EINVAL;
break;
}
LY_CHECK_GOTO(ret, error);
/* make sure that the newest revision is at position 0 */
lysp_sort_revisions(mod->parsed->revs);
if (mod->parsed->revs) {
mod->revision = lydict_insert(ctx, mod->parsed->revs[0].date, 0);
}
/* decide the latest revision */
latest = (struct lys_module *)ly_ctx_get_module_latest(ctx, mod->name);
if (latest) {
if (mod->revision) {
if (!latest->revision) {
/* latest has no revision, so mod is anyway newer */
mod->latest_revision = latest->latest_revision;
/* the latest is zeroed later when the new module is being inserted into the context */
} else if (strcmp(mod->revision, latest->revision) > 0) {
mod->latest_revision = latest->latest_revision;
/* the latest is zeroed later when the new module is being inserted into the context */
} else {
latest = NULL;
}
} else {
latest = NULL;
}
} else {
mod->latest_revision = 1;
}
if (custom_check) {
LY_CHECK_GOTO(ret = custom_check(ctx, mod->parsed, NULL, check_data), error);
}
if (implement) {
/* mark the loaded module implemented */
if (ly_ctx_get_module_implemented(ctx, mod->name)) {
LOGERR(ctx, LY_EDENIED, "Module \"%s\" is already implemented in the context.", mod->name);
ret = LY_EDENIED;
goto error;
}
mod->implemented = 1;
}
/* check for duplicity in the context */
mod_dup = (struct lys_module *)ly_ctx_get_module(ctx, mod->name, mod->revision);
if (mod_dup) {
if (mod_dup->parsed) {
/* error */
if (mod->parsed->revs) {
LOGERR(ctx, LY_EEXIST, "Module \"%s\" of revision \"%s\" is already present in the context.",
mod->name, mod->parsed->revs[0].date);
} else {
LOGERR(ctx, LY_EEXIST, "Module \"%s\" with no revision is already present in the context.",
mod->name);
}
ret = LY_EEXIST;
goto error;
} else {
/* add the parsed data to the currently compiled-only module in the context */
mod_dup->parsed = mod->parsed;
mod_dup->parsed->mod = mod_dup;
mod->parsed = NULL;
lys_module_free(mod, NULL);
mod = mod_dup;
goto finish_parsing;
}
}
switch (in->type) {
case LY_IN_FILEPATH:
/* check that name and revision match filename */
filename = strrchr(in->method.fpath.filepath, '/');
if (!filename) {
filename = in->method.fpath.filepath;
} else {
filename++;
}
rev = strchr(filename, '@');
dot = strrchr(filename, '.');
/* name */
len = strlen(mod->name);
if (strncmp(filename, mod->name, len) ||
((rev && rev != &filename[len]) || (!rev && dot != &filename[len]))) {
LOGWRN(ctx, "File name \"%s\" does not match module name \"%s\".", filename, mod->name);
}
if (rev) {
len = dot - ++rev;
if (!mod->parsed->revs || len != 10 || strncmp(mod->parsed->revs[0].date, rev, len)) {
LOGWRN(ctx, "File name \"%s\" does not match module revision \"%s\".", filename,
mod->parsed->revs ? mod->parsed->revs[0].date : "none");
}
}
break;
case LY_IN_FD:
case LY_IN_FILE:
case LY_IN_MEMORY:
/* nothing special to do */
break;
case LY_IN_ERROR:
LOGINT(ctx);
ret = LY_EINT;
goto error;
}
lys_parser_fill_filepath(ctx, in, &mod->filepath);
if (!mod->implemented) {
/* pre-compile features and identities of the module */
LY_CHECK_GOTO(ret = lys_feature_precompile(NULL, ctx, mod, mod->parsed->features, &mod->dis_features), error);
LY_CHECK_GOTO(ret = lys_identity_precompile(NULL, ctx, mod, mod->parsed->identities, &mod->dis_identities), error);
}
if (latest) {
latest->latest_revision = 0;
}
/* add into context */
ret = ly_set_add(&ctx->list, mod, LY_SET_OPT_USEASLIST, NULL);
LY_CHECK_GOTO(ret, error);
ctx->module_set_id++;
finish_parsing:
/* resolve imports and includes */
LY_CHECK_GOTO(ret = lys_resolve_import_include(pctx, mod->parsed), error_ctx);
if (!mod->implemented) {
/* pre-compile features and identities of any submodules */
LY_ARRAY_FOR(mod->parsed->includes, u) {
LY_CHECK_GOTO(ret = lys_feature_precompile(NULL, ctx, mod, mod->parsed->includes[u].submodule->features,
&mod->dis_features), error);
LY_CHECK_GOTO(ret = lys_identity_precompile(NULL, ctx, mod, mod->parsed->includes[u].submodule->identities,
&mod->dis_identities), error);
}
}
/* check name collisions - typedefs and TODO groupings */
LY_CHECK_GOTO(ret = lysp_check_typedefs(pctx, mod->parsed), error_ctx);
/* compile */
if (!mod->compiled) {
ret = lys_compile(mod, 0);
LY_CHECK_GOTO(ret, error_ctx);
}
if (format == LYS_IN_YANG) {
yang_parser_ctx_free(yangctx);
} else {
yin_parser_ctx_free(yinctx);
}
if (module) {
*module = mod;
}
return LY_SUCCESS;
error_ctx:
ly_set_rm(&ctx->list, mod, NULL);
error:
lys_module_free(mod, NULL);
if (pctx) {
ly_set_erase(&pctx->tpdfs_nodes, NULL);
}
if (format == LYS_IN_YANG) {
yang_parser_ctx_free(yangctx);
} else {
yin_parser_ctx_free(yinctx);
}
return ret;
}
API LY_ERR
lys_parse(struct ly_ctx *ctx, struct ly_in *in, LYS_INFORMAT format, const struct lys_module **module)
{
if (module) {
*module = NULL;
}
LY_CHECK_ARG_RET(NULL, ctx, in, format > LYS_IN_UNKNOWN, LY_EINVAL);
/* remember input position */
in->func_start = in->current;
return lys_create_module(ctx, in, format, 1, NULL, NULL, (struct lys_module **)module);
}
API LY_ERR
lys_parse_mem(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format, const struct lys_module **module)
{
LY_ERR ret;
struct ly_in *in = NULL;
LY_CHECK_ARG_RET(ctx, data, format != LYS_IN_UNKNOWN, LY_EINVAL);
LY_CHECK_ERR_RET(ret = ly_in_new_memory(data, &in), LOGERR(ctx, ret, "Unable to create input handler."), ret);
ret = lys_parse(ctx, in, format, module);
ly_in_free(in, 0);
return ret;
}
API LY_ERR
lys_parse_fd(struct ly_ctx *ctx, int fd, LYS_INFORMAT format, const struct lys_module **module)
{
LY_ERR ret;
struct ly_in *in = NULL;
LY_CHECK_ARG_RET(ctx, fd > -1, format != LYS_IN_UNKNOWN, LY_EINVAL);
LY_CHECK_ERR_RET(ret = ly_in_new_fd(fd, &in), LOGERR(ctx, ret, "Unable to create input handler."), ret);
ret = lys_parse(ctx, in, format, module);
ly_in_free(in, 0);
return ret;
}
API LY_ERR
lys_parse_path(struct ly_ctx *ctx, const char *path, LYS_INFORMAT format, const struct lys_module **module)
{
LY_ERR ret;
struct ly_in *in = NULL;
LY_CHECK_ARG_RET(ctx, path, format != LYS_IN_UNKNOWN, LY_EINVAL);
LY_CHECK_ERR_RET(ret = ly_in_new_filepath(path, 0, &in),
LOGERR(ctx, ret, "Unable to create input handler for filepath %s.", path), ret);
ret = lys_parse(ctx, in, format, module);
ly_in_free(in, 0);
return ret;
}
API LY_ERR
lys_search_localfile(const char * const *searchpaths, ly_bool cwd, const char *name, const char *revision,
char **localfile, LYS_INFORMAT *format)
{
LY_ERR ret = LY_EMEM;
size_t len, flen, match_len = 0, dir_len;
ly_bool implicit_cwd = 0;
char *wd, *wn = NULL;
DIR *dir = NULL;
struct dirent *file;
char *match_name = NULL;
LYS_INFORMAT format_aux, match_format = 0;
struct ly_set *dirs;
struct stat st;
LY_CHECK_ARG_RET(NULL, localfile, LY_EINVAL);
/* start to fill the dir fifo with the context's search path (if set)
* and the current working directory */
LY_CHECK_RET(ly_set_new(&dirs));
len = strlen(name);
if (cwd) {
wd = get_current_dir_name();
if (!wd) {
LOGMEM(NULL);
goto cleanup;
} else {
/* add implicit current working directory (./) to be searched,
* this directory is not searched recursively */
ret = ly_set_add(dirs, wd, 0, NULL);
LY_CHECK_GOTO(ret, cleanup);
implicit_cwd = 1;
}
}
if (searchpaths) {
for (uint64_t i = 0; searchpaths[i]; i++) {
/* check for duplicities with the implicit current working directory */
if (implicit_cwd && !strcmp(dirs->objs[0], searchpaths[i])) {
implicit_cwd = 0;
continue;
}
wd = strdup(searchpaths[i]);
if (!wd) {
LOGMEM(NULL);
goto cleanup;
} else {
ret = ly_set_add(dirs, wd, 0, NULL);
LY_CHECK_GOTO(ret, cleanup);
}
}
}
wd = NULL;
/* start searching */
while (dirs->count) {
free(wd);
free(wn); wn = NULL;
dirs->count--;
wd = (char *)dirs->objs[dirs->count];
dirs->objs[dirs->count] = NULL;
LOGVRB("Searching for \"%s\" in %s.", name, wd);
if (dir) {
closedir(dir);
}
dir = opendir(wd);
dir_len = strlen(wd);
if (!dir) {
LOGWRN(NULL, "Unable to open directory \"%s\" for searching (sub)modules (%s).", wd, strerror(errno));
} else {
while ((file = readdir(dir))) {
if (!strcmp(".", file->d_name) || !strcmp("..", file->d_name)) {
/* skip . and .. */
continue;
}
free(wn);
if (asprintf(&wn, "%s/%s", wd, file->d_name) == -1) {
LOGMEM(NULL);
goto cleanup;
}
if (stat(wn, &st) == -1) {
LOGWRN(NULL, "Unable to get information about \"%s\" file in \"%s\" when searching for (sub)modules (%s)",
file->d_name, wd, strerror(errno));
continue;
}
if (S_ISDIR(st.st_mode) && (dirs->count || !implicit_cwd)) {
/* we have another subdirectory in searchpath to explore,
* subdirectories are not taken into account in current working dir (dirs->set.g[0]) */
ret = ly_set_add(dirs, wn, 0, NULL);
LY_CHECK_GOTO(ret, cleanup);
/* continue with the next item in current directory */
wn = NULL;
continue;
} else if (!S_ISREG(st.st_mode)) {
/* not a regular file (note that we see the target of symlinks instead of symlinks */
continue;
}
/* here we know that the item is a file which can contain a module */
if (strncmp(name, file->d_name, len) ||
(file->d_name[len] != '.' && file->d_name[len] != '@')) {
/* different filename than the module we search for */
continue;
}
/* get type according to filename suffix */
flen = strlen(file->d_name);
if (!strcmp(&file->d_name[flen - 5], ".yang")) {
format_aux = LYS_IN_YANG;
/* TODO YIN parser
} else if (!strcmp(&file->d_name[flen - 4], ".yin")) {
format_aux = LYS_IN_YIN;
*/
} else {
/* not supportde suffix/file format */
continue;
}
if (revision) {
/* we look for the specific revision, try to get it from the filename */
if (file->d_name[len] == '@') {
/* check revision from the filename */
if (strncmp(revision, &file->d_name[len + 1], strlen(revision))) {
/* another revision */
continue;
} else {
/* exact revision */
free(match_name);
match_name = wn;
wn = NULL;
match_len = dir_len + 1 + len;
match_format = format_aux;
goto success;
}
} else {
/* continue trying to find exact revision match, use this only if not found */
free(match_name);
match_name = wn;
wn = NULL;
match_len = dir_len + 1 + len;
match_format = format_aux;
continue;
}
} else {
/* remember the revision and try to find the newest one */
if (match_name) {
if (file->d_name[len] != '@' ||
lysp_check_date(NULL, &file->d_name[len + 1], flen - (format_aux == LYS_IN_YANG ? 5 : 4) - len - 1, NULL)) {
continue;
} else if (match_name[match_len] == '@' &&
(strncmp(&match_name[match_len + 1], &file->d_name[len + 1], LY_REV_SIZE - 1) >= 0)) {
continue;
}
free(match_name);
}
match_name = wn;
wn = NULL;
match_len = dir_len + 1 + len;
match_format = format_aux;
continue;
}
}
}
}
success:
(*localfile) = match_name;
match_name = NULL;
if (format) {
(*format) = match_format;
}
ret = LY_SUCCESS;
cleanup:
free(wn);
free(wd);
if (dir) {
closedir(dir);
}
free(match_name);
ly_set_free(dirs, free);
return ret;
}