diff --git a/Makefile b/Makefile index 23de9e4..a1df7f0 100644 --- a/Makefile +++ b/Makefile @@ -19,6 +19,7 @@ CC:=$(CROSS_COMPILE)gcc LD:=$(CROSS_COMPILE)ld PKG_CONFIG ?= pkg-config APTERYX_PATH ?= +PYANG = pyang --plugindir . -p ./models ABI_VERSION=1.4 CFLAGS := $(CFLAGS) -g -O2 @@ -45,9 +46,9 @@ endif EXTRA_CFLAGS += -DHAVE_LIBXML2 $(shell $(PKG_CONFIG) --cflags libxml-2.0 jansson) EXTRA_LDFLAGS += $(shell $(PKG_CONFIG) --libs libxml-2.0 jansson) -all: libapteryx-xml.so libapteryx-schema.so apteryx/xml.so +all: libapteryx-xml.so libapteryx-schema.so apteryx/xml.so models/ietf-yang-library.xml -libapteryx-schema.so.$(ABI_VERSION): schema.o sch_xpath.o sch_conditions.o +libapteryx-schema.so.$(ABI_VERSION): schema.o sch_xpath.o sch_conditions.o sch_yang_library.o @echo "Creating library "$@"" $(Q)$(CC) -shared $(LDFLAGS) -o $@ $^ $(EXTRA_LDFLAGS) -Wl,-soname,$@ @@ -87,6 +88,9 @@ TEST_ARGS := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS)) $(eval $(TEST_ARGS):;@:) endif +models/ietf-yang-library.xml: models/ietf-yang-library.yang + $(PYANG) -f apteryx-xml $< > $@ + test: unittest @echo "Running XML unit tests" $(Q)$(call apteryxd,unittest -u$(TEST_ARGS)) @@ -95,6 +99,7 @@ test: unittest install: all $(Q)install -d $(DESTDIR)/etc/apteryx/schema $(Q)install -D -m 0644 apteryx.xsd $(DESTDIR)/etc/apteryx/schema/ + $(Q)install -D -m 0644 models/ietf-yang-library.xml $(DESTDIR)/etc/apteryx/schema/ $(Q)install -d $(DESTDIR)/$(PREFIX)/$(LIBDIR) $(Q)install -D libapteryx-xml.so.$(ABI_VERSION) $(DESTDIR)/$(PREFIX)/$(LIBDIR)/ $(Q)install -D libapteryx-schema.so.$(ABI_VERSION) $(DESTDIR)/$(PREFIX)/$(LIBDIR)/ @@ -107,6 +112,6 @@ install: all clean: @echo "Cleaning..." - @rm -fr libapteryx-schema.so* libapteryx-xml.so* apteryx/xml.so unittest *.o + @rm -fr libapteryx-schema.so* libapteryx-xml.so* apteryx/xml.so unittest *.o models/ietf-yang-library.xml .PHONY: all clean diff --git a/apteryx-xml.h b/apteryx-xml.h index d82852a..b87faa7 100644 --- a/apteryx-xml.h +++ b/apteryx-xml.h @@ -45,6 +45,8 @@ typedef struct _sch_loaded_model char *version; char *features; char *deviations; + char *filename; + bool loaded; } sch_loaded_model; /* Schema */ @@ -54,6 +56,7 @@ typedef void sch_ns; sch_instance *sch_load (const char *path); sch_instance *sch_load_with_model_list_filename (const char *path, const char *model_list_filename); +sch_instance *sch_load_model_list_yang_library (const char *path); void sch_free (sch_instance * instance); sch_node *sch_lookup (sch_instance * instance, const char *path); sch_node *sch_lookup_with_ns (sch_instance * instance, sch_ns *ns, const char *path); @@ -138,6 +141,26 @@ void sch_check_condition (sch_node *node, GNode *root, int flags, char **path, c bool sch_apply_conditions (sch_instance * instance, sch_node * schema, GNode *node, int flags); bool sch_trim_tree_by_depth (sch_instance *instance, sch_node *schema, GNode *node, int flags, int rdepth); +#define YANG_LIBRARY_CONTROL_PATH "/yang-library-control" +#define YANG_LIBRARY_CONTROL_STATE YANG_LIBRARY_CONTROL_PATH "/state" +#define YANG_LIBRARY_MOD_SET_COMMON_MOD "/yang-library/module-set/common/module" + +/* A server-generated identifier of the contents of the '/yang-library' tree. */ +#define YANG_LIBRARY_CONTENT_ID "/yang-library/content-id" + +typedef enum +{ + YANG_LIBRARY_S_NONE = 0, /* Zero state */ + YANG_LIBRARY_S_CREATED = 1, /* yang-library databse entry created */ + YANG_LIBRARY_S_LOADING = 2, /* yang-library models being loaded */ + YANG_LIBRARY_S_READY = 3, /* yang-library models fully loaded */ +} yang_library_state; + +void yang_library_control_set_state (int state); +volatile int yang_library_control_get_state (void); +void yang_library_add_model_information (sch_loaded_model *loaded); +void yang_library_create (sch_instance *schema); + #ifdef APTERYX_XML_JSON #include json_t *sch_gnode_to_json (sch_instance * instance, sch_node * schema, GNode * node, int flags); diff --git a/models/ietf-datastores.yang b/models/ietf-datastores.yang new file mode 100644 index 0000000..9e875ab --- /dev/null +++ b/models/ietf-datastores.yang @@ -0,0 +1,117 @@ +module ietf-datastores { + yang-version 1.1; + namespace "urn:ietf:params:xml:ns:yang:ietf-datastores"; + prefix ds; + + organization + "IETF Network Modeling (NETMOD) Working Group"; + + contact + "WG Web: + + WG List: + + Author: Martin Bjorklund + + + Author: Juergen Schoenwaelder + + + Author: Phil Shafer + + + Author: Kent Watsen + + + Author: Rob Wilton + "; + + description + "This YANG module defines a set of identities for identifying + datastores. + + Copyright (c) 2018 IETF Trust and the persons identified as + authors of the code. All rights reserved. + + Redistribution and use in source and binary forms, with or + without modification, is permitted pursuant to, and subject to + the license terms contained in, the Simplified BSD License set + forth in Section 4.c of the IETF Trust's Legal Provisions + Relating to IETF Documents + (https://trustee.ietf.org/license-info). + + This version of this YANG module is part of RFC 8342 + (https://www.rfc-editor.org/info/rfc8342); see the RFC itself + for full legal notices."; + + revision 2018-02-14 { + description + "Initial revision."; + reference + "RFC 8342: Network Management Datastore Architecture (NMDA)"; + } + + /* + * Identities + */ + + identity datastore { + description + "Abstract base identity for datastore identities."; + } + + identity conventional { + base datastore; + description + "Abstract base identity for conventional configuration + datastores."; + } + + identity running { + base conventional; + description + "The running configuration datastore."; + } + + identity candidate { + base conventional; + description + "The candidate configuration datastore."; + } + + identity startup { + base conventional; + description + "The startup configuration datastore."; + } + + identity intended { + base conventional; + description + "The intended configuration datastore."; + } + + identity dynamic { + base datastore; + description + "Abstract base identity for dynamic configuration datastores."; + } + + identity operational { + base datastore; + description + "The operational state datastore."; + } + + /* + * Type definitions + */ + + typedef datastore-ref { + type identityref { + base datastore; + } + description + "A datastore identity reference."; + } +} diff --git a/models/ietf-inet-types.yang b/models/ietf-inet-types.yang new file mode 100644 index 0000000..eacefb6 --- /dev/null +++ b/models/ietf-inet-types.yang @@ -0,0 +1,458 @@ +module ietf-inet-types { + + namespace "urn:ietf:params:xml:ns:yang:ietf-inet-types"; + prefix "inet"; + + organization + "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; + + contact + "WG Web: + WG List: + + WG Chair: David Kessens + + + WG Chair: Juergen Schoenwaelder + + + Editor: Juergen Schoenwaelder + "; + + description + "This module contains a collection of generally useful derived + YANG data types for Internet addresses and related things. + + Copyright (c) 2013 IETF Trust and the persons identified as + authors of the code. All rights reserved. + + Redistribution and use in source and binary forms, with or + without modification, is permitted pursuant to, and subject + to the license terms contained in, the Simplified BSD License + set forth in Section 4.c of the IETF Trust's Legal Provisions + Relating to IETF Documents + (http://trustee.ietf.org/license-info). + + This version of this YANG module is part of RFC 6991; see + the RFC itself for full legal notices."; + + revision 2013-07-15 { + description + "This revision adds the following new data types: + - ip-address-no-zone + - ipv4-address-no-zone + - ipv6-address-no-zone"; + reference + "RFC 6991: Common YANG Data Types"; + } + + revision 2010-09-24 { + description + "Initial revision."; + reference + "RFC 6021: Common YANG Data Types"; + } + + /*** collection of types related to protocol fields ***/ + + typedef ip-version { + type enumeration { + enum unknown { + value "0"; + description + "An unknown or unspecified version of the Internet + protocol."; + } + enum ipv4 { + value "1"; + description + "The IPv4 protocol as defined in RFC 791."; + } + enum ipv6 { + value "2"; + description + "The IPv6 protocol as defined in RFC 2460."; + } + } + description + "This value represents the version of the IP protocol. + + In the value set and its semantics, this type is equivalent + to the InetVersion textual convention of the SMIv2."; + reference + "RFC 791: Internet Protocol + RFC 2460: Internet Protocol, Version 6 (IPv6) Specification + RFC 4001: Textual Conventions for Internet Network Addresses"; + } + + typedef dscp { + type uint8 { + range "0..63"; + } + description + "The dscp type represents a Differentiated Services Code Point + that may be used for marking packets in a traffic stream. + In the value set and its semantics, this type is equivalent + to the Dscp textual convention of the SMIv2."; + reference + "RFC 3289: Management Information Base for the Differentiated + Services Architecture + RFC 2474: Definition of the Differentiated Services Field + (DS Field) in the IPv4 and IPv6 Headers + RFC 2780: IANA Allocation Guidelines For Values In + the Internet Protocol and Related Headers"; + } + + typedef ipv6-flow-label { + type uint32 { + range "0..1048575"; + } + description + "The ipv6-flow-label type represents the flow identifier or Flow + Label in an IPv6 packet header that may be used to + discriminate traffic flows. + + In the value set and its semantics, this type is equivalent + to the IPv6FlowLabel textual convention of the SMIv2."; + reference + "RFC 3595: Textual Conventions for IPv6 Flow Label + RFC 2460: Internet Protocol, Version 6 (IPv6) Specification"; + } + + typedef port-number { + type uint16 { + range "0..65535"; + } + description + "The port-number type represents a 16-bit port number of an + Internet transport-layer protocol such as UDP, TCP, DCCP, or + SCTP. Port numbers are assigned by IANA. A current list of + all assignments is available from . + + Note that the port number value zero is reserved by IANA. In + situations where the value zero does not make sense, it can + be excluded by subtyping the port-number type. + In the value set and its semantics, this type is equivalent + to the InetPortNumber textual convention of the SMIv2."; + reference + "RFC 768: User Datagram Protocol + RFC 793: Transmission Control Protocol + RFC 4960: Stream Control Transmission Protocol + RFC 4340: Datagram Congestion Control Protocol (DCCP) + RFC 4001: Textual Conventions for Internet Network Addresses"; + } + + /*** collection of types related to autonomous systems ***/ + + typedef as-number { + type uint32; + description + "The as-number type represents autonomous system numbers + which identify an Autonomous System (AS). An AS is a set + of routers under a single technical administration, using + an interior gateway protocol and common metrics to route + packets within the AS, and using an exterior gateway + protocol to route packets to other ASes. IANA maintains + the AS number space and has delegated large parts to the + regional registries. + + Autonomous system numbers were originally limited to 16 + bits. BGP extensions have enlarged the autonomous system + number space to 32 bits. This type therefore uses an uint32 + base type without a range restriction in order to support + a larger autonomous system number space. + + In the value set and its semantics, this type is equivalent + to the InetAutonomousSystemNumber textual convention of + the SMIv2."; + reference + "RFC 1930: Guidelines for creation, selection, and registration + of an Autonomous System (AS) + RFC 4271: A Border Gateway Protocol 4 (BGP-4) + RFC 4001: Textual Conventions for Internet Network Addresses + RFC 6793: BGP Support for Four-Octet Autonomous System (AS) + Number Space"; + } + + /*** collection of types related to IP addresses and hostnames ***/ + + typedef ip-address { + type union { + type inet:ipv4-address; + type inet:ipv6-address; + } + description + "The ip-address type represents an IP address and is IP + version neutral. The format of the textual representation + implies the IP version. This type supports scoped addresses + by allowing zone identifiers in the address format."; + reference + "RFC 4007: IPv6 Scoped Address Architecture"; + } + + typedef ipv4-address { + type string { + pattern + '(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}' + + '([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])' + + '(%[\p{N}\p{L}]+)?'; + } + description + "The ipv4-address type represents an IPv4 address in + dotted-quad notation. The IPv4 address may include a zone + index, separated by a % sign. + + The zone index is used to disambiguate identical address + values. For link-local addresses, the zone index will + typically be the interface index number or the name of an + interface. If the zone index is not present, the default + zone of the device will be used. + + The canonical format for the zone index is the numerical + format"; + } + + typedef ipv6-address { + type string { + pattern '((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}' + + '((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|' + + '(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}' + + '(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))' + + '(%[\p{N}\p{L}]+)?'; + pattern '(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|' + + '((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)' + + '(%.+)?'; + } + description + "The ipv6-address type represents an IPv6 address in full, + mixed, shortened, and shortened-mixed notation. The IPv6 + address may include a zone index, separated by a % sign. + + The zone index is used to disambiguate identical address + values. For link-local addresses, the zone index will + typically be the interface index number or the name of an + interface. If the zone index is not present, the default + zone of the device will be used. + + The canonical format of IPv6 addresses uses the textual + representation defined in Section 4 of RFC 5952. The + canonical format for the zone index is the numerical + format as described in Section 11.2 of RFC 4007."; + reference + "RFC 4291: IP Version 6 Addressing Architecture + RFC 4007: IPv6 Scoped Address Architecture + RFC 5952: A Recommendation for IPv6 Address Text + Representation"; + } + + typedef ip-address-no-zone { + type union { + type inet:ipv4-address-no-zone; + type inet:ipv6-address-no-zone; + } + description + "The ip-address-no-zone type represents an IP address and is + IP version neutral. The format of the textual representation + implies the IP version. This type does not support scoped + addresses since it does not allow zone identifiers in the + address format."; + reference + "RFC 4007: IPv6 Scoped Address Architecture"; + } + + typedef ipv4-address-no-zone { + type inet:ipv4-address { + pattern '[0-9\.]*'; + } + description + "An IPv4 address without a zone index. This type, derived from + ipv4-address, may be used in situations where the zone is + known from the context and hence no zone index is needed."; + } + + typedef ipv6-address-no-zone { + type inet:ipv6-address { + pattern '[0-9a-fA-F:\.]*'; + } + description + "An IPv6 address without a zone index. This type, derived from + ipv6-address, may be used in situations where the zone is + known from the context and hence no zone index is needed."; + reference + "RFC 4291: IP Version 6 Addressing Architecture + RFC 4007: IPv6 Scoped Address Architecture + RFC 5952: A Recommendation for IPv6 Address Text + Representation"; + } + + typedef ip-prefix { + type union { + type inet:ipv4-prefix; + type inet:ipv6-prefix; + } + description + "The ip-prefix type represents an IP prefix and is IP + version neutral. The format of the textual representations + implies the IP version."; + } + + typedef ipv4-prefix { + type string { + pattern + '(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}' + + '([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])' + + '/(([0-9])|([1-2][0-9])|(3[0-2]))'; + } + description + "The ipv4-prefix type represents an IPv4 address prefix. + The prefix length is given by the number following the + slash character and must be less than or equal to 32. + + A prefix length value of n corresponds to an IP address + mask that has n contiguous 1-bits from the most + significant bit (MSB) and all other bits set to 0. + + The canonical format of an IPv4 prefix has all bits of + the IPv4 address set to zero that are not part of the + IPv4 prefix."; + } + + typedef ipv6-prefix { + type string { + pattern '((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}' + + '((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|' + + '(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}' + + '(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))' + + '(/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))'; + pattern '(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|' + + '((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)' + + '(/.+)'; + } + + description + "The ipv6-prefix type represents an IPv6 address prefix. + The prefix length is given by the number following the + slash character and must be less than or equal to 128. + + A prefix length value of n corresponds to an IP address + mask that has n contiguous 1-bits from the most + significant bit (MSB) and all other bits set to 0. + + The IPv6 address should have all bits that do not belong + to the prefix set to zero. + + The canonical format of an IPv6 prefix has all bits of + the IPv6 address set to zero that are not part of the + IPv6 prefix. Furthermore, the IPv6 address is represented + as defined in Section 4 of RFC 5952."; + reference + "RFC 5952: A Recommendation for IPv6 Address Text + Representation"; + } + + /*** collection of domain name and URI types ***/ + + typedef domain-name { + type string { + pattern + '((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*' + + '([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)' + + '|\.'; + length "1..253"; + } + description + "The domain-name type represents a DNS domain name. The + name SHOULD be fully qualified whenever possible. + + Internet domain names are only loosely specified. Section + 3.5 of RFC 1034 recommends a syntax (modified in Section + 2.1 of RFC 1123). The pattern above is intended to allow + for current practice in domain name use, and some possible + future expansion. It is designed to hold various types of + domain names, including names used for A or AAAA records + (host names) and other records, such as SRV records. Note + that Internet host names have a stricter syntax (described + in RFC 952) than the DNS recommendations in RFCs 1034 and + 1123, and that systems that want to store host names in + schema nodes using the domain-name type are recommended to + adhere to this stricter standard to ensure interoperability. + + The encoding of DNS names in the DNS protocol is limited + to 255 characters. Since the encoding consists of labels + prefixed by a length bytes and there is a trailing NULL + byte, only 253 characters can appear in the textual dotted + notation. + + The description clause of schema nodes using the domain-name + type MUST describe when and how these names are resolved to + IP addresses. Note that the resolution of a domain-name value + may require to query multiple DNS records (e.g., A for IPv4 + and AAAA for IPv6). The order of the resolution process and + which DNS record takes precedence can either be defined + explicitly or may depend on the configuration of the + resolver. + + Domain-name values use the US-ASCII encoding. Their canonical + format uses lowercase US-ASCII characters. Internationalized + domain names MUST be A-labels as per RFC 5890."; + reference + "RFC 952: DoD Internet Host Table Specification + RFC 1034: Domain Names - Concepts and Facilities + RFC 1123: Requirements for Internet Hosts -- Application + and Support + RFC 2782: A DNS RR for specifying the location of services + (DNS SRV) + RFC 5890: Internationalized Domain Names in Applications + (IDNA): Definitions and Document Framework"; + } + + typedef host { + type union { + type inet:ip-address; + type inet:domain-name; + } + description + "The host type represents either an IP address or a DNS + domain name."; + } + + typedef uri { + type string; + description + "The uri type represents a Uniform Resource Identifier + (URI) as defined by STD 66. + + Objects using the uri type MUST be in US-ASCII encoding, + and MUST be normalized as described by RFC 3986 Sections + 6.2.1, 6.2.2.1, and 6.2.2.2. All unnecessary + percent-encoding is removed, and all case-insensitive + characters are set to lowercase except for hexadecimal + digits, which are normalized to uppercase as described in + Section 6.2.2.1. + + The purpose of this normalization is to help provide + unique URIs. Note that this normalization is not + sufficient to provide uniqueness. Two URIs that are + textually distinct after this normalization may still be + equivalent. + + Objects using the uri type may restrict the schemes that + they permit. For example, 'data:' and 'urn:' schemes + might not be appropriate. + + A zero-length URI is not a valid URI. This can be used to + express 'URI absent' where required. + + In the value set and its semantics, this type is equivalent + to the Uri SMIv2 textual convention defined in RFC 5017."; + reference + "RFC 3986: Uniform Resource Identifier (URI): Generic Syntax + RFC 3305: Report from the Joint W3C/IETF URI Planning Interest + Group: Uniform Resource Identifiers (URIs), URLs, + and Uniform Resource Names (URNs): Clarifications + and Recommendations + RFC 5017: MIB Textual Conventions for Uniform Resource + Identifiers (URIs)"; + } + +} diff --git a/models/ietf-yang-library.yang b/models/ietf-yang-library.yang new file mode 100644 index 0000000..dac53a1 --- /dev/null +++ b/models/ietf-yang-library.yang @@ -0,0 +1,544 @@ +module ietf-yang-library { + yang-version 1.1; + namespace "urn:ietf:params:xml:ns:yang:ietf-yang-library"; + prefix yanglib; + + import ietf-yang-types { + prefix yang; + reference + "RFC 6991: Common YANG Data Types"; + } + import ietf-inet-types { + prefix inet; + reference + "RFC 6991: Common YANG Data Types"; + } + import ietf-datastores { + prefix ds; + reference + "RFC 8342: Network Management Datastore Architecture + (NMDA)"; + } + + organization + "IETF NETCONF (Network Configuration) Working Group"; + contact + "WG Web: + WG List: + + Author: Andy Bierman + + + Author: Martin Bjorklund + + + Author: Juergen Schoenwaelder + + + Author: Kent Watsen + + + Author: Robert Wilton + "; + description + "This module provides information about the YANG modules, + datastores, and datastore schemas used by a network + management server. + The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL + NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', + 'MAY', and 'OPTIONAL' in this document are to be interpreted as + described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, + they appear in all capitals, as shown here. + + Copyright (c) 2019 IETF Trust and the persons identified as + authors of the code. All rights reserved. + + Redistribution and use in source and binary forms, with or + without modification, is permitted pursuant to, and subject + to the license terms contained in, the Simplified BSD License + set forth in Section 4.c of the IETF Trust's Legal Provisions + Relating to IETF Documents + (https://trustee.ietf.org/license-info). + + This version of this YANG module is part of RFC 8525; see + the RFC itself for full legal notices."; + + revision 2019-01-04 { + description + "Added support for multiple datastores according to the + Network Management Datastore Architecture (NMDA)."; + reference + "RFC 8525: YANG Library"; + } + revision 2016-04-09 { + description + "Initial revision."; + reference + "RFC 7895: YANG Module Library"; + } + + /* + * Typedefs + */ + + typedef revision-identifier { + type string { + pattern '\d{4}-\d{2}-\d{2}'; + } + description + "Represents a specific date in YYYY-MM-DD format."; + } + + /* + * Groupings + */ + grouping module-identification-leafs { + description + "Parameters for identifying YANG modules and submodules."; + leaf name { + type yang:yang-identifier; + mandatory true; + description + "The YANG module or submodule name."; + } + leaf revision { + type revision-identifier; + description + "The YANG module or submodule revision date. If no revision + statement is present in the YANG module or submodule, this + leaf is not instantiated."; + } + } + + grouping location-leaf-list { + description + "Common leaf-list parameter for the locations of modules and + submodules."; + leaf-list location { + type inet:uri; + description + "Contains a URL that represents the YANG schema + resource for this module or submodule. + + This leaf will only be present if there is a URL + available for retrieval of the schema for this entry."; + } + } + + grouping module-implementation-parameters { + description + "Parameters for describing the implementation of a module."; + leaf-list feature { + type yang:yang-identifier; + description + "List of all YANG feature names from this module that are + supported by the server, regardless whether they are defined + in the module or any included submodule."; + } + leaf-list deviation { + type leafref { + path "../../module/name"; + } + + description + "List of all YANG deviation modules used by this server to + modify the conformance of the module associated with this + entry. Note that the same module can be used for deviations + for multiple modules, so the same entry MAY appear within + multiple 'module' entries. + + This reference MUST NOT (directly or indirectly) + refer to the module being deviated. + + Robust clients may want to make sure that they handle a + situation where a module deviates itself (directly or + indirectly) gracefully."; + } + } + + grouping module-set-parameters { + description + "A set of parameters that describe a module set."; + leaf name { + type string; + description + "An arbitrary name of the module set."; + } + list module { + key "name"; + description + "An entry in this list represents a module implemented by the + server, as per Section 5.6.5 of RFC 7950, with a particular + set of supported features and deviations."; + reference + "RFC 7950: The YANG 1.1 Data Modeling Language"; + uses module-identification-leafs; + leaf namespace { + type inet:uri; + mandatory true; + description + "The XML namespace identifier for this module."; + } + uses location-leaf-list; + list submodule { + key "name"; + description + "Each entry represents one submodule within the + parent module."; + uses module-identification-leafs; + uses location-leaf-list; + } + uses module-implementation-parameters; + } + list import-only-module { + key "name revision"; + description + "An entry in this list indicates that the server imports + reusable definitions from the specified revision of the + module but does not implement any protocol-accessible + objects from this revision. + + Multiple entries for the same module name MAY exist. This + can occur if multiple modules import the same module but + specify different revision dates in the import statements."; + leaf name { + type yang:yang-identifier; + description + "The YANG module name."; + } + leaf revision { + type union { + type revision-identifier; + type string { + length "0"; + } + } + description + "The YANG module revision date. + A zero-length string is used if no revision statement + is present in the YANG module."; + } + leaf namespace { + type inet:uri; + mandatory true; + description + "The XML namespace identifier for this module."; + } + uses location-leaf-list; + list submodule { + key "name"; + description + "Each entry represents one submodule within the + parent module."; + uses module-identification-leafs; + uses location-leaf-list; + } + } + } + + grouping yang-library-parameters { + description + "The YANG library data structure is represented as a grouping + so it can be reused in configuration or another monitoring + data structure."; + list module-set { + key "name"; + description + "A set of modules that may be used by one or more schemas. + + A module set does not have to be referentially complete, + i.e., it may define modules that contain import statements + for other modules not included in the module set."; + uses module-set-parameters; + } + list schema { + key "name"; + description + "A datastore schema that may be used by one or more + datastores. + + The schema must be valid and referentially complete, i.e., + it must contain modules to satisfy all used import + statements for all modules specified in the schema."; + leaf name { + type string; + description + "An arbitrary name of the schema."; + } + leaf-list module-set { + type leafref { + path "../../module-set/name"; + } + description + "A set of module-sets that are included in this schema. + If a non-import-only module appears in multiple module + sets, then the module revision and the associated features + and deviations must be identical."; + } + } + list datastore { + key "name"; + description + "A datastore supported by this server. + + Each datastore indicates which schema it supports. + + The server MUST instantiate one entry in this list per + specific datastore it supports. + Each datastore entry with the same datastore schema SHOULD + reference the same schema."; + leaf name { + type ds:datastore-ref; + description + "The identity of the datastore."; + } + leaf schema { + type leafref { + path "../../schema/name"; + } + mandatory true; + description + "A reference to the schema supported by this datastore. + All non-import-only modules of the schema are implemented + with their associated features and deviations."; + } + } + } + + /* + * Top-level container + */ + + container yang-library { + config false; + description + "Container holding the entire YANG library of this server."; + uses yang-library-parameters; + leaf content-id { + type string; + mandatory true; + description + "A server-generated identifier of the contents of the + '/yang-library' tree. The server MUST change the value of + this leaf if the information represented by the + '/yang-library' tree, except '/yang-library/content-id', has + changed."; + } + } + + /* + * Notifications + */ + + notification yang-library-update { + description + "Generated when any YANG library information on the + server has changed."; + leaf content-id { + type leafref { + path "/yanglib:yang-library/yanglib:content-id"; + } + mandatory true; + description + "Contains the YANG library content identifier for the updated + YANG library at the time the notification is generated."; + } + } + + /* + * Legacy groupings + */ + + grouping module-list { + status deprecated; + description + "The module data structure is represented as a grouping + so it can be reused in configuration or another monitoring + data structure."; + + grouping common-leafs { + status deprecated; + description + "Common parameters for YANG modules and submodules."; + leaf name { + type yang:yang-identifier; + status deprecated; + description + "The YANG module or submodule name."; + } + leaf revision { + type union { + type revision-identifier; + type string { + length "0"; + } + } + status deprecated; + description + "The YANG module or submodule revision date. + A zero-length string is used if no revision statement + is present in the YANG module or submodule."; + } + } + + grouping schema-leaf { + status deprecated; + description + "Common schema leaf parameter for modules and submodules."; + leaf schema { + type inet:uri; + description + "Contains a URL that represents the YANG schema + resource for this module or submodule. + + This leaf will only be present if there is a URL + available for retrieval of the schema for this entry."; + } + } + list module { + key "name revision"; + status deprecated; + description + "Each entry represents one revision of one module + currently supported by the server."; + uses common-leafs { + status deprecated; + } + uses schema-leaf { + status deprecated; + } + leaf namespace { + type inet:uri; + mandatory true; + status deprecated; + description + "The XML namespace identifier for this module."; + } + leaf-list feature { + type yang:yang-identifier; + status deprecated; + description + "List of YANG feature names from this module that are + supported by the server, regardless of whether they are + defined in the module or any included submodule."; + } + list deviation { + key "name revision"; + status deprecated; + + description + "List of YANG deviation module names and revisions + used by this server to modify the conformance of + the module associated with this entry. Note that + the same module can be used for deviations for + multiple modules, so the same entry MAY appear + within multiple 'module' entries. + + The deviation module MUST be present in the 'module' + list, with the same name and revision values. + The 'conformance-type' value will be 'implement' for + the deviation module."; + uses common-leafs { + status deprecated; + } + } + leaf conformance-type { + type enumeration { + enum implement { + description + "Indicates that the server implements one or more + protocol-accessible objects defined in the YANG module + identified in this entry. This includes deviation + statements defined in the module. + + For YANG version 1.1 modules, there is at most one + 'module' entry with conformance type 'implement' for a + particular module name, since YANG 1.1 requires that + at most one revision of a module is implemented. + + For YANG version 1 modules, there SHOULD NOT be more + than one 'module' entry for a particular module + name."; + } + enum import { + description + "Indicates that the server imports reusable definitions + from the specified revision of the module but does + not implement any protocol-accessible objects from + this revision. + + Multiple 'module' entries for the same module name MAY + exist. This can occur if multiple modules import the + same module but specify different revision dates in + the import statements."; + } + } + mandatory true; + status deprecated; + description + "Indicates the type of conformance the server is claiming + for the YANG module identified by this entry."; + } + list submodule { + key "name revision"; + status deprecated; + description + "Each entry represents one submodule within the + parent module."; + uses common-leafs { + status deprecated; + } + uses schema-leaf { + status deprecated; + } + } + } + } + + /* + * Legacy operational state data nodes + */ + + container modules-state { + config false; + status deprecated; + description + "Contains YANG module monitoring information."; + leaf module-set-id { + type string; + mandatory true; + status deprecated; + description + "Contains a server-specific identifier representing + the current set of modules and submodules. The + server MUST change the value of this leaf if the + information represented by the 'module' list instances + has changed."; + } + uses module-list { + status deprecated; + } + } + + /* + * Legacy notifications + */ + + notification yang-library-change { + status deprecated; + description + "Generated when the set of modules and submodules supported + by the server has changed."; + leaf module-set-id { + type leafref { + path "/yanglib:modules-state/yanglib:module-set-id"; + } + mandatory true; + status deprecated; + description + "Contains the module-set-id value representing the + set of modules and submodules supported at the server + at the time the notification is generated."; + } + } +} diff --git a/models/ietf-yang-types.yang b/models/ietf-yang-types.yang new file mode 100644 index 0000000..ee58fa3 --- /dev/null +++ b/models/ietf-yang-types.yang @@ -0,0 +1,474 @@ +module ietf-yang-types { + + namespace "urn:ietf:params:xml:ns:yang:ietf-yang-types"; + prefix "yang"; + + organization + "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; + + contact + "WG Web: + WG List: + + WG Chair: David Kessens + + + WG Chair: Juergen Schoenwaelder + + + Editor: Juergen Schoenwaelder + "; + + description + "This module contains a collection of generally useful derived + YANG data types. + + Copyright (c) 2013 IETF Trust and the persons identified as + authors of the code. All rights reserved. + + Redistribution and use in source and binary forms, with or + without modification, is permitted pursuant to, and subject + to the license terms contained in, the Simplified BSD License + set forth in Section 4.c of the IETF Trust's Legal Provisions + Relating to IETF Documents + (http://trustee.ietf.org/license-info). + + This version of this YANG module is part of RFC 6991; see + the RFC itself for full legal notices."; + + revision 2013-07-15 { + description + "This revision adds the following new data types: + - yang-identifier + - hex-string + - uuid + - dotted-quad"; + reference + "RFC 6991: Common YANG Data Types"; + } + + revision 2010-09-24 { + description + "Initial revision."; + reference + "RFC 6021: Common YANG Data Types"; + } + + /*** collection of counter and gauge types ***/ + + typedef counter32 { + type uint32; + description + "The counter32 type represents a non-negative integer + that monotonically increases until it reaches a + maximum value of 2^32-1 (4294967295 decimal), when it + wraps around and starts increasing again from zero. + + Counters have no defined 'initial' value, and thus, a + single value of a counter has (in general) no information + content. Discontinuities in the monotonically increasing + value normally occur at re-initialization of the + management system, and at other times as specified in the + description of a schema node using this type. If such + other times can occur, for example, the creation of + a schema node of type counter32 at times other than + re-initialization, then a corresponding schema node + should be defined, with an appropriate type, to indicate + the last discontinuity. + + The counter32 type should not be used for configuration + schema nodes. A default statement SHOULD NOT be used in + combination with the type counter32. + + In the value set and its semantics, this type is equivalent + to the Counter32 type of the SMIv2."; + reference + "RFC 2578: Structure of Management Information Version 2 + (SMIv2)"; + } + + typedef zero-based-counter32 { + type yang:counter32; + default "0"; + description + "The zero-based-counter32 type represents a counter32 + that has the defined 'initial' value zero. + + A schema node of this type will be set to zero (0) on creation + and will thereafter increase monotonically until it reaches + a maximum value of 2^32-1 (4294967295 decimal), when it + wraps around and starts increasing again from zero. + + Provided that an application discovers a new schema node + of this type within the minimum time to wrap, it can use the + 'initial' value as a delta. It is important for a management + station to be aware of this minimum time and the actual time + between polls, and to discard data if the actual time is too + long or there is no defined minimum time. + + In the value set and its semantics, this type is equivalent + to the ZeroBasedCounter32 textual convention of the SMIv2."; + reference + "RFC 4502: Remote Network Monitoring Management Information + Base Version 2"; + } + + typedef counter64 { + type uint64; + description + "The counter64 type represents a non-negative integer + that monotonically increases until it reaches a + maximum value of 2^64-1 (18446744073709551615 decimal), + when it wraps around and starts increasing again from zero. + + Counters have no defined 'initial' value, and thus, a + single value of a counter has (in general) no information + content. Discontinuities in the monotonically increasing + value normally occur at re-initialization of the + management system, and at other times as specified in the + description of a schema node using this type. If such + other times can occur, for example, the creation of + a schema node of type counter64 at times other than + re-initialization, then a corresponding schema node + should be defined, with an appropriate type, to indicate + the last discontinuity. + + The counter64 type should not be used for configuration + schema nodes. A default statement SHOULD NOT be used in + combination with the type counter64. + + In the value set and its semantics, this type is equivalent + to the Counter64 type of the SMIv2."; + reference + "RFC 2578: Structure of Management Information Version 2 + (SMIv2)"; + } + + typedef zero-based-counter64 { + type yang:counter64; + default "0"; + description + "The zero-based-counter64 type represents a counter64 that + has the defined 'initial' value zero. + + A schema node of this type will be set to zero (0) on creation + and will thereafter increase monotonically until it reaches + a maximum value of 2^64-1 (18446744073709551615 decimal), + when it wraps around and starts increasing again from zero. + + Provided that an application discovers a new schema node + of this type within the minimum time to wrap, it can use the + 'initial' value as a delta. It is important for a management + station to be aware of this minimum time and the actual time + between polls, and to discard data if the actual time is too + long or there is no defined minimum time. + + In the value set and its semantics, this type is equivalent + to the ZeroBasedCounter64 textual convention of the SMIv2."; + reference + "RFC 2856: Textual Conventions for Additional High Capacity + Data Types"; + } + + typedef gauge32 { + type uint32; + description + "The gauge32 type represents a non-negative integer, which + may increase or decrease, but shall never exceed a maximum + value, nor fall below a minimum value. The maximum value + cannot be greater than 2^32-1 (4294967295 decimal), and + the minimum value cannot be smaller than 0. The value of + a gauge32 has its maximum value whenever the information + being modeled is greater than or equal to its maximum + value, and has its minimum value whenever the information + being modeled is smaller than or equal to its minimum value. + If the information being modeled subsequently decreases + below (increases above) the maximum (minimum) value, the + gauge32 also decreases (increases). + + In the value set and its semantics, this type is equivalent + to the Gauge32 type of the SMIv2."; + reference + "RFC 2578: Structure of Management Information Version 2 + (SMIv2)"; + } + + typedef gauge64 { + type uint64; + description + "The gauge64 type represents a non-negative integer, which + may increase or decrease, but shall never exceed a maximum + value, nor fall below a minimum value. The maximum value + cannot be greater than 2^64-1 (18446744073709551615), and + the minimum value cannot be smaller than 0. The value of + a gauge64 has its maximum value whenever the information + being modeled is greater than or equal to its maximum + value, and has its minimum value whenever the information + being modeled is smaller than or equal to its minimum value. + If the information being modeled subsequently decreases + below (increases above) the maximum (minimum) value, the + gauge64 also decreases (increases). + + In the value set and its semantics, this type is equivalent + to the CounterBasedGauge64 SMIv2 textual convention defined + in RFC 2856"; + reference + "RFC 2856: Textual Conventions for Additional High Capacity + Data Types"; + } + + /*** collection of identifier-related types ***/ + + typedef object-identifier { + type string { + pattern '(([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))' + + '(\.(0|([1-9]\d*)))*'; + } + description + "The object-identifier type represents administratively + assigned names in a registration-hierarchical-name tree. + + Values of this type are denoted as a sequence of numerical + non-negative sub-identifier values. Each sub-identifier + value MUST NOT exceed 2^32-1 (4294967295). Sub-identifiers + are separated by single dots and without any intermediate + whitespace. + + The ASN.1 standard restricts the value space of the first + sub-identifier to 0, 1, or 2. Furthermore, the value space + of the second sub-identifier is restricted to the range + 0 to 39 if the first sub-identifier is 0 or 1. Finally, + the ASN.1 standard requires that an object identifier + has always at least two sub-identifiers. The pattern + captures these restrictions. + + Although the number of sub-identifiers is not limited, + module designers should realize that there may be + implementations that stick with the SMIv2 limit of 128 + sub-identifiers. + + This type is a superset of the SMIv2 OBJECT IDENTIFIER type + since it is not restricted to 128 sub-identifiers. Hence, + this type SHOULD NOT be used to represent the SMIv2 OBJECT + IDENTIFIER type; the object-identifier-128 type SHOULD be + used instead."; + reference + "ISO9834-1: Information technology -- Open Systems + Interconnection -- Procedures for the operation of OSI + Registration Authorities: General procedures and top + arcs of the ASN.1 Object Identifier tree"; + } + + typedef object-identifier-128 { + type object-identifier { + pattern '\d*(\.\d*){1,127}'; + } + description + "This type represents object-identifiers restricted to 128 + sub-identifiers. + + In the value set and its semantics, this type is equivalent + to the OBJECT IDENTIFIER type of the SMIv2."; + reference + "RFC 2578: Structure of Management Information Version 2 + (SMIv2)"; + } + + typedef yang-identifier { + type string { + length "1..max"; + pattern '[a-zA-Z_][a-zA-Z0-9\-_.]*'; + pattern '.|..|[^xX].*|.[^mM].*|..[^lL].*'; + } + description + "A YANG identifier string as defined by the 'identifier' + rule in Section 12 of RFC 6020. An identifier must + start with an alphabetic character or an underscore + followed by an arbitrary sequence of alphabetic or + numeric characters, underscores, hyphens, or dots. + + A YANG identifier MUST NOT start with any possible + combination of the lowercase or uppercase character + sequence 'xml'."; + reference + "RFC 6020: YANG - A Data Modeling Language for the Network + Configuration Protocol (NETCONF)"; + } + + /*** collection of types related to date and time***/ + + typedef date-and-time { + type string { + pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?' + + '(Z|[\+\-]\d{2}:\d{2})'; + } + description + "The date-and-time type is a profile of the ISO 8601 + standard for representation of dates and times using the + Gregorian calendar. The profile is defined by the + date-time production in Section 5.6 of RFC 3339. + + The date-and-time type is compatible with the dateTime XML + schema type with the following notable exceptions: + + (a) The date-and-time type does not allow negative years. + + (b) The date-and-time time-offset -00:00 indicates an unknown + time zone (see RFC 3339) while -00:00 and +00:00 and Z + all represent the same time zone in dateTime. + + (c) The canonical format (see below) of data-and-time values + differs from the canonical format used by the dateTime XML + schema type, which requires all times to be in UTC using + the time-offset 'Z'. + + This type is not equivalent to the DateAndTime textual + convention of the SMIv2 since RFC 3339 uses a different + separator between full-date and full-time and provides + higher resolution of time-secfrac. + + The canonical format for date-and-time values with a known time + zone uses a numeric time zone offset that is calculated using + the device's configured known offset to UTC time. A change of + the device's offset to UTC time will cause date-and-time values + to change accordingly. Such changes might happen periodically + in case a server follows automatically daylight saving time + (DST) time zone offset changes. The canonical format for + date-and-time values with an unknown time zone (usually + referring to the notion of local time) uses the time-offset + -00:00."; + reference + "RFC 3339: Date and Time on the Internet: Timestamps + RFC 2579: Textual Conventions for SMIv2 + XSD-TYPES: XML Schema Part 2: Datatypes Second Edition"; + } + + typedef timeticks { + type uint32; + description + "The timeticks type represents a non-negative integer that + represents the time, modulo 2^32 (4294967296 decimal), in + hundredths of a second between two epochs. When a schema + node is defined that uses this type, the description of + the schema node identifies both of the reference epochs. + + In the value set and its semantics, this type is equivalent + to the TimeTicks type of the SMIv2."; + reference + "RFC 2578: Structure of Management Information Version 2 + (SMIv2)"; + } + + typedef timestamp { + type yang:timeticks; + description + "The timestamp type represents the value of an associated + timeticks schema node at which a specific occurrence + happened. The specific occurrence must be defined in the + description of any schema node defined using this type. When + the specific occurrence occurred prior to the last time the + associated timeticks attribute was zero, then the timestamp + value is zero. Note that this requires all timestamp values + to be reset to zero when the value of the associated timeticks + attribute reaches 497+ days and wraps around to zero. + + The associated timeticks schema node must be specified + in the description of any schema node using this type. + + In the value set and its semantics, this type is equivalent + to the TimeStamp textual convention of the SMIv2."; + reference + "RFC 2579: Textual Conventions for SMIv2"; + } + + /*** collection of generic address types ***/ + + typedef phys-address { + type string { + pattern '([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)?'; + } + + description + "Represents media- or physical-level addresses represented + as a sequence octets, each octet represented by two hexadecimal + numbers. Octets are separated by colons. The canonical + representation uses lowercase characters. + + In the value set and its semantics, this type is equivalent + to the PhysAddress textual convention of the SMIv2."; + reference + "RFC 2579: Textual Conventions for SMIv2"; + } + + typedef mac-address { + type string { + pattern '[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}'; + } + description + "The mac-address type represents an IEEE 802 MAC address. + The canonical representation uses lowercase characters. + + In the value set and its semantics, this type is equivalent + to the MacAddress textual convention of the SMIv2."; + reference + "IEEE 802: IEEE Standard for Local and Metropolitan Area + Networks: Overview and Architecture + RFC 2579: Textual Conventions for SMIv2"; + } + + /*** collection of XML-specific types ***/ + + typedef xpath1.0 { + type string; + description + "This type represents an XPATH 1.0 expression. + + When a schema node is defined that uses this type, the + description of the schema node MUST specify the XPath + context in which the XPath expression is evaluated."; + reference + "XPATH: XML Path Language (XPath) Version 1.0"; + } + + /*** collection of string types ***/ + + typedef hex-string { + type string { + pattern '([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)?'; + } + description + "A hexadecimal string with octets represented as hex digits + separated by colons. The canonical representation uses + lowercase characters."; + } + + typedef uuid { + type string { + pattern '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'; + } + description + "A Universally Unique IDentifier in the string representation + defined in RFC 4122. The canonical representation uses + lowercase characters. + + The following is an example of a UUID in string representation: + f81d4fae-7dec-11d0-a765-00a0c91e6bf6 + "; + reference + "RFC 4122: A Universally Unique IDentifier (UUID) URN + Namespace"; + } + + typedef dotted-quad { + type string { + pattern + '(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}' + + '([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])'; + } + description + "An unsigned 32-bit number expressed in the dotted-quad + notation, i.e., four octets written as decimal numbers + and separated with the '.' (full stop) character."; + } +} diff --git a/sch_yang_library.c b/sch_yang_library.c new file mode 100644 index 0000000..7ce497d --- /dev/null +++ b/sch_yang_library.c @@ -0,0 +1,359 @@ +/** + * @file sch_yang-library.c + * + * Copyright 2023, Allied Telesis Labs New Zealand, Ltd + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/* Container holding the entire YANG library of this server. */ +#define YANG_LIBRARY_PATH "/yang-library" +/* An arbitrary name of the module set. */ +#define YANG_LIBRARY_MODULE_SET_NAME "name" +/* An entry in this list represents a module implemented by the server, as per Section 5.6.5 of RFC 7950, with a particular set of supported features and deviations. */ +#define YANG_LIBRARY_MODULE_SET_MODULE_PATH "module" +/* The YANG module or submodule name. */ +#define YANG_LIBRARY_MODULE_SET_MODULE_NAME "name" +/* The YANG module or submodule revision date. If no revision statement is present in the YANG module or submodule, this leaf is not instantiated. */ +#define YANG_LIBRARY_MODULE_SET_MODULE_REVISION "revision" +/* List of all YANG feature names from this module that are supported by the server, regardless whether they are defined in the module or any included submodule. */ +#define YANG_LIBRARY_MODULE_SET_MODULE_FEATURE "feature" +/* List of all YANG deviation modules used by this server to modify the conformance of the module associated with this entry. Note that the same module can be used for deviations for multiple modules, so the same entry MAY appear within multiple 'module' entries. This reference MUST NOT (directly or indirectly) refer to the module being deviated. Robust clients may want to make sure that they handle a situation where a module deviates itself (directly or indirectly) gracefully. */ +#define YANG_LIBRARY_MODULE_SET_MODULE_DEVIATION "deviation" +/* The YANG module or submodule name. */ +#define MODULES_STATE_MODULE_NAME "name" +/* The YANG module or submodule revision date. A zero-length string is used if no revision statement is present in the YANG module or submodule. */ +#define MODULES_STATE_MODULE_REVISION "revision" +/* The XML namespace identifier for this module. */ +#define MODULES_STATE_MODULE_NAMESPACE "namespace" +/* An arbitrary name of the schema. */ +#define YANG_LIBRARY_SCHEMA_NAME "name" +/* A set of module-sets that are included in this schema. If a non-import-only module appears in multiple module sets, then the module revision and the associated features and deviations must be identical. */ +#define YANG_LIBRARY_SCHEMA_MODULE_SET "module-set" +/* The identity of the datastore. */ +#define YANG_LIBRARY_DATASTORE_NAME "name" +/* A reference to the schema supported by this datastore. All non-import-only modules of the schema are implemented with their associated features and deviations. */ +#define YANG_LIBRARY_DATASTORE_SCHEMA "schema" + + +/* Name for the set of modules */ +#define MODULES_STR "modules" +#define SCHEMA_STR "schema" +#define DATASTORE_STR "datastore" +#define COMMON_STR "common" + +/* + * A wrapper for APTERYX_LEAF. + * @param root - The node the leaf will be added to + * @param node_name - Name of the new node + * @param value - Value to set the node to, or NULL to delete the leaf + */ +static GNode * +add_leaf (GNode *root, char *node_name, char *value) +{ + GNode *child_node = NULL; + + assert (root); + + if (value == NULL) + { + value = g_strdup (""); + } + + child_node = APTERYX_LEAF (root, (gpointer) node_name, (gpointer) value); + + return child_node; +} + +/** + * Add a leaf to a node + * + * @param root - The node the leaf will be added to + * @param node_name - Name of the new node + * @param value - Value to set the node to, or NULL to delete the leaf + * + * @return a pointer to the leaf, or NULL for failure + */ +static GNode * +add_leaf_strdup (GNode *root, const char *node_name, const char *value) +{ + if (root && node_name) + { + return add_leaf (root, g_strdup (node_name), g_strdup (value)); + } + + return NULL; +} + +/** + * Set the state of yang-library-control. This is a state machine used to + * coordinate multiple sources updating yang-library + * + * @param state - the state to set + */ +void +yang_library_control_set_state (int state) +{ + char *state_str = NULL; + + switch (state) + { + case YANG_LIBRARY_S_CREATED: + state_str = "created"; + break; + case YANG_LIBRARY_S_LOADING: + state_str = "loading"; + break; + case YANG_LIBRARY_S_READY: + state_str = "ready"; + break; + default: + return; + } + apteryx_set (YANG_LIBRARY_CONTROL_STATE, state_str); +} + +/** + * Get the current state of yang-library-control + * + * @return volatile int the current state YANG_LIBRARY_S_xxx + */ +volatile int +yang_library_control_get_state (void) +{ + char *state_str = apteryx_get_string (YANG_LIBRARY_CONTROL_STATE, NULL); + int state = YANG_LIBRARY_S_NONE; + + if (!state_str) + state = YANG_LIBRARY_S_NONE; + else if (g_strcmp0 (state_str, "created") == 0) + state = YANG_LIBRARY_S_CREATED; + else if (g_strcmp0 (state_str, "loading") == 0) + state = YANG_LIBRARY_S_LOADING; + else if (g_strcmp0 (state_str, "ready") == 0) + state = YANG_LIBRARY_S_READY; + + g_free (state_str); + return state; +} + +/** + * Remove an entry from the apteryx database for the specified model + * + * @param loaded - Structure with the relevant model information + */ +void +yang_library_remove_model_information (sch_loaded_model *loaded) +{ + char *path = g_strdup_printf ("%s/%s", YANG_LIBRARY_MOD_SET_COMMON_MOD, loaded->model); + apteryx_prune (path); + g_free (path); +} + +/** + * Update the features leaf-list using the updated models features + * + * @param loaded A control structure for a loaded model + */ +void +yang_library_update_feature_information (sch_loaded_model *loaded) +{ + GNode *root; + GNode *modules; + GNode *gnode; + + char *path = g_strdup_printf ("%s/%s/feature", YANG_LIBRARY_MOD_SET_COMMON_MOD, loaded->model); + apteryx_prune (path); + g_free (path); + + root = APTERYX_NODE (NULL, g_strdup (YANG_LIBRARY_PATH)); + modules = add_leaf_strdup (root, YANG_LIBRARY_SCHEMA_MODULE_SET, COMMON_STR); + add_leaf_strdup (modules, YANG_LIBRARY_MODULE_SET_NAME, COMMON_STR); + gnode = add_leaf_strdup (modules, YANG_LIBRARY_MODULE_SET_MODULE_PATH, + loaded->model); + if (loaded->features) + { + gchar **split; + int count; + int i; + + split = g_strsplit (loaded->features, ",", 0); + count = g_strv_length (split); + for (i = 0; i < count; i++) + { + char *feature_path; + feature_path = g_strdup_printf ("%s/%s", + YANG_LIBRARY_MODULE_SET_MODULE_FEATURE, + split[i]); + add_leaf_strdup (gnode, feature_path, split[i]); + g_free (feature_path); + } + g_strfreev (split); + } + + apteryx_set_tree (root); + apteryx_free_tree (root); +} + +/** + * Add an entry to the apteryx database for the specified model + * + * @param loaded - Structure with the relevant model information + */ +void +yang_library_add_model_information (sch_loaded_model *loaded) +{ + GNode *root; + GNode *modules; + GNode *gnode; + + root = APTERYX_NODE (NULL, g_strdup (YANG_LIBRARY_PATH)); + modules = add_leaf_strdup (root, YANG_LIBRARY_SCHEMA_MODULE_SET, COMMON_STR); + add_leaf_strdup (modules, YANG_LIBRARY_MODULE_SET_NAME, COMMON_STR); + if (loaded->model && loaded->model[0] != '\0') + { + gnode = add_leaf_strdup (modules, YANG_LIBRARY_MODULE_SET_MODULE_PATH, + loaded->model); + + add_leaf_strdup (gnode, MODULES_STATE_MODULE_NAME, loaded->model); + if (loaded->version) + { + add_leaf_strdup (gnode, MODULES_STATE_MODULE_REVISION, + loaded->version); + } + if (loaded->ns_href) + { + add_leaf_strdup (gnode, MODULES_STATE_MODULE_NAMESPACE, loaded->ns_href); + } + if (loaded->features) + { + gchar **split; + int count; + int i; + + split = g_strsplit (loaded->features, ",", 0); + count = g_strv_length (split); + for (i = 0; i < count; i++) + { + char *feature_path; + feature_path = g_strdup_printf ("%s/%s", + YANG_LIBRARY_MODULE_SET_MODULE_FEATURE, + split[i]); + add_leaf_strdup (gnode, feature_path, split[i]); + g_free (feature_path); + } + g_strfreev (split); + } + if (loaded->deviations) + { + gchar **split; + int count; + int i; + + split = g_strsplit (loaded->deviations, ",", 0); + count = g_strv_length (split); + for (i = 0; i < count; i++) + { + char *deviation_path; + deviation_path = g_strdup_printf ("%s/%s", + YANG_LIBRARY_MODULE_SET_MODULE_DEVIATION, + split[i]); + add_leaf_strdup (gnode, deviation_path, split[i]); + g_free (deviation_path); + } + g_strfreev (split); + } + } + + apteryx_set_tree (root); + apteryx_free_tree (root); +} + +/** + * Update the yang-library content-id tag. This changes when any of the models in the schema + * change + * + * @return true - when its done + */ +bool +yang_library_update_content_id (void) +{ + time_t now = time (NULL); + uint64_t now_64 = (uint64_t) now; + char set_id[24]; + + snprintf (set_id, sizeof (set_id), "%" PRIx64 "", now_64); + while (1) + { + uint64_t ts = apteryx_timestamp (YANG_LIBRARY_CONTENT_ID); + bool success = apteryx_cas_wait (YANG_LIBRARY_CONTENT_ID, set_id, ts); + if (success || errno != -EBUSY) + { + // If success is true here, watches have completed + return success; + } + } +} + +/** + * Given a schema create the Apteryx data for the ietf-yang-library model required + * by restconf. + * + * @param g_schema - The root schema xml node + */ +void +yang_library_create (sch_instance *schema) +{ + GNode *root; + GNode *modules; + GNode *datastore; + GNode *tmp; + GNode *sch_tmp; + + root = APTERYX_NODE (NULL, g_strdup (YANG_LIBRARY_PATH)); + modules = add_leaf_strdup (root, YANG_LIBRARY_SCHEMA_MODULE_SET, COMMON_STR); + add_leaf_strdup (modules, YANG_LIBRARY_MODULE_SET_NAME, COMMON_STR); + // schema_set_model_information (schema, modules); + + tmp = add_leaf_strdup (root, SCHEMA_STR, SCHEMA_STR); + add_leaf_strdup (tmp, YANG_LIBRARY_SCHEMA_NAME, COMMON_STR); + sch_tmp = add_leaf_strdup (tmp, YANG_LIBRARY_SCHEMA_MODULE_SET, COMMON_STR); + add_leaf_strdup (sch_tmp, COMMON_STR, COMMON_STR); + + + datastore = add_leaf_strdup (root, DATASTORE_STR, DATASTORE_STR); + add_leaf_strdup (datastore, YANG_LIBRARY_DATASTORE_NAME, "ietf-datastores:running"); + add_leaf_strdup (datastore, YANG_LIBRARY_DATASTORE_SCHEMA, COMMON_STR); + + apteryx_set_tree (root); + apteryx_free_tree (root); + + yang_library_control_set_state (YANG_LIBRARY_S_CREATED); + + yang_library_update_content_id (); +} diff --git a/schema.c b/schema.c index f0726e7..9a65262 100644 --- a/schema.c +++ b/schema.c @@ -448,6 +448,7 @@ add_module_info_to_children (xmlNode *node, xmlNsPtr ns, xmlChar *mod, xmlChar * xmlChar *ver, xmlChar *feat, xmlChar *devi) { xmlNode *n = node; + xmlNode *s = node; while (n) { if (n->ns && g_strcmp0 ((char *)n->ns->href, (char *)ns->href) == 0) @@ -459,6 +460,22 @@ add_module_info_to_children (xmlNode *node, xmlNsPtr ns, xmlChar *mod, xmlChar * xmlNewProp (n, (const xmlChar *)"version", ver); xmlNewProp (n, (const xmlChar *)"features", feat); xmlNewProp (n, (const xmlChar *)"deviations", devi); + s = sch_node_next_sibling ((sch_node *) n); + while (s) + { + if (s->ns && g_strcmp0 ((char *)s->ns->href, (char *)ns->href) == 0) + { + if (!xmlHasProp (s, (const xmlChar *)"model")) + { + xmlNewProp (s, (const xmlChar *)"model", mod); + xmlNewProp (s, (const xmlChar *)"organization", org); + xmlNewProp (s, (const xmlChar *)"version", ver); + xmlNewProp (s, (const xmlChar *)"features", feat); + xmlNewProp (s, (const xmlChar *)"deviations", devi); + } + } + s = sch_node_next_sibling ((sch_node *) s); + } } } else @@ -495,10 +512,11 @@ add_module_info_to_child (sch_instance *instance, xmlNode *module) } static bool -save_module_info (sch_instance *instance, xmlNode *module) +save_module_info (sch_instance *instance, xmlNode *module, char *filename) { sch_loaded_model *loaded; bool add = true; + int ret = false; xmlChar *mod = xmlGetProp (module, (xmlChar *) "model"); xmlChar *org = xmlGetProp (module, (xmlChar *) "organization"); xmlChar *ver = xmlGetProp (module, (xmlChar *) "version"); @@ -507,21 +525,9 @@ save_module_info (sch_instance *instance, xmlNode *module) if (instance->model_hash_table) { - if (!mod || strlen ((char *) mod ) == 0 || - !g_hash_table_lookup (instance->model_hash_table, (const char *) mod)) - { - if (mod) - xmlFree (mod); - if (org) - xmlFree (org); - if (ver) - xmlFree (ver); - if (feat) - xmlFree (feat); - if (devi) - xmlFree (devi); - return false; - } + if ((!mod || strlen ((char *) mod ) == 0) || + !g_hash_table_lookup (instance->model_hash_table, (const char *) mod)) + goto exit; } if (mod) @@ -534,11 +540,18 @@ save_module_info (sch_instance *instance, xmlNode *module) if (g_strcmp0 ((char *) mod, loaded->model) == 0) { /* We have a duplicate model */ + if (!loaded->loaded) + { + loaded->loaded = true; + ret = true; + } add = false; + break; } } } + ret = true; if (add) { loaded = g_malloc0 (sizeof (sch_loaded_model)); @@ -589,10 +602,13 @@ save_module_info (sch_instance *instance, xmlNode *module) { loaded->deviations = g_strdup ((char *) devi); } + loaded->filename = g_strdup (filename); + loaded->loaded = true; instance->models_list = (void *) g_list_append (instance->models_list, loaded); } } +exit: if (mod) xmlFree (mod); if (org) @@ -604,7 +620,7 @@ save_module_info (sch_instance *instance, xmlNode *module) if (devi) xmlFree (devi); - return true; + return ret; } static void @@ -700,18 +716,16 @@ sch_load_namespace_mappings (sch_instance *instance, const char *filename) } static void -sch_load_model_list (sch_instance *instance, const char *path, const char *model_list_filename) +sch_load_model_list (sch_instance *instance, const char *model_list_filename) { FILE *fp = NULL; - char *name; char *buf; if (!instance) return; buf = g_malloc0 (READ_BUF_SIZE); - name = g_strdup_printf ("%s/%s", path, model_list_filename); - fp = fopen (name, "r"); + fp = fopen (model_list_filename, "r"); if (fp && buf) { if (!instance->model_hash_table) @@ -746,7 +760,6 @@ sch_load_model_list (sch_instance *instance, const char *path, const char *model } fclose (fp); } - g_free (name); g_free (buf); } @@ -760,6 +773,43 @@ sch_load_item_free (void *data) g_free (item); } +static void +sch_load_model (sch_instance *instance, xmlNode *module, sch_load_item *item) +{ + char *filename; + char *ext; + + filename = item->filename; + ext = strrchr(filename, '.'); + if (g_strcmp0 (ext, ".map") == 0) + { + sch_load_namespace_mappings (instance, filename); + return; + } + xmlNode *module_new = xmlDocGetRootElement (item->doc_new); + cleanup_nodes (module_new); + /* Sanity check for empty modules */ + if (!module_new || (module_new->children && (module_new->children->name[0] != 'N' && module_new->children->name[0] != 'S'))) + { + syslog (LOG_ERR, "XML: ignoring empty schema \"%s\"", filename); + return; + } + copy_nsdef_to_root (instance->doc, module_new); + if (save_module_info (instance, module_new, filename)) + { + add_module_info_to_child (instance, module_new); + merge_nodes (module_new->ns, module, module->children, module_new->children, 0); + xmlFreeDoc (item->doc_new); + item->doc_new = NULL; + assign_ns_to_root (instance->doc, module->children); + } + else + { + xmlFreeDoc (item->doc_new); + item->doc_new = NULL; + } +} + /* Parse all XML files in the search path and merge trees */ static sch_instance * _sch_load (const char *path, const char *model_list_filename) @@ -784,46 +834,12 @@ _sch_load (const char *path, const char *model_list_filename) xmlDocSetRootElement (instance->doc, module); if (model_list_filename) - sch_load_model_list (instance, path, model_list_filename); + sch_load_model_list (instance, model_list_filename); load_schema_files (&files, path); for (iter = files; iter; iter = g_list_next (iter)) { - sch_load_item *item; - char *filename; - char *ext; - - item = iter->data; - filename = item->filename; - ext = strrchr(filename, '.'); - if (g_strcmp0 (ext, ".map") == 0) - { - sch_load_namespace_mappings (instance, filename); - continue; - } - - xmlNode *module_new = xmlDocGetRootElement (item->doc_new); - cleanup_nodes (module_new); - /* Sanity check for empty modules */ - if (!module_new || (module_new->children && (module_new->children->name[0] != 'N' && module_new->children->name[0] != 'S'))) - { - syslog (LOG_ERR, "XML: ignoring empty schema \"%s\"", filename); - continue; - } - copy_nsdef_to_root (instance->doc, module_new); - if (save_module_info (instance, module_new)) - { - add_module_info_to_child (instance, module_new); - merge_nodes (module_new->ns, module, module->children, module_new->children, 0); - xmlFreeDoc (item->doc_new); - item->doc_new = NULL; - assign_ns_to_root (instance->doc, module->children); - } - else - { - xmlFreeDoc (item->doc_new); - item->doc_new = NULL; - } + sch_load_model (instance, module, (sch_load_item *) iter->data); } g_list_free_full (files, sch_load_item_free); @@ -846,7 +862,80 @@ sch_load (const char *path) sch_instance * sch_load_with_model_list_filename (const char *path, const char *model_list_filename) { - return _sch_load (path, model_list_filename); + char *mlf = g_strdup_printf ("%s/%s", path, model_list_filename); + sch_instance *instance = _sch_load (path, mlf); + g_free (mlf); + return instance; +} + +static void +sch_get_models_in_library (GNode *tree, char *load_filename) +{ + FILE *fp; + GNode *child = NULL; + + fp = fopen (load_filename, "w"); + for (child = tree->children; child; child = child->next) + fprintf (fp, "%s\n", (char *) child->data); + + fclose (fp); +} + +/** + * Only load XML models that are specified in the model list file. If the model list + * filename is NULL, all models are loaded. + */ +sch_instance * +sch_load_model_list_yang_library (const char *path) +{ + sch_instance *instance = NULL; + GNode *query; + GNode *tree; + int state = yang_library_control_get_state (); + + if (state == YANG_LIBRARY_S_READY) + { + query = APTERYX_NODE (NULL, g_strdup_printf ("%s/*/name", YANG_LIBRARY_MOD_SET_COMMON_MOD)); + tree = apteryx_query (query); + apteryx_free_tree (query); + + if (tree) + { + char *load_filename = NULL; + + /* If an existing set of models exist, use those to load the instance */ + load_filename = "/tmp/xml_load_files"; + sch_get_models_in_library (tree, load_filename); + instance = _sch_load (path, load_filename); + apteryx_free_tree (tree); + return instance; + } + } + + /* Load the appropriate models and populate the yang library */ + instance = _sch_load (path, NULL); + if (instance) + { + state = yang_library_control_get_state (); + if (state == YANG_LIBRARY_S_NONE) + { + sch_loaded_model *loaded; + GList *list; + GList *loaded_models; + + yang_library_create (instance); + loaded_models = sch_get_loaded_models (instance); + yang_library_control_set_state (YANG_LIBRARY_S_LOADING); + for (list = g_list_first (loaded_models); list; list = g_list_next (list)) + { + loaded = list->data; + yang_library_add_model_information (loaded); + } + yang_library_control_set_state (YANG_LIBRARY_S_READY); + } + } + + return instance; } static void @@ -860,34 +949,14 @@ sch_free_loaded_models (GList *loaded_models) for (list = g_list_first (loaded_models); list; list = g_list_next (list)) { loaded = list->data; - if (loaded->ns_href) - { - g_free (loaded->ns_href); - } - if (loaded->model) - { - g_free (loaded->model); - } - if (loaded->organization) - { - g_free (loaded->organization); - } - if (loaded->ns_prefix) - { - g_free (loaded->ns_prefix); - } - if (loaded->version) - { - g_free (loaded->version); - } - if (loaded->features) - { - g_free (loaded->features); - } - if (loaded->deviations) - { - g_free (loaded->deviations); - } + g_free (loaded->ns_href); + g_free (loaded->model); + g_free (loaded->organization); + g_free (loaded->ns_prefix); + g_free (loaded->version); + g_free (loaded->features); + g_free (loaded->deviations); + g_free (loaded->filename); g_free (loaded); } g_list_free (loaded_models);