blob: 80a116ecd62a7e282ac77d4ca6d218d1415502a0 [file] [log] [blame]
Radek Krejcid6b76452019-09-03 17:03:03 +02001/**
2 * @file plugins_exts_nacm.c
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief libyang extension plugin - Metadata (RFC 7952)
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#include "common.h"
15
16#include <stdlib.h>
17
18#include "plugins_exts.h"
19#include "tree_schema.h"
20#include "plugins_exts_metadata.h"
21
22/**
23 * @brief Storage for ID used to check plugin API version compatibility.
24 * Ignored here in the internal plugin.
25LYEXT_VERSION_CHECK
26 */
27
Radek Krejci38d85362019-09-05 16:26:38 +020028struct lysc_ext_substmt annotation_substmt[7] = {
29 {LY_STMT_IF_FEATURE, LY_STMT_CARD_ANY, NULL},
30 {LY_STMT_UNITS, LY_STMT_CARD_OPT, NULL},
31 {LY_STMT_STATUS, LY_STMT_CARD_OPT, NULL},
32 {LY_STMT_TYPE, LY_STMT_CARD_MAND, NULL},
33 {LY_STMT_DESCRIPTION, LY_STMT_CARD_OPT, NULL},
34 {LY_STMT_REFERENCE, LY_STMT_CARD_OPT, NULL},
35 {0, 0, 0} /* terminating item */
36};
37
Radek Krejcid6b76452019-09-03 17:03:03 +020038/**
39 * @brief Compile annotation extension instances.
40 *
41 * Implementation of lyext_clb_compile callback set as lyext_plugin::compile.
42 */
43LY_ERR
44annotation_compile(struct lysc_ctx *cctx, const struct lysp_ext_instance *p_ext, struct lysc_ext_instance *c_ext)
45{
46 struct lyext_metadata *annotation;
47 struct lysc_module *mod_c;
Radek Krejcid6b76452019-09-03 17:03:03 +020048 unsigned int u;
Radek Krejcid6b76452019-09-03 17:03:03 +020049
50 /* annotations can appear only at the top level of a YANG module or submodule */
51 if (c_ext->parent_type != LYEXT_PAR_MODULE) {
52 lyext_log(c_ext, LY_LLERR, LY_EVALID, cctx->path, "Extension %s is allowed only at the top level of a YANG module or submodule, but it is placed in \"%s\" statement.",
53 p_ext->name, lyext_parent2str(c_ext->parent_type));
54 return LY_EVALID;
55 }
Radek Krejci335332a2019-09-05 13:03:35 +020056 /* check mandatory argument */
57 if (!c_ext->argument) {
58 lyext_log(c_ext, LY_LLERR, LY_EVALID, cctx->path, "Extension %s is instantiated without mandatory argument representing metadata name.",
59 p_ext->name);
60 return LY_EVALID;
61 }
Radek Krejcid6b76452019-09-03 17:03:03 +020062
63 mod_c = (struct lysc_module *)c_ext->parent;
64
65 /* check for duplication */
66 LY_ARRAY_FOR(mod_c->exts, u) {
Radek Krejci335332a2019-09-05 13:03:35 +020067 if (&mod_c->exts[u] != c_ext && mod_c->exts[u].def == c_ext->def && !strcmp(mod_c->exts[u].argument, c_ext->argument)) {
68 /* duplication of the same annotation extension in a single module */
Radek Krejcid6b76452019-09-03 17:03:03 +020069 lyext_log(c_ext, LY_LLERR, LY_EVALID, cctx->path, "Extension %s is instantiated multiple times.", p_ext->name);
70 return LY_EVALID;
71 }
72 }
73
74 /* compile annotation substatements */
75 c_ext->data = annotation = calloc(1, sizeof *annotation);
Radek Krejci335332a2019-09-05 13:03:35 +020076 LY_CHECK_ERR_RET(!annotation, LOGMEM(cctx->ctx), LY_EMEM);
Radek Krejcid6b76452019-09-03 17:03:03 +020077 annotation_substmt[0].storage = &annotation->iffeatures;
Radek Krejci335332a2019-09-05 13:03:35 +020078 annotation_substmt[1].storage = &annotation->units;
79 annotation_substmt[2].storage = &annotation->flags;
80 annotation_substmt[3].storage = &annotation->type;
Radek Krejcid6b76452019-09-03 17:03:03 +020081 /* description and reference are allowed, but not compiled */
82
83 LY_CHECK_RET(lys_compile_extension_instance(cctx, p_ext, annotation_substmt));
84
85 return LY_SUCCESS;
86}
87
Radek Krejci38d85362019-09-05 16:26:38 +020088/**
89 * @brief Free annotation extension instances' data.
90 *
91 * Implementation of lyext_clb_free callback set as lyext_plugin::free.
92 */
93void
94annotation_free(struct ly_ctx *ctx, struct lysc_ext_instance *ext)
95{
Radek Krejciad5963b2019-09-06 16:03:05 +020096 if (!ext->data) {
97 return;
98 }
99
Radek Krejci38d85362019-09-05 16:26:38 +0200100 struct lyext_metadata *annotation = (struct lyext_metadata*)ext->data;
101 annotation_substmt[0].storage = &annotation->iffeatures;
102 annotation_substmt[1].storage = &annotation->units;
103 annotation_substmt[2].storage = &annotation->flags;
104 annotation_substmt[3].storage = &annotation->type;
105
106 lysc_extension_instance_free(ctx, annotation_substmt);
107 free(ext->data);
108}
Radek Krejcid6b76452019-09-03 17:03:03 +0200109
110/**
111 * @brief Plugin for the Metadata's annotation extension
112 */
113struct lyext_plugin metadata_plugin = {
114 .id = "libyang 2 - metadata, version 1",
115 .compile = &annotation_compile,
116 .validate = NULL,
Radek Krejci38d85362019-09-05 16:26:38 +0200117 .free = annotation_free
Radek Krejcid6b76452019-09-03 17:03:03 +0200118};