plugins types UPDATE separate validate clb into 2 clbs

Support validate_value and validate_tree callbacks.
Only the validate_tree callback is called on the
final data tree making validation more efficient.

Author: michalvasko

src/parser_data.h

@@ -218,8 +218,9 @@ struct ly_in;
                                                  (such as NP containers) are still added. Validation will fail if a
                                                  default node is required for it to pass. */
 #define LYD_VALIDATE_NOT_FINAL 0x0020       /**< Skip final validation tasks that require for all the data nodes to
-                                                 either exist or not, based on the YANG constraints. Once the data
-                                                 satisfy this requirement, the final validation should be performed. */
+                                                 either exist or not, based on the YANG constraints (including skipping
+                                                 type plugin validate_tree callbacks). Once the data satisfy this
+                                                 requirement, the final validation should be performed. */
 
 #define LYD_VALIDATE_OPTS_MASK  0x0000FFFF  /**< Mask for all the LYD_VALIDATE_* options. */
 

src/plugins_types.h

@@ -543,19 +543,38 @@ LIBYANG_API_DECL typedef void (*lyplg_type_lyb_size_clb)(const struct lysc_type
  * @param[out] err Optionally provided error information in case of failure. If not provided to the caller, a generic
  * error message is prepared instead. The error structure can be created by ::ly_err_new().
  * @return LY_SUCCESS on success,
- * @return LY_EINCOMPLETE in case the ::lyplg_type_validate_clb should be called to finish value validation in data,
+ * @return LY_EINCOMPLETE in case the ::lyplg_type_validate_tree_clb is defined and should be called to finish value
+ * validation in data,
  * @return LY_ERR value on error, @p storage must not have any pointers to dynamic memory.
  */
 LIBYANG_API_DECL typedef LY_ERR (*lyplg_type_store_clb)(const struct ly_ctx *ctx, const struct lysc_type *type,
         const void *value, uint32_t value_size_bits, uint32_t options, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints,
         const struct lysc_node *ctx_node, const struct lysc_ext_instance *top_ext, struct lyd_value *storage,
         struct lys_glob_unres *unres, struct ly_err_item **err);
 
+/**
+ * @brief Callback to validate the stored value local semantic constraints of the type.
+ *
+ * This callback should perform any required validation of the value after it is stored. If the stored value is always
+ * valid disregarding the accessible data tree, this callback should not be defined (but ::lyplg_type_validate_tree()
+ * may be).
+ *
+ * @param[in] ctx libyang context.
+ * @param[in] type Original type of the value (not necessarily the stored one) being validated.
+ * @param[in,out] storage Storage of the value successfully filled by ::lyplg_type_store_clb. May be modified.
+ * @param[out] err Optionally provided error information in case of failure. If not provided to the caller, a generic
+ * error message is prepared instead. The error structure can be created by ::ly_err_new().
+ * @return LY_SUCCESS on success,
+ * @return LY_ERR value on error.
+ */
+LIBYANG_API_DECL typedef LY_ERR (*lyplg_type_validate_value_clb)(const struct ly_ctx *ctx, const struct lysc_type *type,
+        struct lyd_value *storage, struct ly_err_item **err);
+
 /**
  * @brief Callback to validate the stored value in the accessible data tree.
  *
- * This callback is optional and may not be defined for types that do not require the accessible data tree for
- * validation (::lyplg_type_store_clb fully stores and validates the value).
+ * This callback should perform any final validation that depends on the other data nodes in the accessible tree. If
+ * the other nodes do not affect the validity of this value, this callback should not be defined.
  *
  * @param[in] ctx libyang context.
  * @param[in] type Original type of the value (not necessarily the stored one) being validated.
@@ -568,7 +587,7 @@ LIBYANG_API_DECL typedef LY_ERR (*lyplg_type_store_clb)(const struct ly_ctx *ctx
  * @return LY_SUCCESS on success,
  * @return LY_ERR value on error.
  */
-LIBYANG_API_DECL typedef LY_ERR (*lyplg_type_validate_clb)(const struct ly_ctx *ctx, const struct lysc_type *type,
+LIBYANG_API_DECL typedef LY_ERR (*lyplg_type_validate_tree_clb)(const struct ly_ctx *ctx, const struct lysc_type *type,
         const struct lyd_node *ctx_node, const struct lyd_node *tree, const struct lysc_ext_instance *top_ext,
         struct lyd_value *storage, struct ly_err_item **err);
 
@@ -660,7 +679,8 @@ struct lyplg_type {
     const char *id;                     /**< Plugin name id, can be used for distinguishing incompatible versions. */
     lyplg_type_lyb_size_clb lyb_size;   /**< Size of the value in [LYB format](@ref howtoDataLYB) in bits. */
     lyplg_type_store_clb store;         /**< Storing and canonization callback for the value. */
-    lyplg_type_validate_clb validate;   /**< Optional validation callback that can use the accessible data tree. */
+    lyplg_type_validate_value_clb validate_value;   /**< Optional value validation callback. */
+    lyplg_type_validate_tree_clb validate_tree;     /**< Optional data tree value validation callback. */
     lyplg_type_compare_clb compare;     /**< Comparison callback for comparing 2 values of the same type. */
     lyplg_type_sort_clb sort;           /**< Comparison callback for sorting values. */
     lyplg_type_print_clb print;         /**< Printer callback for getting value representation in any format. */
@@ -747,6 +767,12 @@ LIBYANG_API_DECL LY_ERR lyplg_type_store_string(const struct ly_ctx *ctx, const
         const struct lysc_node *ctx_node, const struct lysc_ext_instance *top_ext, struct lyd_value *storage,
         struct lys_glob_unres *unres, struct ly_err_item **err);
 
+/**
+ * @brief Implementation of ::lyplg_type_validate_value_clb for the string type.
+ */
+LIBYANG_API_DECL LY_ERR lyplg_type_validate_value_string(const struct ly_ctx *ctx, const struct lysc_type *type,
+        struct lyd_value *storage, struct ly_err_item **err);
+
 /**
  * @brief Implementation of ::lyplg_type_print_clb for the ietf-yang-types xpath1.0 type.
  */

src/plugins_types/binary.c

@@ -44,8 +44,7 @@
 static const char b64_etable[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
 
 static void lyplg_type_free_binary(const struct ly_ctx *ctx, struct lyd_value *value);
-static LY_ERR lyplg_type_validate_binary(const struct ly_ctx *ctx, const struct lysc_type *type,
-        const struct lyd_node *ctx_node, const struct lyd_node *tree, const struct lysc_ext_instance *top_ext,
+static LY_ERR lyplg_type_validate_value_binary(const struct ly_ctx *ctx, const struct lysc_type *type,
         struct lyd_value *storage, struct ly_err_item **err);
 
 /**
@@ -332,7 +331,7 @@ lyplg_type_store_binary(const struct ly_ctx *ctx, const struct lysc_type *type,
 
     if (!(options & LYPLG_TYPE_STORE_ONLY)) {
         /* validate value */
-        ret = lyplg_type_validate_binary(ctx, type, NULL, NULL, NULL, storage, err);
+        ret = lyplg_type_validate_value_binary(ctx, type, storage, err);
         LY_CHECK_GOTO(ret, cleanup);
     }
 
@@ -348,11 +347,10 @@ lyplg_type_store_binary(const struct ly_ctx *ctx, const struct lysc_type *type,
 }
 
 /**
- * @brief Implementation of ::lyplg_type_validate_clb for the binary type.
+ * @brief Implementation of ::lyplg_type_validate_value_clb for the binary type.
  */
 static LY_ERR
-lyplg_type_validate_binary(const struct ly_ctx *ctx, const struct lysc_type *type, const struct lyd_node *UNUSED(ctx_node),
-        const struct lyd_node *UNUSED(tree), const struct lysc_ext_instance *UNUSED(top_ext), struct lyd_value *storage,
+lyplg_type_validate_value_binary(const struct ly_ctx *ctx, const struct lysc_type *type, struct lyd_value *storage,
         struct ly_err_item **err)
 {
     struct lysc_type_bin *type_bin = (struct lysc_type_bin *)type;
@@ -511,7 +509,8 @@ const struct lyplg_type_record plugins_binary[] = {
         .plugin.id = "ly2 binary",
         .plugin.lyb_size = lyplg_type_lyb_size_variable_bytes,
         .plugin.store = lyplg_type_store_binary,
-        .plugin.validate = lyplg_type_validate_binary,
+        .plugin.validate_value = lyplg_type_validate_value_binary,
+        .plugin.validate_tree = NULL,
         .plugin.compare = lyplg_type_compare_binary,
         .plugin.sort = lyplg_type_sort_binary,
         .plugin.print = lyplg_type_print_binary,

src/plugins_types/bits.c

@@ -504,7 +504,8 @@ const struct lyplg_type_record plugins_bits[] = {
         .plugin.id = "ly2 bits",
         .plugin.lyb_size = lyplg_type_lyb_size_bits,
         .plugin.store = lyplg_type_store_bits,
-        .plugin.validate = NULL,
+        .plugin.validate_value = NULL,
+        .plugin.validate_tree = NULL,
         .plugin.compare = lyplg_type_compare_bits,
         .plugin.sort = lyplg_type_sort_bits,
         .plugin.print = lyplg_type_print_bits,

src/plugins_types/boolean.c

@@ -169,7 +169,8 @@ const struct lyplg_type_record plugins_boolean[] = {
         .plugin.id = "ly2 boolean",
         .plugin.lyb_size = lyplg_type_lyb_size_boolean,
         .plugin.store = lyplg_type_store_boolean,
-        .plugin.validate = NULL,
+        .plugin.validate_value = NULL,
+        .plugin.validate_tree = NULL,
         .plugin.compare = lyplg_type_compare_boolean,
         .plugin.sort = lyplg_type_sort_boolean,
         .plugin.print = lyplg_type_print_boolean,

src/plugins_types/date_and_time.c

@@ -396,7 +396,8 @@ const struct lyplg_type_record plugins_date_and_time[] = {
         .plugin.id = "ly2 date-and-time",
         .plugin.lyb_size = lyplg_type_lyb_size_variable_bytes,
         .plugin.store = lyplg_type_store_date_and_time,
-        .plugin.validate = NULL,
+        .plugin.validate_value = NULL,
+        .plugin.validate_tree = NULL,
         .plugin.compare = lyplg_type_compare_date_and_time,
         .plugin.sort = lyplg_type_sort_date_and_time,
         .plugin.print = lyplg_type_print_date_and_time,

src/plugins_types/decimal64.c

@@ -34,7 +34,8 @@
  * | 64        | yes | `int64_t *` | little-endian value represented without floating point |
  */
 
-static LY_ERR lyplg_type_validate_decimal64(const struct ly_ctx *ctx, const struct lysc_type *type, const struct lyd_node *ctx_node, const struct lyd_node *tree, const struct lysc_ext_instance *top_ext, struct lyd_value *storage, struct ly_err_item **err);
+static LY_ERR lyplg_type_validate_value_decimal64(const struct ly_ctx *ctx, const struct lysc_type *type,
+        struct lyd_value *storage, struct ly_err_item **err);
 
 /**
  * @brief Convert decimal64 number to canonical string.
@@ -151,7 +152,7 @@ lyplg_type_store_decimal64(const struct ly_ctx *ctx, const struct lysc_type *typ
 
     if (!(options & LYPLG_TYPE_STORE_ONLY)) {
         /* validate value */
-        ret = lyplg_type_validate_decimal64(ctx, type, NULL, NULL, NULL, storage, err);
+        ret = lyplg_type_validate_value_decimal64(ctx, type, storage, err);
         LY_CHECK_GOTO(ret, cleanup);
     }
 
@@ -167,12 +168,11 @@ lyplg_type_store_decimal64(const struct ly_ctx *ctx, const struct lysc_type *typ
 }
 
 /**
- * @brief Implementation of ::lyplg_type_validate_clb for the built-in decimal64 type.
+ * @brief Implementation of ::lyplg_type_validate_value_clb for the built-in decimal64 type.
  */
 static LY_ERR
-lyplg_type_validate_decimal64(const struct ly_ctx *UNUSED(ctx), const struct lysc_type *type,
-        const struct lyd_node *UNUSED(ctx_node), const struct lyd_node *UNUSED(tree),
-        const struct lysc_ext_instance *UNUSED(top_ext), struct lyd_value *storage, struct ly_err_item **err)
+lyplg_type_validate_value_decimal64(const struct ly_ctx *UNUSED(ctx), const struct lysc_type *type,
+        struct lyd_value *storage, struct ly_err_item **err)
 {
     LY_ERR ret;
     struct lysc_type_dec *type_dec = (struct lysc_type_dec *)type;
@@ -271,7 +271,8 @@ const struct lyplg_type_record plugins_decimal64[] = {
         .plugin.id = "ly2 decimal64",
         .plugin.lyb_size = lyplg_type_lyb_size_decimal64,
         .plugin.store = lyplg_type_store_decimal64,
-        .plugin.validate = lyplg_type_validate_decimal64,
+        .plugin.validate_value = lyplg_type_validate_value_decimal64,
+        .plugin.validate_tree = NULL,
         .plugin.compare = lyplg_type_compare_decimal64,
         .plugin.sort = lyplg_type_sort_decimal64,
         .plugin.print = lyplg_type_print_decimal64,

src/plugins_types/empty.c

@@ -103,7 +103,8 @@ const struct lyplg_type_record plugins_empty[] = {
         .plugin.id = "ly2 empty",
         .plugin.lyb_size = lyplg_type_lyb_size_empty,
         .plugin.store = lyplg_type_store_empty,
-        .plugin.validate = NULL,
+        .plugin.validate_value = NULL,
+        .plugin.validate_tree = NULL,
         .plugin.compare = lyplg_type_compare_simple,
         .plugin.sort = lyplg_type_sort_simple,
         .plugin.print = lyplg_type_print_simple,

src/plugins_types/enumeration.c

@@ -229,7 +229,8 @@ const struct lyplg_type_record plugins_enumeration[] = {
         .plugin.id = "ly2 enumeration",
         .plugin.lyb_size = lyplg_type_lyb_size_enum,
         .plugin.store = lyplg_type_store_enum,
-        .plugin.validate = NULL,
+        .plugin.validate_value = NULL,
+        .plugin.validate_tree = NULL,
         .plugin.compare = lyplg_type_compare_simple,
         .plugin.sort = lyplg_type_sort_enum,
         .plugin.print = lyplg_type_print_enum,

src/plugins_types/hex_string.c

@@ -44,7 +44,6 @@ lyplg_type_store_hex_string(const struct ly_ctx *ctx, const struct lysc_type *ty
         struct lyd_value *storage, struct lys_glob_unres *UNUSED(unres), struct ly_err_item **err)
 {
     LY_ERR ret = LY_SUCCESS;
-    struct lysc_type_str *type_str = (struct lysc_type_str *)type;
     uint32_t value_size, i;
 
     /* init storage */
@@ -87,16 +86,8 @@ lyplg_type_store_hex_string(const struct ly_ctx *ctx, const struct lysc_type *ty
     }
 
     if (!(options & LYPLG_TYPE_STORE_ONLY)) {
-        /* validate length restriction of the string */
-        if (type_str->length) {
-            /* value_size is in bytes, but we need number of characters here */
-            ret = lyplg_type_validate_range(LY_TYPE_STRING, type_str->length, ly_utf8len(value, value_size), value,
-                    value_size, err);
-            LY_CHECK_GOTO(ret, cleanup);
-        }
-
-        /* validate pattern restrictions */
-        ret = lyplg_type_validate_patterns(ctx, type_str->patterns, value, value_size, err);
+        /* validate value */
+        ret = lyplg_type_validate_value_string(ctx, type, storage, err);
         LY_CHECK_GOTO(ret, cleanup);
     }
 
@@ -127,7 +118,8 @@ const struct lyplg_type_record plugins_hex_string[] = {
         .plugin.id = "ly2 hex-string",
         .plugin.lyb_size = lyplg_type_lyb_size_variable_bytes,
         .plugin.store = lyplg_type_store_hex_string,
-        .plugin.validate = NULL,
+        .plugin.validate_value = lyplg_type_validate_value_string,
+        .plugin.validate_tree = NULL,
         .plugin.compare = lyplg_type_compare_simple,
         .plugin.sort = lyplg_type_sort_simple,
         .plugin.print = lyplg_type_print_simple,
@@ -142,7 +134,8 @@ const struct lyplg_type_record plugins_hex_string[] = {
         .plugin.id = "ly2 hex-string",
         .plugin.lyb_size = lyplg_type_lyb_size_variable_bytes,
         .plugin.store = lyplg_type_store_hex_string,
-        .plugin.validate = NULL,
+        .plugin.validate_value = lyplg_type_validate_value_string,
+        .plugin.validate_tree = NULL,
         .plugin.compare = lyplg_type_compare_simple,
         .plugin.sort = lyplg_type_sort_simple,
         .plugin.print = lyplg_type_print_simple,
@@ -157,7 +150,8 @@ const struct lyplg_type_record plugins_hex_string[] = {
         .plugin.id = "ly2 hex-string",
         .plugin.lyb_size = lyplg_type_lyb_size_variable_bytes,
         .plugin.store = lyplg_type_store_hex_string,
-        .plugin.validate = NULL,
+        .plugin.validate_value = lyplg_type_validate_value_string,
+        .plugin.validate_tree = NULL,
         .plugin.compare = lyplg_type_compare_simple,
         .plugin.sort = lyplg_type_sort_simple,
         .plugin.print = lyplg_type_print_simple,
@@ -172,7 +166,8 @@ const struct lyplg_type_record plugins_hex_string[] = {
         .plugin.id = "ly2 hex-string",
         .plugin.lyb_size = lyplg_type_lyb_size_variable_bytes,
         .plugin.store = lyplg_type_store_hex_string,
-        .plugin.validate = NULL,
+        .plugin.validate_value = lyplg_type_validate_value_string,
+        .plugin.validate_tree = NULL,
         .plugin.compare = lyplg_type_compare_simple,
         .plugin.sort = lyplg_type_sort_simple,
         .plugin.print = lyplg_type_print_simple,