experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

config file has .xml ending, yang/clixon-config.yang is used as

Browse source 
model for an xml-based configuration file
This commit is contained in:
Olof hagsand 2017-09-25 22:05:26 +02:00
parent e45e8da6d7
commit 8494d29d6b
9 changed files with 154 additions and 107 deletions
Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md
View file

@ -1,7 +1,8 @@
# Clixon CHANGELOG
## 3.3.3 Upcoming
* Added experimental reading of yang and xml-based config file.
* If clixon config file has .xml ending, yang/clixon-config.yang is used as
model for an xml-based configuration file. Otherwise legacy format is used.
* netconf client was limited to 8K byte messages. Now limit is 2^32.
* Added event_poll function.
* Added experimental xml hash for better performance of large lists.

4
example/Makefile.in
View file

@ -98,9 +98,10 @@ distclean: clean
rm -f Makefile *~ .depend
(cd docker && $(MAKE) $(MFLAGS) $@)
install: $(YANGSPECS) $(CLISPECS) $(BE_PLUGIN) $(CLI_PLUGIN) $(NETCONF_PLUGIN) $(APPNAME).conf
install: $(YANGSPECS) $(CLISPECS) $(BE_PLUGIN) $(CLI_PLUGIN) $(NETCONF_PLUGIN) $(APPNAME).conf $(APPNAME).xml
install -d $(DESTDIR)$(clixon_SYSCONFDIR)
install $(APPNAME).conf $(DESTDIR)$(clixon_SYSCONFDIR)
install $(APPNAME).xml $(DESTDIR)$(clixon_SYSCONFDIR)
install -d $(DESTDIR)$(clixon_DBSPECDIR)/yang
install $(YANGSPECS) $(DESTDIR)$(clixon_DBSPECDIR)/yang
install -d $(DESTDIR)$(clixon_LIBDIR)/cli
@ -116,6 +117,7 @@ install: $(YANGSPECS) $(CLISPECS) $(BE_PLUGIN) $(CLI_PLUGIN) $(NETCONF_PLUGIN) $
uninstall:
rm -rf $(DESTDIR)$(clixon_SYSCONFDIR)/$(APPNAME).conf
rm -rf $(DESTDIR)$(clixon_SYSCONFDIR)/$(APPNAME).xml
rm -rf $(DESTDIR)$(clixon_DBSPECDIR)
rm -rf $(DESTDIR)$(clixon_LOCALSTATEDIR)
rm -rf $(DESTDIR)$(clixon_LIBDIR)

17
example/routing.xml Normal file
View file

@ -0,0 +1,17 @@
<config>
<CLICON_CONFIGFILE>/usr/local/etc/routing.conf</CLICON_CONFIGFILE>
<CLICON_YANG_DIR>/usr/local/share/routing/yang</CLICON_YANG_DIR>
<CLICON_YANG_MODULE_MAIN>example</CLICON_YANG_MODULE_MAIN>
<CLICON_CLI_MODE>routing</CLICON_CLI_MODE>
<CLICON_BACKEND_DIR>/usr/local/lib/routing/backend></CLICON_BACKEND_DIR>
<CLICON_NETCONF_DIR>/usr/local/lib/routing/netconf</CLICON_NETCONF_DIR>
<CLICON_RESTCONF_DIR>/usr/local/lib/routing/restconf</CLICON_RESTCONF_DIR>
<CLICON_CLI_DIR>/usr/local/lib/routing/cli</CLICON_CLI_DIR>
<CLICON_CLISPEC_DIR>/usr/local/lib/routing/clispec</CLICON_CLISPEC_DIR>
<CLICON_SOCK>/usr/local/var/routing/routing.sock</CLICON_SOCK>
<CLICON_BACKEND_PIDFILE>/usr/local/var/routing/routing.pidfile</CLICON_BACKEND_PIDFILE>
<CLICON_CLI_GENMODEL_COMPLETION>1</CLICON_CLI_GENMODEL_COMPLETION>
<CLICON_XMLDB_DIR>/usr/local/var/routing</CLICON_XMLDB_DIR>
<CLICON_XMLDB_PLUGIN>/usr/local/lib/xmldb/text.so</CLICON_XMLDB_PLUGIN>
<CLICON_CLI_LINESCROLLING>0</CLICON_CLI_LINESCROLLING>
</config>

6
include/clixon_custom.h
View file

@ -43,12 +43,6 @@
int strverscmp (__const char *__s1, __const char *__s2);
#endif
/* Replace the current clixon.conf.cpp.cpp options with XML file with Yang
* Why not use the config mechanisms that CLixon uses for its own config-file?
* Experimental
*/
#define CONFIGFILE_XML 0
/* Hash for XML trees list entries
* Experimental
*/

7
lib/clixon/clixon_xml.h
View file

@ -57,7 +57,12 @@ enum cxobj_type {CX_ERROR=-1,
typedef struct xml cxobj; /* struct defined in clicon_xml.c */
/*! Callback function type for xml_apply */
/*! Callback function type for xml_apply
* @retval -1 Error, aborted at first error encounter
* @retval 0 OK, continue
* @retval 1 Abort, dont continue with others
* @retval 2 Locally, just abort this subtree, continue with others
*/
typedef int (xml_applyfn_t)(cxobj *yn, void *arg);
/*

144
lib/src/clixon_options.c
View file

@ -65,11 +65,10 @@
#include "clixon_yang.h"
#include "clixon_plugin.h"
#include "clixon_options.h"
#if CONFIGFILE_XML
#include "clixon_xml.h"
#include "clixon_xsl.h"
#include "clixon_xml_map.h"
#endif
/*
* clicon_option_dump
* Print registry on file. For debugging.
@ -105,23 +104,89 @@ clicon_option_dump(clicon_handle h, int dbglevel)
}
/*! Read filename and set values to global options registry. XML variant.
* @see clicon_option_readfile
*/
static int
clicon_option_readfile_xml(clicon_hash_t *copt,
const char *filename,
yang_spec *yspec)
{
struct stat st;
FILE *f = NULL;
int retval = -1;
int fd;
cxobj *xt = NULL;
cxobj *xc = NULL;
cxobj *x = NULL;
char *name;
char *body;
if (filename == NULL || !strlen(filename)){
clicon_err(OE_UNIX, 0, "Not specified");
goto done;
}
if (stat(filename, &st) < 0){
clicon_err(OE_UNIX, errno, "%s", filename);
goto done;
}
if (!S_ISREG(st.st_mode)){
clicon_err(OE_UNIX, 0, "%s is not a regular file", filename);
goto done;
}
if ((f = fopen(filename, "r")) == NULL) {
clicon_err(OE_UNIX, errno, "configure file: %s", filename);
return -1;
}
clicon_debug(2, "Reading config file %s", __FUNCTION__, filename);
fd = fileno(f);
if (clicon_xml_parse_file(fd, &xt, "</clicon>") < 0)
goto done;
if (xml_child_nr(xt)==1 && xml_child_nr_type(xt, CX_BODY)==1){
clicon_err(OE_CFG, 0, "Config file %s: Expected XML but is probably old sh style", filename);
goto done;
}
if ((xc = xpath_first(xt, "config")) == NULL) {
clicon_err(OE_CFG, 0, "Config file %s: Lacks top-level \"config\" element", filename);
goto done;
}
if (xml_apply0(xc, CX_ELMNT, xml_spec_populate, yspec) < 0)
goto done;
if (xml_apply0(xc, CX_ELMNT, xml_default, yspec) < 0)
goto done;
if (xml_apply0(xc, CX_ELMNT, xml_yang_validate_add, NULL) < 0)
goto done;
while ((x = xml_child_each(xc, x, CX_ELMNT)) != NULL) {
name = xml_name(x);
body = xml_body(x);
if (name && body &&
(hash_add(copt,
name,
body,
strlen(body)+1)) == NULL)
goto done;
}
retval = 0;
done:
if (f)
fclose(f);
return retval;
}
/*! Read filename and set values to global options registry
* For legacy configuration file, ie not xml
* @see clicon_option_readfile_xml
*/
static int
clicon_option_readfile(clicon_hash_t *copt,
const char *filename
#if CONFIGFILE_XML
,yang_spec *yspec
#endif
)
const char *filename)
{
struct stat st;
#if !CONFIGFILE_XML
char opt[1024];
char val[1024];
char line[1024];
char *cp;
#endif
FILE *f = NULL;
int retval = -1;
@ -142,39 +207,6 @@ clicon_option_readfile(clicon_hash_t *copt,
return -1;
}
clicon_debug(2, "Reading config file %s", __FUNCTION__, filename);
#if CONFIGFILE_XML
{
int fd = fileno(f);
cxobj *xt = NULL;
cxobj *xc = NULL;
cxobj *x = NULL;
char *name;
char *body;
if (clicon_xml_parse_file(fd, &xt, "</clicon>") < 0)
goto done;
if (xml_child_nr(xt)==1 && xml_child_nr_type(xt, CX_BODY)==1){
clicon_err(OE_CFG, 0, "Config file %s: Expected XML but is probably old sh style", filename);
goto done;
}
if ((xc = xpath_first(xt, "config")) == NULL) {
clicon_err(OE_CFG, 0, "Config file %s: Lacks top-level \"config\" element", filename);
goto done;
}
if (xml_apply(xc, CX_ELMNT, xml_spec_populate, yspec) < 0)
goto done;
while ((x = xml_child_each(xc, x, CX_ELMNT)) != NULL) {
name = xml_name(x);
body = xml_body(x);
if (name && body &&
(hash_add(copt,
name,
body,
strlen(body)+1)) == NULL)
goto done;
}
}
#else
while (fgets(line, sizeof(line), f)) {
if ((cp = strchr(line, '\n')) != NULL) /* strip last \n */
*cp = '\0';
@ -189,7 +221,6 @@ clicon_option_readfile(clicon_hash_t *copt,
strlen(val)+1)) == NULL)
goto done;
}
#endif
retval = 0;
done:
if (f)
@ -197,7 +228,6 @@ clicon_option_readfile(clicon_hash_t *copt,
return retval;
}
#if !CONFIGFILE_XML
/*! Set default values of some options that may not appear in config-file
*/
static int
@ -256,6 +286,7 @@ clicon_option_default(clicon_hash_t *copt)
}
/*! Check that options are set
* XXX dont detect extra XML
*/
static int
clicon_option_sanity(clicon_hash_t *copt)
@ -302,7 +333,6 @@ clicon_option_sanity(clicon_hash_t *copt)
done:
return retval;
}
#endif /* !CONFIGFILE_XML */
/*! Initialize option values
@ -316,6 +346,9 @@ clicon_options_main(clicon_handle h)
int retval = -1;
char *configfile;
clicon_hash_t *copt = clicon_options(h);
char *suffix;
char xml = 0; /* Configfile is xml, otherwise legacy */
yang_spec *yspec;
/*
* Set configure file if not set by command-line above
@ -326,22 +359,21 @@ clicon_options_main(clicon_handle h)
}
configfile = hash_value(copt, "CLICON_CONFIGFILE", NULL);
clicon_debug(1, "CLICON_CONFIGFILE=%s", configfile);
#if CONFIGFILE_XML
/* Read clixon yang file */
{
yang_spec *yspec;
/* If file ends with .xml, assume it is new format */
if ((suffix = rindex(configfile, '.')) != NULL){
suffix++;
xml = strcmp(suffix,"xml") == 0;
}
if (xml){ /* Read clixon yang file */
if ((yspec = yspec_new()) == NULL)
goto done;
if (yang_parse(h, CLIXON_DATADIR, "clixon-config", NULL, yspec) < 0)
goto done;
/* Read configfile */
if (clicon_option_readfile(copt, configfile, yspec) < 0)
if (clicon_option_readfile_xml(copt, configfile, yspec) < 0)
goto done;
}
#else
else {
/* Set default options */
if (clicon_option_default(copt) < 0) /* init registry from file */
goto done;
@ -350,12 +382,10 @@ clicon_options_main(clicon_handle h)
goto done;
if (clicon_option_sanity(copt) < 0)
goto done;
#endif
}
retval = 0;
done:
return retval;
}
/*! Check if a clicon option has a value

31
lib/src/clixon_xml.c
View file

@ -1445,8 +1445,8 @@ cxvec_append(cxobj *x,
* @param[in] fn Callback
* @param[in] arg Argument
* @retval -1 Error, aborted at first error encounter
* @retval 0 OK, all nodes traversed
* @retval n OK, aborted at first encounter of first match
* @retval 0 OK, all nodes traversed (subparts may have been skipped)
* @retval 1 OK, aborted on first fn returned 1
*
* @code
* int x_fn(cxobj *x, void *arg)
@ -1471,12 +1471,18 @@ xml_apply(cxobj *xn,
x = NULL;
while ((x = xml_child_each(xn, x, type)) != NULL) {
if (fn(x, arg) < 0)
if ((ret = fn(x, arg)) < 0)
goto done;
if (ret == 2)
continue; /* Abort this node, dont recurse */
else if (ret == 1){
retval = 1;
goto done;
}
if ((ret = xml_apply(x, type, fn, arg)) < 0)
goto done;
if (ret > 0){
retval = ret;
if (ret == 1){
retval = 1;
goto done;
}
}
@ -1487,10 +1493,9 @@ xml_apply(cxobj *xn,
/*! Apply a function call on top object and all xml node children recursively
* @retval -1 Error, aborted at first error encounter
* @retval 0 OK, all nodes traversed
* @retval n OK, aborted at first encounter of first match
* @retval 0 OK, all nodes traversed (subparts may have been skipped)
* @retval 1 OK, aborted on first fn returned 1
* @see xml_apply not including top object
*/
int
xml_apply0(cxobj *xn,
@ -1501,11 +1506,13 @@ xml_apply0(cxobj *xn,
int retval = -1;
int ret;
if ((ret = fn(xn, arg)) < 0)
if ((ret = fn(xn, arg)) < 0) /* -1, 0, 1, 2 */
goto done;
if (ret > 0)
retval = ret;
else
if (ret == 1)
retval = 1;
else if (ret > 1)
retval = 0;
else /* 0 */
retval = xml_apply(xn, type, fn, arg);
done:
return retval;

10
lib/src/clixon_xml_map.c
View file

@ -1476,16 +1476,6 @@ xml_spec_populate(cxobj *x,
y = yang_find_datanode((yang_node*)yp, xml_name(x));
else
y = yang_find_topnode(yspec, name, 0); /* still NULL for config */
//#ifdef XXX_OBSOLETE /* Add validate elsewhere */
#if 0
if (y==NULL){
clicon_err(OE_XML, EBADF, "yang spec not found for xml node '%s' xml parent name: '%s' yangspec:'%s']",
name,
xp?xml_name(xp):"", yp?yp->ys_argument:"");
return -1; // XXX
goto done;
}
#endif
if (y)
xml_spec_set(x, y);
retval = 0;

23
yang/clixon-config@2017-07-02.yang
View file

@ -42,14 +42,14 @@
description
"Initial revision";
}
container config {
leaf CLICON_CONFIGFILE{
type string;
default "sysconfdir/$APPNAME.conf";
description "Location of configuration-file for default values (this file)";
}
leaf CLICON_YANG_DIR {
type string;
default "prefix/share/$APPNAME/yang";
mandatory true;
description "Location of YANG module and submodule files. Only if CLICON_DBSPEC_TYPE is YANG";
}
leaf CLICON_YANG_MODULE_MAIN {
@ -66,27 +66,27 @@
}
leaf CLICON_BACKEND_DIR {
type string;
default "libdir/$APPNAME/backend";
mandatory true;
description "Location of backend .so plugins";
}
leaf CLICON_NETCONF_DIR {
type string;
default "libdir/$APPNAME/netconf";
mandatory true;
description "Location of netconf (frontend) .so plugins";
}
leaf CLICON_RESTCONF_DIR {
type string;
default "libdir/$APPNAME/restconf";
mandatory true;
description "Location of restconf (frontend) .so plugins";
}
leaf CLICON_CLI_DIR {
type string;
default "libdir/$APPNAME/cli";
mandatory true;
description "Location of cli frontend .so plugins";
}
leaf CLICON_CLISPEC_DIR {
type string;
default "libdir/$APPNAME/clispec";
mandatory true;
description "Location of frontend .cli cligen spec files";
}
leaf CLICON_USE_STARTUP_CONFIG {
@ -101,7 +101,7 @@
}
leaf CLICON_SOCK {
type string;
default "localstatedir/$APPNAME/$APPNAME.sock";
mandatory true;
description "If family above is AF_UNIX: Unix socket for communicating with
clixon_backend. If family above is AF_INET: IPv4 address";
}
@ -112,7 +112,7 @@
}
leaf CLICON_BACKEND_PIDFILE {
type string;
default "localstatedir/$APPNAME/$APPNAME.pidfile";
mandatory true;
description "Process-id file";
}
leaf CLICON_SOCK_GROUP {
@ -156,12 +156,12 @@
}
leaf CLICON_XMLDB_DIR {
type string;
default "localstatedir/$APPNAME";
mandatory true;
description "Directory where \"running\", \"candidate\" and \"startup\" are placed";
}
leaf CLICON_XMLDB_PLUGIN {
type string;
default "libdir/xmldb/text.so";
mandatory true;
description "XMLDB datastore plugin filename (see datastore/ and clixon_xml_db.[ch])";
}
leaf CLICON_CLI_VARONLY {
@ -183,3 +183,4 @@
Eg in nginx: fastcgi_pass unix:/www-data/clicon_restconf.sock;";
}
}
}