blob: 2be4a20f6d027b0892a7ed8f5f55bdd7943b5c94 [file] [log] [blame]
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001/**
2 * @file common.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief common internal definitions for libyang
5 *
6 * Copyright (c) 2015 - 2018 CESNET, z.s.p.o.
7 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_COMMON_H_
16#define LY_COMMON_H_
17
Radek Krejcib7db73a2018-10-24 14:18:40 +020018#define _DEFAULT_SOURCE
19#define _GNU_SOURCE
Radek Krejcib7db73a2018-10-24 14:18:40 +020020
Radek Krejci151a5b72018-10-19 14:21:44 +020021#include <assert.h>
Radek Krejci6caa6ab2018-10-24 10:04:48 +020022#include <pthread.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020023#include <stdint.h>
24#include <stdlib.h>
Radek Krejcicad716e2018-11-26 15:18:27 +010025#include <unistd.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020026
Radek Krejci2c22f122018-09-05 15:08:03 +020027#include "config.h"
Radek Krejciad573502018-09-07 15:26:55 +020028#include "log.h"
Radek Krejcid33273d2018-10-25 14:55:52 +020029#include "context.h"
Radek Krejcic59bc972018-09-17 16:13:06 +020030#include "tree_schema.h"
Radek Krejci6caa6ab2018-10-24 10:04:48 +020031#include "set.h"
32#include "hash_table.h"
Radek Krejci5aeea3a2018-09-05 13:29:36 +020033
34#if __STDC_VERSION__ >= 201112 && !defined __STDC_NO_THREADS__
35# define THREAD_LOCAL _Thread_local
36#elif defined __GNUC__ || \
37 defined __SUNPRO_C || \
38 defined __xlC__
39# define THREAD_LOCAL __thread
40#else
41# error "Cannot define THREAD_LOCAL"
42#endif
43
Radek Krejcic59bc972018-09-17 16:13:06 +020044#define GETMACRO1(_1, NAME, ...) NAME
Radek Krejci5aeea3a2018-09-05 13:29:36 +020045#define GETMACRO2(_1, _2, NAME, ...) NAME
46#define GETMACRO3(_1, _2, _3, NAME, ...) NAME
47#define GETMACRO4(_1, _2, _3, _4, NAME, ...) NAME
48
49/*
Radek Krejcic59bc972018-09-17 16:13:06 +020050 * If the compiler supports attribute to mark objects as hidden, mark all
51 * objects as hidden and export only objects explicitly marked to be part of
52 * the public API.
Radek Krejci5aeea3a2018-09-05 13:29:36 +020053 */
Radek Krejcic59bc972018-09-17 16:13:06 +020054#define API __attribute__((visibility("default")))
55
Radek Krejcicad716e2018-11-26 15:18:27 +010056#ifndef __USE_GNU
57/*
58 * If we don't have GNU extension, implement these function on your own
59 */
60char *get_current_dir_name(void);
61#endif
62
Radek Krejcic59bc972018-09-17 16:13:06 +020063/******************************************************************************
64 * Logger
65 *****************************************************************************/
Radek Krejci5aeea3a2018-09-05 13:29:36 +020066
67/* internal logging options */
68enum int_log_opts {
69 ILO_LOG = 0, /* log normally */
70 ILO_STORE, /* only store any messages, they will be processed higher on stack */
71 ILO_IGNORE, /* completely ignore messages */
72 ILO_ERR2WRN, /* change errors to warnings */
73};
74
Radek Krejci94aa9942018-09-07 17:12:17 +020075enum LY_VLOG_ELEM {
76 LY_VLOG_NONE = 0,
77 LY_VLOG_LINE,/* line number */
78 LY_VLOG_LYS, /* struct lysc_node* */
79 LY_VLOG_LYD, /* struct lyd_node* */
80 LY_VLOG_STR, /* const char* */
81 LY_VLOG_PREV /* use exact same previous path */
82};
83
Radek Krejci5aeea3a2018-09-05 13:29:36 +020084extern THREAD_LOCAL enum int_log_opts log_opt;
85extern volatile uint8_t ly_log_level;
86extern volatile uint8_t ly_log_opts;
87
Radek Krejciad573502018-09-07 15:26:55 +020088void ly_err_free(void *ptr);
Radek Krejci5aeea3a2018-09-05 13:29:36 +020089void ly_log(const struct ly_ctx *ctx, LY_LOG_LEVEL level, LY_ERR no, const char *format, ...);
Radek Krejci94aa9942018-09-07 17:12:17 +020090void ly_vlog(const struct ly_ctx *ctx, enum LY_VLOG_ELEM elem_type, const void *elem, LY_VECODE code, const char *format, ...);
Radek Krejci5aeea3a2018-09-05 13:29:36 +020091
92#define LOGERR(ctx, errno, str, args...) ly_log(ctx, LY_LLERR, errno, str, ##args)
Radek Krejcif3f47842018-11-15 11:22:15 +010093#define LOGWRN(ctx, str, ...) ly_log(ctx, LY_LLWRN, 0, str, ##__VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +020094#define LOGVRB(str, args...) ly_log(NULL, LY_LLVRB, 0, str, ##args)
95
Radek Krejci4ab61562018-09-05 15:00:37 +020096#ifdef NDEBUG
97# define LOGDBG(dbg_group, str, args...)
98#else
99 void ly_log_dbg(int group, const char *format, ...);
100# define LOGDBG(dbg_group, str, args...) ly_log_dbg(dbg_group, str, ##args);
101#endif
102
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200103#define LOGMEM(CTX) LOGERR(CTX, LY_EMEM, "Memory allocation failed (%s()).", __func__)
104#define LOGINT(CTX) LOGERR(CTX, LY_EINT, "Internal error (%s:%d).", __FILE__, __LINE__)
105#define LOGARG(CTX, ARG) LOGERR(CTX, LY_EINVAL, "Invalid argument %s (%s()).", #ARG, __func__)
Radek Krejcic07921a2018-09-17 11:40:15 +0200106#define LOGVAL(CTX, ELEM_TYPE, ELEM, CODE, FORMAT...) ly_vlog(CTX, ELEM_TYPE, ELEM, CODE, ##FORMAT)
Radek Krejci94aa9942018-09-07 17:12:17 +0200107
108#define LOGMEM_RET(CTX) LOGMEM(CTX); return LY_EMEM
109#define LOGINT_RET(CTX) LOGINT(CTX); return LY_EINT
110#define LOGARG_RET(CTX) LOGARG(CTX); return LY_EINVAL
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200111
112/*
113 * Common code to check return value and perform appropriate action.
114 */
115#define LY_CHECK_GOTO(COND, GOTO) if (COND) {goto GOTO;}
116#define LY_CHECK_ERR_GOTO(COND, ERR, GOTO) if (COND) {ERR; goto GOTO;}
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100117#define LY_CHECK_RET1(RETVAL) {LY_ERR ret__ = RETVAL;if (ret__ != LY_SUCCESS) {return ret__;}}
Radek Krejcic59bc972018-09-17 16:13:06 +0200118#define LY_CHECK_RET2(COND, RETVAL) if (COND) {return RETVAL;}
119#define LY_CHECK_RET(...) GETMACRO2(__VA_ARGS__, LY_CHECK_RET2, LY_CHECK_RET1)(__VA_ARGS__)
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200120#define LY_CHECK_ERR_RET(COND, ERR, RETVAL) if (COND) {ERR; return RETVAL;}
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200121
Radek Krejcia3045382018-11-22 14:30:31 +0100122#define LY_CHECK_ARG_GOTO1(CTX, ARG, GOTO) if (!(ARG)) {LOGARG(CTX, ARG);goto GOTO;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200123#define LY_CHECK_ARG_GOTO2(CTX, ARG1, ARG2, GOTO) LY_CHECK_ARG_GOTO1(CTX, ARG1, GOTO);LY_CHECK_ARG_GOTO1(CTX, ARG2, GOTO)
124#define LY_CHECK_ARG_GOTO3(CTX, ARG1, ARG2, ARG3, GOTO) LY_CHECK_ARG_GOTO2(CTX, ARG1, ARG2, GOTO);LY_CHECK_ARG_GOTO1(CTX, ARG3, GOTO)
125#define LY_CHECK_ARG_GOTO(CTX, ...) GETMACRO4(__VA_ARGS__, LY_CHECK_ARG_GOTO3, LY_CHECK_ARG_GOTO2, LY_CHECK_ARG_GOTO1)(CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200126
Radek Krejcia3045382018-11-22 14:30:31 +0100127#define LY_CHECK_ARG_RET1(CTX, ARG, RETVAL) if (!(ARG)) {LOGARG(CTX, ARG);return RETVAL;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200128#define LY_CHECK_ARG_RET2(CTX, ARG1, ARG2, RETVAL) LY_CHECK_ARG_RET1(CTX, ARG1, RETVAL);LY_CHECK_ARG_RET1(CTX, ARG2, RETVAL)
129#define LY_CHECK_ARG_RET3(CTX, ARG1, ARG2, ARG3, RETVAL) LY_CHECK_ARG_RET2(CTX, ARG1, ARG2, RETVAL);LY_CHECK_ARG_RET1(CTX, ARG3, RETVAL)
130#define LY_CHECK_ARG_RET(CTX, ...) GETMACRO4(__VA_ARGS__, LY_CHECK_ARG_RET3, LY_CHECK_ARG_RET2, LY_CHECK_ARG_RET1)(CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200131
Radek Krejcid972c252018-09-25 13:23:39 +0200132/* count sequence size for LY_VCODE_INCHILDSTMT validation error code */
133size_t LY_VCODE_INSTREXP_len(const char *str);
134/* default maximum characters to print in LY_VCODE_INCHILDSTMT */
135#define LY_VCODE_INSTREXP_MAXLEN 20
136
Michal Vasko58257712018-09-12 11:11:38 +0200137#define LY_VCODE_INCHAR LYVE_SYNTAX, "Invalid character 0x%x."
Michal Vasko37d705c2018-09-12 15:31:26 +0200138#define LY_VCODE_INSTREXP LYVE_SYNTAX, "Invalid character sequence \"%.*s\", expected %s."
Michal Vasko58257712018-09-12 11:11:38 +0200139#define LY_VCODE_EOF LYVE_SYNTAX, "Unexpected end-of-file."
Radek Krejcid91dbaf2018-09-21 15:51:39 +0200140#define LY_VCODE_NTERM LYVE_SYNTAX, "%s not terminated."
141#define LY_VCODE_NSUPP LYVE_SYNTAX, "%s not supported."
Radek Krejci94aa9942018-09-07 17:12:17 +0200142#define LY_VCODE_INSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\"."
Michal Vasko58257712018-09-12 11:11:38 +0200143#define LY_VCODE_INCHILDSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\" as a child of \"%s\"."
Radek Krejci10113652018-11-14 16:56:50 +0100144#define LY_VCODE_INCHILDSTMT2 LYVE_SYNTAX_YANG, "Invalid keyword \"%s\" as a child of \"%s\" - the statement is allowed only in YANG 1.1 modules."
Radek Krejcia9026eb2018-12-12 16:04:47 +0100145#define LY_VCODE_INCHILDSTMSCOMB LYVE_SYNTAX_YANG, "Invalid combination of keywords \"%s\" and \"%s\" as substatements of \"%s\"."
Michal Vasko58257712018-09-12 11:11:38 +0200146#define LY_VCODE_DUPSTMT LYVE_SYNTAX_YANG, "Duplicate keyword \"%s\"."
Radek Krejcifaa1eac2018-10-30 14:34:55 +0100147#define LY_VCODE_DUPIDENT LYVE_SYNTAX_YANG, "Duplicate identifier \"%s\" of %s statement."
Michal Vasko37d705c2018-09-12 15:31:26 +0200148#define LY_VCODE_INVAL LYVE_SYNTAX_YANG, "Invalid value \"%.*s\" of \"%s\"."
Michal Vasko58257712018-09-12 11:11:38 +0200149#define LY_VCODE_MISSTMT LYVE_SYNTAX_YANG, "Missing mandatory keyword \"%s\" as a child of \"%s\"."
Radek Krejci555cb5b2018-11-16 14:54:33 +0100150#define LY_VCODE_MISSCHILDSTMT LYVE_SYNTAX_YANG, "Missing %s substatement for %s%s."
Michal Vasko58257712018-09-12 11:11:38 +0200151#define LY_VCODE_INORD LYVE_SYNTAX_YANG, "Invalid keyword \"%s\", it cannot appear after \"%s\"."
Michal Vasko37d705c2018-09-12 15:31:26 +0200152#define LY_VCODE_OOB LYVE_SYNTAX_YANG, "Value \"%.*s\" is out of \"%s\" bounds."
Michal Vasko58257712018-09-12 11:11:38 +0200153#define LY_VCODE_INDEV LYVE_SYNTAX_YANG, "Deviate \"%s\" does not support keyword \"%s\"."
Radek Krejci4586a022018-11-13 11:29:26 +0100154#define LY_VCODE_INREGEXP LYVE_SYNTAX_YANG, "Regular expression \"%s\" is not valid (\"%s\": %s)."
Radek Krejcib1646a92018-11-02 16:08:26 +0100155#define LY_VCODE_XP_EOE LYVE_XPATH, "Unterminated string delimited with %c (%.15s)."
Radek Krejcid4270262019-01-07 15:07:25 +0100156#define LY_VCODE_XP_INEXPR LYVE_XPATH, "Invalid character number %u of expression \'%s\'."
Radek Krejci94aa9942018-09-07 17:12:17 +0200157
Radek Krejcic59bc972018-09-17 16:13:06 +0200158/******************************************************************************
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200159 * Context
160 *****************************************************************************/
161
162/**
163 * @brief Context of the YANG schemas
164 */
165struct ly_ctx {
166 struct dict_table dict; /**< dictionary to effectively store strings used in the context related structures */
167 struct ly_set search_paths; /**< set of directories where to search for schema's imports/includes */
168 struct ly_set list; /**< set of YANG schemas */
Radek Krejcid33273d2018-10-25 14:55:52 +0200169 ly_module_imp_clb imp_clb; /**< Optional callback for retrieving missing included or imported models in a custom way. */
170 void *imp_clb_data; /**< Optional private data for imp_clb() */
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200171 uint16_t module_set_id; /**< ID of the current set of schemas */
172 uint16_t flags; /**< context settings, see @ref contextoptions. */
173 pthread_key_t errlist_key; /**< key for the thread-specific list of errors related to the context */
174};
175
Radek Krejcid33273d2018-10-25 14:55:52 +0200176/**
177 * @brief Try to find submodule in the context. Submodules are present only in the parsed (lysp_) schema trees, if only
178 * the compiled versions of the schemas are present, the submodule cannot be returned even if it was used to compile
179 * some of the currently present schemas.
180 *
181 * @param[in] ctx Context where to search
Radek Krejcifaa1eac2018-10-30 14:34:55 +0100182 * @param[in] module Name of the module where the submodule is supposed to belongs-to. If NULL, the module name is not checked.
Radek Krejcid33273d2018-10-25 14:55:52 +0200183 * @param[in] submodule Name of the submodule to find.
184 * @param[in] revision Optional revision of the submodule to find. If not specified, the latest revision is returned.
185 * @return Pointer to the specified submodule if it is present in the context.
186 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100187struct lysp_submodule *ly_ctx_get_submodule(const struct ly_ctx *ctx, const char *module, const char *submodule, const char *revision);
Radek Krejcid33273d2018-10-25 14:55:52 +0200188
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200189/******************************************************************************
Radek Krejcic59bc972018-09-17 16:13:06 +0200190 * Parsers
191 *****************************************************************************/
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200192
Radek Krejcic59bc972018-09-17 16:13:06 +0200193enum yang_keyword {
194 YANG_NONE = 0,
195 YANG_ACTION,
196 YANG_ANYDATA,
197 YANG_ANYXML,
198 YANG_ARGUMENT,
199 YANG_AUGMENT,
200 YANG_BASE,
201 YANG_BELONGS_TO,
202 YANG_BIT,
203 YANG_CASE,
204 YANG_CHOICE,
205 YANG_CONFIG,
206 YANG_CONTACT,
207 YANG_CONTAINER,
208 YANG_DEFAULT,
209 YANG_DESCRIPTION,
210 YANG_DEVIATE,
211 YANG_DEVIATION,
212 YANG_ENUM,
213 YANG_ERROR_APP_TAG,
214 YANG_ERROR_MESSAGE,
215 YANG_EXTENSION,
216 YANG_FEATURE,
217 YANG_FRACTION_DIGITS,
218 YANG_GROUPING,
219 YANG_IDENTITY,
220 YANG_IF_FEATURE,
221 YANG_IMPORT,
222 YANG_INCLUDE,
223 YANG_INPUT,
224 YANG_KEY,
225 YANG_LEAF,
226 YANG_LEAF_LIST,
227 YANG_LENGTH,
228 YANG_LIST,
229 YANG_MANDATORY,
230 YANG_MAX_ELEMENTS,
231 YANG_MIN_ELEMENTS,
232 YANG_MODIFIER,
233 YANG_MODULE,
234 YANG_MUST,
235 YANG_NAMESPACE,
236 YANG_NOTIFICATION,
237 YANG_ORDERED_BY,
238 YANG_ORGANIZATION,
239 YANG_OUTPUT,
240 YANG_PATH,
241 YANG_PATTERN,
242 YANG_POSITION,
243 YANG_PREFIX,
244 YANG_PRESENCE,
245 YANG_RANGE,
246 YANG_REFERENCE,
247 YANG_REFINE,
248 YANG_REQUIRE_INSTANCE,
249 YANG_REVISION,
250 YANG_REVISION_DATE,
251 YANG_RPC,
252 YANG_STATUS,
253 YANG_SUBMODULE,
254 YANG_TYPE,
255 YANG_TYPEDEF,
256 YANG_UNIQUE,
257 YANG_UNITS,
258 YANG_USES,
259 YANG_VALUE,
260 YANG_WHEN,
261 YANG_YANG_VERSION,
262 YANG_YIN_ELEMENT,
263
264 YANG_SEMICOLON,
265 YANG_LEFT_BRACE,
266 YANG_RIGHT_BRACE,
267 YANG_CUSTOM
268};
269
270/* list of the YANG statements strings */
271extern const char *const ly_stmt_list[];
272#define ly_stmt2str(STMT) ly_stmt_list[STMT]
273
274/* list of the extensions' substatements strings */
275extern const char *const lyext_substmt_list[];
276#define lyext_substmt2str(STMT) lyext_substmt_list[STMT]
277
278/* list of the deviate modifications strings */
279extern const char *const ly_devmod_list[];
280#define ly_devmod2str(TYPE) ly_devmod_list[TYPE]
281
282/******************************************************************************
Michal Vasko1324b6c2018-09-07 11:16:23 +0200283 * Generic useful functions.
Radek Krejcic59bc972018-09-17 16:13:06 +0200284 *****************************************************************************/
Michal Vasko1324b6c2018-09-07 11:16:23 +0200285
Radek Krejci76b3e962018-12-14 17:01:25 +0100286#define FREE_STRING(CTX, STRING) if (STRING) {lydict_remove(CTX, STRING);}
287
Michal Vasko1324b6c2018-09-07 11:16:23 +0200288/**
289 * @brief Wrapper for realloc() call. The only difference is that if it fails to
290 * allocate the requested memory, the original memory is freed as well.
291 *
292 * @param[in] ptr Memory to reallocate.
293 * @param[in] size New size of the memory block.
294 *
295 * @return Pointer to the new memory, NULL on error.
296 */
297void *ly_realloc(void *ptr, size_t size);
298
Radek Krejcif345c012018-09-19 11:12:59 +0200299/**
Radek Krejcib416be62018-10-01 14:51:45 +0200300 * @brief Get UTF8 code point of the next character in the input string.
301 *
302 * @param[in,out] input Input string to process, updated according to the processed/read data.
303 * @param[out] utf8_char UTF8 code point of the next character.
304 * @param[out] bytes_read Number of bytes used to encode the read utf8_char.
305 * @return LY_ERR value
306 */
307LY_ERR ly_getutf8(const char **input, unsigned int *utf8_char, size_t *bytes_read);
308
309/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100310 * @brief Parse signed integer with possible limitation.
311 * @param[in] val_str String value containing signed integer, note that
312 * nothing else than whitespaces are expected after the value itself.
313 * @param[in] min Limitation for the value which must not be lower than min.
314 * @param[in] max Limitation for the value which must not be higher than max.
315 * @param[in] base Numeric base for parsing:
316 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
317 * 10 - to accept only decimal (e.g. data instance value)
318 * @param[out] ret Resulting value.
319 * @return LY_ERR value:
320 * LY_EDENIED - the value breaks the limits,
321 * LY_EVALID - string contains invalid value,
322 * LY_SUCCESS - successful parsing.
323 */
324LY_ERR ly_parse_int(const char *val_str, int64_t min, int64_t max, int base, int64_t *ret);
325
326/**
327 * @brief Parse unsigned integer with possible limitation.
328 * @param[in] val_str String value containing unsigned integer, note that
329 * nothing else than whitespaces are expected after the value itself.
330 * @param[in] max Limitation for the value which must not be higher than max.
331 * @param[in] base Numeric base for parsing:
332 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
333 * 10 - to accept only decimal (e.g. data instance value)
334 * @param[out] ret Resulting value.
335 * @return LY_ERR value:
336 * LY_EDENIED - the value breaks the limits,
337 * LY_EVALID - string contains invalid value,
338 * LY_SUCCESS - successful parsing.
339 */
340LY_ERR ly_parse_uint(const char *val_str, uint64_t max, int base, uint64_t *ret);
341
342/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200343 * @brief mmap(2) wrapper to map input files into memory to unify parsing.
Radek Krejcif345c012018-09-19 11:12:59 +0200344 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200345 * The address space is allocate only for reading.
346 *
347 * @param[in] ctx libyang context for logging
348 * @param[in] fd Open file descriptor of a file to map.
349 * @param[out] length Allocated size.
350 * @param[out] addr Address where the file is mapped.
Radek Krejcif345c012018-09-19 11:12:59 +0200351 * @return LY_ERR value.
352 */
Radek Krejci86d106e2018-10-18 09:53:19 +0200353LY_ERR ly_mmap(struct ly_ctx *ctx, int fd, size_t *length, void **addr);
Michal Vasko841d1a92018-09-07 15:40:31 +0200354
Radek Krejci86d106e2018-10-18 09:53:19 +0200355/**
356 * @brief munmap(2) wrapper to free the memory mapped by ly_mmap()
Michal Vasko1324b6c2018-09-07 11:16:23 +0200357 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200358 * @param[in] addr Address where the input file is mapped.
359 * @param[in] length Allocated size of the address space.
360 * @return LY_ERR value.
361 */
362LY_ERR ly_munmap(void *addr, size_t length);
363
364/**
365 * @brief (Re-)Allocation of a ([sized array](@ref sizedarrays)).
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200366 *
Radek Krejci2c4e7172018-10-19 15:56:26 +0200367 * Increases the size information.
368 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200369 * @param[in] CTX libyang context for logging.
Radek Krejci2c4e7172018-10-19 15:56:26 +0200370 * @param[in,out] ARRAY Pointer to the array to allocate/resize. The size of the allocated
371 * space is counted from the type of the ARRAY, so do not provide placeholder void pointers.
Radek Krejci86d106e2018-10-18 09:53:19 +0200372 * @param[out] NEW_ITEM Returning pointer to the newly allocated record in the ARRAY.
373 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
Michal Vasko1324b6c2018-09-07 11:16:23 +0200374 */
Radek Krejci2c4e7172018-10-19 15:56:26 +0200375#define LY_ARRAY_NEW_RET(CTX, ARRAY, NEW_ITEM, RETVAL) \
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200376 if (!(ARRAY)) { \
377 ARRAY = malloc(sizeof(uint32_t) + sizeof *(ARRAY)); \
378 *((uint32_t*)(ARRAY)) = 1; \
379 } else { \
Radek Krejci2c4e7172018-10-19 15:56:26 +0200380 ++(*((uint32_t*)(ARRAY) - 1)); \
381 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + (*((uint32_t*)(ARRAY) - 1) * sizeof *(ARRAY))); \
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200382 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
383 } \
Radek Krejci2c4e7172018-10-19 15:56:26 +0200384 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
385 (NEW_ITEM) = &(ARRAY)[*((uint32_t*)(ARRAY) - 1) - 1]; \
386 memset(NEW_ITEM, 0, sizeof *(NEW_ITEM))
Michal Vasko1324b6c2018-09-07 11:16:23 +0200387
Radek Krejci2c4e7172018-10-19 15:56:26 +0200388/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100389 * @brief (Re-)Allocation of a ([sized array](@ref sizedarrays)).
390 *
391 * Increases the size information.
392 *
393 * @param[in] CTX libyang context for logging.
394 * @param[in,out] ARRAY Pointer to the array to allocate/resize. The size of the allocated
395 * space is counted from the type of the ARRAY, so do not provide placeholder void pointers.
396 * @param[out] NEW_ITEM Returning pointer to the newly allocated record in the ARRAY.
397 * @param[out] RET Variable to store error code.
398 * @param[in] GOTO Label to go in case of error (memory allocation failure).
399 */
400#define LY_ARRAY_NEW_GOTO(CTX, ARRAY, NEW_ITEM, RET, GOTO) \
401 if (!(ARRAY)) { \
402 ARRAY = malloc(sizeof(uint32_t) + sizeof *(ARRAY)); \
403 *((uint32_t*)(ARRAY)) = 1; \
404 } else { \
405 ++(*((uint32_t*)(ARRAY) - 1)); \
406 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + (*((uint32_t*)(ARRAY) - 1) * sizeof *(ARRAY))); \
407 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
408 } \
409 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
410 (NEW_ITEM) = &(ARRAY)[*((uint32_t*)(ARRAY) - 1) - 1]; \
411 memset(NEW_ITEM, 0, sizeof *(NEW_ITEM))
412
413/**
Radek Krejci2c4e7172018-10-19 15:56:26 +0200414 * @brief Allocate a ([sized array](@ref sizedarrays)) for the specified number of items.
Radek Krejcid05cbd92018-12-05 14:26:40 +0100415 * If the ARRAY already exists, it is resized (space for SIZE items is added).
Radek Krejci2c4e7172018-10-19 15:56:26 +0200416 *
417 * Does not set the size information, it is supposed to be incremented via ::LY_ARRAY_INCREMENT
418 * when the items are filled.
419 *
420 * @param[in] CTX libyang context for logging.
421 * @param[in,out] ARRAY Pointer to the array to create.
422 * @param[in] SIZE Number of items the array is supposed to hold. The size of the allocated
423 * space is then counted from the type of the ARRAY, so do not provide placeholder void pointers.
424 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
425 */
426#define LY_ARRAY_CREATE_RET(CTX, ARRAY, SIZE, RETVAL) \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100427 if (ARRAY) { \
428 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + ((*((uint32_t*)(ARRAY) - 1) + SIZE) * sizeof *(ARRAY))); \
429 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
430 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
431 memset(&(ARRAY)[*((uint32_t*)(ARRAY) - 1)], 0, SIZE * sizeof *(ARRAY)); \
432 } else { \
433 ARRAY = calloc(1, sizeof(uint32_t) + SIZE * sizeof *(ARRAY)); \
434 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
435 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
436 }
Radek Krejci2c4e7172018-10-19 15:56:26 +0200437
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100438/**
439 * @brief Allocate a ([sized array](@ref sizedarrays)) for the specified number of items.
Radek Krejcid05cbd92018-12-05 14:26:40 +0100440 * If the ARRAY already exists, it is resized (space for SIZE items is added).
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100441 *
442 * Does not set the size information, it is supposed to be incremented via ::LY_ARRAY_INCREMENT
443 * when the items are filled.
444 *
445 * @param[in] CTX libyang context for logging.
446 * @param[in,out] ARRAY Pointer to the array to create.
Radek Krejci00b874b2019-02-12 10:54:50 +0100447 * @param[in] SIZE Number of the new items the array is supposed to hold. The size of the allocated
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100448 * space is then counted from the type of the ARRAY, so do not provide placeholder void pointers.
449 * @param[out] RET Variable to store error code.
450 * @param[in] GOTO Label to go in case of error (memory allocation failure).
451 */
452#define LY_ARRAY_CREATE_GOTO(CTX, ARRAY, SIZE, RET, GOTO) \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100453 if (ARRAY) { \
454 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + ((*((uint32_t*)(ARRAY) - 1) + SIZE) * sizeof *(ARRAY))); \
455 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
456 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
457 memset(&(ARRAY)[*((uint32_t*)(ARRAY) - 1)], 0, SIZE * sizeof *(ARRAY)); \
458 } else { \
459 ARRAY = calloc(1, sizeof(uint32_t) + SIZE * sizeof *(ARRAY)); \
460 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
461 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
462 }
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100463
Radek Krejci2c4e7172018-10-19 15:56:26 +0200464#define LY_ARRAY_INCREMENT(ARRAY) \
465 ++(*((uint32_t*)(ARRAY) - 1))
466/**
467 * @brief Free the space allocated for the ([sized array](@ref sizedarrays)).
468 *
469 * The items inside the array are not freed.
470 *
471 * @param[in] ARRAY A ([sized array](@ref sizedarrays)) to be freed.
472 */
473#define LY_ARRAY_FREE(ARRAY) \
474 if (ARRAY){free((uint32_t*)(ARRAY) - 1);}
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200475#endif /* LY_COMMON_H_ */