diff --git a/.clang-format b/.clang-format new file mode 100644 index 00000000..e75aef3a --- /dev/null +++ b/.clang-format @@ -0,0 +1,53 @@ +# AMD Infinity Storage C/C++ clang-format file +# +# For v18 formatting options: +# https://releases.llvm.org/18.1.6/tools/clang/docs/ClangFormatStyleOptions.html + +BasedOnStyle: LLVM + +AccessModifierOffset: -4 + +AlignConsecutiveAssignments: Consecutive +AlignConsecutiveDeclarations: Consecutive +AlignConsecutiveMacros: Consecutive + +AllowShortFunctionsOnASingleLine: None +AllowShortIfStatementsOnASingleLine: Never + +AlwaysBreakAfterReturnType: TopLevelDefinitions + +BraceWrapping: + BeforeCatch: true + BeforeElse: true + +BreakBeforeBraces: Stroustrup + +BreakStringLiterals: true + +ColumnLimit: 110 + +FixNamespaceComments: false + +IndentAccessModifiers: false +IndentCaseLabels: true +IndentGotoLabels: false +IndentWidth: 4 + +NamespaceIndentation: Inner + +PointerAlignment: Right + +ReflowComments: true + +SortIncludes: false + +StatementMacros: + - HIPFILE_WARN_FORMAT_NONLITERAL_OFF + - HIPFILE_WARN_FORMAT_NONLITERAL_ON + - HIPFILE_WARN_NO_EXIT_DTOR_OFF + - HIPFILE_WARN_NO_EXIT_DTOR_ON + - HIPFILE_WARN_NO_GLOBAL_CTOR_OFF + - HIPFILE_WARN_NO_GLOBAL_CTOR_ON + +TabWidth: 4 +UseTab: Never diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 00000000..892f73de --- /dev/null +++ b/.codespellrc @@ -0,0 +1,5 @@ +# codespell config file docs: +# https://github.com/codespell-project/codespell#using-a-config-file +[codespell] +check-hidden = true +skip = ./.git diff --git a/.github/workflows/ais_ci.yml b/.github/workflows/ais_ci.yml new file mode 100644 index 00000000..6d30fa1c --- /dev/null +++ b/.github/workflows/ais_ci.yml @@ -0,0 +1,20 @@ +name: AIS_CI +run-name: Kicks off several AIS CI workflows for various platforms. +on: + pull_request: + types: [opened, synchronize, reopened] # Defaults +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true +jobs: + AIS_CI: + strategy: + fail-fast: false + matrix: + supported_platforms: + - ubuntu + - rocky + - suse + uses: ./.github/workflows/build_ais.yml + with: + platform: ${{matrix.supported_platforms}} diff --git a/.github/workflows/build_ais.yml b/.github/workflows/build_ais.yml new file mode 100644 index 00000000..b7eccde1 --- /dev/null +++ b/.github/workflows/build_ais.yml @@ -0,0 +1,410 @@ +name: AIS # Mono-workflow - May be advantageous to split up +run-name: Build, Test, and Analyze AIS +env: + AIS_MOUNT_PATH: /mnt/ais/ext4 + AIS_DOCKER_REGISTRY: ghcr.io/rocm/rocs-internal + AIS_CI_IMAGE_NAME: ais_ci_${{inputs.platform}} + AIS_PR_BASE_URL: https://github.com/ROCm/rocs-internal/pull +on: + workflow_call: + inputs: + platform: + required: true + type: string +permissions: + contents: read + packages: write +jobs: + build_AIS_image: + runs-on: [ubuntu-24.04] + container: docker:28.5 + steps: + - name: Set AIS CI image environment variables + run: | + echo "AIS_CI_DEV_IMAGE=${{ env.AIS_DOCKER_REGISTRY }}/${{ env.AIS_CI_IMAGE_NAME }}_dev:$(echo ${{ github.ref }} \ + | sed 's|[^a-zA-Z0-9]|-|g')" >> "$GITHUB_ENV" + echo "AIS_CI_LATEST_IMAGE=${{ env.AIS_DOCKER_REGISTRY }}/${{ env.AIS_CI_IMAGE_NAME }}:latest" >> "$GITHUB_ENV" + echo "AIS_PR_NUMBER=$(echo ${{ github.ref }} | sed 's|[^0-9]||g')" >> "$GITHUB_ENV" + - name: Fetching code repository... + uses: actions/checkout@v5 + - name: Authenticating to GitHub Container Registry. + uses: docker/login-action@v3.6.0 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Setup Docker Builder + uses: docker/setup-buildx-action@v3.11.1 + with: + name: ais-builder + driver: docker-container + cache-binary: false # True uses the GHA Cache Backend. + - name: Build base image for AIS CI + run: | + docker buildx build \ + -f ${GITHUB_WORKSPACE}/util/docker/DOCKERFILE.${{ env.AIS_CI_IMAGE_NAME }} \ + --label "org.opencontainers.image.description= \ + ${{ env.AIS_CI_IMAGE_NAME }} Development Image for AIS CI using branch \ + ${{ github.head_ref }} for PR #${AIS_PR_NUMBER}. \ + PR URL: ${{ env.AIS_PR_BASE_URL }}/${AIS_PR_NUMBER}" \ + --cache-to=type=registry,ref="${{ env.AIS_DOCKER_REGISTRY }}/${{ env.AIS_CI_IMAGE_NAME }}_dev:cache" \ + --cache-from=type=registry,ref="${{ env.AIS_DOCKER_REGISTRY }}/${{ env.AIS_CI_IMAGE_NAME }}_dev:cache" \ + --push \ + -t ${AIS_CI_DEV_IMAGE} \ + ${GITHUB_WORKSPACE} + compile_on_AMD: + runs-on: [ubuntu-24.04] + needs: build_AIS_image + steps: + - name: Get PR number and store it as a environment variable + run: echo "AIS_PR_NUMBER=$(echo ${{ github.ref }} | sed 's|[^0-9]||g')" >> "$GITHUB_ENV" + - name: Set AIS CI image environment variables + run: | + echo "AIS_CI_DEV_IMAGE=${{ env.AIS_DOCKER_REGISTRY }}/${{ env.AIS_CI_IMAGE_NAME }}_dev:$(echo ${{ github.ref }} \ + | sed 's|[^a-zA-Z0-9]|-|g')" >> "$GITHUB_ENV" + echo "AIS_CONTAINER_NAME=${AIS_PR_NUMBER}_${{ github.job }}_${{inputs.platform}}" >> "$GITHUB_ENV" + - name: Fetching code repository... + uses: actions/checkout@v5 + - name: Authenticating to GitHub Container Registry + uses: docker/login-action@v3.6.0 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + # Detach the container and run separate commands to it. + # Thus we can make separate explicit steps in the Github CI + # as if we were able to parameterize the container image in the first place. + - name: Starting Docker Container + run: | + docker run \ + -dt \ + --rm \ + --pull always \ + -v ${GITHUB_WORKSPACE}:/mnt/ais:ro \ + -v ${{ env.AIS_MOUNT_PATH }}:/mnt/ais-fs \ + --name ${AIS_CONTAINER_NAME} \ + ${AIS_CI_DEV_IMAGE} + - name: Make copy of the code repository and create build directories + # Single quotes necessary to ensure string/command substitutions happen + # in the container and not on the host. + run: | + docker exec \ + -t \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cp -R /mnt/ais /ais + mkdir /ais/build + ' + - name: Generate build files for hipFile and rocFile targeting the AMD platform (amdclang++) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cmake \ + -DCMAKE_CXX_COMPILER=amdclang++ \ + -DCMAKE_CXX_FLAGS="-Werror" \ + -DCMAKE_HIP_PLATFORM=amd \ + -DBUILD_AIS_DOCS=ON \ + -DBUILD_CODE_COVERAGE=ON \ + .. + ' + - name: Build hipFile and rocFile for the AMD platform (amdclang++) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cmake --build . --parallel + ' + - name: Test hipFile and rocFile for the AMD platform (amdclang++) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + ctest -V -L "unit" --parallel + ' + - name: Generate coverage summary (amdclang++) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + export PATH="/opt/rocm/llvm/bin:$PATH" + ../util/llvm-coverage.sh + printf "# Code Coverage\n" + printf "\`\`\`\n" + cat coverage-report.txt + printf "\`\`\`\n" + ' >> $GITHUB_STEP_SUMMARY + if: ${{ inputs.platform == 'ubuntu' }} + - name: Clean CMake build directories + run: | + docker exec \ + -t \ + -w /ais \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + rm -rf build/* + ' + - name: Cleanup & Stop the Docker container + if: ${{ always() }} + run: | + docker stop ${AIS_CONTAINER_NAME} + compile_on_AMD_other: + runs-on: [ubuntu-24.04] + needs: build_AIS_image + strategy: + fail-fast: false + matrix: + alternate_compilers: + - clang++ + - g++ + steps: + - name: Get PR number and store it as a environment variable + run: echo "AIS_PR_NUMBER=$(echo ${{ github.ref }} | sed 's|[^0-9]||g')" >> "$GITHUB_ENV" + - name: Set AIS CI image environment variables + run: | + echo "AIS_CI_DEV_IMAGE=${{ env.AIS_DOCKER_REGISTRY }}/${{ env.AIS_CI_IMAGE_NAME }}_dev:$(echo ${{ github.ref }} \ + | sed 's|[^a-zA-Z0-9]|-|g')" >> "$GITHUB_ENV" + echo "AIS_CONTAINER_NAME=${AIS_PR_NUMBER}_${{ github.job }}_${{inputs.platform}}" >> "$GITHUB_ENV" + - name: Fetching code repository... + uses: actions/checkout@v5 + - name: Authenticating to GitHub Container Registry + uses: docker/login-action@v3.6.0 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Starting Docker Container + run: | + docker run \ + -dt \ + --rm \ + --pull always \ + -v ${GITHUB_WORKSPACE}:/mnt/ais:ro \ + -v ${{ env.AIS_MOUNT_PATH }}:/mnt/ais-fs \ + --name ${AIS_CONTAINER_NAME} \ + ${AIS_CI_DEV_IMAGE} + - name: Make copy of the code repository and create build directories + run: | + docker exec \ + -t \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cp -R /mnt/ais /ais + mkdir /ais/build + ' + - name: Generate build files for hipFile and rocFile targeting the AMD platform (${{ matrix.alternate_compilers }}) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cmake \ + -DCMAKE_CXX_COMPILER=${{ matrix.alternate_compilers }} \ + -DCMAKE_CXX_FLAGS="-Werror" \ + -DCMAKE_HIP_PLATFORM=amd \ + -DBUILD_AIS_DOCS=ON \ + .. + ' + - name: Build hipFile and rocFile for the AMD platform (${{ matrix.alternate_compilers }}) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cmake --build . --parallel + ' + - name: Cleanup & Stop the Docker container + if: ${{ always() }} + run: | + docker stop ${AIS_CONTAINER_NAME} + AMD_system_tests: + runs-on: [linux, AIS] + needs: compile_on_AMD + steps: + - name: Get PR number and store it as a environment variable + run: echo "AIS_PR_NUMBER=$(echo ${{ github.ref }} | sed 's|[^0-9]||g')" >> "$GITHUB_ENV" + - name: Set AIS CI image environment variables + run: | + echo "AIS_CI_DEV_IMAGE=${{ env.AIS_DOCKER_REGISTRY }}/${{ env.AIS_CI_IMAGE_NAME }}_dev:$(echo ${{ github.ref }} \ + | sed 's|[^a-zA-Z0-9]|-|g')" >> "$GITHUB_ENV" + echo "AIS_CONTAINER_NAME=${AIS_PR_NUMBER}_${{ github.job }}_${{inputs.platform}}_nvidia" >> "$GITHUB_ENV" + - name: Fetching code repository... + uses: actions/checkout@v5 + - name: Authenticating to GitHub Container Registry + uses: docker/login-action@v3.6.0 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + # Detach the container and run separate commands to it. + # Thus we can make separate explicit steps in the Github CI + # as if we were able to parameterize the container image in the first place. + - name: Starting Docker Container + run: | + docker run \ + -dt \ + --rm \ + --device=/dev/kfd \ + --device=/dev/dri \ + --security-opt seccomp=unconfined \ + --pull always \ + -v ${GITHUB_WORKSPACE}:/mnt/ais:ro \ + -v ${{ env.AIS_MOUNT_PATH }}:/mnt/ais-fs \ + --name ${AIS_CONTAINER_NAME} \ + ${AIS_CI_DEV_IMAGE} + - name: Make copy of the code repository and create build directories + run: | + docker exec \ + -t \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cp -R /mnt/ais /ais + mkdir /ais/build + ' + - name: Generate build files for hipFile and rocFile targeting the AMD platform (amdclang++) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cmake \ + -DCMAKE_CXX_COMPILER=amdclang++ \ + -DCMAKE_CXX_FLAGS="-Werror" \ + -DCMAKE_HIP_PLATFORM=amd \ + -DBUILD_AIS_DOCS=ON \ + .. + ' + - name: Build hipFile and rocFile for the AMD platform (amdclang++) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cmake --build . --parallel + ' + - name: Run hipFile and rocFile system tests for the AMD platform (amdclang++) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + ctest -V -L "system" --parallel + ' + - name: Stress tests for hipFile and rocFile targeting the AMD platform (amdclang++) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + ctest -V -L "stress" --parallel + ' + - name: Cleanup & Stop the Docker container + if: ${{ always() }} + run: | + docker stop ${AIS_CONTAINER_NAME} + compile_on_NVIDIA: + runs-on: [ubuntu-24.04] + needs: build_AIS_image + strategy: + fail-fast: false + matrix: + supported_compilers: + - g++ + - clang++ + steps: + - name: Get PR number and store it as a environment variable + run: echo "AIS_PR_NUMBER=$(echo ${{ github.ref }} | sed 's|[^0-9]||g')" >> "$GITHUB_ENV" + - name: Set AIS CI image environment variables + run: | + echo "AIS_CI_DEV_IMAGE=${{ env.AIS_DOCKER_REGISTRY }}/${{ env.AIS_CI_IMAGE_NAME }}_dev:$(echo ${{ github.ref }} \ + | sed 's|[^a-zA-Z0-9]|-|g')" >> "$GITHUB_ENV" + echo "AIS_CONTAINER_NAME=${AIS_PR_NUMBER}_${{ github.job }}_${{inputs.platform}}_nvidia" >> "$GITHUB_ENV" + - name: Fetching code repository... + uses: actions/checkout@v5 + - name: Authenticating to GitHub Container Registry + uses: docker/login-action@v3.6.0 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + # Detach the container and run separate commands to it. + # Thus we can make separate explicit steps in the Github CI + # as if we were able to parameterize the container image in the first place. + - name: Starting Docker Container + run: | + docker run \ + -dt \ + --rm \ + --pull always \ + -v ${GITHUB_WORKSPACE}:/mnt/ais:ro \ + -v ${{ env.AIS_MOUNT_PATH }}:/mnt/ais-fs \ + --name ${AIS_CONTAINER_NAME} \ + ${AIS_CI_DEV_IMAGE} + - name: Make copy of the code repository and create build directories + run: | + docker exec \ + -t \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cp -R /mnt/ais /ais + mkdir /ais/build + ' + - name: Generate build files for hipFile targeting the NVIDIA platform (${{ matrix.supported_compilers }}) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cmake \ + -DCMAKE_CXX_COMPILER=${{ matrix.supported_compilers }} \ + -DCMAKE_CXX_FLAGS="-Werror" \ + -DBUILD_ROCFILE=OFF \ + -DBUILD_HIPFILE=ON \ + -DCMAKE_HIP_PLATFORM=nvidia \ + -DBUILD_AIS_DOCS=ON \ + .. + ' + - name: Build hipFile for the NVIDIA platform (${{ matrix.supported_compilers }}) + run: | + docker exec \ + -t \ + -w /ais/build \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + cmake --build . --parallel + ' + # NVIDIA hipFile unit tests require an NVIDIA GPU to be present. + # See hipfile-e2e-nvidia for where they are run. + - name: Clean CMake build directories + run: | + docker exec \ + -t \ + -w /ais \ + ${AIS_CONTAINER_NAME} \ + /bin/bash -c ' + rm -rf build/* + ' + - name: Cleanup & Stop the Docker container + if: ${{ always() }} + run: | + docker stop ${AIS_CONTAINER_NAME} + Run_hipFile_e2e_NVIDIA: + uses: ./.github/workflows/hipfile-e2e-nvidia.yml + needs: build_AIS_image + with: + platform: ${{inputs.platform}} diff --git a/.github/workflows/check_jenkins.yml b/.github/workflows/check_jenkins.yml new file mode 100644 index 00000000..4cf28089 --- /dev/null +++ b/.github/workflows/check_jenkins.yml @@ -0,0 +1,65 @@ +name: check-jenkins +run-name: Verify Jenkins CI completed successfully. +on: + pull_request: + types: [opened, synchronize, reopened] # Defaults + workflow_dispatch: +permissions: + actions: write + contents: read + statuses: read +jobs: + check-for-jenkins-ci: + runs-on: ubuntu-24.04 + steps: + # https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28#get-the-combined-status-for-a-specific-reference + - name: Check Jenkins CI job status + uses: actions/github-script@v8 + with: + script: | + // What Jenkins jobs to check + const jenkinsCIJobs = [ + 'mci/main/precheckin(rocs-internal)' + ]; + + console.log(`Using context.payload.pull_request.head.sha: ${context.payload.pull_request.head.sha}`); + const { data: githubData } = await github.rest.repos.getCombinedStatusForRef({ + owner: context.repo.owner, + repo: context.repo.repo, + ref: context.payload.pull_request.head.sha, + }); + // console.debug('::debug::Full combined status response:', JSON.stringify(githubData, null, 2)); + + const allCIStatuses = {}; + for (const status of githubData.statuses) { + allCIStatuses[status.context] = status.state; + } + const missingJenkinsCIJobs = jenkinsCIJobs.filter(name => !(name in allCIStatuses)); + const pendingJenkinsCIJobs = jenkinsCIJobs.filter(name => allCIStatuses[name] === 'pending'); + const failedJenkinsCIJobs = jenkinsCIJobs.filter(name => + allCIStatuses[name] === 'failure' || allCIStatuses[name] === 'error' + ); + const passedJenkinsCIJobs = jenkinsCIJobs.filter(name => allCIStatuses[name] === 'success'); + + console.log(`Missing Jenkins CI Jobs: ${missingJenkinsCIJobs.join(', ')}`); + if (missingJenkinsCIJobs.length !== 0) { + console.log(`::error title=Missing Jobs:: ${missingJenkinsCIJobs.length} jobs missing.`); + } + + console.log(`Pending Jenkins CI Jobs: ${pendingJenkinsCIJobs.join(', ')}`); + if (pendingJenkinsCIJobs.length !== 0) { + console.log(`::error title=Pending Jobs:: ${pendingJenkinsCIJobs.length} jobs pending completion.`); + } + + console.log(`Failed Jenkins CI Jobs: ${failedJenkinsCIJobs.join(', ')}`); + if (failedJenkinsCIJobs.length !== 0 ) { + console.log(`::error title=Failed Jobs:: ${failedJenkinsCIJobs.length} jobs failed.`); + } + + console.log(`Passed Jenkins CI Jobs: ${passedJenkinsCIJobs.join(', ')}`); + console.log(`::notice title=Passed Jobs:: ${passedJenkinsCIJobs.length} jobs completed.`); + + if (passedJenkinsCIJobs.length !== jenkinsCIJobs.length) { + throw new Error('Not all Jenkins CI Jobs have passed.'); + } + console.log('All Jenkins CI Jobs have passed.'); diff --git a/.github/workflows/clang-format-check.yml b/.github/workflows/clang-format-check.yml new file mode 100644 index 00000000..fb5d4864 --- /dev/null +++ b/.github/workflows/clang-format-check.yml @@ -0,0 +1,22 @@ +name: clang-format Check +on: + pull_request: + +permissions: + contents: read + +jobs: + formatting-check: + name: Formatting Check + runs-on: ubuntu-latest + if: "!contains(github.event.head_commit.message, 'skip-ci')" + steps: + - uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493 #v4.1.7 + + - name: Run clang-format style check for C/C++ code + uses: DoozyX/clang-format-lint-action@bcb4eb2cb0d707ee4f3e5cc3b456eb075f12cf73 #v0.20 + with: + source: '.' + extensions: 'c,h,cpp' + clangFormatVersion: 18 + style: file diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 00000000..a60a244a --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,14 @@ +# GitHub Action to automate the identification of common misspellings in text files +# https://github.com/codespell-project/codespell +# https://github.com/codespell-project/actions-codespell +name: codespell +on: pull_request +permissions: + contents: read +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493 #v4.1.7 + - uses: codespell-project/actions-codespell@406322ec52dd7b488e48c1c4b82e2a8b3a1bf630 #v2.1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..5274fea0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +*.swp +.vscode + +# Ignore any build generated files. +build/ + +# Ignore .cache directory generated by clangd +.cache/ diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 00000000..f51551bb --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,227 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +# Top-level CMake file for AIS + +# CMake version according to latest ROCm platform requirements +cmake_minimum_required(VERSION 3.21) + +# Set the default build type to Debug +# +# NOTE: This has to be done BEFORE the project is declared! +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE Debug CACHE STRING "Build type") +endif() + +# Set the library version in a variable so we can use +# it in *.in files and avoid version mismatch. +# +# The versions number of rocFile and hipFile are identical +set(AIS_LIBRARY_MAJOR 0) +set(AIS_LIBRARY_MINOR 2) +set(AIS_LIBRARY_PATCH 0) +set(AIS_LIBRARY_VERSION "${AIS_LIBRARY_MAJOR}.${AIS_LIBRARY_MINOR}.${AIS_LIBRARY_PATCH}") + +# Set the SOVERSION to the major library version (this is the default +# but we set it explicitly to convey intent). +# +# Changes to minor and patch releases must NEVER break the ABI. This +# includes things like reordering struct fields that don't break the API. +set(AIS_LIBRARY_SOVERSION "${AIS_LIBRARY_MAJOR}") + +project("ais" + VERSION ${AIS_LIBRARY_VERSION} + DESCRIPTION "High-performance I/O for AMD's ROCm platform" + LANGUAGES C CXX HIP +) + +# Use position-independent code everywhere +set(CMAKE_POSITION_INDEPENDENT_CODE ON) + +# Everything uses C++17, which is mandatory, and we disable extensions (so no -std=gnu++17) +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED TRUE) +set(CMAKE_CXX_EXTENSIONS OFF) + +# Set the list of build types for ccmake/CMake GUI +# +# This turns the build type box into a multi-select so you don't have to +# enter the names manually +# +# "None" sets nothing, so it's easier to override -O flags, etc. +set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "RelWithDebInfo" "MinSizeRel" "None") + +# Enable CTest (the include line automatically calls enable_testing()) +include(CTest) + +# Enable options with dependencies +include(CMakeDependentOption) + +# Ensure compile_commands.json has implicit header paths +if(CMAKE_EXPORT_COMPILE_COMMANDS) + set(CMAKE_CXX_STANDARD_INCLUDE_DIRECTORIES ${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES}) +endif() + +#----------------------------------------------------------------------------- +# Get the HIP platform +#----------------------------------------------------------------------------- +# The default is "amd" if CMAKE_HIP_PLATFORM hasn't been set +if(NOT CMAKE_HIP_PLATFORM) + set(CMAKE_HIP_PLATFORM "amd" CACHE STRING "HIP platform to build with") +endif() +set_property(CACHE CMAKE_HIP_PLATFORM PROPERTY STRINGS "amd" "nvidia") + +# Set the HIP_PLATFORM environment variable so that HIP headers are +# parsed correctly +set(ENV{HIP_PLATFORM} ${CMAKE_HIP_PLATFORM}) + +# Make sure the HIP platform is valid +if(NOT CMAKE_HIP_PLATFORM STREQUAL "amd" AND NOT CMAKE_HIP_PLATFORM STREQUAL "nvidia") + message(FATAL_ERROR "Invalid CMAKE_HIP_PLATFORM: '${CMAKE_HIP_PLATFORM}'. Allowed values are 'amd' or 'nvidia'.") +endif() + +#----------------------------------------------------------------------------- +# Include our custom CMake code in the module path +#----------------------------------------------------------------------------- +set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH}) + +#----------------------------------------------------------------------------- +# Set the path to ROCm +#----------------------------------------------------------------------------- +# If ROCM_PATH was set in the environment, seed it with that +if(DEFINED ENV{ROCM_PATH}) + set(ROCM_INITIAL_PATH "$ENV{ROCM_PATH}") +else() + set(ROCM_INITIAL_PATH "/opt/rocm") +endif() +set(ROCM_PATH "${ROCM_INITIAL_PATH}" CACHE PATH "The path to the ROCm installation") + +# Add ROCm search paths +list(APPEND CMAKE_PREFIX_PATH + ${ROCM_PATH}/llvm + ${ROCM_PATH} + ${ROCM_PATH}/hip + /opt/rocm/llvm + /opt/rocm + /opt/rocm/hip +) + +#----------------------------------------------------------------------------- +# Import useful things for later +#----------------------------------------------------------------------------- +include(AISAddLibraries) + +#----------------------------------------------------------------------------- +# Options +#----------------------------------------------------------------------------- + +#----------------------------------------------------------------------------- +# Code coverage (via llvm-cov) +# +# To use with the hipFile/rocFile libraries: +# - Build with BUILD_CODE_COVERAGE set to ON +# - Run `ctest .` +# +# This should create a default.profraw file in each test directory +# +# In each test directory: +# - Run `llvm-profdata merge -output=.profdata default.profraw` +# +# The show command gives line-by-line coverage, report gives a summary +# - Run `llvm-cov -instr-profile=.profdata` +# +# You can export the data to lcov or json +# - Run `llvm-cov export -instr-profile=ais.profdata -format= > coverage.` +#----------------------------------------------------------------------------- +option(BUILD_CODE_COVERAGE "Build with code coverage flags (llvm C++ only)" OFF) + +#---------------------------------------------- +# Clang "safe buffer" warnings and suggestions +#---------------------------------------------- +include(AISClangSafeBuffers) + +#------------------- +# Sanitizer options +#------------------- +include(AISSanitizers) + +#---------------------------------- +# rocfile (default OFF for NVIDIA) +#---------------------------------- +if(CMAKE_HIP_PLATFORM STREQUAL "nvidia") + set(BUILD_ROCFILE_DEFAULT OFF) +else() + set(BUILD_ROCFILE_DEFAULT ON) +endif() +option(BUILD_ROCFILE "Build rocfile library (AMD only)" ${BUILD_ROCFILE_DEFAULT}) + +#--------- +# hipfile +#--------- +option(BUILD_HIPFILE "Build hipfile library" ON) + +#------ +# docs +#------ +option(BUILD_AIS_DOCS "Build the rocFile/hipFile docs (requires Doxygen)" OFF) + +#----------------------------------------------------------------------------- +# Find important packages for building the software +#----------------------------------------------------------------------------- + +find_package(hsa-runtime64 CONFIG REQUIRED) +if(${hsa-runtime64_FOUND}) + message(STATUS "hsa-runtime64 found @ ${hsa-runtime64_DIR} ") +else() + message(NOTICE "find_package did NOT find hsa-runtime64") +endif() + +find_package(hip CONFIG REQUIRED) +if(${hip_FOUND}) + message(STATUS "hip found @ ${hip_DIR} ") +else() + message(NOTICE "find_package did NOT find hip") +endif() + +# Find the CUfile library and headers on NVIDIA +if(CMAKE_HIP_PLATFORM STREQUAL "nvidia") + find_package(CUDAToolkit REQUIRED) + + if(CMAKE_HIP_PLATFORM STREQUAL "nvidia" AND CMAKE_VERSION VERSION_LESS "3.28") + enable_language(CUDA) + # Set a default architecture if not provided. + if(NOT CMAKE_CUDA_ARCHITECTURES) + set(CMAKE_CUDA_ARCHITECTURES 80) + endif() + endif() + + find_library(CUFILE_LIBRARY cufile PATHS ${CUDAToolkit_LIBRARY_DIR}) + + if(NOT CUFILE_LIBRARY) + message(FATAL_ERROR "CUfile library not found") + endif() +endif() + +if(NOT AIS_TEST_DIR) + set(AIS_TEST_DIR "/tmp" CACHE STRING "Directory to use for e2e tests.") +endif() + +#----------------------------------------------------------------------------- +# Subdirectories to configure/build +#----------------------------------------------------------------------------- +if(BUILD_ROCFILE AND CMAKE_HIP_PLATFORM STREQUAL "amd") + add_subdirectory(rocfile) +endif() +if(BUILD_HIPFILE) + add_subdirectory(hipfile) +endif() +if(BUILD_AIS_DOCS) + add_subdirectory(docs) +endif() + +#----------------------------------------------------------------------------- +# Set up installs (must come AFTER target creation) +#----------------------------------------------------------------------------- +include(AISUseROCmCMake) +include(AISInstall) diff --git a/README.md b/README.md index fbe263b6..13aa1658 100644 --- a/README.md +++ b/README.md @@ -1 +1,84 @@ -# Future home of hipFile/rocFile +# hipFile / rocFile +AMD Infinity Storage library that supports IO directly to the GPU + +## Building hipFile and rocFile + +Supported compilers: amdclang++, clang++, g++ + +Supported platforms: Linux (Windows may be supported in a future release) + +If CMake can't find hipcc/nvcc, you can set `-DCMAKE_HIP_COMPILER=` + +Targeting NVIDIA requires CUfile to be installed + +### Configure + +You do not need to set the `HIP_PLATFORM` environment variable, as +that will be set by CMake. + +`cmake -DCMAKE_HIP_PLATFORM=(amd|nvidia) ` + +Options +|Option|Default|Purpose| +|------|-------|-------| +|BUILD\_ROCFILE|ON|Build the rocFile library (AMD only, OFF for NVIDIA)| +|BUILD\_HIPFILE|ON|Build the hipFile library| +|BUILD\_AIS\_DOCS|OFF|Build API documentation| +|BUILD\_CODE\_COVERAGE|OFF|Generate code coverage information when tests are run| + +### Build +`cmake --build .` + +### Run tests +`ctest .` + +### Install and package +The hipFile and rocFile libraries can be installed with CMake. The default +install prefix is still the CMake default of `/usr/local`. + +`cmake --install .` + +The libraries can also be packaged with CPack. .rpm, .deb. and .tar.gz +are all supported. + +`cpack -G RPM` +`cpack -G DEB` +`cpack -G TGZ` + +### Code coverage +The same version of Clang and LLVM must be used in order to generate +coverage results. `rocm-llvm-dev` can be installed to get the LLVM +version matching amdclang++. + +PATH may need to be adjusted depending on the system configuration. The +following will add the default ROCm version of the tools to the path. +``` +export PATH=/opt/rocm/bin:/opt/rocm/llvm/bin:"$PATH" +``` + +To generate code coverage information, the `BUILD_CODE_COVERAGE` +flag must be enabled when configuring. Run the build and test steps, +then run the following to generate the summaries. +``` +/util/llvm-coverage.sh +``` + +The results will be wrote to `/build`, in the +`coverage-report.txt` and `coverage-lines.txt` files. + +### Documentation +The API documentation is built using Doxygen. To build it, use the +BUILD\_AIS\_DOCS option. This will build the documentation for any +libraries that have been configured. As a special case, configuring +the documentation without any library will build the documentation +for BOTH libraries, allowing for a docs-only build. + +The documentation will be built with the libraries and appear in +`docs/(hip|roc)file`. We build HTML, XML, and LaTeX docs. If you +want a pdf, run `make pdf` in the `latex` directory, which will +create a file named refman.pdf that you can rename. + +If you want to build the docs without compiling the libraries, +you can just build the `doc` target: + + `cmake --build . --target doc` diff --git a/cmake/AISAddExecutable.cmake b/cmake/AISAddExecutable.cmake new file mode 100644 index 00000000..d0e794ba --- /dev/null +++ b/cmake/AISAddExecutable.cmake @@ -0,0 +1,69 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +include(AISCompilerOptions) + +# Add an executable program using AIS build conventions +# +# Parameters: +# NAME The name of the executable program to create +# DEPS [dependency1 [dependency2 ...]] List of AIS target library dependencies +# SRCS [src1 [src2 ...]] The source files +# SYSINCLS [path1 [path2 ...]] Paths to include dirs +# +# NOTE: Assumes AIS target libraries are named _(static|shared) +# +# NOTE: This isn't the most robust function. It's mainly intended +# to reduce code duplication in rocFile/hipFile. For example, +# DEPS is for passing the rocFile dependency to hipFile and +# won't work for passing general library dependencies. +function(ais_add_executable) + + # Parse arguments + set(options) # None at this time + set(oneValueArgs NAME PLATFORM) + set(multiValueArgs SRCS DEPS SYSINCLS) + cmake_parse_arguments(arg "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + if(NOT arg_PLATFORM) + set(arg_PLATFORM ${CMAKE_HIP_PLATFORM}) + endif() + + add_executable(${arg_NAME} ${arg_SRCS}) + ais_set_compiler_flags(${arg_NAME}) + + get_target_property(linker_language ${arg_NAME} LINKER_LANGUAGE) + if(linker_language STREQUAL "HIP") + target_link_libraries(${arg_NAME} PRIVATE hip::device) + endif() + + if(BUILD_TESTING) + target_compile_definitions(${arg_NAME} PRIVATE AIS_TESTING) + endif() + + if(arg_PLATFORM STREQUAL "amd") + target_compile_definitions(${arg_NAME} PRIVATE __HIP_PLATFORM_AMD__) + elseif(arg_PLATFORM STREQUAL "nvidia") + target_compile_definitions(${arg_NAME} PRIVATE __HIP_PLATFORM_NVIDIA__) + target_include_directories(${arg_NAME} SYSTEM PRIVATE ${HIP_INCLUDE_DIRS}) + + # CUDA include needs to come first. We get a CUB / Thrust version conflict otherwise. + target_include_directories(${arg_NAME} SYSTEM BEFORE PRIVATE ${CUDAToolkit_INCLUDE_DIRS}) + + target_link_libraries(${arg_NAME} PRIVATE CUDA::cuda_driver) + target_link_libraries(${arg_NAME} PRIVATE CUDA::cudart) + endif() + target_link_libraries(${arg_NAME} PRIVATE hip::host) + + foreach(dep IN LISTS arg_DEPS) + add_dependencies(${arg_NAME} ${dep}) + target_link_libraries(${arg_NAME} PRIVATE ${dep}) + endforeach() + + foreach(incl IN LISTS arg_SYSINCLS) + target_include_directories(${arg_NAME} SYSTEM PRIVATE ${incl}) + endforeach() + + target_include_directories(${arg_NAME} PRIVATE "${CMAKE_SOURCE_DIR}/shared") +endfunction() diff --git a/cmake/AISAddLibraries.cmake b/cmake/AISAddLibraries.cmake new file mode 100644 index 00000000..c8c5828f --- /dev/null +++ b/cmake/AISAddLibraries.cmake @@ -0,0 +1,117 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +include(AISCompilerOptions) + +# Add static and shared libraries using AIS build conventions +# +# Parameters: +# NAME The name of the libraries to create +# DETAIL "amd"|"nvidia" Whether this is an AMD or NVIDIA target +# LIBINCL Path to installed include files (e.g., hipfile.h) +# SYSINCLS [path1 [path2 ...]] Paths to other include dirs +# SRCS [src1 [src2 ...]] The source files +# DEPS [dependency1 [dependency2 ...]] List of AIS target library dependencies +# LIBS [lib1, [lib2 ...]] List of external library dependencies +# +# NOTE: Assumes internal library dependencies are named _(static|shared) +# +# NOTE: This isn't the most robust function. It's mainly intended to reduce +# code duplication in rocFile/hipFile. For example, DEPS is for passing +# the rocFile internal library dependency to hipFile and won't work for +# passing general library dependencies. +function(ais_add_libraries) + + # Parse arguments + set(options) # None at this time + set(oneValueArgs NAME DETAIL LIBINCL) + set(multiValueArgs SRCS DEPS SYSINCLS LIBS) + cmake_parse_arguments(arg "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + # Convenience names + set(object_name "${arg_NAME}_object") + set(static_name "${arg_NAME}_static") + set(shared_name "${arg_NAME}_shared") + + # Add the object, shared, and static library targets + # + # The static and shared libraries are both built from the + # same compiled objects (with -fPIC, etc.) + add_library(${object_name} OBJECT ${arg_SRCS}) + add_library(${static_name} STATIC $) + add_library(${shared_name} SHARED $) + + # Add version numbers + set_target_properties(${static_name} PROPERTIES VERSION ${AIS_LIBRARY_VERSION}) + set_target_properties(${shared_name} PROPERTIES VERSION ${AIS_LIBRARY_VERSION}) + set_target_properties(${shared_name} PROPERTIES SOVERSION ${AIS_LIBRARY_SOVERSION}) + + # Add dependencies on internal targets + foreach(dep IN LISTS arg_DEPS) + add_dependencies(${static_name} "${dep}_static") + add_dependencies(${shared_name} "${dep}_shared") + + target_link_libraries(${static_name} PRIVATE "${dep}_static") + target_link_libraries(${shared_name} PRIVATE "${dep}_shared") + + # The object library needs to see the headers for any dependencies + target_link_libraries(${object_name} PUBLIC "${dep}_shared") + endforeach() + + # Add dependencies on external libraries + foreach(lib IN LISTS arg_LIBS) + find_library(LIBRARY_PATH NAMES ${lib}) + if(NOT LIBRARY_PATH) + message(FATAL_ERROR "lib${lib} not found") + endif() + target_link_libraries(${static_name} PRIVATE ${LIBRARY_PATH}) + target_link_libraries(${shared_name} PRIVATE ${LIBRARY_PATH}) + endforeach() + + foreach(target "${object_name}" "${static_name}" "${shared_name}") + + if(BUILD_TESTING) + target_compile_definitions(${target} PRIVATE AIS_TESTING) + endif() + + if(arg_DETAIL STREQUAL "nvidia") + target_compile_definitions(${target} PRIVATE __HIP_PLATFORM_NVIDIA__) + else() + target_compile_definitions(${target} PRIVATE __HIP_PLATFORM_AMD__) + endif() + + # Set the library name, minus the .a, .so, or whatever + set_target_properties(${target} PROPERTIES OUTPUT_NAME ${arg_NAME}) + + # Set the public include paths (these are installed libraries) + target_include_directories(${target} + PUBLIC + $ + $ + ) + + # Add other include paths + foreach(incl IN LISTS arg_SYSINCLS) + target_include_directories(${target} SYSTEM PRIVATE ${incl}) + endforeach() + + # Add libraries and headers for NVIDIA targets + if(arg_DETAIL STREQUAL "nvidia") + target_include_directories(${target} + SYSTEM + PRIVATE + ${HIP_INCLUDE_DIRS} + ${CUDAToolkit_INCLUDE_DIRS} + ) + target_link_libraries(${target} PRIVATE ${CUFILE_LIBRARY}) + endif() + target_link_libraries(${target} PRIVATE hip::host) + + # Add the common include path + target_include_directories(${target} PRIVATE "${CMAKE_SOURCE_DIR}/shared") + + # Set compiler flags + ais_set_compiler_flags(${target}) + endforeach() +endfunction() diff --git a/cmake/AISClangCompilerOptions.cmake b/cmake/AISClangCompilerOptions.cmake new file mode 100644 index 00000000..532e46c0 --- /dev/null +++ b/cmake/AISClangCompilerOptions.cmake @@ -0,0 +1,222 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +# Warning flags for llvm/clang +# +# https://clang.llvm.org/docs/DiagnosticsReference.html + +function(get_ais_clang_warning_flags outvar compiler_version) + + # Warning flags for clang 17 and earlier + set(flags + # Basic "high" warning levels + -Wall + -Wextra + + # Avoid non-standard C/C++ behavior + -pedantic + + # Suggestions from the Effective C++ book + -Weffc++ + + # Build with this until it becomes a problem + # -Wnvcc-compat requires clang 19 and is handled below + -Wcuda-compat + + # Don't bake gcc-isms into the code. clang will usually deal with + # this but it's not a good idea. + -Wgnu + + # Don't use deprecated constructs + -Wdeprecated + + # Aggressively warn about thread-safety issues + -Wthread-safety + + # Turn this on later (generates a lot of noise now) + #-Wdocumentation + + # Avoid things that will cause problems on Windows + -Wmicrosoft + + # Do not warn about incompatibility with earlier versions + # of C++. The pedantic versions suppress a larger set of + # warnings than the non-pedantic ones. + -Wno-c++98-compat-pedantic + -Wno-c++11-compat-pedantic + -Wno-c++14-compat-pedantic + -Wno-pre-c++17-compat-pedantic + + # Misc warnings + # + # This includes most warnings that are not enabled by default + # with the exception of C++ 11/14/etc. and clang extension + # warnings since we only support one compiler with a defined + # language level + # + # This list is not set in stone and we should consider removing + # diagnostics that return a lot of false positives. + # + # Anything commented out with no comment isn't supported w/ clang + # versions in common use. We'll want to update this scheme with + # one that better respects versions in the future. + -Warc-repeated-use-of-weak + -Warray-bounds-pointer-arithmetic + -Wassign-enum + -Watomic-implicit-seq-cst + -Watomic-properties + -Wbad-function-cast + -Wbinary-literal + -Wcast-align + -Wcast-function-type + -Wcast-qual + -Wcomma + -Wconditional-uninitialized + -Wconsumed + #-Wcovered-switch-default (flags default labels where we handle all enum values) + -Wcstring-format-directive + -Wctad-maybe-unsupported + -Wdate-time + -Wdirect-ivar-access + -Wdisabled-macro-expansion + -Wdouble-promotion + -Wdtor-name + -Wduplicate-enum + -Wduplicate-method-arg + -Wduplicate-method-match + -Wendif-labels + -Wexit-time-destructors + -Wexpansion-to-defined + -Wexplicit-ownership-type + -Wextra-semi + -Wextra-semi-stmt + -Wfloat-equal + -Wformat=2 + -Wformat-non-iso + -Wformat-pedantic + -Wformat-type-confusion + -Wfour-char-constants + -Wfuse-ld-path + -Wglobal-constructors + -Wheader-hygiene + -Widiomatic-parentheses + -Wimplicit-fallthrough + -Wimplicit-retain-self + -Wincompatible-function-pointer-types-strict + -Wincomplete-module + -Winconsistent-missing-destructor-override + -Winvalid-or-nonexistent-directory + -Wlocal-type-template-args + -Wloop-analysis + -Wmain + -Wmain-return-type + -Wmax-tokens + -Wmethod-signatures + -Wmissing-include-dirs + #-Wmissing-noreturn # Generates spurious warnings due to unimplemented void + # functions that always throw exceptions or terminate + -Wmissing-prototypes + -Wmissing-variable-declarations + -Wnarrowing + -Wnewline-eof + -Wnoexcept-type + -Wnon-gcc + -Wnon-virtual-dtor + -Wnonportable-system-include-path + -Wnullable-to-nonnull-conversion + -Wold-style-cast + -Wopenmp + -Wover-aligned + -Woverriding-method-mismatch + -Wpacked + #-Wpadded # Generates a LOT of unfixable noise + -Wpartial-availability + -Wpointer-arith + -Wpoison-system-directories + -Wpragmas + -Wquoted-include-in-framework-header + -Wreceiver-forward-class + -Wredundant-parens + -Wreserved-identifier + -Wsequence-point + -Wshadow-all + -Wshift-sign-overflow + -Wsigned-enum-bitfield + -Wsource-uses-openmp + -Wspir-compat + -Wstatic-in-inline + -Wstrict-potentially-direct-selector + -Wstrict-prototypes + -Wstrict-selector-match + -Wsuggest-destructor-override + -Wsuggest-override + -Wsuper-class-method-mismatch + -Wswitch-default + -Werror=switch-enum # To make sure we never miss a CUDA enum value + -Wtype-limits + -Wunaligned-access + -Wundeclared-selector + -Wundef + -Wundef-prefix + -Wundefined-func-template + -Wundefined-reinterpret-cast + -Wunguarded-availability + -Wunnamed-type-template-args + -Wunreachable-code-aggressive + -Wused-but-marked-unused + -Wvariadic-macros + -Wvector-conversion + -Wvla + -Wno-weak-vtables # Lots of noise in gtest code, so turn off for now + -Wzero-as-null-pointer-constant + + # -Wlocal-type-template-args enables + # -Wc++98-compat-local-type-template-args. + -Wno-c++98-compat-local-type-template-args + ) + + if(compiler_version VERSION_GREATER_EQUAL 18.1.6) + set(flags + # Misc warnings + -Wnonportable-private-system-apinotes-path + -Wopenacc + -Wsource-uses-openacc + ${flags} + ) + endif() + + if(compiler_version VERSION_GREATER_EQUAL 19.1) + set(flags + # Build with this until it becomes a problem + # -Wcuda-compat is handled in the general flags, above + -Wnvcc-compat + + # Misc warnings + -Wformat-signedness + ${flags} + ) + endif() + + if(compiler_version VERSION_GREATER_EQUAL 20.1) + set(flags + # Misc warnings + -Wdecls-in-multiple-modules + -Wvariadic-macro-arguments-omitted + ${flags} + ) + endif() + + if(compiler_version VERSION_GREATER_EQUAL 21.0) + set(flags + # Misc warnings + -Wignored-base-class-qualifiers + -Wshift-bool + -Wunique-object-duplication + ${flags} + ) + endif() + + set(${outvar} ${flags} PARENT_SCOPE) + +endfunction() diff --git a/cmake/AISClangSafeBuffers.cmake b/cmake/AISClangSafeBuffers.cmake new file mode 100644 index 00000000..a8281e34 --- /dev/null +++ b/cmake/AISClangSafeBuffers.cmake @@ -0,0 +1,21 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +#----------------------------------------------------------------------------- +# Warn about unsafe buffer operations (llvm C++ only) +# +# See: https://clang.llvm.org/docs/SafeBuffers.html for more info +# +# Fixing this cleanly requires C++20, so it's an option for now +#----------------------------------------------------------------------------- +option(AIS_WARN_UNSAFE_BUFFER_OPS "Warn about unsafe buffer operations (llvm C++ only)" OFF) +if(AIS_WARN_UNSAFE_BUFFER_OPS) + if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") + set(AIS_CLANG_WARNING_FLAGS + -Wunsafe-buffer-usage + -fsafe-buffer-usage-suggestions + ${AIS_CLANG_WARNING_FLAGS} + ) + endif() +endif() diff --git a/cmake/AISCompilerOptions.cmake b/cmake/AISCompilerOptions.cmake new file mode 100644 index 00000000..a2e1dfa6 --- /dev/null +++ b/cmake/AISCompilerOptions.cmake @@ -0,0 +1,39 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +# Set compiler flags on target based on compilers being used on sources + +include(AISClangCompilerOptions) +include(AISGNUCompilerOptions) + +function (ais_set_compiler_flags target) + get_target_property(sources ${target} SOURCES) + foreach(source IN LISTS sources) + get_source_file_property(language ${source} LANGUAGE) + # CMake HIP language prior to 3.28 only supports AMD, so change LANGUAGE to CUDA for HIP files + if(CMAKE_HIP_PLATFORM STREQUAL "nvidia" AND CMAKE_VERSION VERSION_LESS "3.28" AND language STREQUAL HIP) + set_source_files_properties(${source} PROPERTIES LANGUAGE "CUDA") + set(language CUDA) + message(STATUS "Setting ${source} LANGUAGE to CUDA because CMake < 3.28") + endif() + set(compiler_id "${CMAKE_${language}_COMPILER_ID}") + set(compiler_version "${CMAKE_${language}_COMPILER_VERSION}") + if(compiler_id STREQUAL "GNU" OR compiler_id STREQUAL "NVIDIA") + get_ais_gnu_warning_flags(compiler_flags compiler_version) + elseif(compiler_id STREQUAL "Clang") + get_ais_clang_warning_flags(compiler_flags compiler_version) + endif() + target_compile_options(${target} PRIVATE $<$:${compiler_flags}>) + if(BUILD_CODE_COVERAGE) + target_compile_options(${target} PRIVATE $<$:-fprofile-instr-generate -fcoverage-mapping>) + target_link_options(${target} PRIVATE $<$:-fprofile-instr-generate>) + endif() + endforeach() + + ais_add_sanitizers(${target}) + + if(NOT BUILD_TESTING) + target_compile_options(${target} PRIVATE -fvisibility=hidden) + endif() +endfunction() diff --git a/cmake/AISGNUCompilerOptions.cmake b/cmake/AISGNUCompilerOptions.cmake new file mode 100644 index 00000000..52324f50 --- /dev/null +++ b/cmake/AISGNUCompilerOptions.cmake @@ -0,0 +1,127 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +# Warning flags for GNU g++ +# +# https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html + +function(get_ais_gnu_warning_flags outvar compiler_version) + + # Warning flags for g++ 9 and earlier + set(flags + # Basic "high" warning levels + -Wall + -Wextra + + # Avoid non-standard C/C++ behavior + # Can't use -pedantic with nvcc at this time, as nvcc + # generates code with non-standard #line styles, leading + # to a LOT of warnings + #-pedantic + + # Check for ABI warnings + # Most of this is noise, but probably useful to turn + # on from time to time + #-Wabi + + # Turn on stack protection options + -fstack-clash-protection + -fstack-protector-strong + + # Misc warnings + #-Waggregate-return # We return structs, but might be useful + # to turn on to see where this can be + # minimized + -Walloca + -Walloc-zero + -Warray-bounds=2 # TODO: Consider making =3 in newer g++ + -Wcast-align + -Wcast-qual + -Wconversion + -Wdate-time + -Wdouble-promotion + -Wduplicated-branches + -Wduplicated-cond + -Wfloat-equal + -Wformat=2 + -Wformat-nonliteral + -Wformat-overflow=2 + -Wformat-security + -Wformat-signedness + -Wformat-truncation=2 + -Wformat-y2k + -Winvalid-pch + -Wlong-long + -Wlogical-op + -Wmissing-declarations + -Wnormalized + -Wnull-dereference + -Wpacked + #-Wpadded # Probably should be a developer warning + -Wpointer-arith + -Wredundant-decls + -Wshadow + -Wshadow-local + -Wshift-overflow=2 + -Wstrict-overflow=4 + -Wswitch-default + -Wswitch-enum + -Wtrampolines + -Wundef + -Wuninitialized + -Wunknown-pragmas + -Wunsafe-loop-optimizations + -Wunused + -Wunused-macros + -Wuseless-cast + -Wvla + -Wzero-as-null-pointer-constant + + # TODO: Add size warnings when we pick a limit + ) + + if(compiler_version VERSION_GREATER_EQUAL 12) + set(flags + # Fortify source + -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=3 + # Misc warnings + -Winterference-size + -Wtrivial-auto-var-init + ${flags} + ) + endif() + + if(compiler_version VERSION_GREATER_EQUAL 13) + set(flags + # Turn on strict flex arrays (helps ASAN, _FORTIFY_SOURCE, etc.) + -fstrict-flex-arrays=3 + # Misc warnings + -Winvalid-utf8 + ${flags} + ) + endif() + + if(compiler_version VERSION_GREATER_EQUAL 14) + set(flags + # Misc warnings + -Walloc-size + -Wcalloc-transposed-args + -Wflex-array-member-not-at-end + -Wnrvo + ${flags} + ) + endif() + + if(compiler_version VERSION_GREATER_EQUAL 15) + set(flags + # Misc warnings + -Wtrailing-whitespace + -Wleading-whitespace=tabs + ${flags} + ) + endif() + + set(${outvar} ${flags} PARENT_SCOPE) + +endfunction() diff --git a/cmake/AISInstall.cmake b/cmake/AISInstall.cmake new file mode 100644 index 00000000..875c8d01 --- /dev/null +++ b/cmake/AISInstall.cmake @@ -0,0 +1,65 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +# Install hipFile and rocFile +# +# TODO: Rework this to use CPack + +# From the rocm-cmake repo +include(ROCMInstallTargets) +include(ROCMCreatePackage) + +if(BUILD_ROCFILE OR BUILD_HIPFILE) + + # Install the package + if(BUILD_ROCFILE) + rocm_install(TARGETS rocfile_static) + rocm_install(TARGETS rocfile_shared) + endif() + if(BUILD_HIPFILE) + rocm_install(TARGETS hipfile_static) + rocm_install(TARGETS hipfile_shared) + endif() + + # Install the headers + if(BUILD_ROCFILE) + rocm_install( + DIRECTORY ${CMAKE_SOURCE_DIR}/rocfile/include/ + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} + ) + endif() + if(BUILD_HIPFILE) + rocm_install( + DIRECTORY ${CMAKE_SOURCE_DIR}/hipfile/include/ + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} + ) + endif() + + # rocm_package_add_dependencies() line should go here + # when we have dependencies + + # Export the targets + if(BUILD_ROCFILE) + set(target_list ${target_list} roc::rocfile_shared roc::rocfile_static) + endif() + if(BUILD_HIPFILE) + set(target_list ${target_list} roc::hipfile_shared roc::hipfile_static) + endif() + + rocm_export_targets( + TARGETS ${target_list} + NAMESPACE roc:: + ) + + # CPack license setup + set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE") + set(CPACK_RPM_PACKAGE_LICENSE "MIT") + + # Create the package + rocm_create_package( + NAME "hipFile" + DESCRIPTION "The hipFile (and rocFile w/ AMD) libraries" + MAINTAINER "ais-eap " + ) +endif() diff --git a/cmake/AISSanitizers.cmake b/cmake/AISSanitizers.cmake new file mode 100644 index 00000000..29a4bf09 --- /dev/null +++ b/cmake/AISSanitizers.cmake @@ -0,0 +1,33 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +option(AIS_BUILD_SANITIZERS "Build with -fsanitize=address, leak, and undefined" OFF) +option(AIS_BUILD_THREAD_SANITIZERS "Build with -fsanitize=thread (not compatible with AIS_BUILD_SANITIZERS)" OFF) + +if(AIS_BUILD_THREAD_SANITIZERS) + message(WARNING "TSAN has known problems with higher levels of entropy, try using `sudo sysctl vm.mmap_rnd_bits=28` if you encounter errors concerning unexpected memory mappings.") +endif() + +function (ais_add_sanitizers target) + if(AIS_BUILD_SANITIZERS AND AIS_BUILD_THREAD_SANITIZERS) + message(FATAL_ERROR "AIS_BUILD_SANITIZERS is not compatible with AIS_BUILD_THREAD_SANITIZERS") + endif() + + if(AIS_BUILD_SANITIZERS) + # TODO: Consider other sanitizer options + target_compile_options(${target} PRIVATE -fsanitize=address) + target_link_options(${target} PRIVATE -fsanitize=address) + target_compile_options(${target} PRIVATE -fsanitize=leak) + target_link_options(${target} PRIVATE -fsanitize=leak) + target_compile_options(${target} PRIVATE -fsanitize=undefined) + target_link_options(${target} PRIVATE -fsanitize=undefined) + + target_compile_options(${target} PRIVATE -fno-omit-frame-pointer) + endif() + + if(AIS_BUILD_THREAD_SANITIZERS) + target_compile_options(${target} PRIVATE -fsanitize=thread) + target_link_options(${target} PRIVATE -fsanitize=thread) + endif() +endfunction() diff --git a/cmake/AISSetCoverageFile.cmake b/cmake/AISSetCoverageFile.cmake new file mode 100644 index 00000000..71207a61 --- /dev/null +++ b/cmake/AISSetCoverageFile.cmake @@ -0,0 +1,14 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +function (ais_set_coverage_file test_list_name directory) + set(test_counter 0) + set(test_list "${${test_list_name}}") + foreach(test IN LISTS test_list) + set_tests_properties( + ${test} + PROPERTIES ENVIRONMENT_MODIFICATION "LLVM_PROFILE_FILE=set:${directory}/${test_list_name}.${test_counter}.profraw") + MATH(EXPR test_counter "${test_counter}+1") + endforeach() +endfunction() diff --git a/cmake/AISUseGTest.cmake b/cmake/AISUseGTest.cmake new file mode 100644 index 00000000..4c43d837 --- /dev/null +++ b/cmake/AISUseGTest.cmake @@ -0,0 +1,53 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +include(FetchContent) +FetchContent_Declare( + googletest + URL https://github.com/google/googletest/releases/download/v1.17.0/googletest-1.17.0.tar.gz + DOWNLOAD_EXTRACT_TIMESTAMP true + FIND_PACKAGE_ARGS NAMES GTest + SYSTEM +) + +set(INSTALL_GTEST OFF CACHE BOOL "Don't install gtest.") +set(GTEST_HAS_ABSL OFF CACHE BOOL "Don't use abseil for GTest.") +FetchContent_MakeAvailable(googletest) + +if(rocm-cmake_SOURCE_DIR) + message(STATUS "Using fetched googletest.") +else() + message(STATUS "Using system googletest.") +endif() + +include(GoogleTest) + +function (ais_gtest_discover_tests target) + cmake_language(CALL gtest_discover_tests ${ARGV}) + + if(BUILD_CODE_COVERAGE) + set(options) + set(oneValueArgs TEST_LIST) + set(multiValueArgs) + cmake_parse_arguments(PARSE_ARGV 0 arg "${options}" "${oneValueArgs}" "${multiValueArgs}") + if(NOT arg_TEST_LIST) + # Set to target name if not specified. This will result in collisions + # if we run the same test binary in different configurations without + # specifying a test list. + set(arg_TEST_LIST ${target}) + endif() + + set(coverage_include_file "${CMAKE_CURRENT_BINARY_DIR}/${arg_TEST_LIST}_coverage_include.cmake") + set_property( + DIRECTORY APPEND PROPERTY + TEST_INCLUDE_FILES + "${CMAKE_SOURCE_DIR}/cmake/AISSetCoverageFile.cmake" + "${coverage_include_file}" + ) + + file(WRITE "${coverage_include_file}" + "ais_set_coverage_file(\"${arg_TEST_LIST}\" \"${CMAKE_CURRENT_BINARY_DIR}\")" + ) + endif() +endfunction() diff --git a/cmake/AISUseROCmCMake.cmake b/cmake/AISUseROCmCMake.cmake new file mode 100644 index 00000000..8c8555ca --- /dev/null +++ b/cmake/AISUseROCmCMake.cmake @@ -0,0 +1,22 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +include(FetchContent) + +FetchContent_Declare( + rocm-cmake + URL https://github.com/ROCm/rocm-cmake/archive/refs/tags/rocm-6.4.3.tar.gz + DOWNLOAD_EXTRACT_TIMESTAMP true + SOURCE_SUBDIR "DISABLE ADDING TO BUILD" + SYSTEM + FIND_PACKAGE_ARGS NAMES ROCmCMakeBuildTools +) +FetchContent_MakeAvailable(rocm-cmake) + +if(rocm-cmake_SOURCE_DIR) + message(STATUS "Using fetched rocm-cmake.") + find_package(ROCmCMakeBuildTools CONFIG REQUIRED NO_DEFAULT_PATH PATHS "${rocm-cmake_SOURCE_DIR}") +else() + message(STATUS "Using system rocm-cmake.") +endif() diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 00000000..b8588056 --- /dev/null +++ b/docs/CMakeLists.txt @@ -0,0 +1,65 @@ +# Copyright (c) Advanced Micro Devices, Inc. All rights reserved. +# +# SPDX-License-Identifier: MIT + +# Documentation CMake file for AIS + +find_package(Doxygen REQUIRED) + +# The top-level doc target +add_custom_target(doc COMMENT "Building AIS documentation") + +# Add a target of the name AIS_DOC_PRETTY_NAME-doc and make +# it a dependency of the top-level doc target +# +# NOTE: The Doxyfile used in this function is optimized +# for C output and unsuitable for internal C++ +# documentation +function(ais_add_docs_target AIS_DOC_PRETTY_NAME) + # Also need the lower-case name for files, etc. + string(TOLOWER ${AIS_DOC_PRETTY_NAME} AIS_DOC_LOWER_NAME) + + # Set Doxyfile variables + set(AIS_DOXYFILE_PROJECT_NAME "${AIS_DOC_PRETTY_NAME}") + set(AIS_DOXYFILE_PROJECT_BRIEF "${AIS_DOC_PRETTY_NAME} API documentation") + set(AIS_DOXYFILE_INPUT "${CMAKE_SOURCE_DIR}/${AIS_DOC_LOWER_NAME}/include") + + # Set the path to the documentation + set(AIS_DOC_PATH "${CMAKE_CURRENT_BINARY_DIR}/${AIS_DOC_LOWER_NAME}") + + # Set that target name + set(AIS_DOC_TARGET_NAME "${AIS_DOC_LOWER_NAME}-doc") + + # Set the Doxyfile install location + set(AIS_DOXYFILE ${AIS_DOC_PATH}/Doxyfile) + + # Create the Doxyfile from the input file + configure_file(Doxyfile.in ${AIS_DOXYFILE}) + + # Set the output directory + set(DOXYGEN_OUT ${AIS_DOC_PATH}) + + # Configure the documentation build + add_custom_target(${AIS_DOC_TARGET_NAME} + COMMAND ${DOXYGEN_EXECUTABLE} ${AIS_DOXYFILE} + WORKING_DIRECTORY ${AIS_DOC_PATH} + COMMENT "Generating ${AIS_DOC_PRETTY_NAME} API documentation with Doxygen" + VERBATIM + ) + + # Add a dependency to the top-level doc project + add_dependencies(doc ${AIS_DOC_TARGET_NAME}) +endfunction() + +if(BUILD_HIPFILE) + ais_add_docs_target("hipFile") +endif() +if(BUILD_ROCFILE) + ais_add_docs_target("rocFile") +endif() +# Allow building the docs when no library is selected +# This builds ALL the API docs +if(NOT BUILD_ROCFILE AND NOT BUILD_HIPFILE) + ais_add_docs_target("hipFile") + ais_add_docs_target("rocFile") +endif() diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in new file mode 100644 index 00000000..001db11b --- /dev/null +++ b/docs/Doxyfile.in @@ -0,0 +1,2579 @@ +# Doxyfile 1.8.17 + +# 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 = "@AIS_DOXYFILE_PROJECT_NAME@" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = @AIS_LIBRARY_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 = "@AIS_DOXYFILE_PROJECT_BRIEF@" + +# 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 = + +# 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 = NO + +# 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 + +# 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 = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# 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, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See 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 = YES + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# 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 the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# (including Cygwin) ands Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# 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 = NO + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also 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. +# 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 = "@AIS_DOXYFILE_INPUT@" + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: 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. +# +# 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), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.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 \ + *.doc \ + *.txt \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# 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 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 compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the 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. +# 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 + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# 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 master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: 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 of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# 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 = 1 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_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/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://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /