blob: eda898ce8c1fac23343c84f6a4dc7a8f906cd66f [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ák4ffcec82019-07-25 15:10:21 +020032/* shortcut to determin if keyword can in general be subelement of deviation regardles of it's type */
33#define isdevsub(kw) (kw == YANG_CONFIG || kw == YANG_DEFAULT || kw == YANG_MANDATORY || \
34 kw == YANG_MAX_ELEMENTS || kw == YANG_MIN_ELEMENTS || \
35 kw == YANG_MUST || kw == YANG_TYPE || kw == YANG_UNIQUE || \
36 kw == YANG_UNITS || kw == YANG_CUSTOM)
37
David Sedlákc5b20842019-08-13 10:18:31 +020038enum yin_argument {
David Sedlák1bccdfa2019-06-17 15:55:27 +020039 YIN_ARG_UNKNOWN = 0, /**< parsed argument can not be matched with any supported yin argument keyword */
David Sedlák2b626ee2019-06-03 16:40:18 +020040 YIN_ARG_NAME, /**< argument name */
41 YIN_ARG_TARGET_NODE, /**< argument target-node */
42 YIN_ARG_MODULE, /**< argument module */
43 YIN_ARG_VALUE, /**< argument value */
44 YIN_ARG_TEXT, /**< argument text */
45 YIN_ARG_CONDITION, /**< argument condition */
46 YIN_ARG_URI, /**< argument uri */
47 YIN_ARG_DATE, /**< argument data */
48 YIN_ARG_TAG, /**< argument tag */
David Sedlák1bccdfa2019-06-17 15:55:27 +020049 YIN_ARG_NONE, /**< empty (special value) */
David Sedlák7ff55a92019-06-17 11:11:41 +020050};
51
David Sedlák1bccdfa2019-06-17 15:55:27 +020052/**
53 * @brief structure to store instance of xml attribute
54 */
David Sedlák7ff55a92019-06-17 11:11:41 +020055struct yin_arg_record {
David Sedlák1bccdfa2019-06-17 15:55:27 +020056 const char *prefix; /**< start of prefix */
57 size_t prefix_len; /**< length of prefix */
58 const char *name; /**< start of name */
59 size_t name_len; /**< length of name */
60 char *content; /**< start of content */
61 size_t content_len; /**< length of content */
62 int dynamic_content; /**< is set to 1 iff content is dynamically allocated 0 otherwise */
David Sedlák2b626ee2019-06-03 16:40:18 +020063};
64
David Sedlákc5b20842019-08-13 10:18:31 +020065/* flags to set constraints of subelements */
David Sedlák3ffbc522019-07-02 17:49:28 +020066#define YIN_SUBELEM_MANDATORY 0x01 /**< is set when subelement is mandatory */
67#define YIN_SUBELEM_UNIQUE 0x02 /**< is set when subelement is unique */
David Sedláke1a30302019-07-10 13:49:38 +020068#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 +020069#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 +020070
71#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 +020072 time to simply check validity of given constraints */
73
74struct yin_subelement {
75 enum yang_keyword type; /**< type of keyword */
David Sedlák4a650532019-07-10 11:55:18 +020076 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 +020077 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 +020078};
79
David Sedlákb4e44562019-07-04 15:42:12 +020080/* Meta information passed to yin_parse_argument function,
81 holds information about where content of argument element will be stored. */
David Sedlák3ffbc522019-07-02 17:49:28 +020082struct yin_argument_meta {
David Sedlákb4e44562019-07-04 15:42:12 +020083 uint16_t *flags; /**< Argument flags */
84 const char **argument; /**< Argument value */
David Sedlák3ffbc522019-07-02 17:49:28 +020085};
86
David Sedlák04e17b22019-07-19 15:29:48 +020087/* Meta information passed to functions working with tree schema such as yin_parse_any */
David Sedlák8a83bbb2019-07-18 14:46:00 +020088struct tree_node_meta {
89 struct lysp_node *parent; /**< parent node */
90 struct lysp_node **siblings; /**< linked list of siblings */
91};
92
David Sedlák04e17b22019-07-19 15:29:48 +020093/* Meta information passed to yin_parse_typedef */
94struct typedef_meta {
95 struct lysp_node *parent; /**< parent node */
David Sedlák0d6de5a2019-07-22 13:25:44 +020096 struct lysp_tpdf **typedefs; /**< [Sized array](@ref sizedarrays) of typedefs to add to */
97};
98
David Sedlák0c2bab92019-07-22 15:33:19 +020099/* Meta information passed to yin_parse_augment function */
David Sedlák0d6de5a2019-07-22 13:25:44 +0200100struct augment_meta {
101 struct lysp_node *parent; /**< parent node */
102 struct lysp_augment **augments; /**< [Sized array](@ref sizedarrays) of augments to add to */
David Sedlák04e17b22019-07-19 15:29:48 +0200103};
104
David Sedlák0c2bab92019-07-22 15:33:19 +0200105/* Meta information passed to yin_parse_include function */
106struct include_meta {
David Sedlák05404f62019-07-24 14:11:53 +0200107 const char *name; /**< Module/submodule name. */
108 struct lysp_include **includes; /**< [Sized array](@ref sizedarrays) of parsed includes to add to. */
David Sedlák0c2bab92019-07-22 15:33:19 +0200109};
110
David Sedlák05404f62019-07-24 14:11:53 +0200111/* Meta information passed to yin_parse_notification function */
David Sedlák031b9e72019-07-23 15:19:37 +0200112struct notif_meta {
David Sedlák05404f62019-07-24 14:11:53 +0200113 struct lysp_node *parent; /**< Parent node. */
114 struct lysp_notif **notifs; /**< [Sized array](@ref sizedarrays) of notifications to add to. */
David Sedláke3ce9ef2019-07-23 16:34:30 +0200115};
116
David Sedlák05404f62019-07-24 14:11:53 +0200117/* Meta information passed to yin_parse_grouping function */
David Sedláke3ce9ef2019-07-23 16:34:30 +0200118struct grouping_meta {
David Sedlák05404f62019-07-24 14:11:53 +0200119 struct lysp_node *parent; /**< Parent node. */
120 struct lysp_grp **groupings; /**< [Sized array](@ref sizedarrays) of groupings to add to. */
121};
122
123/* Meta information passed to yin_parse_grouping function */
124struct inout_meta {
David Sedlák85d0eca2019-07-24 15:15:21 +0200125 struct lysp_node *parent; /**< Parent node. */
David Sedlák05404f62019-07-24 14:11:53 +0200126 struct lysp_action_inout *inout_p; /**< inout_p Input/output pointer to write to. */
David Sedlák031b9e72019-07-23 15:19:37 +0200127};
128
David Sedlák992fb7c2019-07-24 16:51:01 +0200129/* Meta information passed to yin_parse_action function */
David Sedlák85d0eca2019-07-24 15:15:21 +0200130struct action_meta {
131 struct lysp_node *parent; /**< Parent node. */
132 struct lysp_action **actions; /**< Actions to add to. */
133};
134
David Sedlák298ff6d2019-07-26 14:29:03 +0200135/* Meta information passed to yin_parse_import function */
136struct import_meta {
137 const char *prefix; /**< module prefix. */
138 struct lysp_import **imports; /**< imports to add to. */
139};
140
David Sedlák4ffcec82019-07-25 15:10:21 +0200141struct minmax_dev_meta {
142 uint32_t *lim;
143 uint16_t *flags;
144 struct lysp_ext_instance **exts;
145};
146
David Sedlák2b626ee2019-06-03 16:40:18 +0200147/**
148 * @brief Match argument name.
149 *
150 * @param[in] name String representing name.
151 * @param[in] len Lenght of the name.
152 *
David Sedlákb1ce3f82019-06-05 14:37:26 +0200153 * @return YIN_ARGUMENT value.
David Sedlák2b626ee2019-06-03 16:40:18 +0200154 */
David Sedlákc5b20842019-08-13 10:18:31 +0200155enum yin_argument yin_match_argument_name(const char *name, size_t len);
David Sedlák2b626ee2019-06-03 16:40:18 +0200156
157/**
David Sedlák555c7202019-07-04 12:14:12 +0200158 * @brief Generic function for content parsing
David Sedlák2b626ee2019-06-03 16:40:18 +0200159 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200160 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlák555c7202019-07-04 12:14:12 +0200161 * @param[in] subelem_info array of valid subelement types and meta information,
162 * array must be ordered by subelem_info->type in ascending order.
163 * @param[in] subelem_info_size Size of subelem_info array.
164 * @param[in,out] data Data to read from, always moved to currently handled character.
165 * @param[in] current_element Type of current element.
David Sedlákc5b20842019-08-13 10:18:31 +0200166 * @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 +0200167 * @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 +0200168 *
David Sedlák2b214ac2019-06-06 16:11:03 +0200169 * @return LY_ERR values.
David Sedlák2b626ee2019-06-03 16:40:18 +0200170 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200171LY_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 +0200172 const char **data, enum yang_keyword current_element, const char **text_content,
173 struct lysp_ext_instance **exts);
David Sedlák2b626ee2019-06-03 16:40:18 +0200174
David Sedlákd9d3a312019-06-04 09:47:10 +0200175/**
David Sedlák4a650532019-07-10 11:55:18 +0200176 * @brief Check that val is valid UTF8 character sequence of val_type.
177 * Doesn't check empty string, only character validity.
178 *
179 * @param[in] ctx Yin parser context for logging.
180 * @param[in] val_type Type of the input string to select method of checking character validity.
181 * @param[in] val Input to validate.
182 * @param[in] len Length of input.
183 *
184 * @return LY_ERR values.
185 */
186LY_ERR yin_validate_value(struct yin_parser_ctx *ctx, enum yang_arg val_type, char *val, size_t len);
187
188/**
David Sedlákb4e44562019-07-04 15:42:12 +0200189 * @brief Match yang keyword from yin data.
David Sedlák1bccdfa2019-06-17 15:55:27 +0200190 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200191 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákb4e44562019-07-04 15:42:12 +0200192 * @param[in] name Start of keyword name
David Sedlák8f7a1172019-06-20 14:42:18 +0200193 * @param[in] name_len Lenght of keyword name.
194 * @param[in] prefix Start of keyword prefix.
David Sedlákc5b20842019-08-13 10:18:31 +0200195 * @param[in] prefix_len Lenght of prefix.
David Sedlákc1771b12019-07-10 15:55:46 +0200196 * @param[in] parrent Identification of parrent element, use YANG_NONE for elements without parrent.
David Sedlák1bccdfa2019-06-17 15:55:27 +0200197 *
198 * @return yang_keyword values.
199 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200200enum 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 +0200201 const char *prefix, size_t prefix_len, enum yang_keyword parrent);
David Sedlák1bccdfa2019-06-17 15:55:27 +0200202
David Sedlákb6e65972019-06-19 10:44:13 +0200203/**
David Sedlákc5b20842019-08-13 10:18:31 +0200204 * @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 +0200205 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200206 * @param[in,out] ctx Yin parser context for logging and to store current state.
207 * @param[in,out] data Data to read from, always moved to currently handled character.
David Sedlákbba38e52019-07-09 15:20:01 +0200208 * @param[out] attrs ([Sized array](@ref sizedarrays)) of attributes.
David Sedlák8f7a1172019-06-20 14:42:18 +0200209 *
210 * @return LY_ERR values.
211 */
David Sedlákda8ffa32019-07-08 14:17:10 +0200212LY_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 +0200213
David Sedlák554e36d2019-06-20 16:00:04 +0200214/**
David Sedlákb1a78352019-06-28 16:16:29 +0200215 * @brief Parse instance of extension.
216 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200217 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákbba38e52019-07-09 15:20:01 +0200218 * @param[in] attrs [Sized array](@ref sizedarrays) of attributes of extension instance.
David Sedlákb1a78352019-06-28 16:16:29 +0200219 * @param[in,out] data Data to read from, always moved to currently handled character.
220 * @param[in] ext_name Name of the extension element.
221 * @param[in] ext_name_len Length of extension name.
David Sedlákb4e44562019-07-04 15:42:12 +0200222 * @param[in] subelem Type of the keyword this extension instance is a subelement of.
223 * @param[in] subelem_index Index of the keyword instance this extension instance is a subelement of
224 * @param[in,out] exts Extension instance to add to.
David Sedlákb1a78352019-06-28 16:16:29 +0200225 *
226 * @return LY_ERR values.
227 */
David Sedlák1f90d252019-07-10 17:09:32 +0200228LY_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 +0200229 const char *ext_name, int ext_name_len, LYEXT_SUBSTMT subelem,
230 uint32_t subelem_index, struct lysp_ext_instance **exts);
David Sedlákb1a78352019-06-28 16:16:29 +0200231
232/**
233 * @brief Parse yin element into generic structure.
234 *
David Sedlákda8ffa32019-07-08 14:17:10 +0200235 * @param[in,out] ctx Yin parser context for logging and to store current state.
David Sedlákb1a78352019-06-28 16:16:29 +0200236 * @param[in] name Name of element.
237 * @param[in] name_len Length of elements Name.
238 * @param[in,out] data Data to read from, always moved to currently handled character.
239 * @param[out] element Where the element structure should be stored.
240 *
241 * @return LY_ERR values.
242 */
David Sedlák4ffcec82019-07-25 15:10:21 +0200243LY_ERR yin_parse_element_generic(struct yin_parser_ctx *ctx, const char *name, size_t name_len, const char **data,
244 struct lysp_stmt **element);
David Sedlákb1a78352019-06-28 16:16:29 +0200245
David Sedlák4f03b932019-07-26 13:01:47 +0200246/**
David Sedlák298ff6d2019-07-26 14:29:03 +0200247 * @brief Parse module element.
David Sedlák4f03b932019-07-26 13:01:47 +0200248 *
249 * @param[in,out] ctx Yin parser context for logging and to store current state.
250 * @param[in] mod_attrs Attributes of module element.
251 * @param[in,out] data Data to read from.
252 * @param[out] mod Parsed module structure.
253 *
254 * @return LY_ERR values.
255 */
David Sedlák298ff6d2019-07-26 14:29:03 +0200256LY_ERR yin_parse_mod(struct yin_parser_ctx *ctx, struct yin_arg_record *mod_attrs,
257 const char **data, struct lysp_module *mod);
David Sedlák4f03b932019-07-26 13:01:47 +0200258
259
260/**
David Sedlák298ff6d2019-07-26 14:29:03 +0200261 * @brief Parse submodule element.
262 *
263 * @param[in,out] ctx Yin parser context for logging and to store current state.
264 * @param[in] mod_attrs Attributes of module element.
265 * @param[in,out] data Data to read from.
266 * @param[out] mod Parsed module structure.
267 *
268 * @return LY_ERR values.
269 */
270LY_ERR yin_parse_submod(struct yin_parser_ctx *ctx, struct yin_arg_record *mod_attrs,
271 const char **data, struct lysp_submodule *submod);
272
273/**
David Sedlák4f03b932019-07-26 13:01:47 +0200274 * @brief free argument record, content loaded from lyxml_get_string() can be
275 * dynamically allocated in some cases so it must be also freed.
276 *
David Sedlákc5b20842019-08-13 10:18:31 +0200277 * @param ctx unused just to fulfill signature of callback for FREE_ARRAY.
278 * @param[in] record Record to free.
David Sedlák4f03b932019-07-26 13:01:47 +0200279 */
280void free_arg_rec(struct yin_parser_ctx *ctx, struct yin_arg_record *record);
281
David Sedlák2b626ee2019-06-03 16:40:18 +0200282#endif /* LY_PARSER_YIN_H_*/