blob: 0d9538056bb8692c0ac9194d04dfc66cf10e4d2a [file] [log] [blame]
David Sedlákb1ce3f82019-06-05 14:37:26 +02001/**
2 * @file parser_yin.h
3 * @author David Sedlák <xsedla1d@stud.fit.vutbr.cz>
David Sedlákc5b20842019-08-13 10:18:31 +02004 * @brief YIN parser header file.
David Sedlákb1ce3f82019-06-05 14:37:26 +02005 *
6 * Copyright (c) 2015 - 2019 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 */
David Sedlák2b626ee2019-06-03 16:40:18 +020014
15#ifndef LY_PARSER_YIN_H_
16#define LY_PARSER_YIN_H_
17
18#include <stdio.h>
David Sedlákb1ce3f82019-06-05 14:37:26 +020019#include <stdlib.h>
20
David Sedlák2b626ee2019-06-03 16:40:18 +020021#include "log.h"
22#include "xml.h"
David Sedlák2b626ee2019-06-03 16:40:18 +020023
David Sedlákf6251182019-06-06 10:22:13 +020024/* list of yin attribute strings */
25extern const char *const yin_attr_list[];
26#define yin_attr2str(STMT) yin_attr_list[STMT]
27
David Sedlák2b214ac2019-06-06 16:11:03 +020028#define YIN_NS_URI "urn:ietf:params:xml:ns:yang:yin:1"
David Sedlákd6e56892019-07-01 15:40:24 +020029#define name2fullname(name, prefix_len) (prefix_len != 0 ? name - (prefix_len + 1) : name)
David Sedlákf250ecf2019-07-01 11:02:05 +020030#define namelen2fulllen(name_len, prefix_len) (prefix_len != 0 ? name_len + prefix_len + 1 : name_len)
David Sedlák2b214ac2019-06-06 16:11:03 +020031
David Sedlák26ea1432019-08-14 13:42:23 +020032#define VALID_VALS1 " Only valid value is \"%s\"."
33#define VALID_VALS2 " Valid values are \"%s\" and \"%s\"."
34#define VALID_VALS3 " Valid values are \"%s\", \"%s\" and \"%s\"."
35#define VALID_VALS4 " Valid values are \"%s\", \"%s\", \"%s\" and \"%s\"."
36
David Sedlák4ffcec82019-07-25 15:10:21 +020037/* shortcut to determin if keyword can in general be subelement of deviation regardles of it's type */
38#define isdevsub(kw) (kw == YANG_CONFIG || kw == YANG_DEFAULT || kw == YANG_MANDATORY || \
39 kw == YANG_MAX_ELEMENTS || kw == YANG_MIN_ELEMENTS || \
40 kw == YANG_MUST || kw == YANG_TYPE || kw == YANG_UNIQUE || \
41 kw == YANG_UNITS || kw == YANG_CUSTOM)
42
David Sedlákc5b20842019-08-13 10:18:31 +020043enum yin_argument {
David Sedlák1bccdfa2019-06-17 15:55:27 +020044 YIN_ARG_UNKNOWN = 0, /**< parsed argument can not be matched with any supported yin argument keyword */
David Sedlák2b626ee2019-06-03 16:40:18 +020045 YIN_ARG_NAME, /**< argument name */
46 YIN_ARG_TARGET_NODE, /**< argument target-node */
47 YIN_ARG_MODULE, /**< argument module */
48 YIN_ARG_VALUE, /**< argument value */
49 YIN_ARG_TEXT, /**< argument text */
50 YIN_ARG_CONDITION, /**< argument condition */
51 YIN_ARG_URI, /**< argument uri */
52 YIN_ARG_DATE, /**< argument data */
53 YIN_ARG_TAG, /**< argument tag */
David Sedlák1bccdfa2019-06-17 15:55:27 +020054 YIN_ARG_NONE, /**< empty (special value) */
David Sedlák7ff55a92019-06-17 11:11:41 +020055};
56
David Sedlák1bccdfa2019-06-17 15:55:27 +020057/**
58 * @brief structure to store instance of xml attribute
59 */
David Sedlák7ff55a92019-06-17 11:11:41 +020060struct yin_arg_record {
David Sedlák1bccdfa2019-06-17 15:55:27 +020061 const char *prefix; /**< start of prefix */
62 size_t prefix_len; /**< length of prefix */
63 const char *name; /**< start of name */
64 size_t name_len; /**< length of name */
65 char *content; /**< start of content */
66 size_t content_len; /**< length of content */
67 int dynamic_content; /**< is set to 1 iff content is dynamically allocated 0 otherwise */
David Sedlák2b626ee2019-06-03 16:40:18 +020068};
69
David Sedlákc5b20842019-08-13 10:18:31 +020070/* flags to set constraints of subelements */
David Sedlák3ffbc522019-07-02 17:49:28 +020071#define YIN_SUBELEM_MANDATORY 0x01 /**< is set when subelement is mandatory */
72#define YIN_SUBELEM_UNIQUE 0x02 /**< is set when subelement is unique */
David Sedláke1a30302019-07-10 13:49:38 +020073#define YIN_SUBELEM_FIRST 0x04 /**< is set when subelement is actually yang argument mapped to yin element */
David Sedlák0c2bab92019-07-22 15:33:19 +020074#define YIN_SUBELEM_VER2 0x08 /**< subelemnt is allowed only in modules with version at least 2 (YANG 1.1) */
David Sedlák21f87cd2019-07-03 16:53:23 +020075
76#define YIN_SUBELEM_PARSED 0x80 /**< is set during parsing when given subelement is encountered for the first
David Sedlák3ffbc522019-07-02 17:49:28 +020077 time to simply check validity of given constraints */
78
79struct yin_subelement {
80 enum yang_keyword type; /**< type of keyword */
David Sedlák4a650532019-07-10 11:55:18 +020081 void *dest; /**< meta infromation passed to responsible function (mostly information about where parsed subelement should be stored) */
David Sedlákc5b20842019-08-13 10:18:31 +020082 uint8_t flags; /**< describes constraints of subelement can be set to YIN_SUBELEM_MANDATORY, YIN_SUBELEM_UNIQUE, YIN_SUBELEM_FIRST and YIN_SUBELEM_VER2 */
David Sedlák3ffbc522019-07-02 17:49:28 +020083};
84
David Sedlákb4e44562019-07-04 15:42:12 +020085/* Meta information passed to yin_parse_argument function,
86 holds information about where content of argument element will be stored. */
David Sedlák3ffbc522019-07-02 17:49:28 +020087struct yin_argument_meta {
David Sedlákb4e44562019-07-04 15:42:12 +020088 uint16_t *flags; /**< Argument flags */
89 const char **argument; /**< Argument value */
David Sedlák3ffbc522019-07-02 17:49:28 +020090};
91
David Sedlák6881b512019-08-13 12:52:00 +020092/**
93 * @brief Meta information passed to functions working with tree_schema,
94 * that require additional information about parent node.
95 */
David Sedlák8a83bbb2019-07-18 14:46:00 +020096struct tree_node_meta {
97 struct lysp_node *parent; /**< parent node */
98 struct lysp_node **siblings; /**< linked list of siblings */
99};
100
David Sedlák6881b512019-08-13 12:52:00 +0200101/**
102 * @brief Meta information passed to yin_parse_import function.
103 */
David Sedlák298ff6d2019-07-26 14:29:03 +0200104struct import_meta {
105 const char *prefix; /**< module prefix. */
106 struct lysp_import **imports; /**< imports to add to. */
107};
108
David Sedlák6881b512019-08-13 12:52:00 +0200109/**
110 * @brief Meta information passed to yin_parse_include function.
111 */
112struct include_meta {
113 const char *name; /**< Module/submodule name. */
114 struct lysp_include **includes; /**< [Sized array](@ref sizedarrays) of parsed includes to add to. */
115};
116
117/**
David Sedlák81497a32019-08-13 16:56:26 +0200118 * @brief Meta information passed to yin_parse_inout function.
David Sedlák6881b512019-08-13 12:52:00 +0200119 */
120struct inout_meta {
121 struct lysp_node *parent; /**< Parent node. */
122 struct lysp_action_inout *inout_p; /**< inout_p Input/output pointer to write to. */
123};
124
125/**
126 * @brief Meta information passed to yin_parse_minmax function.
127 */
David Sedlák4ffcec82019-07-25 15:10:21 +0200128struct minmax_dev_meta {
David Sedlák6881b512019-08-13 12:52:00 +0200129 uint32_t *lim; /**< min/max value to write to. */
130 uint16_t *flags; /**< min/max flags to write to. */
131 struct lysp_ext_instance **exts; /**< extension instances to add to. */
David Sedlák4ffcec82019-07-25 15:10:21 +0200132};
133
David Sedlák2b626ee2019-06-03 16:40:18 +0200134/**
135 * @brief Match argument name.
136 *
137 * @param[in] name String representing name.
138 * @param[in] len Lenght of the name.
139 *
David Sedlákb1ce3f82019-06-05 14:37:26 +0200140 * @return YIN_ARGUMENT value.
David Sedlák2b626ee2019-06-03 16:40:18 +0200141 */
David Sedlákc5b20842019-08-13 10:18:31 +0200142enum yin_argument yin_match_argument_name(const char *name, size_t len);
David Sedlák2b626ee2019-06-03 16:40:18 +0200143
144/**
David Sedlák555c7202019-07-04 12:14:12 +0200145 * @brief Generic function for content parsing
David Sedlák2b626ee2019-06-03 16:40:18 +0200146 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200147 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlák555c7202019-07-04 12:14:12 +0200148 * @param[in] subelem_info array of valid subelement types and meta information,
149 * array must be ordered by subelem_info->type in ascending order.
150 * @param[in] subelem_info_size Size of subelem_info array.
151 * @param[in,out] data Data to read from, always moved to currently handled character.
152 * @param[in] current_element Type of current element.
David Sedlákc5b20842019-08-13 10:18:31 +0200153 * @param[out] text_content Where the text content of element should be stored if any. Text content is ignored if not set to NULL.
David Sedlákda8ffa32019-07-08 14:17:10 +0200154 * @param[in,out] exts Extension instance to add to. Can be se to null if element cannot have extension as subelements.
David Sedlákc5b20842019-08-13 10:18:31 +0200155 *
David Sedlák2b214ac2019-06-06 16:11:03 +0200156 * @return LY_ERR values.
David Sedlák2b626ee2019-06-03 16:40:18 +0200157 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200158LY_ERR yin_parse_content(struct yin_parser_ctx *ctx, struct yin_subelement *subelem_info, signed char subelem_info_size,
David Sedlák555c7202019-07-04 12:14:12 +0200159 const char **data, enum yang_keyword current_element, const char **text_content,
160 struct lysp_ext_instance **exts);
David Sedlák2b626ee2019-06-03 16:40:18 +0200161
David Sedlákd9d3a312019-06-04 09:47:10 +0200162/**
David Sedlák4a650532019-07-10 11:55:18 +0200163 * @brief Check that val is valid UTF8 character sequence of val_type.
164 * Doesn't check empty string, only character validity.
165 *
166 * @param[in] ctx Yin parser context for logging.
167 * @param[in] val_type Type of the input string to select method of checking character validity.
168 * @param[in] val Input to validate.
169 * @param[in] len Length of input.
170 *
171 * @return LY_ERR values.
172 */
173LY_ERR yin_validate_value(struct yin_parser_ctx *ctx, enum yang_arg val_type, char *val, size_t len);
174
175/**
David Sedlákb4e44562019-07-04 15:42:12 +0200176 * @brief Match yang keyword from yin data.
David Sedlák1bccdfa2019-06-17 15:55:27 +0200177 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200178 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákb4e44562019-07-04 15:42:12 +0200179 * @param[in] name Start of keyword name
David Sedlák8f7a1172019-06-20 14:42:18 +0200180 * @param[in] name_len Lenght of keyword name.
181 * @param[in] prefix Start of keyword prefix.
David Sedlákc5b20842019-08-13 10:18:31 +0200182 * @param[in] prefix_len Lenght of prefix.
David Sedlákc1771b12019-07-10 15:55:46 +0200183 * @param[in] parrent Identification of parrent element, use YANG_NONE for elements without parrent.
David Sedlák1bccdfa2019-06-17 15:55:27 +0200184 *
185 * @return yang_keyword values.
186 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200187enum yang_keyword yin_match_keyword(struct yin_parser_ctx *ctx, const char *name, size_t name_len,
David Sedlákc1771b12019-07-10 15:55:46 +0200188 const char *prefix, size_t prefix_len, enum yang_keyword parrent);
David Sedlák1bccdfa2019-06-17 15:55:27 +0200189
David Sedlákb6e65972019-06-19 10:44:13 +0200190/**
David Sedlákc5b20842019-08-13 10:18:31 +0200191 * @brief Load all attributes of element into ([sized array](@ref sizedarrays)). Caller is suposed to free the array.
David Sedlák8f7a1172019-06-20 14:42:18 +0200192 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200193 * @param[in,out] ctx Yin parser context for logging and to store current state.
194 * @param[in,out] data Data to read from, always moved to currently handled character.
David Sedlákbba38e52019-07-09 15:20:01 +0200195 * @param[out] attrs ([Sized array](@ref sizedarrays)) of attributes.
David Sedlák8f7a1172019-06-20 14:42:18 +0200196 *
197 * @return LY_ERR values.
198 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200199LY_ERR yin_load_attributes(struct yin_parser_ctx *ctx, const char **data, struct yin_arg_record **attrs);
David Sedlákb6e65972019-06-19 10:44:13 +0200200
David Sedlák554e36d2019-06-20 16:00:04 +0200201/**
David Sedlákb1a78352019-06-28 16:16:29 +0200202 * @brief Parse instance of extension.
203 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200204 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákbba38e52019-07-09 15:20:01 +0200205 * @param[in] attrs [Sized array](@ref sizedarrays) of attributes of extension instance.
David Sedlákb1a78352019-06-28 16:16:29 +0200206 * @param[in,out] data Data to read from, always moved to currently handled character.
207 * @param[in] ext_name Name of the extension element.
208 * @param[in] ext_name_len Length of extension name.
David Sedlákb4e44562019-07-04 15:42:12 +0200209 * @param[in] subelem Type of the keyword this extension instance is a subelement of.
210 * @param[in] subelem_index Index of the keyword instance this extension instance is a subelement of
211 * @param[in,out] exts Extension instance to add to.
David Sedlákb1a78352019-06-28 16:16:29 +0200212 *
213 * @return LY_ERR values.
214 */
David Sedlák1f90d252019-07-10 17:09:32 +0200215LY_ERR yin_parse_extension_instance(struct yin_parser_ctx *ctx, struct yin_arg_record *attrs, const char **data,
David Sedlák619db942019-07-03 14:47:30 +0200216 const char *ext_name, int ext_name_len, LYEXT_SUBSTMT subelem,
217 uint32_t subelem_index, struct lysp_ext_instance **exts);
David Sedlákb1a78352019-06-28 16:16:29 +0200218
219/**
220 * @brief Parse yin element into generic structure.
221 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200222 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákb1a78352019-06-28 16:16:29 +0200223 * @param[in] name Name of element.
224 * @param[in] name_len Length of elements Name.
225 * @param[in,out] data Data to read from, always moved to currently handled character.
226 * @param[out] element Where the element structure should be stored.
227 *
228 * @return LY_ERR values.
229 */
David Sedlák4ffcec82019-07-25 15:10:21 +0200230LY_ERR yin_parse_element_generic(struct yin_parser_ctx *ctx, const char *name, size_t name_len, const char **data,
231 struct lysp_stmt **element);
David Sedlákb1a78352019-06-28 16:16:29 +0200232
David Sedlák4f03b932019-07-26 13:01:47 +0200233/**
David Sedlák298ff6d2019-07-26 14:29:03 +0200234 * @brief Parse module element.
David Sedlák4f03b932019-07-26 13:01:47 +0200235 *
236 * @param[in,out] ctx Yin parser context for logging and to store current state.
237 * @param[in] mod_attrs Attributes of module element.
238 * @param[in,out] data Data to read from.
239 * @param[out] mod Parsed module structure.
240 *
241 * @return LY_ERR values.
242 */
David Sedlák298ff6d2019-07-26 14:29:03 +0200243LY_ERR yin_parse_mod(struct yin_parser_ctx *ctx, struct yin_arg_record *mod_attrs,
244 const char **data, struct lysp_module *mod);
David Sedlák4f03b932019-07-26 13:01:47 +0200245
246
247/**
David Sedlák298ff6d2019-07-26 14:29:03 +0200248 * @brief Parse submodule element.
249 *
250 * @param[in,out] ctx Yin parser context for logging and to store current state.
251 * @param[in] mod_attrs Attributes of module element.
252 * @param[in,out] data Data to read from.
253 * @param[out] mod Parsed module structure.
254 *
255 * @return LY_ERR values.
256 */
257LY_ERR yin_parse_submod(struct yin_parser_ctx *ctx, struct yin_arg_record *mod_attrs,
258 const char **data, struct lysp_submodule *submod);
259
260/**
David Sedlák4f03b932019-07-26 13:01:47 +0200261 * @brief free argument record, content loaded from lyxml_get_string() can be
262 * dynamically allocated in some cases so it must be also freed.
263 *
David Sedlákc5b20842019-08-13 10:18:31 +0200264 * @param ctx unused just to fulfill signature of callback for FREE_ARRAY.
265 * @param[in] record Record to free.
David Sedlák4f03b932019-07-26 13:01:47 +0200266 */
267void free_arg_rec(struct yin_parser_ctx *ctx, struct yin_arg_record *record);
268
David Sedlák2b626ee2019-06-03 16:40:18 +0200269#endif /* LY_PARSER_YIN_H_*/