pax_global_header00006660000000000000000000000064145666045330014526gustar00rootroot0000000000000052 comment=ab2ab82981d3a1eb054f694e5685373d41a04803 volk-3.1.2/000077500000000000000000000000001456660453300125045ustar00rootroot00000000000000volk-3.1.2/.clang-format000066400000000000000000000056021456660453300150620ustar00rootroot00000000000000--- Language: Cpp # BasedOnStyle: LLVM AccessModifierOffset: -4 AlignAfterOpenBracket: Align AlignConsecutiveAssignments: false AlignConsecutiveDeclarations: false AlignEscapedNewlinesLeft: true AlignOperands: true AlignTrailingComments: true AllowAllParametersOfDeclarationOnNextLine: true AllowShortBlocksOnASingleLine: false AllowShortCaseLabelsOnASingleLine: false AllowShortFunctionsOnASingleLine: All AllowShortIfStatementsOnASingleLine: false AllowShortLoopsOnASingleLine: false AlwaysBreakAfterDefinitionReturnType: None AlwaysBreakAfterReturnType: None AlwaysBreakBeforeMultilineStrings: false AlwaysBreakTemplateDeclarations: true BinPackArguments: false BinPackParameters: false BreakBeforeBraces: Custom BraceWrapping: AfterClass: true AfterControlStatement: false AfterEnum: false AfterFunction: true AfterNamespace: false AfterObjCDeclaration: false AfterStruct: false AfterUnion: false BeforeCatch: false BeforeElse: false IndentBraces: false BreakBeforeBinaryOperators: None BreakBeforeTernaryOperators: true BreakConstructorInitializersBeforeComma: false BreakAfterJavaFieldAnnotations: false BreakStringLiterals: true ColumnLimit: 90 CommentPragmas: '^ IWYU pragma:' ConstructorInitializerAllOnOneLineOrOnePerLine: true ConstructorInitializerIndentWidth: 4 ContinuationIndentWidth: 4 Cpp11BracedListStyle: false DerivePointerAlignment: false DisableFormat: false ExperimentalAutoDetectBinPacking: false ForEachMacros: - foreach - Q_FOREACH - BOOST_FOREACH IncludeCategories: - Regex: '^"(gnuradio)/' Priority: 1 - Regex: '^<(gnuradio)/' Priority: 2 - Regex: '^<(boost)/' Priority: 98 - Regex: '^<[a-z]*>$' Priority: 99 - Regex: '^".*"$' Priority: 0 - Regex: '.*' Priority: 10 IncludeIsMainRegex: '(Test)?$' IndentCaseLabels: false IndentWidth: 4 IndentWrappedFunctionNames: false JavaScriptQuotes: Leave JavaScriptWrapImports: true KeepEmptyLinesAtTheStartOfBlocks: true MacroBlockBegin: '' MacroBlockEnd: '' MaxEmptyLinesToKeep: 2 NamespaceIndentation: None ObjCBlockIndentWidth: 2 ObjCSpaceAfterProperty: false ObjCSpaceBeforeProtocolList: true PenaltyBreakBeforeFirstCallParameter: 19 PenaltyBreakComment: 300 PenaltyBreakFirstLessLess: 120 PenaltyBreakString: 1000 PenaltyExcessCharacter: 1000000 PenaltyReturnTypeOnItsOwnLine: 60 PointerAlignment: Left ReflowComments: true SortIncludes: true SpaceAfterCStyleCast: false SpaceAfterTemplateKeyword: true SpaceBeforeAssignmentOperators: true SpaceBeforeParens: ControlStatements SpaceInEmptyParentheses: false SpacesBeforeTrailingComments: 1 SpacesInAngles: false SpacesInContainerLiterals: true SpacesInCStyleCastParentheses: false SpacesInParentheses: false SpacesInSquareBrackets: false Standard: Cpp11 TabWidth: 8 UseTab: Never volk-3.1.2/.cmake-format.py000066400000000000000000000062521456660453300155070ustar00rootroot00000000000000# Copyright 2021 Marcus Müller, 2024 Johannes Demel # SPDX-License-Identifier: LGPL-3.0-or-later class _clang_format_options: def __init__(self, clangfile=None): if not clangfile: clangfile = ".clang-format" self.lines = [] with open(clangfile, encoding="utf-8") as opened: for line in opened: if line.strip().startswith("#"): continue self.lines.append(line.rstrip().split(":")) def __getitem__(self, string): path = string.split(".") value = None for crumble in path: for line in self.lines: if line[0].strip() == crumble: if len(line) > 1: value = line[1].strip().rstrip() break return value _clang_format = _clang_format_options() # ---------------------------------- # Options affecting listfile parsing # ---------------------------------- with section("parse"): additional_commands = { 'gr_python_install': { 'flags': [], 'kwargs': { "PROGRAMS": "*", "FILES": "*", "DESTINATION": "*" } }, } with section("markup"): first_comment_is_literal = True enable_markup = False with section("format"): # Disable formatting entirely, making cmake-format a no-op disable = False # How wide to allow formatted cmake files line_width = int(_clang_format["ColumnLimit"]) # How many spaces to tab for indent tab_size = int(_clang_format["IndentWidth"]) # If true, lines are indented using tab characters (utf-8 0x09) instead of # space characters (utf-8 0x20). In cases where the layout would # require a fractional tab character, the behavior of the fractional # indentation is governed by use_tabchars = _clang_format["UseTab"] in ("ForIndentation", "ForContinuationAndIndentation", "Always") # If true, separate flow control names from their parentheses with a space separate_ctrl_name_with_space = False # If true, separate function names from parentheses with a space separate_fn_name_with_space = False # If a statement is wrapped to more than one line, than dangle the closing # parenthesis on its own line. dangle_parens = False # If the statement spelling length (including space and parenthesis) is # smaller than this amount, then force reject nested layouts. min_prefix_chars = tab_size # If the statement spelling length (including space and parenthesis) is larger # than the tab width by more than this amount, then force reject un-nested # layouts. max_prefix_chars = 3 * tab_size # What style line endings to use in the output. line_ending = "unix" # Format command names consistently as 'lower' or 'upper' case command_case = "canonical" # Format keywords consistently as 'lower' or 'upper' case keyword_case = "upper" with section("lint"): max_arguments = 6 max_localvars = 20 max_statements = 75 volk-3.1.2/.github/000077500000000000000000000000001456660453300140445ustar00rootroot00000000000000volk-3.1.2/.github/workflows/000077500000000000000000000000001456660453300161015ustar00rootroot00000000000000volk-3.1.2/.github/workflows/android_build.yml000066400000000000000000000042251456660453300214260ustar00rootroot00000000000000# # Copyright 2022 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # name: Build on Android NDK on: [push, pull_request] jobs: build: name: Build on Android NDK ${{ matrix.arch.name }} strategy: fail-fast: false matrix: arch: - { name: armeabi-v7a, allow_fail: false } - { name: arm64-v8a, allow_fail: false } - { name: x86, allow_fail: false } - { name: x86_64, allow_fail: false } runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 with: submodules: 'recursive' - name: Update repositories run: sudo apt update # All dependencies - name: Install dependencies run: sudo apt install -y cmake openjdk-11-jre-headless wget unzip make python3-mako # Setup Android SDK, and auto-accept licenses - name: Install Android SDK run: wget --quiet --output-document=android-sdk.zip https://dl.google.com/android/repository/commandlinetools-linux-8512546_latest.zip && mkdir android-sdk-linux && unzip -qq android-sdk.zip -d android-sdk-linux && export ANDROID_HOME=./android-sdk-linux && echo y | $ANDROID_HOME/cmdline-tools/bin/sdkmanager --sdk_root=android-sdk-linux --update && (echo y; echo y; echo y; echo y; echo y; echo y; echo y; echo y) | $ANDROID_HOME/cmdline-tools/bin/sdkmanager --sdk_root=android-sdk-linux --licenses # Call SDKManager to install the Android NDK - name: Install Android NDK run: $GITHUB_WORKSPACE/android-sdk-linux/cmdline-tools/bin/sdkmanager --sdk_root=$GITHUB_WORKSPACE/android-sdk-linux --install "ndk;24.0.8215888" --channel=3 # Setup build directory - name: Setup ${{ matrix.arch.name }} shell: bash run: cd $GITHUB_WORKSPACE/ && mkdir build && cd build && cmake -DCMAKE_TOOLCHAIN_FILE=$GITHUB_WORKSPACE/android-sdk-linux/ndk/24.0.8215888/build/cmake/android.toolchain.cmake -DANDROID_ABI=${{ matrix.arch.name }} -DANDROID_PLATFORM=android-23 .. # Build - name: Build ${{ matrix.arch.name }} shell: bash run: cd $GITHUB_WORKSPACE/build && make continue-on-error: ${{ matrix.arch.allow_fail }} volk-3.1.2/.github/workflows/check-pr-formatting.yml000066400000000000000000000011201456660453300224620ustar00rootroot00000000000000# # Copyright 2020, 2022 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # name: Check PR Formatting on: push: paths-ignore: - 'tmpl/' - 'include/volk/sse2neon.h' pull_request: paths-ignore: - 'tmpl/' - 'include/volk/sse2neon.h' jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: gnuradio/clang-format-lint-action@v0.5-4 with: source: '.' exclude: './tmpl,./include/volk/sse2neon.h' extensions: 'c,cc,cpp,cxx,h,hh' volk-3.1.2/.github/workflows/publish_docs.yml000066400000000000000000000024671456660453300213130ustar00rootroot00000000000000name: Publish docs on: [push] jobs: build-docs: name: Build VOLK docs runs-on: ubuntu-latest steps: - uses: actions/checkout@v3.1.0 with: submodules: 'recursive' - name: Install dependencies run: sudo apt install python3-mako liborc-dev doxygen - name: Configure run: mkdir build && cd build && cmake -DCMAKE_CXX_FLAGS="-Werror" -DBUILD_EXECUTABLE=ON .. - name: Build run: cmake --build build --target volk_doc - name: Setup SSH Keys env: SSH_AUTH_SOCK: /tmp/ssh_agent.sock run: | ssh-agent -a $SSH_AUTH_SOCK > /dev/null ssh-add - <<< "${{ secrets.SSH_KEY }}" mkdir $HOME/.ssh echo -n "${{ secrets.SSH_KNOWN_HOST }}" > $HOME/.ssh/known_hosts - name: Upload via SSH env: SSH_AUTH_SOCK: /tmp/ssh_agent.sock TARGET_DIR: "${{ github.ref_type }}/${{ github.ref_name }}" run: 'tar -cz build/html/ | ssh ${{ secrets.SSH_USER }}@${{ secrets.SSH_SERVER }} "mkdir -p /www/${{ env.TARGET_DIR }}/$(date +%Y.%m.%d); cd /www/${{ env.TARGET_DIR }}/$(date +%Y.%m.%d); tar --strip-components=2 -xz; rm /www/${{ env.TARGET_DIR }}/live; cd /www/${{ env.TARGET_DIR }}; ln -sf $(date +%Y.%m.%d) live;"' - uses: actions/upload-artifact@v4 with: name: volk_docs path: build/html/ volk-3.1.2/.github/workflows/run-tests.yml000066400000000000000000000214601456660453300205730ustar00rootroot00000000000000# # Copyright 2020 - 2022 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # name: Run VOLK tests on: [push, pull_request] jobs: build-ubuntu: name: Build on ${{ matrix.compiler.distro }} ${{ matrix.compiler.name }} strategy: fail-fast: false matrix: compiler: - { name: g++-7, cc: gcc-7, cxx: g++-7, distro: ubuntu-20.04 } - { name: g++-8, cc: gcc-8, cxx: g++-8, distro: ubuntu-20.04 } - { name: g++-9, cc: gcc-9, cxx: g++-9, distro: ubuntu-latest } - { name: g++-10, cc: gcc-10, cxx: g++-10, distro: ubuntu-latest } - { name: clang-7, cc: clang-7, cxx: clang++-7, distro: ubuntu-20.04 } - { name: clang-8, cc: clang-8, cxx: clang++-8, distro: ubuntu-20.04 } - { name: clang-9, cc: clang-9, cxx: clang++-9, distro: ubuntu-20.04 } - { name: clang-10, cc: clang-10, cxx: clang++-10, distro: ubuntu-20.04 } - { name: clang-11, cc: clang-11, cxx: clang++-11, distro: ubuntu-20.04 } - { name: clang-12, cc: clang-12, cxx: clang++-12, distro: ubuntu-latest } - { name: clang-13, cc: clang-13, cxx: clang++-13, distro: ubuntu-latest } - { name: clang-14, cc: clang-14, cxx: clang++-14, distro: ubuntu-latest } # - { name: clang-15, cc: clang-15, cxx: clang++-15, distro: ubuntu-latest } runs-on: ${{ matrix.compiler.distro }} steps: - uses: actions/checkout@v4 with: submodules: 'recursive' - name: Install dependencies run: sudo apt install python3-mako liborc-dev ${{ matrix.compiler.name }} - name: Configure env: CC: ${{ matrix.compiler.cc }} CXX: ${{ matrix.compiler.cxx }} run: mkdir build && cd build && cmake -DCMAKE_CXX_FLAGS="-Werror" -DBUILD_EXECUTABLE=ON .. - name: Build run: | echo "Build with $(nproc) thread(s)" cmake --build build -j$(nproc) - name: Print info run: | ./build/cpu_features/list_cpu_features ./build/apps/volk-config-info --alignment ./build/apps/volk-config-info --avail-machines ./build/apps/volk-config-info --all-machines ./build/apps/volk-config-info --malloc ./build/apps/volk-config-info --cc - name: Test run: | cd build ctest -V build-ubuntu-arm: # The host should always be linux # see: https://github.com/uraimo/run-on-arch-action runs-on: ubuntu-latest name: Build on ${{ matrix.distro }} ${{ matrix.arch }} ${{ matrix.compiler.name }} # Run steps on a matrix of compilers and possibly archs. strategy: fail-fast: false matrix: include: - arch: aarch64 distro: ubuntu20.04 compiler: { name: g++-8, cc: gcc-8, cxx: g++-8 } - arch: aarch64 distro: ubuntu20.04 compiler: { name: g++-9, cc: gcc-9, cxx: g++-9 } - arch: aarch64 distro: ubuntu20.04 compiler: { name: g++-10, cc: gcc-10, cxx: g++-10 } - arch: aarch64 distro: ubuntu22.04 compiler: { name: g++-12, cc: gcc-12, cxx: g++-12 } - arch: aarch64 distro: ubuntu20.04 compiler: { name: clang-9, cc: clang-9, cxx: clang++-9 } - arch: aarch64 distro: ubuntu20.04 compiler: { name: clang-10, cc: clang-10, cxx: clang++-10 } - arch: aarch64 distro: ubuntu22.04 compiler: { name: clang-14, cc: clang-14, cxx: clang++-14 } - arch: armv7 distro: ubuntu22.04 compiler: { name: g++, cc: gcc, cxx: g++ } cmakeargs: "-DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchains/arm_cortex_a72_hardfp_native.cmake" - arch: ppc64le distro: ubuntu22.04 compiler: { name: g++-12, cc: gcc-12, cxx: g++-12 } - arch: s390x distro: ubuntu22.04 compiler: { name: g++-12, cc: gcc-12, cxx: g++-12 } # It would be really nice to test on Risc-V but that'll take time. - arch: riscv64 distro: ubuntu22.04 compiler: { name: g++-12, cc: gcc-12, cxx: g++-12 } steps: - uses: actions/checkout@v4 with: submodules: 'recursive' - uses: uraimo/run-on-arch-action@v2.5.0 name: Build in non-x86 container id: build with: arch: ${{ matrix.arch }} distro: ${{ matrix.distro }} # Not required, but speeds up builds githubToken: ${{ github.token }} setup: | mkdir -p "${PWD}/build" dockerRunArgs: | --volume "${PWD}:/volk" env: | # YAML, but pipe character is necessary CC: ${{ matrix.compiler.cc }} CXX: ${{ matrix.compiler.cxx }} shell: /bin/sh install: | case "${{ matrix.distro }}" in ubuntu*|jessie|stretch|buster) apt-get update -q -y apt-get install -q -y git cmake python3-mako liborc-dev ${{ matrix.compiler.name }} ;; fedora*) dnf -y update dnf -y install git which ;; esac run: | cd /volk cd build cmake -DCMAKE_CXX_FLAGS="-Werror" -DBUILD_EXECUTABLE=ON ${{ matrix.cmakeargs }} .. echo "Build with $(nproc) thread(s)" make -j$(nproc) if [ -f ./cpu_features/list_cpu_features ]; then ./cpu_features/list_cpu_features fi ./apps/volk-config-info --alignment ./apps/volk-config-info --avail-machines ./apps/volk-config-info --all-machines ./apps/volk-config-info --malloc ./apps/volk-config-info --cc ctest -V build-ubuntu-static: name: Build static on ubuntu-latest runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 with: submodules: 'recursive' - name: dependencies run: sudo apt install python3-mako liborc-dev - name: configure run: mkdir build && cd build && cmake -DENABLE_STATIC_LIBS=True -DBUILD_EXECUTABLE=ON .. - name: build run: cmake --build build -j$(nproc) - name: Print info run: | ./build/cpu_features/list_cpu_features ./build/apps/volk-config-info --alignment ./build/apps/volk-config-info --avail-machines ./build/apps/volk-config-info --all-machines ./build/apps/volk-config-info --malloc ./build/apps/volk-config-info --cc - name: test run: cd build && ctest -V build-windows: runs-on: windows-latest steps: - uses: actions/checkout@v4 with: submodules: 'recursive' - name: dependencies run: pip install mako - name: configure run: mkdir build && cd build && cmake .. - name: build run: cmake --build build --config Release --target INSTALL -j2 - name: test run: cd build && ctest -V -C Release # build-windows-msys2: # name: Build on windows-latest using MinGW and MSYS2 # runs-on: windows-latest # steps: # - uses: msys2/setup-msys2@v2 # with: # update: true # install: >- # base-devel # git # mingw-w64-x86_64-gcc-libs # mingw-w64-x86_64-orc # python # python-mako # python-six # mingw-w64-x86_64-gcc # mingw-w64-x86_64-cmake # - uses: actions/checkout@v2 # - name: Checkout submodules # run: git submodule update --init --recursive # - name: Configure # shell: msys2 {0} # run: mkdir build && cd build && cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 -DCMAKE_CXX_FLAGS="-Werror" .. # - name: Build # shell: msys2 {0} # run: cd build && make -j$(nproc) # - name: Test # shell: msys2 {0} # run: | # cd build # ctest -V build-macos: strategy: matrix: os: [macos-latest, flyci-macos-large-latest-m2] runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@v4 with: submodules: 'recursive' - name: dependencies run: pip3 install mako - name: configure run: mkdir build && cd build && cmake -DBUILD_EXECUTABLE=ON .. - name: build run: cmake --build build --config Debug -j3 - name: Print info run: | ./build/cpu_features/list_cpu_features # ./build/apps/volk-config-info --alignment # ./build/apps/volk-config-info --avail-machines # ./build/apps/volk-config-info --all-machines # ./build/apps/volk-config-info --malloc # ./build/apps/volk-config-info --cc - name: test run: cd build && ctest -V volk-3.1.2/.gitignore000066400000000000000000000000421456660453300144700ustar00rootroot00000000000000*~ *.pyc *.pyo *build*/ archives/ volk-3.1.2/.gitlab-ci.yml000066400000000000000000000020561456660453300151430ustar00rootroot00000000000000# # Copyright 2018 - 2020, 2022 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # # This file is a template, and might need editing before it works on your project. # use the official gcc image, based on debian # can use versions as well, like gcc:5.2 # see https://hub.docker.com/_/gcc/ image: ubuntu:18.04 build: stage: build # instead of calling g++ directly you can also use some build toolkit like make # install the necessary build tools when needed before_script: - apt update && apt -y install make cmake python python-pip && pip install mako script: - mkdir build && cd build && cmake .. && make -j artifacts: paths: - build/ # depending on your build setup it's most likely a good idea to cache outputs to reduce the build time # cache: # paths: # - "*.o" # run tests using the binary built before test: stage: test before_script: - apt update && apt -y install cmake python python-pip && pip install mako script: - cd build && ctest -V volk-3.1.2/.gitmodules000066400000000000000000000001421456660453300146560ustar00rootroot00000000000000[submodule "cpu_features"] path = cpu_features url = https://github.com/google/cpu_features.git volk-3.1.2/.lastrelease000066400000000000000000000000071456660453300150060ustar00rootroot00000000000000v3.1.2 volk-3.1.2/.travis.yml000066400000000000000000000051711456660453300146210ustar00rootroot00000000000000# # Copyright 2018 - 2022 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # language: cpp os: linux dist: bionic addons: apt: packages: &common_packages - python3-mako - liborc-dev env: global: - SDE_VERSION=sde-external-8.50.0-2020-03-26-lin - SDE_URL=http://software.intel.com/content/dam/develop/external/us/en/protected/ matrix: include: # Job 1 ... gcc-7 with Intel SDE - name: Linux x86 Intel SDE GCC 7 env: MATRIX_EVAL="CC=gcc-7 && CXX=g++-7 CMAKE_ARG=-DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchains/intel-sde.cmake" addons: {apt: {sources: "ubuntu-toolchain-r-test", packages: [*common_packages]}} cache: directories: - ${TRAVIS_BUILD_DIR}/cache before_script: - cd ${TRAVIS_BUILD_DIR} && ./scripts/ci/download_intel_sde.sh # Job 4 ... gcc-6 - name: Linux x86 GCC 6 env: MATRIX_EVAL="CC=gcc-6 && CXX=g++-6" addons: {apt: {sources: "ubuntu-toolchain-r-test", packages: [*common_packages, g++-6]}} # Job 7 ... ARMv7 cross compile - name: Linux ARMv7 Qemu GCC 7 env: MATRIX_EVAL="CMAKE_ARG=-DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchains/arm-linux-gnueabihf.cmake" addons: {apt: {sources: "ubuntu-toolchain-r-test", packages: [*common_packages, g++-arm-linux-gnueabihf, qemu-user]}} # Job 8 ... ARMv8 (aarch64) cross compile - name: Linux ARMv8 (aarch64) Qemu GCC 7 env: MATRIX_EVAL="CMAKE_ARG=-DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchains/aarch64-linux-gnu.cmake" addons: {apt: {sources: "ubuntu-toolchain-r-test", packages: [*common_packages, g++-aarch64-linux-gnu, qemu-user]}} # Job 9 ... clang - name: Linux x86 Clang 6 env: MATRIX_EVAL="CC=\"clang -fprofile-instr-generate -fcoverage-mapping\" && CXX=\"clang++ -fprofile-instr-generate -fcoverage-mapping\"" addons: {apt: {packages: [*common_packages, ]}} - name: Linux ARMv8 (aarch64) GCC 7 arch: arm64 env: MATRIX_EVAL="CC=gcc-7 && CXX=g++-7" addons: {apt: {packages: [*common_packages, ]}} - name: Linux ARMv8 (aarch64) Clang 6 arch: arm64 env: MATRIX_EVAL="CC=clang && CXX=clang++" addons: {apt: {packages: [*common_packages, ]}} script: - eval "${MATRIX_EVAL}" - lscpu - git submodule update --init --recursive - mkdir build && cd build - cmake ${CMAKE_ARG} ../ - make - echo $(./apps/volk-config-info --malloc) && echo $(./apps/volk-config-info --alignment) && echo "All compiled VOLK machines:" $(./apps/volk-config-info --all-machines) && echo "Available VOLK machines:" $(./apps/volk-config-info --avail-machines) - ctest -V volk-3.1.2/.zenodo.json000066400000000000000000000133251456660453300147570ustar00rootroot00000000000000{ "title": "Vector-Optimized Library of Kernels (VOLK)", "license": { "id": "LGPL-3.0-or-later" }, "keywords": [ "communication", "software radio", "SDR", "C", "C++", "SIMD", "library" ], "creators": [ { "affiliation": "Department of Communications Engineering, University of Bremen, Germany", "name": "Demel, Johannes", "orcid": "0000-0002-5434-7232" }, { "name": "Dickens, Michael" }, { "name": "Anderson, Douglas" }, { "name": "Ashton, Brennan" }, { "name": "Balister, Philip" }, { "name": "Behar, Doron" }, { "name": "Behnke, Steven" }, { "name": "Bekhit, Amr" }, { "affiliation": "Carnegie Mellon University, IIT Bombay", "name": "Bhowmick, Abhishek" }, { "name": "Blossom, Eric" }, { "name": "Blum, Josh" }, { "name": "Bottoms, A. Maitland" }, { "name": "Briggs, Elliot" }, { "name": "Brighthope, Ashley" }, { "name": "Cardoso, Jeison" }, { "name": "Cercueil, Paul" }, { "affiliation": "Corgan Labs", "name": "Corgan, Johnathan" }, { "affiliation": "Skylark Wireless (@skylarkwireless)", "name": "Corgan, Nicholas" }, { "name": "Cruz, Luigi" }, { "name": "Economos, Ron" }, { "name": "Enochs, Brandon P." }, { "name": "Est\u00e9vez, Daniel" }, { "affiliation": "Centre Tecnol\u00f2gic de Telecomunicacions de Catalunya (CTTC)", "name": "Fernandez, Carles" }, { "name": "Fischer, Moritz" }, { "name": "Foster, Nick" }, { "name": "Geiger, Douglas" }, { "name": "Giard, Pascal" }, { "name": "Goavec-Merou, Gwenhael" }, { "name": "Habets, Thomas" }, { "name": "Hilburn, Ben" }, { "name": "Holguin, Albert" }, { "name": "Iwamoto, Jessica" }, { "name": "Kaesberger, Martin" }, { "name": "Lichtman, Marc" }, { "name": "Logue, Kyle A" }, { "name": "Lundmark, Magnus" }, { "name": "Markgraf, Steve" }, { "name": "Mayer, Christoph" }, { "name": "McCarthy, Nicholas" }, { "name": "McCarthy, Nick" }, { "affiliation": "University of Colorado Boulder", "name": "Miralles, Damian" }, { "name": "Munaut, Sylvain" }, { "name": "M\u00fcller, Marcus" }, { "affiliation": "GCN Development", "name": "Nieboer, Geof" }, { "affiliation": "@deepsig", "name": "O'Shea, Tim" }, { "name": "Olivain, Julien" }, { "name": "Oltmanns, Stefan" }, { "name": "Pinkava, Jiri" }, { "name": "Piscopo, Mike" }, { "name": "Quiceno, Jam M. Hernandez" }, { "name": "Rene, Mathieu" }, { "name": "Rikitake, Kenji" }, { "name": "Ritterhoff, Florian" }, { "name": "Robertson, Dan" }, { "name": "Rocca, Federico 'Larroca' La" }, { "name": "Rode, Andrej" }, { "name": "Rodionov, Andrey" }, { "name": "Roe, Michael" }, { "affiliation": "GNU Radio", "name": "Rondeau, Tom" }, { "name": "Sallay, John" }, { "name": "Sekine, Takehiro" }, { "name": "Semich, Karl" }, { "name": "Sergeev, Vanya" }, { "name": "Slokva, Alexey" }, { "name": "Smith, Clayton" }, { "affiliation": "Medurit AB", "name": "Stigo, Albin" }, { "name": "Thompson, Adam" }, { "name": "Thompson, Roy" }, { "name": "Velichkov, Vasil" }, { "affiliation": "@MITHaystack", "name": "Volz, Ryan" }, { "name": "Walls, Andy" }, { "name": "Ward, Don" }, { "name": "West, Nathan" }, { "name": "Wiedemann, Bernhard M." }, { "name": "Wunsch, Stefan" }, { "name": "Zapodovnikov, Valerii" }, { "name": "\u0160karvada, Jaroslav" }, { "name": "Aang23" }, { "name": "AlexandreRouma" }, { "name": "Andrew" }, { "name": "Zlika" }, { "name": "luz.paz" }, { "name": "rear1019" } ] }volk-3.1.2/CMakeLists.txt000066400000000000000000000352351456660453300152540ustar00rootroot00000000000000# # Copyright 2011-2020 Free Software Foundation, Inc. # Copyright 2023 Magnus Lundmark # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # ######################################################################## # Project setup ######################################################################## cmake_minimum_required(VERSION 3.8) set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} CACHE STRING "Choose build type: None Debug Release RelWithDebInfo MinSizeRel") project(volk) enable_language(CXX) enable_language(C) set(CMAKE_C_STANDARD 11) set(CMAKE_CXX_STANDARD 17) enable_testing() ######################################################################## # Common compile flags ######################################################################## # Disable complex math NaN/INFO range checking for performance include(CheckCXXCompilerFlag) check_cxx_compiler_flag(-fcx-limited-range HAVE_CX_LIMITED_RANGE) if(HAVE_CX_LIMITED_RANGE) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fcx-limited-range") endif(HAVE_CX_LIMITED_RANGE) include(CheckCCompilerFlag) check_c_compiler_flag(-fcx-limited-range HAVE_C_LIMITED_RANGE) if(HAVE_C_LIMITED_RANGE) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fcx-limited-range") endif(HAVE_C_LIMITED_RANGE) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall") set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall") add_definitions(-D_GLIBCXX_USE_CXX11_ABI=1) if(CMAKE_C_COMPILER_ID MATCHES "Clang|GNU") # Abort compilation if kernel implementations have inconsistent function # prototypes, i.e. if # # kernel_foo_sse(uint32_t *dst, lv32fc_t *src) # kernel_foo_avx(uint16_t *dst, lv32fc_t *src) # # are defined. Note the different data type of the first argument). By # default 'incompatible-pointer-types' is a warning only and 'pointer-sign' # is a warning enabled by '-Wall'. These warnings are only applicable to C. set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror=incompatible-pointer-types -Werror=pointer-sign") endif() set(CMAKE_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}) #allows this to be a sub-project set(CMAKE_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}) #allows this to be a sub-project list(INSERT CMAKE_MODULE_PATH 0 ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules )#location for custom "Modules" include(VolkBuildTypes) #select the release build type by default to get optimization flags if(NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE "Release") message(STATUS "Build type not specified: defaulting to release.") endif() volk_check_build_type(${CMAKE_BUILD_TYPE}) set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} CACHE STRING "") message(STATUS "Build type set to ${CMAKE_BUILD_TYPE}.") ######################################################################## # Version setup ######################################################################## set(VERSION_INFO_MAJOR_VERSION 3) set(VERSION_INFO_MINOR_VERSION 1) set(VERSION_INFO_MAINT_VERSION 2) include(VolkVersion) #setup version info math(EXPR VOLK_VERSION_DECIMAL "${VERSION_INFO_MAJOR_VERSION} * 10000 + ${VERSION_INFO_MINOR_VERSION} * 100 + ${VERSION_INFO_MAINT_VERSION}") configure_file(${CMAKE_SOURCE_DIR}/include/volk/volk_version.h.in ${CMAKE_BINARY_DIR}/include/volk/volk_version.h @ONLY) ######################################################################## # Environment setup ######################################################################## if(NOT DEFINED CROSSCOMPILE_MULTILIB) set(CROSSCOMPILE_MULTILIB "") endif() set(CROSSCOMPILE_MULTILIB ${CROSSCOMPILE_MULTILIB} CACHE STRING "Define \"true\" if you have and want to use multiple C development libs installed for cross compile" ) if(MSVC) add_definitions(-D_USE_MATH_DEFINES )#enables math constants on all supported versions of MSVC add_compile_options(/W1) #reduce warnings add_compile_options(/wo4309) add_compile_options(/wd4752) add_compile_options(/wo4273) add_compile_options(/wo4838) endif(MSVC) ######################################################################## # Dependencies setup ######################################################################## # cpu_features - sensible defaults, user settable option if(CMAKE_SYSTEM_PROCESSOR MATCHES "(^mips)|(^arm)|(^aarch64)|(x86_64)|(AMD64|amd64)|(^i.86$)|(^powerpc)|(^ppc)|(^riscv)") option(VOLK_CPU_FEATURES "Volk uses cpu_features" ON) else() option(VOLK_CPU_FEATURES "Volk uses cpu_features" OFF) endif() if(VOLK_CPU_FEATURES) find_package(CpuFeatures QUIET) if(NOT CpuFeatures_FOUND) message( STATUS "cpu_features package not found. Requiring cpu_features submodule ...") if(NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/cpu_features/CMakeLists.txt") message( FATAL_ERROR "cpu_features/CMakeLists.txt not found. Did you forget to git clone recursively?\nFix with: git submodule update --init" ) endif() message(STATUS "Building Volk with cpu_features") set(BUILD_TESTING OFF CACHE BOOL "Build cpu_features without tests." FORCE) set(BUILD_PIC ON CACHE BOOL "Build cpu_features with Position Independent Code (PIC)." FORCE) set(CMAKE_POSITION_INDEPENDENT_CODE ON CACHE BOOL "Build cpu_features with Position Independent Code (PIC)." FORCE) set(BUILD_SHARED_LIBS_SAVED "${BUILD_SHARED_LIBS}") set(BUILD_SHARED_LIBS OFF) set(ENABLE_INSTALL OFF) add_subdirectory(cpu_features) set(BUILD_SHARED_LIBS "${BUILD_SHARED_LIBS_SAVED}") endif() else() message(STATUS "Building Volk without cpu_features") endif() # Python include(VolkPython) #sets PYTHON_EXECUTABLE and PYTHON_DASH_B volk_python_check_module("python >= 3.4" sys "sys.version_info >= (3, 4)" PYTHON_MIN_VER_FOUND) volk_python_check_module("mako >= 0.4.2" mako "mako.__version__ >= '0.4.2'" MAKO_FOUND) if(NOT PYTHON_MIN_VER_FOUND) message(FATAL_ERROR "Python 3.4 or greater required to build VOLK") endif() # Mako if(NOT MAKO_FOUND) message(FATAL_ERROR "Mako templates required to build VOLK") endif() # Check if we have std::filesystem find_package( FILESYSTEM COMPONENTS Final Experimental REQUIRED) set(CMAKE_CXX_EXTENSIONS OFF) set(CMAKE_CXX_STANDARD_REQUIRED ON) ######################################################################## # check for aligned_alloc, since some compilers lack this C11 feature. # For Apple-clang use `posix_memalign` # For MSVC use `_aligned_malloc`. ######################################################################## include(CheckSymbolExists) if(NOT (${CMAKE_SYSTEM_NAME} MATCHES "Darwin")) check_symbol_exists(aligned_alloc stdlib.h USE_ALIGNED_ALLOC) endif() if(NOT USE_ALIGNED_ALLOC) check_symbol_exists(posix_memalign stdlib.h HAVE_POSIX_MEMALIGN) endif() ######################################################################## # Check if Orc is available ######################################################################## option(ENABLE_ORC "Enable Orc" True) if(ENABLE_ORC) find_package(ORC) else(ENABLE_ORC) message(STATUS "Disabling use of ORC") endif(ENABLE_ORC) ######################################################################## # Setup doxygen ######################################################################## add_subdirectory(docs) ######################################################################## # Detect /lib versus /lib64 ######################################################################## include(GNUInstallDirs) ######################################################################## # Setup the package config file ######################################################################## #set variables found in the pc.in file set(prefix ${CMAKE_INSTALL_PREFIX}) set(exec_prefix "\${prefix}") set(libdir "\${exec_prefix}/${CMAKE_INSTALL_LIBDIR}") set(includedir "\${prefix}/include") configure_file(${CMAKE_CURRENT_SOURCE_DIR}/tmpl/volk.pc.in ${CMAKE_CURRENT_BINARY_DIR}/volk.pc @ONLY) install( FILES ${CMAKE_CURRENT_BINARY_DIR}/volk.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig COMPONENT "volk_devel") ######################################################################## # Install all headers in the include directories ######################################################################## set(VOLK_RUNTIME_DIR bin) set(VOLK_LIBRARY_DIR ${CMAKE_INSTALL_LIBDIR}) set(VOLK_INCLUDE_DIR include) install( DIRECTORY ${CMAKE_SOURCE_DIR}/kernels/volk DESTINATION include COMPONENT "volk_devel" FILES_MATCHING PATTERN "*.h") install( FILES ${CMAKE_SOURCE_DIR}/include/volk/volk_prefs.h ${CMAKE_SOURCE_DIR}/include/volk/volk_alloc.hh ${CMAKE_SOURCE_DIR}/include/volk/volk_complex.h ${CMAKE_SOURCE_DIR}/include/volk/volk_common.h ${CMAKE_SOURCE_DIR}/include/volk/saturation_arithmetic.h ${CMAKE_SOURCE_DIR}/include/volk/volk_avx_intrinsics.h ${CMAKE_SOURCE_DIR}/include/volk/volk_avx2_intrinsics.h ${CMAKE_SOURCE_DIR}/include/volk/volk_avx2_fma_intrinsics.h ${CMAKE_SOURCE_DIR}/include/volk/volk_sse_intrinsics.h ${CMAKE_SOURCE_DIR}/include/volk/volk_sse3_intrinsics.h ${CMAKE_SOURCE_DIR}/include/volk/volk_neon_intrinsics.h ${CMAKE_BINARY_DIR}/include/volk/volk.h ${CMAKE_BINARY_DIR}/include/volk/volk_cpu.h ${CMAKE_BINARY_DIR}/include/volk/volk_config_fixed.h ${CMAKE_BINARY_DIR}/include/volk/volk_typedefs.h ${CMAKE_SOURCE_DIR}/include/volk/volk_malloc.h ${CMAKE_BINARY_DIR}/include/volk/volk_version.h ${CMAKE_SOURCE_DIR}/include/volk/constants.h DESTINATION include/volk COMPONENT "volk_devel") ######################################################################## # On Apple only, set install name and use rpath correctly, if not already set ######################################################################## if(APPLE) if(NOT CMAKE_INSTALL_NAME_DIR) set(CMAKE_INSTALL_NAME_DIR ${CMAKE_INSTALL_PREFIX}/${VOLK_LIBRARY_DIR} CACHE PATH "Library Install Name Destination Directory" FORCE) endif(NOT CMAKE_INSTALL_NAME_DIR) if(NOT CMAKE_INSTALL_RPATH) set(CMAKE_INSTALL_RPATH ${CMAKE_INSTALL_PREFIX}/${VOLK_LIBRARY_DIR} CACHE PATH "Library Install RPath" FORCE) endif(NOT CMAKE_INSTALL_RPATH) if(NOT CMAKE_BUILD_WITH_INSTALL_RPATH) set(CMAKE_BUILD_WITH_INSTALL_RPATH ON CACHE BOOL "Do Build Using Library Install RPath" FORCE) endif(NOT CMAKE_BUILD_WITH_INSTALL_RPATH) endif(APPLE) ######################################################################## # Create uninstall target ######################################################################## configure_file(${CMAKE_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake @ONLY) # Only add the target if there isn't one defined already if(NOT TARGET uninstall) add_custom_target(uninstall ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake) endif() ######################################################################## # Install our Cmake modules into $prefix/lib/cmake/volk # See "Package Configuration Files" on page: # http://www.cmake.org/Wiki/CMake/Tutorials/Packaging ######################################################################## configure_file(${CMAKE_SOURCE_DIR}/cmake/Modules/VolkConfig.cmake.in ${CMAKE_BINARY_DIR}/cmake/Modules/VolkConfig.cmake @ONLY) configure_file(${CMAKE_SOURCE_DIR}/cmake/Modules/VolkConfigVersion.cmake.in ${CMAKE_BINARY_DIR}/cmake/Modules/VolkConfigVersion.cmake @ONLY) ######################################################################## # Install cmake search routine for external use ######################################################################## if(NOT CMAKE_MODULES_DIR) set(CMAKE_MODULES_DIR ${CMAKE_INSTALL_LIBDIR}/cmake) endif(NOT CMAKE_MODULES_DIR) install( FILES ${CMAKE_CURRENT_BINARY_DIR}/cmake/Modules/VolkConfig.cmake ${CMAKE_CURRENT_BINARY_DIR}/cmake/Modules/VolkConfigVersion.cmake DESTINATION ${CMAKE_MODULES_DIR}/volk COMPONENT "volk_devel") install( EXPORT VOLK-export FILE VolkTargets.cmake NAMESPACE Volk:: DESTINATION ${CMAKE_MODULES_DIR}/volk) ######################################################################## # Option to enable QA testing, on by default ######################################################################## option(ENABLE_TESTING "Enable QA testing" ON) if(ENABLE_TESTING) message(STATUS "QA Testing is enabled.") else() message(STATUS "QA Testing is disabled.") endif() message(STATUS " Modify using: -DENABLE_TESTING=ON/OFF") ######################################################################## # Option to enable post-build profiling using volk_profile, off by default ######################################################################## option(ENABLE_PROFILING "Launch system profiler after build" OFF) if(ENABLE_PROFILING) if(DEFINED VOLK_CONFIGPATH) get_filename_component(VOLK_CONFIGPATH ${VOLK_CONFIGPATH} ABSOLUTE) set(VOLK_CONFIGPATH "${VOLK_CONFIGPATH}/volk") message(STATUS "System profiling is enabled, using path: ${VOLK_CONFIGPATH}") elseif(DEFINED ENV{VOLK_CONFIGPATH}) set(VOLK_CONFIGPATH "$ENV{VOLK_CONFIGPATH}/volk") message( STATUS "System profiling is enabled, using env path: $ENV{VOLK_CONFIGPATH}") else() message(STATUS "System profiling is enabled with default paths.") if(DEFINED ENV{HOME}) set(VOLK_CONFIGPATH "$ENV{HOME}/.volk") elseif(DEFINED ENV{APPDATA}) set(VOLK_CONFIGPATH "$ENV{APPDATA}/.volk") endif() endif() else() message(STATUS "System profiling is disabled.") endif() message(STATUS " Modify using: -DENABLE_PROFILING=ON/OFF") ######################################################################## # Setup the library ######################################################################## add_subdirectory(lib) ######################################################################## # And the utility apps ######################################################################## add_subdirectory(apps) option(ENABLE_MODTOOL "Enable volk_modtool python utility" True) if(ENABLE_MODTOOL) add_subdirectory(python/volk_modtool) endif() ######################################################################## # Print summary ######################################################################## message(STATUS "Using install prefix: ${CMAKE_INSTALL_PREFIX}") volk-3.1.2/COPYING000066400000000000000000000167441456660453300135530ustar00rootroot00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. volk-3.1.2/README.md000066400000000000000000000152141456660453300137660ustar00rootroot00000000000000[![Build Status](https://travis-ci.com/gnuradio/volk.svg?branch=master)](https://travis-ci.com/gnuradio/volk) [![Build status](https://ci.appveyor.com/api/projects/status/5o56mgw0do20jlh3/branch/master?svg=true)](https://ci.appveyor.com/project/gnuradio/volk/branch/master) ![Check PR Formatting](https://github.com/gnuradio/volk/workflows/Check%20PR%20Formatting/badge.svg) ![Run VOLK tests](https://github.com/gnuradio/volk/workflows/Run%20VOLK%20tests/badge.svg) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3360942.svg)](https://doi.org/10.5281/zenodo.3360942) ![VOLK Logo](/docs/volk_logo.png) # Welcome to VOLK! VOLK is a sub-project of GNU Radio. Please see http://libvolk.org for bug tracking, documentation, source code, and contact information about VOLK. See https://www.gnuradio.org/ for information about GNU Radio. VOLK is the Vector-Optimized Library of Kernels. It is a library that contains kernels of hand-written SIMD code for different mathematical operations. Since each SIMD architecture can be very different and no compiler has yet come along to handle vectorization properly or highly efficiently, VOLK approaches the problem differently. For each architecture or platform that a developer wishes to vectorize for, a new proto-kernel is added to VOLK. At runtime, VOLK will select the correct proto-kernel. In this way, the users of VOLK call a kernel for performing the operation that is platform/architecture agnostic. This allows us to write portable SIMD code. Bleeding edge code can be found in our git repository at https://www.gnuradio.org/git/volk.git/. ## How to use VOLK: For detailed instructions see http://libvolk.org/doxygen/using_volk.html See these steps for a quick build guide. ### Building on most x86 (32-bit and 64-bit) platforms ```bash $ mkdir build $ cd build $ cmake .. $ make $ make test $ sudo make install # You might want to explore "make -j[SOMEVALUE]" options for your multicore CPU. # Perform post-installation steps # Linux OS: Link and cache shared library $ sudo ldconfig # macOS/Windows: Update PATH environment variable to point to lib install location # volk_profile will profile your system so that the best kernel is used $ volk_profile ``` #### Missing submodule We use [cpu_features](https://github.com/google/cpu_features) as a git submodule to detect CPU features, e.g. AVX. There are two options to get the required code: ```bash git clone --recursive https://github.com/gnuradio/volk.git ``` will automatically clone submodules as well. In case you missed that, you can just run: ```bash git submodule update --init --recursive ``` that'll pull in missing submodules. ### Building on Raspberry Pi and other ARM boards (32 bit) To build for these boards you need specify the correct cmake toolchain file for best performance. _Note: There is no need for adding extra options to the compiler for 64 bit._ * Raspberry Pi 4 `arm_cortex_a72_hardfp_native.cmake` * Raspberry Pi 3 `arm_cortex_a53_hardfp_native.cmake` ```bash $ mkdir build && cd build $ cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchains/arm_cortex_a72_hardfp_native.cmake .. # make -j4 might be faster $ make $ make test $ sudo make install # volk_profile will profile your system so that the best kernel is used $ volk_profile ``` ## Code of Conduct We want to make sure everyone feels welcome. Thus, we follow our [Code of Conduct](docs/CODE_OF_CONDUCT.md). ## Contributing We are happy to accept contributions. [Please refer to our contributing guide for further details](docs/CONTRIBUTING.md). Also, make sure to read the [Developer's Certificate of Origin](docs/DCO.txt) and make sure to sign every commit with `git commit -s`. ## Releases and development We maintain a [CHANGELOG](docs/CHANGELOG.md) for every release. Please refer to this file for more detailed information. We follow semantic versioning as outlined in [our versioning guide](docs/versioning.md). ## Supported platforms VOLK aims to be portable to as many platforms as possible. We can only run tests on some platforms. ### Hardware architectures Currently VOLK aims to run with optimized kernels on x86 with SSE/AVX and ARM with NEON. Support for MIPS and RISC-V is experimental; some kernels are known not to work on these architectures. ### OS / Distro We run tests on a variety of Ubuntu versions and aim to support as many current distros as possible. The same goal applies to different OSes. Although this does only rarely happen, it might occur that VOLK does not work on obsolete distros, e.g. Ubuntu 12.04. ### Compilers We want to make sure VOLK works with C/C++ standard compliant compilers. Of course, as an open source project we focus on open source compilers, most notably GCC and Clang. We want to make sure VOLK compiles on a wide variety of compilers. Thus, we target AppleClang and MSVC as well. Mind that MSVC lacks `aligned_alloc` support for aligned arrays. We use MSVC specific instructions in this case which cannot be `free`'d with `free`. ## License **VOLK 3.0 and later are licensed under the GNU Lesser General Public License v3.0 or later (LGPL-3.0-or-later).** ### Previous VOLK version license Earlier versions of VOLK (before VOLK 3.0) were licensed under the GNU General Public License v3.0 or later (GPL-3.0-or-later). Since then, VOLK migrated to the LGPL-3.0-or-later. Being technical: There are 3 people left (out of 74) who we haven't been able to get in contact with (at all), for a total of 4 (out of 1092) commits, 13 (of 282822) additions, and 7 (of 170421) deletions. We have reviewed these commits and all are simple, trivial changes (e.g., 1 line change) and most are no longer relevant (e.g., to a file that no longer exists). Volk maintainers (@michaelld and @jdemel) are in agreement that the combination -- small numbers of changes per committer, simple changes per commit, commits no longer relevant -- means that we can proceed with relicensing without the approval of the folks. We will try reaching out periodically to these folks, but we believe it unlikely we will get a reply. We kindly request them to re-submit their GPL-3.0-or-later license code contributions to LGPL-3.0-or-later by adding their name, GitHub handle, and email address(es) used for VOLK commits to the file [AUTHORS_RESUBMITTING_UNDER_LGPL_LICENSE.md](docs/AUTHORS_RESUBMITTING_UNDER_LGPL_LICENSE.md). ### Legal Matters Some files have been changed many times throughout the years. Copyright notices at the top of source files list which years changes have been made. For some files, changes have occurred in many consecutive years. These files may often have the format of a year range (e.g., "2006 - 2011"), which indicates that these files have had copyrightable changes made during each year in the range, inclusive.volk-3.1.2/apps/000077500000000000000000000000001456660453300134475ustar00rootroot00000000000000volk-3.1.2/apps/CMakeLists.txt000066400000000000000000000051541456660453300162140ustar00rootroot00000000000000# # Copyright 2011-2013 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # ######################################################################## # Setup profiler ######################################################################## # POSIX_MEMALIGN: If we have to fall back to `posix_memalign`. if(HAVE_POSIX_MEMALIGN) message(STATUS "Use `posix_memalign` for aligned malloc!") add_definitions(-DHAVE_POSIX_MEMALIGN) endif(HAVE_POSIX_MEMALIGN) # MAKE volk_profile add_executable( volk_profile ${CMAKE_CURRENT_SOURCE_DIR}/volk_profile.cc ${PROJECT_SOURCE_DIR}/lib/qa_utils.cc ${CMAKE_CURRENT_SOURCE_DIR}/volk_option_helpers.cc) if(MSVC) target_include_directories( volk_profile PRIVATE $) endif(MSVC) target_include_directories( volk_profile PRIVATE $ PRIVATE $ PRIVATE $ PRIVATE $ PRIVATE ${CMAKE_CURRENT_BINARY_DIR} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) add_definitions(-DHAS_STD_FILESYSTEM=1) if(${find_experimental}) add_definitions(-DHAS_STD_FILESYSTEM_EXPERIMENTAL=1) endif() target_link_libraries(volk_profile PRIVATE std::filesystem) if(ENABLE_STATIC_LIBS) target_link_libraries(volk_profile PRIVATE volk_static) set_target_properties(volk_profile PROPERTIES LINK_FLAGS "-static") else() target_link_libraries(volk_profile PRIVATE volk) endif() install( TARGETS volk_profile DESTINATION bin COMPONENT "volk") # MAKE volk-config-info add_executable(volk-config-info volk-config-info.cc ${CMAKE_CURRENT_SOURCE_DIR}/volk_option_helpers.cc) if(ENABLE_STATIC_LIBS) target_link_libraries(volk-config-info volk_static) set_target_properties(volk-config-info PROPERTIES LINK_FLAGS "-static") else() target_link_libraries(volk-config-info volk) endif() install( TARGETS volk-config-info DESTINATION bin COMPONENT "volk") # Launch volk_profile if requested to do so if(ENABLE_PROFILING) if(DEFINED VOLK_CONFIGPATH) set(VOLK_CONFIG_ARG "-p${VOLK_CONFIGPATH}") set(VOLK_CONFIG "${VOLK_CONFIGPATH}/volk_config") endif() add_custom_command( OUTPUT ${VOLK_CONFIG} COMMAND volk_profile "${VOLK_CONFIG_ARG}" DEPENDS volk_profile COMMENT "Launching profiler, this may take a few minutes...") add_custom_target(volk-profile-run ALL DEPENDS ${VOLK_CONFIG}) endif() volk-3.1.2/apps/plot_best_vs_generic.py000077500000000000000000000031221456660453300202210ustar00rootroot00000000000000#!/usr/bin/env python # Copyright 2019 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # # This script is used to compare the generic kernels to the highest performing kernel, for each operation # Run: # ./volk_profile -j volk_results.json # Then run this script under python3 import matplotlib.pyplot as plt import numpy as np import json filename = 'volk_results.json' operations = [] metrics = [] with open(filename) as json_file: data = json.load(json_file) for test in data['volk_tests']: if ('generic' in test['results']) or ('u_generic' in test['results']): # some dont have a generic kernel operations.append(test['name'][5:]) # remove volk_ prefix that they all have extension_performance = [] for key, val in test['results'].items(): if key not in ['generic', 'u_generic']: # exclude generic results, when trying to find fastest time extension_performance.append(val['time']) try: generic_time = test['results']['generic']['time'] except: generic_time = test['results']['u_generic']['time'] metrics.append(extension_performance[np.argmin(extension_performance)]/generic_time) plt.bar(np.arange(len(metrics)), metrics) plt.hlines(1.0, -1, len(metrics), colors='r', linestyles='dashed') plt.axis([-1, len(metrics), 0, 2]) plt.xticks(np.arange(len(operations)), operations, rotation=90) plt.ylabel('Time taken of fastest kernel relative to generic kernel') plt.tight_layout() plt.show() volk-3.1.2/apps/volk-config-info.cc000066400000000000000000000046711456660453300171350ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013, 2016, 2018 Free Software Foundation, Inc. * * This file is part of VOLK * * SPDX-License-Identifier: LGPL-3.0-or-later */ #if HAVE_CONFIG_H #include #endif #include // for volk_available_machines, volk_c_com... #include // for operator<<, endl, cout, ostream #include // for string #include "volk/volk.h" // for volk_get_alignment, volk_get_machine #include "volk_option_helpers.h" // for option_list, option_t void print_alignment() { std::cout << "Alignment in bytes: " << volk_get_alignment() << std::endl; } void print_malloc() { // You don't want to change the volk_malloc code, so just copy the if/else // structure from there and give an explanation for the implementations std::cout << "Used malloc implementation: "; #if HAVE_POSIX_MEMALIGN std::cout << "posix_memalign" << std::endl; #elif defined(_MSC_VER) std::cout << "_aligned_malloc" << std::endl; #else std::cout << "C11 aligned_alloc" << std::endl; #endif } int main(int argc, char** argv) { option_list our_options("volk-config-info"); our_options.add( option_t("prefix", "", "print the VOLK installation prefix", volk_prefix())); our_options.add( option_t("cc", "", "print the VOLK C compiler version", volk_c_compiler())); our_options.add( option_t("cflags", "", "print the VOLK CFLAGS", volk_compiler_flags())); our_options.add(option_t( "all-machines", "", "print VOLK machines built", volk_available_machines())); our_options.add(option_t("avail-machines", "", "print VOLK machines on the current " "platform", volk_list_machines)); our_options.add(option_t("machine", "", "print the current VOLK machine that will be used", volk_get_machine())); our_options.add( option_t("alignment", "", "print the memory alignment", print_alignment)); our_options.add(option_t("malloc", "", "print the malloc implementation used in volk_malloc", print_malloc)); our_options.add(option_t("version", "v", "print the VOLK version", volk_version())); our_options.parse(argc, argv); return 0; } volk-3.1.2/apps/volk_option_helpers.cc000066400000000000000000000200371456660453300200450ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2018-2020 Free Software Foundation, Inc. * * This file is part of VOLK * * SPDX-License-Identifier: LGPL-3.0-or-later */ #include "volk_option_helpers.h" #include // IWYU pragma: keep #include // IWYU pragma: keep #include // IWYU pragma: keep #include // for exception #include // for operator<<, endl, basic_ostream, cout, ostream #include // for pair /* * Option type */ option_t::option_t(std::string t_longform, std::string t_shortform, std::string t_msg, void (*t_callback)()) : longform("--" + t_longform), shortform("-" + t_shortform), msg(t_msg), callback(t_callback) { option_type = VOID_CALLBACK; } option_t::option_t(std::string t_longform, std::string t_shortform, std::string t_msg, void (*t_callback)(int)) : longform("--" + t_longform), shortform("-" + t_shortform), msg(t_msg), callback((void (*)())t_callback) { option_type = INT_CALLBACK; } option_t::option_t(std::string t_longform, std::string t_shortform, std::string t_msg, void (*t_callback)(float)) : longform("--" + t_longform), shortform("-" + t_shortform), msg(t_msg), callback((void (*)())t_callback) { option_type = FLOAT_CALLBACK; } option_t::option_t(std::string t_longform, std::string t_shortform, std::string t_msg, void (*t_callback)(bool)) : longform("--" + t_longform), shortform("-" + t_shortform), msg(t_msg), callback((void (*)())t_callback) { option_type = BOOL_CALLBACK; } option_t::option_t(std::string t_longform, std::string t_shortform, std::string t_msg, void (*t_callback)(std::string)) : longform("--" + t_longform), shortform("-" + t_shortform), msg(t_msg), callback((void (*)())t_callback) { option_type = STRING_CALLBACK; } option_t::option_t(std::string t_longform, std::string t_shortform, std::string t_msg, std::string t_printval) : longform("--" + t_longform), shortform("-" + t_shortform), msg(t_msg), printval(t_printval) { option_type = STRING; } /* * Option List */ option_list::option_list(std::string program_name) : d_program_name(program_name) { d_internal_list = std::vector(); } void option_list::add(option_t opt) { d_internal_list.push_back(opt); } void option_list::parse(int argc, char** argv) { for (int arg_number = 0; arg_number < argc; ++arg_number) { for (std::vector::iterator this_option = d_internal_list.begin(); this_option != d_internal_list.end(); this_option++) { int int_val = INT_MIN; if (this_option->longform == std::string(argv[arg_number]) || this_option->shortform == std::string(argv[arg_number])) { if (d_present_options.count(this_option->longform) == 0) { d_present_options.insert( std::pair(this_option->longform, 1)); } else { d_present_options[this_option->longform] += 1; } switch (this_option->option_type) { case VOID_CALLBACK: this_option->callback(); break; case INT_CALLBACK: try { int_val = atoi(argv[++arg_number]); ((void (*)(int))this_option->callback)(int_val); } catch (std::exception& exc) { std::cout << "An int option can only receive a number" << std::endl; throw std::exception(); }; break; case FLOAT_CALLBACK: try { double double_val = atof(argv[++arg_number]); ((void (*)(float))this_option->callback)(double_val); } catch (std::exception& exc) { std::cout << "A float option can only receive a number" << std::endl; throw std::exception(); }; break; case BOOL_CALLBACK: try { if (arg_number == (argc - 1)) { // this is the last arg int_val = 1; } else { // sneak a look at the next arg since it's present char* next_arg = argv[arg_number + 1]; if ((strncmp(next_arg, "-", 1) == 0) || (strncmp(next_arg, "--", 2) == 0)) { // the next arg is actually an arg, the bool is just // present, set to true int_val = 1; } else if (strncmp(next_arg, "true", 4) == 0) { int_val = 1; } else if (strncmp(next_arg, "false", 5) == 0) { int_val = 0; } else { // we got a number or a string. // convert it to a number and depend on the catch to // report an error condition int_val = (bool)atoi(argv[++arg_number]); } } } catch (std::exception& e) { int_val = INT_MIN; }; if (int_val == INT_MIN) { std::cout << "option: '" << argv[arg_number - 1] << "' -> received an unknown value. Boolean " "options should receive one of '0', '1', 'true', 'false'." << std::endl; throw std::exception(); } else if (int_val) { ((void (*)(bool))this_option->callback)(int_val); } break; case STRING_CALLBACK: try { ((void (*)(std::string))this_option->callback)( argv[++arg_number]); } catch (std::exception& exc) { throw std::exception(); }; break; case STRING: std::cout << this_option->printval << std::endl; break; } } } if (std::string("--help") == std::string(argv[arg_number]) || std::string("-h") == std::string(argv[arg_number])) { d_present_options.insert(std::pair("--help", 1)); help(); } } } bool option_list::present(std::string option_name) { if (d_present_options.count("--" + option_name)) { return true; } else { return false; } } void option_list::help() { std::cout << d_program_name << std::endl; std::cout << " -h [ --help ] \t\tdisplay this help message" << std::endl; for (std::vector::iterator this_option = d_internal_list.begin(); this_option != d_internal_list.end(); this_option++) { std::string help_line(" "); if (this_option->shortform == "-") { help_line += this_option->longform + " "; } else { help_line += this_option->shortform + " [ " + this_option->longform + " ]"; } while (help_line.size() < 32) { help_line += " "; } help_line += this_option->msg; std::cout << help_line << std::endl; } } volk-3.1.2/apps/volk_option_helpers.h000066400000000000000000000035631456660453300177140ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2018-2020 Free Software Foundation, Inc. * * This file is part of VOLK * * SPDX-License-Identifier: LGPL-3.0-or-later */ #ifndef VOLK_VOLK_OPTION_HELPERS_H #define VOLK_VOLK_OPTION_HELPERS_H #include #include #include #include #include typedef enum { VOID_CALLBACK, INT_CALLBACK, BOOL_CALLBACK, STRING_CALLBACK, FLOAT_CALLBACK, STRING, } VOLK_OPTYPE; class option_t { public: option_t(std::string t_longform, std::string t_shortform, std::string t_msg, void (*t_callback)()); option_t(std::string t_longform, std::string t_shortform, std::string t_msg, void (*t_callback)(int)); option_t(std::string t_longform, std::string t_shortform, std::string t_msg, void (*t_callback)(float)); option_t(std::string t_longform, std::string t_shortform, std::string t_msg, void (*t_callback)(bool)); option_t(std::string t_longform, std::string t_shortform, std::string t_msg, void (*t_callback)(std::string)); option_t(std::string t_longform, std::string t_shortform, std::string t_msg, std::string t_printval); std::string longform; std::string shortform; std::string msg; VOLK_OPTYPE option_type; std::string printval; void (*callback)(); }; class option_list { public: option_list(std::string program_name); bool present(std::string option_name); void add(option_t opt); void parse(int argc, char** argv); void help(); private: std::string d_program_name; std::vector d_internal_list; std::map d_present_options; }; #endif // VOLK_VOLK_OPTION_HELPERS_H volk-3.1.2/apps/volk_profile.cc000066400000000000000000000300131456660453300164460ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012-2014 Free Software Foundation, Inc. * * This file is part of VOLK * * SPDX-License-Identifier: LGPL-3.0-or-later */ #if HAS_STD_FILESYSTEM_EXPERIMENTAL #include #else #include #endif #include // for size_t #include // for stat #include // for volk_get_config_path #include // IWYU pragma: keep #include // for operator<<, basic_ostream #include // for map, map<>::iterator #include // for pair #include // for vector, vector<>::const_... #include "kernel_tests.h" // for init_test_list #include "qa_utils.h" // for volk_test_results_t, vol... #include "volk/volk_complex.h" // for lv_32fc_t #include "volk_option_helpers.h" // for option_list, option_t #include "volk_profile.h" #if HAS_STD_FILESYSTEM_EXPERIMENTAL namespace fs = std::experimental::filesystem; #else namespace fs = std::filesystem; #endif volk_test_params_t test_params(1e-6f, 327.f, 131071, 1987, false, ""); void set_benchmark(bool val) { test_params.set_benchmark(val); } void set_tolerance(float val) { test_params.set_tol(val); } void set_vlen(int val) { test_params.set_vlen((unsigned int)val); } void set_iter(int val) { test_params.set_iter((unsigned int)val); } void set_substr(std::string val) { test_params.set_regex(val); } bool update_mode = false; void set_update(bool val) { update_mode = val; } bool dry_run = false; void set_dryrun(bool val) { dry_run = val; } std::string json_filename(""); void set_json(std::string val) { json_filename = val; } std::string volk_config_path(""); void set_volk_config(std::string val) { volk_config_path = val; } int main(int argc, char* argv[]) { option_list profile_options("volk_profile"); profile_options.add( option_t("benchmark", "b", "Run all kernels (benchmark mode)", set_benchmark)); profile_options.add( option_t("tol", "t", "Set the default tolerance for all tests", set_tolerance)); profile_options.add( option_t("vlen", "v", "Set the default vector length for tests", set_vlen)); profile_options.add((option_t( "iter", "i", "Set the default number of test iterations per kernel", set_iter))); profile_options.add( (option_t("tests-substr", "R", "Run tests matching substring", set_substr))); profile_options.add( (option_t("update", "u", "Run only kernels missing from config", set_update))); profile_options.add( (option_t("dry-run", "n", "Dry run. Respect other options, but don't write to file", set_dryrun))); profile_options.add((option_t( "json", "j", "Write results to JSON file named as argument value", set_json))); profile_options.add( (option_t("path", "p", "Specify the volk_config path", set_volk_config))); profile_options.parse(argc, argv); if (profile_options.present("help")) { return 0; } if (dry_run) { std::cout << "Warning: this IS a dry-run. Config will not be written!" << std::endl; } // Adding program options std::ofstream json_file; std::string config_file; if (json_filename != "") { json_file.open(json_filename.c_str()); } if (volk_config_path != "") { config_file = volk_config_path + "/volk_config"; } // Run tests std::vector results; if (update_mode) { if (config_file != "") read_results(&results, config_file); else read_results(&results); } // Initialize the list of tests std::vector test_cases = init_test_list(test_params); // Iterate through list of tests running each one std::string substr_to_match(test_params.kernel_regex()); for (unsigned int ii = 0; ii < test_cases.size(); ++ii) { bool regex_match = true; volk_test_case_t test_case = test_cases[ii]; // if the kernel name matches regex then do the test std::string test_case_name = test_case.name(); if (test_case_name.find(substr_to_match) == std::string::npos) { regex_match = false; } // if we are in update mode check if we've already got results // if we have any, then no need to test that kernel bool update = true; if (update_mode) { for (unsigned int jj = 0; jj < results.size(); ++jj) { if (results[jj].name == test_case.name() || results[jj].name == test_case.puppet_master_name()) { update = false; break; } } } if (regex_match && update) { try { run_volk_tests(test_case.desc(), test_case.kernel_ptr(), test_case.name(), test_case.test_parameters(), &results, test_case.puppet_master_name()); } catch (std::string& error) { std::cerr << "Caught Exception in 'run_volk_tests': " << error << std::endl; } } } // Output results according to provided options if (json_filename != "") { write_json(json_file, results); json_file.close(); } if (!dry_run) { if (config_file != "") write_results(&results, false, config_file); else write_results(&results, false); } else { std::cout << "Warning: this was a dry-run. Config not generated" << std::endl; } return 0; } void read_results(std::vector* results) { char path[1024]; volk_get_config_path(path, true); if (path[0] == 0) { std::cout << "No prior test results found ..." << std::endl; return; } read_results(results, std::string(path)); } void read_results(std::vector* results, std::string path) { struct stat buffer; bool config_status = (stat(path.c_str(), &buffer) == 0); if (config_status) { // a config exists and we are reading results from it std::ifstream config(path.c_str()); char config_line[256]; while (config.getline(config_line, 255)) { // tokenize the input line by kernel_name unaligned aligned // then push back in the results vector with fields filled in std::vector single_kernel_result; std::string config_str(config_line); std::size_t str_size = config_str.size(); std::size_t found = config_str.find(' '); // Split line by spaces while (found && found < str_size) { found = config_str.find(' '); // kernel names MUST be less than 128 chars, which is // a length restricted by volk/volk_prefs.c // on the last token in the parsed string we won't find a space // so make sure we copy at most 128 chars. if (found > 127) { found = 127; } str_size = config_str.size(); char line_buffer[128] = { '\0' }; config_str.copy(line_buffer, found + 1, 0); line_buffer[found] = '\0'; single_kernel_result.push_back(std::string(line_buffer)); config_str.erase(0, found + 1); } if (single_kernel_result.size() == 3) { volk_test_results_t kernel_result; kernel_result.name = std::string(single_kernel_result[0]); kernel_result.config_name = std::string(single_kernel_result[0]); kernel_result.best_arch_u = std::string(single_kernel_result[1]); kernel_result.best_arch_a = std::string(single_kernel_result[2]); results->push_back(kernel_result); } } } } void write_results(const std::vector* results, bool update_result) { char path[1024]; volk_get_config_path(path, false); if (path[0] == 0) { std::cout << "Aborting 'No config save path found' ..." << std::endl; return; } write_results(results, update_result, std::string(path)); } void write_results(const std::vector* results, bool update_result, const std::string path) { // struct stat buffer; // bool config_status = (stat (path.c_str(), &buffer) == 0); /* * These */ const fs::path config_path(path); if (!fs::exists(config_path.parent_path())) { std::cout << "Creating " << config_path.parent_path() << "..." << std::endl; fs::create_directories(config_path.parent_path()); } std::ofstream config; if (update_result) { std::cout << "Updating " << path << "..." << std::endl; config.open(path.c_str(), std::ofstream::app); if (!config.is_open()) { // either we don't have write access or we don't have the // dir yet std::cout << "Error opening file " << path << std::endl; } } else { std::cout << "Writing " << path << "..." << std::endl; config.open(path.c_str()); if (!config.is_open()) { // either we don't have write access or we don't have the // dir yet std::cout << "Error opening file " << path << std::endl; } config << "\ #this file is generated by volk_profile.\n\ #the function name is followed by the preferred architecture.\n\ "; } std::vector::const_iterator profile_results; for (profile_results = results->begin(); profile_results != results->end(); ++profile_results) { config << profile_results->config_name << " " << profile_results->best_arch_a << " " << profile_results->best_arch_u << std::endl; } config.close(); } void write_json(std::ofstream& json_file, std::vector results) { json_file << "{" << std::endl; json_file << " \"volk_tests\": [" << std::endl; size_t len = results.size(); size_t i = 0; std::vector::iterator result; for (result = results.begin(); result != results.end(); ++result) { json_file << " {" << std::endl; json_file << " \"name\": \"" << result->name << "\"," << std::endl; json_file << " \"vlen\": " << (int)(result->vlen) << "," << std::endl; json_file << " \"iter\": " << result->iter << "," << std::endl; json_file << " \"best_arch_a\": \"" << result->best_arch_a << "\"," << std::endl; json_file << " \"best_arch_u\": \"" << result->best_arch_u << "\"," << std::endl; json_file << " \"results\": {" << std::endl; size_t results_len = result->results.size(); size_t ri = 0; std::map::iterator kernel_time_pair; for (kernel_time_pair = result->results.begin(); kernel_time_pair != result->results.end(); ++kernel_time_pair) { volk_test_time_t time = kernel_time_pair->second; json_file << " \"" << time.name << "\": {" << std::endl; json_file << " \"name\": \"" << time.name << "\"," << std::endl; json_file << " \"time\": " << time.time << "," << std::endl; json_file << " \"units\": \"" << time.units << "\"" << std::endl; json_file << " }"; if (ri + 1 != results_len) { json_file << ","; } json_file << std::endl; ri++; } json_file << " }" << std::endl; json_file << " }"; if (i + 1 != len) { json_file << ","; } json_file << std::endl; i++; } json_file << " ]" << std::endl; json_file << "}" << std::endl; } volk-3.1.2/apps/volk_profile.h000066400000000000000000000014351456660453300163160ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012-2014 Free Software Foundation, Inc. * * This file is part of VOLK * * SPDX-License-Identifier: LGPL-3.0-or-later */ #include // for bool #include // for ofstream #include // for string #include // for vector class volk_test_results_t; void read_results(std::vector* results); void read_results(std::vector* results, std::string path); void write_results(const std::vector* results, bool update_result); void write_results(const std::vector* results, bool update_result, const std::string path); void write_json(std::ofstream& json_file, std::vector results); volk-3.1.2/appveyor.yml000066400000000000000000000026171456660453300151020ustar00rootroot00000000000000# # Copyright 2016, 2017, 2019, 2020, 2022 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # image: Visual Studio 2019 cache: - packages -> appveyor.yml environment: environment: matrix: - job_name: VS 16 2019 / python 3.8 APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019 CMAKE_GENERATOR: Visual Studio 16 2019 PYTHON: "C:\\Python38-x64" install: # Prepend the selected Python to the PATH of this build - SET PATH=%PYTHON%;%PYTHON%\Scripts;%PATH% # Display version information about selected python and pip - python --version - python -c "import sys, platform, struct; print(sys.platform, platform.machine(), struct.calcsize('P')*8)" - pip --version - pip install mako before_build: - git submodule update --init --recursive - cmake -G "%CMAKE_GENERATOR%" -A x64 \ -DCMAKE_BUILD_TYPE:STRING=Release -DENABLE_ORC:BOOL=OFF -DENABLE_TESTING:BOOL=ON \ . build_script: - cmake --build . --config Release --target INSTALL test_script: - ctest -V --output-on-failure -C Release after_test: - cd "c:\Program Files" - 7z a "c:\libvolk-x64-%VC_VERSION%.zip" volk - mkdir dlls - cd dlls - 7z a "c:\libvolk-x64-deps-%VC_VERSION%.zip" * - appveyor PushArtifact c:\libvolk-x64-%VC_VERSION%.zip - appveyor PushArtifact c:\libvolk-x64-deps-%VC_VERSION%.zip volk-3.1.2/cmake/000077500000000000000000000000001456660453300135645ustar00rootroot00000000000000volk-3.1.2/cmake/Modules/000077500000000000000000000000001456660453300151745ustar00rootroot00000000000000volk-3.1.2/cmake/Modules/CMakeParseArgumentsCopy.cmake000066400000000000000000000143241456660453300226760ustar00rootroot00000000000000# Copyright 2014, 2018 Free Software Foundation, Inc. # # This file is part of VOLK. # # SPDX-License-Identifier: LGPL-3.0-or-later # # CMAKE_PARSE_ARGUMENTS( args...) # # CMAKE_PARSE_ARGUMENTS() is intended to be used in macros or functions for # parsing the arguments given to that macro or function. # It processes the arguments and defines a set of variables which hold the # values of the respective options. # # The argument contains all options for the respective macro, # i.e. keywords which can be used when calling the macro without any value # following, like e.g. the OPTIONAL keyword of the install() command. # # The argument contains all keywords for this macro # which are followed by one value, like e.g. DESTINATION keyword of the # install() command. # # The argument contains all keywords for this macro # which can be followed by more than one value, like e.g. the TARGETS or # FILES keywords of the install() command. # # When done, CMAKE_PARSE_ARGUMENTS() will have defined for each of the # keywords listed in , and # a variable composed of the given # followed by "_" and the name of the respective keyword. # These variables will then hold the respective value from the argument list. # For the keywords this will be TRUE or FALSE. # # All remaining arguments are collected in a variable # _UNPARSED_ARGUMENTS, this can be checked afterwards to see whether # your macro was called with unrecognized parameters. # # As an example here a my_install() macro, which takes similar arguments as the # real install() command: # # function(MY_INSTALL) # set(options OPTIONAL FAST) # set(oneValueArgs DESTINATION RENAME) # set(multiValueArgs TARGETS CONFIGURATIONS) # cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} ) # ... # # Assume my_install() has been called like this: # my_install(TARGETS foo bar DESTINATION bin OPTIONAL blub) # # After the cmake_parse_arguments() call the macro will have set the following # variables: # MY_INSTALL_OPTIONAL = TRUE # MY_INSTALL_FAST = FALSE (this option was not used when calling my_install() # MY_INSTALL_DESTINATION = "bin" # MY_INSTALL_RENAME = "" (was not used) # MY_INSTALL_TARGETS = "foo;bar" # MY_INSTALL_CONFIGURATIONS = "" (was not used) # MY_INSTALL_UNPARSED_ARGUMENTS = "blub" (no value expected after "OPTIONAL" # # You can the continue and process these variables. # # Keywords terminate lists of values, e.g. if directly after a one_value_keyword # another recognized keyword follows, this is interpreted as the beginning of # the new option. # E.g. my_install(TARGETS foo DESTINATION OPTIONAL) would result in # MY_INSTALL_DESTINATION set to "OPTIONAL", but MY_INSTALL_DESTINATION would # be empty and MY_INSTALL_OPTIONAL would be set to TRUE therefore. #============================================================================= # Copyright 2010 Alexander Neundorf # # Distributed under the OSI-approved BSD License (the "License"); # see accompanying file Copyright.txt for details. # # This software is distributed WITHOUT ANY WARRANTY; without even the # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. # See the License for more information. #============================================================================= # (To distribute this file outside of CMake, substitute the full # License text for the above reference.) if(__CMAKE_PARSE_ARGUMENTS_INCLUDED) return() endif() set(__CMAKE_PARSE_ARGUMENTS_INCLUDED TRUE) function(CMAKE_PARSE_ARGUMENTS prefix _optionNames _singleArgNames _multiArgNames) # first set all result variables to empty/FALSE foreach(arg_name ${_singleArgNames} ${_multiArgNames}) set(${prefix}_${arg_name}) endforeach(arg_name) foreach(option ${_optionNames}) set(${prefix}_${option} FALSE) endforeach(option) set(${prefix}_UNPARSED_ARGUMENTS) set(insideValues FALSE) set(currentArgName) # now iterate over all arguments and fill the result variables foreach(currentArg ${ARGN}) list(FIND _optionNames "${currentArg}" optionIndex )# ... then this marks the end of the arguments belonging to this keyword list(FIND _singleArgNames "${currentArg}" singleArgIndex )# ... then this marks the end of the arguments belonging to this keyword list(FIND _multiArgNames "${currentArg}" multiArgIndex )# ... then this marks the end of the arguments belonging to this keyword if(${optionIndex} EQUAL -1 AND ${singleArgIndex} EQUAL -1 AND ${multiArgIndex} EQUAL -1) if(insideValues) if("${insideValues}" STREQUAL "SINGLE") set(${prefix}_${currentArgName} ${currentArg}) set(insideValues FALSE) elseif("${insideValues}" STREQUAL "MULTI") list(APPEND ${prefix}_${currentArgName} ${currentArg}) endif() else(insideValues) list(APPEND ${prefix}_UNPARSED_ARGUMENTS ${currentArg}) endif(insideValues) else() if(NOT ${optionIndex} EQUAL -1) set(${prefix}_${currentArg} TRUE) set(insideValues FALSE) elseif(NOT ${singleArgIndex} EQUAL -1) set(currentArgName ${currentArg}) set(${prefix}_${currentArgName}) set(insideValues "SINGLE") elseif(NOT ${multiArgIndex} EQUAL -1) set(currentArgName ${currentArg}) set(${prefix}_${currentArgName}) set(insideValues "MULTI") endif() endif() endforeach(currentArg) # propagate the result variables to the caller: foreach(arg_name ${_singleArgNames} ${_multiArgNames} ${_optionNames}) set(${prefix}_${arg_name} ${${prefix}_${arg_name}} PARENT_SCOPE) endforeach(arg_name) set(${prefix}_UNPARSED_ARGUMENTS ${${prefix}_UNPARSED_ARGUMENTS} PARENT_SCOPE) endfunction( CMAKE_PARSE_ARGUMENTS _options _singleArgs _multiArgs) volk-3.1.2/cmake/Modules/FindFILESYSTEM.cmake000066400000000000000000000213001456660453300204570ustar00rootroot00000000000000# Copyright 2019 Free Software Foundation, Inc. # # This file is part of VOLK. # # SPDX-License-Identifier: LGPL-3.0-or-later # # Original code from https://github.com/vector-of-bool/CMakeCM and modified # by C. Fernandez. The original code is distributed under the OSI-approved # BSD 3-Clause License. See https://cmake.org/licensing for details. #[=======================================================================[.rst: FindFILESYSTEM ############## This module supports the C++17 standard library's filesystem utilities. Use the :imp-target:`std::filesystem` imported target to Options ******* The ``COMPONENTS`` argument to this module supports the following values: .. find-component:: Experimental :name: fs.Experimental Allows the module to find the "experimental" Filesystem TS version of the Filesystem library. This is the library that should be used with the ``std::experimental::filesystem`` namespace. .. find-component:: Final :name: fs.Final Finds the final C++17 standard version of the filesystem library. If no components are provided, behaves as if the :find-component:`fs.Final` component was specified. If both :find-component:`fs.Experimental` and :find-component:`fs.Final` are provided, first looks for ``Final``, and falls back to ``Experimental`` in case of failure. If ``Final`` is found, :imp-target:`std::filesystem` and all :ref:`variables ` will refer to the ``Final`` version. Imported Targets **************** .. imp-target:: std::filesystem The ``std::filesystem`` imported target is defined when any requested version of the C++ filesystem library has been found, whether it is *Experimental* or *Final*. If no version of the filesystem library is available, this target will not be defined. .. note:: This target has ``cxx_std_17`` as an ``INTERFACE`` :ref:`compile language standard feature `. Linking to this target will automatically enable C++17 if no later standard version is already required on the linking target. .. _fs.variables: Variables ********* .. variable:: CXX_FILESYSTEM_IS_EXPERIMENTAL Set to ``TRUE`` when the :find-component:`fs.Experimental` version of C++ filesystem library was found, otherwise ``FALSE``. .. variable:: CXX_FILESYSTEM_HAVE_FS Set to ``TRUE`` when a filesystem header was found. .. variable:: CXX_FILESYSTEM_HEADER Set to either ``filesystem`` or ``experimental/filesystem`` depending on whether :find-component:`fs.Final` or :find-component:`fs.Experimental` was found. .. variable:: CXX_FILESYSTEM_NAMESPACE Set to either ``std::filesystem`` or ``std::experimental::filesystem`` depending on whether :find-component:`fs.Final` or :find-component:`fs.Experimental` was found. Examples ******** Using `find_package(FILESYSTEM)` with no component arguments: .. code-block:: cmake find_package(FILESYSTEM REQUIRED) add_executable(my-program main.cpp) target_link_libraries(my-program PRIVATE std::filesystem) #]=======================================================================] if(TARGET std::filesystem) # This module has already been processed. Don't do it again. return() endif() include(CMakePushCheckState) include(CheckIncludeFileCXX) include(CheckCXXSourceCompiles) cmake_push_check_state() set(CMAKE_REQUIRED_QUIET ${FILESYSTEM_FIND_QUIETLY}) # All of our tests require C++17 or later set(OLD_CMAKE_CXX_STANDARD ${CMAKE_CXX_STANDARD}) set(CMAKE_CXX_STANDARD 17) if((CMAKE_CXX_COMPILER_ID STREQUAL "GNU") AND (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER "8.0.0")) if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "8.99") set(UNDEFINED_BEHAVIOR_WITHOUT_LINKING TRUE) endif() set(CMAKE_REQUIRED_FLAGS "-std=c++17") endif() if((CMAKE_CXX_COMPILER_ID STREQUAL "Clang") AND NOT (CMAKE_CXX_COMPILER_VERSION VERSION_LESS "8.99")) set(CMAKE_REQUIRED_FLAGS "-std=c++17") endif() if((CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang") AND NOT (CMAKE_CXX_COMPILER_VERSION VERSION_LESS "11")) set(CMAKE_REQUIRED_FLAGS "-std=c++17") endif() if(MSVC AND NOT (CMAKE_CXX_COMPILER_VERSION VERSION_LESS "18")) set(CMAKE_REQUIRED_FLAGS "/std:c++17") endif() # Normalize and check the component list we were given set(want_components ${FILESYSTEM_FIND_COMPONENTS}) if(FILESYSTEM_FIND_COMPONENTS STREQUAL "") set(want_components Final) endif() # Warn on any unrecognized components set(extra_components ${want_components}) list(REMOVE_ITEM extra_components Final Experimental) foreach(component IN LISTS extra_components) message(WARNING "Extraneous find_package component for FILESYSTEM: ${component}") endforeach() # Detect which of Experimental and Final we should look for set(find_experimental TRUE) set(find_final TRUE) if(NOT "Final" IN_LIST want_components) set(find_final FALSE) endif() if(NOT "Experimental" IN_LIST want_components) set(find_experimental FALSE) endif() if(find_final) check_include_file_cxx("filesystem" _CXX_FILESYSTEM_HAVE_HEADER) mark_as_advanced(_CXX_FILESYSTEM_HAVE_HEADER) if(_CXX_FILESYSTEM_HAVE_HEADER) # We found the non-experimental header. Don't bother looking for the # experimental one. set(find_experimental FALSE) endif() else() set(_CXX_FILESYSTEM_HAVE_HEADER FALSE) endif() if(find_experimental) check_include_file_cxx("experimental/filesystem" _CXX_FILESYSTEM_HAVE_EXPERIMENTAL_HEADER) mark_as_advanced(_CXX_FILESYSTEM_HAVE_EXPERIMENTAL_HEADER) else() set(_CXX_FILESYSTEM_HAVE_EXPERIMENTAL_HEADER FALSE) endif() if(_CXX_FILESYSTEM_HAVE_HEADER) set(_have_fs TRUE) set(_fs_header filesystem) set(_fs_namespace std::filesystem) elseif(_CXX_FILESYSTEM_HAVE_EXPERIMENTAL_HEADER) set(_have_fs TRUE) set(_fs_header experimental/filesystem) set(_fs_namespace std::experimental::filesystem) else() set(_have_fs FALSE) endif() set(CXX_FILESYSTEM_HAVE_FS ${_have_fs} CACHE BOOL "TRUE if we have the C++ filesystem headers") set(CXX_FILESYSTEM_HEADER ${_fs_header} CACHE STRING "The header that should be included to obtain the filesystem APIs") set(CXX_FILESYSTEM_NAMESPACE ${_fs_namespace} CACHE STRING "The C++ namespace that contains the filesystem APIs") set(_found FALSE) if(CXX_FILESYSTEM_HAVE_FS) # We have some filesystem library available. Do link checks string( CONFIGURE [[ #include <@CXX_FILESYSTEM_HEADER@> int main() { auto cwd = @CXX_FILESYSTEM_NAMESPACE@::current_path(); return static_cast(cwd.string().size()); } ]] code @ONLY) # Try to compile a simple filesystem program without any linker flags if(NOT UNDEFINED_BEHAVIOR_WITHOUT_LINKING) check_cxx_source_compiles("${code}" CXX_FILESYSTEM_NO_LINK_NEEDED) set(can_link ${CXX_FILESYSTEM_NO_LINK_NEEDED}) endif() if(NOT CXX_FILESYSTEM_NO_LINK_NEEDED) set(prev_libraries ${CMAKE_REQUIRED_LIBRARIES}) set(CMAKE_REQUIRED_FLAGS "-std=c++17") # Add the libstdc++ flag set(CMAKE_REQUIRED_LIBRARIES ${prev_libraries} -lstdc++fs) check_cxx_source_compiles("${code}" CXX_FILESYSTEM_STDCPPFS_NEEDED) set(can_link ${CXX_FILESYSTEM_STDCPPFS_NEEDED}) if(NOT CXX_FILESYSTEM_STDCPPFS_NEEDED) # Try the libc++ flag set(CMAKE_REQUIRED_LIBRARIES ${prev_libraries} -lc++fs) check_cxx_source_compiles("${code}" CXX_FILESYSTEM_CPPFS_NEEDED) set(can_link ${CXX_FILESYSTEM_CPPFS_NEEDED}) endif() endif() if(can_link) if(CMAKE_VERSION VERSION_LESS 3.12) add_library(std::filesystem INTERFACE IMPORTED GLOBAL) else() add_library(std::filesystem INTERFACE IMPORTED) target_compile_features(std::filesystem INTERFACE cxx_std_17) endif() set(_found TRUE) if(CXX_FILESYSTEM_NO_LINK_NEEDED) # Nothing to add... elseif(CXX_FILESYSTEM_STDCPPFS_NEEDED) target_link_libraries(std::filesystem INTERFACE -lstdc++fs) elseif(CXX_FILESYSTEM_CPPFS_NEEDED) target_link_libraries(std::filesystem INTERFACE -lc++fs) endif() endif() endif() if(NOT ${_found}) set(CMAKE_CXX_STANDARD ${OLD_CMAKE_CXX_STANDARD}) endif() cmake_pop_check_state() set(FILESYSTEM_FOUND ${_found} CACHE BOOL "TRUE if we can compile and link a program using std::filesystem" FORCE) if(FILESYSTEM_FIND_REQUIRED AND NOT FILESYSTEM_FOUND) message(FATAL_ERROR "Cannot compile a simple program using std::filesystem") endif() volk-3.1.2/cmake/Modules/FindORC.cmake000066400000000000000000000030411456660453300174200ustar00rootroot00000000000000# Copyright 2014, 2019, 2020 Free Software Foundation, Inc. # # This file is part of VOLK. # # SPDX-License-Identifier: LGPL-3.0-or-later # find_package(PkgConfig) pkg_check_modules(PC_ORC "orc-0.4 > 0.4.11") include(GNUInstallDirs) find_program( ORCC_EXECUTABLE orcc HINTS ${PC_ORC_TOOLSDIR} PATHS ${ORC_ROOT}/bin ${CMAKE_INSTALL_PREFIX}/bin) find_path( ORC_INCLUDE_DIR NAMES orc/orc.h HINTS ${PC_ORC_INCLUDEDIR} PATHS ${ORC_ROOT}/include ${CMAKE_INSTALL_PREFIX}/include PATH_SUFFIXES orc-0.4) find_path( ORC_LIBRARY_DIR NAMES ${CMAKE_SHARED_LIBRARY_PREFIX}orc-0.4${CMAKE_SHARED_LIBRARY_SUFFIX} HINTS ${PC_ORC_LIBDIR} PATHS ${ORC_ROOT}/${CMAKE_INSTALL_LIBDIR} ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}) find_library( ORC_LIB orc-0.4 HINTS ${PC_ORC_LIBRARY_DIRS} PATHS ${ORC_ROOT}/${CMAKE_INSTALL_LIBDIR} ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}) find_library( ORC_LIBRARY_STATIC liborc-0.4.a HINTS ${PC_ORC_LIBRARY_DIRS} PATHS ${ORC_ROOT}/${CMAKE_INSTALL_LIBDIR} ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}) list(APPEND ORC_LIBRARY ${ORC_LIB}) set(ORC_INCLUDE_DIRS ${ORC_INCLUDE_DIR}) set(ORC_LIBRARIES ${ORC_LIBRARY}) set(ORC_LIBRARY_DIRS ${ORC_LIBRARY_DIR}) set(ORC_LIBRARIES_STATIC ${ORC_LIBRARY_STATIC}) include(FindPackageHandleStandardArgs) find_package_handle_standard_args(ORC "orc files" ORC_LIBRARY ORC_INCLUDE_DIR ORCC_EXECUTABLE) mark_as_advanced(ORC_INCLUDE_DIR ORC_LIBRARY ORCC_EXECUTABLE) volk-3.1.2/cmake/Modules/VolkAddTest.cmake000066400000000000000000000205031456660453300203620ustar00rootroot00000000000000# Copyright 2015 Free Software Foundation, Inc. # # This file is part of VOLK. # # SPDX-License-Identifier: LGPL-3.0-or-later # if(DEFINED __INCLUDED_VOLK_ADD_TEST) return() endif() set(__INCLUDED_VOLK_ADD_TEST TRUE) ######################################################################## # Generate a test executable which can be used in ADD_TEST to call # various subtests. # # SOURCES - sources for the test # TARGET_DEPS - build target dependencies (e.g., libraries) ######################################################################## function(VOLK_GEN_TEST executable_name) include(CMakeParseArgumentsCopy) cmake_parse_arguments(VOLK_TEST "" "" "SOURCES;TARGET_DEPS;EXTRA_LIB_DIRS;ENVIRONS;ARGS" ${ARGN}) add_executable(${executable_name} ${VOLK_TEST_SOURCES}) target_link_libraries(${executable_name} ${VOLK_TEST_TARGET_DEPS}) endfunction() ######################################################################## # Add a unit test and setup the environment for it. # Encloses ADD_TEST, with additional functionality to create a shell # script that sets the environment to gain access to in-build binaries # properly. The following variables are used to pass in settings: # A test executable has to be generated with VOLK_GEN_TEST beforehand. # The executable name has to be passed as argument. # # NAME - the test name # TARGET_DEPS - build target dependencies (e.g., libraries) # EXTRA_LIB_DIRS - other directories for the library path # ENVIRONS - other environment key/value pairs # ARGS - arguments for the test ######################################################################## function(VOLK_ADD_TEST test_name executable_name) #parse the arguments for component names include(CMakeParseArgumentsCopy) cmake_parse_arguments(VOLK_TEST "" "" "TARGET_DEPS;EXTRA_LIB_DIRS;ENVIRONS;ARGS" ${ARGN}) #set the initial environs to use set(environs ${VOLK_TEST_ENVIRONS}) #create the initial library path file(TO_NATIVE_PATH "${VOLK_TEST_EXTRA_LIB_DIRS}" libpath) #set the source directory, which is mostly FYI file(TO_NATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR} srcdir) list(APPEND environs "srcdir=\"${srcdir}\"") #http://www.cmake.org/pipermail/cmake/2009-May/029464.html #Replaced this add test + set environs code with the shell script generation. #Its nicer to be able to manually run the shell script to diagnose problems. if(UNIX) if(APPLE) set(LD_PATH_VAR "DYLD_LIBRARY_PATH") else() set(LD_PATH_VAR "LD_LIBRARY_PATH") endif() #create a list of target directories to be determined by the #"add_test" command, via the $ operator; make sure the #test's directory is first, since it ($1) is prepended to PATH. unset(TARGET_DIR_LIST) foreach(target ${executable_name} ${VOLK_TEST_TARGET_DEPS}) list(APPEND TARGET_DIR_LIST "\$") endforeach() #augment the PATH to start with the directory of the test set(binpath "\"$1:\$PATH\"") list(APPEND environs "PATH=${binpath}") #set the shell to use if(CMAKE_CROSSCOMPILING) set(SHELL "/bin/sh") else() find_program(SHELL sh) endif() #check to see if the shell supports "$*" expansion with IFS if(NOT TESTED_SHELL_SUPPORTS_IFS) set(TESTED_SHELL_SUPPORTS_IFS TRUE CACHE BOOL "") set(sh_file ${CMAKE_CURRENT_BINARY_DIR}/ifs_test.sh) file(WRITE ${sh_file} "#!${SHELL}\n") file(APPEND ${sh_file} "export IFS=:\n") file(APPEND ${sh_file} "echo \"$*\"\n") #make the shell file executable execute_process(COMMAND chmod +x ${sh_file}) #execute the shell script execute_process( COMMAND ${sh_file} "a" "b" "c" OUTPUT_VARIABLE output OUTPUT_STRIP_TRAILING_WHITESPACE) #check the output to see if it is correct string(COMPARE EQUAL ${output} "a:b:c" SHELL_SUPPORTS_IFS) set(SHELL_SUPPORTS_IFS ${SHELL_SUPPORTS_IFS} CACHE BOOL "Set this value to TRUE if the shell supports IFS argument expansion") endif() unset(testlibpath) if(SHELL_SUPPORTS_IFS) #"$*" expands in the shell into a list of all of the arguments #to the shell script, concatenated using the character provided #in ${IFS}. list(APPEND testlibpath "$*") else() #shell does not support IFS expansion; use a loop instead list(APPEND testlibpath "\${LL}") endif() #finally: add in the current library path variable list(INSERT libpath 0 ${testlibpath}) list(APPEND libpath "$${LD_PATH_VAR}") #replace list separator with the path separator string(REPLACE ";" ":" libpath "${libpath}") list(APPEND environs "${LD_PATH_VAR}=\"${libpath}\"") #generate a shell script file that sets the environment and runs the test set(sh_file ${CMAKE_CURRENT_BINARY_DIR}/${test_name}_test.sh) file(WRITE ${sh_file} "#!${SHELL}\n") if(SHELL_SUPPORTS_IFS) file(APPEND ${sh_file} "export IFS=:\n") else() file(APPEND ${sh_file} "LL=\"$1\" && for tf in \"\$@\"; do LL=\"\${LL}:\${tf}\"; done\n") endif() #each line sets an environment variable foreach(environ ${environs}) file(APPEND ${sh_file} "export ${environ}\n") endforeach(environ) set(VOLK_TEST_ARGS "${test_name}") #redo the test args to have a space between each string(REPLACE ";" " " VOLK_TEST_ARGS "${VOLK_TEST_ARGS}") #finally: append the test name to execute file(APPEND ${sh_file} "${CMAKE_CROSSCOMPILING_EMULATOR} ${executable_name} ${VOLK_TEST_ARGS}\n") #make the shell file executable execute_process(COMMAND chmod +x ${sh_file}) #add the shell file as the test to execute; #use the form that allows for $ substitutions, #then combine the script arguments inside the script. add_test(NAME qa_${test_name} COMMAND ${SHELL} ${sh_file} ${TARGET_DIR_LIST}) endif(UNIX) if(WIN32) #In the land of windows, all libraries must be in the PATH. Since #the dependent libraries are not yet installed, we must manually #set them in the PATH to run tests. The following appends the #path of a target dependency. # #create a list of target directories to be determined by the #"add_test" command, via the $ operator; make sure the #test's directory is first, since it ($1) is prepended to PATH. unset(TARGET_DIR_LIST) foreach(target ${executable_name} ${VOLK_TEST_TARGET_DEPS}) list(APPEND TARGET_DIR_LIST "$") endforeach() #replace list separator with the path separator (escaped) string(REPLACE ";" "\\\\;" TARGET_DIR_LIST "${TARGET_DIR_LIST}") #add command line argument (TARGET_DIR_LIST) to path and append current path list(INSERT libpath 0 "%1") list(APPEND libpath "%PATH%") #replace list separator with the path separator (escaped) string(REPLACE ";" "\\;" libpath "${libpath}") list(APPEND environs "PATH=${libpath}") #generate a bat file that sets the environment and runs the test set(bat_file ${CMAKE_CURRENT_BINARY_DIR}/${test_name}_test.bat) file(WRITE ${bat_file} "@echo off\n") #each line sets an environment variable foreach(environ ${environs}) file(APPEND ${bat_file} "SET ${environ}\n") endforeach(environ) set(VOLK_TEST_ARGS "${test_name}") #redo the test args to have a space between each string(REPLACE ";" " " VOLK_TEST_ARGS "${VOLK_TEST_ARGS}") #finally: append the test name to execute file(APPEND ${bat_file} "${executable_name} ${VOLK_TEST_ARGS}\n") file(APPEND ${bat_file} "\n") add_test(NAME qa_${test_name} COMMAND ${bat_file} ${TARGET_DIR_LIST}) endif(WIN32) endfunction(VOLK_ADD_TEST) volk-3.1.2/cmake/Modules/VolkBuildTypes.cmake000066400000000000000000000204071456660453300211210ustar00rootroot00000000000000# Copyright 2014 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # if(DEFINED __INCLUDED_VOLK_BUILD_TYPES_CMAKE) return() endif() set(__INCLUDED_VOLK_BUILD_TYPES_CMAKE TRUE) # Standard CMake Build Types and their basic CFLAGS: # - None: nothing set # - Debug: -O2 -g # - Release: -O3 # - RelWithDebInfo: -O3 -g # - MinSizeRel: -Os # Additional Build Types, defined below: # - NoOptWithASM: -O0 -g -save-temps # - O2WithASM: -O2 -g -save-temps # - O3WithASM: -O3 -g -save-temps # - DebugParanoid -O0 -g -Werror # Defines the list of acceptable cmake build types. When adding a new # build type below, make sure to add it to this list. list( APPEND AVAIL_BUILDTYPES None Debug Release RelWithDebInfo MinSizeRel DebugParanoid NoOptWithASM O2WithASM O3WithASM ASAN) ######################################################################## # VOLK_CHECK_BUILD_TYPE(build type) # # Use this to check that the build type set in CMAKE_BUILD_TYPE on the # commandline is one of the valid build types used by this project. It # checks the value set in the cmake interface against the list of # known build types in AVAIL_BUILDTYPES. If the build type is found, # the function exits immediately. If nothing is found by the end of # checking all available build types, we exit with an error and list # the available build types. ######################################################################## function(VOLK_CHECK_BUILD_TYPE settype) string(TOUPPER ${settype} _settype) foreach(btype ${AVAIL_BUILDTYPES}) string(TOUPPER ${btype} _btype) if(${_settype} STREQUAL ${_btype}) return() # found it; exit cleanly endif(${_settype} STREQUAL ${_btype}) endforeach(btype) # Build type not found; error out message( FATAL_ERROR "Build type '${settype}' not valid, must be one of: ${AVAIL_BUILDTYPES}") endfunction(VOLK_CHECK_BUILD_TYPE) ######################################################################## # For GCC and Clang, we can set a build type: # # -DCMAKE_BUILD_TYPE=DebugParanoid # # This type uses no optimization (-O0), outputs debug symbols (-g), warns # on everything, and stops on warnings. # NOTE: This is not defined on Windows systems. ######################################################################## if(NOT WIN32) set(CMAKE_CXX_FLAGS_DEBUGPARANOID "-Wall -Wextra -g -O0" CACHE STRING "Flags used by the C++ compiler during DebugParanoid builds." FORCE) set(CMAKE_C_FLAGS_DEBUGPARANOID "-Wall -Wextra -g -O0" CACHE STRING "Flags used by the C compiler during DebugParanoid builds." FORCE) set(CMAKE_EXE_LINKER_FLAGS_DEBUGPARANOID "-Wl,--warn-unresolved-symbols,--warn-once" CACHE STRING "Flags used for linking binaries during NoOptWithASM builds." FORCE) set(CMAKE_SHARED_LINKER_FLAGS_DEBUGPARANOID "-Wl,--warn-unresolved-symbols,--warn-once" CACHE STRING "Flags used by the shared lib linker during NoOptWithASM builds." FORCE) mark_as_advanced( CMAKE_CXX_FLAGS_DEBUGPARANOID CMAKE_C_FLAGS_DEBUGPARANOID CMAKE_EXE_LINKER_FLAGS_DEBUGPARANOID CMAKE_SHARED_LINKER_DEBUGPARANOID) endif(NOT WIN32) ######################################################################## # For GCC and Clang, we can set a build type: # # -DCMAKE_BUILD_TYPE=NoOptWithASM # # This type uses no optimization (-O0), outputs debug symbols (-g) and # outputs all intermediary files the build system produces, including # all assembly (.s) files. Look in the build directory for these # files. # NOTE: This is not defined on Windows systems. ######################################################################## if(NOT WIN32) set(CMAKE_CXX_FLAGS_NOOPTWITHASM "-save-temps -g -O0" CACHE STRING "Flags used by the C++ compiler during NoOptWithASM builds." FORCE) set(CMAKE_C_FLAGS_NOOPTWITHASM "-save-temps -g -O0" CACHE STRING "Flags used by the C compiler during NoOptWithASM builds." FORCE) set(CMAKE_EXE_LINKER_FLAGS_NOOPTWITHASM "-Wl,--warn-unresolved-symbols,--warn-once" CACHE STRING "Flags used for linking binaries during NoOptWithASM builds." FORCE) set(CMAKE_SHARED_LINKER_FLAGS_NOOPTWITHASM "-Wl,--warn-unresolved-symbols,--warn-once" CACHE STRING "Flags used by the shared lib linker during NoOptWithASM builds." FORCE) mark_as_advanced( CMAKE_CXX_FLAGS_NOOPTWITHASM CMAKE_C_FLAGS_NOOPTWITHASM CMAKE_EXE_LINKER_FLAGS_NOOPTWITHASM CMAKE_SHARED_LINKER_FLAGS_NOOPTWITHASM) endif(NOT WIN32) ######################################################################## # For GCC and Clang, we can set a build type: # # -DCMAKE_BUILD_TYPE=O2WithASM # # This type uses level 2 optimization (-O2), outputs debug symbols # (-g) and outputs all intermediary files the build system produces, # including all assembly (.s) files. Look in the build directory for # these files. # NOTE: This is not defined on Windows systems. ######################################################################## if(NOT WIN32) set(CMAKE_CXX_FLAGS_O2WITHASM "-save-temps -g -O2" CACHE STRING "Flags used by the C++ compiler during O2WithASM builds." FORCE) set(CMAKE_C_FLAGS_O2WITHASM "-save-temps -g -O2" CACHE STRING "Flags used by the C compiler during O2WithASM builds." FORCE) set(CMAKE_EXE_LINKER_FLAGS_O2WITHASM "-Wl,--warn-unresolved-symbols,--warn-once" CACHE STRING "Flags used for linking binaries during O2WithASM builds." FORCE) set(CMAKE_SHARED_LINKER_FLAGS_O2WITHASM "-Wl,--warn-unresolved-symbols,--warn-once" CACHE STRING "Flags used by the shared lib linker during O2WithASM builds." FORCE) mark_as_advanced(CMAKE_CXX_FLAGS_O2WITHASM CMAKE_C_FLAGS_O2WITHASM CMAKE_EXE_LINKER_FLAGS_O2WITHASM CMAKE_SHARED_LINKER_FLAGS_O2WITHASM) endif(NOT WIN32) ######################################################################## # For GCC and Clang, we can set a build type: # # -DCMAKE_BUILD_TYPE=O3WithASM # # This type uses level 3 optimization (-O3), outputs debug symbols # (-g) and outputs all intermediary files the build system produces, # including all assembly (.s) files. Look in the build directory for # these files. # NOTE: This is not defined on Windows systems. ######################################################################## if(NOT WIN32) set(CMAKE_CXX_FLAGS_O3WITHASM "-save-temps -g -O3" CACHE STRING "Flags used by the C++ compiler during O3WithASM builds." FORCE) set(CMAKE_C_FLAGS_O3WITHASM "-save-temps -g -O3" CACHE STRING "Flags used by the C compiler during O3WithASM builds." FORCE) set(CMAKE_EXE_LINKER_FLAGS_O3WITHASM "-Wl,--warn-unresolved-symbols,--warn-once" CACHE STRING "Flags used for linking binaries during O3WithASM builds." FORCE) set(CMAKE_SHARED_LINKER_FLAGS_O3WITHASM "-Wl,--warn-unresolved-symbols,--warn-once" CACHE STRING "Flags used by the shared lib linker during O3WithASM builds." FORCE) mark_as_advanced(CMAKE_CXX_FLAGS_O3WITHASM CMAKE_C_FLAGS_O3WITHASM CMAKE_EXE_LINKER_FLAGS_O3WITHASM CMAKE_SHARED_LINKER_FLAGS_O3WITHASM) endif(NOT WIN32) ######################################################################## # For GCC and Clang, we can set a build type: # # -DCMAKE_BUILD_TYPE=ASAN # # This type creates an address sanitized build (-fsanitize=address) # and defaults to the DebugParanoid linker flags. # NOTE: This is not defined on Windows systems. ######################################################################## if(NOT WIN32) set(CMAKE_CXX_FLAGS_ASAN "-Wall -Wextra -g -O2 -fsanitize=address -fsanitize=undefined -fno-omit-frame-pointer" CACHE STRING "Flags used by the C++ compiler during Address Sanitized builds." FORCE) set(CMAKE_C_FLAGS_ASAN "-Wall -Wextra -g -O2 -fsanitize=address -fsanitize=undefined -fno-omit-frame-pointer" CACHE STRING "Flags used by the C compiler during Address Sanitized builds." FORCE) mark_as_advanced( CMAKE_CXX_FLAGS_ASAN CMAKE_C_FLAGS_ASAN CMAKE_EXE_LINKER_FLAGS_DEBUGPARANOID CMAKE_SHARED_LINKER_DEBUGPARANOID) endif(NOT WIN32) volk-3.1.2/cmake/Modules/VolkConfig.cmake.in000066400000000000000000000031011456660453300206370ustar00rootroot00000000000000# Copyright 2016, 2018 - 2020 Free Software Foundation, Inc. # # This file is part of VOLK. # # SPDX-License-Identifier: LGPL-3.0-or-later # get_filename_component(VOLK_CMAKE_DIR "${CMAKE_CURRENT_LIST_FILE}" PATH) if(NOT TARGET Volk::volk) include("${VOLK_CMAKE_DIR}/VolkTargets.cmake") endif() # set VOLK_FOUND to be set globally, for whether a compatible Volk was # found -- could be a correct enough version or any version depending # on how find_package was called. if(NOT TARGET Volk::volk) set(VOLK_FOUND FALSE) else() set(VOLK_FOUND TRUE) endif() # cache whether a compatible Volk was found for # use anywhere in the calling project set(VOLK_FOUND ${VOLK_FOUND} CACHE BOOL "Whether a compatible Volk was found" FORCE) if(VOLK_FOUND) # use the new target library, regardless of whether new or old style # we still need to set a variable with the library name so that there # is a variable to reference in the using-project's cmake scripts! set(VOLK_LIBRARIES Volk::volk CACHE STRING "Volk Library" FORCE) # INTERFACE_INCLUDE_DIRECTORIES should always be set get_target_property(VOLK_INCLUDE_DIRS Volk::volk INTERFACE_INCLUDE_DIRECTORIES) set(VOLK_INCLUDE_DIRS ${VOLK_INCLUDE_DIRS} CACHE STRING "Volk Include Directories" FORCE) # for backward compatibility with old-CMake non-target project finding include(FindPackageHandleStandardArgs) find_package_handle_standard_args(Volk DEFAULT_MSG VOLK_LIBRARIES VOLK_INCLUDE_DIRS) mark_as_advanced(VOLK_LIBRARIES VOLK_INCLUDE_DIRS) endif(VOLK_FOUND) volk-3.1.2/cmake/Modules/VolkConfigVersion.cmake.in000066400000000000000000000013441456660453300222140ustar00rootroot00000000000000# Copyright 2014, 2015, 2018, 2020 Free Software Foundation, Inc. # # This file is part of VOLK. # # SPDX-License-Identifier: LGPL-3.0-or-later # set(MAJOR_VERSION @VERSION_INFO_MAJOR_VERSION@) set(MINOR_VERSION @VERSION_INFO_MINOR_VERSION@) set(MAINT_VERSION @VERSION_INFO_MAINT_VERSION@) set(PACKAGE_VERSION ${MAJOR_VERSION}.${MINOR_VERSION}.${MAINT_VERSION}) if(${PACKAGE_FIND_VERSION_MAJOR} EQUAL ${MAJOR_VERSION}) if(${PACKAGE_FIND_VERSION_MINOR} EQUAL ${MINOR_VERSION}) if(NOT ${PACKAGE_FIND_VERSION_PATCH} GREATER ${MAINT_VERSION}) set(PACKAGE_VERSION_EXACT 1) # exact match for API version set(PACKAGE_VERSION_COMPATIBLE 1) # compat for minor/patch version endif() endif() endif() volk-3.1.2/cmake/Modules/VolkPython.cmake000066400000000000000000000247551456660453300203300ustar00rootroot00000000000000# Copyright 2010-2011,2013 Free Software Foundation, Inc. # # This file is part of VOLK. # # SPDX-License-Identifier: LGPL-3.0-or-later # if(DEFINED __INCLUDED_VOLK_PYTHON_CMAKE) return() endif() set(__INCLUDED_VOLK_PYTHON_CMAKE TRUE) ######################################################################## # Setup the python interpreter: # This allows the user to specify a specific interpreter, # or finds the interpreter via the built-in cmake module. ######################################################################## #this allows the user to override PYTHON_EXECUTABLE # `PythonInterp` is deprecated in 3.12, we should use `Python3` instead. # The `Python3` CMake module is introduced in CMake 3.12, e.g. Ubuntu 18.04 comes with CMake 3.10 though. # https://cmake.org/cmake/help/latest/module/FindPythonInterp.html # https://cmake.org/cmake/help/latest/module/FindPython3.html#module:FindPython3 # FUTURE TODO: With CMake 3.12+ we can simply do: #if(PYTHON_EXECUTABLE) # set(Python_EXECUTABLE ${PYTHON_EXECUTABLE}) #else(PYTHON_EXECUTABLE) # find_package(Python3 COMPONENTS Interpreter) #endif(PYTHON_EXECUTABLE) # ##make the path to the executable appear in the cmake gui #set(PYTHON_EXECUTABLE ${Python_EXECUTABLE} CACHE FILEPATH "python interpreter") # END FUTURE TODO: Stick with following version as long as we set CMake 3.8 minimum. if(PYTHON_EXECUTABLE) set(PYTHONINTERP_FOUND TRUE) #otherwise if not set, try to automatically find it else(PYTHON_EXECUTABLE) #use the built-in find script set(Python_ADDITIONAL_VERSIONS 3.4 3.5 3.6 3.7 3.8) find_package(PythonInterp 3) #and if that fails use the find program routine if(NOT PYTHONINTERP_FOUND) find_program(PYTHON_EXECUTABLE NAMES python3 python) if(PYTHON_EXECUTABLE) set(PYTHONINTERP_FOUND TRUE) endif(PYTHON_EXECUTABLE) endif(NOT PYTHONINTERP_FOUND) endif(PYTHON_EXECUTABLE) #make the path to the executable appear in the cmake gui set(PYTHON_EXECUTABLE ${PYTHON_EXECUTABLE} CACHE FILEPATH "python interpreter") ######################################################################## # Check for the existence of a python module: # - desc a string description of the check # - mod the name of the module to import # - cmd an additional command to run # - have the result variable to set ######################################################################## macro(VOLK_PYTHON_CHECK_MODULE desc mod cmd have) message(STATUS "") message(STATUS "Python checking for ${desc}") execute_process( COMMAND ${PYTHON_EXECUTABLE} -c " ######################################### try: import ${mod} except: try: ${mod} except: exit(-1) try: assert ${cmd} except: exit(-1) #########################################" RESULT_VARIABLE ${have}) if(${have} EQUAL 0) message(STATUS "Python checking for ${desc} - found") set(${have} TRUE) else(${have} EQUAL 0) message(STATUS "Python checking for ${desc} - not found") set(${have} FALSE) endif(${have} EQUAL 0) endmacro(VOLK_PYTHON_CHECK_MODULE) ######################################################################## # Sets the python installation directory VOLK_PYTHON_DIR # cf. https://github.com/gnuradio/gnuradio/blob/master/cmake/Modules/GrPython.cmake # From https://github.com/pothosware/SoapySDR/tree/master/python # https://github.com/pothosware/SoapySDR/blob/master/LICENSE_1_0.txt ######################################################################## if(NOT DEFINED VOLK_PYTHON_DIR) execute_process( COMMAND ${PYTHON_EXECUTABLE} -c "import os import sysconfig import site install_dir = None # The next line passes a CMake variable into our script. prefix = '${CMAKE_INSTALL_PREFIX}' # We use `site` to identify if our chosen prefix is a default one. # https://docs.python.org/3/library/site.html try: # https://docs.python.org/3/library/site.html#site.getsitepackages paths = [p for p in site.getsitepackages() if p.startswith(prefix)] if len(paths) == 1: install_dir = paths[0] except AttributeError: pass # If we found a default install path, `install_dir` is set. if not install_dir: # We use a custom install prefix! # Determine the correct install path in that prefix on the current platform. # For Python 3.11+, we could use the 'venv' scheme for all platforms # https://docs.python.org/3.11/library/sysconfig.html#installation-paths if os.name == 'nt': scheme = 'nt' else: scheme = 'posix_prefix' install_dir = sysconfig.get_path('platlib', scheme) prefix = sysconfig.get_path('data', scheme) #strip the prefix to return a relative path print(os.path.relpath(install_dir, prefix))" OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE VOLK_PYTHON_DIR) endif() file(TO_CMAKE_PATH ${VOLK_PYTHON_DIR} VOLK_PYTHON_DIR) ######################################################################## # Create an always-built target with a unique name # Usage: VOLK_UNIQUE_TARGET( ) ######################################################################## function(VOLK_UNIQUE_TARGET desc) file(RELATIVE_PATH reldir ${CMAKE_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}) execute_process( COMMAND ${PYTHON_EXECUTABLE} -c "import re, hashlib unique = hashlib.sha256(b'${reldir}${ARGN}').hexdigest()[:5] print(re.sub('\\W', '_', '${desc} ${reldir} ' + unique))" OUTPUT_VARIABLE _target OUTPUT_STRIP_TRAILING_WHITESPACE) add_custom_target(${_target} ALL DEPENDS ${ARGN}) endfunction(VOLK_UNIQUE_TARGET) ######################################################################## # Install python sources (also builds and installs byte-compiled python) ######################################################################## function(VOLK_PYTHON_INSTALL) include(CMakeParseArgumentsCopy) cmake_parse_arguments(VOLK_PYTHON_INSTALL "" "DESTINATION;COMPONENT" "FILES;PROGRAMS" ${ARGN}) #################################################################### if(VOLK_PYTHON_INSTALL_FILES) #################################################################### install(${ARGN}) #installs regular python files #create a list of all generated files unset(pysrcfiles) unset(pycfiles) unset(pyofiles) foreach(pyfile ${VOLK_PYTHON_INSTALL_FILES}) get_filename_component(pyfile ${pyfile} ABSOLUTE) list(APPEND pysrcfiles ${pyfile}) #determine if this file is in the source or binary directory file(RELATIVE_PATH source_rel_path ${CMAKE_CURRENT_SOURCE_DIR} ${pyfile}) string(LENGTH "${source_rel_path}" source_rel_path_len) file(RELATIVE_PATH binary_rel_path ${CMAKE_CURRENT_BINARY_DIR} ${pyfile}) string(LENGTH "${binary_rel_path}" binary_rel_path_len) #and set the generated path appropriately if(${source_rel_path_len} GREATER ${binary_rel_path_len}) set(pygenfile ${CMAKE_CURRENT_BINARY_DIR}/${binary_rel_path}) else() set(pygenfile ${CMAKE_CURRENT_BINARY_DIR}/${source_rel_path}) endif() list(APPEND pycfiles ${pygenfile}c) list(APPEND pyofiles ${pygenfile}o) #ensure generation path exists get_filename_component(pygen_path ${pygenfile} PATH) file(MAKE_DIRECTORY ${pygen_path}) endforeach(pyfile) #the command to generate the pyc files add_custom_command( DEPENDS ${pysrcfiles} OUTPUT ${pycfiles} COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_BINARY_DIR}/python_compile_helper.py ${pysrcfiles} ${pycfiles}) #the command to generate the pyo files add_custom_command( DEPENDS ${pysrcfiles} OUTPUT ${pyofiles} COMMAND ${PYTHON_EXECUTABLE} -O ${CMAKE_BINARY_DIR}/python_compile_helper.py ${pysrcfiles} ${pyofiles}) #create install rule and add generated files to target list set(python_install_gen_targets ${pycfiles} ${pyofiles}) install( FILES ${python_install_gen_targets} DESTINATION ${VOLK_PYTHON_INSTALL_DESTINATION} COMPONENT ${VOLK_PYTHON_INSTALL_COMPONENT}) #################################################################### elseif(VOLK_PYTHON_INSTALL_PROGRAMS) #################################################################### file(TO_NATIVE_PATH ${PYTHON_EXECUTABLE} pyexe_native) if(CMAKE_CROSSCOMPILING) set(pyexe_native "/usr/bin/env python") endif() foreach(pyfile ${VOLK_PYTHON_INSTALL_PROGRAMS}) get_filename_component(pyfile_name ${pyfile} NAME) get_filename_component(pyfile ${pyfile} ABSOLUTE) string(REPLACE "${CMAKE_SOURCE_DIR}" "${CMAKE_BINARY_DIR}" pyexefile "${pyfile}.exe") list(APPEND python_install_gen_targets ${pyexefile}) get_filename_component(pyexefile_path ${pyexefile} PATH) file(MAKE_DIRECTORY ${pyexefile_path}) add_custom_command( OUTPUT ${pyexefile} DEPENDS ${pyfile} COMMAND ${PYTHON_EXECUTABLE} -c "open('${pyexefile}','w').write(r'\#!${pyexe_native}'+'\\n'+open('${pyfile}').read())" COMMENT "Shebangin ${pyfile_name}" VERBATIM) #on windows, python files need an extension to execute get_filename_component(pyfile_ext ${pyfile} EXT) if(WIN32 AND NOT pyfile_ext) set(pyfile_name "${pyfile_name}.py") endif() install( PROGRAMS ${pyexefile} RENAME ${pyfile_name} DESTINATION ${VOLK_PYTHON_INSTALL_DESTINATION} COMPONENT ${VOLK_PYTHON_INSTALL_COMPONENT}) endforeach(pyfile) endif() volk_unique_target("pygen" ${python_install_gen_targets}) endfunction(VOLK_PYTHON_INSTALL) ######################################################################## # Write the python helper script that generates byte code files ######################################################################## file( WRITE ${CMAKE_BINARY_DIR}/python_compile_helper.py " import sys, py_compile files = sys.argv[1:] srcs, gens = files[:len(files)//2], files[len(files)//2:] for src, gen in zip(srcs, gens): py_compile.compile(file=src, cfile=gen, doraise=True) ") volk-3.1.2/cmake/Modules/VolkVersion.cmake000066400000000000000000000047411456660453300204650ustar00rootroot00000000000000# Copyright 2014 Free Software Foundation, Inc. # # This file is part of VOLK. # # SPDX-License-Identifier: LGPL-3.0-or-later # if(DEFINED __INCLUDED_VOLK_VERSION_CMAKE) return() endif() set(__INCLUDED_VOLK_VERSION_CMAKE TRUE) #eventually, replace version.sh and fill in the variables below set(MAJOR_VERSION ${VERSION_INFO_MAJOR_VERSION}) set(MINOR_VERSION ${VERSION_INFO_MINOR_VERSION}) set(MAINT_VERSION ${VERSION_INFO_MAINT_VERSION}) ######################################################################## # Extract the version string from git describe. ######################################################################## find_package(Git) if(GIT_FOUND AND EXISTS ${CMAKE_SOURCE_DIR}/.git) message(STATUS "Extracting version information from git describe...") execute_process( COMMAND ${GIT_EXECUTABLE} describe --always --abbrev=8 --long OUTPUT_VARIABLE GIT_DESCRIBE OUTPUT_STRIP_TRAILING_WHITESPACE WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}) else() if(NOT VOLK_GIT_COUNT) set(VOLK_GIT_COUNT "0") endif() if(NOT VOLK_GIT_HASH) set(VOLK_GIT_HASH "unknown") endif() set(GIT_DESCRIBE "v${MAJOR_VERSION}.${MINOR_VERSION}-${VOLK_GIT_COUNT}-${VOLK_GIT_HASH}") endif() ######################################################################## # Use the logic below to set the version constants ######################################################################## if("${MINOR_VERSION}" STREQUAL "git") # VERSION: 1.0git-xxx-gxxxxxxxx # DOCVER: 1.0git # SOVERSION: 1.0git set(VERSION "${GIT_DESCRIBE}") set(DOCVER "${MAJOR_VERSION}.0${MINOR_VERSION}") set(SOVERSION "${MAJOR_VERSION}.0${MINOR_VERSION}") set(RC_MINOR_VERSION "0") set(RC_MAINT_VERSION "0") elseif("${MAINT_VERSION}" STREQUAL "git") # VERSION: 1.xgit-xxx-gxxxxxxxx # DOCVER: 1.xgit # SOVERSION: 1.xgit set(VERSION "${GIT_DESCRIBE}") set(DOCVER "${MAJOR_VERSION}.${MINOR_VERSION}${MAINT_VERSION}") set(SOVERSION "${MAJOR_VERSION}.${MINOR_VERSION}${MAINT_VERSION}") math(EXPR RC_MINOR_VERSION "${MINOR_VERSION} - 1") set(RC_MAINT_VERSION "0") else() # This is a numbered release. # VERSION: 1.1{.x} # DOCVER: 1.1{.x} # SOVERSION: 1.1.0 set(VERSION "${MAJOR_VERSION}.${MINOR_VERSION}.${MAINT_VERSION}") set(DOCVER "${VERSION}") set(SOVERSION "${MAJOR_VERSION}.${MINOR_VERSION}") set(RC_MINOR_VERSION ${MINOR_VERSION}) set(RC_MAINT_VERSION ${MAINT_VERSION}) endif() volk-3.1.2/cmake/Toolchains/000077500000000000000000000000001456660453300156675ustar00rootroot00000000000000volk-3.1.2/cmake/Toolchains/aarch64-linux-gnu.cmake000066400000000000000000000023011456660453300220410ustar00rootroot00000000000000# # Copyright 2018, 2020 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # set(CMAKE_SYSTEM_NAME Linux) set(CMAKE_SYSTEM_PROCESSOR aarch64) if(MINGW OR CYGWIN OR WIN32) set(UTIL_SEARCH_CMD where) elseif(UNIX OR APPLE) set(UTIL_SEARCH_CMD which) endif() set(TOOLCHAIN_PREFIX aarch64-linux-gnu-) execute_process( COMMAND ${UTIL_SEARCH_CMD} ${TOOLCHAIN_PREFIX}gcc OUTPUT_VARIABLE BINUTILS_PATH OUTPUT_STRIP_TRAILING_WHITESPACE) get_filename_component(ARM_TOOLCHAIN_DIR ${BINUTILS_PATH} DIRECTORY) # The following is not needed on debian # Without that flag CMake is not able to pass test compilation check #set(CMAKE_EXE_LINKER_FLAGS_INIT "--specs=nosys.specs") set(CMAKE_C_COMPILER ${TOOLCHAIN_PREFIX}gcc) set(CMAKE_ASM_COMPILER ${CMAKE_C_COMPILER}) set(CMAKE_CXX_COMPILER ${TOOLCHAIN_PREFIX}g++) set(CMAKE_OBJCOPY ${ARM_TOOLCHAIN_DIR}/${TOOLCHAIN_PREFIX}objcopy CACHE INTERNAL "objcopy tool") set(CMAKE_SIZE_UTIL ${ARM_TOOLCHAIN_DIR}/${TOOLCHAIN_PREFIX}size CACHE INTERNAL "size tool") set(CMAKE_FIND_ROOT_PATH ${BINUTILS_PATH}) set(CMAKE_CROSSCOMPILING_EMULATOR "qemu-aarch64 -L /usr/aarch64-linux-gnu/") volk-3.1.2/cmake/Toolchains/arm-linux-gnueabihf.cmake000066400000000000000000000026211456660453300225340ustar00rootroot00000000000000# # Copyright 2018 - 2020 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # set(CMAKE_SYSTEM_NAME Linux) set(CMAKE_SYSTEM_PROCESSOR arm) if(MINGW OR CYGWIN OR WIN32) set(UTIL_SEARCH_CMD where) elseif(UNIX OR APPLE) set(UTIL_SEARCH_CMD which) endif() set(TOOLCHAIN_PREFIX arm-linux-gnueabihf-) execute_process( COMMAND ${UTIL_SEARCH_CMD} ${TOOLCHAIN_PREFIX}gcc OUTPUT_VARIABLE BINUTILS_PATH OUTPUT_STRIP_TRAILING_WHITESPACE) get_filename_component(ARM_TOOLCHAIN_DIR ${BINUTILS_PATH} DIRECTORY) # The following is not needed on debian # Without that flag CMake is not able to pass test compilation check #set(CMAKE_EXE_LINKER_FLAGS_INIT "--specs=nosys.specs") set(CMAKE_C_COMPILER ${TOOLCHAIN_PREFIX}gcc) set(CMAKE_ASM_COMPILER ${CMAKE_C_COMPILER}) set(CMAKE_CXX_COMPILER ${TOOLCHAIN_PREFIX}g++) ## the following is needed for CheckCSourceCompiles used in lib/CMakeLists.txt set(CMAKE_C_FLAGS "-mfpu=neon" CACHE STRING "" FORCE) set(CMAKE_ASM_FLAGS "${CMAKE_C_FLAGS}" CACHE STRING "" FORCE) set(CMAKE_OBJCOPY ${ARM_TOOLCHAIN_DIR}/${TOOLCHAIN_PREFIX}objcopy CACHE INTERNAL "objcopy tool") set(CMAKE_SIZE_UTIL ${ARM_TOOLCHAIN_DIR}/${TOOLCHAIN_PREFIX}size CACHE INTERNAL "size tool") set(CMAKE_FIND_ROOT_PATH ${BINUTILS_PATH}) set(CMAKE_CROSSCOMPILING_EMULATOR "qemu-arm -L /usr/arm-linux-gnueabihf/") volk-3.1.2/cmake/Toolchains/arm_cortex_a15_hardfp_native.cmake000066400000000000000000000014221456660453300243730ustar00rootroot00000000000000# # Copyright 2014, 2018, 2019 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # ######################################################################## # Toolchain file for building native on a ARM Cortex A8 w/ NEON # Usage: cmake -DCMAKE_TOOLCHAIN_FILE= ######################################################################## set(CMAKE_CXX_COMPILER g++) set(CMAKE_C_COMPILER gcc) set(CMAKE_CXX_FLAGS "-march=armv7-a -mtune=cortex-a15 -mfpu=neon -mfloat-abi=hard" CACHE STRING "" FORCE) set(CMAKE_C_FLAGS ${CMAKE_CXX_FLAGS} CACHE STRING "" FORCE) #same flags for C sources set(CMAKE_ASM_FLAGS "${CMAKE_CXX_FLAGS} -g" CACHE STRING "" FORCE) #same flags for asm sources volk-3.1.2/cmake/Toolchains/arm_cortex_a53_hardfp_native.cmake000066400000000000000000000014521456660453300244000ustar00rootroot00000000000000# # Copyright 2014, 2018, 2019, 2021 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # ######################################################################## # Toolchain file for building native on a ARM Cortex A53 w/ NEON # Usage: cmake -DCMAKE_TOOLCHAIN_FILE= ######################################################################## set(CMAKE_CXX_COMPILER g++) set(CMAKE_C_COMPILER gcc) set(CMAKE_CXX_FLAGS "-march=armv8-a -mtune=cortex-a53 -mfpu=neon-fp-armv8 -mfloat-abi=hard" CACHE STRING "" FORCE) set(CMAKE_C_FLAGS ${CMAKE_CXX_FLAGS} CACHE STRING "" FORCE) #same flags for C sources set(CMAKE_ASM_FLAGS "${CMAKE_CXX_FLAGS} -mthumb -g" CACHE STRING "" FORCE) #same flags for asm sources volk-3.1.2/cmake/Toolchains/arm_cortex_a72_hardfp_native.cmake000066400000000000000000000014441456660453300244020ustar00rootroot00000000000000# # Copyright 2014, 2018, 2019 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # ######################################################################## # Toolchain file for building native on a ARM Cortex A72 w/ NEON # Usage: cmake -DCMAKE_TOOLCHAIN_FILE= ######################################################################## set(CMAKE_CXX_COMPILER g++) set(CMAKE_C_COMPILER gcc) set(CMAKE_CXX_FLAGS "-march=armv8-a -mtune=cortex-a72 -mfpu=neon-fp-armv8 -mfloat-abi=hard" CACHE STRING "" FORCE) set(CMAKE_C_FLAGS ${CMAKE_CXX_FLAGS} CACHE STRING "" FORCE) #same flags for C sources set(CMAKE_ASM_FLAGS "${CMAKE_CXX_FLAGS} -mthumb -g" CACHE STRING "" FORCE) #same flags for asm sources volk-3.1.2/cmake/Toolchains/arm_cortex_a8_hardfp_native.cmake000066400000000000000000000014211456660453300243140ustar00rootroot00000000000000# # Copyright 2014, 2018, 2019 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # ######################################################################## # Toolchain file for building native on a ARM Cortex A8 w/ NEON # Usage: cmake -DCMAKE_TOOLCHAIN_FILE= ######################################################################## set(CMAKE_CXX_COMPILER g++) set(CMAKE_C_COMPILER gcc) set(CMAKE_CXX_FLAGS "-march=armv7-a -mtune=cortex-a8 -mfpu=neon -mfloat-abi=hard" CACHE STRING "" FORCE) set(CMAKE_C_FLAGS ${CMAKE_CXX_FLAGS} CACHE STRING "" FORCE) #same flags for C sources set(CMAKE_ASM_FLAGS "${CMAKE_CXX_FLAGS} -g" CACHE STRING "" FORCE) #same flags for asm sources volk-3.1.2/cmake/Toolchains/arm_cortex_a8_softfp_native.cmake000066400000000000000000000014151456660453300243540ustar00rootroot00000000000000# # Copyright 2014, 2019 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # ######################################################################## # Toolchain file for building native on a ARM Cortex A8 w/ NEON # Usage: cmake -DCMAKE_TOOLCHAIN_FILE= ######################################################################## set(CMAKE_CXX_COMPILER g++) set(CMAKE_C_COMPILER gcc) set(CMAKE_CXX_FLAGS "-march=armv7-a -mtune=cortex-a8 -mfpu=neon -mfloat-abi=softfp" CACHE STRING "" FORCE) set(CMAKE_C_FLAGS ${CMAKE_CXX_FLAGS} CACHE STRING "" FORCE) #same flags for C sources set(CMAKE_ASM_FLAGS "${CMAKE_CXX_FLAGS} -g" CACHE STRING "" FORCE) #same flags for asm sources volk-3.1.2/cmake/Toolchains/arm_cortex_a9_hardfp_native.cmake000066400000000000000000000014211456660453300243150ustar00rootroot00000000000000# # Copyright 2014, 2018, 2019 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # ######################################################################## # Toolchain file for building native on a ARM Cortex A8 w/ NEON # Usage: cmake -DCMAKE_TOOLCHAIN_FILE= ######################################################################## set(CMAKE_CXX_COMPILER g++) set(CMAKE_C_COMPILER gcc) set(CMAKE_CXX_FLAGS "-march=armv7-a -mtune=cortex-a9 -mfpu=neon -mfloat-abi=hard" CACHE STRING "" FORCE) set(CMAKE_C_FLAGS ${CMAKE_CXX_FLAGS} CACHE STRING "" FORCE) #same flags for C sources set(CMAKE_ASM_FLAGS "${CMAKE_CXX_FLAGS} -g" CACHE STRING "" FORCE) #same flags for asm sources volk-3.1.2/cmake/Toolchains/intel-sde.cmake000066400000000000000000000005161456660453300205570ustar00rootroot00000000000000# # Copyright 2019 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -march=knl") set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -march=knl") set(CMAKE_CROSSCOMPILING_EMULATOR "$ENV{TRAVIS_BUILD_DIR}/cache/$ENV{SDE_VERSION}/sde64 -knl --") volk-3.1.2/cmake/Toolchains/oe-sdk_cross.cmake000066400000000000000000000020651456660453300212670ustar00rootroot00000000000000# # Copyright 2014 Free Software Foundation, Inc. # # This file is part of VOLK # # SPDX-License-Identifier: LGPL-3.0-or-later # set(CMAKE_SYSTEM_NAME Linux) #set( CMAKE_C_COMPILER $ENV{CC} ) #set( CMAKE_CXX_COMPILER $ENV{CXX} ) string(REGEX MATCH "sysroots/([a-zA-Z0-9]+)" CMAKE_SYSTEM_PROCESSOR $ENV{SDKTARGETSYSROOT}) string(REGEX REPLACE "sysroots/" "" CMAKE_SYSTEM_PROCESSOR ${CMAKE_SYSTEM_PROCESSOR}) set(CMAKE_CXX_FLAGS $ENV{CXXFLAGS} CACHE STRING "" FORCE) set(CMAKE_C_FLAGS $ENV{CFLAGS} CACHE STRING "" FORCE) #same flags for C sources set(CMAKE_LDFLAGS_FLAGS ${CMAKE_CXX_FLAGS} CACHE STRING "" FORCE) #same flags for C sources set(CMAKE_LIBRARY_PATH ${OECORE_TARGET_SYSROOT}/usr/lib) set(CMAKE_FIND_ROOT_PATH $ENV{OECORE_TARGET_SYSROOT} $ENV{OECORE_NATIVE_SYSROOT}) set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) set(ORC_INCLUDE_DIRS $ENV{OECORE_TARGET_SYSROOT}/usr/include/orc-0.4) set(ORC_LIBRARY_DIRS $ENV{OECORE_TARGET_SYSROOT}/usr/lib) volk-3.1.2/cmake/cmake_uninstall.cmake.in000066400000000000000000000031271456660453300203470ustar00rootroot00000000000000# Copyright 2014 Free Software Foundation, Inc. # # This file is part of VOLK. # # SPDX-License-Identifier: LGPL-3.0-or-later # # http://www.vtk.org/Wiki/CMake_FAQ#Can_I_do_.22make_uninstall.22_with_CMake.3F if(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") message( FATAL_ERROR "Cannot find install manifest: \"@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt\"" ) endif(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") file(READ "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt" files) string(REGEX REPLACE "\n" ";" files "${files}") foreach(file ${files}) message(STATUS "Uninstalling \"$ENV{DESTDIR}${file}\"") if(EXISTS "$ENV{DESTDIR}${file}") exec_program( "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\"" OUTPUT_VARIABLE rm_out RETURN_VALUE rm_retval) if(NOT "${rm_retval}" STREQUAL 0) message(FATAL_ERROR "Problem when removing \"$ENV{DESTDIR}${file}\"") endif(NOT "${rm_retval}" STREQUAL 0) elseif(IS_SYMLINK "$ENV{DESTDIR}${file}") exec_program( "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\"" OUTPUT_VARIABLE rm_out RETURN_VALUE rm_retval) if(NOT "${rm_retval}" STREQUAL 0) message(FATAL_ERROR "Problem when removing \"$ENV{DESTDIR}${file}\"") endif(NOT "${rm_retval}" STREQUAL 0) else(EXISTS "$ENV{DESTDIR}${file}") message(STATUS "File \"$ENV{DESTDIR}${file}\" does not exist.") endif(EXISTS "$ENV{DESTDIR}${file}") endforeach(file) volk-3.1.2/cmake/msvc/000077500000000000000000000000001456660453300145345ustar00rootroot00000000000000volk-3.1.2/cmake/msvc/config.h000066400000000000000000000040621456660453300161540ustar00rootroot00000000000000/* * Copyright 2012, 2017, 2020 Free Software Foundation, Inc. * * This file is part of VOLK * * SPDX-License-Identifier: LGPL-3.0-or-later */ #ifndef _MSC_VER // [ #error "Use this header only with Microsoft Visual C++ compilers!" #endif // _MSC_VER ] #ifndef _MSC_CONFIG_H_ // [ #define _MSC_CONFIG_H_ //////////////////////////////////////////////////////////////////////// // enable inline functions for C code //////////////////////////////////////////////////////////////////////// #ifndef __cplusplus #define inline __inline #endif //////////////////////////////////////////////////////////////////////// // signed size_t //////////////////////////////////////////////////////////////////////// #include typedef ptrdiff_t ssize_t; //////////////////////////////////////////////////////////////////////// // rint functions //////////////////////////////////////////////////////////////////////// #if _MSC_VER < 1800 #include static inline long lrint(double x) { return (long)(x > 0.0 ? x + 0.5 : x - 0.5); } static inline long lrintf(float x) { return (long)(x > 0.0f ? x + 0.5f : x - 0.5f); } static inline long long llrint(double x) { return (long long)(x > 0.0 ? x + 0.5 : x - 0.5); } static inline long long llrintf(float x) { return (long long)(x > 0.0f ? x + 0.5f : x - 0.5f); } static inline double rint(double x) { return (x > 0.0) ? floor(x + 0.5) : ceil(x - 0.5); } static inline float rintf(float x) { return (x > 0.0f) ? floorf(x + 0.5f) : ceilf(x - 0.5f); } #endif //////////////////////////////////////////////////////////////////////// // math constants //////////////////////////////////////////////////////////////////////// #if _MSC_VER < 1800 #include #define INFINITY HUGE_VAL #endif //////////////////////////////////////////////////////////////////////// // random and srandom //////////////////////////////////////////////////////////////////////// #include static inline long int random(void) { return rand(); } static inline void srandom(unsigned int seed) { srand(seed); } #endif // _MSC_CONFIG_H_ ] volk-3.1.2/cmake/msvc/sys/000077500000000000000000000000001456660453300153525ustar00rootroot00000000000000volk-3.1.2/cmake/msvc/sys/time.h000066400000000000000000000034351456660453300164660ustar00rootroot00000000000000/* * Copyright 2018, 2020 Free Software Foundation, Inc. * * This file is part of VOLK * * SPDX-License-Identifier: LGPL-3.0-or-later */ #ifndef _MSC_VER // [ #error "Use this header only with Microsoft Visual C++ compilers!" #endif // _MSC_VER ] #ifndef _MSC_SYS_TIME_H_ #define _MSC_SYS_TIME_H_ // prevent windows.h from clobbering min and max functions with macros #ifndef NOMINMAX #define NOMINMAX #endif // http://social.msdn.microsoft.com/Forums/en/vcgeneral/thread/430449b3-f6dd-4e18-84de-eebd26a8d668 #include < time.h > #include //I've omitted this line. #if defined(_MSC_VER) || defined(_MSC_EXTENSIONS) #define DELTA_EPOCH_IN_MICROSECS 11644473600000000Ui64 #else #define DELTA_EPOCH_IN_MICROSECS 11644473600000000ULL #endif #if _MSC_VER < 1900 struct timespec { time_t tv_sec; /* Seconds since 00:00:00 GMT, */ /* 1 January 1970 */ long tv_nsec; /* Additional nanoseconds since */ /* tv_sec */ }; #endif struct timezone { int tz_minuteswest; /* minutes W of Greenwich */ int tz_dsttime; /* type of dst correction */ }; static inline int gettimeofday(struct timeval* tv, struct timezone* tz) { FILETIME ft; unsigned __int64 tmpres = 0; static int tzflag; if (NULL != tv) { GetSystemTimeAsFileTime(&ft); tmpres |= ft.dwHighDateTime; tmpres <<= 32; tmpres |= ft.dwLowDateTime; /*converting file time to unix epoch*/ tmpres -= DELTA_EPOCH_IN_MICROSECS; tv->tv_sec = (long)(tmpres / 1000000UL); tv->tv_usec = (long)(tmpres % 1000000UL); } if (NULL != tz) { if (!tzflag) { _tzset(); tzflag++; } tz->tz_minuteswest = _timezone / 60; tz->tz_dsttime = _daylight; } return 0; } #endif //_MSC_SYS_TIME_H_ volk-3.1.2/cpu_features/000077500000000000000000000000001456660453300151715ustar00rootroot00000000000000volk-3.1.2/docs/000077500000000000000000000000001456660453300134345ustar00rootroot00000000000000volk-3.1.2/docs/AUTHORS_RESUBMITTING_UNDER_LGPL_LICENSE.md000066400000000000000000000302771456660453300220250ustar00rootroot00000000000000# List of authors resubmitting their contributions under LGPL-3.0-or-later VOLK is migrating from GNU General Public License v3.0 or later (GPL-3.0-or-later) to GNU Lesser General Public License v3.0 or later (LGPL-3.0-or-later). This file is a list of the authors who agreed to resubmit their code under the LGPL-3.0-or-later license to this repository. In case the affected code is licensed differently than VOLK's current license (GPL-3.0-or-later), this gives the VOLK project the right to use the current contributions under both LGPL-3.0-or-later and that other license. Future contributions by these authors are, however, licensed under LGPL-3.0-or-later, unless explicitly stated otherwise. ## Current status We'd like to thank everyone who helped to re-license VOLK under LGPL! Being technical: There are 3 people left (out of 74) who we haven't been able to get in contact with (at all), for a total of 4 (out of 1092) commits, 13 (of 282822) additions, and 7 (of 170421) deletions. We have reviewed these commits and all are simple changes (e.g., 1 line change) and most are no longer relevant (e.g., to a file that no longer exists). VOLK maintainers are in agreement that the combination -- small numbers of changes per committer, simple changes per commit, commits no longer relevant -- means that we can proceed with relicensing without the approval of the folks. We will try reaching out periodically to these folks, but we believe it unlikely we will get a reply. ## How to add myself to the table of authors There are several options. Choose the one you prefer. 1. Open a PR and add yourself to the table. 2. Add a Github comment that clearly states your wish to be added to the table. 3. Write an email to the maintainers that clearly states your wish to be added to the table. ### Information for option 2 and 3 If you go with option 2 or 3, the maintainers add your statement to the corresponding git commit message for documentation purposes. Suggested wording > I, {contributor name}, hereby resubmit all my contributions to the VOLK project and repository under the terms of the LGPLv3+. My GitHub handle is {github handle}, my email addresses used for contributions are: {email address}, ... . ## Table of authors Together with the date of agreement, these authors are: | Date | Author (as used in commits) | GitHub handle | Email address(es) | |------------|-----------------------------|-----------------|---------------------------------------------------------------------| | 2021-07-01 | Marcus Müller | marcusmueller | marcus@hostalia.de, mmueller@gnuradio.org, mueller@kit.edu | | 2021-08-01 | Johannes Demel | jdemel | ufcsy@student.kit.edu, demel@uni-bremen.de, demel@ant.uni-bremen.de | | 2021-08-25 | Martin Braun | mbr0wn | martin@gnuradio.org, martin.braun@ettus.com | | 2021-08-27 | Carles Fernandez | carlesfernandez | carles.fernandez@cttc.es, carles.fernandez@gmail.com, carlesfernandez@gmail.com | | 2021-08-27 | Magnus Lundmark | Ka-zam | magnus@skysense.io | | 2021-09-04 | Michael Dickens | michaelld | mlk@alum.mit.edu, michael.dickens@ettus.com | | 2021-09-05 | Andrej Rode | noc0lour | mail@andrejro.de | | 2021-09-06 | rear1019 | rear1019 | rear1019@posteo.de | | 2021-09-08 | Federico 'Larroca' La Rocca | git-artes | flarroca@fing.edu.uy | | 2021-09-08 | Bernhard M. Wiedemann | bmwiedemann | bwiedemann@suse.de | | 2021-09-08 | A. Maitland Bottoms | maitbot | bottoms@debian.org | | 2021-09-08 | Paul Cercueil | pcercuei | paul.cercueil@analog.com | | 2021-09-08 | Jeison Cardoso | jsonzilla, 0unit| cardoso.jeison@gmail.com | | 2021-09-08 | Brennan Ashton | btashton | bashton@brennanashton.com | | 2021-09-08 | Ryan Volz | ryanvolz | ryan.volz@gmail.com, rvolz@mit.edu | | 2021-09-08 | Douglas Anderson | djanderson | douglas.j.anderson@gmail.com, djanderson@users.noreply.github.com | | 2021-09-08 | Nicholas McCarthy | namccart | namccart@gmail.com | | 2021-09-09 | Jaroslav Škarvada | yarda | jskarvad@redhat.com | | 2021-09-09 | Vasil Velichkov | velichkov | vvvelichkov@gmail.com | | 2021-09-09 | Takehiro Sekine | bstalk | takehiro.sekine@ps23.jp | | 2021-09-10 | Vanya Sergeev | vsergeev | vsergeev@gmail.com | | 2021-09-10 | Ben Hilburn | bhilburn | bhilburn@gnuradio.org, bhilburn@gmail.com, ben@ettus.com, ben@hilburn.dev | | 2021-09-09 | Philip Balister | balister | philip@balister.org, root@usrp-e1xx.(none) | | 2021-09-12 | Andrey Rodionov | dernasherbrezon | rodionovamp@mail.ru | | 2021-09-13 | Clayton Smith | argilo | argilo@gmail.com | | 2021-09-14 | Martin Kaesberger | mkaesberger | git@skipfish.de | | 2021-09-08 | Karl Semich | xloem | 0xloem@gmail.com | | 2021-09-23 | Mike Piscopo | ghostop14 | ghostop14@gmail.com | | 2021-09-13 | Amr Bekhit | amrbekhit | amr@helmpcb.com, amrbekhit@gmail.com | | 2021-09-19 | Eric Blossom | eblossom | eb@comsec.com | | 2021-09-20 | Douglas Geiger | douggeiger | doug.geiger@bioradiation.net,douglas.geiger@nrl.navy.mil | | 2021-09-21 | Zlika | Zlika | zlika_ese@hotmail.com | | 2021-09-24 | Ron Economos | drmpeg | w6rz@comcast.net | | 2021-09-26 | Marc Lichtman | 777arc | marcll@vt.edu | | 2021-09-28 | Stefan Wunsch | stwunsch | stefan.wunsch@student.kit.edu | | 2021-10-02 | Albin Stigö | ast | albin.stigo@gmail.com | | 2021-10-09 | Florian Ritterhoff | fritterhoff | ritterho@hm.edu | | 2021-10-06 | Sylvain Munaut | smunaut | tnt@246tNt.com, 246tnt@gmail.com | | 2021-10-10 | Dan Robertson | dlrobertson | dan@dlrobertson.com | | 2021-10-10 | Steve Markgraf | steve-m | steve@steve-m.de | | 2021-10-10 | Gwenhael Goavec-Merou | trabucayre | gwenhael.goavec-merou@trabucayre.com | | 2021-10-10 | Doron Behar | doronbehar | doron.behar@gmail.com | | 2021-10-10 | Brandon Enochs | brandonenochs | brandon.enochs@nrl.navy.mil | | 2021-10-10 | Thomas Rondeau | trondeau | tom@trondeau.com, trondeau@vt.edu | | 2021-10-11 | Tim O'Shea | oshtim | tim.oshea753@gmail.com | | 2021-10-13 | Alexey Slokva | Alesha72003 | Alesha72003@ya.ru | | 2021-10-17 | Josh Blum | guruofquality | josh@joshknows.com | | 2021-10-14 | Nicholas Corgan | ncorgan | n.corgan@gmail.com, nick.corgan@ettus.com | | 2021-10-24 | Andy Walls | awalls-cx18 | andy@silverblocksystems.net, awalls.cx18@gmail.com, awalls@md.metrocast.net | | 2021-10-26 | Ettus Research | N/A | nick.corgan@ettus.com, nick@ettus.com, ben.hilburn@ettus.com, michael.dickens@ettus.com | | 2021-10-27 | Pascal Giard | evilynux | evilynux@gmail.com, pascal.giard@lacime.etsmtl.ca, pascal.giard@etsmtl.ca, pascal.giard@mail.mcgill.ca | | 2021-10-27 | The Aerospace Corporation | N/A | oss@aero.org, damian.miralles@aero.org, jessica.iwamoto@aero.org, kyle.a.logue@aero.org | | 2021-10-29 | Christoph Mayer | hcab14 | hcab14@gmail.com, Christoph.Mayer@cern.ch | | 2021-10-29 | Valerii Zapodovnikov | ValZapod | val.zapod.vz@gmail.com | | 2021-10-29 | Stefan Oltmanns | Stefan-Olt | stefan-oltmanns@gmx.net | | 2021-10-29 | Mathieu Rene | mrene | mrene@avgs.ca | | 2021-10-29 | Steven Behnke | sbehnke | steven_behnke@me.com | | 2021-10-29 | Adam Thompson | awthomp | adamt@nvidia.com | | 2021-10-29 | Nick Foster | bistromath | bistromath@gmail.com, nick@nerdnetworks.org | | 2021-10-29 | Roy Thompson | roythompson | rthompso@gmail.com | | 2021-10-29 | luzpaz | luzpaz | luzpaz@users.noreply.github.com | | 2021-10-29 | Damian Miralles | dmiralles2009 | dmiralles2009@gmail.com, damian.miralles@colorado.edu | | 2021-11-06 | Julien Olivain | jolivain | julien.olivain@lsv.ens-cachan.fr | | 2021-11-07 | Jam M. Hernandez Quiceno | JamMarHer | jamarck96@gmail.com, jam_quiceno@partech.com | | 2021-11-19 | Abhishek Bhowmick | abhowmick22 | abhowmick22@gmail.com | | 2021-11-29 | Aang23 (Alan) | Aang23 | qwerty15@gmx.fr, aang23@altillimity.com | | 2022-02-06 | Nathan West | n-west | nwest@deepsig.io, nate.ewest@gmail.com, nathan.west@gnuradio.org, nathan.west@nrl.navy.mil, nathan.west@okstate.edu, nathan@pepper | | 2022-04-01 | Albert Holguin | hades- | aholguin_77@yahoo.com, codename.hash@gmail.com | | 2022-04-14 | Elliot Briggs | N/A | elliot.briggs@gmail.com | | 2022-05-31 | Geoffrey Nieboer | gnieboer | gnieboer@gcndevelopment.com, gnieboer@corpcomm.net | | 2022-06-28 | Moritz Fischer | N/A | gnuradio@pure-entropy.org | | 2022-06-29 | Johnathan Corgan | jmcorgan | jcorgan@corganenterprises.com, johnathan@corganlabs.com | | | | | | volk-3.1.2/docs/CHANGELOG.md000066400000000000000000001075111456660453300152520ustar00rootroot00000000000000# Changelog All notable changes to VOLK will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html), starting with version 2.0.0. ## [2.0.0] - 2019-08-06 This is the first version to use semantic versioning. It starts the logging of changes. ## [2.1.0] - 2019-12-22 Hi everyone, we would like to announce that Michael Dickens and Johannes Demel are the new VOLK maintainers. We want to review and merge PRs in a timely manner as well as commenting on issues in order to resolve them. We want to thank all contributors. This release wouldn't have been possible without them. We're curious about VOLK users. Especially we'd like to learn about VOLK users who use VOLK outside GNU Radio. If you have ideas for VOLK enhancements, let us know. Start with an issue to discuss your idea. We'll be happy to see new features get merged into VOLK. ### Highlights VOLK v2.1.0 is a collection of really cool changes. We'd like to highlight some of them. - The AVX FMA rotator bug is fixed - VOLK offers `volk::vector<>` for C++ to follow RAII - Move towards modern dependencies - CMake 3.8 - Prefer Python3 - We will drop Python2 support in a future release! - Use C++17 `std::filesystem` - This enables VOLK to be built without Boost if available! - more stable CI - lots of bugfixes - more optimized kernels, especially more NEON versions ### Contributors * Albin Stigo * Amr Bekhit * Andrej Rode * Carles Fernandez * Christoph Mayer * Clayton Smith * Damian Miralles * Johannes Demel * Marcus Müller * Michael Dickens * Philip Balister * Takehiro Sekine * Vasil Velichkov * luz.paz ### Changes * Usage - Update README to reflect how to build on Raspberry Pi and the importance of running volk_profile * Toolchain - Add toolchain file for Raspberry Pi 3 - Update Raspberry 4 toolchain file * Kernels - Add neonv7 to volk_16ic_magnitude_16i - Add neonv7 to volk_32fc_index_max_32u - Add neonv7 to volk_32fc_s32f_power_spectrum_32f - Add NEONv8 to volk_32f_64f_add_64f - Add Neonv8 to volk_32fc_deinterleave_64f_x2 - Add volk_32fc_x2_s32fc_multiply_conjugate_add_32fc - Add NEONv8 to volk_32fc_convert_16ic * CI - Fix AVX FMA rotator - appveyor: Enable testing on windows - Fixes for flaky kernels for more reliable CI - volk_32f_log2_32f - volk_32f_x3_sum_of_poly_32f - volk_32f_index_max_{16,32}u - volk_32f_8u_polarbutterflypuppet_32f - volk_8u_conv_k7_r2puppet_8u - volk_32fc_convert_16ic - volk_32fc_s32f_magnitude_16i - volk_32f_s32f_convert_{8,16,32}i - volk_16ic_magnitude_16i - volk_32f_64f_add_64f - Use Intel SDE to test all kernels - TravisCI - Add native tests on arm64 - Add native tests on s390x and ppc64le (allow failure) * Build - Build Volk without Boost if C++17 std::filesystem or std::experimental::filesystem is available - Update to more modern CMake - Prevent CMake to choose previously installed VOLK headers - CMake - bump minimum version to 3.8 - Use sha256 instead of md5 for unique target name hash - Python: Prefer Python3 over Python2 if available * C++ - VOLK C++ allocator and C++11 std::vector type alias added \n ## [2.2.0] - 2020-02-16 Hi everyone, we have a new VOLK release v2.2.0! We want to thank all contributors. This release wouldn't have been possible without them. We're curious about VOLK users. Especially we'd like to learn about VOLK users who use VOLK outside GNU Radio. If you have ideas for VOLK enhancements, let us know. Start with an issue to discuss your idea. We'll be happy to see new features get merged into VOLK. The v2.1.0 release was rather large because we had a lot of backlog. We aim for more incremental releases in order to get new features out there. ### Highlights VOLK v2.2.0 updates our build tools and adds support functionality to make it easier to use VOLK in your projects. * Dropped Python 2 build support - Removed Python six module dependency * Use C11 aligned_alloc whenever possible - MacOS `posix_memalign` fall-back - MSVC `_aligned_malloc` fall-back * Add VOLK version in `volk_version.h` (included in `volk.h`) * Improved CMake code * Improved code with lots of refactoring and performance tweaks ### Contributors * Carles Fernandez * Gwenhael Goavec-Merou * Albin Stigo * Johannes Demel * Michael Dickens * Valerii Zapodovnikov * Vasil Velichkov * ghostop14 * rear1019 ### Changes * CMake - Fix detection of AVX and NEON - Fix for macOS - lib/CMakeLists: use __asm__ instead of asm for ARM tests - lib/CMakeLists: fix detection when compiler support NEON but nor neonv7 nor neonv8 - lib/CMakeLists.txt: use __VOLK_ASM instead of __asm__ - lib/CMakeLists.txt: let VOLK choose preferred neon version when both are supported - lib/CMakeLists.txt: simplify neon test support. Unset neon version if not supported - For attribute, change from clang to "clang but not MSC" * Readme - logo: Add logo at top of README.md * Build dependencies - python: Drop Python2 support - python: Reduce six usage - python: Move to Python3 syntax and modules - six: Remove build dependency on python six * Allocation - alloc: Use C11 aligned_alloc - alloc: Implement fall backs for C11 aligned_alloc - alloc: Fix for incomplete MSVC standard compliance - alloc: update to reflect alloc changes * Library usage - Fixup VolkConfigVersion - add volk_version.h * Refactoring - qa_utils.cc: fix always false expression - volk_prefs.c: check null realloc and use temporary pointer - volk_profile.cc: double assignment and return 0 - volk_32f_x2_pow_32f.h: do not need to _mm256_setzero_ps() - volk_8u_conv_k7_r2puppet_8u.h: d_polys[i] is positive - kernels: change one iteration for's to if's - kernels: get rid of some assignments - qa_utils.cc: actually throw something - qa_utils.cc: fix always true code - rotator: Refactor AVX kernels - rotator: Remove unnecessary variable - kernel: Refactor square_dist_scalar_mult - square_dist_scalar_mult: Speed-Up AVX, Add unaligned - square_dist_scalar_mult: refactor AVX2 kernel - kernel: create AVX2 meta intrinsics * CI - appveyor: Test with python 3.4 and 3.8 - appveyor: Add job names - appveyor: Make ctest more verbose * Performance - Improve performance of generic kernels with complex multiply - square_dist_scalar_mult: Add SSE version - Adds NEON versions of cos, sin and tan ## [2.2.1] - 2020-02-24 Hi everyone, with VOLK 2.2.0, we introduced another AVX rotator bug which is fixed with this release. In the process 2 more bugs were identified and fixed. Further, we saw some documentation improvements. ### Contributors * Clayton Smith * Michael Dickens ### Changes * Fix loop bound in AVX rotator * Fix out-of-bounds read in AVX2 square dist kernel * Fix length checks in AVX2 index max kernels * includes: rearrange attributes to simplify macros Whitespace * kernels: fix usage in header comments \n ## [2.3.0] - 2020-05-09 Hi everyone! VOLK 2.3 is out! We want to thank all contributors. This release wouldn't have been possible without them. We saw lots of great improvements. On GNU Radio 'master' VOLK was finally removed as a submodule. Currently we see ongoing discussions on how to improve CPU feature detection because VOLK is not as reliable as we'd like it to be in that department. We'd like to benefit from other open source projects and don't want to reinvent the wheel. Thus, one approach would be to include `cpu_features` as a submodule. ### Highlights * Better reproducible builds * CMake improvements - ORC is removed from the public interface where it was never supposed to be. - CMake fixes for better usability * Updated and new CI chain - TravisCI moved to new distro and does more tests for newer GCC/Clang - Github Actions - Add Action to check proper code formatting. - Add CI that also runs on MacOS with XCode. * Enforce C/C++ coding style via clang-format * Kernel fixes - Add puppet for `power_spectral_density` kernel - Treat the `mod_range` puppet as a puppet for correct use with `volk_profile` - Fix `index_max` kernels - Fix `rotator`. We hope that we finally found the root cause of the issue. * Kernel optimizations - Updated log10 calcs to use faster log2 approach - Optimize `complexmultiplyconjugate` * New kernels - accurate exp kernel is finally merged after years - Add 32f_s32f_add_32f kernel to perform vector + scalar float operation ### Contributors * Bernhard M. Wiedemann * Clayton Smith * Johannes Demel * Michael Dickens * Tom Rondeau * Vasil Velichkov * ghostop14 ### Changes * Reproducible builds - Drop compile-time CPU detection - Drop another instance of compile-time CPU detection * CI updates - ci: Add Github CI Action - ci: Remove Ubuntu 16.04 GCC5 test on TravisCI - TravisCI: Update CI to bionic distro - TravisCI: Add GCC 8 test - TravisCI: Structure CI file - TravisCI: Clean-up .travis.yml * Enforce C/C++ coding style - clang-format: Apply clang-format - clang-format: Update PR with GitHub Action - clang-format: Rebase onto current master * Fix compiler warnings - shadow: rebase kernel fixes - shadow: rebase volk_profile fix * CMake - cmake: Remove the ORC from the VOLK public link interface - versioning: Remove .Maint from libvolk version - Fix endif macro name in comment * Kernels - volk: accurate exp kernel - exp: Rename SSE4.1 to SSE2 kernel - Add 32f_s32f_add_32f kernel - This kernel adds in vector + scalar functionality - Fix the broken index max kernels - Treat the mod_range puppet as such - Add puppet for power spectral density kernel - Updated log10 calcs to use faster log2 approach - fix: Use unaligned load - divide: Optimize complexmultiplyconjugate ## [2.4.0] - 2020-11-22 Hi everyone! We have another VOLK release! We're happy to announce VOLK v2.4.0! We want to thank all contributors. This release wouldn't have been possible without them. We introduce `cpu_features` as a private submodule in this release because we use it to detect CPU features during runtime now. This should enable more reliable feature detection. Further, it takes away the burden to implement platform specific code. As a result, optimized VOLK kernels build for MacOS and Windows with AppleClang/MSVC out-of-the-box now. ### Highlights * Documentation - Update README to be more verbose and to improve usefulness. * Compilers - MSVC: Handle compiler flags and thus architecture specific kernels correctly. This enables optimized kernels with MSVC builds. - AppleClang: Treat AppleClang as Clang. - Paired with the `cpu_features` introduction, this enables us to use architecture specific kernels on a broader set of platforms. * CI - Update to newest version of the Intel SDE - Test the rotator kernel with a realistic scalar - Introduce more test cases with newer GCC and newer Clang versions. * CMake - Enable to not install `volk_modtool`. - Remove "find_package_handle_standard_args" warning. * cpu_features - Use `cpu_features` v0.6.0 as a private submodule to detect available CPU features. - Fix incorrect feature detection for newer AVX versions. - Circumvent platform specific feature detection. - Enable more architecture specific kernels on more platforms. * Kernels - Disable slow and broken SSE4.1 kernel in `volk_32fc_x2_dot_prod_32fc` - Adjust min/max for `32f_s32f_convert_8i` kernel - Use `INT8_*` instead of `CHAR_*` ### Contributors * Adam Thompson * Andrej Rode * Christoph Mayer * Clayton Smith * Doron Behar * Johannes Demel , * Martin Kaesberger * Michael Dickens * Ron Economos ### Changes * Documentation - Update README to include ldconfig upon volk build and install completion - Update README based on review - readme: Fix wording - docs: Fix conversion inaccuracy * MSVC - archs: MSVC 2013 and greater don't have a SSE flag * CI - update to newest version of the Intel SDE - Test the rotator kernel with a realistic scalar * CMake - build: Enable to not install volk_modtool - cmake: Remove "find_package_handle_standard_args" warning. - cmake: Ensure that cpu_features is built as a static library. * cpu_features - readme: Add section on supported platforms - readme: Make supported compiler section more specific - travis: Add GCC 9 test on focal - travis: Add tests for clang 8, 9, 10 - travis: Fix incorrect CXX compiler assignment - cpu_features: Remove unused feature checks - ci: Update TravisCI for cpu_features - cpu_features: Fix MSVC build - pic: Fix BUILD_PIC issue - ci: Update CI system configuration - cpu_features: Bump submodule pointer to v0.6.0 - docs: Add hints how to handle required submodules - cpu_features: Switch to cpu_features - ci: Update CI system for cpu_features - cpu_features: Force PIC build flag - appveyor: Add recursive clone command - cpu_features: Remove xgetbv checks - pic: Cache and force BUILD_PIC - ci: Remove explicit BUILD_PIC from cmake args - ci: Remove BUILD_PIC from CI cmake args - cpu_features: Remove commented code - cpu_features: Assume AppleClang == Clang - cpu_features: Remove obsolete code in archs.xml - fix for ARM cross-compiling CI - ARM CI: remove unneeded environment variables * Housekeeping - structure: Move release scripts to scripts folder * Kernels - emit an emms instruction after using the mmx extension - volk_32fc_x2_dot_prod_32fc: disable slow & broken SSE4.1 kernel - fix: Adjust min/max for 32f_s32f_convert_8i kernel - fix: Use INT8_* instead of CHAR_* ## [2.4.1] - 2020-12-17 Hi everyone! We have a new VOLK bugfix release! We are happy to announce VOLK v2.4.1! We want to thank all contributors. This release wouldn't have been possible without them. Our v2.4.0 release introduced quite a lot of changes under the hood. With this bugfix release, we want to make sure that everything works as expected again. ### Contributors * A. Maitland Bottoms * Johannes Demel * Michael Dickens * Philip Balister * Ron Economos * Ryan Volz ### Changes * Build - cpu_features CMake option - Add cpu_features to static library build. - Use static liborc-0.4 library for static library build. - cmake: Detect if cpu_features submodule is present. * Install - Check for lib64 versus lib and set LIB_SUFFIX accordingly. * CI - Add CI test for static library build. * Releases - project: Include git submodules (i.e. cpu_features) in release tarball. - scripts: Add GPG signature to release script * Other - readme: Update TravisCI status badge ## [2.5.0] - 2021-06-05 Hi everyone! We have a new VOLK release! We are happy to announce VOLK v2.5.0! We want to thank all contributors. This release wouldn't have been possible without them. This release adds new kernel implementations and fixes. Some of these were longstanding PRs that could only be merged recently thanks to our switch from CLA to DCO. ### Announcements I would like to point out one upcoming change. After this release, we will rename our development branch to `main` as discussed in [issue #461](https://github.com/gnuradio/volk/issues/461). I'd like to point the community to this [VOLK relicensing GREP](https://github.com/gnuradio/greps/pull/33). This is an ongoing effort to relicense VOLK under LGPLv3. We're looking for people and organizations that are interested in leading this effort. ### Contributors * Aang23 * Carles Fernandez * Florian Ritterhoff * Jam M. Hernandez Quiceno , * Jaroslav Škarvada * Johannes Demel * Magnus Lundmark * Michael Dickens * Steven Behnke * alesha72003 * dernasherbrezon * rear1019 ### Changes * Kernels - volk_32f_stddev_and_mean_32f_x2: implemented Young and Cramer's algorithm - volk_32fc_accumulator_s32fc: Add new kernel - volk_16ic_x2_dot_prod_16ic_u_avx2: Fix Typo, was `_axv2`. - Remove _mm256_zeroupper() calls - Enforce consistent function prototypes - 32fc_index_max: Improve speed of AVX2 version - conv_k7_r2: Disable broken AVX2 code - improve volk_8i_s32f_convert_32f for ARM NEON - Calculate cos in AVX512F - Calculate sin using AVX512F * Compilers - MSVC - Fix MSVC builds - GCC - Fix segmentation fault when using GCC 8 - MinGW - add support and test for MinGW/MSYS2 * The README has received several improvements * Build - Fix python version detection - cmake: Check that 'distutils' is available - c11: Remove pre-C11 preprocessor instructions * CI - Add more CI to GitHub Actions - Remove redundant tests from TravisCI - Add non-x86 GitHub Actions - Update compiler names in CI - Disable fail-fast CI - Add more debug output to tests * Contributing - contributing: Add CONTRIBUTING.md and DCO.txt ## [2.5.1] - 2022-02-12 Hi everyone! We have a new VOLK release! We are happy to announce VOLK v2.5.1! We want to thank all contributors. This release wouldn't have been possible without them. The list of contributors is pretty long this time due to a lot of support to relicense VOLK under LGPL. Currently, we are "almost there" but need a few more approvals, please support us. We thank everyone for their support in this effort. We use `cpu_features` for a while now. This maintainance release should make it easier for package maintainers, FreeBSD users, and M1 users to use VOLK. Package maintainers should be able to use an external `cpu_features` module. For everyone else, `cpu_features` received support for M1 and FreeBSD. You can find [VOLK on Zenodo DOI: 10.5281/zenodo.3360942](https://doi.org/10.5281/zenodo.3360942). We started to actively support Zenodo now via a `.zenodo.json` file. This might come in handy for people who use VOLK in publications. As a contributor, if you want more information about yourself added to VOLK, feel free to add your ORCiD and affiliation. In the past, we relied on Boost for several tasks in `volk_profile`. For years, we minimized Boost usage to `boost::filesystem`. We mostly switched to C++17 `std::filesystem` years ago. The last distribution in our CI system that required Boost to build VOLK, was Ubuntu 14.04. Thus, now is the time to remove the Boost dependency completely and rely on C++17 features. Some VOLK kernels are untested for years. We decided to deprecate these kernels but assume that nobody uses them anyways. If your compiler spits out a warning that you use a deprecated kernel, get in touch. Besides, we received fixes for various kernels. Especially FEC kernels are notoriously difficult to debug because issues often pop up as performance regressions. Finally, we saw a lot of housekeeping in different areas. Scripts to support us in our LGPL relicensing effort, updated docs, and updated our code of conduct. We could remove some double entries in our QA system and fixed a `volk_malloc` bug that ASAN reported. Finally, we switched to the Python `sysconfig` module in our build system to ensure Python 3.12+ does not break our builds. ### Contributors * A. Maitland Bottoms * Aang23 * AlexandreRouma * Andrej Rode * Ben Hilburn * Bernhard M. Wiedemann * Brennan Ashton * Carles Fernandez * Clayton Smith * Doug * Douglas Anderson * Florian Ritterhoff * Jaroslav Škarvada * Johannes Demel * Josh Blum * Kyle A Logue * Luigi Cruz * Magnus Lundmark * Marc L * Marcus Müller * Martin Kaesberger * Michael Dickens * Nathan West * Paul Cercueil * Philip Balister * Ron Economos * Ryan Volz * Sylvain Munaut * Takehiro Sekine * Vanya Sergeev * Vasil Velichkov * Zlika * namccart * dernasherbrezon * rear1019 ### Changes * Kernels - Fixup underperforming GENERIC kernel for volk_8u_x4_conv_k7_r2_8u - volk_32fc_x2_conjugate_dot_prod_32fc: New generic implementation - Add volk_32f(c)_index_min_16/32u - Fix volk_32fc_index_min_32u_neon - Fix volk_32fc_index_min_32u_neon * Misc - Fix volk_malloc alignment bug - qa: Remove repeating tests - python: Switch to sysconfig module - deprecate: Add attribute deprecated - deprecate: Exclude warnings on Windows - docs: Update docs - Add the list of contributors agreeing to LGPL licensing - Add a script to count the lines that are pending resubmission - Testing: Add test for LGPL licensing - Update CODE_OF_CONDUCT file * Boost - boost: Remove boost dependency - c++: Require C++17 for std::filesystem * cpu_features cpu_features: Update submodule pointer cpu_features: Make cpu_features submodule optional * Zenodo zenodo: Add metadata file zenodo: Re-organize .zenodo.json ## [2.5.2] - 2022-09-04 Hi everyone! We have a new VOLK release! We are happy to announce VOLK v2.5.2! We want to thank all contributors. This release wouldn't have been possible without them. We are happy to announce that our re-licensing effort is complete. This has been a long and challenging journey. Being technical: There are 3 people left (out of 74) who we haven't been able to get in contact with (at all), for a total of 4 (out of 1092) commits, 13 (of 282822) additions, and 7 (of 170421) deletions. We have reviewed these commits and all are simple changes (e.g., 1 line change) and most are no longer relevant (e.g., to a file that no longer exists). VOLK maintainers are in agreement that the combination -- small numbers of changes per committer, simple changes per commit, commits no longer relevant -- means that we can proceed with re-licensing without the approval of the folks. We will try reaching out periodically to these folks, but we believe it unlikely we will get a reply. This maintainance release is intended to be the last VOLK 2.x release. After we completed our re-licensing effort, we want to make a VOLK 3.0 release soon. VOLK 3.0 will be fully compatible with VOLK 2.x on a technical level. However, VOLK 3+ will be released under LGPL. We are convinced a license change justifies a major release. ### Contributors * Aang23 * Clayton Smith * Johannes Demel , * Michael Dickens * Michael Roe ### Changes * Android - Add Android CI - Fix armeabi-v7a on Android * CI - Update all test jobs to more recent actions * volk_8u_x4_conv_k7_r2_8u - Add NEON implementation `neonspiral` via `sse2neon.h` * Fixes - Fix out-of-bounds reads - Fix broken neon kernels - Fix float to int conversion * CMake - Suppress superfluous warning - Fix Python install path calculation and documentation * cpu_features - Update submodule pointer * VOLK 3.0 release preparations - Use SPDX license identifiers everywhere - Re-arrange files in top-level folder - Update Doxygen and all Doxygen related tasks into `docs` ## [3.0.0] - 2023-01-14 Hi everyone! This is the VOLK v3.0.0 major release! This release marks the conclusion of a long lasting effort to complete [GREP 23](https://github.com/gnuradio/greps/blob/main/grep-0023-relicense-volk.md) that proposes to change the VOLK license to LGPLv3+. We would like to thank all VOLK contributors that they allowed this re-licensing effort to complete. This release wouldn't have been possible without them. For VOLK users it is important to not that the VOLK API does NOT change in this major release. After a series of discussion we are convinced a license change justifies a major release. Thus, you may switch to VOLK 3 and enjoy the additional freedom the LGPL offers. ### Motivation for the switch to LGPLv3+ We want to remove usage entry barriers from VOLK. As a result, we expect greater adoption and a growing user and contributor base of VOLK. This move helps to spread the value of Free and Open Source Software in the SIMD community, which so far is dominated by non-FOSS software. Moreover, we recognize the desire of our long term contributors to be able to use VOLK with their contributions in their projects. This may explicitly include proprietary projects. We want to enable all contributors to be able to use VOLK wherever they want. At the same time, we want to make sure that improvements to VOLK itself are easily obtained by everyone, i.e. strike a balance between permissiveness and strict copyleft. Since VOLK is a library it should choose a fitting license. If we see greater adoption of VOLK in more projects, we are confident that we will receive more contributions. May it be bug fixes, new kernels or even contributions to core features. Historically, VOLK was part of GNU Radio. Thus, it made total sense to use GPLv3+ just like GNU Radio. Since then, VOLK became its own project with its own repository and leadership. While it is still a core dependency of GNU Radio and considers GNU Radio as its main user, others may want to use it too. Especially, long term VOLK contributors may be able to use VOLK in a broader set of projects now. After a fruitful series of discussions we settled on the LGPLv3+. We believe this license strikes a good balance between permissiveness and strict copyleft for VOLK. We hope to foster contributions to VOLK. Furthermore, we hope to see VOLK usage in a wider set of projects. ### Contributors The VOLK 3.0.0 release is only possible because all contributors helped to make it possible. Thus, we omit a list of contributors that contributed since the last release. Instead we want to thank everyone again! ### Changes * License switch to LGPLv3+ * Fix build for 32 bit arm with neon * Add experimental support for MIPS and RISC-V ## [3.1.0] - 2023-12-05 Hi everyone! This is the VOLK v3.1.0 release! We want to thank all contributors. This release wouldn't have been possible without them. This release introduces new kernels, fixes a lot of subtle bugs, and introduces an updated API that allows VOLK to run on PowerPC and MIPS platforms without issues. Namely, complex scalar values are passed to kernels by pointer instead of by value. The old API is still around and will be for the whole VOLK v3 release cycle. However, it is recommended to switch to the new API for improved compatibility. Besides, we saw improvements to our `cpu_features` usage that should make it easier for package maintainers. Finally, a lot of tests received fixes that allow our CI to run without hiccups. ### Contributors * A. Maitland Bottoms * Andrej Rode * Ashley Brighthope * Clayton Smith * Daniel Estévez * Johannes Demel , * John Sallay * Magnus Lundmark , * Marcus Müller * Michael Roe * Thomas Habets ### Changes - Build and dependency updates - omit build path - cmake: Link to cpu_features only in BUILD_INTERFACE - cpu_features: Update submodule pointer and new CMake target name - cmake: Removed duplicated logic - cmake: Do not install cpu_features with volk - Use CMake target in one more place - Fix typo in the CMake target name - Use CpuFeatures target - Use cpu_features on RISC-V platforms - cpu_features: Update submodule pointer - Add UBSAN to ASAN builds - CI fixes - Add length checks to volk_8u_x2_encodeframepolar_8u - Fix flaky qa_volk_32f_s32f_convertpuppet_8u - Use absolute tolerance for stddev_and_mean - Use absolute tolerance for sum_of_poly kernel - Add length checks to conv_k7 kernels - Fix variable name in dot product kernels - Fix buffer overflow in volk_32fc_x2_square_dist_32f_a_sse3 - Increase tolerance for volk_32f_log2_32f - Re-enable tests on aarch64 clang-14 - Fix undefined behaviour in volk_8u_x4_conv_k7_r2_8u - Fix undefined behaviour in volk_32u_reverse_32u - Fix aligned loads and stores in unaligned kernels - Fix register size warnings in reverse kernel - Fix undefined behaviour in dot product kernels - Use an absolute tolerance to test the dot product kernels - Always initialize returnValue - Add length checks to puppets - Add carriage return to error message - Include ORC in neonv8 machine definition - Add back volk_32f_exp_32f test - Generate random integers with uniform_int_distribution - Fix puppet master name for volk_32u_popcnt - Avoid integer overflow in volk_8ic_x2_multiply_conjugate_16ic corner case - Use a reasonable scalar and tolerance for spectral_noise_floor - Increase volk_32f_x2_dot_prod_16i tolerance to 1 - Increase tolerance for the power_spectrum test - Decrease the range for signed 16-bit integer testing - Use a puppet to pass positive values to volk_32f_x2_pow_32f - Use absolute tolerances for accumulator and dot product - Fix AppVeyor git checkout - new kernel API - Use pointers to pass in s32fc arguments - The old API is deprecated but will be available for the foreseeable future - updated kernels - Remove unused ORC code - Prefer NEON kernels over ORC - Require all kernels to have a generic implementation - Remove redundant a_generic kernels - Remove ORC kernels that use sqrtf - reverse: Rename dword_shuffle to generic - volk_32f_s32f_convert_8i: code style - volk_32fc_x2_divide_32fc: add documentation about numerical accuracy - kernel: Refactor 32f_s32f_multiply_32f kernel - kernel: Refactor 32f_x2_subtract_32f kernel - convert 32f->32i: fix compiler warnings about loss of int precision - 64u_ byteswape: remove buggy Neonv8 protokernel - 64u_ byteswape: remove buggy Neon protokernel - Remove broken volk_16i_max_star_16i_neon protokernel - Fix truncate-toward-zero distortion - Fix encodepolar documentation - new kernels - add volk_32f_s32f_x2_convert_8u kernel - Fix documentation for the clamp kernel - added new kernel: volk_32f_s32f_x2_clamp - new kernels for atan2 - Add 32f_s32f_multiply_32f RISC-V manually optimized assembly - Add .size to volk_32f_s32f_multiply_32f_sifive_u74 - Add volk_32fc_x2_dot_prod_32fc_sifive_u74 ## [3.1.1] - 2024-01-29 Hi everyone! This is the VOLK v3.1.1 release! We want to thank all contributors. This release wouldn't have been possible without them. This is a maintenance release to fix subtle bugs in many areas and to improve our tests where possible. All in all, our CI is more stable now and catches more errors. ### Contributors Clayton Smith Johannes Demel , Kenji Rikitake Philip Balister ### Changes - CI fixes - Allow for rounding error in float-to-int conversions - Allow for rounding error in `volk_32fc_s32f_magnitude_16i` - Allow for rounding error in float-to-int interleave - Add missing `volk_16_byteswap_u_orc` to puppet - Fix 64-bit integer testing - Build and test neonv7 protokernels on armv7 - kernels - Remove broken sse32 kernels - Fix flaky `fm_detect` test - Fix flaky `mod_range` test - Remove unnecessary volatiles from `volk_32fc_s32f_magnitude_16i` - Remove SSE protokernels written in assembly - Remove inline assembler from `volk_32fc_convert_16ic_neon` - Use bit shifts in generic and `byte_shuffle` reverse - Remove disabled SSE4.1 dot product - Fix `conv_k7_r2` kernel and puppet - Remove unused argument from renormalize - Align types in ORC function signatures - Uncomment AVX2 implementation - Renormalize in every iteration on AVX2 - Remove extraneous permutations - Compute the minimum over both register lanes - `volk_32fc_s32f_atan2_32f`: Add NaN tests for avx2 and avx2fma code - fixes - Express version information in decimal - Remove `__VOLK_VOLATILE` - Remove references to simdmath library - cmake: Switch to GNUInstallDirs - fprintf: Remove fprintf statements from `volk_malloc` - release: Prepare release with updated files - Get the sse2neon.h file to a git submodule to avoid random copies. ## [3.1.2] - 2024-02-25 Hi everyone! This is the VOLK v3.1.2 release! We want to thank all contributors. This release wouldn't have been possible without them. The last maintenance release revealed issues in areas that are difficult to test. While the changes to the library should be minimal, usability should be improved. Most notably, we build and deploy [the VOLK documentation](https://www.libvolk.org/docs) automatically now. ### Contributors - Andrej Rode - Clayton Smith - Johannes Demel , - Marcus Müller - Rick Farina (Zero_Chaos) ### Changes - Documentation improvements, and automatically generate and publish - docs: Add VOLK doc build to CI - docs: Add upload to GitHub actions - cpu_features: Update hints in README - Remove sse2neon with a native NEON implementation - Replace sse2neon with native NEON - Remove loop unrolling - Simplify Spiral-generated code - Improve CI pipeline with new runner - flyci: Test CI service with M2 instance - actions: Update GH Actions checkout - Auto-format CMake files - cmake: Add .cmake-format.py - cmake: Apply .cmake-format.py - Release script fixes - scripts/release: fix multi-concatenation of submodule tars - shellcheck fixes - bash negative exit codes are not portable, let's be positive volk-3.1.2/docs/CMakeLists.txt000066400000000000000000000010621456660453300161730ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # Copyright 2022 Johannes Demel. # # SPDX-License-Identifier: LGPL-3.0-or-later # find_package(Doxygen) if(DOXYGEN_FOUND) message(STATUS "Doxygen found. Building docs ...") configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_BINARY_DIR}/Doxyfile @ONLY) add_custom_target( volk_doc ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile WORKING_DIRECTORY ${CMAKE_BINARY_DIR} COMMENT "Generating documentation with Doxygen" VERBATIM) endif(DOXYGEN_FOUND) volk-3.1.2/docs/CODE_OF_CONDUCT.md000066400000000000000000000117561456660453300162450ustar00rootroot00000000000000# VOLK Code of Conduct This Code of Conduct is adapted from the GNU Radio Code of Conduct, available in the [gr-governance repository][GRCoC], dated 2021-07-12. ## Our Pledge We as members, contributors, and leaders strive to make participation in our community a harassment-free experience for everyone. Qualities and characteristics we note specifically include regardless of age, body size, visible or invisible disability, visible or invisible enhancement, ethnicity, sex characteristics, gender identity, gender expression, sexual identity, sexual orientation, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, and military status -- but lists like these cannot be complete and hence we note "**for everyone**" in order to be as inclusive as possible. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards Examples of behavior that contributes to a positive environment for our community include: * Demonstrating empathy and kindness toward other people * Being respectful of differing opinions, viewpoints, and experiences * Giving and gracefully accepting constructive feedback * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience * Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: * The use of sexualized language or imagery, and sexual attention or advances of any kind * Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at **conduct@gnuradio.org** . All complaints will be reviewed and investigated promptly and fairly. All complain handlers are obligated to respect the privacy and security of the reporter of any incident. ## Enforcement Guidelines Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: ### 1. Correction **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. **Consequence**: A private, written warning from Project maintainers, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. ### 2. Warning **Community Impact**: A violation through a single incident or series of actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. ### 3. Temporary Ban **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within the community. [GRCoC]: https://github.com/gnuradio/gr-governance/blob/main/CODE_OF_CONDUCT.md volk-3.1.2/docs/CONTRIBUTING.md000066400000000000000000000066121456660453300156720ustar00rootroot00000000000000# Contributing to VOLK Welcome! You are reading about how to contribute code to VOLK. First of all, we are very happy that you're about to contribute, and welcome your submissions! We hope many more will come. In this document, we will explain the main things to consider when submitting pull requests against VOLK. Reading this first will help a lot with streamlining the process of getting your code merged. There is also a [wiki-based version of this file][wikicontrib], which contains more detail. VOLK is part of the GNU Radio project and as such, it follows the same contribution guidelines. This file is an [adopted GNU Radio checklist][gnuradiocontrib]. ## What about non-code contributions? Those are at least as important as code contributions: Emails to the mailing list, answers on Stack Overflow, Wiki page edits, examples... We very much appreciate those. However, this document is specifically about contributing code. ## DCO Signed? Any code contributions going into VOLK will become part of an LGPL-licensed (former contributions are GPL-licensed), open source repository. It is therefore imperative that code submissions belong to the authors, and that submitters have the authority to merge that code into the public VOLK codebase. For that purpose, we use the [Developer's Certificate of Origin](DCO.txt). It is the same document used by other projects. Signing the DCO states that there are no legal reasons to not merge your code. To sign the DCO, suffix your git commits with a "Signed-off-by" line. When using the command line, you can use `git commit -s` to automatically add this line. If there were multiple authors of the code, or other types of stakeholders, make sure that all are listed, each with a separate Signed-off-by line. ## Coding Guidelines We have codified our coding guidelines in [GNU Radio GREP1][grep1]. Please read them, and stick to them. For C/C++ code, use clang-format. For Python, PEP8 is your friend (but again, check the actual coding guidelines). ## Git commit messages are very important We follow standard git commit message guidelines, similar to many other open source projects. See the [coding guidelines][grep1] for more details. In a nutshell: - Keep the lines below 72 characters - Subject line has the component prepended (e.g., `kernelname:`) - Avoid empty git commit messages - The git commit message explains the change, the code only explains the current state ## Unit Tests VOLK unit tests compare the results of each kernel version to the generic version. Keep the generic kernel version as simple as possible and verify your optimized kernels against the generic version. ## The Buddy Principle: Submit One, Review One When you've submitted a pull request, please take the time to review another one. This helps make sure that there are always a number of reviews at least equal to the number of pull requests, which means the maintainers don't get overwhelmed when a lot is being contributed. ## Standard command line options When writing programs that are executable from the command line, please follow existing examples regarding their command line arguments, and reuse them. [grep1]: https://github.com/gnuradio/greps/blob/master/grep-0001-coding-guidelines.md [wikicontrib]: https://wiki.gnuradio.org/index.php/Development [gr-devs]: https://github.com/orgs/gnuradio/teams/gr-devs [gnuradiocontrib]: https://github.com/gnuradio/gnuradio/blob/master/CONTRIBUTING.md volk-3.1.2/docs/DCO.txt000066400000000000000000000026151456660453300146060ustar00rootroot00000000000000Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. volk-3.1.2/docs/Doxyfile.in000066400000000000000000003444741456660453300155670ustar00rootroot00000000000000# Doxyfile 1.9.1 # 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 configuration # 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 # https://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 = "Vector Optimized Library of Kernels" # 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 = @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 = "Architecture-tuned implementations of math kernels" # 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 = @CMAKE_SOURCE_DIR@/docs/volk_logo_small.png # 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 = # 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 = NO # 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 # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all generated output in the proper direction. # Possible values are: None, LTR, RTL and Context. # The default value is: None. OUTPUT_TEXT_DIRECTION = None # 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 JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as # /*************** # as being the beginning of a Javadoc-style comment "banner". If set to NO, the # Javadoc-style will behave just like regular comments and it will not be # interpreted by doxygen. # The default value is: NO. JAVADOC_BANNER = 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 # By default Python docstrings are displayed as preformatted text and doxygen's # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the # doxygen's special commands can be used and the contents of the docstring # documentation blocks is shown as doxygen documentation. # The default value is: YES. PYTHON_DOCSTRING = YES # 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 (in the resulting output). You can put ^^ in the value part of an # alias to insert a newline as if a physical newline was in the original file. # When you need a literal { or } or , in the value part of an alias you have to # escape them by means of a backslash (\), this can lead to conflicts with the # commands \{ and \} for these it is advised to use the version @{ and @} or use # a double escape (\\{ and \\}) ALIASES = # 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 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice # sources only. Doxygen will then generate output that is more tailored for that # language. For instance, namespaces will be presented as modules, types will be # separated into more groups, etc. # The default value is: NO. OPTIMIZE_OUTPUT_SLICE = 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, # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, # 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). 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. When specifying no_extension you should add # * to the FILE_PATTERNS. # # Note see also the list of default file extension mappings. 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 https://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 the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. # Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 5 # 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: # https://www.riverbankcomputing.com/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 = NO # 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 # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use # during processing. When set to 0 doxygen will based this on the number of # cores available in the system. You can set it explicitly to a value larger # than 0 to get more control over the balance between CPU load and processing # speed. At this moment only the input processing can be done using multiple # threads. Since this is still an experimental feature the default is set to 1, # which efficively disables parallel processing. Please report any issues you # encounter. Generating dot graphs in parallel is controlled by the # DOT_NUM_THREADS setting. # Minimum value: 0, maximum value: 32, default value: 1. NUM_PROC_THREADS = 1 #--------------------------------------------------------------------------- # 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_PRIV_VIRTUAL tag is set to YES, documented private virtual # methods of a class will be included in the documentation. # The default value is: NO. EXTRACT_PRIV_VIRTUAL = 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 = YES # 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 this flag is set to YES, the name of an unnamed parameter in a declaration # will be determined by the corresponding definition. By default unnamed # parameters remain unnamed in the output. # The default value is: YES. RESOLVE_UNNAMED_PARAMS = YES # 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 = YES # 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 = YES # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # 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 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be # able to match the capabilities of the underlying filesystem. In case the # filesystem is case sensitive (i.e. it supports files in the same directory # whose names only differ in casing), the option must be set to YES to properly # deal with such files in case they appear in the input. For filesystems that # are not case sensitive the option should be be set to NO to properly deal with # output files written for symbols that only differ in casing, such as for two # classes, one named CLASS and the other named Class, and to also support # references to files without having to specify the exact matching casing. On # Windows (including Cygwin) and MacOS, users should typically set this option # to NO, whereas on Linux or other Unix flavors it should typically be set to # YES. # 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 = NO # 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 = NO # 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 = NO # 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 = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml # 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 https://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. If # EXTRACT_ALL is set to YES then this flag will automatically be disabled. # 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. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but # at the end of the doxygen process doxygen will return with a non-zero status. # Possible values are: NO, YES and FAIL_ON_WARNINGS. # 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 = @CMAKE_SOURCE_DIR@ # 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: # https://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. # # Note the list of default checked file patterns might differ from the list of # default file extension mappings. # # 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 (to be provided as doxygen C comment), # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, # *.ucf, *.qsf and *.ice. 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 = YES # 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 = @CMAKE_BINARY_DIR@ \ @CMAKE_SOURCE_DIR@/cpu_features \ @CMAKE_SOURCE_DIR@/include/volk/sse2neon \ @CMAKE_SOURCE_DIR@/README.md \ @CMAKE_SOURCE_DIR@/docs/AUTHORS_RESUBMITTING_UNDER_LGPL_LICENSE.md # 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 = # 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 = NO # 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 # entity 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 https://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 configuration 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 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: # http://clang.llvm.org/) for more accurate parsing at the cost of reduced # performance. This can be particularly helpful with template rich C++ code for # which doxygen's built-in parser lacks the necessary type information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to # YES then doxygen will add the directory of each input to the include path. # The default value is: YES. CLANG_ADD_INC_PATHS = YES # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_OPTIONS = # If clang assisted parsing is enabled you can provide the clang parser with the # path to the directory containing a file called compile_commands.json. This # file is the compilation database (see: # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the # options used when the source files were built. This is equivalent to # specifying the -p option to a clang tool, such as clang-check. These options # will then be passed to the parser. Any options specified with CLANG_OPTIONS # will be added as well. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. CLANG_DATABASE_PATH = #--------------------------------------------------------------------------- # 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 # 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 = # 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 = # 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 # https://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 = NO # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML # page. Disable this option to support browsers that do not have JavaScript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_MENUS = 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: # https://developer.apple.com/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 https://developer.apple.com/library/archive/featuredarticles/Doxy # genXcode/_index.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: # https://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 main .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: # https://doc.qt.io/archives/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: # https://doc.qt.io/archives/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: # https://doc.qt.io/archives/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: # https://doc.qt.io/archives/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: # https://doc.qt.io/archives/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 (absolute path # including file name) 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 = YES # 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 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see # https://inkscape.org) to generate formulas as SVG images instead of PNGs for # the HTML output. These images will generally look nicer at scaled resolutions. # Possible values are: png (the default) and svg (looks nicer but requires the # pdf2svg or inkscape tool). # The default value is: png. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FORMULA_FORMAT = png # 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_TRANSPARENT 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 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. FORMULA_MACROFILE = # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # https://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/v2.7-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 https://www.mathjax.org before deployment. # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. # 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/v2.7-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 # , /