9fa5e216c4
w-level general upgrades and as a complement to module-specific upgrade. * Called on startup after initial XML parsing, but before module-specific upgrades * Enabled by definign the `.ca_datastore_upgrade` * [General-purpose upgrade documentation](https://clixon-docs.readthedocs.io/en/latest/backend.html#ge neral-purpose) * JSON parse error messages change from ` on line x: syntax error,..` to `json_parse: line x: syntax err or` * Unknown-element error message is more descriptive, eg from `namespace is: urn:example:clixon` to: `Fai led to find YANG spec of XML node: x with parent: xp in namespace urn:example:clixon`. * C-API parse and validation API more capable * `xml_spec_populate` family of functions extended with three-value return values * -1: error, 0: parse OK, 1: parse and YANG binding OK. * `xml_parse` and `json_parse` API changes * Three value returns: -1: error, 0: parse OK, 1: parse and YANG binding OK. * Extended `xml_parse_file2` and `xml_parse_string2` extended API functions with all options available. * New concept called `yang_bind` that defines how XML symbols are bound to YANG after parsing * Existing API same except `xml_parse_file` `endtag` argument moved to `xml_parse_file2` * C-API: Added instrumentation: `xml_size` and `xml_stats_get`. * Fixed: Enabling modstate (CLICON_XMLDB_MODSTATE), changing a revision on a yang, and restarting made the backend daemon exit at start (thanks Matt) * Also: ensure to load `ietf-yang-library.yang ` if CLICON_XMLDB_MODSTATE is set
93 lines
3.9 KiB
C
93 lines
3.9 KiB
C
/*
|
|
***** BEGIN LICENSE BLOCK *****
|
|
|
|
Copyright (C) 2009-2019 Olof Hagsand
|
|
Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC
|
|
|
|
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 *****
|
|
|
|
Custom file as boilerplate appended by clixon_config.h
|
|
Note that clixon_config.h is only included by clixon system files, not automatically by examples or apps
|
|
*/
|
|
|
|
#ifndef HAVE_STRNDUP
|
|
#define strndup(s, n) clicon_strndup(s, n)
|
|
#endif
|
|
|
|
/* Set if you want to assert that all rpc messages have set username
|
|
*/
|
|
#undef RPC_USERNAME_ASSERT
|
|
|
|
/* If rpc call does not have a namespace (eg using xmlns) then use the default
|
|
* NETCONF namespace (see rfc6241 3.1)
|
|
* Undefine it if you want to ensure strict namespace assignment on all netconf and
|
|
* XML statements.
|
|
*/
|
|
#define USE_NETCONF_NS_AS_DEFAULT
|
|
|
|
/*! Tag for wrong handling of identityref prefixes (XML encoding)
|
|
* See https://github.com/clicon/clixon/issues/90
|
|
* Instead of using generic xmlns prefix bindings, the module's own prefix
|
|
* is used.
|
|
* In the CLI generation case, this is actually quite complicated: the cli
|
|
* needs to generate a netconf statement with correct xmlns binding.
|
|
* The easy way to do this is to always generate all prefix/namespace bindings
|
|
* on the top-level for the modules involved in the netconf operation.
|
|
*/
|
|
#define IDENTITYREF_KLUDGE
|
|
|
|
/*! Optimize special list key searches in XPATH finds
|
|
* Identify xpaths that search for exactly a list key, eg: "y[k=3]" and then call
|
|
* binary search. This only works if "y" has proper yang binding and is sorted by system
|
|
*/
|
|
#define XPATH_LIST_OPTIMIZE
|
|
|
|
/*! Add explicit search indexes, so that binary search can be made for non-key list indexes
|
|
* This also applies if there are multiple keys and you want to search on only the second for
|
|
* example.
|
|
*/
|
|
#undef XML_EXPLICIT_INDEX
|
|
|
|
/*! Validate user state callback content
|
|
* Users may register state callbacks using ca_statedata callback
|
|
* When this option is set, the XML returned from the callback is validated after merging with the running
|
|
* db. If it fails, an internal error is returned to the originating user.
|
|
* If the option is not set, the XML returned by the user is not validated.
|
|
* Note that enabling this option causes a large performance overhead for large lists, therefore it
|
|
* is recommended to enable it during development and debugging but disable it in production, until
|
|
* this has been resolved.
|
|
*/
|
|
#define VALIDATE_STATE_XML
|
|
|
|
/*! Treat <config> specially in a xmldb datastore.
|
|
* config is treated as a "neutral" tag that does not have a yang spec.
|
|
* In particulat when binding xml to yang, if <config> is encountered as top-of-tree, do not
|
|
* try to bind a yang-spec to this symbol.
|
|
*/
|
|
#define XMLDB_CONFIG_HACK
|
|
|