YANG data modeling language library
C Other
Permalink
Failed to load latest commit information.
CMakeModules add swig javascript bindings Feb 29, 2016
doc abi DOC remove auxiliary files after building abi reports Feb 8, 2016
linenoise linenoise BUGFIX completion hint matching item and substring of an item Feb 5, 2016
models context CHANGE use smaller built-in modules to save some memory Sep 16, 2016
src resolve BUGFIX traversing nodes when resolving when Feb 6, 2017
swig/javascript javascript bindings UPDATE package, cmake file and example Nov 8, 2016
tests yang file BUGFIX apply eratta of RFC 6728 Jan 20, 2017
tools yanglint BUGFIX correct additional parameter for lyd_validate Feb 1, 2017
.gitignore GIT: add .gitignore to ignore the generated doc/ directory Aug 13, 2015
.travis.yml build BUGFIX fix OS X build Oct 31, 2016
CMakeLists.txt VERSION bump to version 0.11.109 Feb 6, 2017
CODINGSTYLE coding style: CHANGE: update Coding style document Jun 16, 2015
Doxyfile.in libyang DOC removed "/*" from doxygen comment for compiler not to whine Apr 19, 2016
FAQ.md doc CHANGE make FAQ answer/instructions more clear Nov 25, 2016
FindLibYANG.cmake build FEATURE include cmake find module that can be used in other pro… Feb 17, 2016
KNOWNISSUES.md doc CHANGE add note about extensions into KNOWNISSUES Jul 29, 2016
LICENSE MAINTENANCE correct license text in source codes Feb 24, 2016
README.md doc CHANGE update info about yanglint Nov 6, 2016
codecov.yml build CHANGE ignore tools subdir when generating data for codecov Sep 30, 2016
libyang.pc.in Use GNUInstallDirs for destination guessing Nov 4, 2016

README.md

libyang

BSD license Build Status codecov.io Coverity Scan Build Status Ohloh Project Status

libyang is YANG data modelling language parser and toolkit written (and providing API) in C. The library is used e.g. in libnetconf2, Netopeer2 or sysrepo projects.

Provided Features

  • Parsing (and validating) schemas in YANG format.
  • Parsing (and validating) schemas in YIN format.
  • Parsing, validating and printing instance data in XML format.
  • Parsing, validating and printing instance data in JSON format (RFC 7951).
  • Manipulation with the instance data.
  • Support for default values in the instance data (RFC 6243).
  • yanglint - features rich YANG tool.

Current implementation covers YANG 1.0 (RFC 6020) as well as YANG 1.1 (RFC 7950).

Planned Features

  • YANG Metadata (RFC 7952).
  • Modular mechanism for supporting YANG extensions.

Requirements

  • cmake >= 2.8.9
  • libpcre
  • cmocka >= 1.0.0 (for tests only, see Tests)

Building

$ mkdir build; cd build
$ cmake ..
$ make 
# make install

Documentation

The library documentation can be generated directly from the source codes using Doxygen tool:

$ make doc
$ google-chrome ../doc/html/index.html

The documentation is also built hourly and available at netopeer.liberouter.org.

Useful CMake Options

Changing Compiler

Set CC variable:

$ CC=/usr/bin/clang cmake ..

Changing Install Path

To change the prefix where the library, headers and any other files are installed, set CMAKE_INSTALL_PREFIX variable:

$ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr ..

Default prefix is /usr/local.

Build Modes

There are two build modes:

  • Release. This generates library for the production use without any debug information.
  • Debug. This generates library with the debug information and disables optimization of the code.

The Debug mode is currently used as the default one. to switch to the Release mode, enter at the command line:

$ cmake -D CMAKE_BUILD_TYPE:String="Release" ..

CMake Notes

Note that, with CMake, if you want to change the compiler or its options after you already ran CMake, you need to clear its cache first - the most simple way to do it is to remove all content from the 'build' directory.

Usage

All libyang functions are available via the main header:

#include <libyang/libyang.h>

To compile your program with libyang, it is necessary to link it with libyang using the following linker parameters:

-lyang

Note, that it may be necessary to call ldconfig(8) after library installation and if the library was installed into a non-standard path, the path to libyang must be specified to the linker. To help with setting all the compiler's options, there is libyang.pc file for pkg-config(1) available in the source tree. The file is installed with the library.

If you are using cmake in you project, it is also possible to use the provided FindLibYANG.cmake file to detect presence of the libyang library in the system.

yanglint

libyang project includes features rich tool called yanglint(1) for validation and conversion of the schemas and YANG modeled data. The source codes are located at /tools/lint and can be used to explore how an application is supposed to use the libyang library. yanglint(1) binary as well as its man page are installed together with the library itself.

There is also README describing some examples of using yanglint.

Tests

libyang includes several tests built with cmocka. The tests can be found in tests subdirectory and they are designed for checking library functionality after code changes.

The tests are by default built in the Debug build mode by running

$ make

In case of the Release mode, the tests are not built by default (it requires additional dependency), but they can be enabled via cmake option:

$ cmake -DENABLE_BUILD_TESTS=ON ..

Note that if the necessary cmocka headers are not present in the system include paths, tests are not available despite the build mode or cmake's options.

Tests can be run by the make's test target:

$ make test

Bindings

We provide bindings for high-level languages using SWIG generator. The bindings are optional and to enable building of the specific binding, the appropriate cmake option must be enabled, for example:

$ cmake -DJAVASCRIPT_BINDING=ON ..

More information about the specific binding can be found in their README files.

Currently supported bindings are:

  • JavaScript
    • cmake option: JAVASCRIPT_BINDING
    • README