blob: 478c6d09fa539e2dd6d0705b7cf740663388111e [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 Krejci6caa6ab2018-10-24 10:04:48 +020023#include "hash_table.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020024#include "log.h"
25#include "set.h"
Radek Krejci535ea9f2020-05-29 16:01:05 +020026#include "tree_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020027
28struct ly_ctx;
Radek Krejciaddfc9a2020-12-17 20:46:35 +010029struct ly_in;
Radek Krejci77114102021-03-10 15:21:57 +010030struct lysc_node;
Radek Krejci5aeea3a2018-09-05 13:29:36 +020031
32#if __STDC_VERSION__ >= 201112 && !defined __STDC_NO_THREADS__
33# define THREAD_LOCAL _Thread_local
34#elif defined __GNUC__ || \
Radek Krejci0f969882020-08-21 16:56:47 +020035 defined __SUNPRO_C || \
36 defined __xlC__
Radek Krejci5aeea3a2018-09-05 13:29:36 +020037# define THREAD_LOCAL __thread
38#else
39# error "Cannot define THREAD_LOCAL"
40#endif
41
Radek Krejcic59bc972018-09-17 16:13:06 +020042#define GETMACRO1(_1, NAME, ...) NAME
Radek Krejci5aeea3a2018-09-05 13:29:36 +020043#define GETMACRO2(_1, _2, NAME, ...) NAME
44#define GETMACRO3(_1, _2, _3, NAME, ...) NAME
45#define GETMACRO4(_1, _2, _3, _4, NAME, ...) NAME
Michal Vaskodc779a82019-11-06 15:44:06 +010046#define GETMACRO5(_1, _2, _3, _4, _5, NAME, ...) NAME
Michal Vaskoe0665742021-02-11 11:08:44 +010047#define GETMACRO6(_1, _2, _3, _4, _5, _6, NAME, ...) NAME
Radek Krejci5aeea3a2018-09-05 13:29:36 +020048
49/*
Radek Krejcic59bc972018-09-17 16:13:06 +020050 * If the compiler supports attribute to mark objects as hidden, mark all
51 * objects as hidden and export only objects explicitly marked to be part of
52 * the public API.
Radek Krejci5aeea3a2018-09-05 13:29:36 +020053 */
Radek Krejcic59bc972018-09-17 16:13:06 +020054#define API __attribute__((visibility("default")))
55
56/******************************************************************************
57 * Logger
58 *****************************************************************************/
Radek Krejci5aeea3a2018-09-05 13:29:36 +020059
Radek Krejci52b6d512020-10-12 12:33:17 +020060extern volatile LY_LOG_LEVEL ly_ll;
Radek Krejci1deb5be2020-08-26 16:43:36 +020061extern volatile uint32_t ly_log_opts;
Radek Krejci5aeea3a2018-09-05 13:29:36 +020062
Radek Krejciaddfc9a2020-12-17 20:46:35 +010063struct ly_log_location_s {
64 uint64_t line; /**< One-time line value being reset after use - replaces whatever is in inputs */
65 struct ly_set inputs; /**< Set of const struct ly_in *in pointers providing the input handler with the line information (LIFO) */
66 struct ly_set scnodes; /**< Set of const struct lysc_node *scnode pointers providing the compiled schema node to generate path (LIFO) */
67 struct ly_set dnodes; /**< Set of const struct lyd_node *dnode pointers providing the data node to generate path (LIFO) */
68 struct ly_set paths; /**< Set of path strings (LIFO) */
69};
70
71/**
Radek Krejcie7b95092019-05-15 11:03:07 +020072 * @brief Print a log message and store it into the context (if provided).
73 *
74 * @param[in] ctx libyang context to store the error record. If not provided, the error is just printed.
75 * @param[in] level Log message level (error, warning, etc.)
76 * @param[in] no Error type code.
77 * @param[in] format Format string to print.
78 */
Radek Krejci5aeea3a2018-09-05 13:29:36 +020079void ly_log(const struct ly_ctx *ctx, LY_LOG_LEVEL level, LY_ERR no, const char *format, ...);
Radek Krejcie7b95092019-05-15 11:03:07 +020080
81/**
82 * @brief Print Validation error and store it into the context (if provided).
83 *
84 * @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 +020085 * @param[in] code Validation error code.
86 * @param[in] format Format string to print.
87 */
Radek Krejci2efc45b2020-12-22 16:25:44 +010088void ly_vlog(const struct ly_ctx *ctx, LY_VECODE code, const char *format, ...);
Radek Krejci5aeea3a2018-09-05 13:29:36 +020089
Radek Krejciaddfc9a2020-12-17 20:46:35 +010090/**
91 * @brief Logger's location data setter.
92 *
Radek Krejciaddfc9a2020-12-17 20:46:35 +010093 * @param[in] scnode Compiled schema node.
94 * @param[in] dnode Data node.
95 * @param[in] path Direct path string to print.
96 * @param[in] in Input handler (providing line number)
97 * @param[in] line One-time line value to be reset when used.
98 * @param[in] reset Flag to indicate if the not set arguments (NULLs) are intended to rewrite the current values or if they
99 * are supposed to be ignored and the previous values should be kept.
100 */
Radek Krejciddace2c2021-01-08 11:30:56 +0100101void ly_log_location(const struct lysc_node *scnode, const struct lyd_node *dnode,
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100102 const char *path, const struct ly_in *in, uint64_t line, ly_bool reset);
103
104/**
105 * @brief Revert the specific logger's location data by number of changes made by ::ly_log_location().
106 *
Radek Krejciddace2c2021-01-08 11:30:56 +0100107 * @param[in] scnode_steps Number of items in ::log_location.scnodes to forget.
108 * @param[in] dnode_steps Number of items in ::log_location.dnodes to forget.
109 * @param[in] path_steps Number of path strings in ::log_location.paths to forget.
110 * @param[in] in_steps Number of input handlers ::log_location.inputs to forget.
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100111 */
Radek Krejciddace2c2021-01-08 11:30:56 +0100112void ly_log_location_revert(uint32_t scnode_steps, uint32_t dnode_steps, uint32_t path_steps, uint32_t in_steps);
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100113
114/**
115 * @brief Initiate location data for logger, all arguments are set as provided (even NULLs) - overrides the current values.
116 *
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100117 * @param[in] SCNODE Compiled schema node.
118 * @param[in] DNODE Data node.
119 * @param[in] PATH Direct path string to print.
120 * @param[in] IN Input handler (providing line number)
121 */
Radek Krejciddace2c2021-01-08 11:30:56 +0100122#define LOG_LOCINIT(SCNODE, DNODE, PATH, IN) \
123 ly_log_location(SCNODE, DNODE, PATH, IN, 0, 1)
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100124
125/**
126 * @brief Update location data for logger, not provided arguments (NULLs) are kept (does not override).
127 *
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100128 * @param[in] SCNODE Compiled schema node.
129 * @param[in] DNODE Data node.
130 * @param[in] PATH Direct path string to print.
131 * @param[in] IN Input handler (providing line number)
132 */
Radek Krejciddace2c2021-01-08 11:30:56 +0100133#define LOG_LOCSET(SCNODE, DNODE, PATH, IN) \
134 ly_log_location(SCNODE, DNODE, PATH, IN, 0, 0)
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100135
Radek Krejciddace2c2021-01-08 11:30:56 +0100136/**
137 * @brief Update location data for logger, not provided arguments (NULLs) are kept (does not override).
138 *
139 * @param[in] SCNODE_STEPS Number of the compiled schema nodes to remove from the stack.
140 * @param[in] DNODE_STEPS Number of the data nodes to remove from the stack.
141 * @param[in] PATH_STEPS Number of the direct path strings to remove from the stack.
142 * @param[in] IN_STEPS Number of the input handlers (providing line number) to remove from the stack.
143 */
144#define LOG_LOCBACK(SCNODE_STEPS, DNODE_STEPS, PATH_STEPS, IN_STEPS) \
145 ly_log_location_revert(SCNODE_STEPS, DNODE_STEPS, PATH_STEPS, IN_STEPS)
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100146
Radek Krejcic0c66412020-08-21 13:53:50 +0200147#define LOGERR(ctx, errno, str, ...) ly_log(ctx, LY_LLERR, errno, str, ##__VA_ARGS__)
Radek Krejcif3f47842018-11-15 11:22:15 +0100148#define LOGWRN(ctx, str, ...) ly_log(ctx, LY_LLWRN, 0, str, ##__VA_ARGS__)
Radek Krejcic0c66412020-08-21 13:53:50 +0200149#define LOGVRB(str, ...) ly_log(NULL, LY_LLVRB, 0, str, ##__VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200150
Radek Krejci4ab61562018-09-05 15:00:37 +0200151#ifdef NDEBUG
Radek Krejcic0c66412020-08-21 13:53:50 +0200152# define LOGDBG(dbg_group, str, ...)
Radek Krejci4ab61562018-09-05 15:00:37 +0200153#else
Radek Krejci1deb5be2020-08-26 16:43:36 +0200154void ly_log_dbg(uint32_t group, const char *format, ...);
Radek Krejcic0c66412020-08-21 13:53:50 +0200155# define LOGDBG(dbg_group, str, ...) ly_log_dbg(dbg_group, str, ##__VA_ARGS__);
Radek Krejci4ab61562018-09-05 15:00:37 +0200156#endif
157
Radek Krejcie2692202020-12-01 14:21:12 +0100158/**
159 * Simple EMEM message, it can be safely stored in ::ly_err_item structures without problems when freeing.
160 */
161#define LY_EMEM_MSG "Memory allocation failed."
162
Radek Krejci859a15a2021-03-05 20:56:59 +0100163#ifdef LOGMEM
164/* overwrite shadow definition from tree_edit.h */
165#undef LOGMEM
166#endif
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200167#define LOGMEM(CTX) LOGERR(CTX, LY_EMEM, "Memory allocation failed (%s()).", __func__)
Radek Krejci859a15a2021-03-05 20:56:59 +0100168
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200169#define LOGINT(CTX) LOGERR(CTX, LY_EINT, "Internal error (%s:%d).", __FILE__, __LINE__)
170#define LOGARG(CTX, ARG) LOGERR(CTX, LY_EINVAL, "Invalid argument %s (%s()).", #ARG, __func__)
Radek Krejci2efc45b2020-12-22 16:25:44 +0100171#define LOGVAL(CTX, CODE, ...) ly_vlog(CTX, CODE, ##__VA_ARGS__)
172#define LOGVAL_LINE(CTX, LINE, CODE, ...) \
Radek Krejciddace2c2021-01-08 11:30:56 +0100173 ly_log_location(NULL, NULL, NULL, NULL, LINE, 0); \
Radek Krejci2efc45b2020-12-22 16:25:44 +0100174 ly_vlog(CTX, CODE, ##__VA_ARGS__)
Radek Krejci94aa9942018-09-07 17:12:17 +0200175
176#define LOGMEM_RET(CTX) LOGMEM(CTX); return LY_EMEM
177#define LOGINT_RET(CTX) LOGINT(CTX); return LY_EINT
178#define LOGARG_RET(CTX) LOGARG(CTX); return LY_EINVAL
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200179
180/*
181 * Common code to check return value and perform appropriate action.
182 */
Radek Krejcie88beef2019-05-30 15:47:19 +0200183#define LY_CHECK_GOTO(COND, GOTO) if ((COND)) {goto GOTO;}
184#define LY_CHECK_ERR_GOTO(COND, ERR, GOTO) if ((COND)) {ERR; goto GOTO;}
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100185#define LY_CHECK_RET1(RETVAL) {LY_ERR ret__ = RETVAL;if (ret__ != LY_SUCCESS) {return ret__;}}
Radek Krejcie88beef2019-05-30 15:47:19 +0200186#define LY_CHECK_RET2(COND, RETVAL) if ((COND)) {return RETVAL;}
Radek Krejcic59bc972018-09-17 16:13:06 +0200187#define LY_CHECK_RET(...) GETMACRO2(__VA_ARGS__, LY_CHECK_RET2, LY_CHECK_RET1)(__VA_ARGS__)
Radek Krejcie88beef2019-05-30 15:47:19 +0200188#define LY_CHECK_ERR_RET(COND, ERR, RETVAL) if ((COND)) {ERR; return RETVAL;}
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200189
Radek Krejcia3045382018-11-22 14:30:31 +0100190#define LY_CHECK_ARG_GOTO1(CTX, ARG, GOTO) if (!(ARG)) {LOGARG(CTX, ARG);goto GOTO;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200191#define LY_CHECK_ARG_GOTO2(CTX, ARG1, ARG2, GOTO) LY_CHECK_ARG_GOTO1(CTX, ARG1, GOTO);LY_CHECK_ARG_GOTO1(CTX, ARG2, GOTO)
192#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 +0100193#define LY_CHECK_ARG_GOTO4(CTX, ARG1, ARG2, ARG3, ARG4, GOTO) LY_CHECK_ARG_GOTO3(CTX, ARG1, ARG2, ARG3, GOTO);\
194 LY_CHECK_ARG_GOTO1(CTX, ARG4, GOTO)
195#define LY_CHECK_ARG_GOTO(CTX, ...) GETMACRO5(__VA_ARGS__, LY_CHECK_ARG_GOTO4, LY_CHECK_ARG_GOTO3, LY_CHECK_ARG_GOTO2, \
196 LY_CHECK_ARG_GOTO1)(CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200197
Radek Krejcia3045382018-11-22 14:30:31 +0100198#define LY_CHECK_ARG_RET1(CTX, ARG, RETVAL) if (!(ARG)) {LOGARG(CTX, ARG);return RETVAL;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200199#define LY_CHECK_ARG_RET2(CTX, ARG1, ARG2, RETVAL) LY_CHECK_ARG_RET1(CTX, ARG1, RETVAL);LY_CHECK_ARG_RET1(CTX, ARG2, RETVAL)
200#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 +0100201#define LY_CHECK_ARG_RET4(CTX, ARG1, ARG2, ARG3, ARG4, RETVAL) LY_CHECK_ARG_RET3(CTX, ARG1, ARG2, ARG3, RETVAL);\
202 LY_CHECK_ARG_RET1(CTX, ARG4, RETVAL)
Michal Vaskoe0665742021-02-11 11:08:44 +0100203#define LY_CHECK_ARG_RET5(CTX, ARG1, ARG2, ARG3, ARG4, ARG5, RETVAL) LY_CHECK_ARG_RET4(CTX, ARG1, ARG2, ARG3, ARG4, RETVAL);\
204 LY_CHECK_ARG_RET1(CTX, ARG5, RETVAL)
205#define LY_CHECK_ARG_RET(CTX, ...) GETMACRO6(__VA_ARGS__, LY_CHECK_ARG_RET5, LY_CHECK_ARG_RET4, LY_CHECK_ARG_RET3, \
206 LY_CHECK_ARG_RET2, LY_CHECK_ARG_RET1) (CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200207
Radek Krejcid972c252018-09-25 13:23:39 +0200208/* count sequence size for LY_VCODE_INCHILDSTMT validation error code */
209size_t LY_VCODE_INSTREXP_len(const char *str);
210/* default maximum characters to print in LY_VCODE_INCHILDSTMT */
211#define LY_VCODE_INSTREXP_MAXLEN 20
212
Michal Vaskoecd62de2019-11-13 12:35:11 +0100213#define LY_VCODE_INCHAR LYVE_SYNTAX, "Invalid character 0x%x."
214#define LY_VCODE_INSTREXP LYVE_SYNTAX, "Invalid character sequence \"%.*s\", expected %s."
215#define LY_VCODE_EOF LYVE_SYNTAX, "Unexpected end-of-input."
216#define LY_VCODE_NTERM LYVE_SYNTAX, "%s not terminated."
217#define LY_VCODE_NSUPP LYVE_SYNTAX, "%s not supported."
218#define LY_VCODE_MOD_SUBOMD LYVE_SYNTAX, "Invalid keyword \"%s\", expected \"module\" or \"submodule\"."
219#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 +0200220#define LY_VCODE_TRAILING_SUBMOD LYVE_SYNTAX, "Trailing garbage \"%.*s%s\" after submodule, expected end-of-input."
221
Michal Vaskoecd62de2019-11-13 12:35:11 +0100222#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 +0100223#define LY_VCODE_NAME_COL LYVE_SEMANTICS, "Name collision between %s of name \"%s\"."
224#define LY_VCODE_NAME2_COL LYVE_SEMANTICS, "Name collision between %s and %s of name \"%s\"."
David Sedlák0c2bab92019-07-22 15:33:19 +0200225
Michal Vaskoecd62de2019-11-13 12:35:11 +0100226#define LY_VCODE_INSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\"."
227#define LY_VCODE_INCHILDSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\" as a child of \"%s\"."
228#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 +0100229#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 +0100230#define LY_VCODE_DUPSTMT LYVE_SYNTAX_YANG, "Duplicate keyword \"%s\"."
231#define LY_VCODE_DUPIDENT LYVE_SYNTAX_YANG, "Duplicate identifier \"%s\" of %s statement."
232#define LY_VCODE_INVAL LYVE_SYNTAX_YANG, "Invalid value \"%.*s\" of \"%s\"."
233#define LY_VCODE_MISSTMT LYVE_SYNTAX_YANG, "Missing mandatory keyword \"%s\" as a child of \"%s\"."
234#define LY_VCODE_MISSCHILDSTMT LYVE_SYNTAX_YANG, "Missing %s substatement for %s%s."
235#define LY_VCODE_INORD LYVE_SYNTAX_YANG, "Invalid keyword \"%s\", it cannot appear after \"%s\"."
236#define LY_VCODE_OOB LYVE_SYNTAX_YANG, "Value \"%.*s\" is out of \"%s\" bounds."
237#define LY_VCODE_INDEV LYVE_SYNTAX_YANG, "Deviate \"%s\" does not support keyword \"%s\"."
238#define LY_VCODE_INREGEXP LYVE_SYNTAX_YANG, "Regular expression \"%s\" is not valid (\"%s\": %s)."
David Sedlák0c2bab92019-07-22 15:33:19 +0200239
Michal Vaskoecd62de2019-11-13 12:35:11 +0100240#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."
241#define LY_VCODE_INVAL_YIN LYVE_SYNTAX_YIN, "Invalid value \"%s\" of \"%s\" attribute in \"%s\" element."
242#define LY_VCODE_UNEXP_SUBELEM LYVE_SYNTAX_YIN, "Unexpected sub-element \"%.*s\" of \"%s\" element."
243#define LY_VCODE_INDEV_YIN LYVE_SYNTAX_YIN, "Deviate of this type doesn't allow \"%s\" as it's sub-element."
244#define LY_VCODE_INORDER_YIN LYVE_SYNTAX_YIN, "Invalid order of %s\'s sub-elements \"%s\" can't appear after \"%s\"."
245#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 +0200246#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 +0100247#define LY_VCODE_DUP_ATTR LYVE_SYNTAX_YIN, "Duplicit definition of \"%s\" attribute in \"%s\" element."
248#define LY_VCODE_UNEXP_ATTR LYVE_SYNTAX_YIN, "Unexpected attribute \"%.*s\" of \"%s\" element."
249#define LY_VCODE_MAND_SUBELEM LYVE_SYNTAX_YIN, "Missing mandatory sub-element \"%s\" of \"%s\" element."
250#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 +0100251#define LY_VCODE_SUBELEM_REDEF LYVE_SYNTAX_YIN, "Redefinition of \"%s\" sub-element in \"%s\" element."
David Sedlák0c2bab92019-07-22 15:33:19 +0200252
Michal Vaskoecd62de2019-11-13 12:35:11 +0100253#define LY_VCODE_XP_EOE LYVE_XPATH, "Unterminated string delimited with %c (%.15s)."
Michal Vasko774ce402021-04-14 15:35:06 +0200254#define LY_VCODE_XP_INEXPR LYVE_XPATH, "Invalid character '%c'[%u] of expression \'%s\'."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100255#define LY_VCODE_XP_EOF LYVE_XPATH, "Unexpected XPath expression end."
Michal Vasko0b468e62020-10-19 09:33:04 +0200256#define LY_VCODE_XP_INTOK LYVE_XPATH, "Unexpected XPath token \"%s\" (\"%.15s\")."
257#define LY_VCODE_XP_INTOK2 LYVE_XPATH, "Unexpected XPath token \"%s\" (\"%.15s\"), expected \"%s\"."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100258#define LY_VCODE_XP_INFUNC LYVE_XPATH, "Unknown XPath function \"%.*s\"."
259#define LY_VCODE_XP_INARGCOUNT LYVE_XPATH, "Invalid number of arguments (%d) for the XPath function %.*s."
260#define LY_VCODE_XP_INARGTYPE LYVE_XPATH, "Wrong type of argument #%d (%s) for the XPath function %s."
261#define LY_VCODE_XP_INCTX LYVE_XPATH, "Invalid context type %s in %s."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100262#define LY_VCODE_XP_INOP_1 LYVE_XPATH, "Cannot apply XPath operation %s on %s."
263#define LY_VCODE_XP_INOP_2 LYVE_XPATH, "Cannot apply XPath operation %s on %s and %s."
Michal Vasko004d3152020-06-11 19:59:22 +0200264#define LY_VCODE_XP_INMOD LYVE_XPATH, "Unknown/non-implemented module \"%.*s\"."
David Sedlák0c2bab92019-07-22 15:33:19 +0200265
Radek Krejci327de162019-06-14 12:52:07 +0200266#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 +0200267
Michal Vasko538b8952021-02-17 11:27:26 +0100268#define LY_VCODE_NOWHEN LYVE_DATA, "When condition \"%s\" not satisfied."
269#define LY_VCODE_NOMAND LYVE_DATA, "Mandatory node \"%s\" instance does not exist."
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 Vasko224e7772021-02-18 14:22:33 +0100272#define LY_VCODE_UNEXPNODE LYVE_DATA, "Unexpected data %s 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 Krejci07a55962021-03-02 20:16:43 +0100275#define LY_ERRMSG_NOPATTERN /* LYVE_DATA */ "Unsatisfied pattern - \"%.*s\" does not conform to %s\"%s\"."
276#define LY_ERRMSG_NOLENGTH /* LYVE_DATA */ "Unsatisfied length - string length \"%s\" is not allowed."
277#define LY_ERRMSG_NORANGE /* LYVE_DATA */ "Unsatisfied range - value \"%s\" is out of the allowed range."
Michal Vasko224e7772021-02-18 14:22:33 +0100278
279/* RFC 7950 section 15 errors */
280#define LY_VCODE_NOUNIQ LYVE_DATA, "Unique data leaf(s) \"%s\" not satisfied in \"%s\" and \"%s\"."
281#define LY_VCODE_NOMAX LYVE_DATA, "Too many \"%s\" instances."
282#define LY_VCODE_NOMIN LYVE_DATA, "Too few \"%s\" instances."
283#define LY_VCODE_NOMUST LYVE_DATA, "Must condition \"%s\" not satisfied."
284#define LY_VCODE_NOMAND_CHOIC LYVE_DATA, "Mandatory choice \"%s\" data do not exist."
285
286/* RFC 7950 section 15 error messages used in type plugin validation callbacks */
Radek Krejci07a55962021-03-02 20:16:43 +0100287#define LY_ERRMSG_NOLREF_VAL /* LYVE_DATA */ "Invalid leafref value \"%s\" - no target instance \"%s\" with the same value."
288#define LY_ERRMSG_NOLREF_INST /* LYVE_DATA */ "Invalid leafref value \"%s\" - no existing target instance \"%s\"."
289#define LY_ERRMSG_NOINST /* LYVE_DATA */ "Invalid instance-identifier \"%s\" value - required instance not found."
Michal Vasko224e7772021-02-18 14:22:33 +0100290
Radek Krejcic59bc972018-09-17 16:13:06 +0200291/******************************************************************************
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200292 * Context
293 *****************************************************************************/
294
295/**
296 * @brief Context of the YANG schemas
297 */
298struct ly_ctx {
299 struct dict_table dict; /**< dictionary to effectively store strings used in the context related structures */
300 struct ly_set search_paths; /**< set of directories where to search for schema's imports/includes */
Michal Vasko89b5c072020-10-06 13:52:44 +0200301 struct ly_set list; /**< set of loaded YANG schemas */
Radek Krejcid33273d2018-10-25 14:55:52 +0200302 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 +0200303 void *imp_clb_data; /**< Optional private data for ::ly_ctx.imp_clb */
Michal Vasko794ab4b2021-03-31 09:42:19 +0200304 uint16_t change_count; /**< Count of changes of the context, on some changes it could be incremented more times */
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200305 uint16_t flags; /**< context settings, see @ref contextoptions. */
306 pthread_key_t errlist_key; /**< key for the thread-specific list of errors related to the context */
Michal Vasko11f76c82021-04-15 14:36:14 +0200307 pthread_mutex_t lyb_hash_lock; /**< lock for storing LYB schema hashes in schema nodes */
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200308};
309
Radek Krejcid33273d2018-10-25 14:55:52 +0200310/**
Radek Krejci0ad51f12020-07-16 12:08:12 +0200311 * @brief Get the (only) implemented YANG module specified by its name.
312 *
313 * @param[in] ctx Context where to search.
314 * @param[in] name Name of the YANG module to get.
315 * @param[in] name_len Optional length of the @p name. If zero, NULL-terminated name is expected.
316 * @return The only implemented YANG module revision of the given name in the given context. NULL if there is no
317 * implemented module of the given name.
318 */
319struct lys_module *ly_ctx_get_module_implemented2(const struct ly_ctx *ctx, const char *name, size_t name_len);
320
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200321/******************************************************************************
Michal Vasko1324b6c2018-09-07 11:16:23 +0200322 * Generic useful functions.
Radek Krejcic59bc972018-09-17 16:13:06 +0200323 *****************************************************************************/
Michal Vasko1324b6c2018-09-07 11:16:23 +0200324
Michal Vaskob36053d2020-03-26 15:49:30 +0100325/**
326 * @brief Insert string into dictionary.
327 *
328 * @param[in] CTX libyang context.
329 * @param[in] STRING string to store.
330 * @param[in] LEN length of the string in WORD to store.
331 * @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.
332 */
Radek Krejci011e4aa2020-09-04 15:22:31 +0200333#define INSERT_STRING_RET(CTX, STRING, LEN, DYNAMIC, TARGET) \
334 if (DYNAMIC) { \
335 LY_CHECK_RET(lydict_insert_zc(CTX, (char *)(STRING), &(TARGET))); \
336 } else { \
337 LY_CHECK_RET(lydict_insert(CTX, LEN ? (STRING) : "", LEN, &(TARGET))); \
338 } \
339 DYNAMIC = 0
Michal Vaskob36053d2020-03-26 15:49:30 +0100340
Michal Vasko1324b6c2018-09-07 11:16:23 +0200341/**
342 * @brief Wrapper for realloc() call. The only difference is that if it fails to
343 * allocate the requested memory, the original memory is freed as well.
344 *
345 * @param[in] ptr Memory to reallocate.
346 * @param[in] size New size of the memory block.
347 *
348 * @return Pointer to the new memory, NULL on error.
349 */
350void *ly_realloc(void *ptr, size_t size);
351
Radek Krejcif345c012018-09-19 11:12:59 +0200352/**
Michal Vasko03ff5a72019-09-11 13:49:33 +0200353 * @brief Just like strchr() function except limit the number of examined characters.
354 *
355 * @param[in] s String to search in.
356 * @param[in] c Character to search for.
357 * @param[in] len Limit the search to this number of characters in @p s.
358 * @return Pointer to first @p c occurence in @p s, NULL if not found in first @p len characters.
359 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200360char *ly_strnchr(const char *s, int c, size_t len);
Michal Vasko03ff5a72019-09-11 13:49:33 +0200361
362/**
Radek Krejci7f9b6512019-09-18 13:11:09 +0200363 * @brief Compare NULL-terminated @p refstr with @str_len bytes from @p str.
364 *
365 * @param[in] refstr NULL-terminated string which must match @str_len bytes from @str followed by NULL-byte.
366 * @param[in] str String to compare
367 * @param[in] str_len Number of bytes to take into comparison from @p str.
368 * @return An integer less than, equal to, or greater than zero if @p refstr matches,
369 * respectively, to be less than, to match, or be greater than @p str.
370 */
371int ly_strncmp(const char *refstr, const char *str, size_t str_len);
372
373/**
aPiecekf102d4d2021-03-30 12:18:38 +0200374 * @brief Get all possible value prefixes from an YANG value by iteratively returning specific substrings.
375 *
376 * The function looks for possible prefix ending in a colon at the beginning of @p str_begin.
377 * If @p str_begin does not contain the prefix at the beginning, then either:
378 * 1. Returns the entire input string if the input string does not contain the prefix at all.
379 * 2. Returns a substring before the prefix. The substring is terminated by any character
380 * that is not allowed to be present in prefix (except colon).
381 *
382 * Examples of inputs and outputs are shown in the table below.
383 * Output string @p str_next is used in the next iteration as input parameter @p str_begin.
384 @verbatim
385 | INPUT | OUTPUT |
386 | | iteration 1 | iteration 2 | iteration 3 |
387 |------------------------------ |------------------|------------------|-----------------|
388 | /namespace_prefix:some_string | / | namespace_prefix | some_string |
389 | namespace_prefix:some_string | namespace_prefix | some_string | NULL |
390 | /some_string | /some_string | NULL | NULL |
391 @endverbatim
392 *
393 *
394 * @param[in] str_begin Begin of the input string.
395 * @param[in] str_end Length of the @p str_begin. If set to NULL then the @p str_begin must be NULL-terminated string.
396 * @param[out] is_prefix Type of substring found. Set to True for prefix, otherwise False.
397 * @param[out] str_next Remaining string starting after prefix/substring and ending with @p str_end.
398 * If the @p is_prefix is set to True then the colon character is skipped.
399 * If no string remains, it is set to NULL.
400 * @return Number of bytes (length) of the found prefix/substring starting at @p str_begin.
401 */
402uint32_t ly_value_prefix_next(const char *str_begin, const char *str_end, ly_bool *is_prefix, const char **str_next);
403
404/**
Radek Krejci1798aae2020-07-14 13:26:06 +0200405 * @brief Wrapper around strlen() to handle NULL strings.
406 */
407#define ly_strlen(STR) (STR ? strlen(STR) : 0)
408
409/**
Radek Krejcif13b87b2020-12-01 22:02:17 +0100410 * @brief Compile-time strlen() for string contants.
411 *
412 * Use to avoid magic numbers usage
413 */
414#define ly_strlen_const(STR) (sizeof STR - 1)
415
416#define ly_sizeofarray(ARRAY) (sizeof ARRAY / sizeof *ARRAY)
417
418/*
419 * Numerical bases for use in functions like strtoll() instead of magic numbers
420 */
421#define LY_BASE_DEC 10 /**< Decimal numeral base */
422#define LY_BASE_OCT 8 /**< Octal numeral base */
423#define LY_BASE_HEX 16 /**< Hexadecimal numeral base */
424
425/**
426 * Maximal length of (needed storage for) a number encoded as a string.
427 *
428 * Applies not only for standard numbers, but also for YANG's decimal64.
429 */
430#define LY_NUMBER_MAXLEN 22
431
432/**
Radek Krejcib416be62018-10-01 14:51:45 +0200433 * @brief Get UTF8 code point of the next character in the input string.
434 *
435 * @param[in,out] input Input string to process, updated according to the processed/read data.
436 * @param[out] utf8_char UTF8 code point of the next character.
437 * @param[out] bytes_read Number of bytes used to encode the read utf8_char.
438 * @return LY_ERR value
439 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100440LY_ERR ly_getutf8(const char **input, uint32_t *utf8_char, size_t *bytes_read);
Radek Krejcib416be62018-10-01 14:51:45 +0200441
442/**
Radek Krejci50f0c6b2020-06-18 16:31:48 +0200443 * Store UTF-8 character specified as 4byte integer into the dst buffer.
444 *
445 * UTF-8 mapping:
446 * 00000000 -- 0000007F: 0xxxxxxx
447 * 00000080 -- 000007FF: 110xxxxx 10xxxxxx
448 * 00000800 -- 0000FFFF: 1110xxxx 10xxxxxx 10xxxxxx
449 * 00010000 -- 001FFFFF: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
450 *
451 * Includes checking for valid characters (following RFC 7950, sec 9.4)
452 *
453 * @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.
454 * @param[in] value 32b value of the UTF-8 character to store.
455 * @param[out] bytes_written Number of bytes written into @p dst (size of the written UTF-8 character).
456 * @return LY_SUCCESS on success
457 * @return LY_EINVAL in case of invalid UTF-8 @p value to store.
458 */
459LY_ERR ly_pututf8(char *dst, uint32_t value, size_t *bytes_written);
460
461/**
Radek Krejci76c98012019-08-14 11:23:24 +0200462 * @brief Get number of characters in the @p str, taking multibyte characters into account.
463 * @param[in] str String to examine.
464 * @param[in] bytes Number of valid bytes that are supposed to be taken into account in @p str.
465 * This parameter is useful mainly for non NULL-terminated strings. In case of NULL-terminated
466 * string, strlen() can be used.
467 * @return Number of characters in (possibly) multibyte characters string.
468 */
469size_t ly_utf8len(const char *str, size_t bytes);
470
471/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100472 * @brief Parse signed integer with possible limitation.
473 * @param[in] val_str String value containing signed integer, note that
474 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200475 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100476 * @param[in] min Limitation for the value which must not be lower than min.
477 * @param[in] max Limitation for the value which must not be higher than max.
478 * @param[in] base Numeric base for parsing:
479 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
480 * 10 - to accept only decimal (e.g. data instance value)
481 * @param[out] ret Resulting value.
482 * @return LY_ERR value:
483 * LY_EDENIED - the value breaks the limits,
484 * LY_EVALID - string contains invalid value,
485 * LY_SUCCESS - successful parsing.
486 */
Radek Krejci249973a2019-06-10 10:50:54 +0200487LY_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 +0100488
489/**
490 * @brief Parse unsigned integer with possible limitation.
491 * @param[in] val_str String value containing unsigned integer, note that
492 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200493 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100494 * @param[in] max Limitation for the value which must not be higher than max.
495 * @param[in] base Numeric base for parsing:
496 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
497 * 10 - to accept only decimal (e.g. data instance value)
498 * @param[out] ret Resulting value.
499 * @return LY_ERR value:
500 * LY_EDENIED - the value breaks the limits,
501 * LY_EVALID - string contains invalid value,
502 * LY_SUCCESS - successful parsing.
503 */
Radek Krejci249973a2019-06-10 10:50:54 +0200504LY_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 +0100505
506/**
Radek Krejcib4a4a272019-06-10 12:44:52 +0200507 * @brief Parse a node-identifier.
508 *
509 * node-identifier = [prefix ":"] identifier
510 *
511 * @param[in, out] id Identifier to parse. When returned, it points to the first character which is not part of the identifier.
512 * @param[out] prefix Node's prefix, NULL if there is not any.
513 * @param[out] prefix_len Length of the node's prefix, 0 if there is not any.
514 * @param[out] name Node's name.
515 * @param[out] nam_len Length of the node's name.
516 * @return LY_ERR value: LY_SUCCESS or LY_EINVAL in case of invalid character in the id.
517 */
518LY_ERR ly_parse_nodeid(const char **id, const char **prefix, size_t *prefix_len, const char **name, size_t *name_len);
519
520/**
521 * @brief parse instance-identifier's predicate, supports key-predicate, leaf-list-predicate and pos rules from YANG ABNF Grammar.
522 *
523 * @param[in, out] pred Predicate string (including the leading '[') to parse. The string is updated according to what was parsed
524 * (even for error case, so it can be used to determine which substring caused failure).
525 * @param[in] limit Limiting length of the @p pred. Function expects NULL terminated string which is not overread.
526 * 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 +0200527 * @param[in] format Input format of the data containing the @p pred.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200528 * @param[out] prefix Start of the node-identifier's prefix if any, NULL in case of pos or leaf-list-predicate rules.
529 * @param[out] prefix_len Length of the parsed @p prefix.
530 * @param[out] id Start of the node-identifier's identifier string, NULL in case of pos rule, "." in case of leaf-list-predicate rule.
531 * @param[out] id_len Length of the parsed @p id.
Radek Krejci084289f2019-07-09 17:35:30 +0200532 * @param[out] value Start of the quoted-string (without quotation marks), not NULL in case of success.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200533 * @param[out] value_len Length of the parsed @p value.
534 * @param[out] errmsg Error message string in case of error.
535 * @return LY_SUCCESS in case a complete predicate was parsed.
536 * @return LY_EVALID in case of invalid predicate form.
537 * @return LY_EINVAL in case of reaching @p limit when parsing @p pred.
538 */
Radek Krejci084289f2019-07-09 17:35:30 +0200539LY_ERR ly_parse_instance_predicate(const char **pred, size_t limit, LYD_FORMAT format,
Radek Krejci0f969882020-08-21 16:56:47 +0200540 const char **prefix, size_t *prefix_len, const char **id, size_t *id_len,
541 const char **value, size_t *value_len, const char **errmsg);
Michal Vasko1324b6c2018-09-07 11:16:23 +0200542
Radek Krejcif345c012018-09-19 11:12:59 +0200543/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200544 * @brief mmap(2) wrapper to map input files into memory to unify parsing.
Radek Krejcif345c012018-09-19 11:12:59 +0200545 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200546 * The address space is allocate only for reading.
547 *
548 * @param[in] ctx libyang context for logging
549 * @param[in] fd Open file descriptor of a file to map.
550 * @param[out] length Allocated size.
551 * @param[out] addr Address where the file is mapped.
Radek Krejcif345c012018-09-19 11:12:59 +0200552 * @return LY_ERR value.
553 */
Radek Krejci86d106e2018-10-18 09:53:19 +0200554LY_ERR ly_mmap(struct ly_ctx *ctx, int fd, size_t *length, void **addr);
Michal Vasko841d1a92018-09-07 15:40:31 +0200555
Radek Krejci86d106e2018-10-18 09:53:19 +0200556/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200557 * @brief munmap(2) wrapper to free the memory mapped by ::ly_mmap()
Michal Vasko1324b6c2018-09-07 11:16:23 +0200558 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200559 * @param[in] addr Address where the input file is mapped.
560 * @param[in] length Allocated size of the address space.
561 * @return LY_ERR value.
562 */
563LY_ERR ly_munmap(void *addr, size_t length);
564
565/**
Radek Krejci4546aa62019-07-15 16:53:32 +0200566 * @brief Concatenate formating string to the @p dest.
567 *
568 * @param[in, out] dest String to be concatenated by @p format.
569 * Note that the input string can be reallocated during concatenation.
570 * @param[in] format Formating string (as for printf) which is supposed to be added after @p dest.
571 * @return LY_SUCCESS or LY_EMEM.
572 */
573LY_ERR ly_strcat(char **dest, const char *format, ...);
574
David Sedláke6cd89e2019-08-07 12:46:02 +0200575#endif /* LY_COMMON_H_ */