Loading...
Searching...
No Matches
node_instanceid.c
Go to the documentation of this file.
#include "plugins_types.h"
#include <stdint.h>
#include <stdlib.h>
#include "libyang.h"
/* additional internal headers for some useful simple macros */
#include "compat.h"
#include "ly_common.h"
#include "path.h"
#include "plugins_internal.h" /* LY_TYPE_*_STR */
#include "xpath.h"
static LY_ERR
node_instanceid_path2str(const struct ly_path *path, LY_VALUE_FORMAT format, void *prefix_data, char **str)
{
LY_ERR ret = LY_SUCCESS;
LY_ARRAY_COUNT_TYPE u, v;
char *result = NULL, quot;
const struct lys_module *mod = NULL, *local_mod = NULL;
struct ly_set *mods;
ly_bool inherit_prefix = 0, d;
const char *strval;
if (!path) {
/* special path */
ret = ly_strcat(&result, "/");
goto cleanup;
}
switch (format) {
case LY_VALUE_XML:
/* null the local module so that all the prefixes are printed */
mods = prefix_data;
local_mod = mods->objs[0];
mods->objs[0] = NULL;
/* fallthrough */
case LY_VALUE_SCHEMA:
case LY_VALUE_SCHEMA_RESOLVED:
/* everything is prefixed */
inherit_prefix = 0;
break;
case LY_VALUE_CANON:
case LY_VALUE_JSON:
case LY_VALUE_LYB:
case LY_VALUE_STR_NS:
/* the same prefix is inherited and skipped */
inherit_prefix = 1;
break;
}
LY_ARRAY_FOR(path, u) {
/* new node */
if (!inherit_prefix || (mod != path[u].node->module)) {
mod = path[u].node->module;
ret = ly_strcat(&result, "/%s:%s", lyplg_type_get_prefix(mod, format, prefix_data), path[u].node->name);
} else {
ret = ly_strcat(&result, "/%s", path[u].node->name);
}
LY_CHECK_GOTO(ret, cleanup);
/* node predicates */
LY_ARRAY_FOR(path[u].predicates, v) {
struct ly_path_predicate *pred = &path[u].predicates[v];
switch (pred->type) {
case LY_PATH_PREDTYPE_POSITION:
/* position predicate */
ret = ly_strcat(&result, "[%" PRIu64 "]", pred->position);
break;
case LY_PATH_PREDTYPE_LIST:
/* key-predicate */
strval = pred->value.realtype->plugin->print(path[u].node->module->ctx, &pred->value, format, prefix_data,
&d, NULL);
/* default quote */
quot = '\'';
if (strchr(strval, quot)) {
quot = '"';
}
if (inherit_prefix) {
/* always the same prefix as the parent */
ret = ly_strcat(&result, "[%s=%c%s%c]", pred->key->name, quot, strval, quot);
} else {
ret = ly_strcat(&result, "[%s:%s=%c%s%c]", lyplg_type_get_prefix(pred->key->module, format, prefix_data),
pred->key->name, quot, strval, quot);
}
if (d) {
free((char *)strval);
}
break;
case LY_PATH_PREDTYPE_LEAFLIST:
/* leaf-list-predicate */
strval = pred->value.realtype->plugin->print(path[u].node->module->ctx, &pred->value, format, prefix_data,
&d, NULL);
/* default quote */
quot = '\'';
if (strchr(strval, quot)) {
quot = '"';
}
ret = ly_strcat(&result, "[.=%c%s%c]", quot, strval, quot);
if (d) {
free((char *)strval);
}
break;
case LY_PATH_PREDTYPE_LIST_VAR:
/* key-predicate with a variable */
if (inherit_prefix) {
/* always the same prefix as the parent */
ret = ly_strcat(&result, "[%s=$%s]", pred->key->name, pred->variable);
} else {
ret = ly_strcat(&result, "[%s:%s=$%s]", lyplg_type_get_prefix(pred->key->module, format, prefix_data),
pred->key->name, pred->variable);
}
break;
}
LY_CHECK_GOTO(ret, cleanup);
}
}
cleanup:
if (local_mod) {
mods->objs[0] = (void *)local_mod;
}
if (ret) {
free(result);
} else {
*str = result;
}
return ret;
}
static LY_ERR
lyplg_type_store_node_instanceid(const struct ly_ctx *ctx, const struct lysc_type *type, const void *value, size_t value_len,
uint32_t options, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints, const struct lysc_node *ctx_node,
struct lyd_value *storage, struct lys_glob_unres *unres, struct ly_err_item **err)
{
LY_ERR ret = LY_SUCCESS;
struct lyxp_expr *exp = NULL;
uint32_t prefix_opt = 0;
struct ly_path *path = NULL;
char *canon;
/* init storage */
memset(storage, 0, sizeof *storage);
storage->realtype = type;
/* check hints */
ret = lyplg_type_check_hints(hints, value, value_len, type->basetype, NULL, err);
LY_CHECK_GOTO(ret, cleanup);
if ((((char *)value)[0] == '/') && (value_len == 1)) {
/* special path */
format = LY_VALUE_CANON;
goto store;
}
switch (format) {
case LY_VALUE_SCHEMA:
case LY_VALUE_SCHEMA_RESOLVED:
case LY_VALUE_XML:
prefix_opt = LY_PATH_PREFIX_MANDATORY;
break;
case LY_VALUE_CANON:
case LY_VALUE_LYB:
case LY_VALUE_JSON:
case LY_VALUE_STR_NS:
prefix_opt = LY_PATH_PREFIX_STRICT_INHERIT;
break;
}
/* parse the value */
ret = ly_path_parse(ctx, ctx_node, value, value_len, 0, LY_PATH_BEGIN_ABSOLUTE, prefix_opt, LY_PATH_PRED_SIMPLE, &exp);
if (ret) {
ret = ly_err_new(err, LY_EVALID, LYVE_DATA, NULL, NULL,
"Invalid node-instance-identifier \"%.*s\" value - syntax error.", (int)value_len, (char *)value);
goto cleanup;
}
if (options & LYPLG_TYPE_STORE_IMPLEMENT) {
/* implement all prefixes */
LY_CHECK_GOTO(ret = lys_compile_expr_implement(ctx, exp, format, prefix_data, 1, unres, NULL), cleanup);
}
/* resolve it on schema tree, use JSON format instead of LYB because for this type they are equal but for some
* nested types (such as numbers in predicates in the path) LYB would be invalid */
ret = ly_path_compile(ctx, NULL, ctx_node, NULL, exp, (ctx_node && (ctx_node->flags & LYS_IS_OUTPUT)) ?
LY_PATH_OPER_OUTPUT : LY_PATH_OPER_INPUT, LY_PATH_TARGET_MANY, 1, (format == LY_VALUE_LYB) ?
LY_VALUE_JSON : format, prefix_data, &path);
if (ret) {
ret = ly_err_new(err, ret, LYVE_DATA, NULL, NULL,
"Invalid node-instance-identifier \"%.*s\" value - semantic error.", (int)value_len, (char *)value);
goto cleanup;
}
store:
/* store value */
storage->target = path;
/* store canonical value */
if (format == LY_VALUE_CANON) {
if (options & LYPLG_TYPE_STORE_DYNAMIC) {
ret = lydict_insert_zc(ctx, (char *)value, &storage->_canonical);
options &= ~LYPLG_TYPE_STORE_DYNAMIC;
LY_CHECK_GOTO(ret, cleanup);
} else {
ret = lydict_insert(ctx, value, value_len, &storage->_canonical);
LY_CHECK_GOTO(ret, cleanup);
}
} else {
/* JSON format with prefix is the canonical one */
ret = node_instanceid_path2str(path, LY_VALUE_JSON, NULL, &canon);
LY_CHECK_GOTO(ret, cleanup);
ret = lydict_insert_zc(ctx, canon, &storage->_canonical);
LY_CHECK_GOTO(ret, cleanup);
}
cleanup:
lyxp_expr_free(ctx, exp);
if (options & LYPLG_TYPE_STORE_DYNAMIC) {
free((void *)value);
}
if (ret) {
lyplg_type_free_instanceid(ctx, storage);
}
return ret;
}
static const void *
lyplg_type_print_node_instanceid(const struct ly_ctx *UNUSED(ctx), const struct lyd_value *value, LY_VALUE_FORMAT format,
void *prefix_data, ly_bool *dynamic, size_t *value_len)
{
char *ret;
if ((format == LY_VALUE_CANON) || (format == LY_VALUE_JSON) || (format == LY_VALUE_LYB)) {
if (dynamic) {
*dynamic = 0;
}
if (value_len) {
*value_len = strlen(value->_canonical);
}
return value->_canonical;
}
/* print the value in the specific format */
if (node_instanceid_path2str(value->target, format, prefix_data, &ret)) {
return NULL;
}
*dynamic = 1;
if (value_len) {
*value_len = strlen(ret);
}
return ret;
}
static LY_ERR
lyplg_type_dup_node_instanceid(const struct ly_ctx *ctx, const struct lyd_value *original, struct lyd_value *dup)
{
LY_ERR ret;
memset(dup, 0, sizeof *dup);
/* canonical value */
ret = lydict_insert(ctx, original->_canonical, 0, &dup->_canonical);
LY_CHECK_GOTO(ret, error);
if (original->target) {
/* copy path */
ret = ly_path_dup(ctx, original->target, &dup->target);
LY_CHECK_GOTO(ret, error);
} /* else is the special path "/" that has no target stored */
dup->realtype = original->realtype;
return LY_SUCCESS;
error:
lyplg_type_free_instanceid(ctx, dup);
return ret;
}
const struct lyplg_type_record plugins_node_instanceid[] = {
{
.module = "ietf-netconf-acm",
.revision = "2012-02-22",
.name = "node-instance-identifier",
.plugin.id = "libyang 2 - node-instance-identifier, version 1",
.plugin.store = lyplg_type_store_node_instanceid,
.plugin.validate = NULL,
.plugin.compare = lyplg_type_compare_simple,
.plugin.sort = lyplg_type_sort_simple,
.plugin.print = lyplg_type_print_node_instanceid,
.plugin.duplicate = lyplg_type_dup_node_instanceid,
.plugin.free = lyplg_type_free_instanceid,
.plugin.lyb_data_len = -1,
},
{
.module = "ietf-netconf-acm",
.revision = "2018-02-14",
.name = "node-instance-identifier",
.plugin.id = "libyang 2 - node-instance-identifier, version 1",
.plugin.store = lyplg_type_store_node_instanceid,
.plugin.validate = NULL,
.plugin.compare = lyplg_type_compare_simple,
.plugin.sort = lyplg_type_sort_simple,
.plugin.print = lyplg_type_print_node_instanceid,
.plugin.duplicate = lyplg_type_dup_node_instanceid,
.plugin.free = lyplg_type_free_instanceid,
.plugin.lyb_data_len = -1,
},
{0}
};
ly_ctx
libyang context handler.
lydict_insert
LIBYANG_API_DECL LY_ERR lydict_insert(const struct ly_ctx *ctx, const char *value, size_t len, const char **str_p)
Insert string into dictionary. If the string is already present, only a reference counter is incremen...
lydict_insert_zc
LIBYANG_API_DECL LY_ERR lydict_insert_zc(const struct ly_ctx *ctx, char *value, const char **str_p)
Insert string into dictionary - zerocopy version. If the string is already present,...
LY_ERR
LY_ERR
libyang's error codes returned by the libyang functions.
Definition log.h:237
LYVE_DATA
@ LYVE_DATA
Definition log.h:274
LY_EVALID
@ LY_EVALID
Definition log.h:245
LY_SUCCESS
@ LY_SUCCESS
Definition log.h:238
ly_err_item
Libyang full error structure.
Definition log.h:282
ly_set
Structure to hold a set of (not necessary somehow connected) objects. Usually used for lyd_node,...
Definition set.h:47
lyplg_type_get_prefix
LIBYANG_API_DECL const char * lyplg_type_get_prefix(const struct lys_module *mod, LY_VALUE_FORMAT format, void *prefix_data)
Get format-specific prefix for a module.
lyplg_type_check_hints
LIBYANG_API_DECL LY_ERR lyplg_type_check_hints(uint32_t hints, const char *value, size_t value_len, LY_DATA_TYPE type, int *base, struct ly_err_item **err)
Check that the type is suitable for the parser's hints (if any) in the specified format.
ly_err_new
LIBYANG_API_DECL LY_ERR ly_err_new(struct ly_err_item **err, LY_ERR ecode, LY_VECODE vecode, char *data_path, char *apptag, const char *err_format,...) _FORMAT_PRINTF(6
Create and fill error structure.
lyplg_type_record
Definition plugins_types.h:635
lyplg_type_free_instanceid
LIBYANG_API_DECL void lyplg_type_free_instanceid(const struct ly_ctx *ctx, struct lyd_value *value)
Implementation of lyplg_type_free_clb for the built-in instance-identifier type.
Definition instanceid.c:342
lyplg_type_sort_simple
LIBYANG_API_DEF int lyplg_type_sort_simple(const struct ly_ctx *ctx, const struct lyd_value *val1, const struct lyd_value *val2)
Implementation of lyplg_type_sort_clb for a generic simple type.
lyplg_type_compare_simple
LIBYANG_API_DECL LY_ERR lyplg_type_compare_simple(const struct ly_ctx *ctx, const struct lyd_value *val1, const struct lyd_value *val2)
Implementation of lyplg_type_compare_clb for a generic simple type.
LYPLG_TYPE_STORE_DYNAMIC
#define LYPLG_TYPE_STORE_DYNAMIC
Definition plugins_types.h:471
LYPLG_TYPE_STORE_IMPLEMENT
#define LYPLG_TYPE_STORE_IMPLEMENT
Definition plugins_types.h:475
lysc_type::basetype
LY_DATA_TYPE basetype
Definition tree_schema.h:1287
lysc_node::flags
uint16_t flags
Definition tree_schema.h:1423
lys_module
Available YANG schema tree structures representing YANG module.
Definition tree_schema.h:2137
lysc_node
Compiled YANG data node.
Definition tree_schema.h:1421
lysc_type
Definition tree_schema.h:1283
LYS_IS_OUTPUT
#define LYS_IS_OUTPUT
Definition tree_schema.h:724
LY_ARRAY_FOR
#define LY_ARRAY_FOR(ARRAY,...)
Sized-array iterator (for-loop).
Definition tree.h:167
LY_VALUE_FORMAT
LY_VALUE_FORMAT
All kinds of supported value formats and prefix mappings to modules.
Definition tree.h:234
LY_ARRAY_COUNT_TYPE
#define LY_ARRAY_COUNT_TYPE
Type (i.e. size) of the sized array's size counter.
Definition tree.h:104
LY_VALUE_JSON
@ LY_VALUE_JSON
Definition tree.h:239
LY_VALUE_SCHEMA
@ LY_VALUE_SCHEMA
Definition tree.h:236
LY_VALUE_CANON
@ LY_VALUE_CANON
Definition tree.h:235
LY_VALUE_XML
@ LY_VALUE_XML
Definition tree.h:238
LY_VALUE_STR_NS
@ LY_VALUE_STR_NS
Definition tree.h:241
LY_VALUE_SCHEMA_RESOLVED
@ LY_VALUE_SCHEMA_RESOLVED
Definition tree.h:237
LY_VALUE_LYB
@ LY_VALUE_LYB
Definition tree.h:240
libyang.h
The main libyang public header.
ly_bool
uint8_t ly_bool
Type to indicate boolean value.
Definition log.h:35
plugins_node_instanceid
const struct lyplg_type_record plugins_node_instanceid[]
Plugin information for instance-identifier type implementation.
Definition node_instanceid.c:335
plugins_types.h
API for (user) types plugins.
lyd_value::realtype
const struct lysc_type * realtype
Definition tree_data.h:571
lyd_value::_canonical
const char * _canonical
Definition tree_data.h:568
lyd_value
YANG data representation.
Definition tree_data.h:567