src/tree_data_helpers.c - github/CESNET/libyang - Gitiles

 /**
  * @file tree_data_helpers.c
  * @author Radek Krejci <rkrejci@cesnet.cz>
  * @brief Parsing and validation helper functions for data trees
  *
  * 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
  */

 #include <assert.h>
 #include <stdint.h>
 #include <stdlib.h>
 #include <string.h>

 #include "common.h"
 #include "context.h"
 #include "dict.h"
 #include "hash_table.h"
 #include "log.h"
 #include "lyb.h"
 #include "parser_data.h"
 #include "set.h"
 #include "tree.h"
 #include "tree_data.h"
 #include "tree_data_internal.h"
 #include "tree_schema.h"

 struct lyd_node *
 lys_getnext_data(const struct lyd_node *last, const struct lyd_node *sibling, const struct lysc_node **slast,
         const struct lysc_node *parent, const struct lysc_module *module)
 {
     const struct lysc_node *siter = NULL;
     struct lyd_node *match = NULL;

     assert(parent || module);
     assert(!last || (slast && *slast));

     if (slast) {
         siter = *slast;
     }

     if (last && last->next && (last->next->schema == siter)) {
         /* return next data instance */
         return last->next;
     }

     /* find next schema node data instance */
     while ((siter = lys_getnext(siter, parent, module, 0))) {
         if (!lyd_find_sibling_val(sibling, siter, NULL, 0, &match)) {
             break;
         }
     }

     if (slast) {
         *slast = siter;
     }
     return match;
 }

 struct lyd_node **
 lyd_node_children_p(struct lyd_node *node)
 {
     assert(node);

     if (!node->schema) {
         return &((struct lyd_node_opaq *)node)->child;
     } else {
         switch (node->schema->nodetype) {
         case LYS_CONTAINER:
         case LYS_LIST:
         case LYS_RPC:
         case LYS_ACTION:
         case LYS_NOTIF:
             return &((struct lyd_node_inner *)node)->child;
         default:
             return NULL;
         }
     }
 }

 API struct lyd_node *
 lyd_parent(const struct lyd_node *node)
 {
     if (!node) {
         return NULL;
     }

     return (struct lyd_node *)(node)->parent;
 }

 API struct lyd_node *
 lyd_child(const struct lyd_node *node)
 {
     struct lyd_node **children;

     if (!node) {
         return NULL;
     }

     if (!node->schema) {
         /* opaq node */
         return ((struct lyd_node_opaq *)(node))->child;
     }

     children = lyd_node_children_p((struct lyd_node *)node);
     if (children) {
         return *children;
     } else {
         return NULL;
     }
 }

 API struct lyd_node *
 lyd_child_no_keys(const struct lyd_node *node)
 {
     struct lyd_node **children;

     if (!node) {
         return NULL;
     }

     if (!node->schema) {
         /* opaq node */
         return ((struct lyd_node_opaq *)(node))->child;
     }

     children = lyd_node_children_p((struct lyd_node *)node);
     if (children) {
         struct lyd_node *child = *children;
         while (child && child->schema && (child->schema->flags & LYS_KEY)) {
             child = child->next;
         }
         return child;
     } else {
         return NULL;
     }
 }

 API const struct lys_module *
 lyd_owner_module(const struct lyd_node *node)
 {
     const struct lysc_node *schema;

     if (!node || !node->schema) {
         return NULL;
     }

     for (schema = node->schema; schema->parent; schema = schema->parent) {}
     return schema->module;
 }

 API const struct lysc_when *
 lyd_has_when(const struct lyd_node *node)
 {
     const struct lysc_node *schema;

     if (!node || !node->schema) {
         return NULL;
     }

     schema = node->schema;
     do {
         if (schema->when) {
             return *schema->when;
         }
         schema = schema->parent;
     } while (schema && (schema->nodetype & (LYS_CASE | LYS_CHOICE)));

     return NULL;
 }

 const struct lys_module *
 lyd_mod_next_module(struct lyd_node *tree, const struct lys_module *module, const struct ly_ctx *ctx, uint32_t *i,
         struct lyd_node **first)
 {
     struct lyd_node *iter;
     const struct lys_module *mod;

     /* get the next module */
     if (module) {
         if (*i) {
             mod = NULL;
         } else {
             mod = module;
             ++(*i);
         }
     } else {
         do {
             mod = ly_ctx_get_module_iter(ctx, i);
         } while (mod && !mod->implemented);
     }

     /* find its data */
     *first = NULL;
     if (mod) {
         LY_LIST_FOR(tree, iter) {
             if (lyd_owner_module(iter) == mod) {
                 *first = iter;
                 break;
             }
         }
     }

     return mod;
 }

 const struct lys_module *
 lyd_data_next_module(struct lyd_node **next, struct lyd_node **first)
 {
     const struct lys_module *mod;

     if (!*next) {
         /* all data traversed */
         *first = NULL;
         return NULL;
     }

     *first = *next;

     /* prepare next */
     mod = lyd_owner_module(*next);
     LY_LIST_FOR(*next, *next) {
         if (lyd_owner_module(*next) != mod) {
             break;
         }
     }

     return mod;
 }

 LY_ERR
 lyd_parse_check_keys(struct lyd_node *node)
 {
     const struct lysc_node *skey = NULL;
     const struct lyd_node *key;

     assert(node->schema->nodetype == LYS_LIST);

     key = lyd_child(node);
     while ((skey = lys_getnext(skey, node->schema, NULL, 0)) && (skey->flags & LYS_KEY)) {
         if (!key || (key->schema != skey)) {
             LOGVAL(LYD_CTX(node), LY_VLOG_LYD, node, LY_VCODE_NOKEY, skey->name);
             return LY_EVALID;
         }

         key = key->next;
     }

     return LY_SUCCESS;
 }

 void
 lyd_parse_set_data_flags(struct lyd_node *node, struct ly_set *when_check, struct lyd_meta **meta, uint32_t options)
 {
     struct lyd_meta *meta2, *prev_meta = NULL;

     if (!(node->schema->nodetype & (LYS_RPC | LYS_ACTION | LYS_NOTIF)) && node->schema->when) {
         if (!(options & LYD_PARSE_ONLY)) {
             /* remember we need to evaluate this node's when */
             LY_CHECK_RET(ly_set_add(when_check, node, 1, NULL), );
         }
     }

     LY_LIST_FOR(*meta, meta2) {
         if (!strcmp(meta2->name, "default") && !strcmp(meta2->annotation->module->name, "ietf-netconf-with-defaults") &&
                 meta2->value.boolean) {
             /* node is default according to the metadata */
             node->flags |= LYD_DEFAULT;

             /* delete the metadata */
             if (prev_meta) {
                 prev_meta->next = meta2->next;
             } else {
                 *meta = (*meta)->next;
             }
             lyd_free_meta_single(meta2);
             break;
         }

         prev_meta = meta2;
     }
 }

 API LY_ERR
 lyd_any_copy_value(struct lyd_node *trg, const union lyd_any_value *value, LYD_ANYDATA_VALUETYPE value_type)
 {
     struct lyd_node_any *t;

     assert(trg->schema->nodetype & LYS_ANYDATA);

     t = (struct lyd_node_any *)trg;

     /* free trg */
     switch (t->value_type) {
     case LYD_ANYDATA_DATATREE:
         lyd_free_all(t->value.tree);
         break;
     case LYD_ANYDATA_STRING:
     case LYD_ANYDATA_XML:
     case LYD_ANYDATA_JSON:
         FREE_STRING(LYD_CTX(trg), t->value.str);
         break;
     case LYD_ANYDATA_LYB:
         free(t->value.mem);
         break;
     }
     t->value.str = NULL;

     if (!value) {
         /* only free value in this case */
         return LY_SUCCESS;
     }

     /* copy src */
     t->value_type = value_type;
     switch (value_type) {
     case LYD_ANYDATA_DATATREE:
         if (value->tree) {
             LY_CHECK_RET(lyd_dup_siblings(value->tree, NULL, LYD_DUP_RECURSIVE, &t->value.tree));
         }
         break;
     case LYD_ANYDATA_STRING:
     case LYD_ANYDATA_XML:
     case LYD_ANYDATA_JSON:
         if (value->str) {
             LY_CHECK_RET(lydict_insert(LYD_CTX(trg), value->str, 0, &t->value.str));
         }
         break;
     case LYD_ANYDATA_LYB:
         if (value->mem) {
             int len = lyd_lyb_data_length(value->mem);
             LY_CHECK_RET(len == -1, LY_EINVAL);
             t->value.mem = malloc(len);
             LY_CHECK_ERR_RET(!t->value.mem, LOGMEM(LYD_CTX(trg)), LY_EMEM);
             memcpy(t->value.mem, value->mem, len);
         }
         break;
     }

     return LY_SUCCESS;
 }

 LYB_HASH
 lyb_hash(struct lysc_node *sibling, uint8_t collision_id)
 {
     const struct lys_module *mod;
     uint32_t full_hash;
     LYB_HASH hash;

     if ((collision_id < LYS_NODE_HASH_COUNT) && sibling->hash[collision_id]) {
         return sibling->hash[collision_id];
     }

     mod = sibling->module;

     full_hash = dict_hash_multi(0, mod->name, strlen(mod->name));
     full_hash = dict_hash_multi(full_hash, sibling->name, strlen(sibling->name));
     if (collision_id) {
         size_t ext_len;

         if (collision_id > strlen(mod->name)) {
             /* fine, we will not hash more bytes, just use more bits from the hash than previously */
             ext_len = strlen(mod->name);
         } else {
             /* use one more byte from the module name than before */
             ext_len = collision_id;
         }
         full_hash = dict_hash_multi(full_hash, mod->name, ext_len);
     }
     full_hash = dict_hash_multi(full_hash, NULL, 0);

     /* use the shortened hash */
     hash = full_hash & (LYB_HASH_MASK >> collision_id);
     /* add colision identificator */
     hash |= LYB_HASH_COLLISION_ID >> collision_id;

     /* save this hash */
     if (collision_id < LYS_NODE_HASH_COUNT) {
         sibling->hash[collision_id] = hash;
     }

     return hash;
 }

 ly_bool
 lyb_has_schema_model(const struct lysc_node *sibling, const struct lys_module **models)
 {
     LY_ARRAY_COUNT_TYPE u;

     LY_ARRAY_FOR(models, u) {
         if (sibling->module == models[u]) {
             return 1;
         }
     }

     return 0;
 }
	/**
	* @file tree_data_helpers.c
	* @author Radek Krejci <rkrejci@cesnet.cz>
	* @brief Parsing and validation helper functions for data trees
	*
	* 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
	*/

	#include <assert.h>
	#include <stdint.h>
	#include <stdlib.h>
	#include <string.h>

	#include "common.h"
	#include "context.h"
	#include "dict.h"
	#include "hash_table.h"
	#include "log.h"
	#include "lyb.h"
	#include "parser_data.h"
	#include "set.h"
	#include "tree.h"
	#include "tree_data.h"
	#include "tree_data_internal.h"
	#include "tree_schema.h"

	struct lyd_node *
	lys_getnext_data(const struct lyd_node last, const struct lyd_node sibling, const struct lysc_node **slast,
	const struct lysc_node parent, const struct lysc_module module)
	{
	const struct lysc_node *siter = NULL;
	struct lyd_node *match = NULL;

	assert(parent \|\| module);
	assert(!last \|\| (slast && *slast));

	if (slast) {
	siter = *slast;
	}

	if (last && last->next && (last->next->schema == siter)) {
	/* return next data instance */
	return last->next;
	}

	/* find next schema node data instance */
	while ((siter = lys_getnext(siter, parent, module, 0))) {
	if (!lyd_find_sibling_val(sibling, siter, NULL, 0, &match)) {
	break;
	}
	}

	if (slast) {
	*slast = siter;
	}
	return match;
	}

	struct lyd_node **
	lyd_node_children_p(struct lyd_node *node)
	{
	assert(node);

	if (!node->schema) {
	return &((struct lyd_node_opaq *)node)->child;
	} else {
	switch (node->schema->nodetype) {
	case LYS_CONTAINER:
	case LYS_LIST:
	case LYS_RPC:
	case LYS_ACTION:
	case LYS_NOTIF:
	return &((struct lyd_node_inner *)node)->child;
	default:
	return NULL;
	}
	}
	}

	API struct lyd_node *
	lyd_parent(const struct lyd_node *node)
	{
	if (!node) {
	return NULL;
	}

	return (struct lyd_node *)(node)->parent;
	}

	API struct lyd_node *
	lyd_child(const struct lyd_node *node)
	{
	struct lyd_node **children;

	if (!node) {
	return NULL;
	}

	if (!node->schema) {
	/* opaq node */
	return ((struct lyd_node_opaq *)(node))->child;
	}

	children = lyd_node_children_p((struct lyd_node *)node);
	if (children) {
	return *children;
	} else {
	return NULL;
	}
	}

	API struct lyd_node *
	lyd_child_no_keys(const struct lyd_node *node)
	{
	struct lyd_node **children;

	if (!node) {
	return NULL;
	}

	if (!node->schema) {
	/* opaq node */
	return ((struct lyd_node_opaq *)(node))->child;
	}

	children = lyd_node_children_p((struct lyd_node *)node);
	if (children) {
	struct lyd_node child = children;
	while (child && child->schema && (child->schema->flags & LYS_KEY)) {
	child = child->next;
	}
	return child;
	} else {
	return NULL;
	}
	}

	API const struct lys_module *
	lyd_owner_module(const struct lyd_node *node)
	{
	const struct lysc_node *schema;

	if (!node \|\| !node->schema) {
	return NULL;
	}

	for (schema = node->schema; schema->parent; schema = schema->parent) {}
	return schema->module;
	}

	API const struct lysc_when *
	lyd_has_when(const struct lyd_node *node)
	{
	const struct lysc_node *schema;

	if (!node \|\| !node->schema) {
	return NULL;
	}

	schema = node->schema;
	do {
	if (schema->when) {
	return *schema->when;
	}
	schema = schema->parent;
	} while (schema && (schema->nodetype & (LYS_CASE \| LYS_CHOICE)));

	return NULL;
	}

	const struct lys_module *
	lyd_mod_next_module(struct lyd_node tree, const struct lys_module module, const struct ly_ctx ctx, uint32_t i,
	struct lyd_node **first)
	{
	struct lyd_node *iter;
	const struct lys_module *mod;

	/* get the next module */
	if (module) {
	if (*i) {
	mod = NULL;
	} else {
	mod = module;
	++(*i);
	}
	} else {
	do {
	mod = ly_ctx_get_module_iter(ctx, i);
	} while (mod && !mod->implemented);
	}

	/* find its data */
	*first = NULL;
	if (mod) {
	LY_LIST_FOR(tree, iter) {
	if (lyd_owner_module(iter) == mod) {
	*first = iter;
	break;
	}
	}
	}

	return mod;
	}

	const struct lys_module *
	lyd_data_next_module(struct lyd_node next, struct lyd_node first)
	{
	const struct lys_module *mod;

	if (!*next) {
	/* all data traversed */
	*first = NULL;
	return NULL;
	}

	first = next;

	/* prepare next */
	mod = lyd_owner_module(*next);
	LY_LIST_FOR(next, next) {
	if (lyd_owner_module(*next) != mod) {
	break;
	}
	}

	return mod;
	}

	LY_ERR
	lyd_parse_check_keys(struct lyd_node *node)
	{
	const struct lysc_node *skey = NULL;
	const struct lyd_node *key;

	assert(node->schema->nodetype == LYS_LIST);

	key = lyd_child(node);
	while ((skey = lys_getnext(skey, node->schema, NULL, 0)) && (skey->flags & LYS_KEY)) {
	if (!key \|\| (key->schema != skey)) {
	LOGVAL(LYD_CTX(node), LY_VLOG_LYD, node, LY_VCODE_NOKEY, skey->name);
	return LY_EVALID;
	}

	key = key->next;
	}

	return LY_SUCCESS;
	}

	void
	lyd_parse_set_data_flags(struct lyd_node node, struct ly_set when_check, struct lyd_meta **meta, uint32_t options)
	{
	struct lyd_meta meta2, prev_meta = NULL;

	if (!(node->schema->nodetype & (LYS_RPC \| LYS_ACTION \| LYS_NOTIF)) && node->schema->when) {
	if (!(options & LYD_PARSE_ONLY)) {
	/* remember we need to evaluate this node's when */
	LY_CHECK_RET(ly_set_add(when_check, node, 1, NULL), );
	}
	}

	LY_LIST_FOR(*meta, meta2) {
	if (!strcmp(meta2->name, "default") && !strcmp(meta2->annotation->module->name, "ietf-netconf-with-defaults") &&
	meta2->value.boolean) {
	/* node is default according to the metadata */
	node->flags \|= LYD_DEFAULT;

	/* delete the metadata */
	if (prev_meta) {
	prev_meta->next = meta2->next;
	} else {
	meta = (meta)->next;
	}
	lyd_free_meta_single(meta2);
	break;
	}

	prev_meta = meta2;
	}
	}

	API LY_ERR
	lyd_any_copy_value(struct lyd_node trg, const union lyd_any_value value, LYD_ANYDATA_VALUETYPE value_type)
	{
	struct lyd_node_any *t;

	assert(trg->schema->nodetype & LYS_ANYDATA);

	t = (struct lyd_node_any *)trg;

	/* free trg */
	switch (t->value_type) {
	case LYD_ANYDATA_DATATREE:
	lyd_free_all(t->value.tree);
	break;
	case LYD_ANYDATA_STRING:
	case LYD_ANYDATA_XML:
	case LYD_ANYDATA_JSON:
	FREE_STRING(LYD_CTX(trg), t->value.str);
	break;
	case LYD_ANYDATA_LYB:
	free(t->value.mem);
	break;
	}
	t->value.str = NULL;

	if (!value) {
	/* only free value in this case */
	return LY_SUCCESS;
	}

	/* copy src */
	t->value_type = value_type;
	switch (value_type) {
	case LYD_ANYDATA_DATATREE:
	if (value->tree) {
	LY_CHECK_RET(lyd_dup_siblings(value->tree, NULL, LYD_DUP_RECURSIVE, &t->value.tree));
	}
	break;
	case LYD_ANYDATA_STRING:
	case LYD_ANYDATA_XML:
	case LYD_ANYDATA_JSON:
	if (value->str) {
	LY_CHECK_RET(lydict_insert(LYD_CTX(trg), value->str, 0, &t->value.str));
	}
	break;
	case LYD_ANYDATA_LYB:
	if (value->mem) {
	int len = lyd_lyb_data_length(value->mem);
	LY_CHECK_RET(len == -1, LY_EINVAL);
	t->value.mem = malloc(len);
	LY_CHECK_ERR_RET(!t->value.mem, LOGMEM(LYD_CTX(trg)), LY_EMEM);
	memcpy(t->value.mem, value->mem, len);
	}
	break;
	}

	return LY_SUCCESS;
	}

	LYB_HASH
	lyb_hash(struct lysc_node *sibling, uint8_t collision_id)
	{
	const struct lys_module *mod;
	uint32_t full_hash;
	LYB_HASH hash;

	if ((collision_id < LYS_NODE_HASH_COUNT) && sibling->hash[collision_id]) {
	return sibling->hash[collision_id];
	}

	mod = sibling->module;

	full_hash = dict_hash_multi(0, mod->name, strlen(mod->name));
	full_hash = dict_hash_multi(full_hash, sibling->name, strlen(sibling->name));
	if (collision_id) {
	size_t ext_len;

	if (collision_id > strlen(mod->name)) {
	/* fine, we will not hash more bytes, just use more bits from the hash than previously */
	ext_len = strlen(mod->name);
	} else {
	/* use one more byte from the module name than before */
	ext_len = collision_id;
	}
	full_hash = dict_hash_multi(full_hash, mod->name, ext_len);
	}
	full_hash = dict_hash_multi(full_hash, NULL, 0);

	/* use the shortened hash */
	hash = full_hash & (LYB_HASH_MASK >> collision_id);
	/* add colision identificator */
	hash \|= LYB_HASH_COLLISION_ID >> collision_id;

	/* save this hash */
	if (collision_id < LYS_NODE_HASH_COUNT) {
	sibling->hash[collision_id] = hash;
	}

	return hash;
	}

	ly_bool
	lyb_has_schema_model(const struct lysc_node sibling, const struct lys_module *models)
	{
	LY_ARRAY_COUNT_TYPE u;

	LY_ARRAY_FOR(models, u) {
	if (sibling->module == models[u]) {
	return 1;
	}
	}

	return 0;
	}