blob: 9b8ca1e5c5cbc1d0a2822043be36377e5e49dbbb [file] [log] [blame]
Radek Krejcif0e1ba52020-05-22 15:14:35 +02001/**
2 * @file parser_internal.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief Internal structures and functions for libyang parsers
5 *
6 * Copyright (c) 2020 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_PARSER_INTERNAL_H_
16#define LY_PARSER_INTERNAL_H_
17
Michal Vaskoe0665742021-02-11 11:08:44 +010018#include "parser_data.h"
Michal Vaskoc8a230d2020-08-14 12:17:10 +020019#include "plugins_types.h"
Radek Krejcif0e1ba52020-05-22 15:14:35 +020020#include "tree_schema_internal.h"
21
Radek Krejci1798aae2020-07-14 13:26:06 +020022struct lyd_ctx;
Michal Vaskoafac7822020-10-20 14:22:26 +020023struct ly_in;
Michal Vaskoc8a230d2020-08-14 12:17:10 +020024
Radek Krejci1798aae2020-07-14 13:26:06 +020025/**
26 * @brief Callback for lyd_ctx to free the structure
27 *
28 * @param[in] ctx Data parser context to free.
29 */
30typedef void (*lyd_ctx_free_clb)(struct lyd_ctx *ctx);
31
32/**
Michal Vaskoe0665742021-02-11 11:08:44 +010033 * @brief Internal data parser flags.
34 */
35#define LYD_INTOPT_RPC 0x01 /**< RPC request is being parsed. */
36#define LYD_INTOPT_ACTION 0x02 /**< Action request is being parsed. */
37#define LYD_INTOPT_REPLY 0x04 /**< RPC/action reply is being parsed. */
38#define LYD_INTOPT_NOTIF 0x08 /**< Notification is being parsed. */
39#define LYD_INTOPT_WITH_SIBLINGS 0x10 /**< Parse the whole input with any siblings. */
40#define LYD_INTOPT_NO_SIBLINGS 0x20 /**< If there are any siblings, return an error. */
41
42/**
Radek Krejci1798aae2020-07-14 13:26:06 +020043 * @brief Internal (common) context for YANG data parsers.
Radek Krejci4f2e3e52021-03-30 14:20:28 +020044 *
45 * Covers ::lyd_xml_ctx, ::lyd_json_ctx and lyd_lyb_ctx.
Radek Krejci1798aae2020-07-14 13:26:06 +020046 */
47struct lyd_ctx {
Radek Krejcif16e2542021-02-17 15:39:23 +010048 const struct lysc_ext_instance *ext; /**< extension instance possibly changing document root context of the data being parsed */
Michal Vaskoe0665742021-02-11 11:08:44 +010049 uint32_t parse_opts; /**< various @ref dataparseroptions. */
50 uint32_t val_opts; /**< various @ref datavalidationoptions. */
51 uint32_t int_opts; /**< internal parser options */
Radek Krejci1798aae2020-07-14 13:26:06 +020052 uint32_t path_len; /**< used bytes in the path buffer */
53#define LYD_PARSER_BUFSIZE 4078
54 char path[LYD_PARSER_BUFSIZE]; /**< buffer for the generated path */
Michal Vaskoc43c8ab2021-03-05 13:32:44 +010055 struct ly_set node_when; /**< set of nodes with "when" conditions */
Radek Krejci4f2e3e52021-03-30 14:20:28 +020056 struct ly_set node_exts; /**< set of nodes and extensions connected with a plugin providing own validation callback */
Michal Vasko32711382020-12-03 14:14:31 +010057 struct ly_set node_types; /**< set of nodes validated with LY_EINCOMPLETE result */
58 struct ly_set meta_types; /**< set of metadata validated with LY_EINCOMPLETE result */
Radek Krejci1798aae2020-07-14 13:26:06 +020059 struct lyd_node *op_node; /**< if an RPC/action/notification is being parsed, store the pointer to it */
60
61 /* callbacks */
Radek Krejci0bff0b12020-08-15 18:37:50 +020062 lyd_ctx_free_clb free; /**< destructor */
Radek Krejci1798aae2020-07-14 13:26:06 +020063
64 struct {
Radek Krejci0bff0b12020-08-15 18:37:50 +020065 const struct ly_ctx *ctx; /**< libyang context */
66 uint64_t line; /**< current line */
67 struct ly_in *in; /**< input structure */
68 } *data_ctx; /**< generic pointer supposed to map to and access (common part of) XML/JSON/... parser contexts */
Radek Krejci1798aae2020-07-14 13:26:06 +020069};
70
Radek Krejci7931b192020-06-25 17:05:03 +020071/**
Radek Krejci1798aae2020-07-14 13:26:06 +020072 * @brief Common part of the lyd_ctx_free_t callbacks.
73 */
74void lyd_ctx_free(struct lyd_ctx *);
75
76/**
Radek Krejcif0e1ba52020-05-22 15:14:35 +020077 * @brief Parse submodule from YANG data.
78 * @param[in,out] ctx Parser context.
79 * @param[in] ly_ctx Context of YANG schemas.
80 * @param[in] main_ctx Parser context of main module.
Michal Vasko63f3d842020-07-08 10:10:14 +020081 * @param[in] in Input structure.
Radek Krejcif0e1ba52020-05-22 15:14:35 +020082 * @param[out] submod Pointer to the parsed submodule structure.
83 * @return LY_ERR value - LY_SUCCESS, LY_EINVAL or LY_EVALID.
84 */
85LY_ERR yang_parse_submodule(struct lys_yang_parser_ctx **context, struct ly_ctx *ly_ctx, struct lys_parser_ctx *main_ctx,
Radek Krejci0f969882020-08-21 16:56:47 +020086 struct ly_in *in, struct lysp_submodule **submod);
Radek Krejcif0e1ba52020-05-22 15:14:35 +020087
88/**
89 * @brief Parse module from YANG data.
90 * @param[in] ctx Parser context.
Michal Vasko63f3d842020-07-08 10:10:14 +020091 * @param[in] in Input structure.
92 * @param[in,out] mod Prepared module structure where the parsed information, including the parsed
Radek Krejcif0e1ba52020-05-22 15:14:35 +020093 * module structure, will be filled in.
Michal Vasko405cc9e2020-12-01 12:01:27 +010094 * @param[in,out] unres Global unres structure.
95 * @return LY_ERR values.
Radek Krejcif0e1ba52020-05-22 15:14:35 +020096 */
Michal Vasko405cc9e2020-12-01 12:01:27 +010097LY_ERR yang_parse_module(struct lys_yang_parser_ctx **context, struct ly_in *in, struct lys_module *mod,
98 struct lys_glob_unres *unres);
Radek Krejcif0e1ba52020-05-22 15:14:35 +020099
100/**
101 * @brief Parse module from YIN data.
102 *
103 * @param[in,out] yin_ctx Context created during parsing, is used to finalize lysp_model after it's completly parsed.
Michal Vasko63f3d842020-07-08 10:10:14 +0200104 * @param[in] in Input structure.
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200105 * @param[in,out] mod Prepared module structure where the parsed information, including the parsed
106 * module structure, will be filled in.
Michal Vasko405cc9e2020-12-01 12:01:27 +0100107 * @param[in,out] unres Global unres structure.
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200108 * @return LY_ERR values.
109 */
Michal Vasko405cc9e2020-12-01 12:01:27 +0100110LY_ERR yin_parse_module(struct lys_yin_parser_ctx **yin_ctx, struct ly_in *in, struct lys_module *mod,
111 struct lys_glob_unres *unres);
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200112
113/**
114 * @brief Parse submodule from YIN data.
115 *
116 * @param[in,out] yin_ctx Context created during parsing, is used to finalize lysp_model after it's completly parsed.
117 * @param[in] ctx Libyang context.
118 * @param[in] main_ctx Parser context of main module.
Michal Vasko63f3d842020-07-08 10:10:14 +0200119 * @param[in] in Input structure.
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200120 * @param[in,out] submod Submodule structure where the parsed information, will be filled in.
121 * @return LY_ERR values.
122 */
123LY_ERR yin_parse_submodule(struct lys_yin_parser_ctx **yin_ctx, struct ly_ctx *ctx, struct lys_parser_ctx *main_ctx,
Radek Krejci0f969882020-08-21 16:56:47 +0200124 struct ly_in *in, struct lysp_submodule **submod);
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200125
Radek Krejci1798aae2020-07-14 13:26:06 +0200126/**
Michal Vaskoe0665742021-02-11 11:08:44 +0100127 * @brief Parse XML string as a YANG data tree.
Michal Vaskoafac7822020-10-20 14:22:26 +0200128 *
Michal Vaskoe0665742021-02-11 11:08:44 +0100129 * @param[in] ctx libyang context.
Radek Krejcif16e2542021-02-17 15:39:23 +0100130 * @param[in] ext Optional extenion instance to parse data following the schema tree specified in the extension instance
Michal Vaskoe0665742021-02-11 11:08:44 +0100131 * @param[in] parent Parent to connect the parsed nodes to, if any.
132 * @param[in,out] first_p Pointer to the first top-level parsed node, used only if @p parent is NULL.
Michal Vaskoafac7822020-10-20 14:22:26 +0200133 * @param[in] in Input structure.
Michal Vaskoe0665742021-02-11 11:08:44 +0100134 * @param[in] parse_opts Options for parser, see @ref dataparseroptions.
135 * @param[in] val_opts Options for the validation phase, see @ref datavalidationoptions.
136 * @param[in] data_type Expected data type of the data.
Michal Vasko299d5d12021-02-16 16:36:37 +0100137 * @param[out] envp Individual parsed envelopes tree, returned only by specific @p data_type and possibly even if
138 * an error occurs later.
Michal Vaskoe0665742021-02-11 11:08:44 +0100139 * @param[out] parsed Set to add all the parsed siblings into.
Michal Vaskoafac7822020-10-20 14:22:26 +0200140 * @param[out] lydctx_p Data parser context to finish validation.
141 * @return LY_ERR value.
142 */
Radek Krejcif16e2542021-02-17 15:39:23 +0100143LY_ERR lyd_parse_xml(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
144 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, enum lyd_type data_type,
145 struct lyd_node **envp, struct ly_set *parsed, struct lyd_ctx **lydctx_p);
Michal Vaskoafac7822020-10-20 14:22:26 +0200146
147/**
Michal Vaskoe0665742021-02-11 11:08:44 +0100148 * @brief Parse JSON string as a YANG data tree.
Michal Vaskoafac7822020-10-20 14:22:26 +0200149 *
Michal Vaskoafac7822020-10-20 14:22:26 +0200150 * @param[in] ctx libyang context.
Radek Krejcif16e2542021-02-17 15:39:23 +0100151 * @param[in] ext Optional extenion instance to parse data following the schema tree specified in the extension instance
Michal Vaskoe0665742021-02-11 11:08:44 +0100152 * @param[in] parent Parent to connect the parsed nodes to, if any.
153 * @param[in,out] first_p Pointer to the first top-level parsed node, used only if @p parent is NULL.
Michal Vaskoafac7822020-10-20 14:22:26 +0200154 * @param[in] in Input structure.
Michal Vaskoe0665742021-02-11 11:08:44 +0100155 * @param[in] parse_opts Options for parser, see @ref dataparseroptions.
156 * @param[in] val_opts Options for the validation phase, see @ref datavalidationoptions.
157 * @param[in] data_type Expected data type of the data.
158 * @param[out] parsed Set to add all the parsed siblings into.
Michal Vaskoafac7822020-10-20 14:22:26 +0200159 * @param[out] lydctx_p Data parser context to finish validation.
160 * @return LY_ERR value.
161 */
Radek Krejcif16e2542021-02-17 15:39:23 +0100162LY_ERR lyd_parse_json(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
163 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, enum lyd_type data_type,
164 struct ly_set *parsed, struct lyd_ctx **lydctx_p);
Michal Vaskoafac7822020-10-20 14:22:26 +0200165
166/**
Michal Vaskoe0665742021-02-11 11:08:44 +0100167 * @brief Parse binary LYB data as a YANG data tree.
Michal Vaskoafac7822020-10-20 14:22:26 +0200168 *
Michal Vaskoafac7822020-10-20 14:22:26 +0200169 * @param[in] ctx libyang context.
Radek Krejcif16e2542021-02-17 15:39:23 +0100170 * @param[in] ext Optional extenion instance to parse data following the schema tree specified in the extension instance
Michal Vaskoe0665742021-02-11 11:08:44 +0100171 * @param[in] parent Parent to connect the parsed nodes to, if any.
172 * @param[in,out] first_p Pointer to the first top-level parsed node, used only if @p parent is NULL.
Michal Vaskoafac7822020-10-20 14:22:26 +0200173 * @param[in] in Input structure.
Michal Vaskoe0665742021-02-11 11:08:44 +0100174 * @param[in] parse_opts Options for parser, see @ref dataparseroptions.
175 * @param[in] val_opts Options for the validation phase, see @ref datavalidationoptions.
176 * @param[in] data_type Expected data type of the data.
177 * @param[out] parsed Set to add all the parsed siblings into.
Michal Vaskoafac7822020-10-20 14:22:26 +0200178 * @param[out] lydctx_p Data parser context to finish validation.
179 * @return LY_ERR value.
180 */
Radek Krejcif16e2542021-02-17 15:39:23 +0100181LY_ERR lyd_parse_lyb(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
182 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, enum lyd_type data_type,
183 struct ly_set *parsed, struct lyd_ctx **lydctx_p);
Michal Vaskoafac7822020-10-20 14:22:26 +0200184
185/**
Michal Vaskoe0665742021-02-11 11:08:44 +0100186 * @brief Search all the parents for an operation node, check validity based on internal parser flags.
Michal Vaskoafac7822020-10-20 14:22:26 +0200187 *
Michal Vaskoe0665742021-02-11 11:08:44 +0100188 * @param[in] parent Parent to connect the parsed nodes to.
189 * @param[in] int_opt Internal parser options.
190 * @param[out] op Found operation, if any.
Michal Vaskoafac7822020-10-20 14:22:26 +0200191 * @return LY_ERR value.
192 */
Michal Vaskoe0665742021-02-11 11:08:44 +0100193LY_ERR lyd_parser_find_operation(const struct lyd_node *parent, uint32_t int_opts, struct lyd_node **op);
Michal Vaskoafac7822020-10-20 14:22:26 +0200194
195/**
Radek Krejci1798aae2020-07-14 13:26:06 +0200196 * @brief Check that a data node representing the @p snode is suitable based on options.
197 *
198 * @param[in] lydctx Common data parsers context.
199 * @param[in] snode Schema node to check.
200 * @return LY_SUCCESS or LY_EVALID
201 */
202LY_ERR lyd_parser_check_schema(struct lyd_ctx *lydctx, const struct lysc_node *snode);
203
204/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200205 * @brief Wrapper around ::lyd_create_term() for data parsers.
Radek Krejci1798aae2020-07-14 13:26:06 +0200206 *
207 * @param[in] lydctx Data parser context.
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200208 * @param[in] hints Data parser's hint for the value's type.
Radek Krejci1798aae2020-07-14 13:26:06 +0200209 */
Radek Krejci09c77442021-04-26 11:10:34 +0200210LY_ERR lyd_parser_create_term(struct lyd_ctx *lydctx, const struct lysc_node *schema, const void *value, size_t value_len,
Radek Krejci8df109d2021-04-23 12:19:08 +0200211 ly_bool *dynamic, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints, struct lyd_node **node);
Radek Krejci1798aae2020-07-14 13:26:06 +0200212
213/**
Radek Krejci8678fa42020-08-18 16:07:28 +0200214 * @brief Wrapper around ::lyd_create_meta() for data parsers.
Radek Krejci1798aae2020-07-14 13:26:06 +0200215 *
216 * @param[in] lydctx Data parser context.
Michal Vaskob68571a2020-11-06 17:18:41 +0100217 * @param[in] parent Parent of the created meta. Must be set if @p meta is NULL.
218 * @param[in,out] meta First existing meta to connect to or empty pointer to set. Must be set if @p parent is NULL.
219 * @param[in] mod Module of the created metadata.
220 * @param[in] name Metadata name.
221 * @param[in] name_len Length of @p name.
222 * @param[in] value Metadata value.
223 * @param[in] value_len Length of @p value.
224 * @param[in,out] dynamic Whether the @p value is dynamically allocated, is adjusted once the value is assigned.
225 * @param[in] format Prefix format.
226 * @param[in] prefix_data Prefix format data (see ::ly_resolve_prefix()).
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200227 * @param[in] hints [Value hint](@ref lydvalhints) from the parser regarding the value type.
Michal Vaskob68571a2020-11-06 17:18:41 +0100228 * @return LY_ERR value.
Radek Krejci1798aae2020-07-14 13:26:06 +0200229 */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200230LY_ERR lyd_parser_create_meta(struct lyd_ctx *lydctx, struct lyd_node *parent, struct lyd_meta **meta,
Radek Krejcif9943642021-04-26 10:18:21 +0200231 const struct lys_module *mod, const char *name, size_t name_len, const void *value,
Radek Krejci8df109d2021-04-23 12:19:08 +0200232 size_t value_len, ly_bool *dynamic, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints);
Radek Krejci1798aae2020-07-14 13:26:06 +0200233
Radek Krejcif0e1ba52020-05-22 15:14:35 +0200234#endif /* LY_PARSER_INTERNAL_H_ */