blob: ffceb2e035afe33620c91bb3cafc5af9168f2601 [file] [log] [blame]
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001/**
2 * @file common.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
Michal Vasko44d474d2023-04-28 14:25:19 +02004 * @author Michal Vasko <mvasko@cesnet.cz>
Radek Krejci5aeea3a2018-09-05 13:29:36 +02005 * @brief common internal definitions for libyang
6 *
Michal Vasko44d474d2023-04-28 14:25:19 +02007 * Copyright (c) 2015 - 2023 CESNET, z.s.p.o.
Radek Krejci5aeea3a2018-09-05 13:29:36 +02008 *
9 * This source code is licensed under BSD 3-Clause License (the "License").
10 * You may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * https://opensource.org/licenses/BSD-3-Clause
14 */
15
16#ifndef LY_COMMON_H_
17#define LY_COMMON_H_
18
Radek Krejci6caa6ab2018-10-24 10:04:48 +020019#include <pthread.h>
Radek Krejcie7b95092019-05-15 11:03:07 +020020#include <stddef.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020021#include <stdint.h>
Michal Vasko55e35212021-04-28 09:38:56 +020022#include <string.h>
Radek Krejci5aeea3a2018-09-05 13:29:36 +020023
Václav Kubernátd367ad92021-11-29 09:28:56 +010024#include "compat.h"
Jan Kundrátc53a7ec2021-12-09 16:01:19 +010025#include "config.h"
Radek Krejcid33273d2018-10-25 14:55:52 +020026#include "context.h"
Michal Vaskoae130f52023-04-20 14:25:16 +020027#include "hash_table_internal.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020028#include "log.h"
Michal Vasko22b26222021-07-30 11:16:47 +020029#include "schema_compile.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020030#include "set.h"
Radek Krejci535ea9f2020-05-29 16:01:05 +020031#include "tree_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020032
33struct ly_ctx;
Radek Krejciaddfc9a2020-12-17 20:46:35 +010034struct ly_in;
Radek Krejci77114102021-03-10 15:21:57 +010035struct lysc_node;
Radek Krejci5aeea3a2018-09-05 13:29:36 +020036
37#if __STDC_VERSION__ >= 201112 && !defined __STDC_NO_THREADS__
38# define THREAD_LOCAL _Thread_local
39#elif defined __GNUC__ || \
Radek Krejci0f969882020-08-21 16:56:47 +020040 defined __SUNPRO_C || \
41 defined __xlC__
Radek Krejci5aeea3a2018-09-05 13:29:36 +020042# define THREAD_LOCAL __thread
Jan Kundrát8d6f1492021-12-09 11:20:53 +010043#elif defined _MSC_VER
44# define THREAD_LOCAL __declspec(thread)
Radek Krejci5aeea3a2018-09-05 13:29:36 +020045#else
46# error "Cannot define THREAD_LOCAL"
47#endif
48
Michal Vasko44d474d2023-04-28 14:25:19 +020049/** platform-specific environment variable path separator */
50#ifndef _WIN32
51# define PATH_SEPARATOR ":"
52#else
53# define PATH_SEPARATOR ";"
54#endif
55
Radek Krejcic59bc972018-09-17 16:13:06 +020056#define GETMACRO1(_1, NAME, ...) NAME
Radek Krejci5aeea3a2018-09-05 13:29:36 +020057#define GETMACRO2(_1, _2, NAME, ...) NAME
58#define GETMACRO3(_1, _2, _3, NAME, ...) NAME
59#define GETMACRO4(_1, _2, _3, _4, NAME, ...) NAME
Michal Vaskodc779a82019-11-06 15:44:06 +010060#define GETMACRO5(_1, _2, _3, _4, _5, NAME, ...) NAME
Michal Vaskoe0665742021-02-11 11:08:44 +010061#define GETMACRO6(_1, _2, _3, _4, _5, _6, NAME, ...) NAME
Michal Vasko820efe82023-05-12 15:47:43 +020062#define GETMACRO7(_1, _2, _3, _4, _5, _6, _7, NAME, ...) NAME
Radek Krejci5aeea3a2018-09-05 13:29:36 +020063
Radek Krejcic59bc972018-09-17 16:13:06 +020064/******************************************************************************
65 * Logger
66 *****************************************************************************/
Radek Krejci5aeea3a2018-09-05 13:29:36 +020067
Michal Vasko236cbac2023-02-10 15:45:37 +010068/** size of the last message buffer */
69#define LY_LAST_MSG_SIZE 512
70
Václav Kubernátd367ad92021-11-29 09:28:56 +010071extern ATOMIC_T ly_ll;
72extern ATOMIC_T ly_log_opts;
Radek Krejci5aeea3a2018-09-05 13:29:36 +020073
Radek Krejciaddfc9a2020-12-17 20:46:35 +010074struct ly_log_location_s {
75 uint64_t line; /**< One-time line value being reset after use - replaces whatever is in inputs */
76 struct ly_set inputs; /**< Set of const struct ly_in *in pointers providing the input handler with the line information (LIFO) */
77 struct ly_set scnodes; /**< Set of const struct lysc_node *scnode pointers providing the compiled schema node to generate path (LIFO) */
78 struct ly_set dnodes; /**< Set of const struct lyd_node *dnode pointers providing the data node to generate path (LIFO) */
79 struct ly_set paths; /**< Set of path strings (LIFO) */
80};
81
82/**
Radek Krejcie7b95092019-05-15 11:03:07 +020083 * @brief Print a log message and store it into the context (if provided).
84 *
85 * @param[in] ctx libyang context to store the error record. If not provided, the error is just printed.
86 * @param[in] level Log message level (error, warning, etc.)
87 * @param[in] no Error type code.
88 * @param[in] format Format string to print.
89 */
Michal Vasko7b3a00e2023-08-09 11:58:03 +020090void ly_log(const struct ly_ctx *ctx, LY_LOG_LEVEL level, LY_ERR no, const char *format, ...) _FORMAT_PRINTF(4, 5);
Radek Krejcie7b95092019-05-15 11:03:07 +020091
92/**
Michal Vaskocd9c00b2023-09-11 10:29:28 +020093 * @brief Generate data path based on the data and schema nodes stored in the log location.
94 *
95 * @param[in] ctx Context for logging.
96 * @param[out] path Generated data path.
97 * @return LY_ERR value.
98 */
99LY_ERR ly_vlog_build_data_path(const struct ly_ctx *ctx, char **path);
100
101/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200102 * @brief Print Validation error and store it into the context (if provided).
103 *
104 * @param[in] ctx libyang context to store the error record. If not provided, the error is just printed.
Michal Vaskoe9391c72021-10-05 10:04:56 +0200105 * @param[in] apptag Optional specific error-app-tag.
Radek Krejcie7b95092019-05-15 11:03:07 +0200106 * @param[in] code Validation error code.
107 * @param[in] format Format string to print.
108 */
Michal Vasko7b3a00e2023-08-09 11:58:03 +0200109void ly_vlog(const struct ly_ctx *ctx, const char *apptag, LY_VECODE code, const char *format, ...) _FORMAT_PRINTF(4, 5);
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200110
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100111/**
Michal Vasko9dbb91d2023-01-30 13:59:22 +0100112 * @brief Move error items from source to target context replacing any previous ones.
113 *
114 * @param[in] src_ctx Source context to read errors from.
115 * @param[in] trg_ctx Target context to set the errors for.
116 */
117void ly_err_move(struct ly_ctx *src_ctx, struct ly_ctx *trg_ctx);
118
119/**
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100120 * @brief Logger's location data setter.
121 *
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100122 * @param[in] scnode Compiled schema node.
123 * @param[in] dnode Data node.
124 * @param[in] path Direct path string to print.
125 * @param[in] in Input handler (providing line number)
126 * @param[in] line One-time line value to be reset when used.
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100127 */
Radek Krejciddace2c2021-01-08 11:30:56 +0100128void ly_log_location(const struct lysc_node *scnode, const struct lyd_node *dnode,
Michal Vaskof8ebf132022-11-21 14:06:48 +0100129 const char *path, const struct ly_in *in, uint64_t line);
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100130
131/**
132 * @brief Revert the specific logger's location data by number of changes made by ::ly_log_location().
133 *
aPiecekb39f56c2021-05-03 10:47:18 +0200134 * @param[in] scnode_steps Number of items in ::ly_log_location_s.scnodes to forget.
135 * @param[in] dnode_steps Number of items in ::ly_log_location_s.dnodes to forget.
136 * @param[in] path_steps Number of path strings in ::ly_log_location_s.paths to forget.
137 * @param[in] in_steps Number of input handlers ::ly_log_location_s.inputs to forget.
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100138 */
Radek Krejciddace2c2021-01-08 11:30:56 +0100139void 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 +0100140
141/**
Michal Vaskoa878a892023-08-18 12:22:07 +0200142 * @brief Get the stored data node for logging at the index.
143 *
144 * @param[in] idx Index of the data node.
145 * @return Logged data node, NULL if out of range.
146 */
147const struct lyd_node *ly_log_location_dnode(uint32_t idx);
148
149/**
150 * @brief Get the count of stored data nodes for logging.
151 *
152 * @return Count of the data nodes.
153 */
154uint32_t ly_log_location_dnode_count(void);
155
156/**
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100157 * @brief Update location data for logger, not provided arguments (NULLs) are kept (does not override).
158 *
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100159 * @param[in] SCNODE Compiled schema node.
160 * @param[in] DNODE Data node.
161 * @param[in] PATH Direct path string to print.
162 * @param[in] IN Input handler (providing line number)
163 */
Radek Krejciddace2c2021-01-08 11:30:56 +0100164#define LOG_LOCSET(SCNODE, DNODE, PATH, IN) \
Michal Vaskof8ebf132022-11-21 14:06:48 +0100165 ly_log_location(SCNODE, DNODE, PATH, IN, 0)
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100166
Radek Krejciddace2c2021-01-08 11:30:56 +0100167/**
168 * @brief Update location data for logger, not provided arguments (NULLs) are kept (does not override).
169 *
170 * @param[in] SCNODE_STEPS Number of the compiled schema nodes to remove from the stack.
171 * @param[in] DNODE_STEPS Number of the data nodes to remove from the stack.
172 * @param[in] PATH_STEPS Number of the direct path strings to remove from the stack.
173 * @param[in] IN_STEPS Number of the input handlers (providing line number) to remove from the stack.
174 */
175#define LOG_LOCBACK(SCNODE_STEPS, DNODE_STEPS, PATH_STEPS, IN_STEPS) \
176 ly_log_location_revert(SCNODE_STEPS, DNODE_STEPS, PATH_STEPS, IN_STEPS)
Radek Krejciaddfc9a2020-12-17 20:46:35 +0100177
Michal Vasko151ae6c2021-09-23 08:23:51 +0200178#define LOGERR(ctx, errno, ...) ly_log(ctx, LY_LLERR, errno, __VA_ARGS__)
179#define LOGWRN(ctx, ...) ly_log(ctx, LY_LLWRN, 0, __VA_ARGS__)
180#define LOGVRB(...) ly_log(NULL, LY_LLVRB, 0, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200181
Radek Krejci4ab61562018-09-05 15:00:37 +0200182#ifdef NDEBUG
Michal Vasko151ae6c2021-09-23 08:23:51 +0200183# define LOGDBG(dbg_group, ...)
Radek Krejci4ab61562018-09-05 15:00:37 +0200184#else
Radek Krejci1deb5be2020-08-26 16:43:36 +0200185void ly_log_dbg(uint32_t group, const char *format, ...);
Michal Vasko151ae6c2021-09-23 08:23:51 +0200186# define LOGDBG(dbg_group, ...) ly_log_dbg(dbg_group, __VA_ARGS__);
Radek Krejci4ab61562018-09-05 15:00:37 +0200187#endif
188
Radek Krejcie2692202020-12-01 14:21:12 +0100189/**
190 * Simple EMEM message, it can be safely stored in ::ly_err_item structures without problems when freeing.
191 */
192#define LY_EMEM_MSG "Memory allocation failed."
193
Radek Krejci859a15a2021-03-05 20:56:59 +0100194#ifdef LOGMEM
195/* overwrite shadow definition from tree_edit.h */
196#undef LOGMEM
197#endif
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200198#define LOGMEM(CTX) LOGERR(CTX, LY_EMEM, "Memory allocation failed (%s()).", __func__)
Radek Krejci859a15a2021-03-05 20:56:59 +0100199
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200200#define LOGINT(CTX) LOGERR(CTX, LY_EINT, "Internal error (%s:%d).", __FILE__, __LINE__)
201#define LOGARG(CTX, ARG) LOGERR(CTX, LY_EINVAL, "Invalid argument %s (%s()).", #ARG, __func__)
Michal Vaskoe9391c72021-10-05 10:04:56 +0200202#define LOGVAL(CTX, ...) ly_vlog(CTX, NULL, __VA_ARGS__)
203#define LOGVAL_APPTAG(CTX, APPTAG, ...) ly_vlog(CTX, APPTAG, __VA_ARGS__)
Michal Vasko151ae6c2021-09-23 08:23:51 +0200204#define LOGVAL_LINE(CTX, LINE, ...) \
Michal Vaskof8ebf132022-11-21 14:06:48 +0100205 ly_log_location(NULL, NULL, NULL, NULL, LINE); \
Michal Vaskoe9391c72021-10-05 10:04:56 +0200206 ly_vlog(CTX, NULL, __VA_ARGS__)
Radek Krejci94aa9942018-09-07 17:12:17 +0200207
aPiecek4204b612021-05-03 09:06:16 +0200208/**
209 * @brief Print Validation error from struct ly_err_item.
210 *
211 * String ::ly_err_item.msg cannot be used directly because it may contain the % character,
212 * which is incorrectly interpreted in this situation as a conversion specification.
213 *
214 * @param[in] CTX libyang context to store the error record. If not provided, the error is just printed.
215 * @param[in] ERRITEM pointer to ly_err_item that contains an error message.
216 */
Michal Vaskoe9391c72021-10-05 10:04:56 +0200217#define LOGVAL_ERRITEM(CTX, ERRITEM) ly_vlog(CTX, ERRITEM->apptag, ERRITEM->vecode, "%s", ERRITEM->msg)
aPiecek4204b612021-05-03 09:06:16 +0200218
Radek Krejci94aa9942018-09-07 17:12:17 +0200219#define LOGMEM_RET(CTX) LOGMEM(CTX); return LY_EMEM
220#define LOGINT_RET(CTX) LOGINT(CTX); return LY_EINT
221#define LOGARG_RET(CTX) LOGARG(CTX); return LY_EINVAL
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200222
223/*
224 * Common code to check return value and perform appropriate action.
225 */
Radek Krejcie88beef2019-05-30 15:47:19 +0200226#define LY_CHECK_GOTO(COND, GOTO) if ((COND)) {goto GOTO;}
227#define LY_CHECK_ERR_GOTO(COND, ERR, GOTO) if ((COND)) {ERR; goto GOTO;}
Radek Krejci6d9b9b52018-11-02 12:43:39 +0100228#define LY_CHECK_RET1(RETVAL) {LY_ERR ret__ = RETVAL;if (ret__ != LY_SUCCESS) {return ret__;}}
Radek Krejcie88beef2019-05-30 15:47:19 +0200229#define LY_CHECK_RET2(COND, RETVAL) if ((COND)) {return RETVAL;}
Michal Vasko151ae6c2021-09-23 08:23:51 +0200230#define LY_CHECK_RET(...) GETMACRO2(__VA_ARGS__, LY_CHECK_RET2, LY_CHECK_RET1, DUMMY)(__VA_ARGS__)
Radek Krejcie88beef2019-05-30 15:47:19 +0200231#define LY_CHECK_ERR_RET(COND, ERR, RETVAL) if ((COND)) {ERR; return RETVAL;}
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200232
Radek Krejcia3045382018-11-22 14:30:31 +0100233#define LY_CHECK_ARG_GOTO1(CTX, ARG, GOTO) if (!(ARG)) {LOGARG(CTX, ARG);goto GOTO;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200234#define LY_CHECK_ARG_GOTO2(CTX, ARG1, ARG2, GOTO) LY_CHECK_ARG_GOTO1(CTX, ARG1, GOTO);LY_CHECK_ARG_GOTO1(CTX, ARG2, GOTO)
235#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 +0100236#define LY_CHECK_ARG_GOTO4(CTX, ARG1, ARG2, ARG3, ARG4, GOTO) LY_CHECK_ARG_GOTO3(CTX, ARG1, ARG2, ARG3, GOTO);\
237 LY_CHECK_ARG_GOTO1(CTX, ARG4, GOTO)
238#define LY_CHECK_ARG_GOTO(CTX, ...) GETMACRO5(__VA_ARGS__, LY_CHECK_ARG_GOTO4, LY_CHECK_ARG_GOTO3, LY_CHECK_ARG_GOTO2, \
239 LY_CHECK_ARG_GOTO1)(CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200240
Radek Krejcia3045382018-11-22 14:30:31 +0100241#define LY_CHECK_ARG_RET1(CTX, ARG, RETVAL) if (!(ARG)) {LOGARG(CTX, ARG);return RETVAL;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +0200242#define LY_CHECK_ARG_RET2(CTX, ARG1, ARG2, RETVAL) LY_CHECK_ARG_RET1(CTX, ARG1, RETVAL);LY_CHECK_ARG_RET1(CTX, ARG2, RETVAL)
243#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 +0100244#define LY_CHECK_ARG_RET4(CTX, ARG1, ARG2, ARG3, ARG4, RETVAL) LY_CHECK_ARG_RET3(CTX, ARG1, ARG2, ARG3, RETVAL);\
245 LY_CHECK_ARG_RET1(CTX, ARG4, RETVAL)
Michal Vaskoe0665742021-02-11 11:08:44 +0100246#define LY_CHECK_ARG_RET5(CTX, ARG1, ARG2, ARG3, ARG4, ARG5, RETVAL) LY_CHECK_ARG_RET4(CTX, ARG1, ARG2, ARG3, ARG4, RETVAL);\
247 LY_CHECK_ARG_RET1(CTX, ARG5, RETVAL)
Michal Vasko820efe82023-05-12 15:47:43 +0200248#define LY_CHECK_ARG_RET6(CTX, ARG1, ARG2, ARG3, ARG4, ARG5, ARG6, RETVAL) LY_CHECK_ARG_RET5(CTX, ARG1, ARG2, ARG3, ARG4, ARG5, RETVAL);\
249 LY_CHECK_ARG_RET1(CTX, ARG6, RETVAL)
250#define LY_CHECK_ARG_RET(CTX, ...) GETMACRO7(__VA_ARGS__, LY_CHECK_ARG_RET6, LY_CHECK_ARG_RET5, LY_CHECK_ARG_RET4, \
251 LY_CHECK_ARG_RET3, LY_CHECK_ARG_RET2, LY_CHECK_ARG_RET1, DUMMY) (CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200252
Michal Vasko892f5bf2021-11-24 10:41:05 +0100253#define LY_CHECK_CTX_EQUAL_RET2(CTX1, CTX2, RETVAL) if ((CTX1) && (CTX2) && ((CTX1) != (CTX2))) \
254 {LOGERR(CTX1, LY_EINVAL, "Different contexts mixed in a single function call."); return RETVAL;}
255#define LY_CHECK_CTX_EQUAL_RET3(CTX1, CTX2, CTX3, RETVAL) LY_CHECK_CTX_EQUAL_RET2(CTX1, CTX2, RETVAL); \
256 LY_CHECK_CTX_EQUAL_RET2(CTX2, CTX3, RETVAL); LY_CHECK_CTX_EQUAL_RET2(CTX1, CTX3, RETVAL)
257#define LY_CHECK_CTX_EQUAL_RET(CTX, ...) GETMACRO3(__VA_ARGS__, LY_CHECK_CTX_EQUAL_RET3, LY_CHECK_CTX_EQUAL_RET2, \
258 DUMMY) (CTX, __VA_ARGS__)
259
Radek Krejcid972c252018-09-25 13:23:39 +0200260/* count sequence size for LY_VCODE_INCHILDSTMT validation error code */
Michal Vasko7b3a00e2023-08-09 11:58:03 +0200261int LY_VCODE_INSTREXP_len(const char *str);
262
Radek Krejcid972c252018-09-25 13:23:39 +0200263/* default maximum characters to print in LY_VCODE_INCHILDSTMT */
264#define LY_VCODE_INSTREXP_MAXLEN 20
265
Michal Vaskoecd62de2019-11-13 12:35:11 +0100266#define LY_VCODE_INCHAR LYVE_SYNTAX, "Invalid character 0x%x."
267#define LY_VCODE_INSTREXP LYVE_SYNTAX, "Invalid character sequence \"%.*s\", expected %s."
268#define LY_VCODE_EOF LYVE_SYNTAX, "Unexpected end-of-input."
269#define LY_VCODE_NTERM LYVE_SYNTAX, "%s not terminated."
270#define LY_VCODE_NSUPP LYVE_SYNTAX, "%s not supported."
271#define LY_VCODE_MOD_SUBOMD LYVE_SYNTAX, "Invalid keyword \"%s\", expected \"module\" or \"submodule\"."
272#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 +0200273#define LY_VCODE_TRAILING_SUBMOD LYVE_SYNTAX, "Trailing garbage \"%.*s%s\" after submodule, expected end-of-input."
274
Michal Vaskoecd62de2019-11-13 12:35:11 +0100275#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 +0100276#define LY_VCODE_NAME_COL LYVE_SEMANTICS, "Name collision between %s of name \"%s\"."
277#define LY_VCODE_NAME2_COL LYVE_SEMANTICS, "Name collision between %s and %s of name \"%s\"."
David Sedlák0c2bab92019-07-22 15:33:19 +0200278
Michal Vaskoecd62de2019-11-13 12:35:11 +0100279#define LY_VCODE_INSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\"."
280#define LY_VCODE_INCHILDSTMT LYVE_SYNTAX_YANG, "Invalid keyword \"%s\" as a child of \"%s\"."
281#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 +0100282#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 +0100283#define LY_VCODE_DUPSTMT LYVE_SYNTAX_YANG, "Duplicate keyword \"%s\"."
284#define LY_VCODE_DUPIDENT LYVE_SYNTAX_YANG, "Duplicate identifier \"%s\" of %s statement."
aPiecekdc12b9f2021-06-25 10:55:47 +0200285#define LY_VCODE_DUPIDENT2 LYVE_SYNTAX_YANG, "Duplicate identifier \"%s\" of %s statement - %s."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100286#define LY_VCODE_INVAL LYVE_SYNTAX_YANG, "Invalid value \"%.*s\" of \"%s\"."
287#define LY_VCODE_MISSTMT LYVE_SYNTAX_YANG, "Missing mandatory keyword \"%s\" as a child of \"%s\"."
288#define LY_VCODE_MISSCHILDSTMT LYVE_SYNTAX_YANG, "Missing %s substatement for %s%s."
289#define LY_VCODE_INORD LYVE_SYNTAX_YANG, "Invalid keyword \"%s\", it cannot appear after \"%s\"."
290#define LY_VCODE_OOB LYVE_SYNTAX_YANG, "Value \"%.*s\" is out of \"%s\" bounds."
291#define LY_VCODE_INDEV LYVE_SYNTAX_YANG, "Deviate \"%s\" does not support keyword \"%s\"."
292#define LY_VCODE_INREGEXP LYVE_SYNTAX_YANG, "Regular expression \"%s\" is not valid (\"%s\": %s)."
David Sedlák0c2bab92019-07-22 15:33:19 +0200293
Michal Vaskoecd62de2019-11-13 12:35:11 +0100294#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."
295#define LY_VCODE_INVAL_YIN LYVE_SYNTAX_YIN, "Invalid value \"%s\" of \"%s\" attribute in \"%s\" element."
296#define LY_VCODE_UNEXP_SUBELEM LYVE_SYNTAX_YIN, "Unexpected sub-element \"%.*s\" of \"%s\" element."
297#define LY_VCODE_INDEV_YIN LYVE_SYNTAX_YIN, "Deviate of this type doesn't allow \"%s\" as it's sub-element."
298#define LY_VCODE_INORDER_YIN LYVE_SYNTAX_YIN, "Invalid order of %s\'s sub-elements \"%s\" can't appear after \"%s\"."
299#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 +0200300#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 +0100301#define LY_VCODE_DUP_ATTR LYVE_SYNTAX_YIN, "Duplicit definition of \"%s\" attribute in \"%s\" element."
302#define LY_VCODE_UNEXP_ATTR LYVE_SYNTAX_YIN, "Unexpected attribute \"%.*s\" of \"%s\" element."
303#define LY_VCODE_MAND_SUBELEM LYVE_SYNTAX_YIN, "Missing mandatory sub-element \"%s\" of \"%s\" element."
304#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 +0100305#define LY_VCODE_SUBELEM_REDEF LYVE_SYNTAX_YIN, "Redefinition of \"%s\" sub-element in \"%s\" element."
David Sedlák0c2bab92019-07-22 15:33:19 +0200306
Michal Vaskoecd62de2019-11-13 12:35:11 +0100307#define LY_VCODE_XP_EOE LYVE_XPATH, "Unterminated string delimited with %c (%.15s)."
Michal Vasko774ce402021-04-14 15:35:06 +0200308#define LY_VCODE_XP_INEXPR LYVE_XPATH, "Invalid character '%c'[%u] of expression \'%s\'."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100309#define LY_VCODE_XP_EOF LYVE_XPATH, "Unexpected XPath expression end."
Michal Vasko0b468e62020-10-19 09:33:04 +0200310#define LY_VCODE_XP_INTOK LYVE_XPATH, "Unexpected XPath token \"%s\" (\"%.15s\")."
311#define LY_VCODE_XP_INTOK2 LYVE_XPATH, "Unexpected XPath token \"%s\" (\"%.15s\"), expected \"%s\"."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100312#define LY_VCODE_XP_INFUNC LYVE_XPATH, "Unknown XPath function \"%.*s\"."
313#define LY_VCODE_XP_INARGCOUNT LYVE_XPATH, "Invalid number of arguments (%d) for the XPath function %.*s."
314#define LY_VCODE_XP_INARGTYPE LYVE_XPATH, "Wrong type of argument #%d (%s) for the XPath function %s."
315#define LY_VCODE_XP_INCTX LYVE_XPATH, "Invalid context type %s in %s."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100316#define LY_VCODE_XP_INOP_1 LYVE_XPATH, "Cannot apply XPath operation %s on %s."
317#define LY_VCODE_XP_INOP_2 LYVE_XPATH, "Cannot apply XPath operation %s on %s and %s."
Michal Vasko004d3152020-06-11 19:59:22 +0200318#define LY_VCODE_XP_INMOD LYVE_XPATH, "Unknown/non-implemented module \"%.*s\"."
aPiecekbf968d92021-05-27 14:35:05 +0200319#define LY_VCODE_XP_DEPTH LYVE_XPATH, "The maximum nesting of expressions has been exceeded."
David Sedlák0c2bab92019-07-22 15:33:19 +0200320
Radek Krejci327de162019-06-14 12:52:07 +0200321#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 +0200322
Michal Vasko538b8952021-02-17 11:27:26 +0100323#define LY_VCODE_NOWHEN LYVE_DATA, "When condition \"%s\" not satisfied."
324#define LY_VCODE_NOMAND LYVE_DATA, "Mandatory node \"%s\" instance does not exist."
Michal Vaskof03ed032020-03-04 13:31:44 +0100325#define LY_VCODE_DUP LYVE_DATA, "Duplicate instance of \"%s\"."
326#define LY_VCODE_DUPCASE LYVE_DATA, "Data for both cases \"%s\" and \"%s\" exist."
Michal Vasko224e7772021-02-18 14:22:33 +0100327#define LY_VCODE_UNEXPNODE LYVE_DATA, "Unexpected data %s node \"%s\" found."
Michal Vasko9f96a052020-03-10 09:41:45 +0100328#define LY_VCODE_NOKEY LYVE_DATA, "List instance is missing its key \"%s\"."
Michal Vaskoecd62de2019-11-13 12:35:11 +0100329
Radek Krejci07a55962021-03-02 20:16:43 +0100330#define LY_ERRMSG_NOPATTERN /* LYVE_DATA */ "Unsatisfied pattern - \"%.*s\" does not conform to %s\"%s\"."
Michal Vasko5c900d62021-04-29 15:21:04 +0200331#define LY_ERRMSG_NOLENGTH /* LYVE_DATA */ "Unsatisfied length - string \"%.*s\" length is not allowed."
Michal Vaskof19c7242021-04-27 13:32:46 +0200332#define LY_ERRMSG_NORANGE /* LYVE_DATA */ "Unsatisfied range - value \"%.*s\" is out of the allowed range."
Michal Vasko224e7772021-02-18 14:22:33 +0100333
334/* RFC 7950 section 15 errors */
335#define LY_VCODE_NOUNIQ LYVE_DATA, "Unique data leaf(s) \"%s\" not satisfied in \"%s\" and \"%s\"."
336#define LY_VCODE_NOMAX LYVE_DATA, "Too many \"%s\" instances."
337#define LY_VCODE_NOMIN LYVE_DATA, "Too few \"%s\" instances."
338#define LY_VCODE_NOMUST LYVE_DATA, "Must condition \"%s\" not satisfied."
339#define LY_VCODE_NOMAND_CHOIC LYVE_DATA, "Mandatory choice \"%s\" data do not exist."
340
341/* RFC 7950 section 15 error messages used in type plugin validation callbacks */
Radek Krejci07a55962021-03-02 20:16:43 +0100342#define LY_ERRMSG_NOLREF_VAL /* LYVE_DATA */ "Invalid leafref value \"%s\" - no target instance \"%s\" with the same value."
Radek Krejci07a55962021-03-02 20:16:43 +0100343#define LY_ERRMSG_NOINST /* LYVE_DATA */ "Invalid instance-identifier \"%s\" value - required instance not found."
Michal Vasko224e7772021-02-18 14:22:33 +0100344
Radek Krejcic59bc972018-09-17 16:13:06 +0200345/******************************************************************************
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200346 * Context
347 *****************************************************************************/
348
349/**
Michal Vasko88ccd582023-03-30 11:50:57 +0200350 * @brief Context error hash table record.
351 */
352struct ly_ctx_err_rec {
353 struct ly_err_item *err; /** pointer to the error items, if any */
354 pthread_t tid; /** pthread thread ID */
355};
356
357/**
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200358 * @brief Context of the YANG schemas
359 */
360struct ly_ctx {
Michal Vasko8efac242023-03-30 08:24:56 +0200361 struct ly_dict dict; /**< dictionary to effectively store strings used in the context related structures */
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200362 struct ly_set search_paths; /**< set of directories where to search for schema's imports/includes */
Michal Vasko89b5c072020-10-06 13:52:44 +0200363 struct ly_set list; /**< set of loaded YANG schemas */
Michal Vasko22b26222021-07-30 11:16:47 +0200364 ly_module_imp_clb imp_clb; /**< optional callback for retrieving missing included or imported models */
365 void *imp_clb_data; /**< optional private data for ::ly_ctx.imp_clb */
366 struct lys_glob_unres unres; /**< global unres, should be empty unless there are modules prepared for
367 compilation if ::LY_CTX_EXPLICIT_COMPILE flag is set */
368 uint16_t change_count; /**< count of changes of the context, on some changes it could be incremented
369 more times */
370 uint16_t flags; /**< context settings, see @ref contextoptions */
371
Michal Vaskoddd76592022-01-17 13:34:48 +0100372 ly_ext_data_clb ext_clb; /**< optional callback for providing extension-specific run-time data for extensions */
373 void *ext_clb_data; /**< optional private data for ::ly_ctx.ext_clb */
Michal Vasko88ccd582023-03-30 11:50:57 +0200374 struct ly_ht *err_ht; /**< hash table of thread-specific list of errors related to the context */
Michal Vasko11f76c82021-04-15 14:36:14 +0200375 pthread_mutex_t lyb_hash_lock; /**< lock for storing LYB schema hashes in schema nodes */
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200376};
377
Radek Krejcid33273d2018-10-25 14:55:52 +0200378/**
Radek Krejci0ad51f12020-07-16 12:08:12 +0200379 * @brief Get the (only) implemented YANG module specified by its name.
380 *
381 * @param[in] ctx Context where to search.
382 * @param[in] name Name of the YANG module to get.
383 * @param[in] name_len Optional length of the @p name. If zero, NULL-terminated name is expected.
384 * @return The only implemented YANG module revision of the given name in the given context. NULL if there is no
385 * implemented module of the given name.
386 */
387struct lys_module *ly_ctx_get_module_implemented2(const struct ly_ctx *ctx, const char *name, size_t name_len);
388
Radek Krejci6caa6ab2018-10-24 10:04:48 +0200389/******************************************************************************
Michal Vasko1324b6c2018-09-07 11:16:23 +0200390 * Generic useful functions.
Radek Krejcic59bc972018-09-17 16:13:06 +0200391 *****************************************************************************/
Michal Vasko1324b6c2018-09-07 11:16:23 +0200392
Michal Vaskob36053d2020-03-26 15:49:30 +0100393/**
394 * @brief Insert string into dictionary.
395 *
396 * @param[in] CTX libyang context.
397 * @param[in] STRING string to store.
398 * @param[in] LEN length of the string in WORD to store.
aPiecekb39f56c2021-05-03 10:47:18 +0200399 * @param[in,out] DYNAMIC Set to 1 if @p STRING is dynamically allocated, 0 otherwise.
400 * If set to 1, zerocopy version of lydict_insert is used.
401 * @param[out] TARGET pointer is set to @p STRING value stored in the dictionary.
Michal Vaskob36053d2020-03-26 15:49:30 +0100402 */
Radek Krejci011e4aa2020-09-04 15:22:31 +0200403#define INSERT_STRING_RET(CTX, STRING, LEN, DYNAMIC, TARGET) \
404 if (DYNAMIC) { \
405 LY_CHECK_RET(lydict_insert_zc(CTX, (char *)(STRING), &(TARGET))); \
406 } else { \
407 LY_CHECK_RET(lydict_insert(CTX, LEN ? (STRING) : "", LEN, &(TARGET))); \
408 } \
409 DYNAMIC = 0
Michal Vaskob36053d2020-03-26 15:49:30 +0100410
Michal Vasko1324b6c2018-09-07 11:16:23 +0200411/**
412 * @brief Wrapper for realloc() call. The only difference is that if it fails to
413 * allocate the requested memory, the original memory is freed as well.
414 *
415 * @param[in] ptr Memory to reallocate.
416 * @param[in] size New size of the memory block.
Michal Vasko1324b6c2018-09-07 11:16:23 +0200417 * @return Pointer to the new memory, NULL on error.
418 */
419void *ly_realloc(void *ptr, size_t size);
420
Radek Krejcif345c012018-09-19 11:12:59 +0200421/**
Michal Vasko03ff5a72019-09-11 13:49:33 +0200422 * @brief Just like strchr() function except limit the number of examined characters.
423 *
424 * @param[in] s String to search in.
425 * @param[in] c Character to search for.
426 * @param[in] len Limit the search to this number of characters in @p s.
aPiecekb0445f22021-06-24 11:34:07 +0200427 * @return Pointer to first @p c occurrence in @p s, NULL if not found in first @p len characters.
Michal Vasko03ff5a72019-09-11 13:49:33 +0200428 */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200429char *ly_strnchr(const char *s, int c, size_t len);
Michal Vasko03ff5a72019-09-11 13:49:33 +0200430
431/**
aPiecekb39f56c2021-05-03 10:47:18 +0200432 * @brief Compare NULL-terminated @p refstr with @p str_len bytes from @p str.
Radek Krejci7f9b6512019-09-18 13:11:09 +0200433 *
aPiecekb39f56c2021-05-03 10:47:18 +0200434 * @param[in] refstr NULL-terminated string which must match @p str_len bytes from @p str followed by NULL-byte.
435 * @param[in] str String to compare.
Radek Krejci7f9b6512019-09-18 13:11:09 +0200436 * @param[in] str_len Number of bytes to take into comparison from @p str.
437 * @return An integer less than, equal to, or greater than zero if @p refstr matches,
438 * respectively, to be less than, to match, or be greater than @p str.
439 */
440int ly_strncmp(const char *refstr, const char *str, size_t str_len);
441
442/**
Michal Vasko15dc9fa2021-05-03 14:33:05 +0200443 * @brief Similar functionality to strtoul() except number length in the string
444 * must be specified and the whole number must be parsed for success.
445 *
446 * @param[in] nptr Number string.
447 * @param[in] len Number string length starting at @p nptr.
448 * @param[out] ret Parsed number.
449 * @return LY_EDENIED on overflow.
450 * @return LY_EVALID on encountering a non-digit character.
451 * @return LY_SUCCESS on success.
452 */
453LY_ERR ly_strntou8(const char *nptr, size_t len, uint8_t *ret);
454
455/**
aPiecekf102d4d2021-03-30 12:18:38 +0200456 * @brief Get all possible value prefixes from an YANG value by iteratively returning specific substrings.
457 *
458 * The function looks for possible prefix ending in a colon at the beginning of @p str_begin.
459 * If @p str_begin does not contain the prefix at the beginning, then either:
460 * 1. Returns the entire input string if the input string does not contain the prefix at all.
461 * 2. Returns a substring before the prefix. The substring is terminated by any character
462 * that is not allowed to be present in prefix (except colon).
463 *
464 * Examples of inputs and outputs are shown in the table below.
465 * Output string @p str_next is used in the next iteration as input parameter @p str_begin.
466 @verbatim
467 | INPUT | OUTPUT |
468 | | iteration 1 | iteration 2 | iteration 3 |
469 |------------------------------ |------------------|------------------|-----------------|
470 | /namespace_prefix:some_string | / | namespace_prefix | some_string |
471 | namespace_prefix:some_string | namespace_prefix | some_string | NULL |
472 | /some_string | /some_string | NULL | NULL |
473 @endverbatim
474 *
475 *
476 * @param[in] str_begin Begin of the input string.
477 * @param[in] str_end Length of the @p str_begin. If set to NULL then the @p str_begin must be NULL-terminated string.
aPieceke3f828d2021-05-10 15:34:41 +0200478 * @param[out] len Number of bytes (length) of the found prefix/substring starting at @p str_begin.
aPiecekf102d4d2021-03-30 12:18:38 +0200479 * @param[out] is_prefix Type of substring found. Set to True for prefix, otherwise False.
480 * @param[out] str_next Remaining string starting after prefix/substring and ending with @p str_end.
481 * If the @p is_prefix is set to True then the colon character is skipped.
482 * If no string remains, it is set to NULL.
aPieceke3f828d2021-05-10 15:34:41 +0200483 * @return LY_ERR value.
aPiecekf102d4d2021-03-30 12:18:38 +0200484 */
Michal Vasko7b3a00e2023-08-09 11:58:03 +0200485LY_ERR ly_value_prefix_next(const char *str_begin, const char *str_end, uint32_t *len, ly_bool *is_prefix,
486 const char **str_next);
aPiecekf102d4d2021-03-30 12:18:38 +0200487
488/**
Radek Krejci1798aae2020-07-14 13:26:06 +0200489 * @brief Wrapper around strlen() to handle NULL strings.
490 */
491#define ly_strlen(STR) (STR ? strlen(STR) : 0)
492
493/**
Radek Krejci822a9482021-06-02 21:23:22 +0200494 * @brief Compile-time strlen() for string constants.
Radek Krejcif13b87b2020-12-01 22:02:17 +0100495 *
496 * Use to avoid magic numbers usage
497 */
498#define ly_strlen_const(STR) (sizeof STR - 1)
499
Radek Krejci71512f92021-06-02 21:20:06 +0200500/**
501 * @brief Macro to simply put couple of string length and the string as
502 * printf's arguments for %.*s. Use only with constant strings.
503 */
Michal Vasko1b9e7f62021-07-30 11:05:27 +0200504#define LY_PRI_LENSTR(STR) (int)ly_strlen_const(STR), STR
Radek Krejci71512f92021-06-02 21:20:06 +0200505
Radek Krejcif13b87b2020-12-01 22:02:17 +0100506#define ly_sizeofarray(ARRAY) (sizeof ARRAY / sizeof *ARRAY)
507
aPiecek889bfce2021-06-15 15:52:58 +0200508/**
509 * @brief Check for overflow during the addition of two unsigned integers.
510 */
511#define LY_OVERFLOW_ADD(MAX, X, Y) (X > MAX - Y)
512
513/**
514 * @brief Check for overflow during the multiplication of two unsigned integers.
515 */
516#define LY_OVERFLOW_MUL(MAX, X, Y) (X > MAX / Y)
517
Radek Krejcif13b87b2020-12-01 22:02:17 +0100518/*
519 * Numerical bases for use in functions like strtoll() instead of magic numbers
520 */
521#define LY_BASE_DEC 10 /**< Decimal numeral base */
522#define LY_BASE_OCT 8 /**< Octal numeral base */
523#define LY_BASE_HEX 16 /**< Hexadecimal numeral base */
524
525/**
526 * Maximal length of (needed storage for) a number encoded as a string.
527 *
528 * Applies not only for standard numbers, but also for YANG's decimal64.
529 */
530#define LY_NUMBER_MAXLEN 22
531
532/**
Radek Krejcib416be62018-10-01 14:51:45 +0200533 * @brief Get UTF8 code point of the next character in the input string.
534 *
535 * @param[in,out] input Input string to process, updated according to the processed/read data.
536 * @param[out] utf8_char UTF8 code point of the next character.
537 * @param[out] bytes_read Number of bytes used to encode the read utf8_char.
538 * @return LY_ERR value
539 */
Michal Vaskob36053d2020-03-26 15:49:30 +0100540LY_ERR ly_getutf8(const char **input, uint32_t *utf8_char, size_t *bytes_read);
Radek Krejcib416be62018-10-01 14:51:45 +0200541
542/**
Michal Vasko44d474d2023-04-28 14:25:19 +0200543 * @brief Store UTF-8 character specified as 4byte integer into the dst buffer.
Radek Krejci50f0c6b2020-06-18 16:31:48 +0200544 *
545 * UTF-8 mapping:
546 * 00000000 -- 0000007F: 0xxxxxxx
547 * 00000080 -- 000007FF: 110xxxxx 10xxxxxx
548 * 00000800 -- 0000FFFF: 1110xxxx 10xxxxxx 10xxxxxx
549 * 00010000 -- 001FFFFF: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
550 *
551 * Includes checking for valid characters (following RFC 7950, sec 9.4)
552 *
Michal Vasko44d474d2023-04-28 14:25:19 +0200553 * @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.
Radek Krejci50f0c6b2020-06-18 16:31:48 +0200554 * @param[in] value 32b value of the UTF-8 character to store.
555 * @param[out] bytes_written Number of bytes written into @p dst (size of the written UTF-8 character).
556 * @return LY_SUCCESS on success
557 * @return LY_EINVAL in case of invalid UTF-8 @p value to store.
558 */
559LY_ERR ly_pututf8(char *dst, uint32_t value, size_t *bytes_written);
560
561/**
Radek Krejci76c98012019-08-14 11:23:24 +0200562 * @brief Get number of characters in the @p str, taking multibyte characters into account.
Michal Vasko44d474d2023-04-28 14:25:19 +0200563 *
Radek Krejci76c98012019-08-14 11:23:24 +0200564 * @param[in] str String to examine.
565 * @param[in] bytes Number of valid bytes that are supposed to be taken into account in @p str.
566 * This parameter is useful mainly for non NULL-terminated strings. In case of NULL-terminated
567 * string, strlen() can be used.
568 * @return Number of characters in (possibly) multibyte characters string.
569 */
570size_t ly_utf8len(const char *str, size_t bytes);
571
572/**
Radek Krejci4f28eda2018-11-12 11:46:16 +0100573 * @brief Parse signed integer with possible limitation.
Michal Vasko44d474d2023-04-28 14:25:19 +0200574 *
Radek Krejci4f28eda2018-11-12 11:46:16 +0100575 * @param[in] val_str String value containing signed integer, note that
576 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200577 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100578 * @param[in] min Limitation for the value which must not be lower than min.
579 * @param[in] max Limitation for the value which must not be higher than max.
580 * @param[in] base Numeric base for parsing:
581 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
582 * 10 - to accept only decimal (e.g. data instance value)
583 * @param[out] ret Resulting value.
584 * @return LY_ERR value:
585 * LY_EDENIED - the value breaks the limits,
586 * LY_EVALID - string contains invalid value,
587 * LY_SUCCESS - successful parsing.
588 */
Radek Krejci249973a2019-06-10 10:50:54 +0200589LY_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 +0100590
591/**
592 * @brief Parse unsigned integer with possible limitation.
Michal Vasko44d474d2023-04-28 14:25:19 +0200593 *
Radek Krejci4f28eda2018-11-12 11:46:16 +0100594 * @param[in] val_str String value containing unsigned integer, note that
595 * nothing else than whitespaces are expected after the value itself.
Radek Krejci249973a2019-06-10 10:50:54 +0200596 * @param[in] val_len Length of the @p val_str string.
Radek Krejci4f28eda2018-11-12 11:46:16 +0100597 * @param[in] max Limitation for the value which must not be higher than max.
598 * @param[in] base Numeric base for parsing:
599 * 0 - to accept decimal, octal, hexadecimal (e.g. in default value)
600 * 10 - to accept only decimal (e.g. data instance value)
601 * @param[out] ret Resulting value.
602 * @return LY_ERR value:
603 * LY_EDENIED - the value breaks the limits,
604 * LY_EVALID - string contains invalid value,
605 * LY_SUCCESS - successful parsing.
606 */
Radek Krejci249973a2019-06-10 10:50:54 +0200607LY_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 +0100608
609/**
Radek Krejcib4a4a272019-06-10 12:44:52 +0200610 * @brief Parse a node-identifier.
611 *
612 * node-identifier = [prefix ":"] identifier
613 *
Michal Vasko44d474d2023-04-28 14:25:19 +0200614 * @param[in,out] id Identifier to parse. When returned, it points to the first character which is not part of the identifier.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200615 * @param[out] prefix Node's prefix, NULL if there is not any.
616 * @param[out] prefix_len Length of the node's prefix, 0 if there is not any.
617 * @param[out] name Node's name.
aPiecekb39f56c2021-05-03 10:47:18 +0200618 * @param[out] name_len Length of the node's name.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200619 * @return LY_ERR value: LY_SUCCESS or LY_EINVAL in case of invalid character in the id.
620 */
621LY_ERR ly_parse_nodeid(const char **id, const char **prefix, size_t *prefix_len, const char **name, size_t *name_len);
622
623/**
624 * @brief parse instance-identifier's predicate, supports key-predicate, leaf-list-predicate and pos rules from YANG ABNF Grammar.
625 *
Michal Vasko44d474d2023-04-28 14:25:19 +0200626 * @param[in,out] pred Predicate string (including the leading '[') to parse. The string is updated according to what was parsed
Radek Krejcib4a4a272019-06-10 12:44:52 +0200627 * (even for error case, so it can be used to determine which substring caused failure).
628 * @param[in] limit Limiting length of the @p pred. Function expects NULL terminated string which is not overread.
629 * 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 +0200630 * @param[in] format Input format of the data containing the @p pred.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200631 * @param[out] prefix Start of the node-identifier's prefix if any, NULL in case of pos or leaf-list-predicate rules.
632 * @param[out] prefix_len Length of the parsed @p prefix.
633 * @param[out] id Start of the node-identifier's identifier string, NULL in case of pos rule, "." in case of leaf-list-predicate rule.
634 * @param[out] id_len Length of the parsed @p id.
Radek Krejci084289f2019-07-09 17:35:30 +0200635 * @param[out] value Start of the quoted-string (without quotation marks), not NULL in case of success.
Radek Krejcib4a4a272019-06-10 12:44:52 +0200636 * @param[out] value_len Length of the parsed @p value.
637 * @param[out] errmsg Error message string in case of error.
638 * @return LY_SUCCESS in case a complete predicate was parsed.
639 * @return LY_EVALID in case of invalid predicate form.
640 * @return LY_EINVAL in case of reaching @p limit when parsing @p pred.
641 */
Radek Krejci084289f2019-07-09 17:35:30 +0200642LY_ERR ly_parse_instance_predicate(const char **pred, size_t limit, LYD_FORMAT format,
Radek Krejci0f969882020-08-21 16:56:47 +0200643 const char **prefix, size_t *prefix_len, const char **id, size_t *id_len,
644 const char **value, size_t *value_len, const char **errmsg);
Michal Vasko1324b6c2018-09-07 11:16:23 +0200645
Radek Krejcif345c012018-09-19 11:12:59 +0200646/**
Radek Krejci86d106e2018-10-18 09:53:19 +0200647 * @brief mmap(2) wrapper to map input files into memory to unify parsing.
Radek Krejcif345c012018-09-19 11:12:59 +0200648 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200649 * The address space is allocate only for reading.
650 *
651 * @param[in] ctx libyang context for logging
652 * @param[in] fd Open file descriptor of a file to map.
653 * @param[out] length Allocated size.
654 * @param[out] addr Address where the file is mapped.
Radek Krejcif345c012018-09-19 11:12:59 +0200655 * @return LY_ERR value.
656 */
Radek Krejci86d106e2018-10-18 09:53:19 +0200657LY_ERR ly_mmap(struct ly_ctx *ctx, int fd, size_t *length, void **addr);
Michal Vasko841d1a92018-09-07 15:40:31 +0200658
Radek Krejci86d106e2018-10-18 09:53:19 +0200659/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200660 * @brief munmap(2) wrapper to free the memory mapped by ::ly_mmap()
Michal Vasko1324b6c2018-09-07 11:16:23 +0200661 *
Radek Krejci86d106e2018-10-18 09:53:19 +0200662 * @param[in] addr Address where the input file is mapped.
663 * @param[in] length Allocated size of the address space.
664 * @return LY_ERR value.
665 */
666LY_ERR ly_munmap(void *addr, size_t length);
667
668/**
Radek Krejci4546aa62019-07-15 16:53:32 +0200669 * @brief Concatenate formating string to the @p dest.
670 *
Michal Vasko44d474d2023-04-28 14:25:19 +0200671 * @param[in,out] dest String to be concatenated by @p format.
672 * Note that the input string can be reallocated during concatenation.
Radek Krejci4546aa62019-07-15 16:53:32 +0200673 * @param[in] format Formating string (as for printf) which is supposed to be added after @p dest.
674 * @return LY_SUCCESS or LY_EMEM.
675 */
Michal Vasko7b3a00e2023-08-09 11:58:03 +0200676LY_ERR ly_strcat(char **dest, const char *format, ...) _FORMAT_PRINTF(2, 3);
Radek Krejci4546aa62019-07-15 16:53:32 +0200677
David Sedláke6cd89e2019-08-07 12:46:02 +0200678#endif /* LY_COMMON_H_ */