Merge branch 'devel'

Author: rkrejci

CMakeLists.txt

@@ -7,12 +7,19 @@ set(LIBYANG_DESCRIPTION "libyang is YANG data modelling language parser and tool
 
 # set version
 set(LIBYANG_MAJOR_VERSION 0)
-set(LIBYANG_MINOR_VERSION 11)
-set(LIBYANG_MICRO_VERSION 112)
+set(LIBYANG_MINOR_VERSION 12)
+set(LIBYANG_MICRO_VERSION 113)
 set(LIBYANG_VERSION ${LIBYANG_MAJOR_VERSION}.${LIBYANG_MINOR_VERSION}.${LIBYANG_MICRO_VERSION})
 set(LIBYANG_SOVERSION ${LIBYANG_MAJOR_VERSION}.${LIBYANG_MINOR_VERSION})
 configure_file(${PROJECT_SOURCE_DIR}/src/libyang.h.in ${PROJECT_SOURCE_DIR}/src/libyang.h)
 
+if(PLUGINS_DIR)
+	set(LIBYANG_EXT_PLUGINS_DIR ${PLUGINS_DIR})
+else()
+	set(LIBYANG_EXT_PLUGINS_DIR ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/libyang)
+endif()
+configure_file(${PROJECT_SOURCE_DIR}/src/extensions_config.h.in ${PROJECT_SOURCE_DIR}/src/extensions_config.h)
+
 # include custom Modules
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/CMakeModules/")
 
@@ -33,9 +40,9 @@ else()
 	configure_file(${PROJECT_SOURCE_DIR}/src/yang.y.in ${PROJECT_SOURCE_DIR}/src/yang.y)
 	add_custom_target(bison
 		WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/src
-		COMMAND bison -Wno-other -l -o parser_yang_bis.c --defines=parser_yang_bis.h yang.y
+		COMMAND bison -l -o parser_yang_bis.c --defines=parser_yang_bis.h yang.y
 		COMMAND flex -8 -L -o parser_yang_lex.c --header-file=parser_yang_lex.h yang.l
-		COMMAND ${SED_TOOL} -i 's/int yychar\;/int yychar\;\\nchar *s = NULL, *tmp_s = NULL\;\\nstruct lys_include inc\;\\nstruct lys_module *trg = NULL\;\\nstruct lys_node *tpdf_parent = NULL, *data_node = NULL\;\\nvoid *actual = NULL\;\\nstruct lys_node_uses *refine_parent = NULL\;\\nint config_inherit = 0, actual_type = 0\;\\nint64_t cnt_val\;\\nint read_string = read_all\;\\nvoid *yang_type = NULL\;/' parser_yang_bis.c
+		COMMAND ${SED_TOOL} -i 's/int yychar\;/int yychar\;\\nchar *s = NULL, *tmp_s = NULL, *ext_name = NULL\;\\nstruct lys_module *trg = NULL\;\\nstruct lys_node *tpdf_parent = NULL, *data_node = NULL\;\\nstruct lys_ext_instance_complex *ext_instance = NULL\;\\nint is_ext_instance\;\\nvoid *actual = NULL\;\\nenum yytokentype backup_type, actual_type = MODULE_KEYWORD\;\\nint64_t cnt_val = 0\;\\nint is_value = 0\;\\nvoid *yang_type = NULL\;/' parser_yang_bis.c
 	)
 endif()
 
@@ -49,7 +56,7 @@ if(NOT CMAKE_BUILD_TYPE)
 	set(CMAKE_BUILD_TYPE debug)
 endif()
 
-set(CMAKE_C_FLAGS         "${CMAKE_C_FLAGS} -Wall -Wextra -fvisibility=hidden")
+set(CMAKE_C_FLAGS         "${CMAKE_C_FLAGS} -Wall -Wextra")
 set(CMAKE_C_FLAGS_RELEASE "-O2 -DNDEBUG")
 set(CMAKE_C_FLAGS_DEBUG   "-g -O0")
 
@@ -78,6 +85,7 @@ set(libsrc
 	src/parser_yang.c
 	src/tree_schema.c
 	src/tree_data.c
+	src/extensions.c
 	src/printer.c
 	src/xpath.c
 	src/printer_yang.c
@@ -102,14 +110,17 @@ set(headers
 	src/libyang.h
 	src/tree_schema.h
 	src/tree_data.h
+	src/extensions.h
 	src/xml.h
 	src/dict.h)
 
 # create static libyang library
 if(STATIC)
     add_library(yang_static STATIC ${libsrc})
     set_target_properties(yang_static PROPERTIES OUTPUT_NAME yang)
+    set_target_properties(yang_static PROPERTIES COMPILE_FLAGS "-fvisibility=hidden")
     target_link_libraries(yang_static m)
+    target_link_libraries(yang_static ${CMAKE_DL_LIBS})
     target_link_libraries(yang_static ${CMAKE_THREAD_LIBS_INIT})
     target_link_libraries(yang_static ${PCRE_LIBRARIES})
     install(TARGETS yang_static DESTINATION ${CMAKE_INSTALL_LIBDIR})
@@ -119,10 +130,14 @@ set(CMAKE_POSITION_INDEPENDENT_CODE TRUE)
 add_library(yangobj OBJECT ${libsrc})
 add_library(yang SHARED $<TARGET_OBJECTS:yangobj>)
 set_target_properties(yang PROPERTIES VERSION ${LIBYANG_VERSION} SOVERSION ${LIBYANG_SOVERSION})
+set_target_properties(yang PROPERTIES COMPILE_FLAGS "-fvisibility=hidden")
 
 # link math
 target_link_libraries(yang m)
 
+#link dl
+target_link_libraries(yang ${CMAKE_DL_LIBS})
+
 # find pthreads
 set(CMAKE_THREAD_PREFER_PTHREAD TRUE)
 find_package(Threads REQUIRED)
@@ -169,11 +184,16 @@ add_custom_target(cclean
 		COMMAND rm -rf Makefile Doxyfile
 		WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
 
+# YANG extensions plugins
+add_subdirectory(src/extensions)
+
+# yanglint
 add_executable(yanglint ${lintsrc})
 target_link_libraries(yanglint yang)
 install(TARGETS yanglint DESTINATION ${CMAKE_INSTALL_BINDIR})
 install(FILES ${PROJECT_SOURCE_DIR}/tools/lint/yanglint.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
 
+# yang2yin
 add_executable(yang2yin ${yang2yinsrc})
 
 if(ENABLE_VALGRIND_TESTS)

Doxyfile.in

@@ -756,6 +756,7 @@ WARN_LOGFILE           =
 INPUT                  = ./src/libyang.h \
                          ./src/tree_data.h \
                          ./src/tree_schema.h \
+                         ./src/extensions.h \
                          ./src/xml.h \
                          ./src/dict.h
 

FAQ.md

@@ -21,4 +21,23 @@ $ make
    or add the libyang's location to the linker paths in `/etc/ld.so.conf.d` and
    then run `ldconfig` to rebuild the linker cache.
 
+__Q: yanglint(1) does not start and, but prints the following error messages:__
+```
+./yanglint
+libyang[0]: Invalid keyword "type" as a child to "annotation". (path: /)
+libyang[0]: Module "yang" parsing failed.
+Failed to create context.
+```
+
+__A:__ To handle complex YANG extensions, libyang (and therefore yanglint(1))
+   needs plugins. By default, the plugins are installed into the system path
+   (next to the libyang library into the separate `libyang` subdirectory). If
+   libyang was not installed, yanglint cannot find these plugins and it fails.
+   If you do not want to install libyang, it is possible to specify path to the
+   plugins via environment variable. The plugins can be found in the libyang
+   build directory in `src/extensions/` subdirectory. So running yanglint(1)
+   then can be made this way:
+```
+$ LIBYANG_EXTENSIONS_PLUGINS_DIR=`pwd`/src/extensions ./yanglint
+```
 

KNOWNISSUES.md

@@ -1,23 +1,18 @@
 # Known Issues
 
-## YANG statements
-
-### Extensions
-
-libyang is not able to parse generic extensions defined in YANG schema. The currently supported
-extensions are only
- * get-filter-element-attributes from ietf-netconf,
- * default-deny-write from ietf-netconf-acm,
- * default-deny-all from ietf-netconf-acm.
-
-All other extension definitions/instances are currently ignored and only warning
-`Not supported "<name>" extension statement found, ignoring.` is printed.
-
 ## XPath Expressions
 
 ### Axes
 
 libyang uses its own XPath implementation to evaluate XPath expressions. The implementation
 completely lacks support for [axes](https://www.w3.org/TR/1999/REC-xpath-19991116/#axes).
-nevertheless, it should always be possible to write equivalent expressions without
+Nevertheless, it should always be possible to write equivalent expressions without
 the use of axes.
+
+### Deviation Must
+
+If there are any XPath expressions defined as part of a deviation, they include literals,
+which are directly compared with identityref nodes (testing whether an identityref has a
+specific identity value), and the identity literal used is from the deviation module
+(meaning it could be written without a prefix), the prefix is mandatory for libyang
+to evaluate the XPath expression correctly.

README.md

@@ -19,6 +19,8 @@ providing API) in C. The library is used e.g. in [libnetconf2](https://github.co
   ([RFC 7951](https://tools.ietf.org/html/rfc7951)).
 * Manipulation with the instance data.
 * Support for default values in the instance data ([RFC 6243](https://tools.ietf.org/html/rfc6243)).
+* Support for YANG extensions.
+* Support for YANG Metadata ([RFC 7952](https://tools.ietf.org/html/rfc6243)).
 * [yanglint](#yanglint) - features rich YANG tool.
 
 Current implementation covers YANG 1.0 ([RFC 6020](https://tools.ietf.org/html/rfc6020))
@@ -53,7 +55,8 @@ $ make doc
 $ google-chrome ../doc/html/index.html
 ```
 
-The documentation is also built hourly and available at [netopeer.liberouter.org](https://netopeer.liberouter.org/doc/libyang/master/).
+The documentation is also built hourly and available at
+[netopeer.liberouter.org](https://netopeer.liberouter.org/doc/libyang/master/).
 
 ### Useful CMake Options
 
@@ -89,6 +92,23 @@ The `Debug` mode is currently used as the default one. to switch to the
 ```
 $ cmake -D CMAKE_BUILD_TYPE:String="Release" ..
 ```
+
+#### Changing Extensions Plugins Directory
+
+For the YANG extensions, libyang loads the extension plugins. By default, the
+directory to store the plugins is LIBDIR/libyang. To change it, use the following
+cmake option with the value specifying the desired directory:
+
+```
+$ cmake -DPLUGINS_DIR:PATH=`pwd`"/src/extensions/" ..
+```
+
+The directory path can be also changed runtime via environment variable, e.g.:
+
+```
+$ LIBYANG_EXTENSIONS_PLUGINS_DIR=`pwd`/my/relative/path yanglint
+```
+
 ### CMake Notes
 
 Note that, with CMake, if you want to change the compiler or its options after
@@ -127,6 +147,22 @@ well as its man page are installed together with the library itself.
 There is also [README](./tools/lint/examples/README.md) describing some examples of
 using `yanglint`.
 
+libyang supports YANG extensions via a plugin mechanism. Some of the plugins (for
+NACM or Metadata) are available out of the box and installed together with libyang.
+However, when libyang is not installed and `yanglint(1)` is used from the build
+directory, the plugins are not available. There are two options:
+
+1. Install libyang.
+```
+# make install
+```
+
+2. Set environment variable `LIBYANG_EXTENSIONS_PLUGINS_DIR` to contain path to the
+   built extensions plugin (`./src/extensions` from the build directory).
+```
+$ LIBYANG_EXTENSIONS_PLUGINS_DIR="`pwd`/src/extensions" ./yanglint
+```
+
 ## Tests
 
 libyang includes several tests built with [cmocka](https://cmocka.org/). The tests