libyang  4.0.2
libyang is YANG data modelling language parser and toolkit written (and providing API) in C.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
instanceid_keys.c
Go to the documentation of this file.
1 
14 #define _GNU_SOURCE /* strdup */
15 
16 #include "plugins_types.h"
17 
18 #include <stdint.h>
19 #include <stdlib.h>
20 
21 #include "libyang.h"
22 
23 /* additional internal headers for some useful simple macros */
24 #include "compat.h"
25 #include "ly_common.h"
26 #include "path.h"
27 #include "plugins_internal.h" /* LY_TYPE_*_STR */
28 #include "xpath.h"
29 
43  struct lyxp_expr *keys;
44  const struct ly_ctx *ctx;
45  void *prefix_data;
47 };
48 
59 static LY_ERR
60 instanceid_keys_print_value(const struct lyd_value_instance_identifier_keys *val, LY_VALUE_FORMAT format, void *prefix_data,
61  char **str_value, struct ly_err_item **err)
62 {
63  LY_ERR ret = LY_SUCCESS;
64  uint32_t cur_idx = 0, str_len = 0;
65  enum lyxp_token cur_tok;
66  char *str_tok;
67  void *mem;
68  const char *cur_exp_ptr;
69  ly_bool is_nt;
70  const struct lys_module *context_mod = NULL, *local_mod = NULL;
71  struct ly_set *mods;
72 
73  *str_value = NULL;
74 
75  if (format == LY_VALUE_XML) {
76  /* null the local module so that all the prefixes are printed */
77  mods = prefix_data;
78  local_mod = mods->objs[0];
79  mods->objs[0] = NULL;
80  }
81 
82  while (cur_idx < val->keys->used) {
83  cur_tok = val->keys->tokens[cur_idx];
84  cur_exp_ptr = val->keys->expr + val->keys->tok_pos[cur_idx];
85 
86  if ((cur_tok == LYXP_TOKEN_NAMETEST) || (cur_tok == LYXP_TOKEN_LITERAL)) {
87  /* tokens that may include prefixes, get them in the target format */
88  is_nt = (cur_tok == LYXP_TOKEN_NAMETEST) ? 1 : 0;
89  LY_CHECK_GOTO(ret = lyplg_type_xpath10_print_token(cur_exp_ptr, val->keys->tok_len[cur_idx], is_nt, &context_mod,
90  val->ctx, val->format, val->prefix_data, format, prefix_data, &str_tok, err), cleanup);
91 
92  /* append the converted token */
93  mem = realloc(*str_value, str_len + strlen(str_tok) + 1);
94  if (!mem) {
95  free(str_tok);
96  ret = ly_err_new(err, LY_EMEM, LYVE_DATA, NULL, NULL, "No memory.");
97  goto cleanup;
98  }
99  *str_value = mem;
100  str_len += sprintf(*str_value + str_len, "%s", str_tok);
101  free(str_tok);
102 
103  /* token processed */
104  ++cur_idx;
105  } else {
106  /* just copy the token */
107  mem = realloc(*str_value, str_len + val->keys->tok_len[cur_idx] + 1);
108  if (!mem) {
109  ret = ly_err_new(err, LY_EMEM, LYVE_DATA, NULL, NULL, "No memory.");
110  goto cleanup;
111  }
112  *str_value = mem;
113  str_len += sprintf(*str_value + str_len, "%.*s", (int)val->keys->tok_len[cur_idx], cur_exp_ptr);
114 
115  /* token processed */
116  ++cur_idx;
117  }
118  }
119 
120 cleanup:
121  if (local_mod) {
122  mods->objs[0] = (void *)local_mod;
123  }
124  if (ret) {
125  free(*str_value);
126  *str_value = NULL;
127  }
128  return ret;
129 }
130 
134 static LY_ERR
135 lyplg_type_store_instanceid_keys(const struct ly_ctx *ctx, const struct lysc_type *type, const void *value, uint32_t value_size_bits,
136  uint32_t options, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints, const struct lysc_node *UNUSED(ctx_node),
137  const struct lysc_ext_instance *UNUSED(top_ext), struct lyd_value *storage, struct lys_glob_unres *UNUSED(unres),
138  struct ly_err_item **err)
139 {
140  LY_ERR ret = LY_SUCCESS;
141  struct lysc_type_str *type_str = (struct lysc_type_str *)type;
143  uint32_t value_size, *prev_lo, temp_lo = LY_LOSTORE;
144  const struct ly_err_item *eitem;
145  char *canon;
146 
147  /* init storage */
148  memset(storage, 0, sizeof *storage);
149  LYPLG_TYPE_VAL_INLINE_PREPARE(storage, val);
150  LY_CHECK_ERR_GOTO(!val, ret = LY_EMEM, cleanup);
151  storage->realtype = type;
152 
153  /* check value length */
154  ret = lyplg_type_check_value_size("instance-identifier-keys", format, value_size_bits,
155  LYPLG_LYB_SIZE_VARIABLE_BYTES, 0, &value_size, err);
156  LY_CHECK_GOTO(ret, cleanup);
157 
158  /* check hints */
159  ret = lyplg_type_check_hints(hints, value, value_size, type->basetype, NULL, err);
160  LY_CHECK_GOTO(ret, cleanup);
161 
162  /* length restriction of the string */
163  if (type_str->length) {
164  /* value_size is in bytes, but we need number of characters here */
165  ret = lyplg_type_validate_range(LY_TYPE_STRING, type_str->length, ly_utf8len(value, value_size), value, value_size, err);
166  LY_CHECK_GOTO(ret, cleanup);
167  }
168 
169  /* pattern restrictions */
170  ret = lyplg_type_validate_patterns(ctx, type_str->patterns, value, value_size, err);
171  LY_CHECK_GOTO(ret, cleanup);
172 
173  /* parse instance-identifier keys, with optional prefix even though it should be mandatory */
174  if (value_size && (((char *)value)[0] != '[')) {
175  ret = ly_err_new(err, LY_EVALID, LYVE_DATA, NULL, NULL, "Invalid first character '%c', list key predicates expected.",
176  ((char *)value)[0]);
177  goto cleanup;
178  }
179 
180  /* do not log */
181  prev_lo = ly_temp_log_options(&temp_lo);
182  ret = ly_path_parse_predicate(ctx, NULL, value_size ? value : "", value_size, LY_PATH_PREFIX_OPTIONAL,
183  LY_PATH_PRED_KEYS, &val->keys);
184  ly_temp_log_options(prev_lo);
185  if (ret) {
186  eitem = ly_err_last(ctx);
187  ret = ly_err_new(err, ret, LYVE_DATA, eitem->data_path, NULL, "%s", eitem->msg);
188  ly_err_clean((struct ly_ctx *)ctx, NULL);
189  goto cleanup;
190  }
191  val->ctx = ctx;
192 
193  /* store format-specific data and context for later prefix resolution */
194  ret = lyplg_type_prefix_data_new(ctx, value, value_size, format, prefix_data, &val->format, &val->prefix_data);
195  LY_CHECK_GOTO(ret, cleanup);
196 
197  switch (format) {
198  case LY_VALUE_CANON:
199  case LY_VALUE_JSON:
200  case LY_VALUE_LYB:
201  case LY_VALUE_STR_NS:
202  /* store canonical value */
203  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
204  ret = lydict_insert_zc(ctx, (char *)value, &storage->_canonical);
205  options &= ~LYPLG_TYPE_STORE_DYNAMIC;
206  LY_CHECK_GOTO(ret, cleanup);
207  } else {
208  ret = lydict_insert(ctx, value_size ? value : "", value_size, &storage->_canonical);
209  LY_CHECK_GOTO(ret, cleanup);
210  }
211  break;
212  case LY_VALUE_SCHEMA:
214  case LY_VALUE_XML:
215  /* JSON format with prefix is the canonical one */
216  ret = instanceid_keys_print_value(val, LY_VALUE_JSON, NULL, &canon, err);
217  LY_CHECK_GOTO(ret, cleanup);
218 
219  ret = lydict_insert_zc(ctx, canon, &storage->_canonical);
220  LY_CHECK_GOTO(ret, cleanup);
221  break;
222  }
223 
224 cleanup:
225  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
226  free((void *)value);
227  }
228 
229  if (ret) {
230  lyplg_type_free_xpath10(ctx, storage);
231  }
232  return ret;
233 }
234 
243  {
244  .module = "yang",
245  .revision = NULL,
246  .name = "instance-identifier-keys",
247 
248  .plugin.id = "ly2 instance-identifier-keys",
249  .plugin.lyb_size = lyplg_type_lyb_size_variable_bytes,
250  .plugin.store = lyplg_type_store_instanceid_keys,
251  .plugin.validate_value = NULL,
252  .plugin.validate_tree = NULL,
253  .plugin.compare = lyplg_type_compare_simple,
254  .plugin.sort = lyplg_type_sort_simple,
255  .plugin.print = lyplg_type_print_xpath10,
256  .plugin.duplicate = lyplg_type_dup_xpath10,
257  .plugin.free = lyplg_type_free_xpath10,
258  },
259  {0}
260 };
struct lysc_type * realtype
Definition: tree_data.h:567
Compiled YANG data node.
Definition: tree_schema.h:1434
memset(value->fixed_mem, 0, LYD_VALUE_FIXED_MEM_SIZE)
LIBYANG_API_DECL LY_ERR lyplg_type_check_value_size(const char *type_name, LY_VALUE_FORMAT format, uint32_t value_size_bits, enum lyplg_lyb_size_type lyb_size_type, uint32_t lyb_fixed_size_bits, uint32_t *value_size, struct ly_err_item **err)
Check a value type in bits is correct and as expected.
LIBYANG_API_DECL void ly_err_clean(const struct ly_ctx *ctx, struct ly_err_item *eitem)
Free error structures from a context.
YANG extension compiled instance.
Definition: plugins_exts.h:436
LIBYANG_API_DECL uint32_t * ly_temp_log_options(uint32_t *opts)
Set temporary thread-safe logger options overwriting those set by ly_log_options().
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.
LY_ERR
libyang&#39;s error codes returned by the libyang functions.
Definition: log.h:240
uint8_t ly_bool
Type to indicate boolean value.
Definition: log.h:28
#define LYPLG_TYPE_STORE_DYNAMIC
LIBYANG_API_DECL LY_ERR lyplg_type_validate_patterns(const struct ly_ctx *ctx, struct lysc_pattern **patterns, const char *str, uint32_t str_len, struct ly_err_item **err)
Data type validator for pattern-restricted string values.
LIBYANG_API_DECL LY_ERR lyplg_type_prefix_data_new(const struct ly_ctx *ctx, const void *value, uint32_t value_size, LY_VALUE_FORMAT format, const void *prefix_data, LY_VALUE_FORMAT *format_p, void **prefix_data_p)
Store used prefixes in a string into an internal libyang structure used in lyd_value.
char * msg
Definition: log.h:289
LIBYANG_API_DECL LY_ERR lyplg_type_dup_xpath10(const struct ly_ctx *ctx, const struct lyd_value *original, struct lyd_value *dup)
Implementation of lyplg_type_dup_clb for the ietf-yang-types xpath1.0 type.
Definition: xpath1.0.c:474
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.
Definition: log.h:242
The main libyang public header.
LIBYANG_API_DECL void lyplg_type_lyb_size_variable_bytes(const struct lysc_type *type, enum lyplg_lyb_size_type *size_type, uint32_t *fixed_size_bits)
Implementation of lyplg_type_lyb_size_clb for a type with variable length rounded to bytes...
struct lysc_pattern ** patterns
Definition: tree_schema.h:1334
struct lysc_range * length
Definition: tree_schema.h:1333
YANG data representation.
Definition: tree_data.h:563
const char * _canonical
Definition: tree_data.h:564
Libyang full error structure.
Definition: log.h:285
Definition: log.h:277
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.
Structure to hold a set of (not necessary somehow connected) objects. Usually used for lyd_node...
Definition: set.h:47
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...
Available YANG schema tree structures representing YANG module.
Definition: tree_schema.h:2184
LIBYANG_API_DECL const void * lyplg_type_print_xpath10(const struct ly_ctx *ctx, const struct lyd_value *value, LY_VALUE_FORMAT format, void *prefix_data, ly_bool *dynamic, uint32_t *value_len)
Implementation of lyplg_type_print_clb for the ietf-yang-types xpath1.0 type.
Definition: xpath1.0.c:435
Definition: log.h:248
const char * module
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, only a reference counter is incremented and no memory allocation is performed. This insert function variant avoids duplication of specified value - it is inserted into the dictionary directly.
LY_VALUE_FORMAT
All kinds of supported value formats and prefix mappings to modules.
Definition: tree.h:234
LIBYANG_API_DECL struct ly_err_item * ly_err_last(const struct ly_ctx *ctx)
Get the latest (thread, context-specific) generated error structure.
#define LYPLG_TYPE_VAL_INLINE_PREPARE(storage, type_val)
Prepare value memory for storing a specific type value, may be allocated dynamically.
LIBYANG_API_DECL void lyplg_type_free_xpath10(const struct ly_ctx *ctx, struct lyd_value *value)
Implementation of lyplg_type_free_clb for the ietf-yang-types xpath1.0 type.
Definition: xpath1.0.c:506
LY_DATA_TYPE basetype
Definition: tree_schema.h:1300
LIBYANG_API_DECL LY_ERR lyplg_type_xpath10_print_token(const char *token, uint16_t tok_len, ly_bool is_nametest, const struct lys_module **context_mod, const struct ly_ctx *resolve_ctx, LY_VALUE_FORMAT resolve_format, const void *resolve_prefix_data, LY_VALUE_FORMAT get_format, void *get_prefix_data, char **token_p, struct ly_err_item **err)
Print xpath1.0 token in the specific format.
Definition: xpath1.0.c:41
struct lyplg_type_record plugins_instanceid_keys[]
Plugin information for instance-identifier type implementation.
LIBYANG_API_DECL LY_ERR lyplg_type_check_hints(uint32_t hints, const char *value, uint32_t value_len, LY_DATA_TYPE type, int *base, struct ly_err_item **err)
Check that the type is suitable for the parser&#39;s hints (if any) in the specified format.
API for (user) types plugins.
#define LY_LOSTORE
Definition: log.h:119
Special lyd_value structure for yang instance-identifier-keys values.
libyang context handler.
LIBYANG_API_DECL LY_ERR lyplg_type_validate_range(LY_DATA_TYPE basetype, struct lysc_range *range, int64_t value, const char *strval, uint32_t strval_len, struct ly_err_item **err)
Data type validator for a range/length-restricted values.
char * data_path
Definition: log.h:290