blob: abf733283a7d54ce84f88f1fb81bd26d8c6930a1 [file] [log] [blame]
Michal Vaskocde73ac2019-11-14 16:10:27 +01001/**
2 * @file validation.h
3 * @author Michal Vasko <mvasko@cesnet.cz>
4 * @brief Validation routines.
5 *
6 * Copyright (c) 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 */
14
15#ifndef LY_VALIDATION_H_
16#define LY_VALIDATION_H_
17
Radek Krejci47fab892020-11-05 17:02:41 +010018#include <stdint.h>
19
Michal Vaskof07286b2021-09-22 12:18:05 +020020#include "diff.h"
Michal Vaskocde73ac2019-11-14 16:10:27 +010021#include "log.h"
Radek Krejci47fab892020-11-05 17:02:41 +010022
Radek Krejci77114102021-03-10 15:21:57 +010023struct ly_ctx;
Radek Krejci47fab892020-11-05 17:02:41 +010024struct ly_set;
25struct lyd_node;
26struct lys_module;
27struct lysc_node;
Michal Vaskocde73ac2019-11-14 16:10:27 +010028
Michal Vaskoa6669ba2020-08-06 16:14:26 +020029/**
30 * @brief Add new changes into a diff. They are always merged.
31 *
32 * @param[in] node Node/subtree to add.
33 * @param[in] op Operation of the change.
34 * @param[in,out] diff Diff to update.
35 * @return LY_ERR value.
36 */
37LY_ERR lyd_val_diff_add(const struct lyd_node *node, enum lyd_diff_op op, struct lyd_node **diff);
38
Michal Vaskocde73ac2019-11-14 16:10:27 +010039/**
Michal Vaskob1b5c262020-03-05 14:29:47 +010040 * @brief Finish validation of nodes and attributes. Specifically, when (is processed first) and type validation.
Michal Vaskocde73ac2019-11-14 16:10:27 +010041 *
Michal Vaskob1b5c262020-03-05 14:29:47 +010042 * !! It is assumed autodeleted nodes cannot be in the unresolved node type set !!
43 *
44 * @param[in,out] tree Data tree, is updated if some nodes are autodeleted.
Michal Vaskod3bb12f2020-12-04 14:33:09 +010045 * @param[in] mod Module of the @p tree to take into consideration when deleting @p tree and moving it.
46 * If set, it is expected @p tree should point to the first node of @p mod. Otherwise it will simply be
47 * the first top-level sibling.
Michal Vaskob1b5c262020-03-05 14:29:47 +010048 * @param[in] node_when Set with nodes with "when" conditions, can be NULL.
Michal Vasko0110cc92021-12-06 15:42:22 +010049 * @param[in] when_xp_opts Additional XPath options to use for evaluating "when".
Michal Vaskocde73ac2019-11-14 16:10:27 +010050 * @param[in] node_types Set with nodes with unresolved types, can be NULL
aPiecekb0445f22021-06-24 11:34:07 +020051 * @param[in] meta_types Set with metadata with unresolved types, can be NULL.
Michal Vaskoaac267d2022-01-17 13:34:48 +010052 * @param[in] ext_val Set with extension data to validate, can be NULL.
53 * @param[in] val_opts Validation options, see @ref datavalidationoptions.
Michal Vasko8104fd42020-07-13 11:09:51 +020054 * @param[in,out] diff Validation diff.
Michal Vaskocde73ac2019-11-14 16:10:27 +010055 * @return LY_ERR value.
56 */
Michal Vaskod3bb12f2020-12-04 14:33:09 +010057LY_ERR lyd_validate_unres(struct lyd_node **tree, const struct lys_module *mod, struct ly_set *node_when,
Michal Vaskoaac267d2022-01-17 13:34:48 +010058 uint32_t when_xp_opts, struct ly_set *node_types, struct ly_set *meta_types, struct ly_set *ext_val,
59 uint32_t val_opts, struct lyd_node **diff);
Michal Vaskocde73ac2019-11-14 16:10:27 +010060
61/**
Michal Vaskob1b5c262020-03-05 14:29:47 +010062 * @brief Validate new siblings. Specifically, check duplicated instances, autodelete default values and cases.
Michal Vaskocde73ac2019-11-14 16:10:27 +010063 *
Michal Vaskob1b5c262020-03-05 14:29:47 +010064 * !! It is assumed autodeleted nodes cannot yet be in the unresolved node type set !!
65 *
66 * @param[in,out] first First sibling.
67 * @param[in] sparent Schema parent of the siblings, NULL for top-level siblings.
68 * @param[in] mod Module of the siblings, NULL for nested siblings.
Michal Vasko8104fd42020-07-13 11:09:51 +020069 * @param[in,out] diff Validation diff.
Michal Vaskob1b5c262020-03-05 14:29:47 +010070 * @return LY_ERR value.
71 */
Michal Vasko8104fd42020-07-13 11:09:51 +020072LY_ERR lyd_validate_new(struct lyd_node **first, const struct lysc_node *sparent, const struct lys_module *mod,
Radek Krejci0f969882020-08-21 16:56:47 +020073 struct lyd_node **diff);
Michal Vaskob1b5c262020-03-05 14:29:47 +010074
75/**
Michal Vaskoe0665742021-02-11 11:08:44 +010076 * @brief Validate a data tree.
Michal Vaskob1b5c262020-03-05 14:29:47 +010077 *
Michal Vaskoe0665742021-02-11 11:08:44 +010078 * @param[in,out] tree Data tree to validate, nodes may be autodeleted.
79 * @param[in] module Module whose data (and schema restrictions) to validate, NULL for all modules.
80 * @param[in] ctx libyang context.
81 * @param[in] val_opts Validation options, see @ref datavalidationoptions.
82 * @param[in] validate_subtree Whether subtree was already validated (as part of data parsing) or not (separate validation).
83 * @param[in] node_when_p Set of nodes with when conditions, if NULL a local set is used.
84 * @param[in] node_types_p Set of unres node types, if NULL a local set is used.
85 * @param[in] meta_types_p Set of unres metadata types, if NULL a local set is used.
Michal Vaskoaac267d2022-01-17 13:34:48 +010086 * @param[in] ext_val_p Set of unres extension data to validate, if NULL a local set is used.
Michal Vaskoe0665742021-02-11 11:08:44 +010087 * @param[out] diff Generated validation diff, not generated if NULL.
Michal Vaskocde73ac2019-11-14 16:10:27 +010088 * @return LY_ERR value.
89 */
Michal Vaskoe0665742021-02-11 11:08:44 +010090LY_ERR lyd_validate(struct lyd_node **tree, const struct lys_module *module, const struct ly_ctx *ctx, uint32_t val_opts,
Michal Vaskoaac267d2022-01-17 13:34:48 +010091 ly_bool validate_subtree, struct ly_set *node_when_p, struct ly_set *node_types_p, struct ly_set *meta_types_p,
92 struct ly_set *ext_val_p, struct lyd_node **diff);
Michal Vasko9b368d32020-02-14 13:53:31 +010093
Michal Vaskocde73ac2019-11-14 16:10:27 +010094#endif /* LY_VALIDATION_H_ */