blob: 2cca2b2ae81a51d2fea4467fccae0ae7227c3c30 [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,
Radek Krejci335332a2019-09-05 13:03:35 +020092 LY_VLOG_LINE,/* line number (uint64_t*) */
Radek Krejci94aa9942018-09-07 17:12:17 +020093 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."
David Sedlák1538a842019-08-08 15:38:51 +0200181#define LY_VCODE_MOD_SUBOMD LYVE_SYNTAX, "Invalid keyword \"%s\", expected \"module\" or \"submodule\"."
182#define LY_VCODE_TRAILING_MOD LYVE_SYNTAX, "Trailing garbage \"%.*s%s\" after module, expected end-of-input."
183#define LY_VCODE_TRAILING_SUBMOD LYVE_SYNTAX, "Trailing garbage \"%.*s%s\" after submodule, expected end-of-input."
184
185#define LY_VCODE_INVAL_MINMAX LYVE_SEMANTICS, "Invalid combination of min-elements and max-elements: min value %u is bigger than the max value %u."
David Sedlák0c2bab92019-07-22 15:33:19 +0200186
Radek Krejci94aa9942018-09-07 17:12:17 +0200187#define LY_VCODE_INSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\"."
Michal Vasko58257712018-09-12 11:11:38 +0200188#define LY_VCODE_INCHILDSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\" as a child of \"%s\"."
Radek Krejci10113652018-11-14 16:56:50 +0100189#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 +0100190#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 +0200191#define LY_VCODE_DUPSTMT LYVE_SYNTAX_YANG, "Duplicate keyword \"%s\"."
Radek Krejcifaa1eac2018-10-30 14:34:55 +0100192#define LY_VCODE_DUPIDENT LYVE_SYNTAX_YANG, "Duplicate identifier \"%s\" of %s statement."
Michal Vasko37d705c2018-09-12 15:31:26 +0200193#define LY_VCODE_INVAL LYVE_SYNTAX_YANG, "Invalid value \"%.*s\" of \"%s\"."
Michal Vasko58257712018-09-12 11:11:38 +0200194#define LY_VCODE_MISSTMT LYVE_SYNTAX_YANG, "Missing mandatory keyword \"%s\" as a child of \"%s\"."
Radek Krejci555cb5b2018-11-16 14:54:33 +0100195#define LY_VCODE_MISSCHILDSTMT LYVE_SYNTAX_YANG, "Missing %s substatement for %s%s."
Michal Vasko58257712018-09-12 11:11:38 +0200196#define LY_VCODE_INORD LYVE_SYNTAX_YANG, "Invalid keyword \"%s\", it cannot appear after \"%s\"."
Michal Vasko37d705c2018-09-12 15:31:26 +0200197#define LY_VCODE_OOB LYVE_SYNTAX_YANG, "Value \"%.*s\" is out of \"%s\" bounds."
Michal Vasko58257712018-09-12 11:11:38 +0200198#define LY_VCODE_INDEV LYVE_SYNTAX_YANG, "Deviate \"%s\" does not support keyword \"%s\"."
Radek Krejci4586a022018-11-13 11:29:26 +0100199#define LY_VCODE_INREGEXP LYVE_SYNTAX_YANG, "Regular expression \"%s\" is not valid (\"%s\": %s)."
David Sedlák0c2bab92019-07-22 15:33:19 +0200200
David Sedlák1538a842019-08-08 15:38:51 +0200201#define LY_VCODE_INSUBELEM2 LYVE_SYNTAX_YIN, "Invalid sub-elemnt \"%s\" of \"%s\" element - this sub-element is allowed only in modules with version 1.1 or newer."
202#define LY_VCODE_INVAL_YIN LYVE_SYNTAX_YIN, "Invalid value \"%s\" of \"%s\" attribute in \"%s\" element."
203#define LY_VCODE_UNEXP_SUBELEM LYVE_SYNTAX_YIN, "Unexpected sub-element \"%.*s\" of \"%s\" element."
David Sedlák4ffcec82019-07-25 15:10:21 +0200204#define LY_VCODE_INDEV_YIN LYVE_SYNTAX_YIN, "Deviate of this type doesn't allow \"%s\" as it's sub-element."
David Sedlák1538a842019-08-08 15:38:51 +0200205#define LY_VCODE_INORDER_YIN LYVE_SYNTAX_YIN, "Invalid order of %s\'s sub-elements \"%s\" can't appear after \"%s\"."
206#define LY_VCODE_OOB_YIN LYVE_SYNTAX_YIN, "Value \"%s\" of \"%s\" attribute in \"%s\" element is out of bounds."
207#define LY_VCODE_INCHILDSTMSCOMB_YIN LYVE_SYNTAX_YIN, "Invalid combination of sub-elemnts \"%s\" and \"%s\" in \"%s\" element."
208#define LY_VCODE_DUP_ATTR LYVE_SYNTAX_YIN, "Duplicit definition of \"%s\" attribute in \"%s\" element."
209#define LY_VCODE_UNEXP_ATTR LYVE_SYNTAX_YIN, "Unexpected attribute \"%.*s\" of \"%s\" element."
210#define LY_VCODE_MAND_SUBELEM LYVE_SYNTAX_YIN, "Missing mandatory sub-element \"%s\" of \"%s\" element."
211#define LY_VCODE_FIRT_SUBELEM LYVE_SYNTAX_YIN, "Sub-element \"%s\" of \"%s\" element must be defined as it's first sub-element."
212#define LY_VCODE_NAME_COL LYVE_SYNTAX_YIN, "Name collision between module and submodule of name \"%s\"."
213#define LY_VCODE_SUBELEM_REDEF LYVE_SYNTAX_YIN, "Redefinition of \"%s\" sub-element in \"%s\" element."
David Sedlák0c2bab92019-07-22 15:33:19 +0200214
Radek Krejcib1646a92018-11-02 16:08:26 +0100215#define LY_VCODE_XP_EOE LYVE_XPATH, "Unterminated string delimited with %c (%.15s)."
Radek Krejci6a9a0c02019-06-21 10:15:22 +0200216#define LY_VCODE_XP_INEXPR LYVE_XPATH, "Invalid character number %u of expression \'%s\'."
Michal Vasko03ff5a72019-09-11 13:49:33 +0200217#define LY_VCODE_XP_DUMMY LYVE_XPATH, "Accessing the value of the dummy node \"%s\"."
218#define LY_VCODE_XP_EOF LYVE_XPATH, "Unexpected XPath expression end."
219#define LY_VCODE_XP_INTOK LYVE_XPATH, "Unexpected XPath token %s (%.15s)."
220#define LY_VCODE_XP_INFUNC LYVE_XPATH, "Unknown XPath function \"%.*s\"."
221#define LY_VCODE_XP_INARGCOUNT LYVE_XPATH, "Invalid number of arguments (%d) for the XPath function %.*s."
222#define LY_VCODE_XP_INARGTYPE LYVE_XPATH, "Wrong type of argument #%d (%s) for the XPath function %s."
223#define LY_VCODE_XP_INCTX LYVE_XPATH, "Invalid context type %s in %s."
224#define LY_VCODE_XP_DUMMY LYVE_XPATH, "Accessing the value of the dummy node \"%s\"."
225#define LY_VCODE_XP_INOP_1 LYVE_XPATH, "Cannot apply XPath operation %s on %s."
226#define LY_VCODE_XP_INOP_2 LYVE_XPATH, "Cannot apply XPath operation %s on %s and %s."
227#define LY_VCODE_XP_INMOD LYVE_XPATH, "Unknown module \"%.*s\"."
David Sedlák0c2bab92019-07-22 15:33:19 +0200228
Radek Krejci327de162019-06-14 12:52:07 +0200229#define LY_VCODE_DEV_NODETYPE LYVE_REFERENCE, "Invalid deviation of %s node - it is not possible to %s \"%s\" property."
230#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 +0200231
Radek Krejcic59bc972018-09-17 16:13:06 +0200232/******************************************************************************
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200233 * Context
234 *****************************************************************************/
235
236/**
237 * @brief Context of the YANG schemas
238 */
239struct ly_ctx {
240 struct dict_table dict; /**< dictionary to effectively store strings used in the context related structures */
241 struct ly_set search_paths; /**< set of directories where to search for schema's imports/includes */
242 struct ly_set list; /**< set of YANG schemas */
Radek Krejcid33273d2018-10-25 14:55:52 +0200243 ly_module_imp_clb imp_clb; /**< Optional callback for retrieving missing included or imported models in a custom way. */
244 void *imp_clb_data; /**< Optional private data for imp_clb() */
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200245 uint16_t module_set_id; /**< ID of the current set of schemas */
246 uint16_t flags; /**< context settings, see @ref contextoptions. */
247 pthread_key_t errlist_key; /**< key for the thread-specific list of errors related to the context */
248};
249
Radek Krejcid33273d2018-10-25 14:55:52 +0200250/**
Radek Krejci474f9b82019-07-24 11:36:37 +0200251 * @defgroup contextflags Context flags
252 * @ingroup context
253 *
254 * Internal context flags.
255 *
256 * Note that the flags 0x00FF are reserved for @ref contextoptions.
257 * @{
258 */
259
260#define LY_CTX_CHANGED_TREE 0x8000 /**< Deviation changed tree of a module(s) in the context, it is necessary to recompile
261 leafref paths, default values and must/when expressions to check that they are still valid */
262
263/**@} contextflags */
264
265/**
Radek Krejcid33273d2018-10-25 14:55:52 +0200266 * @brief Try to find submodule in the context. Submodules are present only in the parsed (lysp_) schema trees, if only
267 * the compiled versions of the schemas are present, the submodule cannot be returned even if it was used to compile
268 * some of the currently present schemas.
269 *
270 * @param[in] ctx Context where to search
Radek Krejcifaa1eac2018-10-30 14:34:55 +0100271 * @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 +0200272 * @param[in] submodule Name of the submodule to find.
273 * @param[in] revision Optional revision of the submodule to find. If not specified, the latest revision is returned.
274 * @return Pointer to the specified submodule if it is present in the context.
275 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100276struct 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 +0200277
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200278/******************************************************************************
Radek Krejcic59bc972018-09-17 16:13:06 +0200279 * Parsers
280 *****************************************************************************/
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200281
Radek Krejcic59bc972018-09-17 16:13:06 +0200282/* list of the YANG statements strings */
283extern const char *const ly_stmt_list[];
284#define ly_stmt2str(STMT) ly_stmt_list[STMT]
285
286/* list of the extensions' substatements strings */
287extern const char *const lyext_substmt_list[];
288#define lyext_substmt2str(STMT) lyext_substmt_list[STMT]
289
290/* list of the deviate modifications strings */
291extern const char *const ly_devmod_list[];
292#define ly_devmod2str(TYPE) ly_devmod_list[TYPE]
293
294/******************************************************************************
Michal Vasko1324b6c2018-09-07 11:16:23 +0200295 * Generic useful functions.
Radek Krejcic59bc972018-09-17 16:13:06 +0200296 *****************************************************************************/
Michal Vasko1324b6c2018-09-07 11:16:23 +0200297
Radek Krejci76b3e962018-12-14 17:01:25 +0100298#define FREE_STRING(CTX, STRING) if (STRING) {lydict_remove(CTX, STRING);}
299
Michal Vasko1324b6c2018-09-07 11:16:23 +0200300/**
301 * @brief Wrapper for realloc() call. The only difference is that if it fails to
302 * allocate the requested memory, the original memory is freed as well.
303 *
304 * @param[in] ptr Memory to reallocate.
305 * @param[in] size New size of the memory block.
306 *
307 * @return Pointer to the new memory, NULL on error.
308 */
309void *ly_realloc(void *ptr, size_t size);
310
Radek Krejcif345c012018-09-19 11:12:59 +0200311/**
Michal Vasko03ff5a72019-09-11 13:49:33 +0200312 * @brief Just like strchr() function except limit the number of examined characters.
313 *
314 * @param[in] s String to search in.
315 * @param[in] c Character to search for.
316 * @param[in] len Limit the search to this number of characters in @p s.
317 * @return Pointer to first @p c occurence in @p s, NULL if not found in first @p len characters.
318 */
319char *ly_strnchr(const char *s, int c, unsigned int len);
320
321/**
Radek Krejci7f9b6512019-09-18 13:11:09 +0200322 * @brief Compare NULL-terminated @p refstr with @str_len bytes from @p str.
323 *
324 * @param[in] refstr NULL-terminated string which must match @str_len bytes from @str followed by NULL-byte.
325 * @param[in] str String to compare
326 * @param[in] str_len Number of bytes to take into comparison from @p str.
327 * @return An integer less than, equal to, or greater than zero if @p refstr matches,
328 * respectively, to be less than, to match, or be greater than @p str.
329 */
330int ly_strncmp(const char *refstr, const char *str, size_t str_len);
331
332/**
Radek Krejcib416be62018-10-01 14:51:45 +0200333 * @brief Get UTF8 code point of the next character in the input string.
334 *
335 * @param[in,out] input Input string to process, updated according to the processed/read data.
336 * @param[out] utf8_char UTF8 code point of the next character.
337 * @param[out] bytes_read Number of bytes used to encode the read utf8_char.
338 * @return LY_ERR value
339 */
340LY_ERR ly_getutf8(const char **input, unsigned int *utf8_char, size_t *bytes_read);
341
342/**
Radek Krejci76c98012019-08-14 11:23:24 +0200343 * @brief Get number of characters in the @p str, taking multibyte characters into account.
344 * @param[in] str String to examine.
345 * @param[in] bytes Number of valid bytes that are supposed to be taken into account in @p str.
346 * This parameter is useful mainly for non NULL-terminated strings. In case of NULL-terminated
347 * string, strlen() can be used.
348 * @return Number of characters in (possibly) multibyte characters string.
349 */
350size_t ly_utf8len(const char *str, size_t bytes);
351
352/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100353 * @brief Parse signed integer with possible limitation.
354 * @param[in] val_str String value containing signed integer, note that
355 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200356 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100357 * @param[in] min Limitation for the value which must not be lower than min.
358 * @param[in] max Limitation for the value which must not be higher than max.
359 * @param[in] base Numeric base for parsing:
360 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
361 * 10 - to accept only decimal (e.g. data instance value)
362 * @param[out] ret Resulting value.
363 * @return LY_ERR value:
364 * LY_EDENIED - the value breaks the limits,
365 * LY_EVALID - string contains invalid value,
366 * LY_SUCCESS - successful parsing.
367 */
Radek Krejci249973a2019-06-10 10:50:54 +0200368LY_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 +0100369
370/**
371 * @brief Parse unsigned integer with possible limitation.
372 * @param[in] val_str String value containing unsigned integer, note that
373 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200374 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100375 * @param[in] max Limitation for the value which must not be higher than max.
376 * @param[in] base Numeric base for parsing:
377 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
378 * 10 - to accept only decimal (e.g. data instance value)
379 * @param[out] ret Resulting value.
380 * @return LY_ERR value:
381 * LY_EDENIED - the value breaks the limits,
382 * LY_EVALID - string contains invalid value,
383 * LY_SUCCESS - successful parsing.
384 */
Radek Krejci249973a2019-06-10 10:50:54 +0200385LY_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 +0100386
387/**
Radek Krejcib4a4a272019-06-10 12:44:52 +0200388 * @brief Parse a node-identifier.
389 *
390 * node-identifier = [prefix ":"] identifier
391 *
392 * @param[in, out] id Identifier to parse. When returned, it points to the first character which is not part of the identifier.
393 * @param[out] prefix Node's prefix, NULL if there is not any.
394 * @param[out] prefix_len Length of the node's prefix, 0 if there is not any.
395 * @param[out] name Node's name.
396 * @param[out] nam_len Length of the node's name.
397 * @return LY_ERR value: LY_SUCCESS or LY_EINVAL in case of invalid character in the id.
398 */
399LY_ERR ly_parse_nodeid(const char **id, const char **prefix, size_t *prefix_len, const char **name, size_t *name_len);
400
401/**
402 * @brief parse instance-identifier's predicate, supports key-predicate, leaf-list-predicate and pos rules from YANG ABNF Grammar.
403 *
404 * @param[in, out] pred Predicate string (including the leading '[') to parse. The string is updated according to what was parsed
405 * (even for error case, so it can be used to determine which substring caused failure).
406 * @param[in] limit Limiting length of the @p pred. Function expects NULL terminated string which is not overread.
407 * 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 +0200408 * @param[in] format Input format of the data containing the @p pred.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200409 * @param[out] prefix Start of the node-identifier's prefix if any, NULL in case of pos or leaf-list-predicate rules.
410 * @param[out] prefix_len Length of the parsed @p prefix.
411 * @param[out] id Start of the node-identifier's identifier string, NULL in case of pos rule, "." in case of leaf-list-predicate rule.
412 * @param[out] id_len Length of the parsed @p id.
Radek Krejci084289f2019-07-09 17:35:30 +0200413 * @param[out] value Start of the quoted-string (without quotation marks), not NULL in case of success.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200414 * @param[out] value_len Length of the parsed @p value.
415 * @param[out] errmsg Error message string in case of error.
416 * @return LY_SUCCESS in case a complete predicate was parsed.
417 * @return LY_EVALID in case of invalid predicate form.
418 * @return LY_EINVAL in case of reaching @p limit when parsing @p pred.
419 */
Radek Krejci084289f2019-07-09 17:35:30 +0200420LY_ERR ly_parse_instance_predicate(const char **pred, size_t limit, LYD_FORMAT format,
Radek Krejcib4a4a272019-06-10 12:44:52 +0200421 const char **prefix, size_t *prefix_len, const char **id, size_t *id_len,
422 const char **value, size_t *value_len, const char **errmsg);
Michal Vasko1324b6c2018-09-07 11:16:23 +0200423
Radek Krejcif345c012018-09-19 11:12:59 +0200424/**
Radek Krejci13a57b62019-07-19 13:04:09 +0200425 * @brief ly_clb_get_prefix implementation for JSON. For its simplicity, this implementation is used
426 * internally for various purposes.
427 *
428 * Implemented in printer_json.c
429 */
430const char *json_print_get_prefix(const struct lys_module *mod, void *private);
431
432/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200433 * @brief mmap(2) wrapper to map input files into memory to unify parsing.
Radek Krejcif345c012018-09-19 11:12:59 +0200434 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200435 * The address space is allocate only for reading.
436 *
437 * @param[in] ctx libyang context for logging
438 * @param[in] fd Open file descriptor of a file to map.
439 * @param[out] length Allocated size.
440 * @param[out] addr Address where the file is mapped.
Radek Krejcif345c012018-09-19 11:12:59 +0200441 * @return LY_ERR value.
442 */
Radek Krejci86d106e2018-10-18 09:53:19 +0200443LY_ERR ly_mmap(struct ly_ctx *ctx, int fd, size_t *length, void **addr);
Michal Vasko841d1a92018-09-07 15:40:31 +0200444
Radek Krejci86d106e2018-10-18 09:53:19 +0200445/**
446 * @brief munmap(2) wrapper to free the memory mapped by ly_mmap()
Michal Vasko1324b6c2018-09-07 11:16:23 +0200447 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200448 * @param[in] addr Address where the input file is mapped.
449 * @param[in] length Allocated size of the address space.
450 * @return LY_ERR value.
451 */
452LY_ERR ly_munmap(void *addr, size_t length);
453
454/**
Radek Krejci4546aa62019-07-15 16:53:32 +0200455 * @brief Concatenate formating string to the @p dest.
456 *
457 * @param[in, out] dest String to be concatenated by @p format.
458 * Note that the input string can be reallocated during concatenation.
459 * @param[in] format Formating string (as for printf) which is supposed to be added after @p dest.
460 * @return LY_SUCCESS or LY_EMEM.
461 */
462LY_ERR ly_strcat(char **dest, const char *format, ...);
463
464/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200465 * @brief (Re-)Allocation of a ([sized array](@ref sizedarrays)).
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200466 *
Radek Krejci2c4e7172018-10-19 15:56:26 +0200467 * Increases the size information.
468 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200469 * @param[in] CTX libyang context for logging.
Radek Krejci2c4e7172018-10-19 15:56:26 +0200470 * @param[in,out] ARRAY Pointer to the array to allocate/resize. The size of the allocated
471 * space is counted from the type of the ARRAY, so do not provide placeholder void pointers.
Radek Krejci86d106e2018-10-18 09:53:19 +0200472 * @param[out] NEW_ITEM Returning pointer to the newly allocated record in the ARRAY.
473 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
Michal Vasko1324b6c2018-09-07 11:16:23 +0200474 */
Radek Krejci2c4e7172018-10-19 15:56:26 +0200475#define LY_ARRAY_NEW_RET(CTX, ARRAY, NEW_ITEM, RETVAL) \
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200476 if (!(ARRAY)) { \
477 ARRAY = malloc(sizeof(uint32_t) + sizeof *(ARRAY)); \
478 *((uint32_t*)(ARRAY)) = 1; \
479 } else { \
Radek Krejci2c4e7172018-10-19 15:56:26 +0200480 ++(*((uint32_t*)(ARRAY) - 1)); \
481 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + (*((uint32_t*)(ARRAY) - 1) * sizeof *(ARRAY))); \
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200482 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
483 } \
Radek Krejci2c4e7172018-10-19 15:56:26 +0200484 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
485 (NEW_ITEM) = &(ARRAY)[*((uint32_t*)(ARRAY) - 1) - 1]; \
486 memset(NEW_ITEM, 0, sizeof *(NEW_ITEM))
Michal Vasko1324b6c2018-09-07 11:16:23 +0200487
Radek Krejci2c4e7172018-10-19 15:56:26 +0200488/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100489 * @brief (Re-)Allocation of a ([sized array](@ref sizedarrays)).
490 *
491 * Increases the size information.
492 *
493 * @param[in] CTX libyang context for logging.
494 * @param[in,out] ARRAY Pointer to the array to allocate/resize. The size of the allocated
495 * space is counted from the type of the ARRAY, so do not provide placeholder void pointers.
496 * @param[out] NEW_ITEM Returning pointer to the newly allocated record in the ARRAY.
497 * @param[out] RET Variable to store error code.
498 * @param[in] GOTO Label to go in case of error (memory allocation failure).
499 */
500#define LY_ARRAY_NEW_GOTO(CTX, ARRAY, NEW_ITEM, RET, GOTO) \
501 if (!(ARRAY)) { \
502 ARRAY = malloc(sizeof(uint32_t) + sizeof *(ARRAY)); \
503 *((uint32_t*)(ARRAY)) = 1; \
504 } else { \
505 ++(*((uint32_t*)(ARRAY) - 1)); \
506 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + (*((uint32_t*)(ARRAY) - 1) * sizeof *(ARRAY))); \
507 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
508 } \
509 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
510 (NEW_ITEM) = &(ARRAY)[*((uint32_t*)(ARRAY) - 1) - 1]; \
511 memset(NEW_ITEM, 0, sizeof *(NEW_ITEM))
512
513/**
Radek Krejci2c4e7172018-10-19 15:56:26 +0200514 * @brief Allocate a ([sized array](@ref sizedarrays)) for the specified number of items.
Radek Krejcid05cbd92018-12-05 14:26:40 +0100515 * If the ARRAY already exists, it is resized (space for SIZE items is added).
Radek Krejci2c4e7172018-10-19 15:56:26 +0200516 *
517 * Does not set the size information, it is supposed to be incremented via ::LY_ARRAY_INCREMENT
518 * when the items are filled.
519 *
520 * @param[in] CTX libyang context for logging.
521 * @param[in,out] ARRAY Pointer to the array to create.
522 * @param[in] SIZE Number of items the array is supposed to hold. The size of the allocated
523 * space is then counted from the type of the ARRAY, so do not provide placeholder void pointers.
524 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
525 */
526#define LY_ARRAY_CREATE_RET(CTX, ARRAY, SIZE, RETVAL) \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100527 if (ARRAY) { \
528 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + ((*((uint32_t*)(ARRAY) - 1) + SIZE) * sizeof *(ARRAY))); \
529 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
530 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
531 memset(&(ARRAY)[*((uint32_t*)(ARRAY) - 1)], 0, SIZE * sizeof *(ARRAY)); \
532 } else { \
533 ARRAY = calloc(1, sizeof(uint32_t) + SIZE * sizeof *(ARRAY)); \
534 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
535 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
536 }
Radek Krejci2c4e7172018-10-19 15:56:26 +0200537
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100538/**
539 * @brief Allocate a ([sized array](@ref sizedarrays)) for the specified number of items.
Radek Krejcid05cbd92018-12-05 14:26:40 +0100540 * If the ARRAY already exists, it is resized (space for SIZE items is added).
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100541 *
542 * Does not set the size information, it is supposed to be incremented via ::LY_ARRAY_INCREMENT
543 * when the items are filled.
544 *
545 * @param[in] CTX libyang context for logging.
546 * @param[in,out] ARRAY Pointer to the array to create.
Radek Krejci00b874b2019-02-12 10:54:50 +0100547 * @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 +0100548 * space is then counted from the type of the ARRAY, so do not provide placeholder void pointers.
549 * @param[out] RET Variable to store error code.
550 * @param[in] GOTO Label to go in case of error (memory allocation failure).
551 */
552#define LY_ARRAY_CREATE_GOTO(CTX, ARRAY, SIZE, RET, GOTO) \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100553 if (ARRAY) { \
Radek Krejci58dca372019-04-12 10:38:06 +0200554 ARRAY = ly_realloc(((uint32_t*)(ARRAY) - 1), sizeof(uint32_t) + ((*((uint32_t*)(ARRAY) - 1) + (SIZE)) * sizeof *(ARRAY))); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100555 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
556 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
Radek Krejci58dca372019-04-12 10:38:06 +0200557 memset(&(ARRAY)[*((uint32_t*)(ARRAY) - 1)], 0, (SIZE) * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100558 } else { \
Radek Krejci58dca372019-04-12 10:38:06 +0200559 ARRAY = calloc(1, sizeof(uint32_t) + (SIZE) * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100560 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
561 ARRAY = (void*)((uint32_t*)(ARRAY) + 1); \
562 }
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100563
Radek Krejci2c4e7172018-10-19 15:56:26 +0200564#define LY_ARRAY_INCREMENT(ARRAY) \
565 ++(*((uint32_t*)(ARRAY) - 1))
Radek Krejciccd20f12019-02-15 14:12:27 +0100566
567#define LY_ARRAY_DECREMENT(ARRAY) \
568 --(*((uint32_t*)(ARRAY) - 1))
569
Radek Krejci2c4e7172018-10-19 15:56:26 +0200570/**
571 * @brief Free the space allocated for the ([sized array](@ref sizedarrays)).
572 *
573 * The items inside the array are not freed.
574 *
575 * @param[in] ARRAY A ([sized array](@ref sizedarrays)) to be freed.
576 */
577#define LY_ARRAY_FREE(ARRAY) \
578 if (ARRAY){free((uint32_t*)(ARRAY) - 1);}
David Sedlák8d552d62019-08-06 15:29:05 +0200579
David Sedlák26ea1432019-08-14 13:42:23 +0200580/**
David Sedlákaa98bba2019-09-12 11:52:14 +0200581 * @brief Insert item into linked list.
David Sedlák26ea1432019-08-14 13:42:23 +0200582 *
583 * @param[in,out] LIST Linked list to add to.
584 * @param[in] NEW_ITEM New item, that will be appended to the list, must be already allocated.
585 * @param[in] LINKER name of structuin member that is used to connect items together.
586 */
David Sedlák8d552d62019-08-06 15:29:05 +0200587#define LY_LIST_INSERT(LIST, NEW_ITEM, LINKER)\
588 if (!(*LIST)) { \
589 *LIST = (__typeof__(*(LIST)))NEW_ITEM; \
590 } else { \
591 do { \
592 __typeof__(*(LIST)) iterator; \
593 for (iterator = *(LIST); iterator->LINKER; iterator = iterator->LINKER); \
594 iterator->LINKER = (__typeof__(*(LIST)))NEW_ITEM; \
595 } while (0); \
596 }
597
David Sedlák26ea1432019-08-14 13:42:23 +0200598/**
David Sedlákaa98bba2019-09-12 11:52:14 +0200599 * @brief Allocate and insert new item into linked list, return in case of error.
David Sedlák26ea1432019-08-14 13:42:23 +0200600 *
David Sedláke6284fc2019-09-10 11:57:02 +0200601 * @param[in] CTX used for logging.
602 * @param[in,out] LIST Linked list to add to.
603 * @param[out] NEW_ITEM New item that is appended to the list.
604 * @param[in] LINKER name of structure member that is used to connect items together.
David Sedlákfbe240f2019-09-13 11:18:53 +0200605 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
David Sedlák26ea1432019-08-14 13:42:23 +0200606 */
David Sedlákb9eeb9c2019-09-13 11:17:19 +0200607#define LY_LIST_NEW_RET(CTX, LIST, NEW_ITEM, LINKER, RETVAL) \
David Sedlák8d552d62019-08-06 15:29:05 +0200608 NEW_ITEM = calloc(1, sizeof *NEW_ITEM); \
David Sedlákb9eeb9c2019-09-13 11:17:19 +0200609 LY_CHECK_ERR_RET(!(NEW_ITEM), LOGMEM(CTX), RETVAL); \
David Sedlák8d552d62019-08-06 15:29:05 +0200610 LY_LIST_INSERT(LIST, NEW_ITEM, LINKER)
611
David Sedláke6284fc2019-09-10 11:57:02 +0200612/**
David Sedlákaa98bba2019-09-12 11:52:14 +0200613 * @brief Allocate and insert new item into linked list, goto specified label in case of error.
David Sedláke6284fc2019-09-10 11:57:02 +0200614 *
615 * @param[in] CTX used for logging.
616 * @param[in,out] LIST Linked list to add to.
617 * @param[out] NEW_ITEM New item that is appended to the list.
618 * @param[in] LINKER name of structure member that is used to connect items together.
619 * @param[in] RET variable to store returned error type.
620 * @param[in] LABEL label to goto in case of error.
621 */
622#define LY_LIST_NEW_GOTO(CTX, LIST, NEW_ITEM, LINKER, RET, LABEL) \
623 NEW_ITEM = calloc(1, sizeof *NEW_ITEM); \
624 LY_CHECK_ERR_GOTO(!(NEW_ITEM), RET = LY_EMEM; LOGMEM(CTX), LABEL); \
625 LY_LIST_INSERT(LIST, NEW_ITEM, LINKER)
626
David Sedláke6cd89e2019-08-07 12:46:02 +0200627#endif /* LY_COMMON_H_ */