blob: 8010c0bb0dc472098a4fa1057acc1f739184817c [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 Krejci6caa6ab2018-10-24 10:04:48 +020018#include <pthread.h>
Radek Krejcie7b95092019-05-15 11:03:07 +020019#include <stddef.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020020#include <stdint.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020021
Radek Krejci2c22f122018-09-05 15:08:03 +020022#include "config.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020023
Radek Krejcid33273d2018-10-25 14:55:52 +020024#include "context.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020025#include "dict.h"
Radek Krejci6caa6ab2018-10-24 10:04:48 +020026#include "hash_table.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020027#include "log.h"
28#include "set.h"
Radek Krejcic4fa0292020-05-14 10:54:49 +020029#include "tree.h"
Radek Krejci535ea9f2020-05-29 16:01:05 +020030#include "tree_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020031
32struct ly_ctx;
Radek Krejci535ea9f2020-05-29 16:01:05 +020033struct lys_module;
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
Michal Vaskodc779a82019-11-06 15:44:06 +010049#define GETMACRO5(_1, _2, _3, _4, _5, NAME, ...) NAME
Radek Krejci5aeea3a2018-09-05 13:29:36 +020050
51/*
Radek Krejcic59bc972018-09-17 16:13:06 +020052 * If the compiler supports attribute to mark objects as hidden, mark all
53 * objects as hidden and export only objects explicitly marked to be part of
54 * the public API.
Radek Krejci5aeea3a2018-09-05 13:29:36 +020055 */
Radek Krejcic59bc972018-09-17 16:13:06 +020056#define API __attribute__((visibility("default")))
57
Radek Krejcicad716e2018-11-26 15:18:27 +010058
Radek Krejcic59bc972018-09-17 16:13:06 +020059/******************************************************************************
60 * Logger
61 *****************************************************************************/
Radek Krejci5aeea3a2018-09-05 13:29:36 +020062
Radek Krejci94aa9942018-09-07 17:12:17 +020063enum LY_VLOG_ELEM {
64 LY_VLOG_NONE = 0,
Michal Vaskof6e51882019-12-16 09:59:45 +010065 LY_VLOG_LINE, /* line number (uint64_t*) */
66 LY_VLOG_LYSC, /* struct lysc_node* */
67 LY_VLOG_LYD, /* struct lyd_node* */
68 LY_VLOG_STR, /* const char* */
69 LY_VLOG_PREV /* use exact same previous path */
Radek Krejci94aa9942018-09-07 17:12:17 +020070};
71
Radek Krejci5aeea3a2018-09-05 13:29:36 +020072extern THREAD_LOCAL enum int_log_opts log_opt;
73extern volatile uint8_t ly_log_level;
74extern volatile uint8_t ly_log_opts;
75
Radek Krejcie7b95092019-05-15 11:03:07 +020076/**
77 * @brief Set error-app-tag to the last error record in the context.
78 * @param[in] ctx libyang context where the error records are present.
79 * @param[in] apptag The error-app-tag value to store.
80 */
81void ly_err_last_set_apptag(const struct ly_ctx *ctx, const char *apptag);
82
83/**
84 * @brief Print a log message and store it into the context (if provided).
85 *
86 * @param[in] ctx libyang context to store the error record. If not provided, the error is just printed.
87 * @param[in] level Log message level (error, warning, etc.)
88 * @param[in] no Error type code.
89 * @param[in] format Format string to print.
90 */
Radek Krejci5aeea3a2018-09-05 13:29:36 +020091void ly_log(const struct ly_ctx *ctx, LY_LOG_LEVEL level, LY_ERR no, const char *format, ...);
Radek Krejcie7b95092019-05-15 11:03:07 +020092
93/**
94 * @brief Print Validation error and store it into the context (if provided).
95 *
96 * @param[in] ctx libyang context to store the error record. If not provided, the error is just printed.
97 * @param[in] elem_type Type of the data in @p elem variable.
98 * @param[in] elem Object to provide more information about the place where the error appeared.
99 * @param[in] code Validation error code.
100 * @param[in] format Format string to print.
101 */
Radek Krejci94aa9942018-09-07 17:12:17 +0200102void 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 +0200103
104#define LOGERR(ctx, errno, str, args...) ly_log(ctx, LY_LLERR, errno, str, ##args)
Radek Krejcif3f47842018-11-15 11:22:15 +0100105#define LOGWRN(ctx, str, ...) ly_log(ctx, LY_LLWRN, 0, str, ##__VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200106#define LOGVRB(str, args...) ly_log(NULL, LY_LLVRB, 0, str, ##args)
107
Radek Krejci4ab61562018-09-05 15:00:37 +0200108#ifdef NDEBUG
109# define LOGDBG(dbg_group, str, args...)
110#else
111 void ly_log_dbg(int group, const char *format, ...);
112# define LOGDBG(dbg_group, str, args...) ly_log_dbg(dbg_group, str, ##args);
113#endif
114
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200115#define LOGMEM(CTX) LOGERR(CTX, LY_EMEM, "Memory allocation failed (%s()).", __func__)
116#define LOGINT(CTX) LOGERR(CTX, LY_EINT, "Internal error (%s:%d).", __FILE__, __LINE__)
117#define LOGARG(CTX, ARG) LOGERR(CTX, LY_EINVAL, "Invalid argument %s (%s()).", #ARG, __func__)
Radek Krejcic07921a2018-09-17 11:40:15 +0200118#define LOGVAL(CTX, ELEM_TYPE, ELEM, CODE, FORMAT...) ly_vlog(CTX, ELEM_TYPE, ELEM, CODE, ##FORMAT)
Radek Krejci94aa9942018-09-07 17:12:17 +0200119
120#define LOGMEM_RET(CTX) LOGMEM(CTX); return LY_EMEM
121#define LOGINT_RET(CTX) LOGINT(CTX); return LY_EINT
122#define LOGARG_RET(CTX) LOGARG(CTX); return LY_EINVAL
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200123
124/*
125 * Common code to check return value and perform appropriate action.
126 */
Radek Krejcie88beef2019-05-30 15:47:19 +0200127#define LY_CHECK_GOTO(COND, GOTO) if ((COND)) {goto GOTO;}
128#define LY_CHECK_ERR_GOTO(COND, ERR, GOTO) if ((COND)) {ERR; goto GOTO;}
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100129#define LY_CHECK_RET1(RETVAL) {LY_ERR ret__ = RETVAL;if (ret__ != LY_SUCCESS) {return ret__;}}
Radek Krejcie88beef2019-05-30 15:47:19 +0200130#define LY_CHECK_RET2(COND, RETVAL) if ((COND)) {return RETVAL;}
Radek Krejcic59bc972018-09-17 16:13:06 +0200131#define LY_CHECK_RET(...) GETMACRO2(__VA_ARGS__, LY_CHECK_RET2, LY_CHECK_RET1)(__VA_ARGS__)
Radek Krejcie88beef2019-05-30 15:47:19 +0200132#define LY_CHECK_ERR_RET(COND, ERR, RETVAL) if ((COND)) {ERR; return RETVAL;}
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200133
Radek Krejcia3045382018-11-22 14:30:31 +0100134#define LY_CHECK_ARG_GOTO1(CTX, ARG, GOTO) if (!(ARG)) {LOGARG(CTX, ARG);goto GOTO;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200135#define LY_CHECK_ARG_GOTO2(CTX, ARG1, ARG2, GOTO) LY_CHECK_ARG_GOTO1(CTX, ARG1, GOTO);LY_CHECK_ARG_GOTO1(CTX, ARG2, GOTO)
136#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)
Michal Vaskodc779a82019-11-06 15:44:06 +0100137#define LY_CHECK_ARG_GOTO4(CTX, ARG1, ARG2, ARG3, ARG4, GOTO) LY_CHECK_ARG_GOTO3(CTX, ARG1, ARG2, ARG3, GOTO);\
138 LY_CHECK_ARG_GOTO1(CTX, ARG4, GOTO)
139#define LY_CHECK_ARG_GOTO(CTX, ...) GETMACRO5(__VA_ARGS__, LY_CHECK_ARG_GOTO4, LY_CHECK_ARG_GOTO3, LY_CHECK_ARG_GOTO2, \
140 LY_CHECK_ARG_GOTO1)(CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200141
Radek Krejcia3045382018-11-22 14:30:31 +0100142#define LY_CHECK_ARG_RET1(CTX, ARG, RETVAL) if (!(ARG)) {LOGARG(CTX, ARG);return RETVAL;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200143#define LY_CHECK_ARG_RET2(CTX, ARG1, ARG2, RETVAL) LY_CHECK_ARG_RET1(CTX, ARG1, RETVAL);LY_CHECK_ARG_RET1(CTX, ARG2, RETVAL)
144#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)
Michal Vaskodc779a82019-11-06 15:44:06 +0100145#define LY_CHECK_ARG_RET4(CTX, ARG1, ARG2, ARG3, ARG4, RETVAL) LY_CHECK_ARG_RET3(CTX, ARG1, ARG2, ARG3, RETVAL);\
146 LY_CHECK_ARG_RET1(CTX, ARG4, RETVAL)
147#define LY_CHECK_ARG_RET(CTX, ...) GETMACRO5(__VA_ARGS__, LY_CHECK_ARG_RET4, LY_CHECK_ARG_RET3, LY_CHECK_ARG_RET2, LY_CHECK_ARG_RET1)\
148 (CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200149
Radek Krejcid972c252018-09-25 13:23:39 +0200150/* count sequence size for LY_VCODE_INCHILDSTMT validation error code */
151size_t LY_VCODE_INSTREXP_len(const char *str);
152/* default maximum characters to print in LY_VCODE_INCHILDSTMT */
153#define LY_VCODE_INSTREXP_MAXLEN 20
154
Michal Vaskoecd62de2019-11-13 12:35:11 +0100155#define LY_VCODE_INCHAR LYVE_SYNTAX, "Invalid character 0x%x."
156#define LY_VCODE_INSTREXP LYVE_SYNTAX, "Invalid character sequence \"%.*s\", expected %s."
157#define LY_VCODE_EOF LYVE_SYNTAX, "Unexpected end-of-input."
158#define LY_VCODE_NTERM LYVE_SYNTAX, "%s not terminated."
159#define LY_VCODE_NSUPP LYVE_SYNTAX, "%s not supported."
160#define LY_VCODE_MOD_SUBOMD LYVE_SYNTAX, "Invalid keyword \"%s\", expected \"module\" or \"submodule\"."
161#define LY_VCODE_TRAILING_MOD LYVE_SYNTAX, "Trailing garbage \"%.*s%s\" after module, expected end-of-input."
David Sedlák1538a842019-08-08 15:38:51 +0200162#define LY_VCODE_TRAILING_SUBMOD LYVE_SYNTAX, "Trailing garbage \"%.*s%s\" after submodule, expected end-of-input."
163
Michal Vaskoecd62de2019-11-13 12:35:11 +0100164#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."
165#define LY_VCODE_CIRC_WHEN LYVE_SEMANTICS, "When condition of \"%s\" includes a self-reference (referenced by when of \"%s\")."
Michal Vasko5c4e5892019-11-14 12:31:38 +0100166#define LY_VCODE_DUMMY_WHEN LYVE_SEMANTICS, "When condition of \"%s\" is accessing its own conditional node."
David Sedlák0c2bab92019-07-22 15:33:19 +0200167
Michal Vaskoecd62de2019-11-13 12:35:11 +0100168#define LY_VCODE_INSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\"."
169#define LY_VCODE_INCHILDSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\" as a child of \"%s\"."
170#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 +0100171#define LY_VCODE_INCHILDSTMSCOMB LYVE_SYNTAX_YANG, "Invalid combination of keywords \"%s\" and \"%s\" as substatements of \"%s\"."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100172#define LY_VCODE_DUPSTMT LYVE_SYNTAX_YANG, "Duplicate keyword \"%s\"."
173#define LY_VCODE_DUPIDENT LYVE_SYNTAX_YANG, "Duplicate identifier \"%s\" of %s statement."
174#define LY_VCODE_INVAL LYVE_SYNTAX_YANG, "Invalid value \"%.*s\" of \"%s\"."
175#define LY_VCODE_MISSTMT LYVE_SYNTAX_YANG, "Missing mandatory keyword \"%s\" as a child of \"%s\"."
176#define LY_VCODE_MISSCHILDSTMT LYVE_SYNTAX_YANG, "Missing %s substatement for %s%s."
177#define LY_VCODE_INORD LYVE_SYNTAX_YANG, "Invalid keyword \"%s\", it cannot appear after \"%s\"."
178#define LY_VCODE_OOB LYVE_SYNTAX_YANG, "Value \"%.*s\" is out of \"%s\" bounds."
179#define LY_VCODE_INDEV LYVE_SYNTAX_YANG, "Deviate \"%s\" does not support keyword \"%s\"."
180#define LY_VCODE_INREGEXP LYVE_SYNTAX_YANG, "Regular expression \"%s\" is not valid (\"%s\": %s)."
David Sedlák0c2bab92019-07-22 15:33:19 +0200181
Michal Vaskoecd62de2019-11-13 12:35:11 +0100182#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."
183#define LY_VCODE_INVAL_YIN LYVE_SYNTAX_YIN, "Invalid value \"%s\" of \"%s\" attribute in \"%s\" element."
184#define LY_VCODE_UNEXP_SUBELEM LYVE_SYNTAX_YIN, "Unexpected sub-element \"%.*s\" of \"%s\" element."
185#define LY_VCODE_INDEV_YIN LYVE_SYNTAX_YIN, "Deviate of this type doesn't allow \"%s\" as it's sub-element."
186#define LY_VCODE_INORDER_YIN LYVE_SYNTAX_YIN, "Invalid order of %s\'s sub-elements \"%s\" can't appear after \"%s\"."
187#define LY_VCODE_OOB_YIN LYVE_SYNTAX_YIN, "Value \"%s\" of \"%s\" attribute in \"%s\" element is out of bounds."
David Sedlák1538a842019-08-08 15:38:51 +0200188#define LY_VCODE_INCHILDSTMSCOMB_YIN LYVE_SYNTAX_YIN, "Invalid combination of sub-elemnts \"%s\" and \"%s\" in \"%s\" element."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100189#define LY_VCODE_DUP_ATTR LYVE_SYNTAX_YIN, "Duplicit definition of \"%s\" attribute in \"%s\" element."
190#define LY_VCODE_UNEXP_ATTR LYVE_SYNTAX_YIN, "Unexpected attribute \"%.*s\" of \"%s\" element."
191#define LY_VCODE_MAND_SUBELEM LYVE_SYNTAX_YIN, "Missing mandatory sub-element \"%s\" of \"%s\" element."
192#define LY_VCODE_FIRT_SUBELEM LYVE_SYNTAX_YIN, "Sub-element \"%s\" of \"%s\" element must be defined as it's first sub-element."
193#define LY_VCODE_NAME_COL LYVE_SYNTAX_YIN, "Name collision between module and submodule of name \"%s\"."
194#define LY_VCODE_SUBELEM_REDEF LYVE_SYNTAX_YIN, "Redefinition of \"%s\" sub-element in \"%s\" element."
David Sedlák0c2bab92019-07-22 15:33:19 +0200195
Michal Vaskoecd62de2019-11-13 12:35:11 +0100196#define LY_VCODE_XP_EOE LYVE_XPATH, "Unterminated string delimited with %c (%.15s)."
197#define LY_VCODE_XP_INEXPR LYVE_XPATH, "Invalid character number %u of expression \'%s\'."
198#define LY_VCODE_XP_EOF LYVE_XPATH, "Unexpected XPath expression end."
199#define LY_VCODE_XP_INTOK LYVE_XPATH, "Unexpected XPath token %s (%.15s)."
200#define LY_VCODE_XP_INFUNC LYVE_XPATH, "Unknown XPath function \"%.*s\"."
201#define LY_VCODE_XP_INARGCOUNT LYVE_XPATH, "Invalid number of arguments (%d) for the XPath function %.*s."
202#define LY_VCODE_XP_INARGTYPE LYVE_XPATH, "Wrong type of argument #%d (%s) for the XPath function %s."
203#define LY_VCODE_XP_INCTX LYVE_XPATH, "Invalid context type %s in %s."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100204#define LY_VCODE_XP_INOP_1 LYVE_XPATH, "Cannot apply XPath operation %s on %s."
205#define LY_VCODE_XP_INOP_2 LYVE_XPATH, "Cannot apply XPath operation %s on %s and %s."
Michal Vasko004d3152020-06-11 19:59:22 +0200206#define LY_VCODE_XP_INMOD LYVE_XPATH, "Unknown/non-implemented module \"%.*s\"."
David Sedlák0c2bab92019-07-22 15:33:19 +0200207
Michal Vaskoecd62de2019-11-13 12:35:11 +0100208#define LY_VCODE_DEV_NODETYPE LYVE_REFERENCE, "Invalid deviation of %s node - it is not possible to %s \"%s\" property."
Radek Krejci327de162019-06-14 12:52:07 +0200209#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 +0200210
Michal Vaskoecd62de2019-11-13 12:35:11 +0100211#define LY_VCODE_NOWHEN LYVE_DATA, "When condition \"%s\" not satisfied."
Michal Vaskocc048b22020-03-27 15:52:38 +0100212#define LY_VCODE_NOMUST LYVE_DATA, "Must condition \"%s\" not satisfied."
Michal Vaskoa3881362020-01-21 15:57:35 +0100213#define LY_VCODE_NOMAND LYVE_DATA, "Mandatory node \"%s\" instance does not exist."
Michal Vaskoacd83e72020-02-04 14:12:01 +0100214#define LY_VCODE_NOMIN LYVE_DATA, "Too few \"%s\" instances."
215#define LY_VCODE_NOMAX LYVE_DATA, "Too many \"%s\" instances."
Michal Vasko14654712020-02-06 08:35:21 +0100216#define LY_VCODE_NOUNIQ LYVE_DATA, "Unique data leaf(s) \"%s\" not satisfied in \"%s\" and \"%s\"."
Michal Vaskof03ed032020-03-04 13:31:44 +0100217#define LY_VCODE_DUP LYVE_DATA, "Duplicate instance of \"%s\"."
218#define LY_VCODE_DUPCASE LYVE_DATA, "Data for both cases \"%s\" and \"%s\" exist."
Michal Vaskoc193ce92020-03-06 11:04:48 +0100219#define LY_VCODE_NOIFF LYVE_DATA, "Data are disabled by \"%s\" schema node if-feature."
Michal Vaskocb7526d2020-03-30 15:08:26 +0200220#define LY_VCODE_INNODE LYVE_DATA, "Invalid %s data node \"%s\" found."
Michal Vasko9f96a052020-03-10 09:41:45 +0100221#define LY_VCODE_NOKEY LYVE_DATA, "List instance is missing its key \"%s\"."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100222
Radek Krejcic59bc972018-09-17 16:13:06 +0200223/******************************************************************************
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200224 * Context
225 *****************************************************************************/
226
227/**
228 * @brief Context of the YANG schemas
229 */
230struct ly_ctx {
231 struct dict_table dict; /**< dictionary to effectively store strings used in the context related structures */
232 struct ly_set search_paths; /**< set of directories where to search for schema's imports/includes */
233 struct ly_set list; /**< set of YANG schemas */
Radek Krejcid33273d2018-10-25 14:55:52 +0200234 ly_module_imp_clb imp_clb; /**< Optional callback for retrieving missing included or imported models in a custom way. */
235 void *imp_clb_data; /**< Optional private data for imp_clb() */
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200236 uint16_t module_set_id; /**< ID of the current set of schemas */
237 uint16_t flags; /**< context settings, see @ref contextoptions. */
238 pthread_key_t errlist_key; /**< key for the thread-specific list of errors related to the context */
239};
240
Radek Krejcid33273d2018-10-25 14:55:52 +0200241/**
Radek Krejci474f9b82019-07-24 11:36:37 +0200242 * @defgroup contextflags Context flags
243 * @ingroup context
244 *
245 * Internal context flags.
246 *
247 * Note that the flags 0x00FF are reserved for @ref contextoptions.
248 * @{
249 */
250
251#define LY_CTX_CHANGED_TREE 0x8000 /**< Deviation changed tree of a module(s) in the context, it is necessary to recompile
252 leafref paths, default values and must/when expressions to check that they are still valid */
253
Michal Vasko5aa44c02020-06-29 11:47:02 +0200254/** @} contextflags */
Radek Krejci474f9b82019-07-24 11:36:37 +0200255
256/**
Radek Krejcid33273d2018-10-25 14:55:52 +0200257 * @brief Try to find submodule in the context. Submodules are present only in the parsed (lysp_) schema trees, if only
258 * the compiled versions of the schemas are present, the submodule cannot be returned even if it was used to compile
259 * some of the currently present schemas.
260 *
261 * @param[in] ctx Context where to search
Radek Krejcifaa1eac2018-10-30 14:34:55 +0100262 * @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 +0200263 * @param[in] submodule Name of the submodule to find.
264 * @param[in] revision Optional revision of the submodule to find. If not specified, the latest revision is returned.
265 * @return Pointer to the specified submodule if it is present in the context.
266 */
Radek Krejci0bcdaed2019-01-10 10:21:34 +0100267struct 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 +0200268
Radek Krejci0ad51f12020-07-16 12:08:12 +0200269/**
270 * @brief Get the (only) implemented YANG module specified by its name.
271 *
272 * @param[in] ctx Context where to search.
273 * @param[in] name Name of the YANG module to get.
274 * @param[in] name_len Optional length of the @p name. If zero, NULL-terminated name is expected.
275 * @return The only implemented YANG module revision of the given name in the given context. NULL if there is no
276 * implemented module of the given name.
277 */
278struct lys_module *ly_ctx_get_module_implemented2(const struct ly_ctx *ctx, const char *name, size_t name_len);
279
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200280/******************************************************************************
Radek Krejcic59bc972018-09-17 16:13:06 +0200281 * Parsers
282 *****************************************************************************/
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200283
Radek Krejcic59bc972018-09-17 16:13:06 +0200284/* list of the YANG statements strings */
285extern const char *const ly_stmt_list[];
286#define ly_stmt2str(STMT) ly_stmt_list[STMT]
287
288/* list of the extensions' substatements strings */
289extern const char *const lyext_substmt_list[];
290#define lyext_substmt2str(STMT) lyext_substmt_list[STMT]
291
292/* list of the deviate modifications strings */
293extern const char *const ly_devmod_list[];
294#define ly_devmod2str(TYPE) ly_devmod_list[TYPE]
295
296/******************************************************************************
Michal Vasko1324b6c2018-09-07 11:16:23 +0200297 * Generic useful functions.
Radek Krejcic59bc972018-09-17 16:13:06 +0200298 *****************************************************************************/
Michal Vasko1324b6c2018-09-07 11:16:23 +0200299
Michal Vaskob36053d2020-03-26 15:49:30 +0100300/**
301 * @brief Insert string into dictionary.
302 *
303 * @param[in] CTX libyang context.
304 * @param[in] STRING string to store.
305 * @param[in] LEN length of the string in WORD to store.
306 * @param[in,out] DYNAMIC Set to 1 if STR is dynamically allocated, 0 otherwise. If set to 1, zerocopy version of lydict_insert is used.
307 */
308#define INSERT_STRING(CTX, STRING, LEN, DYNAMIC) \
309 (DYNAMIC ? lydict_insert_zc(CTX, (char *)(STRING)) : lydict_insert(CTX, LEN ? (STRING) : "", LEN)); DYNAMIC = 0
310
Radek Krejci76b3e962018-12-14 17:01:25 +0100311#define FREE_STRING(CTX, STRING) if (STRING) {lydict_remove(CTX, STRING);}
312
Michal Vasko1324b6c2018-09-07 11:16:23 +0200313/**
314 * @brief Wrapper for realloc() call. The only difference is that if it fails to
315 * allocate the requested memory, the original memory is freed as well.
316 *
317 * @param[in] ptr Memory to reallocate.
318 * @param[in] size New size of the memory block.
319 *
320 * @return Pointer to the new memory, NULL on error.
321 */
322void *ly_realloc(void *ptr, size_t size);
323
Radek Krejcif345c012018-09-19 11:12:59 +0200324/**
Michal Vasko03ff5a72019-09-11 13:49:33 +0200325 * @brief Just like strchr() function except limit the number of examined characters.
326 *
327 * @param[in] s String to search in.
328 * @param[in] c Character to search for.
329 * @param[in] len Limit the search to this number of characters in @p s.
330 * @return Pointer to first @p c occurence in @p s, NULL if not found in first @p len characters.
331 */
332char *ly_strnchr(const char *s, int c, unsigned int len);
333
334/**
Radek Krejci7f9b6512019-09-18 13:11:09 +0200335 * @brief Compare NULL-terminated @p refstr with @str_len bytes from @p str.
336 *
337 * @param[in] refstr NULL-terminated string which must match @str_len bytes from @str followed by NULL-byte.
338 * @param[in] str String to compare
339 * @param[in] str_len Number of bytes to take into comparison from @p str.
340 * @return An integer less than, equal to, or greater than zero if @p refstr matches,
341 * respectively, to be less than, to match, or be greater than @p str.
342 */
343int ly_strncmp(const char *refstr, const char *str, size_t str_len);
344
345/**
Radek Krejcib416be62018-10-01 14:51:45 +0200346 * @brief Get UTF8 code point of the next character in the input string.
347 *
348 * @param[in,out] input Input string to process, updated according to the processed/read data.
349 * @param[out] utf8_char UTF8 code point of the next character.
350 * @param[out] bytes_read Number of bytes used to encode the read utf8_char.
351 * @return LY_ERR value
352 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100353LY_ERR ly_getutf8(const char **input, uint32_t *utf8_char, size_t *bytes_read);
Radek Krejcib416be62018-10-01 14:51:45 +0200354
355/**
Radek Krejci50f0c6b2020-06-18 16:31:48 +0200356 * Store UTF-8 character specified as 4byte integer into the dst buffer.
357 *
358 * UTF-8 mapping:
359 * 00000000 -- 0000007F: 0xxxxxxx
360 * 00000080 -- 000007FF: 110xxxxx 10xxxxxx
361 * 00000800 -- 0000FFFF: 1110xxxx 10xxxxxx 10xxxxxx
362 * 00010000 -- 001FFFFF: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
363 *
364 * Includes checking for valid characters (following RFC 7950, sec 9.4)
365 *
366 * @param[in, out] dst Destination buffer to store the UTF-8 character, must provide enough space (up to 4 bytes) for storing the UTF-8 character.
367 * @param[in] value 32b value of the UTF-8 character to store.
368 * @param[out] bytes_written Number of bytes written into @p dst (size of the written UTF-8 character).
369 * @return LY_SUCCESS on success
370 * @return LY_EINVAL in case of invalid UTF-8 @p value to store.
371 */
372LY_ERR ly_pututf8(char *dst, uint32_t value, size_t *bytes_written);
373
374/**
Radek Krejci76c98012019-08-14 11:23:24 +0200375 * @brief Get number of characters in the @p str, taking multibyte characters into account.
376 * @param[in] str String to examine.
377 * @param[in] bytes Number of valid bytes that are supposed to be taken into account in @p str.
378 * This parameter is useful mainly for non NULL-terminated strings. In case of NULL-terminated
379 * string, strlen() can be used.
380 * @return Number of characters in (possibly) multibyte characters string.
381 */
382size_t ly_utf8len(const char *str, size_t bytes);
383
384/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100385 * @brief Parse signed integer with possible limitation.
386 * @param[in] val_str String value containing signed integer, note that
387 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200388 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100389 * @param[in] min Limitation for the value which must not be lower than min.
390 * @param[in] max Limitation for the value which must not be higher than max.
391 * @param[in] base Numeric base for parsing:
392 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
393 * 10 - to accept only decimal (e.g. data instance value)
394 * @param[out] ret Resulting value.
395 * @return LY_ERR value:
396 * LY_EDENIED - the value breaks the limits,
397 * LY_EVALID - string contains invalid value,
398 * LY_SUCCESS - successful parsing.
399 */
Radek Krejci249973a2019-06-10 10:50:54 +0200400LY_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 +0100401
402/**
403 * @brief Parse unsigned integer with possible limitation.
404 * @param[in] val_str String value containing unsigned integer, note that
405 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200406 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100407 * @param[in] max Limitation for the value which must not be higher than max.
408 * @param[in] base Numeric base for parsing:
409 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
410 * 10 - to accept only decimal (e.g. data instance value)
411 * @param[out] ret Resulting value.
412 * @return LY_ERR value:
413 * LY_EDENIED - the value breaks the limits,
414 * LY_EVALID - string contains invalid value,
415 * LY_SUCCESS - successful parsing.
416 */
Radek Krejci249973a2019-06-10 10:50:54 +0200417LY_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 +0100418
419/**
Radek Krejcib4a4a272019-06-10 12:44:52 +0200420 * @brief Parse a node-identifier.
421 *
422 * node-identifier = [prefix ":"] identifier
423 *
424 * @param[in, out] id Identifier to parse. When returned, it points to the first character which is not part of the identifier.
425 * @param[out] prefix Node's prefix, NULL if there is not any.
426 * @param[out] prefix_len Length of the node's prefix, 0 if there is not any.
427 * @param[out] name Node's name.
428 * @param[out] nam_len Length of the node's name.
429 * @return LY_ERR value: LY_SUCCESS or LY_EINVAL in case of invalid character in the id.
430 */
431LY_ERR ly_parse_nodeid(const char **id, const char **prefix, size_t *prefix_len, const char **name, size_t *name_len);
432
433/**
434 * @brief parse instance-identifier's predicate, supports key-predicate, leaf-list-predicate and pos rules from YANG ABNF Grammar.
435 *
436 * @param[in, out] pred Predicate string (including the leading '[') to parse. The string is updated according to what was parsed
437 * (even for error case, so it can be used to determine which substring caused failure).
438 * @param[in] limit Limiting length of the @p pred. Function expects NULL terminated string which is not overread.
439 * 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 +0200440 * @param[in] format Input format of the data containing the @p pred.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200441 * @param[out] prefix Start of the node-identifier's prefix if any, NULL in case of pos or leaf-list-predicate rules.
442 * @param[out] prefix_len Length of the parsed @p prefix.
443 * @param[out] id Start of the node-identifier's identifier string, NULL in case of pos rule, "." in case of leaf-list-predicate rule.
444 * @param[out] id_len Length of the parsed @p id.
Radek Krejci084289f2019-07-09 17:35:30 +0200445 * @param[out] value Start of the quoted-string (without quotation marks), not NULL in case of success.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200446 * @param[out] value_len Length of the parsed @p value.
447 * @param[out] errmsg Error message string in case of error.
448 * @return LY_SUCCESS in case a complete predicate was parsed.
449 * @return LY_EVALID in case of invalid predicate form.
450 * @return LY_EINVAL in case of reaching @p limit when parsing @p pred.
451 */
Radek Krejci084289f2019-07-09 17:35:30 +0200452LY_ERR ly_parse_instance_predicate(const char **pred, size_t limit, LYD_FORMAT format,
Radek Krejcib4a4a272019-06-10 12:44:52 +0200453 const char **prefix, size_t *prefix_len, const char **id, size_t *id_len,
454 const char **value, size_t *value_len, const char **errmsg);
Michal Vasko1324b6c2018-09-07 11:16:23 +0200455
Radek Krejcif345c012018-09-19 11:12:59 +0200456/**
Radek Krejci13a57b62019-07-19 13:04:09 +0200457 * @brief ly_clb_get_prefix implementation for JSON. For its simplicity, this implementation is used
458 * internally for various purposes.
459 *
460 * Implemented in printer_json.c
461 */
462const char *json_print_get_prefix(const struct lys_module *mod, void *private);
463
464/**
Michal Vasko90932a92020-02-12 14:33:03 +0100465 * @brief ly_type_resolve_prefix implementation for JSON. For its simplicity, this implementation is used
466 * internally for various purposes.
467 *
468 * Implemented in parser_json.c
469 */
Michal Vasko52927e22020-03-16 17:26:14 +0100470const struct lys_module *lydjson_resolve_prefix(const struct ly_ctx *ctx, const char *prefix, size_t prefix_len, void *parser);
Michal Vasko90932a92020-02-12 14:33:03 +0100471
472/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200473 * @brief mmap(2) wrapper to map input files into memory to unify parsing.
Radek Krejcif345c012018-09-19 11:12:59 +0200474 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200475 * The address space is allocate only for reading.
476 *
477 * @param[in] ctx libyang context for logging
478 * @param[in] fd Open file descriptor of a file to map.
479 * @param[out] length Allocated size.
480 * @param[out] addr Address where the file is mapped.
Radek Krejcif345c012018-09-19 11:12:59 +0200481 * @return LY_ERR value.
482 */
Radek Krejci86d106e2018-10-18 09:53:19 +0200483LY_ERR ly_mmap(struct ly_ctx *ctx, int fd, size_t *length, void **addr);
Michal Vasko841d1a92018-09-07 15:40:31 +0200484
Radek Krejci86d106e2018-10-18 09:53:19 +0200485/**
486 * @brief munmap(2) wrapper to free the memory mapped by ly_mmap()
Michal Vasko1324b6c2018-09-07 11:16:23 +0200487 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200488 * @param[in] addr Address where the input file is mapped.
489 * @param[in] length Allocated size of the address space.
490 * @return LY_ERR value.
491 */
492LY_ERR ly_munmap(void *addr, size_t length);
493
494/**
Radek Krejci4546aa62019-07-15 16:53:32 +0200495 * @brief Concatenate formating string to the @p dest.
496 *
497 * @param[in, out] dest String to be concatenated by @p format.
498 * Note that the input string can be reallocated during concatenation.
499 * @param[in] format Formating string (as for printf) which is supposed to be added after @p dest.
500 * @return LY_SUCCESS or LY_EMEM.
501 */
502LY_ERR ly_strcat(char **dest, const char *format, ...);
503
504/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200505 * @brief (Re-)Allocation of a ([sized array](@ref sizedarrays)).
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200506 *
Radek Krejci2c4e7172018-10-19 15:56:26 +0200507 * Increases the size information.
508 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200509 * @param[in] CTX libyang context for logging.
Radek Krejci2c4e7172018-10-19 15:56:26 +0200510 * @param[in,out] ARRAY Pointer to the array to allocate/resize. The size of the allocated
511 * space is counted from the type of the ARRAY, so do not provide placeholder void pointers.
Radek Krejci86d106e2018-10-18 09:53:19 +0200512 * @param[out] NEW_ITEM Returning pointer to the newly allocated record in the ARRAY.
513 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
Michal Vasko1324b6c2018-09-07 11:16:23 +0200514 */
Radek Krejci2c4e7172018-10-19 15:56:26 +0200515#define LY_ARRAY_NEW_RET(CTX, ARRAY, NEW_ITEM, RETVAL) \
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200516 if (!(ARRAY)) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200517 ARRAY = malloc(sizeof(LY_ARRAY_COUNT_TYPE) + sizeof *(ARRAY)); \
518 *((LY_ARRAY_COUNT_TYPE*)(ARRAY)) = 1; \
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200519 } else { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200520 ++(*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1)); \
521 ARRAY = ly_realloc(((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1), sizeof(LY_ARRAY_COUNT_TYPE) + (*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1) * sizeof *(ARRAY))); \
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200522 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
523 } \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200524 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
525 (NEW_ITEM) = &(ARRAY)[*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1) - 1]; \
Radek Krejci2c4e7172018-10-19 15:56:26 +0200526 memset(NEW_ITEM, 0, sizeof *(NEW_ITEM))
Michal Vasko1324b6c2018-09-07 11:16:23 +0200527
Radek Krejci2c4e7172018-10-19 15:56:26 +0200528/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100529 * @brief (Re-)Allocation of a ([sized array](@ref sizedarrays)).
530 *
531 * Increases the size information.
532 *
533 * @param[in] CTX libyang context for logging.
534 * @param[in,out] ARRAY Pointer to the array to allocate/resize. The size of the allocated
535 * space is counted from the type of the ARRAY, so do not provide placeholder void pointers.
536 * @param[out] NEW_ITEM Returning pointer to the newly allocated record in the ARRAY.
537 * @param[out] RET Variable to store error code.
538 * @param[in] GOTO Label to go in case of error (memory allocation failure).
539 */
540#define LY_ARRAY_NEW_GOTO(CTX, ARRAY, NEW_ITEM, RET, GOTO) \
541 if (!(ARRAY)) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200542 ARRAY = malloc(sizeof(LY_ARRAY_COUNT_TYPE) + sizeof *(ARRAY)); \
543 *((LY_ARRAY_COUNT_TYPE*)(ARRAY)) = 1; \
Radek Krejci4f28eda2018-11-12 11:46:16 +0100544 } else { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200545 ++(*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1)); \
546 ARRAY = ly_realloc(((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1), sizeof(LY_ARRAY_COUNT_TYPE) + (*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1) * sizeof *(ARRAY))); \
Radek Krejci4f28eda2018-11-12 11:46:16 +0100547 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
548 } \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200549 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
550 (NEW_ITEM) = &(ARRAY)[*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1) - 1]; \
Radek Krejci4f28eda2018-11-12 11:46:16 +0100551 memset(NEW_ITEM, 0, sizeof *(NEW_ITEM))
552
553/**
Radek Krejci2c4e7172018-10-19 15:56:26 +0200554 * @brief Allocate a ([sized array](@ref sizedarrays)) for the specified number of items.
Radek Krejcic4fa0292020-05-14 10:54:49 +0200555 * If the ARRAY already exists, it is resized (space for SIZE items is added and zeroed).
Radek Krejci2c4e7172018-10-19 15:56:26 +0200556 *
557 * Does not set the size information, it is supposed to be incremented via ::LY_ARRAY_INCREMENT
558 * when the items are filled.
559 *
560 * @param[in] CTX libyang context for logging.
561 * @param[in,out] ARRAY Pointer to the array to create.
562 * @param[in] SIZE Number of items the array is supposed to hold. The size of the allocated
563 * space is then counted from the type of the ARRAY, so do not provide placeholder void pointers.
564 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
565 */
566#define LY_ARRAY_CREATE_RET(CTX, ARRAY, SIZE, RETVAL) \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100567 if (ARRAY) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200568 ARRAY = ly_realloc(((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1), sizeof(LY_ARRAY_COUNT_TYPE) + ((*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1) + SIZE) * sizeof *(ARRAY))); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100569 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200570 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
571 memset(&(ARRAY)[*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1)], 0, SIZE * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100572 } else { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200573 ARRAY = calloc(1, sizeof(LY_ARRAY_COUNT_TYPE) + SIZE * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100574 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200575 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100576 }
Radek Krejci2c4e7172018-10-19 15:56:26 +0200577
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100578/**
579 * @brief Allocate a ([sized array](@ref sizedarrays)) for the specified number of items.
Radek Krejcid05cbd92018-12-05 14:26:40 +0100580 * If the ARRAY already exists, it is resized (space for SIZE items is added).
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100581 *
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200582 * Does not set the count information, it is supposed to be incremented via ::LY_ARRAY_INCREMENT
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100583 * when the items are filled.
584 *
585 * @param[in] CTX libyang context for logging.
586 * @param[in,out] ARRAY Pointer to the array to create.
Radek Krejci00b874b2019-02-12 10:54:50 +0100587 * @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 +0100588 * space is then counted from the type of the ARRAY, so do not provide placeholder void pointers.
589 * @param[out] RET Variable to store error code.
590 * @param[in] GOTO Label to go in case of error (memory allocation failure).
591 */
592#define LY_ARRAY_CREATE_GOTO(CTX, ARRAY, SIZE, RET, GOTO) \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100593 if (ARRAY) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200594 ARRAY = ly_realloc(((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1), sizeof(LY_ARRAY_COUNT_TYPE) + ((*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1) + (SIZE)) * sizeof *(ARRAY))); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100595 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200596 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
597 memset(&(ARRAY)[*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1)], 0, (SIZE) * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100598 } else { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200599 ARRAY = calloc(1, sizeof(LY_ARRAY_COUNT_TYPE) + (SIZE) * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100600 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200601 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100602 }
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100603
Radek Krejcic4fa0292020-05-14 10:54:49 +0200604/**
605 * @brief Resize a ([sized array](@ref sizedarrays)) to the the specified number of items.
606 *
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200607 * Does not change the count information, it is supposed to be incremented via ::LY_ARRAY_INCREMENT
Radek Krejcic4fa0292020-05-14 10:54:49 +0200608 * when the items are filled.
609 *
610 * @param[in] CTX libyang context for logging.
611 * @param[in,out] ARRAY Pointer to the array to create.
612 * @param[in] SIZE Number of items the array is supposed to hold. The size of the allocated
613 * space is then counted from the type of the ARRAY, so do not provide placeholder void pointers.
614 * @param[in] ERR Additional action(s) in case of error (passed to LY_CHECK_ERR_RET).
615 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
616 */
617#define LY_ARRAY_RESIZE_ERR_RET(CTX, ARRAY, SIZE, ERR, RETVAL) \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200618 ARRAY = ly_realloc(((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1), sizeof(LY_ARRAY_COUNT_TYPE) + ((SIZE) * sizeof *(ARRAY))); \
Radek Krejcic4fa0292020-05-14 10:54:49 +0200619 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX); ERR, RETVAL); \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200620 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1);
Radek Krejciccd20f12019-02-15 14:12:27 +0100621
Radek Krejcic4fa0292020-05-14 10:54:49 +0200622/**
623 * @brief Increment the items counter in a ([sized array](@ref sizedarrays)).
624 *
625 * Does not change the allocated memory used by the ARRAY. To do so, use LY_ARRAY_CREATE_RET,
626 * LY_ARRAY_CREATE_GOTO or LY_ARRAY_RESIZE_ERR_RET.
627 *
628 * @param[in] ARRAY Pointer to the array to affect.
629 */
630#define LY_ARRAY_INCREMENT(ARRAY) \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200631 ++(*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1))
Radek Krejcic4fa0292020-05-14 10:54:49 +0200632
633/**
634 * @brief Decrement the items counter in a ([sized array](@ref sizedarrays)).
635 *
636 * Does not change the allocated memory used by the ARRAY. To do so, use LY_ARRAY_CREATE_RET,
637 * LY_ARRAY_CREATE_GOTO or LY_ARRAY_RESIZE_ERR_RET.
638 *
639 * @param[in] ARRAY Pointer to the array to affect.
640 */
Radek Krejciccd20f12019-02-15 14:12:27 +0100641#define LY_ARRAY_DECREMENT(ARRAY) \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200642 --(*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1))
Radek Krejciccd20f12019-02-15 14:12:27 +0100643
Radek Krejci2c4e7172018-10-19 15:56:26 +0200644/**
645 * @brief Free the space allocated for the ([sized array](@ref sizedarrays)).
646 *
647 * The items inside the array are not freed.
648 *
649 * @param[in] ARRAY A ([sized array](@ref sizedarrays)) to be freed.
650 */
651#define LY_ARRAY_FREE(ARRAY) \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200652 if (ARRAY){free((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1);}
David Sedlák8d552d62019-08-06 15:29:05 +0200653
David Sedlák26ea1432019-08-14 13:42:23 +0200654/**
David Sedlákaa98bba2019-09-12 11:52:14 +0200655 * @brief Insert item into linked list.
David Sedlák26ea1432019-08-14 13:42:23 +0200656 *
657 * @param[in,out] LIST Linked list to add to.
658 * @param[in] NEW_ITEM New item, that will be appended to the list, must be already allocated.
659 * @param[in] LINKER name of structuin member that is used to connect items together.
660 */
David Sedlák8d552d62019-08-06 15:29:05 +0200661#define LY_LIST_INSERT(LIST, NEW_ITEM, LINKER)\
662 if (!(*LIST)) { \
663 *LIST = (__typeof__(*(LIST)))NEW_ITEM; \
664 } else { \
665 do { \
666 __typeof__(*(LIST)) iterator; \
667 for (iterator = *(LIST); iterator->LINKER; iterator = iterator->LINKER); \
668 iterator->LINKER = (__typeof__(*(LIST)))NEW_ITEM; \
669 } while (0); \
670 }
671
David Sedlák26ea1432019-08-14 13:42:23 +0200672/**
David Sedlákaa98bba2019-09-12 11:52:14 +0200673 * @brief Allocate and insert new item into linked list, return in case of error.
David Sedlák26ea1432019-08-14 13:42:23 +0200674 *
David Sedláke6284fc2019-09-10 11:57:02 +0200675 * @param[in] CTX used for logging.
676 * @param[in,out] LIST Linked list to add to.
677 * @param[out] NEW_ITEM New item that is appended to the list.
678 * @param[in] LINKER name of structure member that is used to connect items together.
David Sedlákfbe240f2019-09-13 11:18:53 +0200679 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
David Sedlák26ea1432019-08-14 13:42:23 +0200680 */
David Sedlákb9eeb9c2019-09-13 11:17:19 +0200681#define LY_LIST_NEW_RET(CTX, LIST, NEW_ITEM, LINKER, RETVAL) \
David Sedlák8d552d62019-08-06 15:29:05 +0200682 NEW_ITEM = calloc(1, sizeof *NEW_ITEM); \
David Sedlákb9eeb9c2019-09-13 11:17:19 +0200683 LY_CHECK_ERR_RET(!(NEW_ITEM), LOGMEM(CTX), RETVAL); \
David Sedlák8d552d62019-08-06 15:29:05 +0200684 LY_LIST_INSERT(LIST, NEW_ITEM, LINKER)
685
David Sedláke6284fc2019-09-10 11:57:02 +0200686/**
David Sedlákaa98bba2019-09-12 11:52:14 +0200687 * @brief Allocate and insert new item into linked list, goto specified label in case of error.
David Sedláke6284fc2019-09-10 11:57:02 +0200688 *
689 * @param[in] CTX used for logging.
690 * @param[in,out] LIST Linked list to add to.
691 * @param[out] NEW_ITEM New item that is appended to the list.
692 * @param[in] LINKER name of structure member that is used to connect items together.
693 * @param[in] RET variable to store returned error type.
694 * @param[in] LABEL label to goto in case of error.
695 */
696#define LY_LIST_NEW_GOTO(CTX, LIST, NEW_ITEM, LINKER, RET, LABEL) \
697 NEW_ITEM = calloc(1, sizeof *NEW_ITEM); \
698 LY_CHECK_ERR_GOTO(!(NEW_ITEM), RET = LY_EMEM; LOGMEM(CTX), LABEL); \
699 LY_LIST_INSERT(LIST, NEW_ITEM, LINKER)
700
David Sedláke6cd89e2019-08-07 12:46:02 +0200701#endif /* LY_COMMON_H_ */