blob: 021eca8c5f79b8e9823b7f08d680d5b82079b473 [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 Krejci6caa6ab2018-10-24 10:04:48 +020021#include <pthread.h>
Radek Krejcie7b95092019-05-15 11:03:07 +020022#include <stddef.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020023#include <stdint.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020024
Radek Krejci2c22f122018-09-05 15:08:03 +020025#include "config.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020026
Radek Krejcid33273d2018-10-25 14:55:52 +020027#include "context.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020028#include "dict.h"
Radek Krejci6caa6ab2018-10-24 10:04:48 +020029#include "hash_table.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020030#include "log.h"
31#include "set.h"
32
33struct ly_ctx;
Radek Krejci5aeea3a2018-09-05 13:29:36 +020034
35#if __STDC_VERSION__ >= 201112 && !defined __STDC_NO_THREADS__
36# define THREAD_LOCAL _Thread_local
37#elif defined __GNUC__ || \
38 defined __SUNPRO_C || \
39 defined __xlC__
40# define THREAD_LOCAL __thread
41#else
42# error "Cannot define THREAD_LOCAL"
43#endif
44
Radek Krejcic59bc972018-09-17 16:13:06 +020045#define GETMACRO1(_1, NAME, ...) NAME
Radek Krejci5aeea3a2018-09-05 13:29:36 +020046#define GETMACRO2(_1, _2, NAME, ...) NAME
47#define GETMACRO3(_1, _2, _3, NAME, ...) NAME
48#define GETMACRO4(_1, _2, _3, _4, NAME, ...) NAME
49
50/*
Radek Krejcic59bc972018-09-17 16:13:06 +020051 * If the compiler supports attribute to mark objects as hidden, mark all
52 * objects as hidden and export only objects explicitly marked to be part of
53 * the public API.
Radek Krejci5aeea3a2018-09-05 13:29:36 +020054 */
Radek Krejcic59bc972018-09-17 16:13:06 +020055#define API __attribute__((visibility("default")))
56
Radek Krejcicad716e2018-11-26 15:18:27 +010057
Radek Krejcic59bc972018-09-17 16:13:06 +020058/******************************************************************************
Radek Krejcie7b95092019-05-15 11:03:07 +020059 * Compatibility functions
60 *****************************************************************************/
61
Radek Krejcia9dc4ab2019-05-16 11:13:17 +020062#ifndef HAVE_GET_CURRENT_DIR_NAME
63/**
64 * @brief Return a malloc'd string containing the current directory name.
65 */
66char *get_current_dir_name(void);
67#endif
68
Radek Krejcie7b95092019-05-15 11:03:07 +020069#ifndef HAVE_STRNSTR
70/**
71 * @brief Find the first occurrence of find in s, where the search is limited to the
72 * first slen characters of s.
73 */
74char *strnstr(const char *s, const char *find, size_t slen);
75#endif
76
77
78/******************************************************************************
Radek Krejcic59bc972018-09-17 16:13:06 +020079 * Logger
80 *****************************************************************************/
Radek Krejci5aeea3a2018-09-05 13:29:36 +020081
82/* internal logging options */
83enum int_log_opts {
84 ILO_LOG = 0, /* log normally */
85 ILO_STORE, /* only store any messages, they will be processed higher on stack */
86 ILO_IGNORE, /* completely ignore messages */
87 ILO_ERR2WRN, /* change errors to warnings */
88};
89
Radek Krejci94aa9942018-09-07 17:12:17 +020090enum LY_VLOG_ELEM {
91 LY_VLOG_NONE = 0,
92 LY_VLOG_LINE,/* line number */
93 LY_VLOG_LYS, /* struct lysc_node* */
94 LY_VLOG_LYD, /* struct lyd_node* */
95 LY_VLOG_STR, /* const char* */
96 LY_VLOG_PREV /* use exact same previous path */
97};
98
Radek Krejci5aeea3a2018-09-05 13:29:36 +020099extern THREAD_LOCAL enum int_log_opts log_opt;
100extern volatile uint8_t ly_log_level;
101extern volatile uint8_t ly_log_opts;
102
Radek Krejcie7b95092019-05-15 11:03:07 +0200103/**
104 * @brief Set error-app-tag to the last error record in the context.
105 * @param[in] ctx libyang context where the error records are present.
106 * @param[in] apptag The error-app-tag value to store.
107 */
108void ly_err_last_set_apptag(const struct ly_ctx *ctx, const char *apptag);
109
110/**
111 * @brief Print a log message and store it into the context (if provided).
112 *
113 * @param[in] ctx libyang context to store the error record. If not provided, the error is just printed.
114 * @param[in] level Log message level (error, warning, etc.)
115 * @param[in] no Error type code.
116 * @param[in] format Format string to print.
117 */
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200118void ly_log(const struct ly_ctx *ctx, LY_LOG_LEVEL level, LY_ERR no, const char *format, ...);
Radek Krejcie7b95092019-05-15 11:03:07 +0200119
120/**
121 * @brief Print Validation error and store it into the context (if provided).
122 *
123 * @param[in] ctx libyang context to store the error record. If not provided, the error is just printed.
124 * @param[in] elem_type Type of the data in @p elem variable.
125 * @param[in] elem Object to provide more information about the place where the error appeared.
126 * @param[in] code Validation error code.
127 * @param[in] format Format string to print.
128 */
Radek Krejci94aa9942018-09-07 17:12:17 +0200129void 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 +0200130
131#define LOGERR(ctx, errno, str, args...) ly_log(ctx, LY_LLERR, errno, str, ##args)
Radek Krejcif3f47842018-11-15 11:22:15 +0100132#define LOGWRN(ctx, str, ...) ly_log(ctx, LY_LLWRN, 0, str, ##__VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200133#define LOGVRB(str, args...) ly_log(NULL, LY_LLVRB, 0, str, ##args)
134
Radek Krejci4ab61562018-09-05 15:00:37 +0200135#ifdef NDEBUG
136# define LOGDBG(dbg_group, str, args...)
137#else
138 void ly_log_dbg(int group, const char *format, ...);
139# define LOGDBG(dbg_group, str, args...) ly_log_dbg(dbg_group, str, ##args);
140#endif
141
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200142#define LOGMEM(CTX) LOGERR(CTX, LY_EMEM, "Memory allocation failed (%s()).", __func__)
143#define LOGINT(CTX) LOGERR(CTX, LY_EINT, "Internal error (%s:%d).", __FILE__, __LINE__)
144#define LOGARG(CTX, ARG) LOGERR(CTX, LY_EINVAL, "Invalid argument %s (%s()).", #ARG, __func__)
Radek Krejcic07921a2018-09-17 11:40:15 +0200145#define LOGVAL(CTX, ELEM_TYPE, ELEM, CODE, FORMAT...) ly_vlog(CTX, ELEM_TYPE, ELEM, CODE, ##FORMAT)
Radek Krejci94aa9942018-09-07 17:12:17 +0200146
147#define LOGMEM_RET(CTX) LOGMEM(CTX); return LY_EMEM
148#define LOGINT_RET(CTX) LOGINT(CTX); return LY_EINT
149#define LOGARG_RET(CTX) LOGARG(CTX); return LY_EINVAL
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200150
151/*
152 * Common code to check return value and perform appropriate action.
153 */
Radek Krejcie88beef2019-05-30 15:47:19 +0200154#define LY_CHECK_GOTO(COND, GOTO) if ((COND)) {goto GOTO;}
155#define LY_CHECK_ERR_GOTO(COND, ERR, GOTO) if ((COND)) {ERR; goto GOTO;}
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100156#define LY_CHECK_RET1(RETVAL) {LY_ERR ret__ = RETVAL;if (ret__ != LY_SUCCESS) {return ret__;}}
Radek Krejcie88beef2019-05-30 15:47:19 +0200157#define LY_CHECK_RET2(COND, RETVAL) if ((COND)) {return RETVAL;}
Radek Krejcic59bc972018-09-17 16:13:06 +0200158#define LY_CHECK_RET(...) GETMACRO2(__VA_ARGS__, LY_CHECK_RET2, LY_CHECK_RET1)(__VA_ARGS__)
Radek Krejcie88beef2019-05-30 15:47:19 +0200159#define LY_CHECK_ERR_RET(COND, ERR, RETVAL) if ((COND)) {ERR; return RETVAL;}
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200160
Radek Krejcia3045382018-11-22 14:30:31 +0100161#define LY_CHECK_ARG_GOTO1(CTX, ARG, GOTO) if (!(ARG)) {LOGARG(CTX, ARG);goto GOTO;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200162#define LY_CHECK_ARG_GOTO2(CTX, ARG1, ARG2, GOTO) LY_CHECK_ARG_GOTO1(CTX, ARG1, GOTO);LY_CHECK_ARG_GOTO1(CTX, ARG2, GOTO)
163#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)
164#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 +0200165
Radek Krejcia3045382018-11-22 14:30:31 +0100166#define LY_CHECK_ARG_RET1(CTX, ARG, RETVAL) if (!(ARG)) {LOGARG(CTX, ARG);return RETVAL;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200167#define LY_CHECK_ARG_RET2(CTX, ARG1, ARG2, RETVAL) LY_CHECK_ARG_RET1(CTX, ARG1, RETVAL);LY_CHECK_ARG_RET1(CTX, ARG2, RETVAL)
168#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)
169#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 +0200170
Radek Krejcid972c252018-09-25 13:23:39 +0200171/* count sequence size for LY_VCODE_INCHILDSTMT validation error code */
172size_t LY_VCODE_INSTREXP_len(const char *str);
173/* default maximum characters to print in LY_VCODE_INCHILDSTMT */
174#define LY_VCODE_INSTREXP_MAXLEN 20
175
Michal Vasko58257712018-09-12 11:11:38 +0200176#define LY_VCODE_INCHAR LYVE_SYNTAX, "Invalid character 0x%x."
Michal Vasko37d705c2018-09-12 15:31:26 +0200177#define LY_VCODE_INSTREXP LYVE_SYNTAX, "Invalid character sequence \"%.*s\", expected %s."
Radek Krejci0a1d0d42019-05-16 15:14:51 +0200178#define LY_VCODE_EOF LYVE_SYNTAX, "Unexpected end-of-input."
Radek Krejcid91dbaf2018-09-21 15:51:39 +0200179#define LY_VCODE_NTERM LYVE_SYNTAX, "%s not terminated."
180#define LY_VCODE_NSUPP LYVE_SYNTAX, "%s not supported."
Radek Krejci94aa9942018-09-07 17:12:17 +0200181#define LY_VCODE_INSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\"."
Michal Vasko58257712018-09-12 11:11:38 +0200182#define LY_VCODE_INCHILDSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\" as a child of \"%s\"."
Radek Krejci10113652018-11-14 16:56:50 +0100183#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 +0100184#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 +0200185#define LY_VCODE_DUPSTMT LYVE_SYNTAX_YANG, "Duplicate keyword \"%s\"."
Radek Krejcifaa1eac2018-10-30 14:34:55 +0100186#define LY_VCODE_DUPIDENT LYVE_SYNTAX_YANG, "Duplicate identifier \"%s\" of %s statement."
Michal Vasko37d705c2018-09-12 15:31:26 +0200187#define LY_VCODE_INVAL LYVE_SYNTAX_YANG, "Invalid value \"%.*s\" of \"%s\"."
Michal Vasko58257712018-09-12 11:11:38 +0200188#define LY_VCODE_MISSTMT LYVE_SYNTAX_YANG, "Missing mandatory keyword \"%s\" as a child of \"%s\"."
Radek Krejci555cb5b2018-11-16 14:54:33 +0100189#define LY_VCODE_MISSCHILDSTMT LYVE_SYNTAX_YANG, "Missing %s substatement for %s%s."
Michal Vasko58257712018-09-12 11:11:38 +0200190#define LY_VCODE_INORD LYVE_SYNTAX_YANG, "Invalid keyword \"%s\", it cannot appear after \"%s\"."
Michal Vasko37d705c2018-09-12 15:31:26 +0200191#define LY_VCODE_OOB LYVE_SYNTAX_YANG, "Value \"%.*s\" is out of \"%s\" bounds."
Michal Vasko58257712018-09-12 11:11:38 +0200192#define LY_VCODE_INDEV LYVE_SYNTAX_YANG, "Deviate \"%s\" does not support keyword \"%s\"."
Radek Krejci4586a022018-11-13 11:29:26 +0100193#define LY_VCODE_INREGEXP LYVE_SYNTAX_YANG, "Regular expression \"%s\" is not valid (\"%s\": %s)."
Radek Krejcib1646a92018-11-02 16:08:26 +0100194#define LY_VCODE_XP_EOE LYVE_XPATH, "Unterminated string delimited with %c (%.15s)."
Radek Krejci6a9a0c02019-06-21 10:15:22 +0200195#define LY_VCODE_XP_INEXPR LYVE_XPATH, "Invalid character number %u of expression \'%s\'."
Radek Krejci327de162019-06-14 12:52:07 +0200196#define LY_VCODE_DEV_NODETYPE LYVE_REFERENCE, "Invalid deviation of %s node - it is not possible to %s \"%s\" property."
197#define LY_VCODE_DEV_NOT_PRESENT LYVE_REFERENCE, "Invalid deviation %s \"%s\" property \"%s\" which is not present."
Radek Krejci94aa9942018-09-07 17:12:17 +0200198
Radek Krejcic59bc972018-09-17 16:13:06 +0200199/******************************************************************************
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200200 * Context
201 *****************************************************************************/
202
203/**
204 * @brief Context of the YANG schemas
205 */
206struct ly_ctx {
207 struct dict_table dict; /**< dictionary to effectively store strings used in the context related structures */
208 struct ly_set search_paths; /**< set of directories where to search for schema's imports/includes */
209 struct ly_set list; /**< set of YANG schemas */
Radek Krejcid33273d2018-10-25 14:55:52 +0200210 ly_module_imp_clb imp_clb; /**< Optional callback for retrieving missing included or imported models in a custom way. */
211 void *imp_clb_data; /**< Optional private data for imp_clb() */
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200212 uint16_t module_set_id; /**< ID of the current set of schemas */
213 uint16_t flags; /**< context settings, see @ref contextoptions. */
214 pthread_key_t errlist_key; /**< key for the thread-specific list of errors related to the context */
215};
216
Radek Krejcid33273d2018-10-25 14:55:52 +0200217/**
Radek Krejci474f9b82019-07-24 11:36:37 +0200218 * @defgroup contextflags Context flags
219 * @ingroup context
220 *
221 * Internal context flags.
222 *
223 * Note that the flags 0x00FF are reserved for @ref contextoptions.
224 * @{
225 */
226
227#define LY_CTX_CHANGED_TREE 0x8000 /**< Deviation changed tree of a module(s) in the context, it is necessary to recompile
228 leafref paths, default values and must/when expressions to check that they are still valid */
229
230/**@} contextflags */
231
232/**
Radek Krejcid33273d2018-10-25 14:55:52 +0200233 * @brief Try to find submodule in the context. Submodules are present only in the parsed (lysp_) schema trees, if only
234 * the compiled versions of the schemas are present, the submodule cannot be returned even if it was used to compile
235 * some of the currently present schemas.
236 *
237 * @param[in] ctx Context where to search
Radek Krejcifaa1eac2018-10-30 14:34:55 +0100238 * @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 +0200239 * @param[in] submodule Name of the submodule to find.
240 * @param[in] revision Optional revision of the submodule to find. If not specified, the latest revision is returned.
241 * @return Pointer to the specified submodule if it is present in the context.
242 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100243struct 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 +0200244
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200245/******************************************************************************
Radek Krejcic59bc972018-09-17 16:13:06 +0200246 * Parsers
247 *****************************************************************************/
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200248
Radek Krejcic59bc972018-09-17 16:13:06 +0200249enum yang_keyword {
250 YANG_NONE = 0,
251 YANG_ACTION,
252 YANG_ANYDATA,
253 YANG_ANYXML,
254 YANG_ARGUMENT,
255 YANG_AUGMENT,
256 YANG_BASE,
257 YANG_BELONGS_TO,
258 YANG_BIT,
259 YANG_CASE,
260 YANG_CHOICE,
261 YANG_CONFIG,
262 YANG_CONTACT,
263 YANG_CONTAINER,
264 YANG_DEFAULT,
265 YANG_DESCRIPTION,
266 YANG_DEVIATE,
267 YANG_DEVIATION,
268 YANG_ENUM,
269 YANG_ERROR_APP_TAG,
270 YANG_ERROR_MESSAGE,
271 YANG_EXTENSION,
272 YANG_FEATURE,
273 YANG_FRACTION_DIGITS,
274 YANG_GROUPING,
275 YANG_IDENTITY,
276 YANG_IF_FEATURE,
277 YANG_IMPORT,
278 YANG_INCLUDE,
279 YANG_INPUT,
280 YANG_KEY,
281 YANG_LEAF,
282 YANG_LEAF_LIST,
283 YANG_LENGTH,
284 YANG_LIST,
285 YANG_MANDATORY,
286 YANG_MAX_ELEMENTS,
287 YANG_MIN_ELEMENTS,
288 YANG_MODIFIER,
289 YANG_MODULE,
290 YANG_MUST,
291 YANG_NAMESPACE,
292 YANG_NOTIFICATION,
293 YANG_ORDERED_BY,
294 YANG_ORGANIZATION,
295 YANG_OUTPUT,
296 YANG_PATH,
297 YANG_PATTERN,
298 YANG_POSITION,
299 YANG_PREFIX,
300 YANG_PRESENCE,
301 YANG_RANGE,
302 YANG_REFERENCE,
303 YANG_REFINE,
304 YANG_REQUIRE_INSTANCE,
305 YANG_REVISION,
306 YANG_REVISION_DATE,
307 YANG_RPC,
308 YANG_STATUS,
309 YANG_SUBMODULE,
310 YANG_TYPE,
311 YANG_TYPEDEF,
312 YANG_UNIQUE,
313 YANG_UNITS,
314 YANG_USES,
315 YANG_VALUE,
316 YANG_WHEN,
317 YANG_YANG_VERSION,
318 YANG_YIN_ELEMENT,
319
320 YANG_SEMICOLON,
321 YANG_LEFT_BRACE,
322 YANG_RIGHT_BRACE,
323 YANG_CUSTOM
324};
325
326/* list of the YANG statements strings */
327extern const char *const ly_stmt_list[];
328#define ly_stmt2str(STMT) ly_stmt_list[STMT]
329
330/* list of the extensions' substatements strings */
331extern const char *const lyext_substmt_list[];
332#define lyext_substmt2str(STMT) lyext_substmt_list[STMT]
333
334/* list of the deviate modifications strings */
335extern const char *const ly_devmod_list[];
336#define ly_devmod2str(TYPE) ly_devmod_list[TYPE]
337
338/******************************************************************************
Michal Vasko1324b6c2018-09-07 11:16:23 +0200339 * Generic useful functions.
Radek Krejcic59bc972018-09-17 16:13:06 +0200340 *****************************************************************************/
Michal Vasko1324b6c2018-09-07 11:16:23 +0200341
Radek Krejci76b3e962018-12-14 17:01:25 +0100342#define FREE_STRING(CTX, STRING) if (STRING) {lydict_remove(CTX, STRING);}
343
Michal Vasko1324b6c2018-09-07 11:16:23 +0200344/**
345 * @brief Wrapper for realloc() call. The only difference is that if it fails to
346 * allocate the requested memory, the original memory is freed as well.
347 *
348 * @param[in] ptr Memory to reallocate.
349 * @param[in] size New size of the memory block.
350 *
351 * @return Pointer to the new memory, NULL on error.
352 */
353void *ly_realloc(void *ptr, size_t size);
354
Radek Krejcif345c012018-09-19 11:12:59 +0200355/**
Radek Krejcib416be62018-10-01 14:51:45 +0200356 * @brief Get UTF8 code point of the next character in the input string.
357 *
358 * @param[in,out] input Input string to process, updated according to the processed/read data.
359 * @param[out] utf8_char UTF8 code point of the next character.
360 * @param[out] bytes_read Number of bytes used to encode the read utf8_char.
361 * @return LY_ERR value
362 */
363LY_ERR ly_getutf8(const char **input, unsigned int *utf8_char, size_t *bytes_read);
364
365/**
Radek Krejci76c98012019-08-14 11:23:24 +0200366 * @brief Get number of characters in the @p str, taking multibyte characters into account.
367 * @param[in] str String to examine.
368 * @param[in] bytes Number of valid bytes that are supposed to be taken into account in @p str.
369 * This parameter is useful mainly for non NULL-terminated strings. In case of NULL-terminated
370 * string, strlen() can be used.
371 * @return Number of characters in (possibly) multibyte characters string.
372 */
373size_t ly_utf8len(const char *str, size_t bytes);
374
375/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100376 * @brief Parse signed integer with possible limitation.
377 * @param[in] val_str String value containing signed integer, note that
378 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200379 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100380 * @param[in] min Limitation for the value which must not be lower than min.
381 * @param[in] max Limitation for the value which must not be higher than max.
382 * @param[in] base Numeric base for parsing:
383 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
384 * 10 - to accept only decimal (e.g. data instance value)
385 * @param[out] ret Resulting value.
386 * @return LY_ERR value:
387 * LY_EDENIED - the value breaks the limits,
388 * LY_EVALID - string contains invalid value,
389 * LY_SUCCESS - successful parsing.
390 */
Radek Krejci249973a2019-06-10 10:50:54 +0200391LY_ERR ly_parse_int(const char *val_str, size_t val_len, int64_t min, int64_t max, int base, int64_t *ret);
Radek Krejci4f28eda2018-11-12 11:46:16 +0100392
393/**
394 * @brief Parse unsigned integer with possible limitation.
395 * @param[in] val_str String value containing unsigned integer, note that
396 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200397 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100398 * @param[in] max Limitation for the value which must not be higher than max.
399 * @param[in] base Numeric base for parsing:
400 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
401 * 10 - to accept only decimal (e.g. data instance value)
402 * @param[out] ret Resulting value.
403 * @return LY_ERR value:
404 * LY_EDENIED - the value breaks the limits,
405 * LY_EVALID - string contains invalid value,
406 * LY_SUCCESS - successful parsing.
407 */
Radek Krejci249973a2019-06-10 10:50:54 +0200408LY_ERR ly_parse_uint(const char *val_str, size_t val_len, uint64_t max, int base, uint64_t *ret);
Radek Krejci4f28eda2018-11-12 11:46:16 +0100409
410/**
Radek Krejcib4a4a272019-06-10 12:44:52 +0200411 * @brief Parse a node-identifier.
412 *
413 * node-identifier = [prefix ":"] identifier
414 *
415 * @param[in, out] id Identifier to parse. When returned, it points to the first character which is not part of the identifier.
416 * @param[out] prefix Node's prefix, NULL if there is not any.
417 * @param[out] prefix_len Length of the node's prefix, 0 if there is not any.
418 * @param[out] name Node's name.
419 * @param[out] nam_len Length of the node's name.
420 * @return LY_ERR value: LY_SUCCESS or LY_EINVAL in case of invalid character in the id.
421 */
422LY_ERR ly_parse_nodeid(const char **id, const char **prefix, size_t *prefix_len, const char **name, size_t *name_len);
423
424/**
425 * @brief parse instance-identifier's predicate, supports key-predicate, leaf-list-predicate and pos rules from YANG ABNF Grammar.
426 *
427 * @param[in, out] pred Predicate string (including the leading '[') to parse. The string is updated according to what was parsed
428 * (even for error case, so it can be used to determine which substring caused failure).
429 * @param[in] limit Limiting length of the @p pred. Function expects NULL terminated string which is not overread.
430 * The limit value is not checked with each character, so it can be overread and the failure is detected later.
Radek Krejci084289f2019-07-09 17:35:30 +0200431 * @param[in] format Input format of the data containing the @p pred.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200432 * @param[out] prefix Start of the node-identifier's prefix if any, NULL in case of pos or leaf-list-predicate rules.
433 * @param[out] prefix_len Length of the parsed @p prefix.
434 * @param[out] id Start of the node-identifier's identifier string, NULL in case of pos rule, "." in case of leaf-list-predicate rule.
435 * @param[out] id_len Length of the parsed @p id.
Radek Krejci084289f2019-07-09 17:35:30 +0200436 * @param[out] value Start of the quoted-string (without quotation marks), not NULL in case of success.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200437 * @param[out] value_len Length of the parsed @p value.
438 * @param[out] errmsg Error message string in case of error.
439 * @return LY_SUCCESS in case a complete predicate was parsed.
440 * @return LY_EVALID in case of invalid predicate form.
441 * @return LY_EINVAL in case of reaching @p limit when parsing @p pred.
442 */
Radek Krejci084289f2019-07-09 17:35:30 +0200443LY_ERR ly_parse_instance_predicate(const char **pred, size_t limit, LYD_FORMAT format,
Radek Krejcib4a4a272019-06-10 12:44:52 +0200444 const char **prefix, size_t *prefix_len, const char **id, size_t *id_len,
445 const char **value, size_t *value_len, const char **errmsg);
446
447/**
Radek Krejci13a57b62019-07-19 13:04:09 +0200448 * @brief ly_clb_get_prefix implementation for JSON. For its simplicity, this implementation is used
449 * internally for various purposes.
450 *
451 * Implemented in printer_json.c
452 */
453const char *json_print_get_prefix(const struct lys_module *mod, void *private);
454
455/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200456 * @brief mmap(2) wrapper to map input files into memory to unify parsing.
Radek Krejcif345c012018-09-19 11:12:59 +0200457 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200458 * The address space is allocate only for reading.
459 *
460 * @param[in] ctx libyang context for logging
461 * @param[in] fd Open file descriptor of a file to map.
462 * @param[out] length Allocated size.
463 * @param[out] addr Address where the file is mapped.
Radek Krejcif345c012018-09-19 11:12:59 +0200464 * @return LY_ERR value.
465 */
Radek Krejci86d106e2018-10-18 09:53:19 +0200466LY_ERR ly_mmap(struct ly_ctx *ctx, int fd, size_t *length, void **addr);
Michal Vasko841d1a92018-09-07 15:40:31 +0200467
Radek Krejci86d106e2018-10-18 09:53:19 +0200468/**
469 * @brief munmap(2) wrapper to free the memory mapped by ly_mmap()
Michal Vasko1324b6c2018-09-07 11:16:23 +0200470 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200471 * @param[in] addr Address where the input file is mapped.
472 * @param[in] length Allocated size of the address space.
473 * @return LY_ERR value.
474 */
475LY_ERR ly_munmap(void *addr, size_t length);
476
477/**
Radek Krejci4546aa62019-07-15 16:53:32 +0200478 * @brief Concatenate formating string to the @p dest.
479 *
480 * @param[in, out] dest String to be concatenated by @p format.
481 * Note that the input string can be reallocated during concatenation.
482 * @param[in] format Formating string (as for printf) which is supposed to be added after @p dest.
483 * @return LY_SUCCESS or LY_EMEM.
484 */
485LY_ERR ly_strcat(char **dest, const char *format, ...);
486
487/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200488 * @brief (Re-)Allocation of a ([sized array](@ref sizedarrays)).
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200489 *
Radek Krejci2c4e7172018-10-19 15:56:26 +0200490 * Increases the size information.
491 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200492 * @param[in] CTX libyang context for logging.
Radek Krejci2c4e7172018-10-19 15:56:26 +0200493 * @param[in,out] ARRAY Pointer to the array to allocate/resize. The size of the allocated
494 * space is counted from the type of the ARRAY, so do not provide placeholder void pointers.
Radek Krejci86d106e2018-10-18 09:53:19 +0200495 * @param[out] NEW_ITEM Returning pointer to the newly allocated record in the ARRAY.
496 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
Michal Vasko1324b6c2018-09-07 11:16:23 +0200497 */
Radek Krejci2c4e7172018-10-19 15:56:26 +0200498#define LY_ARRAY_NEW_RET(CTX, ARRAY, NEW_ITEM, RETVAL) \
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200499 if (!(ARRAY)) { \
500 ARRAY = malloc(sizeof(uint32_t) + sizeof *(ARRAY)); \
501 *((uint32_t*)(ARRAY)) = 1; \
502 } else { \
Radek Krejci2c4e7172018-10-19 15:56:26 +0200503 ++(*((uint32_t*)(ARRAY) - 1)); \
504 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + (*((uint32_t*)(ARRAY) - 1) * sizeof *(ARRAY))); \
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200505 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
506 } \
Radek Krejci2c4e7172018-10-19 15:56:26 +0200507 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
508 (NEW_ITEM) = &(ARRAY)[*((uint32_t*)(ARRAY) - 1) - 1]; \
509 memset(NEW_ITEM, 0, sizeof *(NEW_ITEM))
Michal Vasko1324b6c2018-09-07 11:16:23 +0200510
Radek Krejci2c4e7172018-10-19 15:56:26 +0200511/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100512 * @brief (Re-)Allocation of a ([sized array](@ref sizedarrays)).
513 *
514 * Increases the size information.
515 *
516 * @param[in] CTX libyang context for logging.
517 * @param[in,out] ARRAY Pointer to the array to allocate/resize. The size of the allocated
518 * space is counted from the type of the ARRAY, so do not provide placeholder void pointers.
519 * @param[out] NEW_ITEM Returning pointer to the newly allocated record in the ARRAY.
520 * @param[out] RET Variable to store error code.
521 * @param[in] GOTO Label to go in case of error (memory allocation failure).
522 */
523#define LY_ARRAY_NEW_GOTO(CTX, ARRAY, NEW_ITEM, RET, GOTO) \
524 if (!(ARRAY)) { \
525 ARRAY = malloc(sizeof(uint32_t) + sizeof *(ARRAY)); \
526 *((uint32_t*)(ARRAY)) = 1; \
527 } else { \
528 ++(*((uint32_t*)(ARRAY) - 1)); \
529 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + (*((uint32_t*)(ARRAY) - 1) * sizeof *(ARRAY))); \
530 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
531 } \
532 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
533 (NEW_ITEM) = &(ARRAY)[*((uint32_t*)(ARRAY) - 1) - 1]; \
534 memset(NEW_ITEM, 0, sizeof *(NEW_ITEM))
535
536/**
Radek Krejci2c4e7172018-10-19 15:56:26 +0200537 * @brief Allocate a ([sized array](@ref sizedarrays)) for the specified number of items.
Radek Krejcid05cbd92018-12-05 14:26:40 +0100538 * If the ARRAY already exists, it is resized (space for SIZE items is added).
Radek Krejci2c4e7172018-10-19 15:56:26 +0200539 *
540 * Does not set the size information, it is supposed to be incremented via ::LY_ARRAY_INCREMENT
541 * when the items are filled.
542 *
543 * @param[in] CTX libyang context for logging.
544 * @param[in,out] ARRAY Pointer to the array to create.
545 * @param[in] SIZE Number of items the array is supposed to hold. The size of the allocated
546 * space is then counted from the type of the ARRAY, so do not provide placeholder void pointers.
547 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
548 */
549#define LY_ARRAY_CREATE_RET(CTX, ARRAY, SIZE, RETVAL) \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100550 if (ARRAY) { \
551 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + ((*((uint32_t*)(ARRAY) - 1) + SIZE) * sizeof *(ARRAY))); \
552 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
553 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
554 memset(&(ARRAY)[*((uint32_t*)(ARRAY) - 1)], 0, SIZE * sizeof *(ARRAY)); \
555 } else { \
556 ARRAY = calloc(1, sizeof(uint32_t) + SIZE * sizeof *(ARRAY)); \
557 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
558 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
559 }
Radek Krejci2c4e7172018-10-19 15:56:26 +0200560
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100561/**
562 * @brief Allocate a ([sized array](@ref sizedarrays)) for the specified number of items.
Radek Krejcid05cbd92018-12-05 14:26:40 +0100563 * If the ARRAY already exists, it is resized (space for SIZE items is added).
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100564 *
565 * Does not set the size information, it is supposed to be incremented via ::LY_ARRAY_INCREMENT
566 * when the items are filled.
567 *
568 * @param[in] CTX libyang context for logging.
569 * @param[in,out] ARRAY Pointer to the array to create.
Radek Krejci00b874b2019-02-12 10:54:50 +0100570 * @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 +0100571 * space is then counted from the type of the ARRAY, so do not provide placeholder void pointers.
572 * @param[out] RET Variable to store error code.
573 * @param[in] GOTO Label to go in case of error (memory allocation failure).
574 */
575#define LY_ARRAY_CREATE_GOTO(CTX, ARRAY, SIZE, RET, GOTO) \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100576 if (ARRAY) { \
Radek Krejci58dca372019-04-12 10:38:06 +0200577 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + ((*((uint32_t*)(ARRAY) - 1) + (SIZE)) * sizeof *(ARRAY))); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100578 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
579 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
Radek Krejci58dca372019-04-12 10:38:06 +0200580 memset(&(ARRAY)[*((uint32_t*)(ARRAY) - 1)], 0, (SIZE) * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100581 } else { \
Radek Krejci58dca372019-04-12 10:38:06 +0200582 ARRAY = calloc(1, sizeof(uint32_t) + (SIZE) * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100583 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
584 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
585 }
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100586
Radek Krejci2c4e7172018-10-19 15:56:26 +0200587#define LY_ARRAY_INCREMENT(ARRAY) \
588 ++(*((uint32_t*)(ARRAY) - 1))
Radek Krejciccd20f12019-02-15 14:12:27 +0100589
590#define LY_ARRAY_DECREMENT(ARRAY) \
591 --(*((uint32_t*)(ARRAY) - 1))
592
Radek Krejci2c4e7172018-10-19 15:56:26 +0200593/**
594 * @brief Free the space allocated for the ([sized array](@ref sizedarrays)).
595 *
596 * The items inside the array are not freed.
597 *
598 * @param[in] ARRAY A ([sized array](@ref sizedarrays)) to be freed.
599 */
600#define LY_ARRAY_FREE(ARRAY) \
601 if (ARRAY){free((uint32_t*)(ARRAY) - 1);}
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200602#endif /* LY_COMMON_H_ */