536 lines
16 KiB
C
536 lines
16 KiB
C
/*
|
|
*
|
|
***** BEGIN LICENSE BLOCK *****
|
|
|
|
Copyright (C) 2023 Olof Hagsand
|
|
|
|
This file is part of CLIXON.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
Alternatively, the contents of this file may be used under the terms of
|
|
the GNU General Public License Version 3 or later (the "GPL"),
|
|
in which case the provisions of the GPL are applicable instead
|
|
of those above. If you wish to allow use of your version of this file only
|
|
under the terms of the GPL, and not to allow others to
|
|
use your version of this file under the terms of Apache License version 2,
|
|
indicate your decision by deleting the provisions above and replace them with
|
|
the notice and other provisions required by the GPL. If you do not delete
|
|
the provisions above, a recipient may use your version of this file under
|
|
the terms of any one of the Apache License version 2 or the GPL.
|
|
|
|
***** END LICENSE BLOCK *****
|
|
|
|
* RFC 8525 Yang schema mount support
|
|
*
|
|
* Structure of mount-points in XML:
|
|
* YANG mount extentsion -->* YANG unknown mount stmt -->* XML mount-points
|
|
* |
|
|
* cvec mapping xpath->yspec mountpoint
|
|
*
|
|
* The calls into this code are:
|
|
* 1. yang_schema_mount_point() Check that a yang nod eis mount-point
|
|
* 2. xml_yang_mount_get(): from xml_bind_yang and xmldb_put
|
|
* 3. xml_yang_mount_freeall(): from ys_free1 when deallocatin YANG trees
|
|
* 4. yang_schema_mount_statedata(): from get_common/get_statedata to retrieve system state
|
|
* 5. yang_schema_yanglib_parse_mount(): from xml_bind_yang to parse and mount
|
|
* 6. yang_schema_get_child(): from xmldb_put/text_modify when adding new XML nodes
|
|
*/
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "clixon_config.h" /* generated by config & autoconf */
|
|
#endif
|
|
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <errno.h>
|
|
#include <limits.h>
|
|
#include <string.h>
|
|
#include <sys/param.h>
|
|
|
|
/* cligen */
|
|
#include <cligen/cligen.h>
|
|
|
|
/* clixon */
|
|
#include "clixon_queue.h"
|
|
#include "clixon_hash.h"
|
|
#include "clixon_string.h"
|
|
#include "clixon_handle.h"
|
|
#include "clixon_err.h"
|
|
#include "clixon_log.h"
|
|
#include "clixon_yang.h"
|
|
#include "clixon_xml.h"
|
|
#include "clixon_xml_io.h"
|
|
#include "clixon_xml_map.h"
|
|
#include "clixon_data.h"
|
|
#include "clixon_xpath_ctx.h"
|
|
#include "clixon_xpath.h"
|
|
#include "clixon_yang_module.h"
|
|
#include "clixon_yang_parse_lib.h"
|
|
#include "clixon_plugin.h"
|
|
#include "clixon_xml_bind.h"
|
|
#include "clixon_netconf_lib.h"
|
|
#include "clixon_yang_schema_mount.h"
|
|
|
|
/*! Check if YANG node is a RFC 8525 YANG schema mount
|
|
*
|
|
* Check if:
|
|
* - y is CONTAINER or LIST, AND
|
|
* - y has YANG schema mount "mount-point" as child element, AND
|
|
* - the extension label matches y (see note below)
|
|
* If so, then return 1
|
|
* @param[in] y Yang statement
|
|
* @retval 1 Yes, y is a RFC 8525 YANG mount-point
|
|
* @retval 0 No, y is not
|
|
* @retval -1 Error
|
|
* @note That this may be a restriction on the usage of "label". The RFC is somewhat unclear.
|
|
*/
|
|
int
|
|
yang_schema_mount_point(yang_stmt *y)
|
|
{
|
|
int retval = -1;
|
|
enum rfc_6020 keyw;
|
|
int exist = 0;
|
|
char *value = NULL;
|
|
|
|
if (y == NULL){
|
|
clicon_err(OE_YANG, EINVAL, "y is NULL");
|
|
goto done;
|
|
}
|
|
keyw = yang_keyword_get(y);
|
|
if (keyw != Y_CONTAINER
|
|
#ifndef YANG_SCHEMA_MOUNT_ONLY_PRESENCE_CONTAINERS
|
|
&& keyw != Y_LIST
|
|
#endif
|
|
#if 0 /* See this in some standard YANGs but RFC 8528 does not allow it */
|
|
&& keyw != Y_ANYDATA
|
|
#endif
|
|
)
|
|
goto fail;
|
|
if (yang_extension_value(y, "mount-point", YANG_SCHEMA_MOUNT_NAMESPACE, &exist, &value) < 0)
|
|
goto done;
|
|
if (exist == 0)
|
|
goto fail;
|
|
if (value == NULL)
|
|
goto fail;
|
|
retval = 1;
|
|
done:
|
|
return retval;
|
|
fail:
|
|
retval = 0;
|
|
goto done;
|
|
}
|
|
|
|
/*! Get yangspec mount-point
|
|
*
|
|
* @param[in] h Clixon handle
|
|
* @param[in] x XML moint-point node
|
|
* @param[out] vallevel Do or dont do full RFC 7950 validation
|
|
* @param[out] yspec YANG stmt spec
|
|
* @retval 1 x is a mount-point: yspec may be set
|
|
* @retval 0 x is not a mount point
|
|
* @retval -1 Error
|
|
*/
|
|
int
|
|
xml_yang_mount_get(clicon_handle h,
|
|
cxobj *xt,
|
|
validate_level *vl,
|
|
yang_stmt **yspec)
|
|
{
|
|
int retval = -1;
|
|
cvec *cvv = NULL;
|
|
cg_var *cv;
|
|
yang_stmt *y;
|
|
yang_stmt *yu;
|
|
char *xpath = NULL; // XXX free it
|
|
int ret;
|
|
|
|
if ((y = xml_spec(xt)) == NULL)
|
|
goto fail;
|
|
if ((ret = yang_schema_mount_point(y)) < 0)
|
|
goto done;
|
|
if (ret == 0)
|
|
goto fail;
|
|
/* Check validate level */
|
|
if (clixon_plugin_yang_mount_all(h, xt, NULL, vl, NULL) < 0)
|
|
goto done;
|
|
// XXX hardcoded prefix: yangmnt
|
|
if ((yu = yang_find(y, Y_UNKNOWN, "yangmnt:mount-point")) == NULL)
|
|
goto ok;
|
|
if (xml2xpath(xt, NULL, 1, &xpath) < 0)
|
|
goto done;
|
|
/* Special value in yang unknown node for mount-points: mapping from xpath->mounted yspec */
|
|
if ((cvv = yang_cvec_get(yu)) == NULL)
|
|
goto ok;
|
|
if ((cv = cvec_find(cvv, xpath)) == NULL)
|
|
goto ok;
|
|
if (yspec)
|
|
|
|
*yspec = cv_void_get(cv);
|
|
ok:
|
|
retval = 1;
|
|
done:
|
|
if (xpath)
|
|
free(xpath);
|
|
return retval;
|
|
fail:
|
|
retval = 0;
|
|
goto done;
|
|
}
|
|
|
|
/*! Set yangspec mount-point
|
|
*
|
|
* Stored in a separate structure (not in XML config tree)
|
|
* @param[in] x XML moint-point node
|
|
* @param[in] yspec Yangspec for this mount-point (consumed)
|
|
* @retval 0 OK
|
|
* @retval -1 Error
|
|
*/
|
|
int
|
|
xml_yang_mount_set(cxobj *x,
|
|
yang_stmt *yspec)
|
|
{
|
|
cg_var *cv;
|
|
yang_stmt *y;
|
|
yang_stmt *yu;
|
|
yang_stmt *yspec0;
|
|
char *xpath = NULL;
|
|
cvec *cvv;
|
|
|
|
if ((y = xml_spec(x)) == NULL ||
|
|
(yu = yang_find(y, Y_UNKNOWN, "yangmnt:mount-point")) == NULL){
|
|
goto done;
|
|
}
|
|
if (xml2xpath(x, NULL, 1, &xpath) < 0)
|
|
goto done;
|
|
if ((cvv = yang_cvec_get(yu)) != NULL &&
|
|
(cv = cvec_find(cvv, xpath)) != NULL &&
|
|
(yspec0 = cv_void_get(cv)) != NULL){
|
|
#if 0 /* Problematic to free yang specs here, upper layers should handle it? */
|
|
ys_free(yspec0);
|
|
#endif
|
|
cv_void_set(cv, NULL);
|
|
}
|
|
else if ((cv = yang_cvec_add(yu, CGV_VOID, xpath)) == NULL)
|
|
return -1;
|
|
cv_void_set(cv, yspec);
|
|
done:
|
|
if (xpath)
|
|
free(xpath);
|
|
return 0;
|
|
}
|
|
|
|
/*! Free all yspec yang-mounts
|
|
*
|
|
* @param[in] cvv Cligen-variable vector containing xpath -> yspec mapping
|
|
* @retval 0 OK
|
|
*/
|
|
int
|
|
xml_yang_mount_freeall(cvec *cvv)
|
|
{
|
|
cg_var *cv = NULL;
|
|
yang_stmt *ys;
|
|
|
|
cv = NULL;
|
|
while ((cv = cvec_each(cvv, cv)) != NULL){
|
|
if ((ys = cv_void_get(cv)) != NULL)
|
|
ys_free(ys);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/*! Find schema mounts - callback function for xml_apply
|
|
*
|
|
* @param[in] x XML node
|
|
* @param[in] arg cvec, if match add node
|
|
* @retval 2 Locally abort this subtree, continue with others
|
|
* @retval 1 Abort, dont continue with others, return 1 to end user
|
|
* @retval 0 OK, continue
|
|
* @retval -1 Error, aborted at first error encounter, return -1 to end user
|
|
*/
|
|
static int
|
|
find_schema_mounts(cxobj *x,
|
|
void *arg)
|
|
{
|
|
int ret;
|
|
yang_stmt *y;
|
|
cvec *cvv = (cvec *)arg;
|
|
cg_var *cv;
|
|
|
|
if ((y = xml_spec(x)) == NULL)
|
|
return 2;
|
|
if (yang_config(y) == 0)
|
|
return 2;
|
|
if ((ret = yang_schema_mount_point(y)) < 0)
|
|
return -1;
|
|
if (ret == 0)
|
|
return 0;
|
|
if ((cv = cvec_add(cvv, CGV_VOID)) == NULL){
|
|
clicon_err(OE_UNIX, errno, "cvec_add");
|
|
return -1;
|
|
}
|
|
cv_void_set(cv, x);
|
|
return 0;
|
|
}
|
|
|
|
/*! Find mount-points and return yang-library state
|
|
*
|
|
* Brute force: traverse whole XML, match all x that have ymount as yspec
|
|
* Add yang-library state for all x
|
|
* @param[in] h Clixon handle
|
|
* @param[in] xpath XML Xpath
|
|
* @param[in] nsc XML Namespace context for xpath
|
|
* @param[in,out] xret Existing XML tree, merge x into this
|
|
* @param[out] xerr XML error tree, if retval = 0
|
|
* @retval 1 OK
|
|
* @retval 0 Validation failed, error in xret
|
|
* @retval -1 Error (fatal)
|
|
*
|
|
* RFC 8528 Section 3.4:
|
|
* A schema for a mount point contained in a mounted module can be
|
|
* specified by implementing the "ietf-yang-library" and
|
|
* "ietf-yang-schema-mount" modules in the mounted schema and specifying
|
|
* the schemas in exactly the same way as the top-level schema.
|
|
* Alt: see snmp_yang2xml to get instances instead of brute force traverse of whole tree
|
|
*/
|
|
static int
|
|
yang_schema_mount_statedata_yanglib(clicon_handle h,
|
|
char *xpath,
|
|
cvec *nsc,
|
|
cxobj **xret,
|
|
cxobj **xerr)
|
|
{
|
|
int retval = -1;
|
|
cvec *cvv = NULL;
|
|
cg_var *cv;
|
|
cxobj *xmp; /* xml mount-point */
|
|
cxobj *yanglib = NULL; /* xml yang-lib */
|
|
cbuf *cb = NULL;
|
|
yang_stmt *yspec;
|
|
int ret;
|
|
int config = 1;
|
|
validate_level vl = VL_FULL;
|
|
|
|
if ((cb = cbuf_new()) == NULL){
|
|
clicon_err(OE_UNIX, 0, "clicon buffer");
|
|
goto done;
|
|
}
|
|
if ((cvv = cvec_new(0)) == NULL){
|
|
clicon_err(OE_UNIX, errno, "cvec_new");
|
|
goto done;
|
|
}
|
|
if (xml_apply(*xret, CX_ELMNT, find_schema_mounts, cvv) < 0)
|
|
goto done;
|
|
cv = NULL;
|
|
while ((cv = cvec_each(cvv, cv)) != NULL) {
|
|
xmp = cv_void_get(cv);
|
|
yanglib = NULL;
|
|
/* User callback */
|
|
if (clixon_plugin_yang_mount_all(h, xmp, &config, &vl, &yanglib) < 0)
|
|
goto done;
|
|
if (yanglib == NULL)
|
|
continue;
|
|
yspec = clicon_dbspec_yang(h);
|
|
if ((ret = xml_bind_yang0(h, yanglib, YB_MODULE, yspec, xerr)) < 0)
|
|
goto done;
|
|
if (ret == 0)
|
|
goto fail;
|
|
if (xml_addsub(xmp, yanglib) < 0)
|
|
goto done;
|
|
yanglib = NULL;
|
|
}
|
|
retval = 1;
|
|
done:
|
|
if (cvv)
|
|
cvec_free(cvv);
|
|
if (cb)
|
|
cbuf_free(cb);
|
|
return retval;
|
|
fail:
|
|
retval = 0;
|
|
goto done;
|
|
}
|
|
|
|
/*! Get schema mount-point state according to RFC 8528
|
|
*
|
|
* @param[in] h Clixon handle
|
|
* @param[in] yspec Yang spec
|
|
* @param[in] xpath XML Xpath
|
|
* @param[in] nsc XML Namespace context for xpath
|
|
* @param[in,out] xret Existing XML tree, merge x into this
|
|
* @param[out] xerr XML error tree, if retval = 0
|
|
* @retval 1 OK
|
|
* @retval 0 Validation failed, error in xret
|
|
* @retval -1 Error (fatal)
|
|
* @note Only "inline" specification of mounted schema supported, not "shared schema"
|
|
*/
|
|
int
|
|
yang_schema_mount_statedata(clicon_handle h,
|
|
yang_stmt *yspec,
|
|
char *xpath,
|
|
cvec *nsc,
|
|
cxobj **xret,
|
|
cxobj **xerr)
|
|
{
|
|
int retval = -1;
|
|
cbuf *cb = NULL;
|
|
int ret;
|
|
yang_stmt *yext;
|
|
yang_stmt *ymount;
|
|
yang_stmt *ymodext;
|
|
yang_stmt *ymod;
|
|
cg_var *cv;
|
|
cg_var *cv1;
|
|
char *label;
|
|
cvec *cvv;
|
|
cxobj *x1 = NULL;
|
|
|
|
if ((ymodext = yang_find(yspec, Y_MODULE, "ietf-yang-schema-mount")) == NULL ||
|
|
(yext = yang_find(ymodext, Y_EXTENSION, "mount-point")) == NULL){
|
|
goto ok;
|
|
// clicon_err(OE_YANG, 0, "yang schema mount-point extension not found");
|
|
// goto done;
|
|
}
|
|
if ((cvv = yang_cvec_get(yext)) != NULL){
|
|
if ((cb = cbuf_new()) ==NULL){
|
|
clicon_err(OE_XML, errno, "cbuf_new");
|
|
goto done;
|
|
}
|
|
cprintf(cb, "<schema-mounts xmlns=\"%s\">", YANG_SCHEMA_MOUNT_NAMESPACE); // XXX only if hit
|
|
cv = NULL;
|
|
while ((cv = cvec_each(cvv, cv)) != NULL){
|
|
ymount = (yang_stmt*)cv_void_get(cv);
|
|
ymod = ys_module(ymount);
|
|
if ((cv1 = yang_cv_get(ymount)) == NULL){
|
|
clicon_err(OE_YANG, 0, "mount-point extension must have label");
|
|
goto done;
|
|
}
|
|
label = cv_string_get(cv1);
|
|
cprintf(cb, "<mount-point>");
|
|
cprintf(cb, "<module>%s</module>", yang_argument_get(ymod));
|
|
cprintf(cb, "<label>%s</label>", label);
|
|
cprintf(cb, "<inline/>");
|
|
cprintf(cb, "</mount-point>");
|
|
}
|
|
cprintf(cb, "</schema-mounts>");
|
|
if ((ret = clixon_xml_parse_string(cbuf_get(cb), YB_MODULE, yspec, &x1, xerr)) < 0)
|
|
goto done;
|
|
if (ret == 0)
|
|
goto fail;
|
|
if ((ret = netconf_trymerge(x1, yspec, xret)) < 0)
|
|
goto done;
|
|
if (ret == 0)
|
|
goto fail;
|
|
}
|
|
/* Find mount-points and return yang-library state */
|
|
if (yang_schema_mount_statedata_yanglib(h, xpath, nsc, xret, xerr) < 0)
|
|
goto done;
|
|
ok:
|
|
retval = 1;
|
|
done:
|
|
if (x1)
|
|
xml_free(x1);
|
|
if (cb)
|
|
cbuf_free(cb);
|
|
return retval;
|
|
fail:
|
|
retval = 0;
|
|
goto done;
|
|
}
|
|
|
|
/*! Get yanglib from user plugin callback, parse it and mount it
|
|
*
|
|
* @param[in] h Clixon handle
|
|
* @param[in] xt
|
|
* @retval 0 OK
|
|
* @retval -1 Error
|
|
*/
|
|
int
|
|
yang_schema_yanglib_parse_mount(clicon_handle h,
|
|
cxobj *xt)
|
|
{
|
|
int retval = -1;
|
|
cxobj *yanglib = NULL;
|
|
yang_stmt *yspec = NULL;
|
|
int ret;
|
|
int config = 1;
|
|
validate_level vl = VL_FULL;
|
|
|
|
if (clixon_plugin_yang_mount_all(h, xt, &config, &vl, &yanglib) < 0)
|
|
goto done;
|
|
if (yanglib == NULL)
|
|
goto anydata;
|
|
/* Parse it and set mount-point */
|
|
if ((yspec = yspec_new()) == NULL)
|
|
goto done;
|
|
if ((ret = yang_lib2yspec(h, yanglib, yspec)) < 0)
|
|
goto done;
|
|
if (ret == 0)
|
|
goto anydata;
|
|
if (xml_yang_mount_set(xt, yspec) < 0)
|
|
goto done;
|
|
yspec = NULL;
|
|
retval = 1;
|
|
done:
|
|
if (yspec)
|
|
ys_free(yspec);
|
|
if (yanglib)
|
|
xml_free(yanglib);
|
|
return retval;
|
|
anydata: // Treat as anydata
|
|
retval = 0;
|
|
goto done;
|
|
}
|
|
|
|
/*! Check if XML nod is mount-point and return matching YANG child
|
|
*
|
|
* @param[in] h Clixon handle
|
|
* @param[in] x1 XML node
|
|
* @param[in] x1c A child of x1
|
|
* @param[out] yc YANG child
|
|
* @retval 1 OK, yc contains child
|
|
* @retval 0 No such child
|
|
* @retval -1 Error
|
|
* XXX maybe not needed
|
|
*/
|
|
int
|
|
yang_schema_get_child(clicon_handle h,
|
|
cxobj *x1,
|
|
cxobj *x1c,
|
|
yang_stmt **yc)
|
|
{
|
|
int retval = -1;
|
|
yang_stmt *yspec1;
|
|
yang_stmt *ymod1 = NULL;
|
|
char *x1cname;
|
|
int ret;
|
|
|
|
x1cname = xml_name(x1c);
|
|
if ((ret = xml_yang_mount_get(h, x1, NULL, &yspec1)) < 0)
|
|
goto done;
|
|
if (ret == 1 && yspec1 != NULL){
|
|
if (ys_module_by_xml(yspec1, x1c, &ymod1) <0)
|
|
goto done;
|
|
if (ymod1 != NULL)
|
|
*yc = yang_find_datanode(ymod1, x1cname);
|
|
else{ /* It is in fact a mountpoint, there is a yang mount, but it is not found */
|
|
goto fail;
|
|
}
|
|
}
|
|
retval = 1;
|
|
done:
|
|
return retval;
|
|
fail:
|
|
retval = 0;
|
|
goto done;
|
|
}
|