pax_global_header00006660000000000000000000000064151572477740014535gustar00rootroot0000000000000052 comment=2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/000077500000000000000000000000001515724777400205415ustar00rootroot00000000000000sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/.editorconfig000066400000000000000000000003531515724777400232170ustar00rootroot00000000000000# ex: ft=dosini root = true [*] end_of_line = lf insert_final_newline = true charset = utf-8 indent_style = space indent_size = 4 [*.yml] indent_size = 2 [packages/debian.rules.in] indent_style = tabs indent_size = 1 tab_width = 8 sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/.github/000077500000000000000000000000001515724777400221015ustar00rootroot00000000000000sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/.github/workflows/000077500000000000000000000000001515724777400241365ustar00rootroot00000000000000sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/.github/workflows/ci.yml000066400000000000000000000326161515724777400252640ustar00rootroot00000000000000name: sysrepo CI on: push: branches: - master - devel pull_request: branches: - master - devel jobs: git-branch: name: Get git branch runs-on: ubuntu-latest outputs: branch-name: ${{ steps.get-git-branch.outputs.branch-name }} steps: - id: get-git-branch run: | if ${{ github.event_name == 'push' }} then export GIT_BRANCH=`echo ${{ github.ref }} | cut -d'/' -f 3` else export GIT_BRANCH=${{ github.base_ref }} fi echo "branch-name=$GIT_BRANCH" >> $GITHUB_OUTPUT build: name: ${{ matrix.config.name }} runs-on: ${{ matrix.config.os }} # mac-OS does not implement robust mutexes so it is not supported needs: git-branch strategy: fail-fast: false matrix: config: - { name: "Release, gcc", os: "ubuntu-latest", build-type: "Release", dep-build-type: "Release", cc: "gcc", options: "-DENABLE_TESTS=ON", packages: "libcmocka-dev", snaps: "", make-target: "" } - { name: "Release, clang", os: "ubuntu-latest", build-type: "Release", dep-build-type: "Release", cc: "clang", options: "-DENABLE_TESTS=ON", packages: "libcmocka-dev", snaps: "", make-target: "" } - { name: "Debug, gcc", os: "ubuntu-latest", build-type: "Debug", dep-build-type: "Debug", cc: "gcc", options: "", packages: "libcmocka-dev valgrind", snaps: "", make-target: "" } - { name: "Debug, clang", os: "ubuntu-latest", build-type: "Debug", dep-build-type: "Debug", cc: "clang", options: "", # no valgrind because it does not support DWARF5 yet generated by clang 14 packages: "libcmocka-dev", snaps: "", make-target: "" } - { name: "ASAN and UBSAN", os: "ubuntu-latest", build-type: "Debug", dep-build-type: "Debug", cc: "clang", options: "-DCMAKE_C_FLAGS=-fsanitize=address,undefined -DENABLE_TESTS=ON -DENABLE_VALGRIND_TESTS=OFF", packages: "libcmocka-dev", snaps: "", make-target: "", ubsan-options: "print_stacktrace=1:halt_on_error=1", } - { name: "Printed context OFF", os: "ubuntu-latest", build-type: "Debug", dep-build-type: "Debug", cc: "gcc", options: "-DPRINTED_CONTEXT_ADDRESS=0", packages: "libcmocka-dev valgrind", snaps: "", make-target: "" } - { name: "MONGO DS plugin", os: "ubuntu-latest", build-type: "Debug", dep-build-type: "Debug", cc: "gcc", options: "-DENABLE_DS_MONGO=ON -DDEFAULT_STARTUP_DS_PLG=\"MONGO DS\" -DDEFAULT_RUNNING_DS_PLG=\"MONGO DS\" -DDEFAULT_CANDIDATE_DS_PLG=\"MONGO DS\" -DDEFAULT_OPERATIONAL_DS_PLG=\"MONGO DS\" -DDEFAULT_FACTORY_DEFAULT_DS_PLG=\"MONGO DS\"", packages: "libcmocka-dev valgrind", snaps: "", make-target: "" } - { name: "MONGO DS plugin latest", os: "ubuntu-latest", build-type: "Debug", dep-build-type: "Debug", cc: "gcc", options: "-DENABLE_DS_MONGO=ON -DDEFAULT_STARTUP_DS_PLG=\"MONGO DS\" -DDEFAULT_RUNNING_DS_PLG=\"MONGO DS\" -DDEFAULT_CANDIDATE_DS_PLG=\"MONGO DS\" -DDEFAULT_OPERATIONAL_DS_PLG=\"MONGO DS\" -DDEFAULT_FACTORY_DEFAULT_DS_PLG=\"MONGO DS\"", packages: "libcmocka-dev valgrind", snaps: "", make-target: "" } - { name: "REDIS DS plugin", os: "ubuntu-latest", build-type: "Debug", dep-build-type: "Debug", cc: "gcc", options: "-DENABLE_DS_REDIS=ON -DDEFAULT_STARTUP_DS_PLG=\"REDIS DS\" -DDEFAULT_RUNNING_DS_PLG=\"REDIS DS\" -DDEFAULT_CANDIDATE_DS_PLG=\"REDIS DS\" -DDEFAULT_OPERATIONAL_DS_PLG=\"REDIS DS\" -DDEFAULT_FACTORY_DEFAULT_DS_PLG=\"REDIS DS\"", packages: "libcmocka-dev valgrind", snaps: "", make-target: "" } - { name: "REDIS DS plugin latest", os: "ubuntu-latest", build-type: "Debug", dep-build-type: "Debug", cc: "gcc", options: "-DENABLE_DS_REDIS=ON -DDEFAULT_STARTUP_DS_PLG=\"REDIS DS\" -DDEFAULT_RUNNING_DS_PLG=\"REDIS DS\" -DDEFAULT_CANDIDATE_DS_PLG=\"REDIS DS\" -DDEFAULT_OPERATIONAL_DS_PLG=\"REDIS DS\" -DDEFAULT_FACTORY_DEFAULT_DS_PLG=\"REDIS DS\"", packages: "libcmocka-dev valgrind", snaps: "", make-target: "" } - { name: "DEB Package", os: "ubuntu-latest", build-type: "Release", dep-build-type: "Release", cc: "gcc", options: "", packages: "cmake debhelper libsystemd-dev libcmocka-dev valgrind python3-pip", snaps: "", make-target: "" } env: UBSAN_OPTIONS: ${{ matrix.config.ubsan-options }} steps: - uses: actions/checkout@main with: fetch-depth: 100 - name: Deps-packages shell: bash run: | sudo apt-get update if ${{ matrix.config.packages != '' }} then sudo apt-get install ${{ matrix.config.packages }} fi if ${{ matrix.config.snaps != '' }} then sudo snap install ${{ matrix.config.snaps }} fi if ${{ matrix.config.name == 'DEB Package' }}; then pip install apkg apkg system-setup fi - name: Deps-uncrustify shell: bash working-directory: ${{ github.workspace }} run: | git clone --branch uncrustify-0.77.1 https://github.com/uncrustify/uncrustify cd uncrustify mkdir build cd build CC=${{ matrix.config.cc }} cmake -DCMAKE_POLICY_VERSION_MINIMUM=3.5 .. make sudo make install if: ${{ matrix.config.name == 'Debug, gcc' }} - name: Deps-libyang shell: bash run: | git clone -b ${{ needs.git-branch.outputs.branch-name }} https://github.com/CESNET/libyang.git cd libyang if ${{ matrix.config.name == 'DEB Package' }}; then apkg build apkg install else mkdir build cd build CC=${{ matrix.config.cc }} cmake -DCMAKE_BUILD_TYPE=${{ matrix.config.dep-build-type }} -DENABLE_TESTS=OFF .. make -j2 sudo make install fi - name: Build-and-install-package shell: bash working-directory: ${{ github.workspace }} run: | apkg build apkg install if: ${{ matrix.config.name == 'DEB Package' }} - name: Deps-MongoDB shell: bash run: | curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | sudo gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg --dearmor echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list sudo apt-get update sudo apt-get install -y mongodb-org sudo service mongod start if: ${{ matrix.config.name == 'MONGO DS plugin' || matrix.config.name == 'MONGO DS plugin latest' }} - name: Deps-libmongoc shell: bash run: | wget https://github.com/mongodb/mongo-c-driver/releases/download/1.24.0/mongo-c-driver-1.24.0.tar.gz tar xzf mongo-c-driver-1.24.0.tar.gz cd mongo-c-driver-1.24.0 mkdir cmake-build cd cmake-build cmake -DCMAKE_POLICY_VERSION_MINIMUM=3.5 -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF .. cmake --build . sudo cmake --build . --target install if: ${{ matrix.config.name == 'MONGO DS plugin' }} - name: Deps-libmongoc-latest shell: bash run: | git clone https://github.com/mongodb/mongo-c-driver.git cd mongo-c-driver cmake -S . -B ./_build -DENABLE_EXTRA_ALIGNMENT=OFF -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_MONGOC=ON -DCMAKE_POLICY_VERSION_MINIMUM=3.5 cmake --build ./_build --config RelWithDebInfo --parallel sudo cmake --install "./_build" --prefix "/usr/local" if: ${{ matrix.config.name == 'MONGO DS plugin latest' }} - name: Deps-RedisDB shell: bash # use jammy (22.04) since redis-stack-server is not available on noble (24.04) yet! run: | curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg sudo chmod 644 /usr/share/keyrings/redis-archive-keyring.gpg echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb jammy main" | sudo tee /etc/apt/sources.list.d/redis.list sudo apt-get update sudo apt-get install redis-stack-server sudo service redis-stack-server start if: ${{ matrix.config.name == 'REDIS DS plugin' || matrix.config.name == 'REDIS DS plugin latest' }} - name: Deps-libhiredis shell: bash run: | wget https://github.com/redis/hiredis/archive/refs/tags/v1.1.0.tar.gz tar xzf v1.1.0.tar.gz cd hiredis-1.1.0 make sudo make install if: ${{ matrix.config.name == 'REDIS DS plugin' }} - name: Deps-libhiredis-latest shell: bash run: | git clone https://github.com/redis/hiredis.git cd hiredis make sudo make install if: ${{ matrix.config.name == 'REDIS DS plugin latest' }} - name: Configure shell: bash working-directory: ${{ github.workspace }} run: | mkdir build cd build CC=${{ matrix.config.cc }} cmake -DCMAKE_BUILD_TYPE=${{ matrix.config.build-type }} ${{ matrix.config.options }} .. if: ${{ matrix.config.name != 'DEB Package' }} - name: Build shell: bash working-directory: ${{ github.workspace }}/build run: | export LC_ALL=C.UTF-8 export PATH=/snap/bin:${{ github.workspace }}/coverity-tools/bin:$PATH make ${{ matrix.config.make-target }} if: ${{ matrix.config.name != 'DEB Package' }} - name: Test shell: bash working-directory: ${{ github.workspace }}/build run: ctest --output-on-failure if: ${{ matrix.config.name != 'DEB Package' }} build-linux-32bit: name: Release, Linux 32-bit, gcc runs-on: ubuntu-latest needs: git-branch steps: - uses: actions/checkout@main - name: Build in 32-bit container run: | docker run --rm \ -v ${{ github.workspace }}:${{ github.workspace }} \ -w ${{ github.workspace }} \ i386/ubuntu \ /bin/bash -c " \ apt-get update -q && \ apt-get install -y -q git cmake gcc g++ libcmocka-dev valgrind libxxhash-dev libpcre2-dev && \ git clone -b ${{ needs.git-branch.outputs.branch-name }} https://github.com/CESNET/libyang.git && \ cd libyang && mkdir build && cd build && \ cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTS=OFF .. && \ make -j2 && \ make install && \ cd ../.. && \ mkdir build && cd build && \ cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTS=ON .. && \ make && \ ctest --output-on-failure \ " build-big-endian: name: Release, Big-endian, s390x runs-on: ubuntu-latest needs: git-branch steps: - uses: actions/checkout@main - name: Build and test # use QEMU user-static emulation to run non-x86 Linux uses: uraimo/run-on-arch-action@master with: arch: s390x distro: ubuntu22.04 # speeds up build by caching Docker images in GitHub Packages githubToken: ${{ github.token }} # map the build directory to the container dockerRunArgs: | --volume "${PWD}:/workspace" # install dependencies inside the emulated container install: | apt-get update -q -y apt-get install -q -y git cmake gcc g++ libcmocka-dev valgrind libxxhash-dev libpcre2-dev # run the build run: | set -e git clone -b ${{ needs.git-branch.outputs.branch-name }} https://github.com/CESNET/libyang.git cd libyang && mkdir build && cd build cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTS=OFF .. make -j2 make install cd ../.. mkdir build cd build cmake -DPRINTED_CONTEXT_ADDRESS=0 -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTS=ON .. make ctest --output-on-failure sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/.github/workflows/devel-push.yml000066400000000000000000000104061515724777400267360ustar00rootroot00000000000000name: sysrepo devel push on: push: branches: - devel env: COVERITY_PROJECT: sysrepo%2Fsysrepo jobs: git-branch: name: Get git branch runs-on: ubuntu-latest outputs: branch-name: ${{ steps.get-git-branch.outputs.branch-name }} steps: - id: get-git-branch run: | if ${{ github.event_name == 'push' }} then export GIT_BRANCH=`echo ${{ github.ref }} | cut -d'/' -f 3` else export GIT_BRANCH=${{ github.base_ref }} fi echo "branch-name=$GIT_BRANCH" >> $GITHUB_OUTPUT build: name: ${{ matrix.config.name }} runs-on: ${{ matrix.config.os }} # mac-OS does not implement robust mutexes so it is not supported needs: git-branch if: ${{ github.repository == 'sysrepo/sysrepo' }} strategy: fail-fast: false matrix: config: - { name: "Coverity", os: "ubuntu-latest", build-type: "Debug", dep-build-type: "Debug", cc: "clang", options: "", packages: "", snaps: "", make-prepend: "cov-build --dir cov-int", make-target: "" } - { name: "Codecov", os: "ubuntu-latest", build-type: "Debug", cc: "gcc", options: "-DENABLE_COVERAGE=ON", packages: "libcmocka-dev lcov", snaps: "", make-prepend: "", make-target: "" } steps: - uses: actions/checkout@main - name: Deps-packages shell: bash run: | sudo apt-get update if ${{ matrix.config.packages != '' }} then sudo apt-get install ${{ matrix.config.packages }} fi if ${{ matrix.config.snaps != '' }} then sudo snap install ${{ matrix.config.snaps }} fi - name: Deps-coverity shell: bash working-directory: ${{ github.workspace }} run: | wget -q https://scan.coverity.com/download/linux64 --post-data "token=$TOKEN&project=$COVERITY_PROJECT" -O coverity-tools.tar.gz mkdir coverity-tools tar xzf coverity-tools.tar.gz --strip 1 -C coverity-tools env: TOKEN: ${{ secrets.COVERITY_SCAN_TOKEN }} if: ${{ matrix.config.name == 'Coverity' }} - name: Deps-libyang shell: bash run: | git clone -b ${{ needs.git-branch.outputs.branch-name }} https://github.com/CESNET/libyang.git cd libyang mkdir build cd build CC=${{ matrix.config.cc }} cmake -DCMAKE_BUILD_TYPE=${{ matrix.config.dep-build-type }} -DENABLE_TESTS=OFF .. make -j2 sudo make install - name: Configure shell: bash working-directory: ${{ github.workspace }} run: | mkdir build cd build CC=${{ matrix.config.cc }} cmake -DCMAKE_BUILD_TYPE=${{ matrix.config.build-type }} ${{ matrix.config.options }} .. - name: Build shell: bash working-directory: ${{ github.workspace }}/build run: | export LC_ALL=C.UTF-8 export PATH=/snap/bin:${{ github.workspace }}/coverity-tools/bin:$PATH ${{ matrix.config.make-prepend }} make ${{ matrix.config.make-target }} - name: Test shell: bash working-directory: ${{ github.workspace }}/build run: ctest --output-on-failure - name: Upload to Coverity.com shell: bash working-directory: ${{ github.workspace }}/build run: | tar czvf sysrepo.tgz cov-int curl \ --form token=$TOKEN \ --form email=mvasko@cesnet.cz \ --form file=@sysrepo.tgz \ --form version="`./sysrepoctl -V | head -n1 | cut -d' ' -f 11 | cut -b 2-`" \ --form description="sysrepo datastore" \ https://scan.coverity.com/builds?project=$COVERITY_PROJECT env: TOKEN: ${{ secrets.COVERITY_SCAN_TOKEN }} if: ${{ matrix.config.name == 'Coverity' }} - name: Upload to Codecov.io shell: bash working-directory: ${{ github.workspace }}/build run: bash <(curl -s https://codecov.io/bash) if: ${{ matrix.config.name == 'Codecov' }} sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeLists.txt000066400000000000000000000717001515724777400233060ustar00rootroot00000000000000cmake_minimum_required(VERSION 2.8.12...3.28.1) project(sysrepo C) set(SYSREPO_DESC "YANG-based system repository for all-around configuration management.") # include custom Modules set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/CMakeModules/") include(GNUInstallDirs) include(CheckSymbolExists) include(CheckIncludeFile) include(CheckLibraryExists) include(UseCompat) include(ABICheck) include(SourceFormat) include(GenDoc) include(GenCoverage) include(SetupPrintedContext) if(POLICY CMP0075) cmake_policy(SET CMP0075 NEW) endif() # osx specific set(CMAKE_MACOSX_RPATH TRUE) # set default build type if not specified by user and normalize it if(NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE Debug) endif() string(TOUPPER "${CMAKE_BUILD_TYPE}" BUILD_TYPE_UPPER) # see https://github.com/CESNET/libyang/pull/1692 for why CMAKE_C_FLAGS_ are not used directly if("${BUILD_TYPE_UPPER}" STREQUAL "RELEASE") set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Build Type" FORCE) set(CMAKE_C_FLAGS "-DNDEBUG -O2 ${CMAKE_C_FLAGS}") elseif("${BUILD_TYPE_UPPER}" STREQUAL "DEBUG") set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Build Type" FORCE) set(CMAKE_C_FLAGS "-g -O0 ${CMAKE_C_FLAGS}") elseif("${BUILD_TYPE_UPPER}" STREQUAL "RELWITHDEBINFO") set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Build Type" FORCE) set(CMAKE_C_FLAGS "-DNDEBUG -g -O2 ${CMAKE_C_FLAGS}") elseif("${BUILD_TYPE_UPPER}" STREQUAL "RELWITHDEBUG") set(CMAKE_BUILD_TYPE "RelWithDebug" CACHE STRING "Build Type" FORCE) elseif("${BUILD_TYPE_UPPER}" STREQUAL "ABICHECK") set(CMAKE_BUILD_TYPE "ABICheck" CACHE STRING "Build Type" FORCE) set(CMAKE_C_FLAGS "-g -Og ${CMAKE_C_FLAGS}") elseif("${BUILD_TYPE_UPPER}" STREQUAL "DOCONLY") set(CMAKE_BUILD_TYPE "DocOnly" CACHE STRING "Build Type" FORCE) endif() set(CMAKE_EXPORT_COMPILE_COMMANDS 1) # Version of the project # Generic version of not only the library. Major version is reserved for really big changes of the project, # minor version changes with added functionality (new tool, functionality of the tool or library, ...) and # micro version is changed with a set of small changes or bugfixes anywhere in the project. set(SYSREPO_MAJOR_VERSION 4) set(SYSREPO_MINOR_VERSION 5) set(SYSREPO_MICRO_VERSION 4) set(SYSREPO_VERSION ${SYSREPO_MAJOR_VERSION}.${SYSREPO_MINOR_VERSION}.${SYSREPO_MICRO_VERSION}) # Version of the library # Major version is changed with every backward non-compatible API/ABI change, minor version changes # with backward compatible change and micro version is connected with any internal change of the library. set(SYSREPO_MAJOR_SOVERSION 8) set(SYSREPO_MINOR_SOVERSION 4) set(SYSREPO_MICRO_SOVERSION 8) set(SYSREPO_SOVERSION_FULL ${SYSREPO_MAJOR_SOVERSION}.${SYSREPO_MINOR_SOVERSION}.${SYSREPO_MICRO_SOVERSION}) set(SYSREPO_SOVERSION ${SYSREPO_MAJOR_SOVERSION}) # Version of libyang library that this sysrepo depends on set(LIBYANG_DEP_VERSION 5.1.1) set(LIBYANG_DEP_SOVERSION 5.1.1) set(LIBYANG_DEP_SOVERSION_MAJOR 5) # generate only version header, it is needed for docs configure_file("${PROJECT_SOURCE_DIR}/src/version.h.in" "${PROJECT_BINARY_DIR}/include/sysrepo/version.h" ESCAPE_QUOTES @ONLY) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wpedantic -std=c11") # # options # if(("${BUILD_TYPE_UPPER}" STREQUAL "DEBUG") OR ("${BUILD_TYPE_UPPER}" STREQUAL "RELWITHDEBINFO")) option(ENABLE_TESTS "Build tests" ON) option(ENABLE_VALGRIND_TESTS "Build tests with valgrind" ON) else() option(ENABLE_TESTS "Build tests" OFF) option(ENABLE_VALGRIND_TESTS "Build tests with valgrind" OFF) endif() option(ENABLE_EXAMPLES "Build examples." ON) set(PRINTED_CONTEXT_ADDRESS "" CACHE STRING "Address of the printed context, generated automatically by default. If set, it must be page-aligned and in a memory region unlikely to conflict with normal process allocation. Set to 0 to disable printed context.") option(ENABLE_COVERAGE "Build code coverage report from tests" OFF) option(ENABLE_COMMON_TARGETS "Define common custom target names such as 'doc' or 'uninstall', may cause conflicts when using add_subdirectory() to build this project" ON) option(ENABLE_DS_MONGO "Enable MongoDB datastore plugin" OFF) option(ENABLE_DS_REDIS "Enable Redis datastore plugin" OFF) option(ENABLE_SYSREPOCTL "Build binary tool 'sysrepoctl'" ON) option(ENABLE_SYSREPOCFG "Build binary tool 'sysrepocfg'" ON) option(ENABLE_SYSREPO_PLUGIND "Build binary daemon 'sysrepo-plugind'" ON) option(BUILD_SHARED_LIBS "By default, shared libs are enabled. Turn off for a static build." ON) option(INSTALL_SYSCTL_CONF "Install sysctl conf file to allow shared access to SHM files." OFF) set(YANG_MODULE_DIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATADIR}/yang/modules/sysrepo" CACHE STRING "Directory where to copy the YANG modules to.") set(INTERNAL_MODULE_DATA_PATH "" CACHE STRING "Path to a file with startup and factory-default data of internal modules. Contents of the file are compiled into the library.") if(INTERNAL_MODULE_DATA_PATH) if(NOT EXISTS "${INTERNAL_MODULE_DATA_PATH}") message(FATAL_ERROR "File \"${INTERNAL_MODULE_DATA_PATH}\" does not exist.") endif() string(REGEX MATCH "[.](xml|json)$" EXT ${INTERNAL_MODULE_DATA_PATH}) if(NOT EXT) message(FATAL_ERROR "File \"${INTERNAL_MODULE_DATA_PATH}\" with an unknown extension.") endif() file(READ "${INTERNAL_MODULE_DATA_PATH}" INTERNAL_MODULE_DATA_RAW) string(REPLACE "\n" "\\\n" INTERNAL_MODULE_DATA ${INTERNAL_MODULE_DATA_RAW}) if(${EXT} STREQUAL ".xml") set(INTERNAL_MODULE_DATA_FORMAT LYD_XML) else() set(INTERNAL_MODULE_DATA_FORMAT LYD_JSON) endif() else() # empty data but the code needs a format set(INTERNAL_MODULE_DATA_FORMAT LYD_XML) endif() set(INTERNAL_MODULE_DISABLED_RUNNING "" CACHE STRING "List of internal sysrepo or libyang modules that will have their 'running' datastores disabled (always mirroring 'startup'), separated by space. Use '*' for all the modules.") # default datastore plugins set(DEFAULT_STARTUP_DS_PLG "JSON DS file" CACHE STRING "Default datastore plugin for storing startup data.") set(DEFAULT_RUNNING_DS_PLG "JSON DS file" CACHE STRING "Default datastore plugin for storing running data.") set(DEFAULT_CANDIDATE_DS_PLG "JSON DS file" CACHE STRING "Default datastore plugin for storing candidate data.") set(DEFAULT_OPERATIONAL_DS_PLG "JSON DS file" CACHE STRING "Default datastore plugin for storing operational data.") set(DEFAULT_FACTORY_DEFAULT_DS_PLG "JSON DS file" CACHE STRING "Default datastore plugin for storing factory default data.") set(DEFAULT_NOTIFICATION_DS_PLG "JSON notif" CACHE STRING "Default datastore plugin for storing notifications.") # MongoDB username, password, host and port for the client set(MONGO_AUTHSOURCE "admin" CACHE STRING "Database name associated with the user's credentials.") set(MONGO_USERNAME "" CACHE STRING "Username for MongoDB administrator client, all operations are done via this client in case MongoDB plugin is supported. If not provided, no authentication is done.") set(MONGO_PASSWORD "" CACHE STRING "Password for all MongoDB clients in case MongoDB plugin is supported.") set(MONGO_HOST "127.0.0.1" CACHE STRING "Host for the MongoDB client to connect to.") set(MONGO_PORT 27017 CACHE STRING "Port for the MongoDB client to connect to.") set(MONGO_SOCKET "" CACHE STRING "Unix socket for the MongoDB client to connect to, this overrides MONGO_HOST and MONGO_PORT variables.") # Redis username, password, host and port for the client set(REDIS_USERNAME "" CACHE STRING "Username for Redis user, all operations are done via this client in case Redis plugin is supported. If not provided, no authentication is done.") set(REDIS_PASSWORD "" CACHE STRING "Password for Redis user in case Redis plugin is supported.") set(REDIS_HOST "127.0.0.1" CACHE STRING "Host for the Redis client to connect to.") set(REDIS_PORT 6379 CACHE STRING "Port for the Redis client to connect to.") set(REDIS_SOCKET "" CACHE STRING "Unix socket for the Redis client to connect to, this overrides REDIS_HOST and REDIS_PORT variables.") # ietf-yang-library revision set(YANGLIB_REVISION "2019-01-04" CACHE STRING "YANG module ietf-yang-library revision to implement. Only 2019-01-04 and 2016-06-21 are supported.") if(NOT ${YANGLIB_REVISION} STREQUAL "2019-01-04" AND NOT ${YANGLIB_REVISION} STREQUAL "2016-06-21") message(FATAL_ERROR "Unsupported ietf-yang-library revision ${YANGLIB_REVISION} specified!") endif() message(STATUS "ietf-yang-library revision: ${YANGLIB_REVISION}") # security set(SYSREPO_UMASK "000" CACHE STRING "Umask used for any files created by sysrepo.") set(SYSREPO_GROUP "" CACHE STRING "System group that will own all sysrepo-related files. If empty, the specific process group will be kept.") set(SYSREPO_SUPERUSER_UID "0" CACHE STRING "UID of the system user that can execute sensitive functions.") if(NOT SYSREPO_SUPERUSER_UID MATCHES "^[0-9]+$") message(FATAL_ERROR "Invalid superuser UID \"${SYSREPO_SUPERUSER_UID}\"!") endif() set(NACM_RECOVERY_USER "root" CACHE STRING "NACM recovery session user that has unrestricted access.") set(NACM_SRMON_DATA_PERM "600" CACHE STRING "NACM modules ietf-netconf-acm and sysrepo-monitoring default data permissions.") # sr_cond implementation if(NOT SR_COND_IMPL) check_include_file("linux/futex.h" HAS_FUTEX) check_symbol_exists(SYS_futex "sys/syscall.h" HAS_SYS_FUTEX) if(HAS_FUTEX AND HAS_SYS_FUTEX) set(SR_COND_IMPL "sr_cond_futex") else() set(SR_COND_IMPL "sr_cond_pthread") endif() endif() message(STATUS "Conditional variable implementation: ${SR_COND_IMPL}") # paths if(NOT SHM_DIR) if("${CMAKE_SYSTEM_NAME}" STREQUAL "FreeBSD") set(SHM_DIR "/tmp/shm") else() set(SHM_DIR "/dev/shm") endif() endif() set(SHM_DIR "${SHM_DIR}" CACHE PATH "SHM file directory, contains all shared memory files.") if(NOT REPO_PATH) if("${BUILD_TYPE_UPPER}" STREQUAL "DEBUG") set(REPO_PATH "${CMAKE_BINARY_DIR}/repository") else() set(REPO_PATH "/etc/sysrepo") endif() endif() set(REPO_PATH "${REPO_PATH}" CACHE PATH "Repository path, contains configuration schema and data files.") message(STATUS "Sysrepo repository: ${REPO_PATH}") set(STARTUP_DATA_PATH "${STARTUP_DATA_PATH}" CACHE PATH "Startup data path, contains startup datastore module files.") if(STARTUP_DATA_PATH) message(STATUS "Startup data path: ${STARTUP_DATA_PATH}") else() message(STATUS "Startup data path: ${REPO_PATH}/data") endif() set(FACTORY_DEFAULT_DATA_PATH "${FACTORY_DEFAULT_DATA_PATH}" CACHE PATH "Factory-default data path, contains factory-default datastore module files.") if(FACTORY_DEFAULT_DATA_PATH) message(STATUS "Factory-default data path: ${FACTORY_DEFAULT_DATA_PATH}") else() message(STATUS "Factory-default data path: ${REPO_PATH}/data") endif() set(NOTIFICATION_PATH "${NOTIFICATION_PATH}" CACHE PATH "Notification path, contains stored notifications.") if(NOTIFICATION_PATH) message(STATUS "Notification path: ${NOTIFICATION_PATH}") else() message(STATUS "Notification path: ${REPO_PATH}/data/notif") endif() set(YANG_MODULE_PATH "${YANG_MODULE_PATH}" CACHE PATH "YANG module path, contains all used YANG module files.") if(YANG_MODULE_PATH) message(STATUS "YANG module path: ${YANG_MODULE_PATH}") else() message(STATUS "YANG module path: ${REPO_PATH}/yang") endif() if(NOT SR_PLUGINS_PATH) set(SR_PLUGINS_PATH "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/sysrepo/plugins/" CACHE PATH "Sysrepo datastore and/or notification plugins path.") endif() message(STATUS "SR plugins path: ${SR_PLUGINS_PATH}") if(NOT SRPD_PLUGINS_PATH) set(SRPD_PLUGINS_PATH "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/sysrepo-plugind/plugins/" CACHE PATH "Sysrepo plugin daemon plugins path.") endif() message(STATUS "SRPD plugins path: ${SRPD_PLUGINS_PATH}") if(NOT SYSREPOCFG_DEFAULT_LYD_FORMAT) set(SYSREPOCFG_DEFAULT_LYD_FORMAT LYD_XML) endif() message(STATUS "sysrepocfg default data format: ${SYSREPOCFG_DEFAULT_LYD_FORMAT}") # # sources # set(LIB_SRC src/sysrepo.c src/common.c src/ly_wrap.c src/subscr.c src/log.c src/replay.c src/modinfo.c src/edit_diff.c src/lyd_mods.c src/context_change.c src/shm_main.c src/shm_ext.c src/shm_mod.c src/shm_sub.c src/sr_cond/${SR_COND_IMPL}.c src/plugins/ds_json.c src/plugins/ntf_json.c src/plugins/common_json.c src/utils/values.c src/utils/xpath.c src/utils/error_format.c src/utils/nacm.c src/utils/subscribed_notifications.c src/utils/sn_common.c src/utils/sn_yang_push.c) set(SYSREPOCTL_SRC src/executables/sysrepoctl.c) set(SYSREPOCFG_SRC src/executables/sysrepocfg.c) set(SYSREPOPLUGIND_SRC src/executables/srpd_rotation.c src/executables/srpd_oper_poll_diff.c src/executables/srpd_common.c src/executables/sysrepo-plugind.c) # public headers to check API/ABI on set(LIB_MAIN_HEADERS src/sysrepo.h src/sysrepo_types.h) set(LIB_UTIL_HEADERS src/plugins_datastore.h src/plugins_notification.h src/utils/values.h src/utils/xpath.h src/utils/error_format.h src/utils/netconf_acm.h src/utils/subscribed_notifications.h) # files to generate doxygen from set(DOXY_FILES doc/ ${LIB_MAIN_HEADERS} ${LIB_UTIL_HEADERS} src/plugins_datastore.h src/plugins_notification.h ${PROJECT_BINARY_DIR}/include/sysrepo/version.h) # project (doxygen) logo set(PROJECT_LOGO doc/logo.png) # source files to be covered by the 'format' target set(FORMAT_SOURCES compat/*.c compat/*.h* examples/*.c examples/plugin/*.c src/*.c src/*.h src/executables/*.c src/executables/*.h* src/plugins/*.c src/plugins/*.h* src/utils/* tests/*.c tests/*.c) # # checks # if(ENABLE_VALGRIND_TESTS) if(NOT ENABLE_TESTS) message(WARNING "Tests are disabled! Disabling memory leak tests.") set(ENABLE_VALGRIND_TESTS OFF) else() find_program(VALGRIND_FOUND valgrind) if(NOT VALGRIND_FOUND) message(WARNING "valgrind executable not found! Disabling memory leaks tests.") set(ENABLE_VALGRIND_TESTS OFF) endif() endif() endif() if(ENABLE_TESTS) find_package(CMocka 1.0.1) if(NOT CMOCKA_FOUND) message(STATUS "Disabling tests because of missing CMocka") set(ENABLE_TESTS OFF) endif() endif() find_path(VALGRIND_INCLUDE_DIR NAMES valgrind/callgrind.h PATHS /usr/include /usr/local/include /opt/local/include /sw/include ${CMAKE_INCLUDE_PATH} ${CMAKE_INSTALL_PREFIX}/include) if(VALGRIND_INCLUDE_DIR) set(SR_HAVE_CALLGRIND 1) else() message(STATUS "Disabling callgrind macros in performance tests because of missing valgrind headers") endif() if(ENABLE_COVERAGE) gen_coverage_enable(${ENABLE_TESTS}) endif() if ("${BUILD_TYPE_UPPER}" STREQUAL "DEBUG") source_format_enable(0.77) endif() if("${BUILD_TYPE_UPPER}" STREQUAL "DOCONLY") gen_doc("${DOXY_FILES}" ${SYSREPO_VERSION} ${SYSREPO_DESC} ${PROJECT_LOGO}) return() endif() # # targets # # use compat use_compat() # setup printed context - needs to be after use_compat() setup_printed_context() # required functions list(APPEND CMAKE_REQUIRED_DEFINITIONS -D_GNU_SOURCE) list(APPEND CMAKE_REQUIRED_DEFINITIONS -D_DEFAULT_SOURCE) check_symbol_exists(eaccess "unistd.h" SR_HAVE_EACCESS) if(NOT SR_HAVE_EACCESS) message(WARNING "Function eaccess() is not supported, using access() instead which may " "change results of access control checks!") endif() check_symbol_exists(mkstemps "stdlib.h" SR_HAVE_MKSTEMPS) list(APPEND CMAKE_REQUIRED_LIBRARIES dl) check_symbol_exists(dlopen "dlfcn.h" SR_HAVE_DLOPEN) list(REMOVE_ITEM CMAKE_REQUIRED_LIBRARIES dl) if(NOT SR_HAVE_DLOPEN) message(WARNING "Function dlopen() is not supported, disabling plugin support and 'sysrepo-plugind'.") set(ENABLE_SYSREPO_PLUGIND OFF) endif() list(REMOVE_ITEM CMAKE_REQUIRED_DEFINITIONS -D_GNU_SOURCE) list(REMOVE_ITEM CMAKE_REQUIRED_DEFINITIONS -D_DEFAULT_SOURCE) # libmongoc - optional if(ENABLE_DS_MONGO) find_package(mongoc 2.0.2 CONFIG) if (NOT TARGET mongoc::shared) find_package(mongoc-1.0 1.24.0 CONFIG) endif() find_program(MONGO_CLI_CMD mongosh) if((TARGET mongoc::shared OR TARGET mongo::mongoc_shared) AND MONGO_CLI_CMD) # datastore plugin added if libraries exist list(APPEND LIB_SRC src/plugins/ds_mongo.c) set(SR_ENABLED_DS_PLG_MONGO 1) message(STATUS "Datastore plugin ds_mongo supported.") # try running a command in MongoDB database (should not be possible) and check authentication if(MONGO_SOCKET) set(MONGO_TMP_ARGS "mongodb://${MONGO_SOCKET}") else() set(MONGO_TMP_ARGS "--host" "${MONGO_HOST}" "--port" "${MONGO_PORT}") endif() execute_process(COMMAND ${MONGO_CLI_CMD} ${MONGO_TMP_ARGS} "--eval" "use sr_running" "--eval" "db.runCommand({usersInfo: 1})" RESULT_VARIABLE MONGO_RETURN_CODE ERROR_VARIABLE MONGO_STDERR OUTPUT_QUIET) if(${MONGO_RETURN_CODE} EQUAL 0) message(WARNING "MongoDB authentication is NOT supported! Data stored by sysrepo in MongoDB will be accessible by anyone.") else() if("${MONGO_STDERR}" MATCHES "^MongoServerError: .*auth.*") message(STATUS "MongoDB authentication is supported!") else() message(WARNING "MongoDB authentication cannot be checked - a request to MongoDB failed with: ${MONGO_STDERR}") endif() endif() else() message(STATUS "Datastore plugin ds_mongo not supported.") endif() else() message(STATUS "MongoDB datastore plugin disabled") endif() # libhiredis - optional if(ENABLE_DS_REDIS) find_package(LibHiredis 1.1.0) find_program(REDIS_CLI_CMD redis-cli) if(LIBHIREDIS_FOUND AND REDIS_CLI_CMD) # datastore plugin added if libraries exist list(APPEND LIB_SRC src/plugins/ds_redis.c) set(SR_ENABLED_DS_PLG_REDIS 1) message(STATUS "Datastore plugin ds_redis supported.") # try running a command in Redis database and check authentication if(REDIS_SOCKET) set(REDIS_TMP_ARGS "-s" "${REDIS_SOCKET}") else() set(REDIS_TMP_ARGS "-h" "${REDIS_HOST}" "-p" "${REDIS_PORT}") endif() execute_process(COMMAND ${REDIS_CLI_CMD} ${REDIS_TMP_ARGS} "ACL" "WHOAMI" RESULT_VARIABLE REDIS_RETURN_CODE OUTPUT_VARIABLE REDIS_STDOUT ERROR_VARIABLE REDIS_STDERR) if (${REDIS_RETURN_CODE} GREATER 0) message(WARNING "Redis authentication cannot be checked - a request to Redis failed with: ${REDIS_STDERR}") else() if("${REDIS_STDOUT}" MATCHES "^NOAUTH.*") message(STATUS "Redis authentication is supported!") else() message(WARNING "Redis authentication is NOT supported! Data stored by sysrepo in Redis will be accessible by anyone.") endif() endif() else() message(STATUS "Datastore plugin ds_redis not supported.") endif() else() message(STATUS "Redis datastore plugin disabled") endif() # common database utility functions - optional if(SR_ENABLED_DS_PLG_MONGO OR SR_ENABLED_DS_PLG_REDIS) # common utilities added if at least one library exists and the plugin is enabled list(APPEND LIB_SRC src/plugins/common_db.c) endif() # sysrepo set(CMAKE_POSITION_INDEPENDENT_CODE TRUE) add_library(srobj OBJECT ${LIB_SRC} ${compatsrc}) set_target_properties(srobj PROPERTIES COMPILE_FLAGS "-fvisibility=hidden") add_library(sysrepo $) set_target_properties(sysrepo PROPERTIES VERSION ${SYSREPO_SOVERSION_FULL} SOVERSION ${SYSREPO_SOVERSION}) if(SR_ENABLED_DS_PLG_MONGO) # cannot separately include and link mongoc library, thus add include to srobj and link with sysrepo # to add include directories if (TARGET mongoc::shared) get_target_property(BSON_INTERFACE_INCLUDE_DIR bson::shared INTERFACE_INCLUDE_DIRECTORIES) get_target_property(MONGOC_INTERFACE_INCLUDE_DIR mongoc::shared INTERFACE_INCLUDE_DIRECTORIES) elseif(TARGET mongo::mongoc_shared) get_target_property(BSON_INTERFACE_INCLUDE_DIR mongo::bson_shared INTERFACE_INCLUDE_DIRECTORIES) get_target_property(MONGOC_INTERFACE_INCLUDE_DIR mongo::mongoc_shared INTERFACE_INCLUDE_DIRECTORIES) endif() set_property(TARGET srobj APPEND PROPERTY INCLUDE_DIRECTORIES ${BSON_INTERFACE_INCLUDE_DIR} ${MONGOC_INTERFACE_INCLUDE_DIR}) if (TARGET mongoc::shared) target_link_libraries(sysrepo mongoc::shared) elseif(TARGET mongo::mongoc_shared) target_link_libraries(sysrepo mongo::mongoc_shared) endif() endif() if (SR_ENABLED_DS_PLG_REDIS) # to add include directories target_link_libraries(sysrepo ${LIBHIREDIS_LIBRARIES}) include_directories(${LIBHIREDIS_INCLUDE_DIRS}) endif() if(ENABLE_SYSREPOCTL) # sysrepoctl tool add_executable(sysrepoctl ${SYSREPOCTL_SRC} ${compatsrc}) target_link_libraries(sysrepoctl sysrepo) endif() if(ENABLE_SYSREPOCFG) # sysrepocfg tool add_executable(sysrepocfg ${SYSREPOCFG_SRC} ${compatsrc}) target_link_libraries(sysrepocfg sysrepo) endif() if(ENABLE_SYSREPO_PLUGIND) # sysrepo-plugind daemon add_executable(sysrepo-plugind ${SYSREPOPLUGIND_SRC} ${compatsrc}) target_link_libraries(sysrepo-plugind sysrepo) endif() # include repository files with highest priority include_directories("${PROJECT_SOURCE_DIR}/src") include_directories("${PROJECT_SOURCE_DIR}/src/plugins") include_directories(${PROJECT_BINARY_DIR}) # dependencies # libatomic find_library(LIBATOMIC_LIBRARIES NAMES libatomic.so libatomic.so.1) if(LIBATOMIC_LIBRARIES) target_link_libraries(sysrepo ${LIBATOMIC_LIBRARIES}) endif() # librt (shm_open, shm_unlink, not required on QNX or OSX) find_library(LIBRT_LIBRARIES rt) if(LIBRT_LIBRARIES) target_link_libraries(sysrepo ${LIBRT_LIBRARIES}) endif() # libdl target_link_libraries(sysrepo ${CMAKE_DL_LIBS}) # libyang, check version find_package(LibYANG ${LIBYANG_DEP_SOVERSION} REQUIRED) target_link_libraries(sysrepo ${LIBYANG_LIBRARIES}) include_directories(${LIBYANG_INCLUDE_DIRS}) # pkg-config find_package(PkgConfig) if(NOT PKG_CONFIG_FOUND AND NOT SYSTEMD_UNIT_DIR) set(SYSTEMD_UNIT_DIR "/usr/lib/systemd/system") endif() # libsystemd find_package(LibSystemd) if(LIBSYSTEMD_FOUND) set(SR_HAVE_SYSTEMD 1) if(ENABLE_SYSREPO_PLUGIND) target_link_libraries(sysrepo-plugind ${LIBSYSTEMD_LIBRARIES}) endif() include_directories(${LIBSYSTEMD_INCLUDE_DIRS}) message(STATUS "systemd system service unit path: ${SYSTEMD_UNIT_DIR}") else() message(WARNING "Disabling sysrepo-plugind systemd support because libsystemd was not found.") endif() # pthread set(CMAKE_THREAD_PREFER_PTHREAD TRUE) find_package(Threads REQUIRED) target_link_libraries(sysrepo ${CMAKE_THREAD_LIBS_INIT}) set(CMAKE_REQUIRED_LIBRARIES pthread) # tar find_program(TAR_BINARY "tar") if(NOT TAR_BINARY) message(FATAL_ERROR "tar binary was not found.") endif() # generate files configure_file("${PROJECT_SOURCE_DIR}/src/config.h.in" "${PROJECT_BINARY_DIR}/config.h" ESCAPE_QUOTES @ONLY) configure_file("${PROJECT_SOURCE_DIR}/sysrepo.pc.in" "${PROJECT_BINARY_DIR}/sysrepo.pc" @ONLY) configure_file("${PROJECT_SOURCE_DIR}/src/executables/bin_common.h.in" "${PROJECT_BINARY_DIR}/bin_common.h" ESCAPE_QUOTES @ONLY) configure_file("${PROJECT_SOURCE_DIR}/src/executables/sysrepo-plugind.service.in" "${PROJECT_BINARY_DIR}/sysrepo-plugind.service" @ONLY) # copy public headers file(COPY ${LIB_MAIN_HEADERS} DESTINATION "${PROJECT_BINARY_DIR}/include") file(COPY ${LIB_UTIL_HEADERS} DESTINATION "${PROJECT_BINARY_DIR}/include/sysrepo") # installation file(GLOB yangs "${PROJECT_SOURCE_DIR}/modules/*.yang") install(FILES ${yangs} DESTINATION ${YANG_MODULE_DIR}) file(GLOB sn_yangs "${PROJECT_SOURCE_DIR}/modules/subscribed_notifications/*.yang") install(FILES ${sn_yangs} DESTINATION ${YANG_MODULE_DIR}) install(TARGETS sysrepo DESTINATION ${CMAKE_INSTALL_LIBDIR}) install(FILES ${PROJECT_BINARY_DIR}/include/sysrepo.h ${PROJECT_BINARY_DIR}/include/sysrepo_types.h DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) install(DIRECTORY ${PROJECT_BINARY_DIR}/include/sysrepo DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) install(FILES ${PROJECT_BINARY_DIR}/sysrepo.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig) install(DIRECTORY DESTINATION ${REPO_PATH} DIRECTORY_PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_WRITE GROUP_EXECUTE WORLD_READ WORLD_WRITE WORLD_EXECUTE) if(ENABLE_SYSREPOCTL) install(TARGETS sysrepoctl DESTINATION ${CMAKE_INSTALL_BINDIR}) install(FILES ${PROJECT_SOURCE_DIR}/src/executables/sysrepoctl.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1) endif() if(ENABLE_SYSREPOCFG) install(TARGETS sysrepocfg DESTINATION ${CMAKE_INSTALL_BINDIR}) install(FILES ${PROJECT_SOURCE_DIR}/src/executables/sysrepocfg.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1) endif() if(ENABLE_SYSREPO_PLUGIND) install(TARGETS sysrepo-plugind DESTINATION ${CMAKE_INSTALL_BINDIR}) install(FILES ${PROJECT_SOURCE_DIR}/src/executables/sysrepo-plugind.8 DESTINATION ${CMAKE_INSTALL_MANDIR}/man8) install(DIRECTORY DESTINATION ${SRPD_PLUGINS_PATH}) endif() if(SR_HAVE_DLOPEN) install(DIRECTORY DESTINATION ${SR_PLUGINS_PATH}) endif() if(SR_HAVE_SYSTEMD AND ENABLE_SYSREPO_PLUGIND) install(FILES ${PROJECT_BINARY_DIR}/sysrepo-plugind.service DESTINATION ${SYSTEMD_UNIT_DIR}) endif() if(INSTALL_SYSCTL_CONF) install(FILES "${PROJECT_SOURCE_DIR}/zz-sysrepo-disable-fs-protected_regular.conf" DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/sysctl.d/") endif() # tests if(ENABLE_TESTS) enable_testing() add_subdirectory(tests) endif() # create coverage target for generating coverage reports gen_coverage("test_.*" "test_.*_valgrind") # examples if(ENABLE_EXAMPLES) add_subdirectory(examples) endif() # generate doxygen documentation if(ENABLE_COMMON_TARGETS) gen_doc("${DOXY_FILES}" ${SYSREPO_VERSION} ${SYSREPO_DESC} ${PROJECT_LOGO}) endif() # generate API/ABI report if("${BUILD_TYPE_UPPER}" STREQUAL "ABICHECK") lib_abi_check(sysrepo "${LIB_MAIN_HEADERS};${LIB_UTIL_HEADERS}" ${SYSREPO_SOVERSION_FULL} 0232c2fad78281e7577271c61a0031cc3c0307e1) endif() # source files to be covered by the 'format' target and a test with 'format-check' target source_format(${FORMAT_SOURCES}) # phony target for clearing sysrepo SHM add_custom_target(shm_clean COMMAND rm -rf ${SHM_DIR}/sr_* COMMAND rm -rf ${SHM_DIR}/srsub_* COMMENT "Removing all volatile SHM files prefixed with \"sr\"" ) # phony target for clearing all sysrepo data add_custom_target(sr_clean COMMAND rm -rf ${REPO_PATH} DEPENDS shm_clean COMMENT "Removing the whole persistent repository \"${REPO_PATH}\"" ) # flush all sysrepo related data from mongo if(SR_ENABLED_DS_PLG_MONGO) if (MONGO_SOCKET) set(MONGO_TMP_ARGS "mongodb://${MONGO_SOCKET}") else() set(MONGO_TMP_ARGS "--host" "${MONGO_HOST}" "--port" "${MONGO_PORT}") endif() list(APPEND MONGO_TMP_ARGS ) add_custom_target(sr_mongo_clean COMMAND ${MONGO_CLI_CMD} ${MONGO_TMP_ARGS} "--eval" "use sr_startup" "--eval" "\"db.dropDatabase()\"" "--eval" "use sr_running" "--eval" "\"db.dropDatabase()\"" "--eval" "use sr_candidate" "--eval" "\"db.dropDatabase()\"" "--eval" "use sr_operational" "--eval" "\"db.dropDatabase()\"" "--eval" "use sr_factory-default" "--eval" "\"db.dropDatabase()\"" "1>" "/dev/null") add_dependencies(sr_clean sr_mongo_clean) endif() # flush all sysrepo related data from redis if(SR_ENABLED_DS_PLG_REDIS) set(REDIS_SCRIPT "local reply = redis.pcall('FT._LIST'); if reply['err'] ~= nil then return reply['err']; end local n = table.getn(reply); local reply2; local index; for i=1,n do index = ''; for k,v in pairs(reply[i]) do index = index..v; end if string.sub(index,1,3) == 'sr:' then reply2 = redis.pcall('FT.DROPINDEX', index, 'DD'); if reply2['err'] ~= nil then return reply2['err']; end end end reply = redis.pcall('SCAN', '0', 'MATCH', 'sr:*', 'COUNT', '50000'); if reply['err'] ~= nil then return reply['err']; end while 1 do n = table.getn(reply[2]); for i=1,n do reply2 = redis.pcall('DEL', reply[2][i]); if reply2 ~= 1 then return reply2['err']; end end if reply[1] == '0' then break end reply = redis.pcall('SCAN', reply[1], 'MATCH', 'sr:*', 'COUNT', '50000'); if reply['err'] ~= nil then return reply['err']; end end return 0;") if(REDIS_SOCKET) set(REDIS_TMP_ARGS "-s" "${REDIS_SOCKET}") else() set(REDIS_TMP_ARGS "-h" "${REDIS_HOST}" "-p" "${REDIS_PORT}") endif() add_custom_target(sr_redis_clean COMMAND ${REDIS_CLI_CMD} ${REDIS_TMP_ARGS} "EVAL" "${REDIS_SCRIPT}" "0" "1>" "/dev/null" VERBATIM) add_dependencies(sr_clean sr_redis_clean) endif() # uninstall if(ENABLE_COMMON_TARGETS) add_custom_target(uninstall "${CMAKE_COMMAND}" -P "${CMAKE_MODULE_PATH}/uninstall.cmake") endif() add_custom_target(uninstall_with_repo "${CMAKE_COMMAND}" -P "${CMAKE_MODULE_PATH}/uninstall.cmake" COMMAND rm -rf ${REPO_PATH}) sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/000077500000000000000000000000001515724777400230525ustar00rootroot00000000000000sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/ABICheck.cmake000066400000000000000000000060651515724777400254140ustar00rootroot00000000000000# generate API/ABI report macro(LIB_ABI_CHECK LIB_TARGET LIB_HEADERS LIB_SOVERSION_FULL ABI_BASE_HASH) # get short hash string(SUBSTRING "${ABI_BASE_HASH}" 0 8 ABI_BASE_HASH_SHORT) # find abi-dumper find_program(ABI_DUMPER abi-dumper) find_package_handle_standard_args(abi-dumper DEFAULT_MSG ABI_DUMPER) if(NOT ABI_DUMPER) message(FATAL_ERROR "Program abi-dumper not found!") endif() # find abi-checker find_program(ABI_CHECKER abi-compliance-checker) find_package_handle_standard_args(abi-compliance-checker DEFAULT_MSG ABI_CHECKER) if(NOT ABI_CHECKER) message(FATAL_ERROR "Program abi-compliance-checker not found!") endif() # abi-dump target - generating an ABI dump set(PUBLIC_HEADERS ${LIB_HEADERS}) string(PREPEND PUBLIC_HEADERS "${CMAKE_SOURCE_DIR}/") string(REPLACE ";" "\n${CMAKE_SOURCE_DIR}/" PUBLIC_HEADERS "${PUBLIC_HEADERS}") file(GENERATE OUTPUT ${CMAKE_BINARY_DIR}/public_headers CONTENT "${PUBLIC_HEADERS}") add_custom_target(abi-dump COMMAND ${ABI_DUMPER} ./lib${LIB_TARGET}${CMAKE_SHARED_LIBRARY_SUFFIX} -o lib${LIB_TARGET}.${LIB_SOVERSION_FULL}.dump -lver ${LIB_SOVERSION_FULL} -public-headers ${CMAKE_BINARY_DIR}/public_headers DEPENDS ${LIB_TARGET} BYPRODUCTS ${CMAKE_BINARY_DIR}/lib${LIB_TARGET}.${LIB_SOVERSION_FULL}.dump WORKING_DIRECTORY ${CMAKE_BINARY_DIR} COMMENT "Dumping ABI information of version ${LIB_SOVERSION_FULL} for abi-check") # get URL for fetching origin execute_process(COMMAND git remote get-url origin OUTPUT_VARIABLE ORIGIN_URL OUTPUT_STRIP_TRAILING_WHITESPACE) # generate script for generating the base ABI dump file(GENERATE OUTPUT ${CMAKE_BINARY_DIR}/abibase.sh CONTENT "#!/bin/sh if [ ! -d abibase ]; then mkdir abibase; fi cd abibase if [ ! -f build/lib${LIB_TARGET}.*.dump ]; then if [ -d .git ] && [ \"${ABI_BASE_HASH}\" != \"`git log --pretty=oneline | cut -d' ' -f1`\" ]; then rm -rf .* 2> /dev/null; fi if [ ! -d .git ]; then git init --initial-branch=master git remote add origin ${ORIGIN_URL} git fetch origin --depth 1 ${ABI_BASE_HASH} git reset --hard FETCH_HEAD fi if [ ! -d build ]; then mkdir build; fi cd build cmake -DCMAKE_BUILD_TYPE=ABICheck .. make abi-dump fi ") # abi-check target - check ABI compatibility of current version and the base hash version add_custom_target(abi-check COMMAND bash ./abibase.sh COMMAND ${ABI_CHECKER} -l lib${LIB_TARGET}${CMAKE_SHARED_LIBRARY_SUFFIX} -old abibase/build/lib${LIB_TARGET}.*.dump -new ./lib${LIB_TARGET}.${LIB_SOVERSION_FULL}.dump DEPENDS ${LIB_TARGET} abi-dump BYPRODUCTS ${CMAKE_BINARY_DIR}/compat_reports/lib${LIB_TARGET}${CMAKE_SHARED_LIBRARY_SUFFIX}/*_to_${LIB_SOVERSION_FULL}/compat_report.html WORKING_DIRECTORY ${CMAKE_BINARY_DIR} COMMENT "Checking ABI compatibility of version ${LIB_SOVERSION_FULL} and revision ${ABI_BASE_HASH_SHORT}") endmacro() sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/FindCMocka.cmake000066400000000000000000000051161515724777400260150ustar00rootroot00000000000000# - Try to find CMocka # Once done this will define # # CMOCKA_ROOT_DIR - Set this variable to the root installation of CMocka # # Read-Only variables: # CMOCKA_FOUND - system has CMocka # CMOCKA_INCLUDE_DIR - the CMocka include directory # CMOCKA_LIBRARIES - Link these to use CMocka # CMOCKA_DEFINITIONS - Compiler switches required for using CMocka # #============================================================================= # Copyright (c) 2011-2012 Andreas Schneider # # Distributed under the OSI-approved BSD License (the "License"). # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions # are met: # # 1. Redistributions of source code must retain the copyright # notice, this list of conditions and the following disclaimer. # 2. Redistributions in binary form must reproduce the copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. # 3. The name of the author may not be used to endorse or promote products # derived from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. # IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # #============================================================================= # find_path(CMOCKA_INCLUDE_DIR NAMES cmocka.h PATHS ${CMOCKA_ROOT_DIR}/include ) find_library(CMOCKA_LIBRARY NAMES cmocka cmocka_shared PATHS ${CMOCKA_ROOT_DIR}/include ) if (CMOCKA_LIBRARY) set(CMOCKA_LIBRARIES ${CMOCKA_LIBRARIES} ${CMOCKA_LIBRARY} ) endif (CMOCKA_LIBRARY) include(FindPackageHandleStandardArgs) find_package_handle_standard_args(CMocka DEFAULT_MSG CMOCKA_LIBRARIES CMOCKA_INCLUDE_DIR) # show the CMOCKA_INCLUDE_DIR and CMOCKA_LIBRARIES variables only in the advanced view mark_as_advanced(CMOCKA_INCLUDE_DIR CMOCKA_LIBRARIES) sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/FindLibHiredis.cmake000066400000000000000000000055571515724777400267070ustar00rootroot00000000000000# - Try to find LibHiredis # Once done this will define # # LIBHIREDIS_FOUND - system has LibHiredis # LIBHIREDIS_INCLUDE_DIRS - the LibHiredis include directory # LIBHIREDIS_LIBRARIES - Link these to use LibHiredis # LIBHIREDIS_VERSION - SO version of the found hiredis library # # Author Ondrej Kusnirik # Copyright (c) 2021 CESNET, z.s.p.o. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions # are met: # # 1. Redistributions of source code must retain the copyright # notice, this list of conditions and the following disclaimer. # 2. Redistributions in binary form must reproduce the copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. # 3. The name of the author may not be used to endorse or promote products # derived from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. # IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # include(FindPackageHandleStandardArgs) if(LIBHIREDIS_LIBRARIES AND LIBHIREDIS_INCLUDE_DIRS) # in cache already set(LIBHIREDIS_FOUND 1) else() find_path(LIBHIREDIS_INCLUDE_DIR NAMES hiredis/hiredis.h PATHS /usr/include /usr/local/include /opt/local/include /sw/include ${CMAKE_INCLUDE_PATH} ${CMAKE_INSTALL_PREFIX}/include ) find_library(LIBHIREDIS_LIBRARY NAMES hiredis libhiredis PATHS /usr/lib /usr/lib64 /usr/local/lib /usr/local/lib64 /opt/local/lib /sw/lib ${CMAKE_LIBRARY_PATH} ${CMAKE_INSTALL_PREFIX}/lib ) set(LIBHIREDIS_INCLUDE_DIRS ${LIBHIREDIS_INCLUDE_DIR}) set(LIBHIREDIS_LIBRARIES ${LIBHIREDIS_LIBRARY}) mark_as_advanced(LIBHIREDIS_INCLUDE_DIRS LIBHIREDIS_LIBRARIES) # handle the QUIETLY and REQUIRED arguments and set LIBSYSTEMD_FOUND to TRUE # if all listed variables are TRUE find_package_handle_standard_args(LibHiredis FOUND_VAR LIBHIREDIS_FOUND REQUIRED_VARS LIBHIREDIS_LIBRARY LIBHIREDIS_INCLUDE_DIR) endif() sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/FindLibSystemd.cmake000066400000000000000000000064161515724777400267430ustar00rootroot00000000000000# - Try to find LibSystemd, it is expected find_package(PkgConfig) was called before # # Once done this will define # # LIBSYSTEMD_FOUND - system has LibSystemd # LIBSYSTEMD_INCLUDE_DIRS - the LibSystemd include directory # LIBSYSTEMD_LIBRARIES - link these to use LibSystemd # SYSTEMD_UNIT_DIR - directory with systemd system unit files # # Author Michal Vasko # Copyright (c) 2022 CESNET, z.s.p.o. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions # are met: # # 1. Redistributions of source code must retain the copyright # notice, this list of conditions and the following disclaimer. # 2. Redistributions in binary form must reproduce the copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. # 3. The name of the author may not be used to endorse or promote products # derived from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. # IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # include(FindPackageHandleStandardArgs) if(LIBSYSTEMD_LIBRARIES AND LIBSYSTEMD_INCLUDE_DIRS AND SYSTEMD_UNIT_DIR) # in cache already set(LIBSYSTEMD_FOUND TRUE) else() find_path(LIBSYSTEMD_INCLUDE_DIR NAMES systemd/sd-daemon.h PATHS /usr/include /usr/local/include /opt/local/include /sw/include ${CMAKE_INCLUDE_PATH} ${CMAKE_INSTALL_PREFIX}/include ) find_library(LIBSYSTEMD_LIBRARY NAMES systemd libsystemd PATHS /usr/lib /usr/lib64 /usr/local/lib /usr/local/lib64 /opt/local/lib /sw/lib ${CMAKE_LIBRARY_PATH} ${CMAKE_INSTALL_PREFIX}/lib ) if(NOT SYSTEMD_UNIT_DIR) execute_process(COMMAND ${PKG_CONFIG_EXECUTABLE} --define-variable=rootprefix=${CMAKE_INSTALL_PREFIX} --variable=systemdsystemunitdir systemd OUTPUT_VARIABLE SYSTEMD_UNIT_DIR) string(REGEX REPLACE "[ \t\n]+" "" SYSTEMD_UNIT_DIR "${SYSTEMD_UNIT_DIR}") endif() set(LIBSYSTEMD_INCLUDE_DIRS ${LIBSYSTEMD_INCLUDE_DIR}) set(LIBSYSTEMD_LIBRARIES ${LIBSYSTEMD_LIBRARY}) mark_as_advanced(LIBSYSTEMD_INCLUDE_DIRS LIBSYSTEMD_LIBRARIES) # handle the QUIETLY and REQUIRED arguments and set LIBSYSTEMD_FOUND to TRUE # if all listed variables are TRUE find_package_handle_standard_args(LibSystemd FOUND_VAR LIBSYSTEMD_FOUND REQUIRED_VARS LIBSYSTEMD_LIBRARY LIBSYSTEMD_INCLUDE_DIR SYSTEMD_UNIT_DIR) endif() sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/FindLibYANG.cmake000066400000000000000000000066671515724777400260610ustar00rootroot00000000000000# - Try to find LibYANG # Once done this will define # # LIBYANG_FOUND - system has LibYANG # LIBYANG_INCLUDE_DIRS - the LibYANG include directory # LIBYANG_LIBRARIES - Link these to use LibYANG # LIBYANG_VERSION - SO version of the found libyang library # # Author Michal Vasko # Copyright (c) 2021 CESNET, z.s.p.o. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions # are met: # # 1. Redistributions of source code must retain the copyright # notice, this list of conditions and the following disclaimer. # 2. Redistributions in binary form must reproduce the copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. # 3. The name of the author may not be used to endorse or promote products # derived from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. # IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # include(FindPackageHandleStandardArgs) if(LIBYANG_LIBRARIES AND LIBYANG_INCLUDE_DIRS) # in cache already set(LIBYANG_FOUND TRUE) else() find_path(LIBYANG_INCLUDE_DIR NAMES libyang/libyang.h PATHS /usr/include /usr/local/include /opt/local/include /sw/include ${CMAKE_INCLUDE_PATH} ${CMAKE_INSTALL_PREFIX}/include ) find_library(LIBYANG_LIBRARY NAMES yang libyang PATHS /usr/lib /usr/lib64 /usr/local/lib /usr/local/lib64 /opt/local/lib /sw/lib ${CMAKE_LIBRARY_PATH} ${CMAKE_INSTALL_PREFIX}/lib ) if(LIBYANG_INCLUDE_DIR) find_path(LY_VERSION_PATH "libyang/version.h" HINTS ${LIBYANG_INCLUDE_DIR}) if(LY_VERSION_PATH) file(READ "${LY_VERSION_PATH}/libyang/version.h" LY_VERSION_FILE) else() find_path(LY_HEADER_PATH "libyang/libyang.h" HINTS ${LIBYANG_INCLUDE_DIR}) file(READ "${LY_HEADER_PATH}/libyang/libyang.h" LY_VERSION_FILE) endif() string(REGEX MATCH "#define LY_VERSION \"[0-9]+\\.[0-9]+\\.[0-9]+\"" LY_VERSION_MACRO "${LY_VERSION_FILE}") string(REGEX MATCH "[0-9]+\\.[0-9]+\\.[0-9]+" LIBYANG_VERSION "${LY_VERSION_MACRO}") endif() set(LIBYANG_INCLUDE_DIRS ${LIBYANG_INCLUDE_DIR}) set(LIBYANG_LIBRARIES ${LIBYANG_LIBRARY}) mark_as_advanced(LIBYANG_INCLUDE_DIRS LIBYANG_LIBRARIES) # handle the QUIETLY and REQUIRED arguments and set LIBYANG_FOUND to TRUE # if all listed variables are TRUE find_package_handle_standard_args(LibYANG FOUND_VAR LIBYANG_FOUND REQUIRED_VARS LIBYANG_LIBRARY LIBYANG_INCLUDE_DIR VERSION_VAR LIBYANG_VERSION) endif() sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/FindUncrustify.cmake000066400000000000000000000015201515724777400270260ustar00rootroot00000000000000# - Find uncrustify # Find the uncrustify binary. # # UNCRUSTIFY - path ot the binary # UNCRUSTIFY_VERSION - found version # UNCRUSTIFY_FOUND - True if uncrustify found. include(FindPackageHandleStandardArgs) find_program(UNCRUSTIFY uncrustify) if(UNCRUSTIFY) execute_process(COMMAND ${UNCRUSTIFY} --version OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE VERSION) string(FIND ${VERSION} "-" START_IDX) math(EXPR START_IDX "${START_IDX} + 1") string(SUBSTRING "${VERSION}" ${START_IDX} -1 VERSION) string(FIND ${VERSION} "-" LEN) string(SUBSTRING "${VERSION}" 0 ${LEN} UNCRUSTIFY_VERSION) endif() # Handle the QUIETLY and REQUIRED arguments and set UNCRUSTIFY_FOUND to TRUE if all listed variables are TRUE. find_package_handle_standard_args(Uncrustify REQUIRED_VARS UNCRUSTIFY VERSION_VAR UNCRUSTIFY_VERSION) sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/GenCoverage.cmake000066400000000000000000000105641515724777400262470ustar00rootroot00000000000000# generate test code coverage report # check that coverage tools are available - always use before GEN_COVERAGE macro(GEN_COVERAGE_ENABLE ENABLE_TESTS) # make into normal variable set(TESTS_ENABLED ${ENABLE_TESTS}) set(GEN_COVERAGE_ENABLED ON) if(NOT TESTS_ENABLED) message(WARNING "You cannot generate coverage when tests are disabled. Enable test by additing parameter -DENABLE_BUILD_TESTS=ON or run cmake with Debug build target.") set(GEN_COVERAGE_ENABLED OFF) endif() if(GEN_COVERAGE_ENABLED) find_program(PATH_GCOV NAMES gcov) if(NOT PATH_GCOV) message(WARNING "gcov executable not found! Disabling building code coverage report.") set(GEN_COVERAGE_ENABLED OFF) endif() endif() if(GEN_COVERAGE_ENABLED) find_program(PATH_LCOV NAMES lcov) if(NOT PATH_LCOV) message(WARNING "lcov executable not found! Disabling building code coverage report.") set(GEN_COVERAGE_ENABLED OFF) endif() endif() if(GEN_COVERAGE_ENABLED) find_program(PATH_GENHTML NAMES genhtml) if(NOT PATH_GENHTML) message(WARNING "genhtml executable not found! Disabling building code coverage report.") set(GEN_COVERAGE_ENABLED OFF) endif() endif() if(GEN_COVERAGE_ENABLED) if(NOT CMAKE_COMPILER_IS_GNUCC) message(WARNING "Compiler is not gcc! Coverage may break the tests!") endif() execute_process( COMMAND bash "-c" "${CMAKE_C_COMPILER} --version | head -n1 | sed \"s/.* (.*) \\([0-9]\\+.[0-9]\\+.[0-9]\\+ .*\\)/\\1/\"" OUTPUT_VARIABLE GCC_VERSION_FULL OUTPUT_STRIP_TRAILING_WHITESPACE ) execute_process( COMMAND bash "-c" "${PATH_GCOV} --version | head -n1 | sed \"s/.* (.*) \\([0-9]\\+.[0-9]\\+.[0-9]\\+ .*\\)/\\1/\"" OUTPUT_VARIABLE GCOV_VERSION_FULL OUTPUT_STRIP_TRAILING_WHITESPACE ) if(NOT GCC_VERSION_FULL STREQUAL GCOV_VERSION_FULL) message(WARNING "gcc and gcov versions do not match! Generating coverage may fail with errors.") endif() # add specific required compile flags set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --coverage -fprofile-arcs -ftest-coverage") endif() endmacro() # tests are always expected to be in ${CMAKE_SOURCE_DIR}/tests function(GEN_COVERAGE MATCH_TEST_REGEX EXCLUDE_TEST_REGEX) if(NOT GEN_COVERAGE_ENABLED) return() endif() # destination set(COVERAGE_DIR "${CMAKE_BINARY_DIR}/code_coverage/") set(COVERAGE_FILE_RAW "${CMAKE_BINARY_DIR}/coverage_raw.info") set(COVERAGE_FILE_CLEAN "${CMAKE_BINARY_DIR}/coverage_clean.info") # test match/exclude if(MATCH_TEST_REGEX) set(MATCH_TEST_ARGS -R \"${MATCH_TEST_REGEX}\") endif() if(EXCLUDE_TEST_REGEX) set(EXCLUDE_TEST_ARGS -E \"${EXCLUDE_TEST_REGEX}\") endif() # coverage target add_custom_target(coverage COMMENT "Generating code coverage..." WORKING_DIRECTORY "${CMAKE_BINARY_DIR}" # Cleanup code counters COMMAND "${PATH_LCOV}" --directory . --zerocounters --quiet # Run tests COMMAND "${CMAKE_CTEST_COMMAND}" --quiet ${MATCH_TEST_ARGS} ${EXCLUDE_TEST_ARGS} # Capture the counters COMMAND "${PATH_LCOV}" --directory . --rc lcov_branch_coverage=1 --rc 'lcov_excl_line=assert' --capture --quiet --output-file "${COVERAGE_FILE_RAW}" # Remove coverage of tests, system headers, etc. COMMAND "${PATH_LCOV}" --remove "${COVERAGE_FILE_RAW}" '${CMAKE_SOURCE_DIR}/tests/*' --rc lcov_branch_coverage=1 --quiet --output-file "${COVERAGE_FILE_CLEAN}" # Generate HTML report COMMAND "${PATH_GENHTML}" --branch-coverage --function-coverage --quiet --title "${PROJECT_NAME}" --legend --show-details --output-directory "${COVERAGE_DIR}" "${COVERAGE_FILE_CLEAN}" # Delete the counters COMMAND "${CMAKE_COMMAND}" -E remove ${COVERAGE_FILE_RAW} ${COVERAGE_FILE_CLEAN} ) add_custom_command(TARGET coverage POST_BUILD WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/tests" COMMENT "To see the code coverage report, open ${COVERAGE_DIR}index.html" COMMAND ; ) endfunction() sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/GenDoc.cmake000066400000000000000000000017561515724777400252240ustar00rootroot00000000000000# Prepare building doxygen documentation macro(GEN_DOC INPUT_FILES PROJECT_VERSION PROJECT_DESCRIPTION DOC_LOGO) find_package(Doxygen) if(DOXYGEN_FOUND) find_program(DOT_PATH dot PATH_SUFFIXES graphviz2.38/bin graphviz/bin) if(DOT_PATH) set(HAVE_DOT "YES") else() set(HAVE_DOT "NO") message(AUTHOR_WARNING "Doxygen: to generate UML diagrams please install graphviz") endif() # target doc add_custom_target(doc COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) # generate list with spaces as separators string(REPLACE ";" " " DOXY_INPUT "${INPUT_FILES}") # make other arguments into variables set(PROJECT_VERSION ${PROJECT_VERSION}) set(PROJECT_DESCRIPTION ${PROJECT_DESCRIPTION}) set(DOC_LOGO ${DOC_LOGO}) configure_file(Doxyfile.in Doxyfile) endif() endmacro() sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/SetupPrintedContext.cmake000066400000000000000000000116001515724777400300450ustar00rootroot00000000000000# Configure printed libyang context address. # # The following variables are used: # PRINTED_CONTEXT_ADDRESS - Pre-defined address to use for the printed context mapping, "" if not set, 0 if disabled # # The following cache variables are set: # PRINTED_CONTEXT_ADDRESS - The final address used for printed context mapping # # Behavior: # 1. Checks if MAP_FIXED_NOREPLACE is available on the system # 2. If PRINTED_CONTEXT_ADDRESS is provided, uses that address # 3. If not provided, attempts to calculate address using pctx_addr_calculator.c # 4. If MAP_FIXED_NOREPLACE is unavailable: # - Requires manual PRINTED_CONTEXT_ADDRESS and warns about ASLR # - Falls back to MAP_FIXED with potential undefined behavior # 5. Sets PRINTED_CONTEXT_ADDRESS for use in source code # # Author Roman Janota # Copyright (c) 2025 CESNET, z.s.p.o. # # This source code is licensed under BSD 3-Clause License (the "License"). # You may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://opensource.org/licenses/BSD-3-Clause # function(SETUP_PRINTED_CONTEXT) # get the docstring for the address get_property(PRINTED_CONTEXT_ADDRESS_DOCSTRING CACHE PRINTED_CONTEXT_ADDRESS PROPERTY HELPSTRING) # handle case when MAP_FIXED_NOREPLACE is not available if(NOT HAVE_MAP_FIXED_NOREPLACE) # MAP_FIXED_NOREPLACE is not available, but printed context may still be used with MAP_FIXED if(NOT "${PRINTED_CONTEXT_ADDRESS}" STREQUAL "" AND NOT "${PRINTED_CONTEXT_ADDRESS}" STREQUAL "0") message(WARNING "MAP_FIXED_NOREPLACE not available, but printed context enabled. " "Consider disabling ASLR (Address Space Layout Randomization) to avoid overwriting existing memory mappings.") message(STATUS "Printed context: enabled (using provided address ${PRINTED_CONTEXT_ADDRESS})") else() # no address provided, printed context cannot be used, we can end here message(WARNING "MAP_FIXED_NOREPLACE not available and no valid address provided. " "Provide page-aligned PRINTED_CONTEXT_ADDRESS to use printed context.") message(STATUS "Printed context: disabled") set(PRINTED_CONTEXT_ADDRESS 0 CACHE STRING "${PRINTED_CONTEXT_ADDRESS_DOCSTRING}" FORCE) endif() return() endif() # check if no address is provided if("${PRINTED_CONTEXT_ADDRESS}" STREQUAL "") # calculate printed context address # no point compiling the calculator if sbrk() is not available if (NOT HAVE_SBRK) message(WARNING "sbrk() is required to calculate printed context address, but it is not available. " "Provide PRINTED_CONTEXT_ADDRESS manually to enable printed context.") message(STATUS "Printed context: disabled") set(PRINTED_CONTEXT_ADDRESS 0 CACHE STRING "${PRINTED_CONTEXT_ADDRESS_DOCSTRING}" FORCE) return() endif() # compile and run the address calculator # build tree dir cannot be the same as the main build tree dir on older versions of CMake # see https://cmake.cmake.narkive.com/sRBrNTsf/error-attempt-at-a-recursive-or-nested-try-compile-in-directory try_run(exec_result compile_result ${CMAKE_BINARY_DIR}/CMakeFiles/CMakeTmp "${CMAKE_CURRENT_SOURCE_DIR}/CMakeModules/pctx_addr_calculator.c" COMPILE_OUTPUT_VARIABLE compile_output RUN_OUTPUT_VARIABLE calculated_addr ) if (NOT compile_result) message(WARNING "Failed to compile address calculator:\n${compile_output}\n" "Provide PRINTED_CONTEXT_ADDRESS manually to enable printed context.") message(STATUS "Printed context: disabled") set(PRINTED_CONTEXT_ADDRESS 0 CACHE STRING "${PRINTED_CONTEXT_ADDRESS_DOCSTRING}" FORCE) return() endif() if(exec_result EQUAL 0) # overwrite the cached address set(PRINTED_CONTEXT_ADDRESS ${calculated_addr} CACHE STRING "${PRINTED_CONTEXT_ADDRESS_DOCSTRING}" FORCE) message(STATUS "Printed context: enabled (using generated address ${PRINTED_CONTEXT_ADDRESS})") else() message(WARNING "Address calculator failed to run. " "Provide PRINTED_CONTEXT_ADDRESS manually to enable printed context.") message(STATUS "Printed context: disabled") set(PRINTED_CONTEXT_ADDRESS 0 CACHE STRING "${PRINTED_CONTEXT_ADDRESS_DOCSTRING}" FORCE) endif() elseif("${PRINTED_CONTEXT_ADDRESS}" STREQUAL "0") # address is 0, printed context is disabled message(STATUS "Printed context: disabled") else() # address provided, use it message(STATUS "Printed context: enabled (using provided address ${PRINTED_CONTEXT_ADDRESS})") endif() endfunction() sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/SourceFormat.cmake000066400000000000000000000024371515724777400264730ustar00rootroot00000000000000# format source files with uncrustify # check that format checking is available - always use before SOURCE_FORMAT macro(SOURCE_FORMAT_ENABLE) if(NOT ${ARGC} EQUAL 1) message(FATAL_ERROR "source_format_enable() needs the required Uncrustify version!") endif() find_package(Uncrustify ${ARGV0}) if(UNCRUSTIFY_FOUND) set(SOURCE_FORMAT_ENABLED TRUE) else() set(SOURCE_FORMAT_ENABLED FALSE) endif() endmacro() # files are expected to be a list and relative paths are resolved wtih respect to CMAKE_SOURCE DIR macro(SOURCE_FORMAT) if(NOT ${ARGC}) message(FATAL_ERROR "source_format() needs a list of files to format!") endif() if(SOURCE_FORMAT_ENABLED) add_custom_target(format COMMAND ${UNCRUSTIFY} -c ${CMAKE_SOURCE_DIR}/uncrustify.cfg --no-backup --replace ${ARGN} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} COMMENT "Formating sources with ${UNCRUSTIFY} ...") add_custom_target(format-check COMMAND ${UNCRUSTIFY} -c ${CMAKE_SOURCE_DIR}/uncrustify.cfg --check ${ARGN} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} COMMENT "Checking format of the sources with ${UNCRUSTIFY} ...") set(SOURCE_FORMAT_ENABLED TRUE) endif() endmacro() sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/UseCompat.cmake000066400000000000000000000067201515724777400257610ustar00rootroot00000000000000# - Use compat library providing various functions and macros that may be missing on some systems # Once done this will define # # compatsrc - sources to add to compilation # # Additionally, "compat.h" include directory is added and can be included. # # Author Michal Vasko # Copyright (c) 2021 - 2023 CESNET, z.s.p.o. # # This source code is licensed under BSD 3-Clause License (the "License"). # You may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://opensource.org/licenses/BSD-3-Clause # include(CheckSymbolExists) include(CheckIncludeFile) include(TestBigEndian) if(POLICY CMP0075) cmake_policy(SET CMP0075 NEW) endif() macro(USE_COMPAT) # compatibility checks list(APPEND CMAKE_REQUIRED_DEFINITIONS -D_POSIX_C_SOURCE=200809L) list(APPEND CMAKE_REQUIRED_DEFINITIONS -D_GNU_SOURCE) list(APPEND CMAKE_REQUIRED_DEFINITIONS -D__BSD_VISIBLE=1) check_symbol_exists(clock_gettime "time.h" HAVE_CLOCK) if(NOT HAVE_CLOCK) message(FATAL_ERROR "Missing support for clock_gettime() and similar functions!") endif() set(CMAKE_THREAD_PREFER_PTHREAD TRUE) find_package(Threads) list(APPEND CMAKE_REQUIRED_LIBRARIES ${CMAKE_THREAD_LIBS_INIT}) check_symbol_exists(pthread_mutex_timedlock "pthread.h" HAVE_PTHREAD_MUTEX_TIMEDLOCK) check_symbol_exists(pthread_mutex_clocklock "pthread.h" HAVE_PTHREAD_MUTEX_CLOCKLOCK) check_symbol_exists(pthread_rwlock_clockrdlock "pthread.h" HAVE_PTHREAD_RWLOCK_CLOCKRDLOCK) check_symbol_exists(pthread_rwlock_clockwrlock "pthread.h" HAVE_PTHREAD_RWLOCK_CLOCKWRLOCK) check_symbol_exists(pthread_cond_clockwait "pthread.h" HAVE_PTHREAD_COND_CLOCKWAIT) list(REMOVE_ITEM CMAKE_REQUIRED_LIBRARIES ${CMAKE_THREAD_LIBS_INIT}) if(HAVE_PTHREAD_MUTEX_CLOCKLOCK) # can use CLOCK_MONOTONIC only if we have pthread_mutex_clocklock() check_symbol_exists(CLOCK_MONOTONIC "time.h" HAVE_CLOCK_MONOTONIC) endif() if(HAVE_CLOCK_MONOTONIC) set(COMPAT_CLOCK_ID "CLOCK_MONOTONIC") else() set(COMPAT_CLOCK_ID "CLOCK_REALTIME") endif() check_symbol_exists(vdprintf "stdio.h;stdarg.h" HAVE_VDPRINTF) check_symbol_exists(asprintf "stdio.h" HAVE_ASPRINTF) check_symbol_exists(vasprintf "stdio.h" HAVE_VASPRINTF) check_symbol_exists(getline "stdio.h" HAVE_GETLINE) check_symbol_exists(strndup "string.h" HAVE_STRNDUP) check_symbol_exists(strnstr "string.h" HAVE_STRNSTR) check_symbol_exists(strdupa "string.h" HAVE_STRDUPA) check_symbol_exists(strchrnul "string.h" HAVE_STRCHRNUL) check_symbol_exists(get_current_dir_name "unistd.h" HAVE_GET_CURRENT_DIR_NAME) # for printed context check_symbol_exists(MAP_FIXED_NOREPLACE "sys/mman.h" HAVE_MAP_FIXED_NOREPLACE) check_symbol_exists(sbrk "unistd.h" HAVE_SBRK) test_big_endian(IS_BIG_ENDIAN) check_include_file("stdatomic.h" HAVE_STDATOMIC) check_include_file("alloca.h" HAVE_ALLOCA_H) list(REMOVE_ITEM CMAKE_REQUIRED_DEFINITIONS -D_POSIX_C_SOURCE=200809L) list(REMOVE_ITEM CMAKE_REQUIRED_DEFINITIONS -D_GNU_SOURCE) list(REMOVE_ITEM CMAKE_REQUIRED_DEFINITIONS -D__BSD_VISIBLE=1) # header and source file (adding the source directly allows for hiding its symbols) configure_file(${PROJECT_SOURCE_DIR}/compat/compat.h.in ${PROJECT_BINARY_DIR}/compat/compat.h @ONLY) include_directories(${PROJECT_BINARY_DIR}/compat) set(compatsrc ${PROJECT_SOURCE_DIR}/compat/compat.c) endmacro() sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/pctx_addr_calculator.c000066400000000000000000000050661515724777400274060ustar00rootroot00000000000000/** * @file pcx_addr_calculator.c * @author Roman Janota * @brief Calculator for the memory address to map the printed libyang context to * * Copyright (c) 2025 CESNET, z.s.p.o. * * This source code is licensed under BSD 3-Clause License (the "License"). * You may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://opensource.org/licenses/BSD-3-Clause */ #define _GNU_SOURCE #include #include #include #include #include #include /** * @brief Macro to align an address to the nearest page boundary. * * @param[in] addr The address to align. */ #define PAGE_ALIGNED_ADDR(addr) \ (void *)(((uintptr_t)addr + getpagesize() - 1) & ~(getpagesize() - 1)) /** * @brief Calculates a page-aligned address approximately halfway between the stack and heap. * * @note Assumes that the stack grows downwards and the heap grows upwards and that * the heap is on a lower address than the stack in the process' virtual address space. * * @return uintptr_t The calculated address, or 0 on failure. */ static uintptr_t calculate_mid_stack_heap_address(void) { void *heap_base, *stack_base; struct rlimit stack_limits; uintptr_t midpoint_address; /* get the current heap break address and page align it */ heap_base = sbrk(0); if (heap_base == (void *)-1) { fprintf(stderr, "sbrk(0) failed: %s\n", strerror(errno)); return 0; } heap_base = PAGE_ALIGNED_ADDR(heap_base); /* get the current stack limits */ if (getrlimit(RLIMIT_STACK, &stack_limits)) { fprintf(stderr, "getrlimit failed: %s\n", strerror(errno)); return 0; } /* approximate the stack base address by subtracting the size of the stack from * an address of a variable allocated on the stack and page align it (assuming stack grows down) */ stack_base = (void*)((uintptr_t)&stack_limits - stack_limits.rlim_cur); stack_base = PAGE_ALIGNED_ADDR(stack_base); /* calculate the midpoint address and page align it */ midpoint_address = ((uintptr_t)stack_base + (uintptr_t)heap_base) / 2; midpoint_address = (uintptr_t)PAGE_ALIGNED_ADDR(midpoint_address); return midpoint_address; } int main(void) { uintptr_t address; /* calculate the address */ address = calculate_mid_stack_heap_address(); if (!address) { return 1; } /* print the address to stdout for the cmake module to collect it */ printf("0x%" PRIxPTR, address); return 0; } sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/CMakeModules/uninstall.cmake000066400000000000000000000013041515724777400260630ustar00rootroot00000000000000set(MANIFEST "${CMAKE_CURRENT_BINARY_DIR}/install_manifest.txt") if(NOT EXISTS ${MANIFEST}) message(FATAL_ERROR "Cannot find install manifest: ${MANIFEST}") endif() file(STRINGS ${MANIFEST} files) foreach(file ${files}) if(EXISTS ${file} OR IS_SYMLINK ${file}) message(STATUS "Removing: ${file}") execute_process(COMMAND rm -f ${file} RESULT_VARIABLE result OUTPUT_QUIET ERROR_VARIABLE stderr ERROR_STRIP_TRAILING_WHITESPACE ) if(NOT ${result} EQUAL 0) message(FATAL_ERROR "${stderr}") endif() else() message(STATUS "Does-not-exist: ${file}") endif() endforeach() sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/DB_PLG_PERF.md000066400000000000000000000541701515724777400226750ustar00rootroot00000000000000# Database plugins performance ## Idea Database plugins have been developed to try to improve storage and retrieval of low amounts of data in a high-volume data environment. Sysrepo uses a diff data structure to inform its subscribers about the changes in the data tree, diffs however can also be sent to datastore plugins to help them store these changes. The default plugin `JSON DS file` does not use diff and it instead parses the whole data tree into a JSON format and stores it in the file. Databases on the other hand can be used to store only the changes from the diff and in specific use-cases speed up the whole process. ## Usage In order to rerun performance tests, please feel free to use the Dockerfile below as suggested. ``` docker build --file scripts/db_plg_perf.Dockerfile --tag perf . docker run --rm perf ``` ## Performance **| Options** - Data set size : 1000 - Each test executed : 10 times **| Performance tests** - **JSON DS file** | test name | time | comparison | | --------------------------- | ------------ | ---------- | | get tree | 0.001854 s | 1.000 x | | get item | 0.001778 s | 1.000 x | | get tree hash | 0.001265 s | 1.000 x | | get tree hash cached | 0.000011 s | 1.000 x | | get user ordered tree | 0.000771 s | 1.000 x | | get oper tree | 0.003297 s | 1.000 x | | create batch | 0.004387 s | 1.000 x | | create user ordered items | 0.007394 s | 1.000 x | | create all items | 0.009278 s | 1.000 x | | create all items oper | 0.009828 s | 1.000 x | | many oper change_subs | 0.268622 s | 1.000 x | | remove all items | 0.000290 s | 1.000 x | | remove all items cached | 0.000220 s | 1.000 x | | remove whole subtree | 0.000279 s | 1.000 x | | remove whole subtree cached | 0.000227 s | 1.000 x | | create an item | 0.002188 s | 1.000 x | | create an item cached | 0.001278 s | 1.000 x | | create an item oper | 0.003886 s | 1.000 x | | modify an item | 0.001398 s | 1.000 x | | modify an item cached | 0.000505 s | 1.000 x | | remove an item | 0.001403 s | 1.000 x | | remove an item cached | 0.000508 s | 1.000 x | - **MONGO DS** | test name | time | comparison | | --------------------------- | ------------ | ------------------------- | | get tree | 0.003391 s | $\color{#FF474C}1.829$ x | | get item | 0.004908 s | $\color{#FF474C}2.760$ x | | get tree hash | 0.000210 s | $\color{#08872B}6.023$ x | | get tree hash cached | 0.000091 s | $\color{#FF474C}8.272$ x | | get user ordered tree | 0.002773 s | $\color{#FF474C}3.596$ x | | get oper tree | 0.009505 s | $\color{#FF474C}2.882$ x | | create batch | 0.015844 s | $\color{#FF474C}3.611$ x | | create user ordered items | 0.116348 s | $\color{#FF474C}15.735$ x | | create all items | 0.019848 s | $\color{#FF474C}2.139$ x | | create all items oper | 0.017425 s | $\color{#FF474C}1.772$ x | | many oper change_subs | 0.656261 s | $\color{#FF474C}2.443$ x | | remove all items | 0.005498 s | $\color{#FF474C}18.958$ x | | remove all items cached | 0.005236 s | $\color{#FF474C}23.799$ x | | remove whole subtree | 0.002150 s | $\color{#FF474C}7.706$ x | | remove whole subtree cached | 0.001359 s | $\color{#FF474C}5.986$ x | | create an item | 0.004550 s | $\color{#FF474C}2.079$ x | | create an item cached | 0.000725 s | $\color{#08872B}1.762$ x | | create an item oper | 0.003609 s | $\color{#08872B}1.076$ x | | modify an item | 0.004212 s | $\color{#FF474C}3.012$ x | | modify an item cached | 0.000737 s | $\color{#FF474C}1.459$ x | | remove an item | 0.003979 s | $\color{#FF474C}2.836$ x | | remove an item cached | 0.000465 s | $\color{#08872B}1.092$ x | - **REDIS DS** | test name | time | comparison | | --------------------------- | ------------ | ------------------------- | | get tree | 0.008860 s | $\color{#FF474C}4.778$ x | | get item | 0.011593 s | $\color{#FF474C}6.520$ x | | get tree hash | 0.000079 s | $\color{#08872B}16.012$ x | | get tree hash cached | 0.000055 s | $\color{#FF474C}5.000$ x | | get user ordered tree | 0.010339 s | $\color{#FF474C}13.409$ x | | get oper tree | 0.005808 s | $\color{#FF474C}1.761$ x | | create batch | 0.018640 s | $\color{#FF474C}4.248$ x | | create user ordered items | 0.055091 s | $\color{#FF474C}7.450$ x | | create all items | 0.023312 s | $\color{#FF474C}2.512$ x | | create all items oper | 0.023822 s | $\color{#FF474C}2.423$ x | | many oper change_subs | 0.534279 s | $\color{#FF474C}1.988$ x | | remove all items | 0.001734 s | $\color{#FF474C}5.979$ x | | remove all items cached | 0.000676 s | $\color{#FF474C}3.072$ x | | remove whole subtree | 0.001838 s | $\color{#FF474C}6.587$ x | | remove whole subtree cached | 0.000744 s | $\color{#FF474C}3.277$ x | | create an item | 0.009084 s | $\color{#FF474C}4.151$ x | | create an item cached | 0.000773 s | $\color{#08872B}1.653$ x | | create an item oper | 0.003516 s | $\color{#08872B}1.105$ x | | modify an item | 0.009051 s | $\color{#FF474C}6.474$ x | | modify an item cached | 0.000476 s | $\color{#08872B}1.060$ x | | remove an item | 0.008450 s | $\color{#FF474C}6.022$ x | | remove an item cached | 0.000456 s | $\color{#08872B}1.114$ x | *All comparisons refer to how many times faster (green) or slower (red) the current plugin is compared to the first plugin.* **| Options** - Data set size : 10000 - Each test executed : 10 times **| Performance tests** - **JSON DS file** | test name | time | comparison | | --------------------------- | ------------ | ---------- | | get tree | 0.019634 s | 1.000 x | | get item | 0.017939 s | 1.000 x | | get tree hash | 0.014083 s | 1.000 x | | get tree hash cached | 0.000028 s | 1.000 x | | get user ordered tree | 0.007701 s | 1.000 x | | get oper tree | 0.031657 s | 1.000 x | | create batch | 0.047354 s | 1.000 x | | create user ordered items | 0.090858 s | 1.000 x | | create all items | 0.106988 s | 1.000 x | | create all items oper | 0.111167 s | 1.000 x | | many oper change_subs | 3.713649 s | 1.000 x | | remove all items | 0.003449 s | 1.000 x | | remove all items cached | 0.002566 s | 1.000 x | | remove whole subtree | 0.002902 s | 1.000 x | | remove whole subtree cached | 0.002584 s | 1.000 x | | create an item | 0.023081 s | 1.000 x | | create an item cached | 0.014541 s | 1.000 x | | create an item oper | 0.041899 s | 1.000 x | | modify an item | 0.015329 s | 1.000 x | | modify an item cached | 0.006262 s | 1.000 x | | remove an item | 0.015146 s | 1.000 x | | remove an item cached | 0.005578 s | 1.000 x | - **MONGO DS** | test name | time | comparison | | --------------------------- | ------------ | ------------------------- | | get tree | 0.032961 s | $\color{#FF474C}1.678$ x | | get item | 0.032789 s | $\color{#FF474C}1.827$ x | | get tree hash | 0.000243 s | $\color{#08872B}57.954$ x | | get tree hash cached | 0.000227 s | $\color{#FF474C}8.107$ x | | get user ordered tree | 0.026990 s | $\color{#FF474C}3.504$ x | | get oper tree | 0.034777 s | $\color{#FF474C}1.098$ x | | create batch | 0.151078 s | $\color{#FF474C}3.190$ x | | create user ordered items | 1.323064 s | $\color{#FF474C}14.561$ x | | create all items | 0.218437 s | $\color{#FF474C}2.041$ x | | create all items oper | 0.165269 s | $\color{#FF474C}1.486$ x | | many oper change_subs | 7.151995 s | $\color{#FF474C}1.925$ x | | remove all items | 0.039869 s | $\color{#FF474C}11.559$ x | | remove all items cached | 0.039474 s | $\color{#FF474C}15.383$ x | | remove whole subtree | 0.015050 s | $\color{#FF474C}5.186$ x | | remove whole subtree cached | 0.013198 s | $\color{#FF474C}5.107$ x | | create an item | 0.029860 s | $\color{#FF474C}1.293$ x | | create an item cached | 0.007017 s | $\color{#08872B}2.072$ x | | create an item oper | 0.034413 s | $\color{#08872B}1.217$ x | | modify an item | 0.028166 s | $\color{#FF474C}1.837$ x | | modify an item cached | 0.004840 s | $\color{#08872B}1.293$ x | | remove an item | 0.026894 s | $\color{#FF474C}1.775$ x | | remove an item cached | 0.004642 s | $\color{#08872B}1.201$ x | - **REDIS DS** | test name | time | comparison | | --------------------------- | ------------ | -------------------------- | | get tree | 0.095244 s | $\color{#FF474C}4.850$ x | | get item | 0.093283 s | $\color{#FF474C}5.200$ x | | get tree hash | 0.000123 s | $\color{#08872B}114.495$ x | | get tree hash cached | 0.000153 s | $\color{#FF474C}5.464$ x | | get user ordered tree | 0.148259 s | $\color{#FF474C}19.251$ x | | get oper tree | 0.040969 s | $\color{#FF474C}1.294$ x | | create batch | 0.220800 s | $\color{#FF474C}4.662$ x | | create user ordered items | 0.627265 s | $\color{#FF474C}6.903$ x | | create all items | 0.264463 s | $\color{#FF474C}2.471$ x | | create all items oper | 0.265828 s | $\color{#FF474C}2.391$ x | | many oper change_subs | 5.875323 s | $\color{#FF474C}1.582$ x | | remove all items | 0.021471 s | $\color{#FF474C}6.225$ x | | remove all items cached | 0.007099 s | $\color{#FF474C}2.766$ x | | remove whole subtree | 0.022487 s | $\color{#FF474C}7.748$ x | | remove whole subtree cached | 0.008592 s | $\color{#FF474C}3.325$ x | | create an item | 0.112921 s | $\color{#FF474C}4.892$ x | | create an item cached | 0.008093 s | $\color{#08872B}1.796$ x | | create an item oper | 0.041982 s | $\color{#FF474C}1.001$ x | | modify an item | 0.131935 s | $\color{#FF474C}8.606$ x | | modify an item cached | 0.006567 s | $\color{#FF474C}1.048$ x | | remove an item | 0.113544 s | $\color{#FF474C}7.496$ x | | remove an item cached | 0.006064 s | $\color{#FF474C}1.087$ x | *All comparisons refer to how many times faster (green) or slower (red) the current plugin is compared to the first plugin.* **| Options** - Data set size : 100000 - Each test executed : 10 times **| Performance tests** - **JSON DS file** | test name | time | comparison | | --------------------------- | ------------ | ---------- | | get tree | 0.257987 s | 1.000 x | | get item | 0.214855 s | 1.000 x | | get tree hash | 0.182746 s | 1.000 x | | get tree hash cached | 0.000405 s | 1.000 x | | get user ordered tree | 0.092115 s | 1.000 x | | get oper tree | 0.413835 s | 1.000 x | | create batch | 0.658496 s | 1.000 x | | create user ordered items | 0.964103 s | 1.000 x | | create all items | 1.214159 s | 1.000 x | | create all items oper | 1.233159 s | 1.000 x | | many oper change_subs | 42.937387 s | 1.000 x | | remove all items | 0.036810 s | 1.000 x | | remove all items cached | 0.043710 s | 1.000 x | | remove whole subtree | 0.036970 s | 1.000 x | | remove whole subtree cached | 0.044760 s | 1.000 x | | create an item | 0.262785 s | 1.000 x | | create an item cached | 0.234830 s | 1.000 x | | create an item oper | 0.778777 s | 1.000 x | | modify an item | 0.162250 s | 1.000 x | | modify an item cached | 0.107049 s | 1.000 x | | remove an item | 0.161752 s | 1.000 x | | remove an item cached | 0.105254 s | 1.000 x | - **MONGO DS** | test name | time | comparison | | --------------------------- | ------------ | -------------------------- | | get tree | 0.419329 s | $\color{#FF474C}1.625$ x | | get item | 0.415434 s | $\color{#FF474C}1.933$ x | | get tree hash | 0.000278 s | $\color{#08872B}657.359$ x | | get tree hash cached | 0.003688 s | $\color{#FF474C}9.106$ x | | get user ordered tree | 0.345308 s | $\color{#FF474C}3.748$ x | | get oper tree | 0.432859 s | $\color{#FF474C}1.045$ x | | create batch | 1.749139 s | $\color{#FF474C}2.656$ x | | create user ordered items | 14.456433 s | $\color{#FF474C}14.994$ x | | create all items | 2.360571 s | $\color{#FF474C}1.944$ x | | create all items oper | 1.890673 s | $\color{#FF474C}1.533$ x | | many oper change_subs | 80.463488 s | $\color{#FF474C}1.873$ x | | remove all items | 0.443124 s | $\color{#FF474C}12.038$ x | | remove all items cached | 0.482664 s | $\color{#FF474C}11.042$ x | | remove whole subtree | 0.194736 s | $\color{#FF474C}5.267$ x | | remove whole subtree cached | 0.167887 s | $\color{#FF474C}3.750$ x | | create an item | 0.381125 s | $\color{#FF474C}1.450$ x | | create an item cached | 0.171303 s | $\color{#08872B}1.370$ x | | create an item oper | 0.716619 s | $\color{#08872B}1.086$ x | | modify an item | 0.343846 s | $\color{#FF474C}2.119$ x | | modify an item cached | 0.100483 s | $\color{#08872B}1.065$ x | | remove an item | 0.364858 s | $\color{#FF474C}2.255$ x | | remove an item cached | 0.109074 s | $\color{#FF474C}1.036$ x | - **REDIS DS** | test name | time | comparison | | --------------------------- | ------------ | --------------------------- | | get tree | 1.260671 s | $\color{#FF474C}4.886$ x | | get item | 1.354169 s | $\color{#FF474C}6.302$ x | | get tree hash | 0.000126 s | $\color{#08872B}1450.365$ x | | get tree hash cached | 0.002517 s | $\color{#FF474C}6.214$ x | | get user ordered tree | 1.757068 s | $\color{#FF474C}19.074$ x | | get oper tree | 0.448883 s | $\color{#FF474C}1.084$ x | | create batch | 2.471534 s | $\color{#FF474C}3.753$ x | | create user ordered items | 5.911053 s | $\color{#FF474C}6.131$ x | | create all items | 3.006915 s | $\color{#FF474C}2.476$ x | | create all items oper | 3.160048 s | $\color{#FF474C}2.562$ x | | many oper change_subs | 68.550078 s | $\color{#FF474C}1.596$ x | | remove all items | 0.226741 s | $\color{#FF474C}6.159$ x | | remove all items cached | 0.083266 s | $\color{#FF474C}1.904$ x | | remove whole subtree | 0.222872 s | $\color{#FF474C}6.028$ x | | remove whole subtree cached | 0.093635 s | $\color{#FF474C}2.091$ x | | create an item | 1.344594 s | $\color{#FF474C}5.116$ x | | create an item cached | 0.166586 s | $\color{#08872B}1.409$ x | | create an item oper | 0.694264 s | $\color{#08872B}1.121$ x | | modify an item | 1.245561 s | $\color{#FF474C}7.676$ x | | modify an item cached | 0.108219 s | $\color{#FF474C}1.010$ x | | remove an item | 1.291421 s | $\color{#FF474C}7.983$ x | | remove an item cached | 0.100165 s | $\color{#08872B}1.050$ x | *All comparisons refer to how many times faster (green) or slower (red) the current plugin is compared to the first plugin.* ### Loading - `get tree` retrieves the whole data tree. The XPath used for retrieval is not a Path, so databases cannot use quick prefix match to get the necessary data and have to load all the data. Databases will always be slower since loading a file is faster than loading all of the module's data from the database. - `get item` retrieves one item. Since the XPath used for retrieval is not a Path (much like in the case of `get tree`), databases load all the data. Databases will always be slower here. - `get tree hash` retrieves one item. Since the XPath used for retrieval is a Path, databases load only one item (and parents of this item if any), so the number of items retrieved by the databases is at most the depth of the tree where this item lies. Databases will always be faster from certain amount of items stored (at 1000 they will always be faster). - `get tree hash cached` retrieves one item. No module's data are loaded, everything is cached. Databases will always be slower here, since checking file permissions is much faster than checking the data containing permissions from the database. - `get user ordered items` retrieves the whole data tree. Databases will always be slower since loading a file is faster and the userordered lists and leaflists have to be sorted at the end because databases do not retrieve the data in the correct order. - `get oper tree` retrieves the whole data tree from Operational datastore. No data are loaded, everything is cached. No permissions are checked, speed should be approximately the same. *Note: MongoDB is faster at loading many data at once than Redis, but Redis has faster retrieval of low amounts of data.* ### Storing (big amounts of data) - `create batch` creates a lot of items. Databases should always be slower here. Loading is performed before storing to create a diff (loading is slower). - `create user ordered items` creates a lot of userordered items. Databases should always be much slower here. The changes from the diff have to be applied one by one (without the advantage of bulking/pipelining). Additionaly there are multiple operations per item (not just a simple store). - `create all items` is the same as `create batch`, but the sysrepo data preparation phase takes longer (no sr_edit_batch()). - `create all items oper` creates a lot of items in Operational datastore. Since databases also use diff for Operational datastore, the times are about the same as with `create all items` (the Operational datastore also needs to store metadata for the items, so it should be a little bit slower in this case). - `many oper change_subs` creates and deletes a lot of items. Databases should always be slower. - `remove all items` deletes a lot of items. Databases should always be much slower. Loading is performed before storing. Deleting one item in the database is slower than deleting one item in memory (for `JSON DS file` plugin after loading it into the memory). - `remove all items cached` deletes a lot of items. Databases should always be slower. All data are in cache (no data loading, which is good), but deleting is still slow. - `remove whole subtree` and `remove whole subtree cached` are the same as `remove all items` and `remove all items cached`, but MongoDB has an optimization for deleting a whole subtree (in a form of regex delete), which is faster than a regular delete of lots of items. However databases are still much slower. *Note: MongoDB is faster at creating lots of data than Redis, but slower at deleting them. Also Redis has a much better per item insertion/deletion performance as is apparent from the `create user ordered items`* ### Storing (one item) - `create an item` creates one item. Load is performed to create the diff, so databases are always slower. - `create an item cached` creates one item. Load is not performed. Databases should be faster from certain amount of items stored (at 1000 they will always be faster). - `create an item oper` creates one item in Operational datastore. Databases should be faster from certain amount of items stored, but this depends. - `modify an item` and `remove an item` modifies and deletes one item. Databases are always slower because of loading. - `modify an item cached` and `remove an item cached` modifies and deletes one item. Databases should have a similar performance to `JSON DS file` plugin. Modifying or deleting one item is much easier process than creating one for `JSON DS file` plugin. ### Load is faster with more data, but store is not Loading of one item is much better for more data, because the complexity of other sysrepo processes during load is constant. Storing of one item on the other hand is not. The complexity of data validation during store is linear and so constant times during database store can only speed up the whole process so much. $x$ is time needed for `JSON DS file` store.
$c$ is time needed for database store.
$y$ is time needed for validation.
$\frac{x + y}{c + y}$ is how many times the database plugin is faster than the default `JSON DS file` plugin.
for many items $\frac{x + y}{c + y} \approx \frac{x + y}{y} = \frac{x}{y} + \frac{y}{y} = \frac{x}{y} + 1$ ... as we can see, the final ratio is only influenced by the times of data validation and `JSON DS file` store. If we want to further speed up the process, we need to make the validation process faster. ## Final words Database plugins should only be used when lots of small changes are expected to be made (especially creating one item periodically) and they should only be used on Running datastore using a cached connection, otherwise they will always be slower than the default `JSON DS file` plugin. If unsure, avoid them. sysrepo-2fc5e80f0bb91c52849c6bfd909ceb65aba1c64a/Doxyfile.in000066400000000000000000003207561515724777400226710ustar00rootroot00000000000000# Doxyfile 1.8.11 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv # for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = @PROJECT_NAME@ # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = @PROJECT_VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "@PROJECT_DESCRIPTION@" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = @DOC_LOGO@ # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = ./doc # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = YES # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ is \ provides \ specifies \ contains \ represents \ a \ an \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. ALIASES = asterisk=* # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. For # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = YES # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = YES # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = YES # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = YES # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = @DOXY_INPUT@ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. FILE_PATTERNS = *.c \ *.cc \ *.cxx \ *.cpp \ *.c++ \ *.java \ *.ii \ *.ixx \ *.ipp \ *.i++ \ *.inl \ *.idl \ *.ddl \ *.odl \ *.h \ *.hh \ *.hxx \ *.hpp \ *.h++ \ *.cs \ *.d \ *.php \ *.php4 \ *.php5 \ *.phtml \ *.inc \ *.m \ *.markdown \ *.md \ *.mm \ *.dox \ *.py \ *.f90 \ *.f \ *.for \ *.tcl \ *.vhd \ *.vhdl \ *.ucf \ *.qsf \ *.as \ *.js # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = "./doc" # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see http://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = doc/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = doc/cesnet-style.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: http://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /