libyang  4.0.0
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
ipv4_address.c
Go to the documentation of this file.
1 
15 #define _GNU_SOURCE /* strndup */
16 
17 #include "plugins_internal.h"
18 #include "plugins_types.h"
19 
20 #ifdef _WIN32
21 # include <winsock2.h>
22 # include <ws2tcpip.h>
23 #else
24 # include <arpa/inet.h>
25 # if defined (__FreeBSD__) || defined (__NetBSD__) || defined (__OpenBSD__)
26 # include <netinet/in.h>
27 # include <sys/socket.h>
28 # endif
29 #endif
30 #include <ctype.h>
31 #include <errno.h>
32 #include <stdint.h>
33 #include <stdlib.h>
34 #include <string.h>
35 
36 #include "libyang.h"
37 
38 #include "compat.h"
39 #include "ly_common.h"
40 
51 static void lyplg_type_free_ipv4_address(const struct ly_ctx *ctx, struct lyd_value *value);
52 
65 static LY_ERR
66 ipv4address_str2ip(const char *value, uint32_t value_len, uint32_t options, const struct ly_ctx *ctx,
67  struct in_addr *addr, const char **zone, struct ly_err_item **err)
68 {
69  LY_ERR ret = LY_SUCCESS;
70  const char *addr_no_zone;
71  char *zone_ptr = NULL, *addr_dyn = NULL;
72  uint32_t zone_len;
73 
74  /* store zone and get the string IPv4 address without it */
75  if ((zone_ptr = ly_strnchr(value, '%', value_len))) {
76  /* there is a zone index */
77  zone_len = value_len - (zone_ptr - value) - 1;
78  ret = lydict_insert(ctx, zone_ptr + 1, zone_len, zone);
79  LY_CHECK_GOTO(ret, cleanup);
80 
81  /* get the IP without it */
82  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
83  *zone_ptr = '\0';
84  addr_no_zone = value;
85  } else {
86  addr_dyn = strndup(value, zone_ptr - value);
87  addr_no_zone = addr_dyn;
88  }
89  } else {
90  /* no zone */
91  *zone = NULL;
92 
93  /* get the IP terminated with zero */
94  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
95  /* we can use the value directly */
96  addr_no_zone = value;
97  } else {
98  addr_dyn = strndup(value, value_len);
99  addr_no_zone = addr_dyn;
100  }
101  }
102 
103  /* store the IPv4 address in network-byte order */
104  if (!inet_pton(AF_INET, addr_no_zone, addr)) {
105  ret = ly_err_new(err, LY_EVALID, LYVE_DATA, NULL, NULL, "Failed to store IPv4 address \"%s\".", addr_no_zone);
106  goto cleanup;
107  }
108 
109  /* restore the value */
110  if ((options & LYPLG_TYPE_STORE_DYNAMIC) && zone_ptr) {
111  *zone_ptr = '%';
112  }
113 
114 cleanup:
115  free(addr_dyn);
116  return ret;
117 }
118 
122 static LY_ERR
123 lyplg_type_store_ipv4_address(const struct ly_ctx *ctx, const struct lysc_type *type, const void *value, uint32_t value_size_bits,
124  uint32_t options, LY_VALUE_FORMAT format, void *UNUSED(prefix_data), uint32_t hints,
125  const struct lysc_node *UNUSED(ctx_node), const struct lysc_ext_instance *UNUSED(top_ext),
126  struct lyd_value *storage, struct lys_glob_unres *UNUSED(unres), struct ly_err_item **err)
127 {
128  LY_ERR ret = LY_SUCCESS;
129  struct lyd_value_ipv4_address *val;
130  const char *value_str = value;
131  uint32_t value_size, i;
132 
133  /* init storage */
134  memset(storage, 0, sizeof *storage);
135  LYPLG_TYPE_VAL_INLINE_PREPARE(storage, val);
136  LY_CHECK_ERR_GOTO(!val, ret = LY_EMEM, cleanup);
137  storage->realtype = type;
138 
139  value_size = LYPLG_BITS2BYTES(value_size_bits);
140 
141  if (format == LY_VALUE_LYB) {
142  /* validation */
143  if (value_size_bits < 32) {
144  ret = ly_err_new(err, LY_EVALID, LYVE_DATA, NULL, NULL, "Invalid LYB ipv4-address value size %" PRIu32
145  " b (expected at least 32 b).", value_size_bits);
146  goto cleanup;
147  }
148  for (i = 4; i < value_size; ++i) {
149  if (!isalnum(value_str[i])) {
150  ret = ly_err_new(err, LY_EVALID, LYVE_DATA, NULL, NULL, "Invalid LYB ipv4-address zone character 0x%x.",
151  value_str[i]);
152  goto cleanup;
153  }
154  }
155 
156  /* store IP address */
157  memcpy(&val->addr, value, sizeof val->addr);
158 
159  /* store zone, if any */
160  if (value_size > 4) {
161  ret = lydict_insert(ctx, value_str + 4, value_size - 4, &val->zone);
162  LY_CHECK_GOTO(ret, cleanup);
163  } else {
164  val->zone = NULL;
165  }
166 
167  /* success */
168  goto cleanup;
169  }
170 
171  /* check hints */
172  ret = lyplg_type_check_hints(hints, value, value_size, type->basetype, NULL, err);
173  LY_CHECK_GOTO(ret, cleanup);
174 
175  /* get the network-byte order address */
176  ret = ipv4address_str2ip(value, value_size, options, ctx, &val->addr, &val->zone, err);
177  LY_CHECK_GOTO(ret, cleanup);
178 
179  /* store canonical value */
180  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
181  ret = lydict_insert_zc(ctx, (char *)value, &storage->_canonical);
182  options &= ~LYPLG_TYPE_STORE_DYNAMIC;
183  LY_CHECK_GOTO(ret, cleanup);
184  } else {
185  ret = lydict_insert(ctx, value_size ? value : "", value_size, &storage->_canonical);
186  LY_CHECK_GOTO(ret, cleanup);
187  }
188 
189 cleanup:
190  if (options & LYPLG_TYPE_STORE_DYNAMIC) {
191  free((void *)value);
192  }
193 
194  if (ret) {
195  lyplg_type_free_ipv4_address(ctx, storage);
196  }
197  return ret;
198 }
199 
203 static LY_ERR
204 lyplg_type_compare_ipv4_address(const struct ly_ctx *UNUSED(ctx), const struct lyd_value *val1,
205  const struct lyd_value *val2)
206 {
207  struct lyd_value_ipv4_address *v1, *v2;
208 
209  LYD_VALUE_GET(val1, v1);
210  LYD_VALUE_GET(val2, v2);
211 
212  /* zones are NULL or in the dictionary */
213  if (memcmp(&v1->addr, &v2->addr, sizeof v1->addr) || (v1->zone != v2->zone)) {
214  return LY_ENOT;
215  }
216  return LY_SUCCESS;
217 }
218 
222 static int
223 lyplg_type_sort_ipv4_address(const struct ly_ctx *UNUSED(ctx), const struct lyd_value *val1,
224  const struct lyd_value *val2)
225 {
226  struct lyd_value_ipv4_address *v1, *v2;
227  int cmp;
228 
229  LYD_VALUE_GET(val1, v1);
230  LYD_VALUE_GET(val2, v2);
231 
232  cmp = memcmp(&v1->addr, &v2->addr, sizeof v1->addr);
233  if (cmp != 0) {
234  return cmp;
235  }
236 
237  if (!v1->zone && v2->zone) {
238  return -1;
239  } else if (v1->zone && !v2->zone) {
240  return 1;
241  } else if (v1->zone && v2->zone) {
242  return strcmp(v1->zone, v2->zone);
243  }
244 
245  return 0;
246 }
247 
251 static const void *
252 lyplg_type_print_ipv4_address(const struct ly_ctx *ctx, const struct lyd_value *value, LY_VALUE_FORMAT format,
253  void *UNUSED(prefix_data), ly_bool *dynamic, uint32_t *value_size_bits)
254 {
255  struct lyd_value_ipv4_address *val;
256  uint32_t zone_len;
257  char *ret;
258 
259  LYD_VALUE_GET(value, val);
260 
261  if (format == LY_VALUE_LYB) {
262  if (!val->zone) {
263  /* address-only, const */
264  *dynamic = 0;
265  if (value_size_bits) {
266  *value_size_bits = sizeof val->addr * 8;
267  }
268  return &val->addr;
269  }
270 
271  /* dynamic */
272  zone_len = strlen(val->zone);
273  ret = malloc(sizeof val->addr + zone_len);
274  LY_CHECK_RET(!ret, NULL);
275 
276  memcpy(ret, &val->addr, sizeof val->addr);
277  memcpy(ret + sizeof val->addr, val->zone, zone_len);
278 
279  *dynamic = 1;
280  if (value_size_bits) {
281  *value_size_bits = sizeof val->addr * 8 + zone_len * 8;
282  }
283  return ret;
284  }
285 
286  /* generate canonical value if not already */
287  if (!value->_canonical) {
288  /* '%' + zone */
289  zone_len = val->zone ? strlen(val->zone) + 1 : 0;
290  ret = malloc(INET_ADDRSTRLEN + zone_len);
291  LY_CHECK_RET(!ret, NULL);
292 
293  /* get the address in string */
294  if (!inet_ntop(AF_INET, &val->addr, ret, INET_ADDRSTRLEN)) {
295  free(ret);
296  LOGERR(ctx, LY_ESYS, "Failed to get IPv4 address in string (%s).", strerror(errno));
297  return NULL;
298  }
299 
300  /* add zone */
301  if (zone_len) {
302  sprintf(ret + strlen(ret), "%%%s", val->zone);
303  }
304 
305  /* store it */
306  if (lydict_insert_zc(ctx, ret, (const char **)&value->_canonical)) {
307  LOGMEM(ctx);
308  return NULL;
309  }
310  }
311 
312  /* use the cached canonical value */
313  if (dynamic) {
314  *dynamic = 0;
315  }
316  if (value_size_bits) {
317  *value_size_bits = strlen(value->_canonical) * 8;
318  }
319  return value->_canonical;
320 }
321 
325 static LY_ERR
326 lyplg_type_dup_ipv4_address(const struct ly_ctx *ctx, const struct lyd_value *original, struct lyd_value *dup)
327 {
328  LY_ERR ret;
329  struct lyd_value_ipv4_address *orig_val, *dup_val;
330 
331  memset(dup, 0, sizeof *dup);
332 
333  ret = lydict_insert(ctx, original->_canonical, 0, &dup->_canonical);
334  LY_CHECK_GOTO(ret, error);
335 
336  LYPLG_TYPE_VAL_INLINE_PREPARE(dup, dup_val);
337  LY_CHECK_ERR_GOTO(!dup_val, ret = LY_EMEM, error);
338 
339  LYD_VALUE_GET(original, orig_val);
340 
341  memcpy(&dup_val->addr, &orig_val->addr, sizeof orig_val->addr);
342  ret = lydict_insert(ctx, orig_val->zone, 0, &dup_val->zone);
343  LY_CHECK_GOTO(ret, error);
344 
345  dup->realtype = original->realtype;
346  return LY_SUCCESS;
347 
348 error:
349  lyplg_type_free_ipv4_address(ctx, dup);
350  return ret;
351 }
352 
356 static void
357 lyplg_type_free_ipv4_address(const struct ly_ctx *ctx, struct lyd_value *value)
358 {
359  struct lyd_value_ipv4_address *val;
360 
361  lydict_remove(ctx, value->_canonical);
362  value->_canonical = NULL;
363  LYD_VALUE_GET(value, val);
364  if (val) {
365  lydict_remove(ctx, val->zone);
367  }
368 }
369 
378  {
379  .module = "ietf-inet-types",
380  .revision = "2013-07-15",
381  .name = "ipv4-address",
382 
383  .plugin.id = "ly2 ipv4-address",
384  .plugin.lyb_size = lyplg_type_lyb_size_variable_bytes,
385  .plugin.store = lyplg_type_store_ipv4_address,
386  .plugin.validate_value = NULL,
387  .plugin.validate_tree = NULL,
388  .plugin.compare = lyplg_type_compare_ipv4_address,
389  .plugin.sort = lyplg_type_sort_ipv4_address,
390  .plugin.print = lyplg_type_print_ipv4_address,
391  .plugin.duplicate = lyplg_type_dup_ipv4_address,
392  .plugin.free = lyplg_type_free_ipv4_address,
393  },
394  {0}
395 };
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)
struct in_addr addr
Definition: tree_data.h:662
YANG extension compiled instance.
Definition: plugins_exts.h:436
const char * zone
Definition: tree_data.h:663
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
struct lyplg_type_record plugins_ipv4_address[]
Plugin information for ipv4-address type implementation.
Definition: ipv4_address.c:377
Definition: log.h:254
#define LYPLG_TYPE_STORE_DYNAMIC
Special lyd_value structure for ietf-inet-types ipv4-address values.
Definition: tree_data.h:661
#define LOGMEM(CTX)
Definition: tree_edit.h:22
Definition: log.h:243
int cmp
Definition: binary.c:394
LYPLG_TYPE_VAL_INLINE_DESTROY(val)
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...
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
#define LYD_VALUE_GET(value, type_val)
Get the value in format specific to the type.
Definition: tree_data.h:606
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.
LIBYANG_API_DECL LY_ERR lydict_remove(const struct ly_ctx *ctx, const char *value)
Remove specified string from the dictionary. It decrement reference counter for the string and if it ...
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...
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
#define LYPLG_TYPE_VAL_INLINE_PREPARE(storage, type_val)
Prepare value memory for storing a specific type value, may be allocated dynamically.
LY_DATA_TYPE basetype
Definition: tree_schema.h:1300
return memcmp(v1->data, v2->data, bitmap_size)
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.
libyang context handler.
#define LYPLG_BITS2BYTES(bits)
Convert bits to bytes.