blob: 3204bbf8493ea0315f4abc814895f3e072934270 [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 Krejcid33273d2018-10-25 14:55:52 +020022#include "context.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020023#include "dict.h"
Radek Krejci6caa6ab2018-10-24 10:04:48 +020024#include "hash_table.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020025#include "log.h"
26#include "set.h"
Radek Krejcic4fa0292020-05-14 10:54:49 +020027#include "tree.h"
Radek Krejci535ea9f2020-05-29 16:01:05 +020028#include "tree_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020029
30struct ly_ctx;
Radek Krejciaddfc9a2020-12-17 20:46:35 +010031struct ly_in;
Radek Krejci535ea9f2020-05-29 16:01:05 +020032struct lys_module;
Radek Krejci5aeea3a2018-09-05 13:29:36 +020033
34#if __STDC_VERSION__ >= 201112 && !defined __STDC_NO_THREADS__
35# define THREAD_LOCAL _Thread_local
36#elif defined __GNUC__ || \
Radek Krejci0f969882020-08-21 16:56:47 +020037 defined __SUNPRO_C || \
38 defined __xlC__
Radek Krejci5aeea3a2018-09-05 13:29:36 +020039# define THREAD_LOCAL __thread
40#else
41# error "Cannot define THREAD_LOCAL"
42#endif
43
Radek Krejcic59bc972018-09-17 16:13:06 +020044#define GETMACRO1(_1, NAME, ...) NAME
Radek Krejci5aeea3a2018-09-05 13:29:36 +020045#define GETMACRO2(_1, _2, NAME, ...) NAME
46#define GETMACRO3(_1, _2, _3, NAME, ...) NAME
47#define GETMACRO4(_1, _2, _3, _4, NAME, ...) NAME
Michal Vaskodc779a82019-11-06 15:44:06 +010048#define GETMACRO5(_1, _2, _3, _4, _5, NAME, ...) NAME
Radek Krejci5aeea3a2018-09-05 13:29:36 +020049
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
57/******************************************************************************
58 * Logger
59 *****************************************************************************/
Radek Krejci5aeea3a2018-09-05 13:29:36 +020060
Radek Krejci52b6d512020-10-12 12:33:17 +020061extern volatile LY_LOG_LEVEL ly_ll;
Radek Krejci1deb5be2020-08-26 16:43:36 +020062extern volatile uint32_t ly_log_opts;
Radek Krejci5aeea3a2018-09-05 13:29:36 +020063
Radek Krejciaddfc9a2020-12-17 20:46:35 +010064struct ly_log_location_s {
65 uint64_t line; /**< One-time line value being reset after use - replaces whatever is in inputs */
66 struct ly_set inputs; /**< Set of const struct ly_in *in pointers providing the input handler with the line information (LIFO) */
67 struct ly_set scnodes; /**< Set of const struct lysc_node *scnode pointers providing the compiled schema node to generate path (LIFO) */
68 struct ly_set dnodes; /**< Set of const struct lyd_node *dnode pointers providing the data node to generate path (LIFO) */
69 struct ly_set paths; /**< Set of path strings (LIFO) */
70};
71
72/**
73 * @brief Destructor for the thread-specific data providing location information for the logger.
74 */
75void ly_log_location_free(void *ptr);
76
Radek Krejcie7b95092019-05-15 11:03:07 +020077/**
Radek Krejcie7b95092019-05-15 11:03:07 +020078 * @brief Print a log message and store it into the context (if provided).
79 *
80 * @param[in] ctx libyang context to store the error record. If not provided, the error is just printed.
81 * @param[in] level Log message level (error, warning, etc.)
82 * @param[in] no Error type code.
83 * @param[in] format Format string to print.
84 */
Radek Krejci5aeea3a2018-09-05 13:29:36 +020085void ly_log(const struct ly_ctx *ctx, LY_LOG_LEVEL level, LY_ERR no, const char *format, ...);
Radek Krejcie7b95092019-05-15 11:03:07 +020086
87/**
88 * @brief Print Validation error and store it into the context (if provided).
89 *
90 * @param[in] ctx libyang context to store the error record. If not provided, the error is just printed.
Radek Krejcie7b95092019-05-15 11:03:07 +020091 * @param[in] code Validation error code.
92 * @param[in] format Format string to print.
93 */
Radek Krejci2efc45b2020-12-22 16:25:44 +010094void ly_vlog(const struct ly_ctx *ctx, LY_VECODE code, const char *format, ...);
Radek Krejci5aeea3a2018-09-05 13:29:36 +020095
Radek Krejciaddfc9a2020-12-17 20:46:35 +010096/**
97 * @brief Logger's location data setter.
98 *
99 * @param[in] ctx libyang context, mandatory argument.
100 * @param[in] scnode Compiled schema node.
101 * @param[in] dnode Data node.
102 * @param[in] path Direct path string to print.
103 * @param[in] in Input handler (providing line number)
104 * @param[in] line One-time line value to be reset when used.
105 * @param[in] reset Flag to indicate if the not set arguments (NULLs) are intended to rewrite the current values or if they
106 * are supposed to be ignored and the previous values should be kept.
107 */
108void ly_log_location(const struct ly_ctx *ctx, const struct lysc_node *scnode, const struct lyd_node *dnode,
109 const char *path, const struct ly_in *in, uint64_t line, ly_bool reset);
110
111/**
112 * @brief Revert the specific logger's location data by number of changes made by ::ly_log_location().
113 *
114 * @param[in] ctx libyang context, mandatory argument.
115 * @param[in] scnode_steps Number of items in ::ly_log_location.scnodes to forget.
116 * @param[in] dnode_steps Number of items in ::ly_log_location.dnodes to forget.
117 * @param[in] path_steps Number of path strings in ::ly_log_location.paths to forget.
118 * @param[in] in_steps Number of input handlers ::ly_log_location.inputs to forget.
119 */
120void ly_log_location_revert(const struct ly_ctx *ctx, uint32_t scnode_steps, uint32_t dnode_steps,
121 uint32_t path_steps, uint32_t in_steps);
122
123/**
124 * @brief Initiate location data for logger, all arguments are set as provided (even NULLs) - overrides the current values.
125 *
126 * @param[in] CTX libyang context, mandatory argument.
127 * @param[in] SCNODE Compiled schema node.
128 * @param[in] DNODE Data node.
129 * @param[in] PATH Direct path string to print.
130 * @param[in] IN Input handler (providing line number)
131 */
132#define LOG_LOCINIT(CTX, SCNODE, DNODE, PATH, IN) \
133 ly_log_location(CTX, SCNODE, DNODE, PATH, IN, 0, 1)
134
135/**
136 * @brief Update location data for logger, not provided arguments (NULLs) are kept (does not override).
137 *
138 * @param[in] CTX libyang context, mandatory argument.
139 * @param[in] SCNODE Compiled schema node.
140 * @param[in] DNODE Data node.
141 * @param[in] PATH Direct path string to print.
142 * @param[in] IN Input handler (providing line number)
143 */
144#define LOG_LOCSET(CTX, SCNODE, DNODE, PATH, IN) \
145 ly_log_location(CTX, SCNODE, DNODE, PATH, IN, 0, 0)
146
147#define LOG_LOCBACK(CTX, SCNODE_STEPS, DNODE_STEPS, PATH_STEPS, IN_STEPS) \
148 ly_log_location_revert(CTX, SCNODE_STEPS, DNODE_STEPS, PATH_STEPS, IN_STEPS)
149
Radek Krejcic0c66412020-08-21 13:53:50 +0200150#define LOGERR(ctx, errno, str, ...) ly_log(ctx, LY_LLERR, errno, str, ##__VA_ARGS__)
Radek Krejcif3f47842018-11-15 11:22:15 +0100151#define LOGWRN(ctx, str, ...) ly_log(ctx, LY_LLWRN, 0, str, ##__VA_ARGS__)
Radek Krejcic0c66412020-08-21 13:53:50 +0200152#define LOGVRB(str, ...) ly_log(NULL, LY_LLVRB, 0, str, ##__VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200153
Radek Krejci4ab61562018-09-05 15:00:37 +0200154#ifdef NDEBUG
Radek Krejcic0c66412020-08-21 13:53:50 +0200155# define LOGDBG(dbg_group, str, ...)
Radek Krejci4ab61562018-09-05 15:00:37 +0200156#else
Radek Krejci1deb5be2020-08-26 16:43:36 +0200157void ly_log_dbg(uint32_t group, const char *format, ...);
Radek Krejcic0c66412020-08-21 13:53:50 +0200158# define LOGDBG(dbg_group, str, ...) ly_log_dbg(dbg_group, str, ##__VA_ARGS__);
Radek Krejci4ab61562018-09-05 15:00:37 +0200159#endif
160
Radek Krejcie2692202020-12-01 14:21:12 +0100161/**
162 * Simple EMEM message, it can be safely stored in ::ly_err_item structures without problems when freeing.
163 */
164#define LY_EMEM_MSG "Memory allocation failed."
165
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200166#define LOGMEM(CTX) LOGERR(CTX, LY_EMEM, "Memory allocation failed (%s()).", __func__)
167#define LOGINT(CTX) LOGERR(CTX, LY_EINT, "Internal error (%s:%d).", __FILE__, __LINE__)
168#define LOGARG(CTX, ARG) LOGERR(CTX, LY_EINVAL, "Invalid argument %s (%s()).", #ARG, __func__)
Radek Krejci2efc45b2020-12-22 16:25:44 +0100169#define LOGVAL(CTX, CODE, ...) ly_vlog(CTX, CODE, ##__VA_ARGS__)
170#define LOGVAL_LINE(CTX, LINE, CODE, ...) \
171 ly_log_location(CTX, NULL, NULL, NULL, NULL, LINE, 0); \
172 ly_vlog(CTX, CODE, ##__VA_ARGS__)
Radek Krejci94aa9942018-09-07 17:12:17 +0200173
174#define LOGMEM_RET(CTX) LOGMEM(CTX); return LY_EMEM
175#define LOGINT_RET(CTX) LOGINT(CTX); return LY_EINT
176#define LOGARG_RET(CTX) LOGARG(CTX); return LY_EINVAL
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200177
178/*
179 * Common code to check return value and perform appropriate action.
180 */
Radek Krejcie88beef2019-05-30 15:47:19 +0200181#define LY_CHECK_GOTO(COND, GOTO) if ((COND)) {goto GOTO;}
182#define LY_CHECK_ERR_GOTO(COND, ERR, GOTO) if ((COND)) {ERR; goto GOTO;}
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100183#define LY_CHECK_RET1(RETVAL) {LY_ERR ret__ = RETVAL;if (ret__ != LY_SUCCESS) {return ret__;}}
Radek Krejcie88beef2019-05-30 15:47:19 +0200184#define LY_CHECK_RET2(COND, RETVAL) if ((COND)) {return RETVAL;}
Radek Krejcic59bc972018-09-17 16:13:06 +0200185#define LY_CHECK_RET(...) GETMACRO2(__VA_ARGS__, LY_CHECK_RET2, LY_CHECK_RET1)(__VA_ARGS__)
Radek Krejcie88beef2019-05-30 15:47:19 +0200186#define LY_CHECK_ERR_RET(COND, ERR, RETVAL) if ((COND)) {ERR; return RETVAL;}
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200187
Radek Krejcia3045382018-11-22 14:30:31 +0100188#define LY_CHECK_ARG_GOTO1(CTX, ARG, GOTO) if (!(ARG)) {LOGARG(CTX, ARG);goto GOTO;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200189#define LY_CHECK_ARG_GOTO2(CTX, ARG1, ARG2, GOTO) LY_CHECK_ARG_GOTO1(CTX, ARG1, GOTO);LY_CHECK_ARG_GOTO1(CTX, ARG2, GOTO)
190#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 +0100191#define LY_CHECK_ARG_GOTO4(CTX, ARG1, ARG2, ARG3, ARG4, GOTO) LY_CHECK_ARG_GOTO3(CTX, ARG1, ARG2, ARG3, GOTO);\
192 LY_CHECK_ARG_GOTO1(CTX, ARG4, GOTO)
193#define LY_CHECK_ARG_GOTO(CTX, ...) GETMACRO5(__VA_ARGS__, LY_CHECK_ARG_GOTO4, LY_CHECK_ARG_GOTO3, LY_CHECK_ARG_GOTO2, \
194 LY_CHECK_ARG_GOTO1)(CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200195
Radek Krejcia3045382018-11-22 14:30:31 +0100196#define LY_CHECK_ARG_RET1(CTX, ARG, RETVAL) if (!(ARG)) {LOGARG(CTX, ARG);return RETVAL;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200197#define LY_CHECK_ARG_RET2(CTX, ARG1, ARG2, RETVAL) LY_CHECK_ARG_RET1(CTX, ARG1, RETVAL);LY_CHECK_ARG_RET1(CTX, ARG2, RETVAL)
198#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 +0100199#define LY_CHECK_ARG_RET4(CTX, ARG1, ARG2, ARG3, ARG4, RETVAL) LY_CHECK_ARG_RET3(CTX, ARG1, ARG2, ARG3, RETVAL);\
200 LY_CHECK_ARG_RET1(CTX, ARG4, RETVAL)
201#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)\
202 (CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200203
Radek Krejcid972c252018-09-25 13:23:39 +0200204/* count sequence size for LY_VCODE_INCHILDSTMT validation error code */
205size_t LY_VCODE_INSTREXP_len(const char *str);
206/* default maximum characters to print in LY_VCODE_INCHILDSTMT */
207#define LY_VCODE_INSTREXP_MAXLEN 20
208
Michal Vaskoecd62de2019-11-13 12:35:11 +0100209#define LY_VCODE_INCHAR LYVE_SYNTAX, "Invalid character 0x%x."
210#define LY_VCODE_INSTREXP LYVE_SYNTAX, "Invalid character sequence \"%.*s\", expected %s."
211#define LY_VCODE_EOF LYVE_SYNTAX, "Unexpected end-of-input."
212#define LY_VCODE_NTERM LYVE_SYNTAX, "%s not terminated."
213#define LY_VCODE_NSUPP LYVE_SYNTAX, "%s not supported."
214#define LY_VCODE_MOD_SUBOMD LYVE_SYNTAX, "Invalid keyword \"%s\", expected \"module\" or \"submodule\"."
215#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 +0200216#define LY_VCODE_TRAILING_SUBMOD LYVE_SYNTAX, "Trailing garbage \"%.*s%s\" after submodule, expected end-of-input."
217
Michal Vaskoecd62de2019-11-13 12:35:11 +0100218#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."
Radek Krejci854e1552020-12-21 15:05:23 +0100219#define LY_VCODE_NAME_COL LYVE_SEMANTICS, "Name collision between %s of name \"%s\"."
220#define LY_VCODE_NAME2_COL LYVE_SEMANTICS, "Name collision between %s and %s of name \"%s\"."
David Sedlák0c2bab92019-07-22 15:33:19 +0200221
Michal Vaskoecd62de2019-11-13 12:35:11 +0100222#define LY_VCODE_INSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\"."
223#define LY_VCODE_INCHILDSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\" as a child of \"%s\"."
224#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 +0100225#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 +0100226#define LY_VCODE_DUPSTMT LYVE_SYNTAX_YANG, "Duplicate keyword \"%s\"."
227#define LY_VCODE_DUPIDENT LYVE_SYNTAX_YANG, "Duplicate identifier \"%s\" of %s statement."
228#define LY_VCODE_INVAL LYVE_SYNTAX_YANG, "Invalid value \"%.*s\" of \"%s\"."
229#define LY_VCODE_MISSTMT LYVE_SYNTAX_YANG, "Missing mandatory keyword \"%s\" as a child of \"%s\"."
230#define LY_VCODE_MISSCHILDSTMT LYVE_SYNTAX_YANG, "Missing %s substatement for %s%s."
231#define LY_VCODE_INORD LYVE_SYNTAX_YANG, "Invalid keyword \"%s\", it cannot appear after \"%s\"."
232#define LY_VCODE_OOB LYVE_SYNTAX_YANG, "Value \"%.*s\" is out of \"%s\" bounds."
233#define LY_VCODE_INDEV LYVE_SYNTAX_YANG, "Deviate \"%s\" does not support keyword \"%s\"."
234#define LY_VCODE_INREGEXP LYVE_SYNTAX_YANG, "Regular expression \"%s\" is not valid (\"%s\": %s)."
David Sedlák0c2bab92019-07-22 15:33:19 +0200235
Michal Vaskoecd62de2019-11-13 12:35:11 +0100236#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."
237#define LY_VCODE_INVAL_YIN LYVE_SYNTAX_YIN, "Invalid value \"%s\" of \"%s\" attribute in \"%s\" element."
238#define LY_VCODE_UNEXP_SUBELEM LYVE_SYNTAX_YIN, "Unexpected sub-element \"%.*s\" of \"%s\" element."
239#define LY_VCODE_INDEV_YIN LYVE_SYNTAX_YIN, "Deviate of this type doesn't allow \"%s\" as it's sub-element."
240#define LY_VCODE_INORDER_YIN LYVE_SYNTAX_YIN, "Invalid order of %s\'s sub-elements \"%s\" can't appear after \"%s\"."
241#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 +0200242#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 +0100243#define LY_VCODE_DUP_ATTR LYVE_SYNTAX_YIN, "Duplicit definition of \"%s\" attribute in \"%s\" element."
244#define LY_VCODE_UNEXP_ATTR LYVE_SYNTAX_YIN, "Unexpected attribute \"%.*s\" of \"%s\" element."
245#define LY_VCODE_MAND_SUBELEM LYVE_SYNTAX_YIN, "Missing mandatory sub-element \"%s\" of \"%s\" element."
246#define LY_VCODE_FIRT_SUBELEM LYVE_SYNTAX_YIN, "Sub-element \"%s\" of \"%s\" element must be defined as it's first sub-element."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100247#define LY_VCODE_SUBELEM_REDEF LYVE_SYNTAX_YIN, "Redefinition of \"%s\" sub-element in \"%s\" element."
David Sedlák0c2bab92019-07-22 15:33:19 +0200248
Michal Vaskoecd62de2019-11-13 12:35:11 +0100249#define LY_VCODE_XP_EOE LYVE_XPATH, "Unterminated string delimited with %c (%.15s)."
250#define LY_VCODE_XP_INEXPR LYVE_XPATH, "Invalid character number %u of expression \'%s\'."
251#define LY_VCODE_XP_EOF LYVE_XPATH, "Unexpected XPath expression end."
Michal Vasko0b468e62020-10-19 09:33:04 +0200252#define LY_VCODE_XP_INTOK LYVE_XPATH, "Unexpected XPath token \"%s\" (\"%.15s\")."
253#define LY_VCODE_XP_INTOK2 LYVE_XPATH, "Unexpected XPath token \"%s\" (\"%.15s\"), expected \"%s\"."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100254#define LY_VCODE_XP_INFUNC LYVE_XPATH, "Unknown XPath function \"%.*s\"."
255#define LY_VCODE_XP_INARGCOUNT LYVE_XPATH, "Invalid number of arguments (%d) for the XPath function %.*s."
256#define LY_VCODE_XP_INARGTYPE LYVE_XPATH, "Wrong type of argument #%d (%s) for the XPath function %s."
257#define LY_VCODE_XP_INCTX LYVE_XPATH, "Invalid context type %s in %s."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100258#define LY_VCODE_XP_INOP_1 LYVE_XPATH, "Cannot apply XPath operation %s on %s."
259#define LY_VCODE_XP_INOP_2 LYVE_XPATH, "Cannot apply XPath operation %s on %s and %s."
Michal Vasko004d3152020-06-11 19:59:22 +0200260#define LY_VCODE_XP_INMOD LYVE_XPATH, "Unknown/non-implemented module \"%.*s\"."
David Sedlák0c2bab92019-07-22 15:33:19 +0200261
Radek Krejci327de162019-06-14 12:52:07 +0200262#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 +0200263
Michal Vaskoecd62de2019-11-13 12:35:11 +0100264#define LY_VCODE_NOWHEN LYVE_DATA, "When condition \"%s\" not satisfied."
Michal Vaskocc048b22020-03-27 15:52:38 +0100265#define LY_VCODE_NOMUST LYVE_DATA, "Must condition \"%s\" not satisfied."
Michal Vaskoa3881362020-01-21 15:57:35 +0100266#define LY_VCODE_NOMAND LYVE_DATA, "Mandatory node \"%s\" instance does not exist."
Michal Vaskoacd83e72020-02-04 14:12:01 +0100267#define LY_VCODE_NOMIN LYVE_DATA, "Too few \"%s\" instances."
268#define LY_VCODE_NOMAX LYVE_DATA, "Too many \"%s\" instances."
Michal Vasko14654712020-02-06 08:35:21 +0100269#define LY_VCODE_NOUNIQ LYVE_DATA, "Unique data leaf(s) \"%s\" not satisfied in \"%s\" and \"%s\"."
Michal Vaskof03ed032020-03-04 13:31:44 +0100270#define LY_VCODE_DUP LYVE_DATA, "Duplicate instance of \"%s\"."
271#define LY_VCODE_DUPCASE LYVE_DATA, "Data for both cases \"%s\" and \"%s\" exist."
Michal Vaskocb7526d2020-03-30 15:08:26 +0200272#define LY_VCODE_INNODE LYVE_DATA, "Invalid %s data node \"%s\" found."
Michal Vasko9f96a052020-03-10 09:41:45 +0100273#define LY_VCODE_NOKEY LYVE_DATA, "List instance is missing its key \"%s\"."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100274
Radek Krejcic59bc972018-09-17 16:13:06 +0200275/******************************************************************************
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200276 * Context
277 *****************************************************************************/
278
279/**
280 * @brief Context of the YANG schemas
281 */
282struct ly_ctx {
283 struct dict_table dict; /**< dictionary to effectively store strings used in the context related structures */
284 struct ly_set search_paths; /**< set of directories where to search for schema's imports/includes */
Michal Vasko89b5c072020-10-06 13:52:44 +0200285 struct ly_set list; /**< set of loaded YANG schemas */
Radek Krejcid33273d2018-10-25 14:55:52 +0200286 ly_module_imp_clb imp_clb; /**< Optional callback for retrieving missing included or imported models in a custom way. */
Radek Krejci8678fa42020-08-18 16:07:28 +0200287 void *imp_clb_data; /**< Optional private data for ::ly_ctx.imp_clb */
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200288 uint16_t module_set_id; /**< ID of the current set of schemas */
289 uint16_t flags; /**< context settings, see @ref contextoptions. */
290 pthread_key_t errlist_key; /**< key for the thread-specific list of errors related to the context */
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100291 pthread_key_t log_location_key; /**< key for the thread-specific tracing of current location for logging error location */
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200292};
293
Radek Krejcid33273d2018-10-25 14:55:52 +0200294/**
295 * @brief Try to find submodule in the context. Submodules are present only in the parsed (lysp_) schema trees, if only
296 * the compiled versions of the schemas are present, the submodule cannot be returned even if it was used to compile
297 * some of the currently present schemas.
298 *
Michal Vaskoc3781c32020-10-06 14:04:08 +0200299 * @param[in] ctx Context where to search in case @p module is NULL.
300 * @param[in] module Submodule parent (belongs-to) module in case @p ctx is NULL.
Radek Krejcid33273d2018-10-25 14:55:52 +0200301 * @param[in] submodule Name of the submodule to find.
302 * @param[in] revision Optional revision of the submodule to find. If not specified, the latest revision is returned.
303 * @return Pointer to the specified submodule if it is present in the context.
304 */
Michal Vaskoc3781c32020-10-06 14:04:08 +0200305struct lysp_submodule *ly_ctx_get_submodule(const struct ly_ctx *ctx, const struct lys_module *module,
306 const char *submodule, const char *revision);
Radek Krejcid33273d2018-10-25 14:55:52 +0200307
Radek Krejci0ad51f12020-07-16 12:08:12 +0200308/**
309 * @brief Get the (only) implemented YANG module specified by its name.
310 *
311 * @param[in] ctx Context where to search.
312 * @param[in] name Name of the YANG module to get.
313 * @param[in] name_len Optional length of the @p name. If zero, NULL-terminated name is expected.
314 * @return The only implemented YANG module revision of the given name in the given context. NULL if there is no
315 * implemented module of the given name.
316 */
317struct lys_module *ly_ctx_get_module_implemented2(const struct ly_ctx *ctx, const char *name, size_t name_len);
318
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200319/******************************************************************************
Radek Krejcic59bc972018-09-17 16:13:06 +0200320 * Parsers
321 *****************************************************************************/
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200322
Radek Krejcic59bc972018-09-17 16:13:06 +0200323/* list of the YANG statements strings */
Michal Vasko22df3f02020-08-24 13:29:22 +0200324extern const char * const ly_stmt_list[];
Radek Krejcic59bc972018-09-17 16:13:06 +0200325#define ly_stmt2str(STMT) ly_stmt_list[STMT]
326
327/* list of the extensions' substatements strings */
Michal Vasko22df3f02020-08-24 13:29:22 +0200328extern const char * const lyext_substmt_list[];
Radek Krejcic59bc972018-09-17 16:13:06 +0200329#define lyext_substmt2str(STMT) lyext_substmt_list[STMT]
330
331/* list of the deviate modifications strings */
Michal Vasko22df3f02020-08-24 13:29:22 +0200332extern const char * const ly_devmod_list[];
Radek Krejcic59bc972018-09-17 16:13:06 +0200333#define ly_devmod2str(TYPE) ly_devmod_list[TYPE]
334
335/******************************************************************************
Michal Vasko1324b6c2018-09-07 11:16:23 +0200336 * Generic useful functions.
Radek Krejcic59bc972018-09-17 16:13:06 +0200337 *****************************************************************************/
Michal Vasko1324b6c2018-09-07 11:16:23 +0200338
Michal Vaskob36053d2020-03-26 15:49:30 +0100339/**
340 * @brief Insert string into dictionary.
341 *
342 * @param[in] CTX libyang context.
343 * @param[in] STRING string to store.
344 * @param[in] LEN length of the string in WORD to store.
345 * @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.
346 */
Radek Krejci011e4aa2020-09-04 15:22:31 +0200347#define INSERT_STRING_RET(CTX, STRING, LEN, DYNAMIC, TARGET) \
348 if (DYNAMIC) { \
349 LY_CHECK_RET(lydict_insert_zc(CTX, (char *)(STRING), &(TARGET))); \
350 } else { \
351 LY_CHECK_RET(lydict_insert(CTX, LEN ? (STRING) : "", LEN, &(TARGET))); \
352 } \
353 DYNAMIC = 0
Michal Vaskob36053d2020-03-26 15:49:30 +0100354
Radek Krejci76b3e962018-12-14 17:01:25 +0100355#define FREE_STRING(CTX, STRING) if (STRING) {lydict_remove(CTX, STRING);}
356
Michal Vasko1324b6c2018-09-07 11:16:23 +0200357/**
358 * @brief Wrapper for realloc() call. The only difference is that if it fails to
359 * allocate the requested memory, the original memory is freed as well.
360 *
361 * @param[in] ptr Memory to reallocate.
362 * @param[in] size New size of the memory block.
363 *
364 * @return Pointer to the new memory, NULL on error.
365 */
366void *ly_realloc(void *ptr, size_t size);
367
Radek Krejcif345c012018-09-19 11:12:59 +0200368/**
Michal Vasko03ff5a72019-09-11 13:49:33 +0200369 * @brief Just like strchr() function except limit the number of examined characters.
370 *
371 * @param[in] s String to search in.
372 * @param[in] c Character to search for.
373 * @param[in] len Limit the search to this number of characters in @p s.
374 * @return Pointer to first @p c occurence in @p s, NULL if not found in first @p len characters.
375 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200376char *ly_strnchr(const char *s, int c, size_t len);
Michal Vasko03ff5a72019-09-11 13:49:33 +0200377
378/**
Radek Krejci7f9b6512019-09-18 13:11:09 +0200379 * @brief Compare NULL-terminated @p refstr with @str_len bytes from @p str.
380 *
381 * @param[in] refstr NULL-terminated string which must match @str_len bytes from @str followed by NULL-byte.
382 * @param[in] str String to compare
383 * @param[in] str_len Number of bytes to take into comparison from @p str.
384 * @return An integer less than, equal to, or greater than zero if @p refstr matches,
385 * respectively, to be less than, to match, or be greater than @p str.
386 */
387int ly_strncmp(const char *refstr, const char *str, size_t str_len);
388
389/**
Radek Krejci1798aae2020-07-14 13:26:06 +0200390 * @brief Wrapper around strlen() to handle NULL strings.
391 */
392#define ly_strlen(STR) (STR ? strlen(STR) : 0)
393
394/**
Radek Krejcif13b87b2020-12-01 22:02:17 +0100395 * @brief Compile-time strlen() for string contants.
396 *
397 * Use to avoid magic numbers usage
398 */
399#define ly_strlen_const(STR) (sizeof STR - 1)
400
401#define ly_sizeofarray(ARRAY) (sizeof ARRAY / sizeof *ARRAY)
402
403/*
404 * Numerical bases for use in functions like strtoll() instead of magic numbers
405 */
406#define LY_BASE_DEC 10 /**< Decimal numeral base */
407#define LY_BASE_OCT 8 /**< Octal numeral base */
408#define LY_BASE_HEX 16 /**< Hexadecimal numeral base */
409
410/**
411 * Maximal length of (needed storage for) a number encoded as a string.
412 *
413 * Applies not only for standard numbers, but also for YANG's decimal64.
414 */
415#define LY_NUMBER_MAXLEN 22
416
417/**
Radek Krejcib416be62018-10-01 14:51:45 +0200418 * @brief Get UTF8 code point of the next character in the input string.
419 *
420 * @param[in,out] input Input string to process, updated according to the processed/read data.
421 * @param[out] utf8_char UTF8 code point of the next character.
422 * @param[out] bytes_read Number of bytes used to encode the read utf8_char.
423 * @return LY_ERR value
424 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100425LY_ERR ly_getutf8(const char **input, uint32_t *utf8_char, size_t *bytes_read);
Radek Krejcib416be62018-10-01 14:51:45 +0200426
427/**
Radek Krejci50f0c6b2020-06-18 16:31:48 +0200428 * Store UTF-8 character specified as 4byte integer into the dst buffer.
429 *
430 * UTF-8 mapping:
431 * 00000000 -- 0000007F: 0xxxxxxx
432 * 00000080 -- 000007FF: 110xxxxx 10xxxxxx
433 * 00000800 -- 0000FFFF: 1110xxxx 10xxxxxx 10xxxxxx
434 * 00010000 -- 001FFFFF: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
435 *
436 * Includes checking for valid characters (following RFC 7950, sec 9.4)
437 *
438 * @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.
439 * @param[in] value 32b value of the UTF-8 character to store.
440 * @param[out] bytes_written Number of bytes written into @p dst (size of the written UTF-8 character).
441 * @return LY_SUCCESS on success
442 * @return LY_EINVAL in case of invalid UTF-8 @p value to store.
443 */
444LY_ERR ly_pututf8(char *dst, uint32_t value, size_t *bytes_written);
445
446/**
Radek Krejci76c98012019-08-14 11:23:24 +0200447 * @brief Get number of characters in the @p str, taking multibyte characters into account.
448 * @param[in] str String to examine.
449 * @param[in] bytes Number of valid bytes that are supposed to be taken into account in @p str.
450 * This parameter is useful mainly for non NULL-terminated strings. In case of NULL-terminated
451 * string, strlen() can be used.
452 * @return Number of characters in (possibly) multibyte characters string.
453 */
454size_t ly_utf8len(const char *str, size_t bytes);
455
456/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100457 * @brief Parse signed integer with possible limitation.
458 * @param[in] val_str String value containing signed integer, note that
459 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200460 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100461 * @param[in] min Limitation for the value which must not be lower than min.
462 * @param[in] max Limitation for the value which must not be higher than max.
463 * @param[in] base Numeric base for parsing:
464 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
465 * 10 - to accept only decimal (e.g. data instance value)
466 * @param[out] ret Resulting value.
467 * @return LY_ERR value:
468 * LY_EDENIED - the value breaks the limits,
469 * LY_EVALID - string contains invalid value,
470 * LY_SUCCESS - successful parsing.
471 */
Radek Krejci249973a2019-06-10 10:50:54 +0200472LY_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 +0100473
474/**
475 * @brief Parse unsigned integer with possible limitation.
476 * @param[in] val_str String value containing unsigned integer, note that
477 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200478 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100479 * @param[in] max Limitation for the value which must not be higher than max.
480 * @param[in] base Numeric base for parsing:
481 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
482 * 10 - to accept only decimal (e.g. data instance value)
483 * @param[out] ret Resulting value.
484 * @return LY_ERR value:
485 * LY_EDENIED - the value breaks the limits,
486 * LY_EVALID - string contains invalid value,
487 * LY_SUCCESS - successful parsing.
488 */
Radek Krejci249973a2019-06-10 10:50:54 +0200489LY_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 +0100490
491/**
Radek Krejcib4a4a272019-06-10 12:44:52 +0200492 * @brief Parse a node-identifier.
493 *
494 * node-identifier = [prefix ":"] identifier
495 *
496 * @param[in, out] id Identifier to parse. When returned, it points to the first character which is not part of the identifier.
497 * @param[out] prefix Node's prefix, NULL if there is not any.
498 * @param[out] prefix_len Length of the node's prefix, 0 if there is not any.
499 * @param[out] name Node's name.
500 * @param[out] nam_len Length of the node's name.
501 * @return LY_ERR value: LY_SUCCESS or LY_EINVAL in case of invalid character in the id.
502 */
503LY_ERR ly_parse_nodeid(const char **id, const char **prefix, size_t *prefix_len, const char **name, size_t *name_len);
504
505/**
506 * @brief parse instance-identifier's predicate, supports key-predicate, leaf-list-predicate and pos rules from YANG ABNF Grammar.
507 *
508 * @param[in, out] pred Predicate string (including the leading '[') to parse. The string is updated according to what was parsed
509 * (even for error case, so it can be used to determine which substring caused failure).
510 * @param[in] limit Limiting length of the @p pred. Function expects NULL terminated string which is not overread.
511 * 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 +0200512 * @param[in] format Input format of the data containing the @p pred.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200513 * @param[out] prefix Start of the node-identifier's prefix if any, NULL in case of pos or leaf-list-predicate rules.
514 * @param[out] prefix_len Length of the parsed @p prefix.
515 * @param[out] id Start of the node-identifier's identifier string, NULL in case of pos rule, "." in case of leaf-list-predicate rule.
516 * @param[out] id_len Length of the parsed @p id.
Radek Krejci084289f2019-07-09 17:35:30 +0200517 * @param[out] value Start of the quoted-string (without quotation marks), not NULL in case of success.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200518 * @param[out] value_len Length of the parsed @p value.
519 * @param[out] errmsg Error message string in case of error.
520 * @return LY_SUCCESS in case a complete predicate was parsed.
521 * @return LY_EVALID in case of invalid predicate form.
522 * @return LY_EINVAL in case of reaching @p limit when parsing @p pred.
523 */
Radek Krejci084289f2019-07-09 17:35:30 +0200524LY_ERR ly_parse_instance_predicate(const char **pred, size_t limit, LYD_FORMAT format,
Radek Krejci0f969882020-08-21 16:56:47 +0200525 const char **prefix, size_t *prefix_len, const char **id, size_t *id_len,
526 const char **value, size_t *value_len, const char **errmsg);
Michal Vasko1324b6c2018-09-07 11:16:23 +0200527
Radek Krejcif345c012018-09-19 11:12:59 +0200528/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200529 * @brief mmap(2) wrapper to map input files into memory to unify parsing.
Radek Krejcif345c012018-09-19 11:12:59 +0200530 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200531 * The address space is allocate only for reading.
532 *
533 * @param[in] ctx libyang context for logging
534 * @param[in] fd Open file descriptor of a file to map.
535 * @param[out] length Allocated size.
536 * @param[out] addr Address where the file is mapped.
Radek Krejcif345c012018-09-19 11:12:59 +0200537 * @return LY_ERR value.
538 */
Radek Krejci86d106e2018-10-18 09:53:19 +0200539LY_ERR ly_mmap(struct ly_ctx *ctx, int fd, size_t *length, void **addr);
Michal Vasko841d1a92018-09-07 15:40:31 +0200540
Radek Krejci86d106e2018-10-18 09:53:19 +0200541/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200542 * @brief munmap(2) wrapper to free the memory mapped by ::ly_mmap()
Michal Vasko1324b6c2018-09-07 11:16:23 +0200543 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200544 * @param[in] addr Address where the input file is mapped.
545 * @param[in] length Allocated size of the address space.
546 * @return LY_ERR value.
547 */
548LY_ERR ly_munmap(void *addr, size_t length);
549
550/**
Radek Krejci4546aa62019-07-15 16:53:32 +0200551 * @brief Concatenate formating string to the @p dest.
552 *
553 * @param[in, out] dest String to be concatenated by @p format.
554 * Note that the input string can be reallocated during concatenation.
555 * @param[in] format Formating string (as for printf) which is supposed to be added after @p dest.
556 * @return LY_SUCCESS or LY_EMEM.
557 */
558LY_ERR ly_strcat(char **dest, const char *format, ...);
559
560/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200561 * @brief (Re-)Allocation of a ([sized array](@ref sizedarrays)).
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200562 *
Radek Krejci2c4e7172018-10-19 15:56:26 +0200563 * Increases the size information.
564 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200565 * @param[in] CTX libyang context for logging.
Radek Krejci2c4e7172018-10-19 15:56:26 +0200566 * @param[in,out] ARRAY Pointer to the array to allocate/resize. The size of the allocated
567 * space is counted from the type of the ARRAY, so do not provide placeholder void pointers.
Radek Krejci86d106e2018-10-18 09:53:19 +0200568 * @param[out] NEW_ITEM Returning pointer to the newly allocated record in the ARRAY.
569 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
Michal Vasko1324b6c2018-09-07 11:16:23 +0200570 */
Radek Krejci2c4e7172018-10-19 15:56:26 +0200571#define LY_ARRAY_NEW_RET(CTX, ARRAY, NEW_ITEM, RETVAL) \
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200572 if (!(ARRAY)) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200573 ARRAY = malloc(sizeof(LY_ARRAY_COUNT_TYPE) + sizeof *(ARRAY)); \
574 *((LY_ARRAY_COUNT_TYPE*)(ARRAY)) = 1; \
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200575 } else { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200576 ++(*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1)); \
577 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 +0200578 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
579 } \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200580 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
581 (NEW_ITEM) = &(ARRAY)[*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1) - 1]; \
Radek Krejci2c4e7172018-10-19 15:56:26 +0200582 memset(NEW_ITEM, 0, sizeof *(NEW_ITEM))
Michal Vasko1324b6c2018-09-07 11:16:23 +0200583
Radek Krejci2c4e7172018-10-19 15:56:26 +0200584/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100585 * @brief (Re-)Allocation of a ([sized array](@ref sizedarrays)).
586 *
587 * Increases the size information.
588 *
589 * @param[in] CTX libyang context for logging.
590 * @param[in,out] ARRAY Pointer to the array to allocate/resize. The size of the allocated
591 * space is counted from the type of the ARRAY, so do not provide placeholder void pointers.
592 * @param[out] NEW_ITEM Returning pointer to the newly allocated record in the ARRAY.
593 * @param[out] RET Variable to store error code.
594 * @param[in] GOTO Label to go in case of error (memory allocation failure).
595 */
596#define LY_ARRAY_NEW_GOTO(CTX, ARRAY, NEW_ITEM, RET, GOTO) \
597 if (!(ARRAY)) { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200598 ARRAY = malloc(sizeof(LY_ARRAY_COUNT_TYPE) + sizeof *(ARRAY)); \
599 *((LY_ARRAY_COUNT_TYPE*)(ARRAY)) = 1; \
Radek Krejci4f28eda2018-11-12 11:46:16 +0100600 } else { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200601 ++(*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1)); \
602 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 +0100603 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
604 } \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200605 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
606 (NEW_ITEM) = &(ARRAY)[*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1) - 1]; \
Radek Krejci4f28eda2018-11-12 11:46:16 +0100607 memset(NEW_ITEM, 0, sizeof *(NEW_ITEM))
608
609/**
Radek Krejci2c4e7172018-10-19 15:56:26 +0200610 * @brief Allocate a ([sized array](@ref sizedarrays)) for the specified number of items.
Radek Krejcic4fa0292020-05-14 10:54:49 +0200611 * If the ARRAY already exists, it is resized (space for SIZE items is added and zeroed).
Radek Krejci2c4e7172018-10-19 15:56:26 +0200612 *
613 * Does not set the size information, it is supposed to be incremented via ::LY_ARRAY_INCREMENT
614 * when the items are filled.
615 *
616 * @param[in] CTX libyang context for logging.
617 * @param[in,out] ARRAY Pointer to the array to create.
Radek Krejcid552f1b2020-12-09 13:56:01 +0100618 * @param[in] SIZE Number of the new items the array is supposed to hold. The size of the allocated
Radek Krejci2c4e7172018-10-19 15:56:26 +0200619 * space is then counted from the type of the ARRAY, so do not provide placeholder void pointers.
620 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
621 */
622#define LY_ARRAY_CREATE_RET(CTX, ARRAY, SIZE, RETVAL) \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100623 if (ARRAY) { \
Radek Krejcid552f1b2020-12-09 13:56:01 +0100624 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 +0100625 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200626 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
Radek Krejcid552f1b2020-12-09 13:56:01 +0100627 memset(&(ARRAY)[*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1)], 0, (SIZE) * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100628 } else { \
Radek Krejcid552f1b2020-12-09 13:56:01 +0100629 ARRAY = calloc(1, sizeof(LY_ARRAY_COUNT_TYPE) + (SIZE) * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100630 LY_CHECK_ERR_RET(!(ARRAY), LOGMEM(CTX), RETVAL); \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200631 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100632 }
Radek Krejci2c4e7172018-10-19 15:56:26 +0200633
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100634/**
635 * @brief Allocate a ([sized array](@ref sizedarrays)) for the specified number of items.
Radek Krejcid05cbd92018-12-05 14:26:40 +0100636 * If the ARRAY already exists, it is resized (space for SIZE items is added).
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100637 *
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200638 * Does not set the count information, it is supposed to be incremented via ::LY_ARRAY_INCREMENT
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100639 * when the items are filled.
640 *
641 * @param[in] CTX libyang context for logging.
642 * @param[in,out] ARRAY Pointer to the array to create.
Radek Krejci00b874b2019-02-12 10:54:50 +0100643 * @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 +0100644 * space is then counted from the type of the ARRAY, so do not provide placeholder void pointers.
645 * @param[out] RET Variable to store error code.
646 * @param[in] GOTO Label to go in case of error (memory allocation failure).
647 */
648#define LY_ARRAY_CREATE_GOTO(CTX, ARRAY, SIZE, RET, GOTO) \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100649 if (ARRAY) { \
Radek Krejci6a205692020-12-09 13:58:22 +0100650 ARRAY = ly_realloc(((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1), sizeof(LY_ARRAY_COUNT_TYPE) + ((LY_ARRAY_COUNT(ARRAY) + (SIZE)) * sizeof *(ARRAY))); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100651 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200652 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
653 memset(&(ARRAY)[*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1)], 0, (SIZE) * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100654 } else { \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200655 ARRAY = calloc(1, sizeof(LY_ARRAY_COUNT_TYPE) + (SIZE) * sizeof *(ARRAY)); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100656 LY_CHECK_ERR_GOTO(!(ARRAY), LOGMEM(CTX); RET = LY_EMEM, GOTO); \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200657 ARRAY = (void*)((LY_ARRAY_COUNT_TYPE*)(ARRAY) + 1); \
Radek Krejcid05cbd92018-12-05 14:26:40 +0100658 }
Radek Krejci6d6e4e42018-10-29 13:28:19 +0100659
Radek Krejcic4fa0292020-05-14 10:54:49 +0200660/**
Radek Krejcic4fa0292020-05-14 10:54:49 +0200661 * @brief Increment the items counter in a ([sized array](@ref sizedarrays)).
662 *
663 * Does not change the allocated memory used by the ARRAY. To do so, use LY_ARRAY_CREATE_RET,
664 * LY_ARRAY_CREATE_GOTO or LY_ARRAY_RESIZE_ERR_RET.
665 *
666 * @param[in] ARRAY Pointer to the array to affect.
667 */
668#define LY_ARRAY_INCREMENT(ARRAY) \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200669 ++(*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1))
Radek Krejcic4fa0292020-05-14 10:54:49 +0200670
671/**
672 * @brief Decrement the items counter in a ([sized array](@ref sizedarrays)).
673 *
674 * Does not change the allocated memory used by the ARRAY. To do so, use LY_ARRAY_CREATE_RET,
675 * LY_ARRAY_CREATE_GOTO or LY_ARRAY_RESIZE_ERR_RET.
676 *
677 * @param[in] ARRAY Pointer to the array to affect.
678 */
Radek Krejciccd20f12019-02-15 14:12:27 +0100679#define LY_ARRAY_DECREMENT(ARRAY) \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200680 --(*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1))
Radek Krejciccd20f12019-02-15 14:12:27 +0100681
Radek Krejci2c4e7172018-10-19 15:56:26 +0200682/**
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100683 * @brief Decrement the items counter in a ([sized array](@ref sizedarrays)) and free the whole array
684 * in case it was decremented to 0.
685 *
686 * @param[in] ARRAY Pointer to the array to affect.
687 */
688#define LY_ARRAY_DECREMENT_FREE(ARRAY) \
689 --(*((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1)); \
690 if (!LY_ARRAY_COUNT(ARRAY)) { \
691 LY_ARRAY_FREE(ARRAY); \
692 (ARRAY) = NULL; \
693 }
694
695/**
Radek Krejci2c4e7172018-10-19 15:56:26 +0200696 * @brief Free the space allocated for the ([sized array](@ref sizedarrays)).
697 *
698 * The items inside the array are not freed.
699 *
700 * @param[in] ARRAY A ([sized array](@ref sizedarrays)) to be freed.
701 */
702#define LY_ARRAY_FREE(ARRAY) \
Michal Vaskofd69e1d2020-07-03 11:57:17 +0200703 if (ARRAY){free((LY_ARRAY_COUNT_TYPE*)(ARRAY) - 1);}
David Sedlák8d552d62019-08-06 15:29:05 +0200704
David Sedlák26ea1432019-08-14 13:42:23 +0200705/**
David Sedlákaa98bba2019-09-12 11:52:14 +0200706 * @brief Insert item into linked list.
David Sedlák26ea1432019-08-14 13:42:23 +0200707 *
708 * @param[in,out] LIST Linked list to add to.
709 * @param[in] NEW_ITEM New item, that will be appended to the list, must be already allocated.
710 * @param[in] LINKER name of structuin member that is used to connect items together.
711 */
David Sedlák8d552d62019-08-06 15:29:05 +0200712#define LY_LIST_INSERT(LIST, NEW_ITEM, LINKER)\
713 if (!(*LIST)) { \
714 *LIST = (__typeof__(*(LIST)))NEW_ITEM; \
715 } else { \
716 do { \
717 __typeof__(*(LIST)) iterator; \
Radek Krejci1e008d22020-08-17 11:37:37 +0200718 for (iterator = *(LIST); iterator->LINKER; iterator = iterator->LINKER) {} \
David Sedlák8d552d62019-08-06 15:29:05 +0200719 iterator->LINKER = (__typeof__(*(LIST)))NEW_ITEM; \
720 } while (0); \
721 }
722
David Sedlák26ea1432019-08-14 13:42:23 +0200723/**
David Sedlákaa98bba2019-09-12 11:52:14 +0200724 * @brief Allocate and insert new item into linked list, return in case of error.
David Sedlák26ea1432019-08-14 13:42:23 +0200725 *
David Sedláke6284fc2019-09-10 11:57:02 +0200726 * @param[in] CTX used for logging.
727 * @param[in,out] LIST Linked list to add to.
728 * @param[out] NEW_ITEM New item that is appended to the list.
729 * @param[in] LINKER name of structure member that is used to connect items together.
David Sedlákfbe240f2019-09-13 11:18:53 +0200730 * @param[in] RETVAL Return value for the case of error (memory allocation failure).
David Sedlák26ea1432019-08-14 13:42:23 +0200731 */
David Sedlákb9eeb9c2019-09-13 11:17:19 +0200732#define LY_LIST_NEW_RET(CTX, LIST, NEW_ITEM, LINKER, RETVAL) \
David Sedlák8d552d62019-08-06 15:29:05 +0200733 NEW_ITEM = calloc(1, sizeof *NEW_ITEM); \
David Sedlákb9eeb9c2019-09-13 11:17:19 +0200734 LY_CHECK_ERR_RET(!(NEW_ITEM), LOGMEM(CTX), RETVAL); \
David Sedlák8d552d62019-08-06 15:29:05 +0200735 LY_LIST_INSERT(LIST, NEW_ITEM, LINKER)
736
David Sedláke6284fc2019-09-10 11:57:02 +0200737/**
David Sedlákaa98bba2019-09-12 11:52:14 +0200738 * @brief Allocate and insert new item into linked list, goto specified label in case of error.
David Sedláke6284fc2019-09-10 11:57:02 +0200739 *
740 * @param[in] CTX used for logging.
741 * @param[in,out] LIST Linked list to add to.
742 * @param[out] NEW_ITEM New item that is appended to the list.
743 * @param[in] LINKER name of structure member that is used to connect items together.
744 * @param[in] RET variable to store returned error type.
745 * @param[in] LABEL label to goto in case of error.
746 */
747#define LY_LIST_NEW_GOTO(CTX, LIST, NEW_ITEM, LINKER, RET, LABEL) \
748 NEW_ITEM = calloc(1, sizeof *NEW_ITEM); \
749 LY_CHECK_ERR_GOTO(!(NEW_ITEM), RET = LY_EMEM; LOGMEM(CTX), LABEL); \
750 LY_LIST_INSERT(LIST, NEW_ITEM, LINKER)
751
David Sedláke6cd89e2019-08-07 12:46:02 +0200752#endif /* LY_COMMON_H_ */