[ { "path": ".clang-format", "content": "---\nBasedOnStyle: LLVM\nIndentWidth: 2\n---\nLanguage: Cpp\nAlignConsecutiveBitFields: true\nAlignEscapedNewlines: Left\nAlwaysBreakTemplateDeclarations: Yes\nIncludeCategories:\n - Regex: '^\"(llvm|catch2|spdlog)/'\n Priority: 5\n SortPriority: 0\n - Regex: '^\"QBDI'\n Priority: 3\n SortPriority: 0\n - Regex: '^\"(Engine|ExecBlock|ExecBroker|Patch|Utility)/'\n Priority: 4\n SortPriority: 0\n - Regex: '^<'\n Priority: 1\n SortPriority: 0\n - Regex: '.*'\n Priority: 2\n SortPriority: 0\nIndentCaseLabels: true\nAlwaysBreakBeforeMultilineStrings: true\n---\n\n" }, { "path": ".clang-format.exclude-list.txt", "content": "cmake/llvm/.*\\.patch\\.txt\ncmake/config/ios.toolchain.cmake\n" }, { "path": ".cmake_format.conf.py", "content": "with section(\"format\"):\n\n line_width = 80\n tab_size = 2\n use_tabchars = False\n\nwith section(\"markup\"):\n enable_markup = False\n\nadditional_commands = {\n \"FetchContent_Declare\": {\n \"pargs\": 1,\n \"flags\": [],\n \"kwargs\": {\n \"URL\": '1',\n \"URL_HASH\": '1',\n \"GIT_REPOSITORY\": '1',\n \"GIT_PROGRESS\": '1',\n \"GIT_TAG\": '1',\n \"DOWNLOAD_DIR\": '1',\n }\n }\n}\n" }, { "path": ".github/ISSUE_TEMPLATE/assistance_request.md", "content": "---\nname: Assistance Request\nabout: Ask for help for using QBDI\ntitle: ''\nlabels: ''\nassignees: ''\n---\n\n**Description of the problem**\nA clear description of what your problem is.\n\n**Compilation or execution log**\nAny relevant log that illustrate your problem.\nPlease use [distinct block]https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code) to format this section.\n\n**QBDI/PyQBDI/Frida script**\nInsert your script/code that use QBDI here.\n\n**Code of the target of the instrumentation**\nInsert the script/code that you try to instrument with QBDI.\nIf the instrumented code is a public library/binary, you may provide a link to download it.\n\n**Specific command to reproduce your problem on other laptop**\nList all the command (if possible shell) that should be run the get the same output as you.\n\n**Information about the environment**\nVersion of your environment and any tools that is needed to reproduce your problem\n\nIf you use multiples devices (like a computer and a smartphone), please provide the information for each of them.\n\n- OS: (with version) [e.g. Windows 11, Debian 12.4, Android 14, ...]\n- Architecture: [e.g. X86, X64, AARCH64, ARM32]\n- QBDI version (returned by getVersion) and commit hash (if not a release version)\n- Frida version on the Host and on the target (in case of android device) (for frida/QBDI issue)\n- Python version (for PyQBDI issue)\n\n**Additional context or informations**\nAny other context about the problem here.\n\nThanks for taking the time to fill out all information! This will help us to reproduce your issue on our side.\n" }, { "path": ".github/ISSUE_TEMPLATE/assistance_request_new.yml", "content": "name: Assistance Request (new)\ndescription: Ask for help for using QBDI\nbody:\n - type: markdown\n attributes:\n label: Description of the problem\n value: |\n A clear description of what your problem is.\n - type: markdown\n attributes:\n label: Compilation or execution log\n value: |\n Any relevant log that illustrate your problem.\n Please use [distinct block]https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code) to format this section.\n - type: markdown\n attributes:\n label: QBDI/PyQBDI/Frida script\n value: |\n Insert your script/code that use QBDI here.\n - type: markdown\n attributes:\n label: Code of the target of the instrumentation\n value: |\n Insert the script/code that you try to instrument with QBDI.\n If the instrumented code is a public library/binary, you may provide a link to download it.\n - type: markdown\n attributes:\n label: Specific command to reproduce your problem on other laptop\n value: |\n List all the command (if possible shell) that should be run the get the same output as you.\n - type: markdown\n attributes:\n label: Information about the environment\n value: |\n Version of your environment and any tools that is needed to reproduce your problem\n \n If you use multiples devices (like a computer and a smartphone), please provide the information for each of them.\n\n - OS: (with version) [e.g. Windows 11, Debian 12.4, Android 14, ...] \n - Architecture: [e.g. X86, X64, AARCH64, ARM32]\n - QBDI version (returned by getVersion) and commit hash (if not a release version)\n - Frida version on the Host and on the target (in case of android device) (for frida/QBDI issue)\n - Python version (for PyQBDI issue)\n - type: markdown\n attributes:\n label: Additional context or informations\n value: |\n Any other context about the problem here.\n\n Thanks for taking the time to fill out all information! This will help us to reproduce your issue on our side.\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Create a bug report\ntitle: ''\nlabels: ''\nassignees: ''\n---\n\n** Description of the problem **\nA clear description of what the bug is, including the expected and actual behavior.\n\n\n**Compilation or execution log**\nAny relevant log that may help to understand the bug.\nPlease use [distinct block]https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code) to format this section.\n\n**Minimal code/script to reproduce the problem**\nInsert your script/code that use QBDI here.\n\n**Code of the target of the instrumentation**\nInsert your script/code that you try to instrument with QBDI.\nIf the instrumented code is a public library/binary, you may provide a link to download it.\n\n**Specific command to reproduce your issue**\n Can you list all the command (if possible shell) that should be run to reproduce the bug.\n\n**Information about the environment**\nVersion of your environment and any tools that is needed to reproduce the bug\nIf you use multiples devices (like a computer and a smartphone), please provide the information for each of them.\n\n- OS: (with version) [e.g. Windows 11, Debian 12.4, Android 14, ...]\n- Architecture: [e.g. X86, X64, AARCH64, ARM32]\n- QBDI version (returned by getVersion) and commit hash (if not a release version)\n- Frida version on the Host and on the target (in case of android device) (for frida/QBDI issue)\n- Python version (for PyQBDI issue)\n\n**Additional context or informations**\nAny other context about the problem here.\n\nThanks for taking the time to fill out this report!\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report_new.yml", "content": "name: Bug Report (new)\ndescription: Create a bug report\nbody:\n - type: markdown\n attributes:\n label: Description of the problem\n value: |\n A clear description of what the bug is, including the expected and actual behavior.\n - type: markdown\n attributes:\n label: Compilation or execution log\n value: |\n Any relevant log that may help to understand the bug.\n Please use [distinct block]https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code) to format this section.\n - type: markdown\n attributes:\n label: Minimal code/script to reproduce the problem\n value: |\n Insert your script/code that use QBDI here.\n - type: markdown\n attributes:\n label: Code of the target of the instrumentation\n value: |\n Insert your script/code that you try to instrument with QBDI.\n If the instrumented code is a public library/binary, you may provide a link to download it.\n - type: markdown\n attributes:\n label: Specific command to reproduce your issue\n value: |\n Can you list all the command (if possible shell) that should be run to reproduce the bug.\n - type: markdown\n attributes:\n label: Information about the environment\n value: |\n Version of your environment and any tools that is needed to reproduce the bug\n \n If you use multiples devices (like a computer and a smartphone), please provide the information for each of them.\n\n - OS: (with version) [e.g. Windows 11, Debian 12.4, Android 14, ...] \n - Architecture: [e.g. X86, X64, AARCH64, ARM32]\n - QBDI version (returned by getVersion) and commit hash (if not a release version)\n - Frida version on the Host and on the target (in case of android device) (for frida/QBDI issue)\n - Python version (for PyQBDI issue)\n - type: markdown\n attributes:\n label: Additional context or informations\n value: |\n Any other context about the problem here.\n\n Thanks for taking the time to fill out this report!\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: true\n" }, { "path": ".github/format_check.sh", "content": "#!/usr/bin/env bash\n\nset -e\n\ncd $(dirname \"$0\")\nRETURN_CODE=0\nBASEDIR=$(pwd -P)\nGITDIR=$(git rev-parse --show-toplevel)\ncd $GITDIR\n\nfor file in $(git ls-files | grep -v -f \"${GITDIR}/.clang-format.exclude-list.txt\" | grep '\\.\\(cpp\\|c\\|h\\|hpp\\)$'); do\n if [[ -n \"${CLANG_FORMAT_VERSION}\" ]]; then\n clang-format-\"${CLANG_FORMAT_VERSION}\" -Werror --style=file --verbose -n \"${file}\" || RETURN_CODE=1\n else\n clang-format -Werror --style=file --verbose -n \"${file}\" || RETURN_CODE=1\n fi\ndone\n\ncmake-format -c .cmake_format.conf.py -l info --check $(git ls-files | grep -v -f \"${GITDIR}/.clang-format.exclude-list.txt\" | grep '\\(CMakeLists.txt\\|\\.cmake\\)$')\n\n\nexit ${RETURN_CODE}\n" }, { "path": ".github/workflows/android.yml", "content": "name: Package Android\n\non:\n push:\n branches:\n - master\n - dev-next\n workflow_dispatch:\n\njobs:\n build:\n runs-on: ubuntu-22.04\n strategy:\n matrix: \n include:\n - QBDI_ARCH: 'X86_64'\n ANDROID_ABI: 'x86_64'\n - QBDI_ARCH: 'X86'\n ANDROID_ABI: 'x86'\n - QBDI_ARCH: 'AARCH64'\n ANDROID_ABI: 'arm64-v8a'\n - QBDI_ARCH: 'ARM'\n ANDROID_ABI: 'armeabi-v7a'\n fail-fast: false\n env:\n QBDI_PLATFORM: 'android'\n NDK_VERSION: 'r26c'\n ANDROID_PLATFORM: 23\n steps:\n - name: checkout\n uses: actions/checkout@v4\n - name: Cache ccache\n uses: actions/cache@v4\n id: cache-ccache\n with:\n path: |\n ~/.ccache\n key: ccache-android-${{ matrix.QBDI_ARCH }}-${{ env.NDK_VERSION }}-${{ env.ANDROID_PLATFORM }}-${{ hashFiles('.github/workflows/ccache.conf') }}-${{ github.run_number }}\n restore-keys: |\n ccache-android-${{ matrix.QBDI_ARCH }}-${{ env.NDK_VERSION }}-${{ env.ANDROID_PLATFORM }}-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - if: steps.cache-ccache.outputs.cache-hit != 'true'\n run: |\n mkdir -p ~/.ccache\n cp .github/workflows/ccache.conf ~/.ccache/ccache.conf\n - name: Cache android NDK ${{ env.NDK_VERSION }}\n uses: actions/cache@v4\n id: cache-ndk\n with:\n path: |\n android-ndk-${{ env.NDK_VERSION }}/\n key: ndk-${{ env.NDK_VERSION }}-linux\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n - name: Install dependencies\n run: |\n sudo apt-get update\n sudo apt-get install build-essential ccache cmake g++ libstdc++-10-dev make ninja-build pkg-config python3 unzip wget zlib1g-dev\n - name: Install android NDK ${{ env.NDK_VERSION }}\n if: steps.cache-ndk.outputs.cache-hit != 'true'\n run: |\n wget --no-verbose https://dl.google.com/android/repository/android-ndk-${{ env.NDK_VERSION }}-linux.zip\n unzip -q android-ndk-${{ env.NDK_VERSION }}-linux.zip\n rm android-ndk-${{ env.NDK_VERSION }}-linux.zip\n - run: mkdir -p build\n - name: Build Package\n working-directory: ./build\n run: |\n cmake -DQBDI_PLATFORM=${{ env.QBDI_PLATFORM }} \\\n -DQBDI_ARCH=${{ matrix.QBDI_ARCH }} \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/android-ndk-${{ env.NDK_VERSION }}/build/cmake/android.toolchain.cmake \\\n -DANDROID_ABI=${{ matrix.ANDROID_ABI }} \\\n -DANDROID_PLATFORM=${{ env.ANDROID_PLATFORM }} \\\n -DQBDI_TEST=OFF \\\n -G Ninja \\\n ..\n ninja\n cpack\n - name: Export package\n uses: actions/upload-artifact@v4\n with:\n name: package_android_${{ matrix.QBDI_ARCH }}\n path: build/QBDI-*-android-${{ matrix.QBDI_ARCH }}.tar.gz\n\n\n\n" }, { "path": ".github/workflows/ccache.conf", "content": "max_size = 512 M\n" }, { "path": ".github/workflows/clang_format.yml", "content": "name: Code format\n\non: [push, pull_request]\n\njobs:\n check:\n runs-on: ubuntu-24.04\n env:\n CLANG_FORMAT_VERSION: 19\n steps:\n - name: checkout\n uses: actions/checkout@v4\n - name: Set up Python env\n uses: actions/setup-python@v5\n with:\n python-version: \"3.12\"\n - name: Install system dependencies\n run: |\n sudo apt install -y --no-install-recommends clang-format-${{ env.CLANG_FORMAT_VERSION }}\n python3 -m pip install cmakelang\n - name: Check format\n run: bash ./.github/format_check.sh\n\n\n" }, { "path": ".github/workflows/ios.yml", "content": "name: Package iOS\n\non:\n push:\n branches:\n - master\n - dev-next\n workflow_dispatch:\n\njobs:\n build:\n runs-on: macos-15\n env:\n QBDI_ARCH: 'AARCH64'\n QBDI_PLATFORM: 'ios'\n MACOSX_DEPLOYMENT_TARGET: '15.0'\n steps:\n - name: Set up Python env\n uses: actions/setup-python@v5\n with:\n python-version: \"3.12\"\n - name: Install system dependencies\n run: |\n brew install cmake ninja ccache\n python3 -m pip install --upgrade pip setuptools wheel\n - name: checkout\n uses: actions/checkout@v4\n - name: Cache ccache\n uses: actions/cache@v4\n id: cache-ccache\n with:\n path: |\n ~/.ccache\n key: ccache-ios-${{ env.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-${{ github.run_number }}\n restore-keys: |\n ccache-ios-${{ env.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - if: steps.cache-ccache.outputs.cache-hit != 'true'\n run: |\n mkdir -p ~/.ccache\n cp .github/workflows/ccache.conf ~/.ccache/ccache.conf\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n - run: mkdir -p build\n - name: build QBDI\n working-directory: ./build\n run: |\n cmake -G Ninja \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DQBDI_PLATFORM=${{ env.QBDI_PLATFORM }} \\\n -DQBDI_ARCH=${{ env.QBDI_ARCH }} \\\n -DCMAKE_TOOLCHAIN_FILE=\"../cmake/config/ios.toolchain.cmake\" \\\n ..\n ninja\n cpack\n - name: Export package\n uses: actions/upload-artifact@v4\n with:\n name: package_iOS_${{ env.QBDI_ARCH }}\n path: build/QBDI-*.tar.gz\n" }, { "path": ".github/workflows/linux.yml", "content": "name: Tests and Package Linux\n\non:\n push:\n branches:\n - master\n - dev-next\n pull_request:\n workflow_dispatch:\n\njobs:\n build:\n runs-on: ubuntu-latest\n strategy:\n matrix: \n QBDI_ARCH: ['X86_64', 'X86']\n fail-fast: false\n env:\n QBDI_PLATFORM: 'linux'\n steps:\n - name: checkout\n uses: actions/checkout@v4\n - name: Login to Docker Hub\n uses: docker/login-action@v3\n with:\n username: ${{ secrets.DOCKERHUB_USERNAME }}\n password: ${{ secrets.DOCKERHUB_TOKEN }}\n - name: Cache ccache\n uses: actions/cache@v4\n id: cache-ccache\n with:\n path: |\n ~/.ccache\n key: ccache-linux-${{ matrix.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-${{ github.run_number }}\n restore-keys: |\n ccache-linux-${{ matrix.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - if: steps.cache-ccache.outputs.cache-hit != 'true'\n run: |\n mkdir -p ~/.ccache\n cp .github/workflows/ccache.conf ~/.ccache/ccache.conf\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n - name: Cache test result\n uses: actions/cache@v4\n with:\n path: |\n tools/validation_runner/travis_db\n key: test-linux-${{ matrix.QBDI_ARCH }}\n - name: Create build image\n env:\n QBDI_ARCH: ${{ matrix.QBDI_ARCH }}\n run: bash ./docker/ci_linux/img_build.sh\n - name: Build and test QBDI\n env:\n QBDI_ARCH: ${{ matrix.QBDI_ARCH }}\n run: bash ./docker/ci_linux/qbdi.sh\n - name: Export package\n uses: actions/upload-artifact@v4\n with:\n name: package_linux_${{ matrix.QBDI_ARCH }}\n path: build/QBDI-*-linux-${{ matrix.QBDI_ARCH }}.tar.gz\n\n build_ARM_AARCH64:\n runs-on: ubuntu-latest\n strategy:\n matrix:\n QBDI_ARCH: ['AARCH64', 'ARM']\n fail-fast: false\n env:\n QBDI_PLATFORM: 'linux'\n steps:\n - name: checkout\n uses: actions/checkout@v4\n - name: Login to Docker Hub\n uses: docker/login-action@v3\n with:\n username: ${{ secrets.DOCKERHUB_USERNAME }}\n password: ${{ secrets.DOCKERHUB_TOKEN }}\n - name: Cache ccache\n uses: actions/cache@v4\n id: cache-ccache\n with:\n path: |\n ~/.ccache\n key: ccache-linux-${{ matrix.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-${{ github.run_number }}\n restore-keys: |\n ccache-linux-${{ matrix.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - if: steps.cache-ccache.outputs.cache-hit != 'true'\n run: |\n mkdir -p ~/.ccache\n cp .github/workflows/ccache.conf ~/.ccache/ccache.conf\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n - name: Cache test result\n uses: actions/cache@v4\n with:\n path: |\n tools/validation_runner/travis_db\n key: test-linux-${{ matrix.QBDI_ARCH }}\n\n - name: Create build image\n run: bash ./docker/ci_linux_arm/images/img_build.sh ${{ matrix.QBDI_ARCH }}\n\n - name: Build and test QBDI\n run: bash ./docker/ci_linux_arm/build_qbdi_linux.sh ${{ matrix.QBDI_ARCH }}\n\n - name: Export package\n uses: actions/upload-artifact@v4\n with:\n name: package_linux_${{ matrix.QBDI_ARCH }}\n path: build-docker-*/QBDI-*-linux-*.tar.gz\n\n\n" }, { "path": ".github/workflows/macos.yml", "content": "name: Tests and Package macOS\n\non:\n push:\n branches:\n - master\n - dev-next\n pull_request:\n workflow_dispatch:\n\njobs:\n build-x86:\n runs-on: macos-15-intel\n env:\n QBDI_ARCH: 'X86_64'\n QBDI_PLATFORM: 'macos'\n MACOSX_DEPLOYMENT_TARGET: '10.14'\n CMAKE_OSX_ARCHITECTURES: \"x86_64\"\n steps:\n - name: Set up Python env\n uses: actions/setup-python@v5\n with:\n python-version: \"3.12\"\n - name: Install system dependencies\n run: |\n brew install cmake ninja ccache\n python3 -m pip install --upgrade pip setuptools wheel\n - name: checkout\n uses: actions/checkout@v4\n - name: Cache ccache\n uses: actions/cache@v4\n id: cache-ccache\n with:\n path: |\n ~/.ccache\n key: ccache-macos-${{ env.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-${{ github.run_number }}\n restore-keys: |\n ccache-macos-${{ env.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - if: steps.cache-ccache.outputs.cache-hit != 'true'\n run: |\n mkdir -p ~/.ccache\n cp .github/workflows/ccache.conf ~/.ccache/ccache.conf\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n - run: mkdir -p build\n - name: build QBDI\n working-directory: ./build\n run: |\n cmake -G Ninja \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DQBDI_PLATFORM=${{ env.QBDI_PLATFORM }} \\\n -DQBDI_ARCH=${{ env.QBDI_ARCH }} \\\n -DQBDI_TOOLS_VALIDATOR=ON \\\n -DQBDI_EXAMPLES=ON \\\n ..\n ninja\n cpack\n - name: test QBDI\n working-directory: ./build/test\n run: |\n ./QBDITest\n - name: Export package\n uses: actions/upload-artifact@v4\n with:\n name: package_macOS_${{ env.QBDI_ARCH }}\n path: build/QBDI-*.pkg\n\n build-aarch64:\n runs-on: macos-15\n env:\n QBDI_ARCH: 'AARCH64'\n QBDI_PLATFORM: 'macos'\n MACOSX_DEPLOYMENT_TARGET: '10.14'\n CMAKE_OSX_ARCHITECTURES: \"arm64\"\n steps:\n - name: Set up Python env\n uses: actions/setup-python@v5\n with:\n python-version: \"3.12\"\n - name: Install system dependencies\n run: |\n brew install cmake ninja ccache\n python3 -m pip install --upgrade pip setuptools wheel\n - name: checkout\n uses: actions/checkout@v4\n - name: Cache ccache\n uses: actions/cache@v4\n id: cache-ccache\n with:\n path: |\n ~/.ccache\n key: ccache-macos-${{ env.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-${{ github.run_number }}\n restore-keys: |\n ccache-macos-${{ env.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - if: steps.cache-ccache.outputs.cache-hit != 'true'\n run: |\n mkdir -p ~/.ccache\n cp .github/workflows/ccache.conf ~/.ccache/ccache.conf\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n - run: mkdir -p build\n - name: build QBDI\n working-directory: ./build\n run: |\n cmake -G Ninja \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DQBDI_PLATFORM=${{ env.QBDI_PLATFORM }} \\\n -DQBDI_ARCH=${{ env.QBDI_ARCH }} \\\n -DQBDI_TOOLS_VALIDATOR=ON \\\n -DQBDI_EXAMPLES=ON \\\n ..\n ninja\n cpack\n - name: test QBDI\n working-directory: ./build/test\n run: |\n ./QBDITest\n - name: Export package\n uses: actions/upload-artifact@v4\n with:\n name: package_macOS_${{ env.QBDI_ARCH }}\n path: build/QBDI-*.pkg\n\n build-aarch64-arm64e:\n runs-on: macos-15\n env:\n QBDI_ARCH: 'AARCH64'\n QBDI_PLATFORM: 'macos'\n MACOSX_DEPLOYMENT_TARGET: '10.14'\n CMAKE_OSX_ARCHITECTURES: \"arm64e\"\n steps:\n - name: Set up Python env\n uses: actions/setup-python@v5\n with:\n python-version: \"3.12\"\n - name: Install system dependencies\n run: |\n brew install cmake ninja ccache\n python3 -m pip install --upgrade pip setuptools wheel\n - name: checkout\n uses: actions/checkout@v4\n - name: Cache ccache\n uses: actions/cache@v4\n id: cache-ccache\n with:\n path: |\n ~/.ccache\n key: ccache-macos-${{ env.QBDI_ARCH }}-arm64e-${{ hashFiles('.github/workflows/ccache.conf') }}-${{ github.run_number }}\n restore-keys: |\n ccache-macos-${{ env.QBDI_ARCH }}-arm64e-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - if: steps.cache-ccache.outputs.cache-hit != 'true'\n run: |\n mkdir -p ~/.ccache\n cp .github/workflows/ccache.conf ~/.ccache/ccache.conf\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n - run: mkdir -p build\n - name: build QBDI\n working-directory: ./build\n run: |\n echo 'set(\"CMAKE_OSX_ARCHITECTURES\" \"arm64\" CACHE STRING \"\" FORCE)' > QBDI_llvm_tblgen.cmake\n cmake -G Ninja \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DQBDI_PLATFORM=${{ env.QBDI_PLATFORM }} \\\n -DQBDI_ARCH=${{ env.QBDI_ARCH }} \\\n -DQBDI_PTRAUTH=ON \\\n -DQBDI_TOOLS_VALIDATOR=ON \\\n -DQBDI_EXAMPLES=ON \\\n -DQBDI_LLVM_TABLEN_TOOLSCHAIN=$(pwd)/QBDI_llvm_tblgen.cmake \\\n ..\n ninja\n cpack\n # github action doesn't seems to be able to execute arm64e binary\n # - name: test QBDI\n # working-directory: ./build/test\n # run: |\n # ./QBDITest\n - name: Export package\n uses: actions/upload-artifact@v4\n with:\n name: package_macOS_${{ env.QBDI_ARCH }}_arm64e\n path: build/QBDI-*.pkg\n" }, { "path": ".github/workflows/python.yml", "content": "name: PyQBDI package\n\non:\n push:\n branches:\n - master\n - dev-next\n tags:\n - 'v*'\n workflow_dispatch:\n\njobs:\n build_pyqbdi_linux:\n uses: ./.github/workflows/python_linux.yml\n secrets: inherit\n build_pyqbdi_macos:\n uses: ./.github/workflows/python_macos.yml\n secrets: inherit\n build_pyqbdi_windows:\n uses: ./.github/workflows/python_windows.yml\n secrets: inherit\n\n trigger-rtd:\n runs-on: ubuntu-latest\n needs: build_pyqbdi_linux\n steps:\n - name: trigger Read The docs build\n if: github.event_name == 'push'\n run: |\n curl -X POST -d \"branches=${BRANCH}\" -d \"token=${RTD_TOKEN}\" https://readthedocs.org/api/v2/webhook/qbdi/145608/\n env:\n RTD_TOKEN: ${{ secrets.RTD_TOKEN }}\n BRANCH: ${{ github.ref_name }}\n\n all-in-one:\n name: All PyQBDI whell\n needs:\n - build_pyqbdi_linux\n - build_pyqbdi_macos\n - build_pyqbdi_windows\n runs-on: ubuntu-latest\n\n steps:\n - name: Download all wheel\n uses: actions/download-artifact@v4\n with:\n pattern: PyQBDI_*\n path: dist/\n merge-multiple: true\n\n - name: Export All wheels\n uses: actions/upload-artifact@v4\n with:\n name: All_PyQBDI\n path: dist/*\n\n publish-to-testpypi:\n name: Publish to TestPyPI\n needs:\n - build_pyqbdi_linux\n - build_pyqbdi_macos\n - build_pyqbdi_windows\n runs-on: ubuntu-latest\n\n if: ${{ github.event_name == 'push' && github.ref_name == 'dev-next' && github.ref_type == 'branch' }}\n\n environment:\n name: test\n url: https://test.pypi.org/p/PyQBDI\n\n permissions:\n id-token: write\n\n steps:\n - name: Download all wheel\n uses: actions/download-artifact@v4\n with:\n pattern: PyQBDI_*\n path: dist/\n merge-multiple: true\n\n - name: Publish to TestPyPI\n uses: pypa/gh-action-pypi-publish@release/v1\n with:\n repository-url: https://test.pypi.org/legacy/\n skip-existing: true\n\n publish-to-pypi:\n name: Publish to PyPI\n needs:\n - build_pyqbdi_linux\n - build_pyqbdi_macos\n - build_pyqbdi_windows\n runs-on: ubuntu-latest\n\n if: startsWith(github.ref, 'refs/tags/v')\n\n environment:\n name: release\n url: https://pypi.org/p/PyQBDI\n\n permissions:\n id-token: write\n\n steps:\n - name: Download all wheel\n uses: actions/download-artifact@v4\n with:\n pattern: PyQBDI_*\n path: dist/\n merge-multiple: true\n\n - name: Publish to PyPI\n uses: pypa/gh-action-pypi-publish@release/v1\n" }, { "path": ".github/workflows/python_linux.yml", "content": "name: PyQBDI Linux package\n\non:\n workflow_call:\n workflow_dispatch:\n\njobs:\n build:\n runs-on: ubuntu-latest\n strategy:\n matrix: \n python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14']\n QBDI_ARCH: ['X86_64', 'X86']\n fail-fast: false\n env:\n QBDI_PLATFORM: 'linux'\n steps:\n - name: checkout\n uses: actions/checkout@v4\n - name: Cache ccache\n uses: actions/cache@v4\n id: cache-ccache\n with:\n path: |\n ~/.ccache\n key: ccache-pyqbdi-linux-${{ matrix.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-${{ github.run_number }}\n restore-keys: |\n ccache-pyqbdi-linux-${{ matrix.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - if: steps.cache-ccache.outputs.cache-hit != 'true'\n run: |\n mkdir -p ~/.ccache\n cp .github/workflows/ccache.conf ~/.ccache/ccache.conf\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n - name: Create build image\n env:\n QBDI_ARCH: ${{ matrix.QBDI_ARCH }}\n run: bash ./docker/ci_python_linux/img_build.sh\n - name: Build Wheel for python ${{ matrix.python-version }}\n env:\n QBDI_ARCH: ${{ matrix.QBDI_ARCH }}\n run: bash ./docker/ci_python_linux/whl_build.sh ${{ matrix.python-version }}\n - name: Export wheel ${{ matrix.python-version }}\n uses: actions/upload-artifact@v4\n with:\n name: PyQBDI_linux_${{ matrix.QBDI_ARCH }}_python_${{ matrix.python-version }}\n path: outwheel/*\n\n" }, { "path": ".github/workflows/python_macos.yml", "content": "name: PyQBDI macOS package\n\non:\n workflow_call:\n workflow_dispatch:\n\njobs:\n build-pyqbdi-x64:\n runs-on: macos-15-intel\n strategy:\n matrix:\n python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14']\n fail-fast: false\n env:\n QBDI_PLATFORM: 'macos'\n QBDI_ARCH: 'X86_64'\n MACOSX_DEPLOYMENT_TARGET: '10.14'\n _PYTHON_HOST_PLATFORM: \"macosx-10.14-x86_64\"\n CMAKE_OSX_ARCHITECTURES: \"x86_64\"\n steps:\n - name: Set up Python ${{ matrix.python-version }}\n uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n allow-prereleases: ${{ matrix.python-version == '3.15' }}\n - name: Install system dependencies\n run: |\n brew install cmake ninja ccache\n python3 -m pip install --upgrade pip setuptools wheel build\n - name: checkout\n uses: actions/checkout@v4\n - name: Cache ccache\n uses: actions/cache@v4\n id: cache-ccache-python\n with:\n path: |\n ~/.ccache\n key: ccache-macos-X86_64-${{ hashFiles('.github/workflows/ccache.conf') }}-python-${{ matrix.python-version }}-${{ github.run_number }}\n restore-keys: |\n ccache-macos-X86_64-${{ hashFiles('.github/workflows/ccache.conf') }}-python-${{ matrix.python-version }}-\n ccache-macos-X86_64-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - if: steps.cache-ccache-python.outputs.cache-hit != 'true'\n run: |\n mkdir -p ~/.ccache\n cp .github/workflows/ccache.conf ~/.ccache/ccache.conf\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n - name: Build PyQBDI ${{ matrix.python-version }}\n run: |\n python3 --version\n python3 -m build -w\n - name: Export package\n uses: actions/upload-artifact@v4\n with:\n name: PyQBDI_macOS_X86_64_${{ matrix.python-version }}\n path: dist/*\n\n build-pyqbdi-aarch64:\n runs-on: macos-15\n strategy:\n matrix:\n python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']\n fail-fast: false\n env:\n QBDI_ARCH: 'AARCH64'\n QBDI_PLATFORM: 'macos'\n MACOSX_DEPLOYMENT_TARGET: '11.0'\n _PYTHON_HOST_PLATFORM: \"macosx-11.0-arm64\"\n CMAKE_OSX_ARCHITECTURES: \"arm64\"\n steps:\n - name: Set up Python ${{ matrix.python-version }}\n uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n allow-prereleases: ${{ matrix.python-version == '3.15' }}\n - name: Install system dependencies\n run: |\n brew install cmake ninja ccache\n python3 -m pip install --upgrade pip setuptools wheel build\n - name: checkout\n uses: actions/checkout@v4\n - name: Cache ccache\n uses: actions/cache@v4\n id: cache-ccache-python\n with:\n path: |\n ~/.ccache\n key: ccache-macos-AARCH64-${{ hashFiles('.github/workflows/ccache.conf') }}-python-${{ matrix.python-version }}-${{ github.run_number }}\n restore-keys: |\n ccache-macos-AARCH64-${{ hashFiles('.github/workflows/ccache.conf') }}-python-${{ matrix.python-version }}-\n ccache-macos-AARCH64-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - if: steps.cache-ccache-python.outputs.cache-hit != 'true'\n run: |\n mkdir -p ~/.ccache\n cp .github/workflows/ccache.conf ~/.ccache/ccache.conf\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n - name: Build PyQBDI ${{ matrix.python-version }}\n run: |\n python3 --version\n python3 -m build -w\n - name: Export package\n uses: actions/upload-artifact@v4\n with:\n name: PyQBDI_macOS_AARCH64_${{ matrix.python-version }}\n path: dist/*\n\n# build-pyqbdi-aarch64-arm64e:\n# runs-on: macos-15\n# env:\n# QBDI_ARCH: 'AARCH64'\n# QBDI_PLATFORM: 'macos'\n# MACOSX_DEPLOYMENT_TARGET: '11.0'\n# _PYTHON_HOST_PLATFORM: 'macosx-11.0-arm64'\n# CMAKE_OSX_ARCHITECTURES: 'arm64e'\n# OPENSSL_VERSION: '3.5.4'\n# OPENSSL_PREFIX: ${{ github.workspace }}/openssl-build\n# PYTHON_VERSION: '3.14.0'\n# PYTHON_PREFIX: ${{ github.workspace }}/python-build\n# PYTHON_VENV: ${{ github.workspace }}/python-venv\n# steps:\n# - name: Download OpenSSL\n# run: |\n# wget -O- https://github.com/openssl/openssl/releases/download/openssl-${OPENSSL_VERSION}/openssl-${OPENSSL_VERSION}.tar.gz | tar xJf -\n# - name: Build OpenSSL for arm64e\n# working-directory: openssl-${{ env.OPENSSL_VERSION }}\n# run: |\n# sed -i'' -e 's/-arch arm64/-arch arm64e/g' Configurations/10-main.conf\n# ./configure --prefix=${OPENSSL_PREFIX} --openssldir=${OPENSSL_PREFIX}/ssl\n# make -j$(nproc)\n# make install\n# - name: Download Python\n# run: |\n# wget -O- https://www.python.org/ftp/python/${PYTHON_VERSION}/Python-${PYTHON_VERSION}.tar.xz | tar xJf -\n# - name: Build Python for arm64e\n# working-directory: Python-${{ env.PYTHON_VERSION }}\n# run: |\n# ./configure --prefix=${PYTHON_PREFIX} --with-pydebug --with-openssl=${OPENSSL_PREFIX} \\\n# CFLAGS='-arch arm64e' LDFLAGS='-arch arm64e'\n# make -j$(nproc)\n# make install\n# - name: Checkout QBDI\n# uses: actions/checkout@v4\n# - name: Install system dependencies\n# run: |\n# brew install cmake\n# - name: Create Python virtual environment\n# run: |\n# ${PYTHON_PREFIX}/bin/python3 -m venv ${PYTHON_VENV}\n# ${PYTHON_VENV}/bin/python3 -m pip install --upgrade pip setuptools wheel build\n# - name: Build PyQBDI ${PYTHON_VERSION}\n# run: |\n# ${PYTHON_VENV}/bin/python3 -m build -w\n# - name: Export package\n# uses: actions/upload-artifact@v4\n# with:\n# name: PyQBDI_macOS_AARCH64_arm64e_${PYTHON_VERSION}\n# path: dist/*\n" }, { "path": ".github/workflows/python_windows.yml", "content": "name: PyQBDI Windows Package\n\non:\n workflow_call:\n workflow_dispatch:\n\njobs:\n build:\n runs-on: windows-latest\n strategy:\n matrix:\n python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14']\n QBDI_ARCH: ['X86_64', 'X86']\n include:\n - QBDI_ARCH: 'X86_64'\n WINDOWS_ARCH: 'x64'\n - QBDI_ARCH: 'X86'\n WINDOWS_ARCH: 'x86'\n fail-fast: false\n env:\n QBDI_PLATFORM: 'windows'\n SCCACHE_CACHE_SIZE: \"1G\"\n SCCACHE_DIR: \"C:\\\\Users\\\\runner\\\\AppData\\\\Local\\\\Mozilla\\\\sccache\"\n steps:\n - name: Install system dependencies\n run: |\n choco install sccache\n - name: checkout\n uses: actions/checkout@v4\n - name: Cache sccache\n uses: actions/cache@v4\n id: cache-sccache\n with:\n path: |\n ${{ env.SCCACHE_DIR }}\n key: sccache-win-${{ matrix.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-${{ matrix.python-version }}-${{ github.run_number }}\n restore-keys: |\n sccache-win-${{ matrix.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-${{ matrix.python-version }}-\n sccache-win-${{ matrix.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - name: Create sccache directory\n if: steps.cache-sccache.outputs.cache-hit != 'true'\n shell: powershell\n run: |\n If(!(test-path -PathType container ${env:SCCACHE_DIR}))\n {\n New-Item -ItemType Directory -Path ${env:SCCACHE_DIR}\n }\n - uses: ilammy/msvc-dev-cmd@v1\n with:\n arch: ${{ matrix.WINDOWS_ARCH }}\n - name: Start sccache server\n run: sccache --start-server\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n\n - name: Set up Python ${{ matrix.python-version }}\n uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n allow-prereleases: ${{ matrix.python-version == '3.15' }}\n architecture: ${{ matrix.WINDOWS_ARCH }}\n - name: build PyQBDI ${{ matrix.python-version }}\n run: |\n python --version\n python -m pip --version\n python -m pip install --upgrade pip\n python -m pip install setuptools wheel build\n python -m build -w\n\n - name: Export package\n uses: actions/upload-artifact@v4\n with:\n name: PyQBDI_windows_${{ matrix.QBDI_ARCH }}_python_${{ matrix.python-version }}\n path: dist\\PyQBDI-*.whl\n - name: Stop sccache server\n run: sccache --stop-server\n\n" }, { "path": ".github/workflows/windows.yml", "content": "name: Tests and Package Windows\n\non:\n push:\n branches:\n - master\n - dev-next\n pull_request:\n workflow_dispatch:\n\njobs:\n build:\n runs-on: windows-latest\n strategy:\n matrix:\n include:\n - QBDI_ARCH: 'X86_64'\n WINDOWS_ARCH: 'x64'\n - QBDI_ARCH: 'X86'\n WINDOWS_ARCH: 'x86'\n fail-fast: false\n env:\n QBDI_PLATFORM: 'windows'\n SCCACHE_CACHE_SIZE: \"1G\"\n SCCACHE_DIR: \"C:\\\\Users\\\\runner\\\\AppData\\\\Local\\\\Mozilla\\\\sccache\"\n steps:\n - name: Install system dependencies\n run: |\n choco install sccache nsis\n - name: checkout\n uses: actions/checkout@v4\n - name: Cache sccache\n uses: actions/cache@v4\n id: cache-sccache\n with:\n path: |\n ${{ env.SCCACHE_DIR }}\n key: sccache-win-${{ matrix.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-${{ github.run_number }}\n restore-keys: |\n sccache-win-${{ matrix.QBDI_ARCH }}-${{ hashFiles('.github/workflows/ccache.conf') }}-\n - name: Create sccache directory\n if: steps.cache-sccache.outputs.cache-hit != 'true'\n shell: powershell\n run: |\n If(!(test-path -PathType container ${env:SCCACHE_DIR}))\n {\n New-Item -ItemType Directory -Path ${env:SCCACHE_DIR}\n }\n - uses: ilammy/msvc-dev-cmd@v1\n with:\n arch: ${{ matrix.WINDOWS_ARCH }}\n - name: Start sccache server\n run: sccache --start-server\n - name: Cache third-party\n uses: actions/cache@v4\n with:\n path: |\n third-party\n key: QBDI-third-party-${{ hashFiles('**/CMakeLists.txt') }}-${{ hashFiles('**/*.cmake') }}\n - run: mkdir build\n - name: Configure\n working-directory: .\\build\n run: cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_CROSSCOMPILING=FALSE -DQBDI_PLATFORM=${{ env.QBDI_PLATFORM }} -DQBDI_ARCH=${{ matrix.QBDI_ARCH }} -DQBDI_TOOLS_VALIDATOR=OFF -DQBDI_TOOLS_PYQBDI=OFF -DQBDI_EXAMPLES=ON ..\n - name: build QBDI\n working-directory: .\\build\n run: ninja\n - name: package QBDI\n working-directory: .\\build\n run: cpack\n - name: test QBDI\n working-directory: .\\build\\test\n run: |\n .\\QBDITest\n - name: Export package\n uses: actions/upload-artifact@v4\n with:\n name: package_Windows_${{ matrix.WINDOWS_ARCH }}\n path: build/QBDI-*.exe\n - name: Stop sccache server\n run: sccache --stop-server\n\n" }, { "path": ".gitignore", "content": "**/.DS_Store\nTODO\nbuild*/*\n\ndist\noutwheel\n\ndocs/build\ndocs/doxygen_c\ndocs/doxygen_cpp\ndocs/doxygen_qbdipreload\ndocs/qbdi_c.doxygen\ndocs/qbdi_cpp.doxygen\ndocs/qbdipreload.doxygen\n\nqbdi-deps.tar.gz\nqbdi.tar.gz\npackage/QBDI-*\npackage/package-*\n\nthird-party\n\ntools/validation_runner/.*_coverage\ntools/validation_runner/.*_output\ntools/validation_runner/.*_result\ntools/validation_runner/*.db\ntools/validation_runner/travis_db\n\n__pycache__\n*.pyc\n*.egg-info\n" }, { "path": ".readthedocs.condaenv.yml", "content": "name: RTD\nchannels:\n - conda-forge\n - defaults\ndependencies:\n - python=3.11\n - doxygen=1.9.8\n - pip\n - pip:\n - python-dateutil\n - pygit2\n - requests\n - Sphinx==5.3.0\n - docutils==0.18.1\n - breathe==4.35.0\n - sphinx-js==3.2.1\n - markupsafe==2.0.1\n - sphinx_rtd_theme==1.3.0\n" }, { "path": ".readthedocs.yml", "content": "version: 2\n\nbuild:\n os: ubuntu-24.04\n tools:\n python: \"miniconda3-4.7\"\n nodejs: \"20\"\n jobs:\n post_create_environment:\n - npm install -g jsdoc\n\n# install doxygen >= 1.9.2\nconda:\n environment: .readthedocs.condaenv.yml\n\n# Build documentation in the docs/ directory with Sphinx\nsphinx:\n configuration: docs/source/conf.py\n\nformats:\n - htmlzip\n - pdf\n\npython:\n install:\n - method: setuptools\n path: docs/rtd_pyqbdi_artifact\n" }, { "path": "CHANGELOG", "content": "Changelog\n=========\n\nsee docs/source/changelog.rst or https://qbdi.readthedocs.io/en/stable/changelog.html\n" }, { "path": "CMakeLists.txt", "content": "cmake_minimum_required(VERSION 3.28)\nproject(QBDI)\n\ninclude(GNUInstallDirs)\n\nlist(APPEND CMAKE_MODULE_PATH \"${CMAKE_CURRENT_SOURCE_DIR}/cmake/\")\n\n# Avoid warning about DOWNLOAD_EXTRACT_TIMESTAMP in CMake 3.24:\ncmake_policy(SET CMP0135 NEW)\n\n# Config platform & arch\ninclude(QBDIConfig)\n# Option\ninclude(QBDIOptions)\n\n# Force find system utils (strip)\ninclude(CMakeFindBinUtils)\n\n# Macros\ninclude(merge_archives)\n\n# CCACHE\n# ======\nif(QBDI_CCACHE)\n if(CMAKE_SYSTEM_NAME STREQUAL \"Windows\")\n find_program(SCCACHE_FOUND sccache)\n if(SCCACHE_FOUND)\n set(CMAKE_C_COMPILER_LAUNCHER ${SCCACHE_FOUND})\n set(CMAKE_CXX_COMPILER_LAUNCHER ${SCCACHE_FOUND})\n message(STATUS \"found SCCACHE at ${SCCACHE_FOUND}\")\n else()\n set(QBDI_CCACHE OFF)\n message(WARNING \"CCACHE or SCCACHE not found: disabled\")\n endif()\n else()\n find_program(CCACHE_FOUND ccache)\n if(CCACHE_FOUND)\n set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${CCACHE_FOUND})\n set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ${CCACHE_FOUND})\n message(STATUS \"found CCACHE at ${CCACHE_FOUND}\")\n else()\n set(QBDI_CCACHE OFF)\n message(WARNING \"CCACHE or SCCACHE not found: disabled\")\n endif()\n endif()\nendif()\n\ninclude(CheckCCompilerFlag)\n\nif(QBDI_ASAN)\n set(CMAKE_REQUIRED_FLAGS \"-Werror -fsanitize=address\")\n check_c_compiler_flag(\"-fsanitize=address\" HAVE_FLAG_SANITIZE_ADDRESS)\n unset(CMAKE_REQUIRED_FLAGS)\n if(HAVE_FLAG_SANITIZE_ADDRESS)\n set(CMAKE_C_FLAGS \"${CMAKE_C_FLAGS} -fsanitize=address\")\n set(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -fsanitize=address\")\n message(STATUS \"ASAN is activated\")\n else()\n message(WARNING \"ASAN can't be activated\")\n endif()\nendif()\n\n# Configure RPATH on OS X\n\nif(APPLE)\n set(CMAKE_MACOSX_RPATH TRUE)\n\n # use, i.e. don't skip the full RPATH for the build tree\n set(CMAKE_SKIP_BUILD_RPATH FALSE)\n\n # when building, don't use the install RPATH already\n # (but later on when installing)\n set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)\n\n set(CMAKE_INSTALL_RPATH \"${CMAKE_INSTALL_PREFIX}/lib\")\n\n # add the automatically determined parts of the RPATH\n # which point to directories outside the build tree to the install RPATH\n set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)\n\n # the RPATH to be used when installing, but only if it's not a system directory\n list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES\n \"${CMAKE_INSTALL_PREFIX}/lib\" isSystemDir)\n if(\"${isSystemDir}\" STREQUAL \"-1\")\n set(CMAKE_INSTALL_RPATH \"${CMAKE_INSTALL_PREFIX}/lib\")\n endif(\"${isSystemDir}\" STREQUAL \"-1\")\nendif()\n\nset(QBDI_EXPORT_SYM 1)\nconfigure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/include/QBDI/Config.h.in\"\n \"${CMAKE_CURRENT_BINARY_DIR}/include-shared/QBDI/Config.h\" @ONLY)\nunset(QBDI_EXPORT_SYM)\nconfigure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/include/QBDI/Config.h.in\"\n \"${CMAKE_CURRENT_BINARY_DIR}/include-static/QBDI/Config.h\" @ONLY)\nconfigure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/include/QBDI/Version.h.in\"\n \"${CMAKE_CURRENT_BINARY_DIR}/include/QBDI/Version.h\" @ONLY)\nconfigure_file(\n \"${CMAKE_CURRENT_SOURCE_DIR}/include/QBDI/arch/${QBDI_ARCH}/State.h\"\n \"${CMAKE_CURRENT_BINARY_DIR}/include/QBDI/State.h\" COPYONLY)\nconfigure_file(\n \"${CMAKE_CURRENT_SOURCE_DIR}/include/QBDI/arch/${QBDI_ARCH}/Options.h\"\n \"${CMAKE_CURRENT_BINARY_DIR}/include/QBDI/Options.h\" COPYONLY)\nconfigure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/src/Utility/Version_commit.h.in\"\n \"${CMAKE_CURRENT_BINARY_DIR}/src/Utility/Version_commit.h\" @ONLY)\n\n# log debug\nset(QBDI_COMMON_DEFINITION)\nif(QBDI_LOG_DEBUG)\n message(STATUS \"Compiling with QBDI_LOG_DEBUG\")\n set(QBDI_COMMON_DEFINITION ${QBDI_COMMON_DEFINITION} -D_QBDI_LOG_DEBUG)\nendif()\n\nif(QBDI_PLATFORM_WINDOWS)\n set(QBDI_COMMON_C_FLAGS\n /DWIN32\n /D_WINDOWS\n /W3\n /MP\n /permissive-\n -D_CRT_SECURE_NO_DEPRECATE\n -D_CRT_SECURE_NO_WARNINGS\n -D_CRT_NONSTDC_NO_DEPRECATE\n -D_CRT_NONSTDC_NO_WARNINGS\n -D_SCL_SECURE_NO_DEPRECATE\n -D_SCL_SECURE_NO_WARNINGS\n -D_DISABLE_CONSTEXPR_MUTEX_CONSTRUCTOR\n -w14062\n -wd4141\n -wd4146\n -wd4180\n -wd4244\n -wd4258\n -wd4267\n -wd4291\n -wd4345\n -wd4351\n -wd4355\n -wd4456\n -wd4457\n -wd4458\n -wd4459\n -wd4503\n -wd4624\n -wd4722\n -wd4800\n -we4238\n -D__STDC_CONSTANT_MACROS\n -D__STDC_FORMAT_MACROS\n -D__STDC_LIMIT_MACROS)\n set(QBDI_COMMON_CXX_FLAGS\n /DWIN32\n /D_WINDOWS\n /W3\n /MP\n /permissive-\n -D_CRT_SECURE_NO_DEPRECATE\n -D_CRT_SECURE_NO_WARNINGS\n -D_CRT_NONSTDC_NO_DEPRECATE\n -D_CRT_NONSTDC_NO_WARNINGS\n -D_SCL_SECURE_NO_DEPRECATE\n -D_SCL_SECURE_NO_WARNINGS\n -D_DISABLE_CONSTEXPR_MUTEX_CONSTRUCTOR\n -w14062\n -wd4141\n -wd4146\n -wd4180\n -wd4244\n -wd4258\n -wd4267\n -wd4291\n -wd4345\n -wd4351\n -wd4355\n -wd4456\n -wd4457\n -wd4458\n -wd4459\n -wd4503\n -wd4624\n -wd4722\n -wd4800\n -we4238\n -D__STDC_CONSTANT_MACROS\n -D__STDC_FORMAT_MACROS\n -D__STDC_LIMIT_MACROS)\n # set _SILENCE_CXX17_ITERATOR_BASE_CLASS_DEPRECATION_WARNING for llvm compile\n set(CMAKE_CXX_FLAGS\n \"${CMAKE_CXX_FLAGS} -D_SILENCE_CXX17_ITERATOR_BASE_CLASS_DEPRECATION_WARNING\"\n )\nelse()\n set(QBDI_COMMON_C_FLAGS -Wall -ffunction-sections -fdata-sections\n -fvisibility-inlines-hidden -fvisibility=hidden -fPIC)\n set(QBDI_COMMON_CXX_FLAGS\n -Wall\n -ffunction-sections\n -fdata-sections\n -fvisibility-inlines-hidden\n -fvisibility=hidden\n -fPIC\n -fno-rtti)\n if(CMAKE_CXX_COMPILER_ID STREQUAL \"GNU\")\n list(APPEND QBDI_COMMON_C_FLAGS -Wno-missing-template-keyword)\n list(APPEND QBDI_COMMON_CXX_FLAGS -Wno-missing-template-keyword)\n check_c_compiler_flag(-Wno-psabi HAS_NO_PSABI)\n if(HAS_NO_PSABI)\n list(APPEND QBDI_COMMON_C_FLAGS -Wno-psabi)\n list(APPEND QBDI_COMMON_CXX_FLAGS -Wno-psabi)\n endif()\n endif()\n if(NOT QBDI_PLATFORM_ANDROID)\n set(QBDI_COMMON_DEFINITION\n ${QBDI_COMMON_DEFINITION} -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS\n -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS)\n endif()\nendif()\n\n# AVX\nif(QBDI_DISABLE_AVX)\n set(QBDI_COMMON_DEFINITION ${QBDI_COMMON_DEFINITION}\n -D_QBDI_FORCE_DISABLE_AVX)\nendif()\n\n# Force 32bit\nif(QBDI_PLATFORM_MACOS AND QBDI_ARCH_X86)\n set(CMAKE_C_FLAGS \"-arch i386 ${CMAKE_C_FLAGS}\")\n set(CMAKE_CXX_FLAGS \"-arch i386 ${CMAKE_CXX_FLAGS}\")\nelseif((QBDI_PLATFORM_LINUX OR QBDI_PLATFORM_ANDROID) AND QBDI_ARCH_X86)\n set(CMAKE_C_FLAGS \"-m32 ${CMAKE_C_FLAGS}\")\n set(CMAKE_CXX_FLAGS \"-m32 ${CMAKE_CXX_FLAGS}\")\nendif()\n\n# Disable thumb on ARM (until we support it)\nif(QBDI_ARCH_ARM)\n # detect if -mthumb-interwork is needed\n check_c_compiler_flag(-mthumb-interwork HAS_THUMB_INTERWORK)\n if(HAS_THUMB_INTERWORK)\n set(CMAKE_C_FLAGS \"${CMAKE_C_FLAGS} -mthumb-interwork\")\n set(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -mthumb-interwork\")\n set(CMAKE_EXE_LINKER_FLAGS \"${CMAKE_EXE_LINKER_FLAGS} -mthumb-interwork\")\n set(CMAKE_SHARED_LINKER_FLAGS\n \"${CMAKE_SHARED_LINKER_FLAGS} -mthumb-interwork\")\n set(CMAKE_MODULE_LINKER_FLAGS\n \"${CMAKE_MODULE_LINKER_FLAGS} -mthumb-interwork\")\n endif()\nendif()\n\n# Dependencies\n# ============\ninclude(QBDIDependencies)\n\n# Setup assembly compile\nif(QBDI_PLATFORM_WINDOWS)\n enable_language(ASM_MASM)\n set(ASM_EXT \"asm\")\nelseif(QBDI_ARCH_X86 OR QBDI_ARCH_X86_64)\n if(NOT QBDI_PLATFORM_ANDROID)\n set(CMAKE_ASM-ATT_COMPILER ${AS_BINARY})\n enable_language(ASM-ATT)\n else()\n enable_language(ASM)\n endif()\n set(ASM_EXT \"s\")\n if(QBDI_PLATFORM_MACOS AND QBDI_ARCH_X86)\n set(CMAKE_ASM-ATT_FLAGS \"-arch i386\")\n elseif((QBDI_PLATFORM_LINUX OR QBDI_PLATFORM_ANDROID) AND QBDI_ARCH_X86)\n set(CMAKE_ASM-ATT_FLAGS \"--32\")\n endif()\nelse()\n enable_language(ASM)\n if(QBDI_PLATFORM_IOS)\n if(QBDI_ARCH_AARCH64)\n set(CMAKE_ASM_FLAGS \"-arch arm64\")\n else()\n set(CMAKE_ASM_FLAGS \"-arch armv7\")\n endif()\n endif()\nendif()\n\n# Add QBDI source file in QBDI_obj\nadd_library(QBDI_src INTERFACE)\nadd_library(QBDI_shared_src INTERFACE)\n\ntarget_link_libraries(QBDI_src INTERFACE qbdi-llvm spdlog)\n\ninclude(\"${CMAKE_CURRENT_SOURCE_DIR}/src/CMakeLists.txt\")\n\ntarget_compile_features(QBDI_src INTERFACE cxx_std_17)\ntarget_compile_options(\n QBDI_src INTERFACE $<$:${QBDI_COMMON_C_FLAGS}>)\ntarget_compile_options(\n QBDI_src INTERFACE $<$:${QBDI_COMMON_CXX_FLAGS}>)\ntarget_compile_definitions(QBDI_src INTERFACE ${QBDI_COMMON_DEFINITION})\ntarget_include_directories(\n QBDI_src\n INTERFACE \"${CMAKE_CURRENT_BINARY_DIR}/include\"\n \"${CMAKE_CURRENT_SOURCE_DIR}/include\"\n \"${CMAKE_CURRENT_SOURCE_DIR}/src\" \"${CMAKE_CURRENT_BINARY_DIR}/src\")\n\ntarget_include_directories(\n QBDI_shared_src INTERFACE \"${CMAKE_CURRENT_BINARY_DIR}/include\"\n \"${CMAKE_CURRENT_SOURCE_DIR}/include\")\n\nif(QBDI_STATIC_LIBRARY)\n add_library(QBDI_obj STATIC)\n target_link_libraries(QBDI_obj PRIVATE QBDI_src)\n set_target_properties(QBDI_obj PROPERTIES POSITION_INDEPENDENT_CODE ON)\n target_include_directories(\n QBDI_obj PUBLIC \"${CMAKE_CURRENT_BINARY_DIR}/include-static\")\n\n set(qbdi_static_libs qbdi-llvm QBDI_obj spdlog)\n\n merge_static_libs(QBDI_static QBDI \\${qbdi_static_libs})\n\n add_library(QBDI::QBDI_static ALIAS QBDI_static)\n target_include_directories(\n QBDI_static\n PUBLIC $\n $\n $\n $)\n\n target_link_libraries(QBDI_static PUBLIC ${QBDI_LLVM_LINK_LIBRARY})\n if(QBDI_PLATFORM_ANDROID)\n target_link_libraries(QBDI_static PUBLIC log)\n endif()\n add_dependencies(QBDI_static QBDI_obj)\n\n if(QBDI_PLATFORM_WINDOWS)\n set_target_properties(QBDI_static PROPERTIES OUTPUT_NAME QBDI_static)\n endif()\n\n install(\n TARGETS QBDI_static\n EXPORT QBDI_targets\n COMPONENT QBDI\n LIBRARY DESTINATION \"${CMAKE_INSTALL_LIBDIR}\"\n ARCHIVE DESTINATION \"${CMAKE_INSTALL_LIBDIR}\"\n RUNTIME DESTINATION \"${CMAKE_INSTALL_LIBDIR}\")\n\nendif()\n\n# QBDI as a shared library\nif(QBDI_SHARED_LIBRARY)\n add_library(QBDI SHARED)\n add_library(QBDI::QBDI ALIAS QBDI)\n\n target_include_directories(\n QBDI\n PUBLIC $\n $\n $\n INTERFACE $\n PRIVATE $)\n\n target_link_libraries(QBDI PRIVATE QBDI_src QBDI_shared_src qbdi-llvm)\n\n set_target_properties(QBDI PROPERTIES OUTPUT_NAME QBDI)\n\n if(DEFINED STRIP_PATH)\n # Force a strip cmd\n set(CMAKE_STRIP ${STRIP_PATH})\n endif()\n if(DEFINED CMAKE_STRIP\n AND NOT CMAKE_STRIP STREQUAL \"CMAKE_STRIP-NOTFOUND\"\n AND NOT CMAKE_BUILD_TYPE STREQUAL \"Debug\"\n AND NOT QBDI_ENABLE_LOG_DEBUG)\n\n set(STRIP_ARGS \"\")\n if(APPLE)\n set(STRIP_ARGS ${STRIP_ARGS} -un)\n elseif(UNIX)\n set(STRIP_ARGS ${STRIP_ARGS} -x)\n endif()\n add_custom_command(\n TARGET QBDI\n POST_BUILD\n COMMAND ${CMAKE_STRIP} ${STRIP_ARGS} \"$\")\n endif()\n\n # Install QBDI targets\n install(\n TARGETS QBDI\n EXPORT QBDI_targets\n COMPONENT QBDI\n LIBRARY DESTINATION \"${CMAKE_INSTALL_LIBDIR}\"\n ARCHIVE DESTINATION \"${CMAKE_INSTALL_LIBDIR}\"\n RUNTIME DESTINATION \"${CMAKE_INSTALL_LIBDIR}\")\n\n if(QBDI_PLATFORM_WINDOWS)\n install(\n FILES ${CMAKE_CURRENT_BINARY_DIR}/QBDI.exp\n COMPONENT QBDI\n DESTINATION \"${CMAKE_INSTALL_LIBDIR}\")\n endif()\n\nendif()\n\nset(CMAKE_INSTALL_DEFAULT_COMPONENT_NAME \"QBDI\")\ninstall(\n DIRECTORY \"${CMAKE_CURRENT_SOURCE_DIR}/include/QBDI\"\n DESTINATION \"${CMAKE_INSTALL_INCLUDEDIR}\"\n PATTERN \"*.in\" EXCLUDE\n PATTERN \"arch\" EXCLUDE)\ninstall(DIRECTORY \"${CMAKE_CURRENT_BINARY_DIR}/include/QBDI\"\n DESTINATION \"${CMAKE_INSTALL_INCLUDEDIR}\")\ninstall(DIRECTORY \"${CMAKE_CURRENT_BINARY_DIR}/include-static/QBDI\"\n DESTINATION \"${CMAKE_INSTALL_INCLUDEDIR}\")\n\ninstall(FILES \"${CMAKE_CURRENT_SOURCE_DIR}/include/QBDI.h\"\n DESTINATION \"${CMAKE_INSTALL_INCLUDEDIR}\")\n\nif(QBDI_INSTALL)\n # Configure install\n if(UNIX)\n set(FULL_PACKAGE true)\n else()\n set(FULL_PACKAGE false)\n endif()\n\n if(FULL_PACKAGE)\n #string(REPLACE \";\" \" \" LLVM_LIBS_STR \"${LLVM_LIBS}\")\n #configure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/package/qbdi.pc.in\"\n # \"${CMAKE_CURRENT_BINARY_DIR}/package/qbdi.pc\" @ONLY)\n #install(FILES \"${CMAKE_CURRENT_BINARY_DIR}/package/qbdi.pc\"\n # DESTINATION \"${CMAKE_INSTALL_LIBDIR}/pkgconfig/\")\n\n set(RESOURCES_PREFIX \"${CMAKE_INSTALL_DATADIR}/qbdi${QBDI_ARCH}\")\n\n install(\n FILES \"${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.txt\"\n DESTINATION \"${RESOURCES_PREFIX}\"\n COMPONENT QBDI)\n\n install(\n EXPORT QBDI_targets\n FILE QBDIConfig.cmake\n NAMESPACE QBDI::\n DESTINATION ${RESOURCES_PREFIX}/cmake)\n\n install(\n EXPORT QBDI_targets\n FILE QBDI${QBDI_ARCH}Config.cmake\n NAMESPACE QBDI::${QBDI_ARCH}::\n DESTINATION ${RESOURCES_PREFIX}/cmake)\n\n # QBDI template\n configure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/package/qbdi-template.in\"\n \"${CMAKE_CURRENT_BINARY_DIR}/package/qbdi-template\")\n configure_file(\n \"${CMAKE_CURRENT_SOURCE_DIR}/templates/qbdi_template/CMakeLists.txt.in\"\n \"${CMAKE_CURRENT_BINARY_DIR}/templates/qbdi_template/CMakeLists.txt\"\n @ONLY)\n install(\n DIRECTORY templates/qbdi_template\n DESTINATION \"${RESOURCES_PREFIX}\"\n COMPONENT QBDITemplate\n PATTERN \"CMakeLists.txt.in\" EXCLUDE)\n install(\n FILES \"${CMAKE_CURRENT_BINARY_DIR}/templates/qbdi_template/CMakeLists.txt\"\n DESTINATION \"${RESOURCES_PREFIX}/qbdi_template\")\n install(\n PROGRAMS \"${CMAKE_CURRENT_BINARY_DIR}/package/qbdi-template\"\n DESTINATION \"${CMAKE_INSTALL_BINDIR}\"\n COMPONENT QBDITemplate\n RENAME \"qbdi-template-${QBDI_ARCH}\")\n\n set(PRELOAD_RESOURCES_PREFIX\n \"${CMAKE_INSTALL_DATADIR}/qbdipreload${QBDI_ARCH}\")\n # QBDI preload template\n if(QBDI_TOOLS_QBDIPRELOAD)\n configure_file(\n \"${CMAKE_CURRENT_SOURCE_DIR}/package/qbdi-preload-template.in\"\n \"${CMAKE_CURRENT_BINARY_DIR}/package/qbdi-preload-template\")\n configure_file(\n \"${CMAKE_CURRENT_SOURCE_DIR}/templates/qbdi_preload_template/CMakeLists.txt.in\"\n \"${CMAKE_CURRENT_BINARY_DIR}/templates/qbdi_preload_template/CMakeLists.txt\"\n @ONLY)\n install(\n DIRECTORY templates/qbdi_preload_template\n DESTINATION \"${PRELOAD_RESOURCES_PREFIX}\"\n COMPONENT QBDITemplate\n PATTERN \"CMakeLists.txt.in\" EXCLUDE)\n install(\n FILES\n \"${CMAKE_CURRENT_BINARY_DIR}/templates/qbdi_preload_template/CMakeLists.txt\"\n DESTINATION \"${PRELOAD_RESOURCES_PREFIX}/qbdi_preload_template\")\n install(\n PROGRAMS \"${CMAKE_CURRENT_BINARY_DIR}/package/qbdi-preload-template\"\n DESTINATION \"${CMAKE_INSTALL_BINDIR}\"\n COMPONENT QBDITemplate\n RENAME \"qbdi-preload-template-${QBDI_ARCH}\")\n endif()\n\n # Frida template\n if(QBDI_TOOLS_FRIDAQBDI)\n configure_file(package/qbdi-frida-template.in package/qbdi-frida-template)\n install(\n DIRECTORY templates/qbdi_frida_template\n DESTINATION \"${RESOURCES_PREFIX}\"\n COMPONENT QBDIFridaTemplate)\n install(\n PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/package/qbdi-frida-template\n DESTINATION \"${CMAKE_INSTALL_BINDIR}\"\n COMPONENT QBDIFridaTemplate\n RENAME \"qbdi-frida-template-${QBDI_ARCH}\")\n install(FILES tools/frida-qbdi.js DESTINATION \"${RESOURCES_PREFIX}\")\n endif()\n\n else()\n install(\n EXPORT QBDI_targets\n FILE QBDIConfig.cmake\n NAMESPACE QBDI::\n DESTINATION cmake)\n\n install(\n EXPORT QBDI_targets\n FILE QBDI${QBDI_ARCH}Config.cmake\n NAMESPACE QBDI::${QBDI_ARCH}::\n DESTINATION cmake)\n\n install(FILES \"${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.txt\" DESTINATION .)\n\n install(DIRECTORY templates/qbdi_template/\n DESTINATION templates/qbdi_template)\n\n if(QBDI_TOOLS_QBDIPRELOAD)\n install(DIRECTORY templates/qbdi_preload_template\n DESTINATION templates/qbdi_preload_template)\n endif()\n\n if(QBDI_TOOLS_FRIDAQBDI)\n install(DIRECTORY templates/qbdi_frida_template\n DESTINATION templates/qbdi_frida_template)\n install(FILES tools/frida-qbdi.js DESTINATION .)\n endif()\n\n install(FILES LICENSE.txt package/Readme.txt DESTINATION .)\n\n set(PRELOAD_RESOURCES_PREFIX qbdipreload)\n endif()\nendif()\n\n# Configure iOS code signature\nif(QBDI_PLATFORM_IOS)\n # Find codesign executable\n execute_process(\n COMMAND xcrun -f codesign\n OUTPUT_STRIP_TRAILING_WHITESPACE\n OUTPUT_VARIABLE CODESIGN)\n # Define a code signature macro\n macro(ADD_SIGNATURE target_name)\n add_custom_command(\n TARGET ${target_name}\n POST_BUILD\n COMMAND ${CMAKE_COMMAND} -E env ${CODESIGN} -f -s -\n $)\n endmacro()\nelse()\n # Define a dummy code signature macro\n macro(ADD_SIGNATURE target_name)\n\n endmacro()\nendif()\n\n# Add tests\nif(QBDI_TEST OR QBDI_BENCHMARK)\n enable_testing()\n add_subdirectory(test)\nendif()\n\n# Add tools\nadd_subdirectory(tools)\n\n# Add examples\nif(QBDI_EXAMPLES)\n add_subdirectory(examples)\nendif()\n\n# Add documentation\nif(QBDI_INCLUDE_DOCS)\n add_subdirectory(docs)\nendif()\n\n# Add packaging\nif(QBDI_INCLUDE_PACKAGE)\n add_subdirectory(package)\nendif()\n" }, { "path": "LICENSE.txt", "content": "################################################################################\nQBDI package license\n################################################################################\n\nQBDI binaries and packages can be statically linked with the followed source:\n\n- QBDI under the Apache License v2.0\n- LLVM under the Apache License v2.0 with LLVM Exceptions\n https://releases.llvm.org/10.0.0/LICENSE.TXT\n- spdlog under the MIT License\n https://github.com/gabime/spdlog/blob/v1.x/LICENSE\n- fmtlib under the MIT License\n https://github.com/fmtlib/fmt/blob/master/LICENSE.rst\n- Catch2 under the Boost Software License 1.0\n https://github.com/catchorg/Catch2/blob/devel/LICENSE.txt\n- Pybind11 under a BSD-style license\n https://github.com/pybind/pybind11/blob/master/LICENSE\n- A sha256 implementation under GPLv3 / Apache License v2.0\n https://github.com/aguinet/sha256_literal#licensing\n\n################################################################################\nQBDI source code is under the Apache License v2.0\n################################################################################\n\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright 2017 - 2025 Quarkslab\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n" }, { "path": "MANIFEST.in", "content": "\n## include any cmake file\n\ninclude CMakeLists.txt\nrecursive-include cmake *\nrecursive-exclude cmake config/*\n\n## include tools\n\ninclude tools/CMakeLists.txt\nrecursive-include tools/pyqbdi *\nrecursive-include tools/QBDIPreload *\n\n## include code\n\nrecursive-include src *\nrecursive-include include *\n\ninclude README-pypi.rst\n" }, { "path": "README-pypi.rst", "content": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/qbdi/badge/?version=stable\n :target: https://qbdi.readthedocs.io/en/stable/?badge=stable\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/github/v/release/QBDI/QBDI\n :target: https://github.com/QBDI/QBDI/releases\n\n.. image:: https://img.shields.io/pypi/pyversions/PyQBDI\n :target: https://pypi.org/project/PyQBDI/\n\n.. image:: https://img.shields.io/pypi/v/PyQBDI\n :target: https://pypi.org/project/PyQBDI/\n\nQuarkslaB Dynamic binary Instrumentation (QBDI) is a modular, cross-platform and cross-architecture\nDBI framework. It aims to support Linux, macOS, Android, iOS and Windows operating systems running on\nx86, x86-64, ARM and AArch64 architectures. In addition of C/C++ API, Python and JS/frida bindings are\navailable to script QBDI. Information about what is a DBI framework and how QBDI\nworks can be found in the `documentation introduction `_.\n\nQBDI modularity means it doesn't contain a preferred injection method and it is designed to be\nused in conjunction with an external injection tool. QBDI includes a tiny (``LD_PRELOAD`` based)\nLinux and macOS injector for dynamic executables (QBDIPreload).\nQBDI is also fully integrated with `Frida `_, a reference dynamic instrumentation toolkit,\nallowing anybody to use their combined powers.\n\nA current limitation is that QBDI doesn't handle signals, multithreading (it doesn't deal with new\nthreads creation) and C++ exception mechanisms.\nHowever, those system-dependent features will probably not be part of the core library (KISS),\nand should be integrated as a new layer (to be determined how).\n\nStatus\n++++++\n\n.. role:: green\n.. role:: yellow\n.. role:: orange\n.. role:: red\n\n======= ============================== ================== =========================\nCPU Operating Systems Execution Memory Access Information\n======= ============================== ================== =========================\nx86-64 Android, Linux, macOS, Windows :green:`Supported` :green:`Supported`\nx86 Android, Linux, macOS, Windows :green:`Supported` :green:`Supported`\nARM Android, Linux :green:`Supported` :green:`Supported`\nAArch64 Android, Linux, macOS, iOS (*) :green:`Supported` :green:`Supported`\n======= ============================== ================== =========================\n\n\\* iOS support is unstable and need a jailbroken device.\n\nInstallation\n============\n\nPython API (PyQBDI)\n+++++++++++++++++++\n\nPyQBDI is available through PyPI. The wheel package can be either `downloaded `__ or installed with the following command:\n\n pip install PyQBDI\n\nThe PyQBDI package is self-contained so completely independent from the C/C++ package.\n\nDevel packages\n++++++++++++++\n\nThere is no strict development timeline or scheduled release plan for the QBDI project.\nAll the new features and fixes are merged onto the ``dev-next`` branch.\nDevel packages can be downloaded in the artefacts of `GitHub Actions `__.\n\nCompilation\n===========\n\nThe PyQDBI library (apart from the wheel package) can be built by solely passing the **'-DQBDI_TOOLS_PYQBDI=ON'** option to the CMake build system.\n\nHowever, if you want to build the wheel package, you can run these commands::\n\n git clone https://github.com/QBDI/QBDI.git\n python -m pip install --upgrade pip\n python -m pip install setuptools wheel build\n python -m build -w\n\nA 32-bit version of Python is mandatory for the X86 architecture whereas a 64-bit one is required for the X86-64 architecture.\n" }, { "path": "README.rst", "content": ".. image:: https://readthedocs.org/projects/qbdi/badge/?version=stable\n :target: https://qbdi.readthedocs.io/en/stable/?badge=stable\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/github/v/release/QBDI/QBDI\n :target: https://github.com/QBDI/QBDI/releases\n\n.. image:: https://img.shields.io/pypi/pyversions/PyQBDI\n :target: https://pypi.org/project/PyQBDI/\n\n.. image:: https://img.shields.io/pypi/v/PyQBDI\n :target: https://pypi.org/project/PyQBDI/\n\nIntroduction\n============\n.. intro\n\nQuarkslaB Dynamic binary Instrumentation (QBDI) is a modular, cross-platform and cross-architecture\nDBI framework. It aims to support Linux, macOS, Android, iOS and Windows operating systems running on\nx86, x86-64, ARM and AArch64 architectures. In addition of C/C++ API, Python and JS/frida bindings are\navailable to script QBDI. Information about what is a DBI framework and how QBDI\nworks can be found in the `documentation introduction `_.\n\nQBDI modularity means it doesn't contain a preferred injection method and it is designed to be\nused in conjunction with an external injection tool. QBDI includes a tiny (``LD_PRELOAD`` based)\nLinux and macOS injector for dynamic executables (QBDIPreload).\nQBDI is also fully integrated with `Frida `_, a reference dynamic instrumentation toolkit,\nallowing anybody to use their combined powers.\n\nA current limitation is that QBDI doesn't handle signals, multithreading (it doesn't deal with new\nthreads creation) and C++ exception mechanisms.\nHowever, those system-dependent features will probably not be part of the core library (KISS),\nand should be integrated as a new layer (to be determined how).\n\nStatus\n++++++\n\n.. role:: green\n.. role:: yellow\n.. role:: orange\n.. role:: red\n\n======= ============================== ================== =========================\nCPU Operating Systems Execution Memory Access Information\n======= ============================== ================== =========================\nx86-64 Android, Linux, macOS, Windows :green:`Supported` :green:`Supported`\nx86 Android, Linux, macOS, Windows :green:`Supported` :green:`Supported`\nARM Android, Linux :green:`Supported` :green:`Supported`\nAArch64 Android, Linux, macOS, iOS (*) :green:`Supported` :green:`Supported`\n======= ============================== ================== =========================\n\n\\* iOS support is unstable and need a jailbroken device.\n\n**stable**\n\n.. image:: https://readthedocs.org/projects/qbdi/badge/?version=stable\n :target: https://qbdi.readthedocs.io/en/stable/\n :alt: Documentation Status\n\n.. image:: https://github.com/QBDI/QBDI/actions/workflows/windows.yml/badge.svg?branch=master\n :target: https://github.com/QBDI/QBDI/actions/workflows/windows.yml?query=branch%3Amaster\n\n.. image:: https://github.com/QBDI/QBDI/actions/workflows/linux.yml/badge.svg?branch=master\n :target: https://github.com/QBDI/QBDI/actions/workflows/linux.yml?query=branch%3Amaster\n\n.. image:: https://github.com/QBDI/QBDI/actions/workflows/macos.yml/badge.svg?branch=master\n :target: https://github.com/QBDI/QBDI/actions/workflows/macos.yml?query=branch%3Amaster\n\n**dev**\n\n.. image:: https://readthedocs.org/projects/qbdi/badge/?version=dev-next\n :target: https://qbdi.readthedocs.io/en/dev-next/\n :alt: Documentation Status\n\n.. image:: https://github.com/QBDI/QBDI/actions/workflows/windows.yml/badge.svg?branch=dev-next\n :target: https://github.com/QBDI/QBDI/actions/workflows/windows.yml?query=branch%3Adev-next\n\n.. image:: https://github.com/QBDI/QBDI/actions/workflows/linux.yml/badge.svg?branch=dev-next\n :target: https://github.com/QBDI/QBDI/actions/workflows/linux.yml?query=branch%3Adev-next\n\n.. image:: https://github.com/QBDI/QBDI/actions/workflows/macos.yml/badge.svg?branch=dev-next\n :target: https://github.com/QBDI/QBDI/actions/workflows/macos.yml?query=branch%3Adev-next\n\n.. intro-end\n\nInstallation\n============\n\nC/C++/Frida APIs\n++++++++++++++++\n\nEvery new QBDI version is compiled and made available on the GitHub `release page `_.\n\nPython API (PyQBDI)\n+++++++++++++++++++\n\nPyQBDI is available through PyPI. The wheel package can be either `downloaded `__ or installed with the following command:\n\n pip install PyQBDI\n\nThe PyQBDI package is self-contained so completely independent from the C/C++ package.\n\nDevel packages\n++++++++++++++\n\nThere is no strict development timeline or scheduled release plan for the QBDI project.\nAll the new features and fixes are merged onto the ``dev-next`` branch.\nDevel packages can be downloaded in the artefacts of:\n\n- `GitHub Actions `__ for Android C/C++/frida API\n- `GitHub Actions `__ for Linux C/C++/frida API (based on ubuntu)\n- `GitHub Actions `__ for macOS C/C++/frida API\n- `GitHub Actions `__ for Windows packages C/C++ API\n- `GitHub Actions `__ for PyQBDI\n\nCompilation\n===========\n.. compil\n\nTo build this project, the following dependencies are needed on your system:\n\n- cmake >= 3.12\n- ninja or make\n- C++17 toolchain (gcc, clang, Visual Studio 2019, ...)\n\nA local version of llvm is statically built within QBDI because QBDI uses private APIs\nnot exported by regular LLVM installations and because our code is only compatible\nwith a specific version of those APIs.\n\nQBDI build system relies on CMake and requires to pass build configuration flags. To help with\nthis step we provide shell scripts for common build configurations which follow the naming pattern\n``config-OS-ARCH.sh``. Modifying these scripts is necessary if you want to compile in debug mode or\ncross-compile QBDI.\n\nLinux\n+++++\n\nx86-64\n^^^^^^\n\nCreate a new directory at the root of the source tree, and execute the Linux configuration script::\n\n mkdir build\n cd build\n ../cmake/config/config-linux-X86_64.sh\n ninja\n\nx86\n^^^\n\nYou can follow the same instructions as for x86-64 but instead, use the ``config-linux-X86.sh`` configuration script.\n\nmacOS\n+++++\n\nCompiling QBDI on macOS requires a few things:\n\n* A modern version of **macOS** (like Sierra)\n* **Xcode** (from the *App Store* or *Apple Developer Tools*)\n* the **Command Line Tools** (``xcode-select --install``)\n* a package manager (preferably **MacPorts**, but *HomeBrew* should also be fine)\n* some packages (``port install cmake wget ninja``)\n\nOnce requirements are met, create a new directory at the root of the source tree, and execute the macOS configuration script::\n\n mkdir build\n cd build\n ../cmake/config/config-macOS-X86_64.sh\n ninja\n\nWindows\n+++++++\n\nBuilding on Windows requires a pure Windows installation of *Python 3*\n(from the official packages, this is mandatory) in order to build our dependencies\n(we really hope to improve this in the future).\nIt also requires an up-to-date CMake and Ninja.\n\nFirst of all, the Visual Studio environment must be set up. This can be done with a command such as::\n\n \"C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Community\\VC\\Auxiliary\\Build\\vcvarsall.bat\" x64\n\n\nThen, the following commands must be run::\n\n mkdir build\n cd build\n python ../cmake/config/config-win-X86_64.py\n ninja\n\nAndroid\n+++++++\n\nCross-compiling for Android requires the NDK (or the SDK) to be installed on your workstation.\nFor now, it has only been tested under Linux.\nIf not already installed, you can download the latest Android NDK package\nthrough the `official website `__\nand extract it.\nAfterwards, the ``config-android-*.sh`` configuration script needs to be\ncustomised to match your NDK installation directory and the target platform.::\n\n # Configure and compile QBDI X86_64 with a NDK\n mkdir build && cd build\n NDK_PATH= ../cmake/config/config-android-X86_64.sh\n ninja\n\n # Configure and compile QBDI X86 with a SDK\n mkdir build && cd build\n ANDROID_SDK_ROOT= ../cmake/config/config-android-X86.sh\n ninja\n\nPyQBDI compilation\n++++++++++++++++++\n\nThe PyQDBI library (apart from the wheel package) can be built by solely passing the **'-DQBDI_TOOLS_PYQBDI=ON'** option to the CMake build system.\n\nHowever, if you want to build the wheel package, you can run these commands::\n\n python -m pip install --upgrade pip\n python -m pip install setuptools wheel build\n python -m build -w\n\nA 32-bit version of Python is mandatory for the X86 architecture whereas a 64-bit one is required for the X86-64 architecture.\n\n.. compil-end\n" }, { "path": "cmake/QBDIConfig.cmake", "content": "if(__add_qbdi_config)\n return()\nendif()\nset(__add_qbdi_config ON)\n\n# ========================\n# CMAKE build type\n# ========================\n\nset(DEFAULT_BUILD_TYPE Release)\n\nif(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)\n message(\n STATUS\n \"Setting build type to '${DEFAULT_BUILD_TYPE}' as none was specified.\")\n set(CMAKE_BUILD_TYPE\n \"${DEFAULT_BUILD_TYPE}\"\n CACHE STRING \"Used default build type (${DEFAULT_BUILD_TYPE}).\" FORCE)\n set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS \"Release\" \"Debug\"\n \"MinSizeRel\" \"RelWithDebInfo\")\nendif()\n\n# ========================\n# QBDI Version\n# ========================\n# note: the version should also be changed in the followed files:\n# - docker/archlinux/PKGBUILD.{X86|X86_64}\n# - docker/common.sh\n# - setup.cfg\n# - tools/frida-qbdi.js\nset(QBDI_VERSION_MAJOR 0)\nset(QBDI_VERSION_MINOR 12)\nset(QBDI_VERSION_PATCH 2)\nset(QBDI_VERSION_DEV 1)\n\nset(QBDI_VERSION_STRING\n \"${QBDI_VERSION_MAJOR}.${QBDI_VERSION_MINOR}.${QBDI_VERSION_PATCH}\")\nif(QBDI_VERSION_DEV)\n set(QBDI_VERSION_STRING \"${QBDI_VERSION_STRING}-devel\")\n if(EXISTS \"${CMAKE_CURRENT_SOURCE_DIR}/.git\"\n AND IS_DIRECTORY \"${CMAKE_CURRENT_SOURCE_DIR}/.git\")\n set_property(\n DIRECTORY\n APPEND\n PROPERTY CMAKE_CONFIGURE_DEPENDS \"${CMAKE_CURRENT_SOURCE_DIR}/.git\")\n find_package(Git REQUIRED)\n execute_process(\n COMMAND ${GIT_EXECUTABLE} rev-parse --short HEAD\n WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}\n OUTPUT_VARIABLE COMMIT_HASH\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n set(QBDI_VERSION_FULL_STRING \"${QBDI_VERSION_STRING}-${COMMIT_HASH}\")\n elseif(DEFINED ENV{APPVEYOR_REPO_COMMIT})\n set(QBDI_VERSION_FULL_STRING\n \"${QBDI_VERSION_STRING}-$ENV{APPVEYOR_REPO_COMMIT}\")\n else()\n set(QBDI_VERSION_FULL_STRING \"${QBDI_VERSION_STRING}\")\n endif()\nelse()\n set(QBDI_VERSION_FULL_STRING \"${QBDI_VERSION_STRING}\")\nendif()\n\n# ========================\n# QBDI Platform\n# ========================\nset(QBDI_SUPPORTED_PLATFORMS \"android\" \"linux\" \"windows\" \"macos\" \"ios\")\n\nset(QBDI_SUPPORTED_ARCH \"ARM\" \"AARCH64\" \"X86\" \"X86_64\")\n\nset(QBDI_PLATFORM_WINDOWS 0)\nset(QBDI_PLATFORM_LINUX 0)\nset(QBDI_PLATFORM_ANDROID 0)\nset(QBDI_PLATFORM_MACOS 0)\nset(QBDI_PLATFORM_IOS 0)\n\nset(QBDI_ARCH_X86 0)\nset(QBDI_ARCH_X86_64 0)\nset(QBDI_ARCH_ARM 0)\nset(QBDI_ARCH_AARCH64 0)\n\nset(QBDI_BITS_32 0)\nset(QBDI_BITS_64 0)\n\n# Check platform\nif(NOT DEFINED QBDI_PLATFORM)\n message(\n FATAL_ERROR\n \"Please set 'QBDI_PLATFORM'\\nSupported platform: ${QBDI_SUPPORTED_PLATFORMS}\"\n )\nelseif(QBDI_PLATFORM STREQUAL \"windows\")\n set(QBDI_PLATFORM_WINDOWS 1)\nelseif(QBDI_PLATFORM STREQUAL \"linux\")\n set(QBDI_PLATFORM_LINUX 1)\nelseif(QBDI_PLATFORM STREQUAL \"android\")\n set(QBDI_PLATFORM_ANDROID 1)\nelseif(QBDI_PLATFORM STREQUAL \"osx\")\n set(QBDI_PLATFORM_MACOS 1)\nelseif(QBDI_PLATFORM STREQUAL \"macos\")\n set(QBDI_PLATFORM_MACOS 1)\nelseif(QBDI_PLATFORM STREQUAL \"ios\")\n set(QBDI_PLATFORM_IOS 1)\nelse()\n message(\n FATAL_ERROR\n \"${QBDI_PLATFORM} is not a supported platform.\\nCurrently supported: ${QBDI_SUPPORTED_PLATFORMS}\"\n )\nendif()\n\n# Check arch\nif(NOT DEFINED QBDI_ARCH)\n message(\n FATAL_ERROR\n \"Please set 'QBDI_ARCH'\\nSupported architecture: ${QBDI_SUPPORTED_ARCH}\")\nelseif(QBDI_ARCH STREQUAL \"ARM\")\n set(QBDI_ARCH_ARM 1)\n set(QBDI_BITS_32 1)\n set(QBDI_LLVM_ARCH \"ARM\")\n set(QBDI_BASE_ARCH \"ARM\")\nelseif(QBDI_ARCH STREQUAL \"AARCH64\")\n set(QBDI_ARCH_AARCH64 1)\n set(QBDI_BITS_64 1)\n set(QBDI_LLVM_ARCH \"AArch64\")\n set(QBDI_BASE_ARCH \"AARCH64\")\nelseif(QBDI_ARCH STREQUAL \"X86\")\n set(QBDI_ARCH_X86 1)\n set(QBDI_BITS_32 1)\n set(QBDI_LLVM_ARCH \"X86\")\n set(QBDI_BASE_ARCH \"X86_64\")\nelseif(QBDI_ARCH STREQUAL \"X86_64\")\n set(QBDI_ARCH_X86_64 1)\n set(QBDI_BITS_64 1)\n set(QBDI_LLVM_ARCH \"X86\")\n set(QBDI_BASE_ARCH \"X86_64\")\nelse()\n message(\n FATAL_ERROR\n \"${QBDI_ARCH} is not a supported architecture.\\nCurrently supported: ${QBDI_SUPPORTED_ARCH}\"\n )\nendif()\n\nif(QBDI_PLATFORM_WINDOWS AND NOT (QBDI_ARCH_X86 OR QBDI_ARCH_X86_64))\n message(\n FATAL_ERROR\n \"Windows platform is only supported for X86 and X86_64 architectures.\")\nendif()\n\nif(QBDI_PLATFORM_MACOS\n AND NOT\n (QBDI_ARCH_X86\n OR QBDI_ARCH_X86_64\n OR QBDI_ARCH_AARCH64))\n message(\n FATAL_ERROR\n \"OSX platform is only supported for X86 and X86_64 architectures.\")\nendif()\n\nif(QBDI_PLATFORM_IOS AND NOT (QBDI_ARCH_ARM OR QBDI_ARCH_AARCH64))\n message(\n FATAL_ERROR\n \"IOS platform is only supported for ARM and AARCH64 architecture.\")\nendif()\n\nif(QBDI_PLATFORM_MACOS)\n if(QBDI_ARCH_X86_64 AND NOT (\"${CMAKE_HOST_SYSTEM_PROCESSOR}\" STREQUAL\n \"x86_64\"))\n set(CMAKE_OSX_ARCHITECTURES\n \"x86_64\"\n CACHE STRING \"\" FORCE)\n set(CMAKE_CROSSCOMPILING\n \"TRUE\"\n CACHE STRING \"\" FORCE)\n elseif(QBDI_ARCH_AARCH64 AND NOT (\"${CMAKE_HOST_SYSTEM_PROCESSOR}\" STREQUAL\n \"arm64\"))\n set(CMAKE_OSX_ARCHITECTURES\n \"arm64\"\n CACHE STRING \"\" FORCE)\n set(CMAKE_CROSSCOMPILING\n \"TRUE\"\n CACHE STRING \"\" FORCE)\n endif()\nendif()\n\nif(QBDI_PTRAUTH AND NOT ((QBDI_PLATFORM_MACOS OR QBDI_PLATFORM_IOS)\n AND QBDI_ARCH_AARCH64))\n message(\n FATAL_ERROR\n \"PTRAUTH is only supported for iOS and macOS platforms and AARCH64 architecture.\"\n )\nendif()\n\nmessage(STATUS \"\")\nmessage(STATUS \"== QBDI Target ==\")\nmessage(STATUS \"QBDI Platform: ${QBDI_PLATFORM}\")\nmessage(STATUS \"QBDI ARCH: ${QBDI_ARCH}\")\nmessage(STATUS \"LLVM ARCH: ${QBDI_LLVM_ARCH}\")\nmessage(STATUS \"Version: ${QBDI_VERSION_FULL_STRING}\")\nmessage(STATUS \"\")\n" }, { "path": "cmake/QBDIDependencies.cmake", "content": "if(__add_qbdi_deps)\n return()\nendif()\nset(__add_qbdi_deps ON)\ninclude(FetchContent)\n\nif(NOT DEFINED QBDI_THIRD_PARTY_DIRECTORY)\n set(QBDI_THIRD_PARTY_DIRECTORY \"${CMAKE_CURRENT_SOURCE_DIR}/third-party/\")\nendif()\nset(qbdi_deps)\n\n# Custom FetchContent Command\n# ===========================\n\n# since CMAKE 3.30, FetchContent_Declare doesn't support DOWNLOAD_DIR, which is\n# used in order to cache the downloaded archive during CI.\n# The followed function are used to keep this functionnality\n\nfunction(DOWNLOAD_PACKAGE PACKAGE_NAME)\n\n string(TOLOWER \"${PACKAGE_NAME}\" PACKAGE_NAME_LOWER)\n set(FetchName \"qbdi_deps_${PACKAGE_NAME_LOWER}\")\n\n FetchContent_Populate(\n ${FetchName}\n DOWNLOAD_DIR \"${QBDI_THIRD_PARTY_DIRECTORY}/${PACKAGE_NAME}_download\"\n SOURCE_DIR \"${FETCHCONTENT_BASE_DIR}/${PACKAGE_NAME_LOWER}-src\"\n BINARY_DIR \"${FETCHCONTENT_BASE_DIR}/${PACKAGE_NAME_LOWER}-build\"\n SUBBUILD_DIR \"${FETCHCONTENT_BASE_DIR}/${PACKAGE_NAME_LOWER}-subbuild\"\n QUIET ${ARGN})\n\n set(\"${PACKAGE_NAME}_EXTRACT_PATH\"\n \"${${FetchName}_SOURCE_DIR}\"\n PARENT_SCOPE)\nendfunction()\n\nfunction(PREPARE_PACKAGE PACKAGE_NAME)\n\n cmake_parse_arguments(ARG \"\" \"URL;URL_HASH\" \"\" ${ARGN})\n\n if(NOT ((DEFINED ARG_URL) AND (DEFINED ARG_URL_HASH)))\n message(FATAL_ERROR \"missing URL or URL_HASH in function argument\")\n endif()\n\n download_package(${PACKAGE_NAME} URL \"${ARG_URL}\" URL_HASH \"${ARG_URL_HASH}\")\n\n FetchContent_Declare(\n ${PACKAGE_NAME} SOURCE_DIR \"${${PACKAGE_NAME}_EXTRACT_PATH}\"\n ${ARG_UNPARSED_ARGUMENTS})\nendfunction()\n\n# Spdlog\n# ======\nset(SPDLOG_VERSION 1.15.0)\n\nprepare_package(\n spdlog\n URL\n \"https://github.com/gabime/spdlog/archive/v${SPDLOG_VERSION}.zip\"\n URL_HASH\n \"SHA256=076f3b4d452b95433083bcc66d07f79addba2d3fcb2b9177abeb7367d47aefbb\"\n EXCLUDE_FROM_ALL)\n\nlist(APPEND qbdi_deps spdlog)\n\nset(SPDLOG_NO_EXCEPTIONS\n ON\n CACHE BOOL \"Enable SPDLOG_NO_EXCEPTIONS\")\nset(SPDLOG_NO_TLS\n ON\n CACHE BOOL \"Enable SPDLOG_NO_TLS\")\nset(SPDLOG_NO_THREAD_ID\n ON\n CACHE BOOL \"Enable SPDLOG_NO_THREAD_ID\")\nif(QBDI_LOG_DEBUG)\n set(SPDLOG_ACTIVE_LEVEL\n SPDLOG_LEVEL_DEBUG\n CACHE BOOL \"Enable SPDLOG_LEVEL_DEBUG level\")\nendif()\n\n# Catch2\n# ======\nif((QBDI_TEST) OR (QBDI_BENCHMARK))\n prepare_package(\n Catch2\n URL\n \"https://github.com/catchorg/Catch2/archive/refs/tags/v3.3.1.zip\"\n URL_HASH\n \"SHA256=5e5283bf93b2693f6877bba3eaa76d66588955374d0cec5b40117066c044ad5e\"\n EXCLUDE_FROM_ALL)\n list(APPEND qbdi_deps Catch2)\nendif()\n\n# Pybind11\n# ========\nif(QBDI_TOOLS_PYQBDI)\n if(DEFINED QBDI_TOOLS_PYQBDI_TARGET_PYTHON_VERSION)\n find_package(\n Python3 \"${QBDI_TOOLS_PYQBDI_TARGET_PYTHON_VERSION}\" EXACT REQUIRED\n COMPONENTS Interpreter Development.Module\n OPTIONAL_COMPONENTS Development.Embed)\n else()\n find_package(\n Python3 REQUIRED\n COMPONENTS Interpreter Development.Module\n OPTIONAL_COMPONENTS Development.Embed)\n endif()\n\n if(NOT Python3_FOUND)\n message(FATAL_ERROR \"Python not found\")\n endif()\n\n set(PYBIND11_FINDPYTHON ON)\n\n prepare_package(\n pybind11\n URL\n \"https://github.com/pybind/pybind11/archive/v3.0.1.zip\"\n URL_HASH\n \"SHA256=20fb420fe163d0657a262a8decb619b7c3101ea91db35f1a7227e67c426d4c7e\"\n EXCLUDE_FROM_ALL)\n list(APPEND qbdi_deps pybind11)\nendif()\n\n# Fetch all deps\n# ==============\nFetchContent_MakeAvailable(${qbdi_deps})\n\n# Fetch LLVM\n# ==========\nlist(APPEND CMAKE_MODULE_PATH \"${CMAKE_CURRENT_SOURCE_DIR}/cmake/llvm\")\ninclude(QBDI_llvm)\n\n# Spdlog Configure\n# ================\nset_property(TARGET spdlog PROPERTY POSITION_INDEPENDENT_CODE ON)\ntarget_compile_definitions(\n spdlog INTERFACE SPDLOG_NO_TLS=1 SPDLOG_NO_THREAD_ID=1 SPDLOG_NO_EXCEPTIONS=1)\n\nif(QBDI_LOG_DEBUG)\n target_compile_definitions(spdlog\n INTERFACE SPDLOG_ACTIVE_LEVEL=SPDLOG_LEVEL_DEBUG)\nelse()\n target_compile_definitions(spdlog\n INTERFACE SPDLOG_ACTIVE_LEVEL=SPDLOG_LEVEL_INFO)\nendif()\n\n# remove Threads::Threads for android\nif(ANDROID)\n get_target_property(SPDLOG_LIB spdlog INTERFACE_LINK_LIBRARIES)\n list(REMOVE_ITEM SPDLOG_LIB Threads::Threads)\n set_property(TARGET spdlog PROPERTY INTERFACE_LINK_LIBRARIES \"${SPDLOG_LIB}\")\nendif()\n\nif(QBDI_PLATFORM_WINDOWS)\n target_compile_definitions(spdlog PUBLIC _DISABLE_CONSTEXPR_MUTEX_CONSTRUCTOR)\n\nelse()\n set(SPDLOG_QBDI_CXX_FLAGS\n -ffunction-sections -fdata-sections -fvisibility-inlines-hidden\n -fvisibility=hidden -fPIC -fno-rtti)\n target_compile_options(\n spdlog PRIVATE $<$:${SPDLOG_QBDI_CXX_FLAGS}>)\nendif()\n" }, { "path": "cmake/QBDIOptions.cmake", "content": "if(__add_qbdi_options)\n return()\nendif()\nset(__add_qbdi_options ON)\n\n# Enable compilation using ccache\noption(QBDI_CCACHE \"Enable CCACHE or SCCACHE\" ON)\n\n# FORCE_DISABLE_AVX - default is OFF\nif(QBDI_ARCH_X86_64 OR QBDI_ARCH_X86)\n option(QBDI_DISABLE_AVX\n \"Force disable AVX support in case dynamic support detection is buggy\"\n OFF)\nelse()\n # AVX only available on X86 and X86-64\n set(QBDI_DISABLE_AVX OFF)\nendif()\n\n# ASAN option\noption(QBDI_ASAN\n \"Enable AddressSanitizer (ASAN) for debugging (May be slow down)\" OFF)\n\n# Enable the logging level debug\noption(QBDI_LOG_DEBUG \"Enable Debug log level\" OFF)\n\n# Compile static Library\noption(QBDI_STATIC_LIBRARY \"Build the static library\" ON)\n\n# Compile shared Library\noption(QBDI_SHARED_LIBRARY \"Build the shared library\" ON)\n\nif(NOT QBDI_PLATFORM_ANDROID)\n # test\n option(QBDI_TEST \"Compile tests\" ON)\n\n # benchmark\n option(QBDI_BENCHMARK \"Compile benchmark\" OFF)\nelse()\n set(QBDI_TEST OFF)\n set(QBDI_BENCHMARK OFF)\nendif()\n\n# example\noption(QBDI_EXAMPLES \"Compile examples\" OFF)\n\n# docs\noption(QBDI_INCLUDE_DOCS \"Include cmake docs\" ON)\n\n# package\noption(QBDI_INCLUDE_PACKAGE \"Include cmake package (for cpack)\" ON)\n\n# package\noption(QBDI_INSTALL \"Prepare install target\" ON)\n\n# tools\nif(NOT (QBDI_PLATFORM_IOS OR QBDI_PLATFORM_ANDROID))\n\n option(QBDI_TOOLS_QBDIPRELOAD \"Compile QBDIPRELOAD\" ON)\n\n if(QBDI_PLATFORM_WINDOWS)\n set(QBDI_TOOLS_VALIDATOR OFF)\n else()\n # Validator (compare execution between QBDIPreload and ptrace)\n option(QBDI_TOOLS_VALIDATOR\n \"Compile the validator (need QBDI_TOOLS_QBDIPRELOAD)\" OFF)\n endif()\nelse()\n set(QBDI_TOOLS_QBDIPRELOAD OFF)\n set(QBDI_TOOLS_VALIDATOR OFF)\nendif()\n\n# PYQBDI (need a python 32bit for 32bit architecture)\nif(QBDI_BITS_64\n AND (QBDI_PLATFORM_WINDOWS\n OR QBDI_PLATFORM_LINUX\n OR QBDI_PLATFORM_MACOS))\n option(QBDI_TOOLS_PYQBDI \"Compile python binding\" ON)\nelse()\n option(QBDI_TOOLS_PYQBDI \"Compile python binding\" OFF)\nendif()\n\n# binding QBDI for frida\noption(QBDI_TOOLS_FRIDAQBDI \"Install frida-qbdi\" ON)\n\n# verify options\nif(NOT QBDI_STATIC_LIBRARY)\n if(QBDI_TEST)\n message(FATAL_ERROR \"Need QBDI_STATIC_LIBRARY to compile QBDI_TEST\")\n endif()\n if(QBDI_BENCHMARK)\n message(FATAL_ERROR \"Need QBDI_STATIC_LIBRARY to compile QBDI_BENCHMARK\")\n endif()\n if(QBDI_TOOLS_PYQBDI)\n message(FATAL_ERROR \"Need QBDI_STATIC_LIBRARY to compile QBDI_TOOLS_PYQBDI\")\n endif()\n if(QBDI_TOOLS_QBDIPRELOAD)\n message(\n FATAL_ERROR \"Need QBDI_STATIC_LIBRARY to compile QBDI_TOOLS_QBDIPRELOAD\")\n endif()\n if(QBDI_TOOLS_VALIDATOR)\n message(\n FATAL_ERROR \"Need QBDI_STATIC_LIBRARY to compile QBDI_TOOLS_VALIDATOR\")\n endif()\nendif()\n\nif(NOT QBDI_SHARED_LIBRARY)\n if(QBDI_EXAMPLES)\n message(FATAL_ERROR \"Need QBDI_SHARED_LIBRARY to compile QBDI_EXAMPLES\")\n endif()\nendif()\n\nif(QBDI_TOOLS_VALIDATOR AND NOT QBDI_TOOLS_QBDIPRELOAD)\n message(\n FATAL_ERROR \"Need QBDI_TOOLS_QBDIPRELOAD to compile QBDI_TOOLS_VALIDATOR\")\nendif()\n\n# display resulted options\nmessage(STATUS \"== QBDI Options ==\")\nmessage(STATUS \"QBDI_CCACHE: ${QBDI_CCACHE}\")\n\nif(QBDI_ARCH_X86_64 OR QBDI_ARCH_X86)\n message(STATUS \"QBDI_DISABLE_AVX: ${QBDI_DISABLE_AVX}\")\nendif()\n\nmessage(STATUS \"QBDI_ASAN: ${QBDI_ASAN}\")\nif(CMAKE_BUILD_TYPE STREQUAL \"Debug\")\n set(QBDI_LOG_DEBUG ON)\n message(\n STATUS\n \"QBDI_LOG_DEBUG: ${QBDI_LOG_DEBUG} (by CMAKE_BUILD_TYPE=Debug)\")\nelse()\n message(STATUS \"QBDI_LOG_DEBUG: ${QBDI_LOG_DEBUG}\")\nendif()\nmessage(STATUS \"QBDI_STATIC_LIBRARY: ${QBDI_STATIC_LIBRARY}\")\nmessage(STATUS \"QBDI_SHARED_LIBRARY: ${QBDI_SHARED_LIBRARY}\")\nmessage(STATUS \"QBDI_TEST: ${QBDI_TEST}\")\nmessage(STATUS \"QBDI_BENCHMARK: ${QBDI_BENCHMARK}\")\nmessage(STATUS \"QBDI_EXAMPLES: ${QBDI_EXAMPLES}\")\nmessage(STATUS \"QBDI_TOOLS_QBDIPRELOAD: ${QBDI_TOOLS_QBDIPRELOAD}\")\nmessage(STATUS \"QBDI_TOOLS_VALIDATOR: ${QBDI_TOOLS_VALIDATOR}\")\nmessage(STATUS \"QBDI_TOOLS_PYQBDI: ${QBDI_TOOLS_PYQBDI}\")\nmessage(STATUS \"QBDI_TOOLS_FRIDAQBDI: ${QBDI_TOOLS_FRIDAQBDI}\")\n\nmessage(STATUS \"\")\n\nif(QBDI_LOG_DEBUG)\n set(QBDI_ENABLE_LOG_DEBUG 1)\nelse()\n set(QBDI_ENABLE_LOG_DEBUG 0)\nendif()\n" }, { "path": "cmake/config/config-android-X86.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\nif [ -z \"${NDK_PATH}\" ]; then\n if [ -z \"${ANDROID_SDK_ROOT}\" ]; then\n echo \"ANDROID_SDK_ROOT or NDK_PATH variable should be set to configure cmake.\"\n exit 1\n fi\n if [ ! -d \"${ANDROID_SDK_ROOT}\" ]; then\n echo \"'${ANDROID_SDK_ROOT}' is not valid!\"\n exit 1\n fi\n export NDK_PATH=\"${ANDROID_SDK_ROOT}/ndk-bundle/\"\nfi\n\nif [ ! -d \"${NDK_PATH}\" ]; then\n echo \"'${NDK_PATH}' is not valid!\"\n exit 1\nfi\n\ncmake \"${GITDIR}\" \\\n -DQBDI_PLATFORM=android \\\n -DQBDI_ARCH=X86 \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_TOOLCHAIN_FILE=\"${NDK_PATH}/build/cmake/android.toolchain.cmake\" \\\n -DANDROID_ABI=x86 \\\n -DANDROID_PLATFORM=23 \\\n -G Ninja\n\n\n" }, { "path": "cmake/config/config-android-X86_64.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\nif [ -z \"${NDK_PATH}\" ]; then\n if [ -z \"${ANDROID_SDK_ROOT}\" ]; then\n echo \"ANDROID_SDK_ROOT or NDK_PATH variable should be set to configure cmake.\"\n exit 1\n fi\n if [ ! -d \"${ANDROID_SDK_ROOT}\" ]; then\n echo \"'${ANDROID_SDK_ROOT}' is not valid!\"\n exit 1\n fi\n export NDK_PATH=\"${ANDROID_SDK_ROOT}/ndk-bundle/\"\nfi\n\nif [ ! -d \"${NDK_PATH}\" ]; then\n echo \"'${NDK_PATH}' is not valid!\"\n exit 1\nfi\n\ncmake \"${GITDIR}\" \\\n -DQBDI_PLATFORM=android \\\n -DQBDI_ARCH=X86_64 \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_TOOLCHAIN_FILE=\"${NDK_PATH}/build/cmake/android.toolchain.cmake\" \\\n -DANDROID_ABI=x86_64 \\\n -DANDROID_PLATFORM=23 \\\n -G Ninja\n\n\n" }, { "path": "cmake/config/config-android-aarch64.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\nif [ -z \"${NDK_PATH}\" ]; then\n if [ -z \"${ANDROID_SDK_ROOT}\" ]; then\n echo \"ANDROID_SDK_ROOT or NDK_PATH variable should be set to configure cmake.\"\n exit 1\n fi\n if [ ! -d \"${ANDROID_SDK_ROOT}\" ]; then\n echo \"'${ANDROID_SDK_ROOT}' is not valid!\"\n exit 1\n fi\n export NDK_PATH=\"${ANDROID_SDK_ROOT}/ndk-bundle/\"\nfi\n\nif [ ! -d \"${NDK_PATH}\" ]; then\n echo \"'${NDK_PATH}' is not valid!\"\n exit 1\nfi\n\ncmake \"${GITDIR}\" \\\n -DQBDI_PLATFORM=android \\\n -DQBDI_ARCH=AARCH64 \\\n -DCMAKE_BUILD_TYPE=RelWithDebInfo \\\n -DCMAKE_TOOLCHAIN_FILE=\"${NDK_PATH}/build/cmake/android.toolchain.cmake\" \\\n -DANDROID_ABI=\"arm64-v8a\" \\\n -DANDROID_PLATFORM=24 \\\n -G Ninja\n\n" }, { "path": "cmake/config/config-android-armv7.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\nif [ -z \"${NDK_PATH}\" ]; then\n if [ -z \"${ANDROID_SDK_ROOT}\" ]; then\n echo \"ANDROID_SDK_ROOT or NDK_PATH variable should be set to configure cmake.\"\n exit 1\n fi\n if [ ! -d \"${ANDROID_SDK_ROOT}\" ]; then\n echo \"'${ANDROID_SDK_ROOT}' is not valid!\"\n exit 1\n fi\n export NDK_PATH=\"${ANDROID_SDK_ROOT}/ndk-bundle/\"\nfi\n\nif [ ! -d \"${NDK_PATH}\" ]; then\n echo \"'${NDK_PATH}' is not valid!\"\n exit 1\nfi\n\ncmake \"${GITDIR}\" \\\n -DQBDI_PLATFORM=android \\\n -DQBDI_ARCH=ARM \\\n -DCMAKE_BUILD_TYPE=RelWithDebInfo \\\n -DCMAKE_TOOLCHAIN_FILE=\"${NDK_PATH}/build/cmake/android.toolchain.cmake\" \\\n -DANDROID_ABI=\"armeabi-v7a\" \\\n -DANDROID_PLATFORM=24 \\\n -G Ninja\n" }, { "path": "cmake/config/config-ios-aarch64.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\ncmake \"${GITDIR}\" \\\n -DQBDI_PLATFORM=ios \\\n -DQBDI_ARCH=AARCH64 \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_TOOLCHAIN_FILE=\"${GITDIR}/cmake/config/ios.toolchain.cmake\" \\\n -DCMAKE_OSX_DEPLOYMENT_TARGET=\"15.0\" \\\n -G Ninja\n\n" }, { "path": "cmake/config/config-linux-X86.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\ncmake \"${GITDIR}\" \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=linux \\\n -DQBDI_ARCH=X86 \\\n -G Ninja\n" }, { "path": "cmake/config/config-linux-X86_64.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\ncmake \"${GITDIR}\" \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=linux \\\n -DQBDI_ARCH=X86_64 \\\n -G Ninja\n" }, { "path": "cmake/config/config-linux-aarch64.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\ncmake \"${GITDIR}\" \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=linux \\\n -DQBDI_ARCH=X86_64 \\\n -G Ninja\n" }, { "path": "cmake/config/config-macOS-AARCH64.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\ncmake \"${GITDIR}\" \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=macos \\\n -DQBDI_ARCH=AARCH64 \\\n -G Ninja\n" }, { "path": "cmake/config/config-macOS-AARCH64e.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\ncmake \"${GITDIR}\" \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=macos \\\n -DQBDI_ARCH=AARCH64 \\\n -DCMAKE_OSX_ARCHITECTURES=\"arm64e\" \\\n -DQBDI_PTRAUTH=ON \\\n -G Ninja\n" }, { "path": "cmake/config/config-macOS-X86.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\ncmake \"${GITDIR}\" \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=macos \\\n -DQBDI_ARCH=X86 \\\n -G Ninja\n" }, { "path": "cmake/config/config-macOS-X86_64.sh", "content": "#!/bin/sh\nset -e\n\nBASEDIR=\"$(cd \"$(dirname \"$0\")\" && pwd -P)\"\nGITDIR=\"$(realpath \"${BASEDIR}/../..\")\"\n\ncmake \"${GITDIR}\" \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=macos \\\n -DQBDI_ARCH=X86_64 \\\n -G Ninja\n" }, { "path": "cmake/config/config-win-X86.py", "content": "import subprocess\nimport os\n\n# be sure to run \"C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Community\\VC\\Auxiliary\\Build\\vcvarsall.bat\" x86 before\n\nsubprocess.check_call([\"cmake\", os.path.realpath(os.path.join(os.path.dirname(__file__), \"..\" , \"..\")),\n \"-G\", \"Ninja\",\n \"-DCMAKE_CXX_FLAGS=/D_SILENCE_TR1_NAMESPACE_DEPRECATION_WARNING\",\n \"-DCMAKE_BUILD_TYPE=Release\",\n \"-DCMAKE_CROSSCOMPILING=FALSE\",\n \"-DQBDI_PLATFORM=windows\",\n \"-DQBDI_ARCH=X86\"])\n" }, { "path": "cmake/config/config-win-X86_64.py", "content": "import subprocess\nimport os\n\n# be sure to run \"C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Community\\VC\\Auxiliary\\Build\\vcvarsall.bat\" x64 before\n\nsubprocess.check_call([\"cmake\", os.path.realpath(os.path.join(os.path.dirname(__file__), \"..\" , \"..\")),\n \"-G\", \"Ninja\",\n \"-DCMAKE_BUILD_TYPE=Release\",\n \"-DCMAKE_CROSSCOMPILING=FALSE\",\n \"-DQBDI_PLATFORM=windows\",\n \"-DQBDI_ARCH=X86_64\"])\n" }, { "path": "cmake/config/ios.toolchain.cmake", "content": "# from https://github.com/llvm/llvm-project/blob/release/19.x/llvm/cmake/platforms/iOS.cmake\n\n# LICENSE : Apache License v2.0 with LLVM Exceptions\n# see https://github.com/llvm/llvm-project/blob/release/19.x/LICENSE.TXT\n\n# Toolchain config for iOS.\n\nSET(CMAKE_SYSTEM_NAME Darwin)\nSET(CMAKE_SYSTEM_VERSION 13)\nSET(CMAKE_CXX_COMPILER_WORKS True)\nSET(CMAKE_C_COMPILER_WORKS True)\nSET(IOS True)\n\nif(NOT CMAKE_OSX_SYSROOT)\n execute_process(COMMAND xcodebuild -version -sdk iphoneos Path\n OUTPUT_VARIABLE SDKROOT\n ERROR_QUIET\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n\n IF(NOT EXISTS ${SDKROOT})\n MESSAGE(FATAL_ERROR \"SDKROOT could not be detected!\")\n ENDIF()\n\n message(STATUS \"Using SDKROOT ${SDKROOT}\")\n set(CMAKE_OSX_SYSROOT ${SDKROOT})\nendif()\n\nIF(NOT CMAKE_C_COMPILER)\n execute_process(COMMAND xcrun -sdk ${CMAKE_OSX_SYSROOT} -find clang\n OUTPUT_VARIABLE CMAKE_C_COMPILER\n ERROR_QUIET\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n message(STATUS \"Using C compiler ${CMAKE_C_COMPILER}\")\nENDIF()\n\nIF(NOT CMAKE_CXX_COMPILER)\n execute_process(COMMAND xcrun -sdk ${CMAKE_OSX_SYSROOT} -find clang++\n OUTPUT_VARIABLE CMAKE_CXX_COMPILER\n ERROR_QUIET\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n message(STATUS \"Using C++ compiler ${CMAKE_CXX_COMPILER}\")\nENDIF()\n\nIF(NOT CMAKE_AR)\n execute_process(COMMAND xcrun -sdk ${CMAKE_OSX_SYSROOT} -find ar\n OUTPUT_VARIABLE CMAKE_AR_val\n ERROR_QUIET\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n SET(CMAKE_AR ${CMAKE_AR_val} CACHE FILEPATH \"Archiver\")\n message(STATUS \"Using ar ${CMAKE_AR}\")\nENDIF()\n\nIF(NOT CMAKE_RANLIB)\n execute_process(COMMAND xcrun -sdk ${CMAKE_OSX_SYSROOT} -find ranlib\n OUTPUT_VARIABLE CMAKE_RANLIB_val\n ERROR_QUIET\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n SET(CMAKE_RANLIB ${CMAKE_RANLIB_val} CACHE FILEPATH \"Ranlib\")\n message(STATUS \"Using ranlib ${CMAKE_RANLIB}\")\nENDIF()\n\nIF(NOT CMAKE_STRIP)\n execute_process(COMMAND xcrun -sdk ${CMAKE_OSX_SYSROOT} -find strip\n OUTPUT_VARIABLE CMAKE_STRIP_val\n ERROR_QUIET\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n SET(CMAKE_STRIP ${CMAKE_STRIP_val} CACHE FILEPATH \"Strip\")\n message(STATUS \"Using strip ${CMAKE_STRIP}\")\nENDIF()\n\nIF(NOT CMAKE_DSYMUTIL)\n execute_process(COMMAND xcrun -sdk ${CMAKE_OSX_SYSROOT} -find dsymutil\n OUTPUT_VARIABLE CMAKE_DSYMUTIL_val\n ERROR_QUIET\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n SET(CMAKE_DSYMUTIL ${CMAKE_DSYMUTIL_val} CACHE FILEPATH \"Dsymutil\")\n message(STATUS \"Using dsymutil ${CMAKE_DSYMUTIL}\")\nENDIF()\n\nIF(NOT CMAKE_LIBTOOL)\n execute_process(COMMAND xcrun -sdk ${CMAKE_OSX_SYSROOT} -find libtool\n OUTPUT_VARIABLE CMAKE_LIBTOOL_val\n ERROR_QUIET\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n SET(CMAKE_LIBTOOL ${CMAKE_LIBTOOL_val} CACHE FILEPATH \"Libtool\")\n message(STATUS \"Using libtool ${CMAKE_LIBTOOL}\")\nENDIF()\n\nIF(NOT CMAKE_CODESIGN)\n execute_process(COMMAND xcrun -sdk ${CMAKE_OSX_SYSROOT} -find codesign\n OUTPUT_VARIABLE CMAKE_CODESIGN_val\n ERROR_QUIET\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n SET(CMAKE_CODESIGN ${CMAKE_CODESIGN_val} CACHE FILEPATH \"Codesign\")\n message(STATUS \"Using codesign ${CMAKE_CODESIGN}\")\nENDIF()\n\nIF(NOT CMAKE_CODESIGN_ALLOCATE)\n execute_process(\n COMMAND xcrun -sdk ${CMAKE_OSX_SYSROOT} -find codesign_allocate\n OUTPUT_VARIABLE CMAKE_CODESIGN_ALLOCATE_val\n ERROR_QUIET\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n SET(CMAKE_CODESIGN_ALLOCATE ${CMAKE_CODESIGN_ALLOCATE_val} CACHE\n FILEPATH \"Codesign_Allocate\")\n message(STATUS \"Using codesign_allocate ${CMAKE_CODESIGN_ALLOCATE}\")\nENDIF()\n" }, { "path": "cmake/dummy.c", "content": "int dummy() { return 42; }\n" }, { "path": "cmake/llvm/QBDI_llvm.cmake", "content": "if(__add_qbdi_llvm)\n return()\nendif()\nset(__add_qbdi_llvm ON)\n\ninclude(FetchContent)\n\n# configure FetchContent\nset(QBDI_LLVM_MAJOR_VERSION 19)\nset(QBDI_LLVM_VERSION 19.1.5)\n\n# download and include llvm cmake module\noption(QBDI_INCLUDE_LLVM_CMAKE_MODUKE \"Include llvm cmake module\" ON)\nif(QBDI_INCLUDE_LLVM_CMAKE_MODUKE)\n FetchContent_Populate(\n llvm_cmake\n URL \"https://github.com/llvm/llvm-project/releases/download/llvmorg-${QBDI_LLVM_VERSION}/cmake-${QBDI_LLVM_VERSION}.src.tar.xz\"\n URL_HASH\n \"SHA256=a08ae477571fd5e929c27d3d0d28c6168d58dd00b6354c2de3266ae0d86ad44f\"\n DOWNLOAD_DIR \"${QBDI_THIRD_PARTY_DIRECTORY}/llvm-cmake-download\"\n SOURCE_DIR \"${FETCHCONTENT_BASE_DIR}/qbdi_llvm/cmake\"\n BINARY_DIR \"${FETCHCONTENT_BASE_DIR}/llvm_cmake-build\"\n SUBBUILD_DIR \"${FETCHCONTENT_BASE_DIR}/llvm_cmake-subbuild\"\n QUIET)\nendif()\n\n# Variable also use in QBDI_llvm_tblgen\nset(QBDI_LLVM_URL\n \"https://github.com/llvm/llvm-project/releases/download/llvmorg-${QBDI_LLVM_VERSION}/llvm-${QBDI_LLVM_VERSION}.src.tar.xz\"\n)\nset(QBDI_LLVM_URL_HASH\n \"SHA256=7d71635948e4da1814ce8e15ec45399e4094a5442e86d352c96ded0f2b3171b6\")\n\nFetchContent_Populate(\n llvm\n URL \"${QBDI_LLVM_URL}\"\n URL_HASH \"${QBDI_LLVM_URL_HASH}\"\n DOWNLOAD_DIR \"${QBDI_THIRD_PARTY_DIRECTORY}/llvm-download\"\n SOURCE_DIR \"${FETCHCONTENT_BASE_DIR}/qbdi_llvm/llvm\"\n BINARY_DIR \"${FETCHCONTENT_BASE_DIR}/llvm-build\"\n SUBBUILD_DIR \"${FETCHCONTENT_BASE_DIR}/llvm-subbuild\"\n QUIET)\n\nset(CMAKE_CXX_STANDARD\n 17\n CACHE STRING \"USE CPP 17\")\nset(LLVM_BUILD_TOOLS\n OFF\n CACHE BOOL \"Disable LLVM_BUILD_TOOLS\")\nset(LLVM_BUILD_UTILS\n OFF\n CACHE BOOL \"Disable LLVM_BUILD_UTILS\")\nset(LLVM_BUILD_TESTS\n OFF\n CACHE BOOL \"Disable LLVM_BUILD_TESTS\")\nset(LLVM_BUILD_BENCHMARKS\n OFF\n CACHE BOOL \"Disable LLVM_BUILD_BENCHMARKS\")\nset(LLVM_BUILD_EXAMPLES\n OFF\n CACHE BOOL \"Disable LLVM_BUILD_EXAMPLES\")\nset(LLVM_INCLUDE_TOOLS\n OFF\n CACHE BOOL \"Disable LLVM_INCLUDE_TOOLS\")\nset(LLVM_INCLUDE_UTILS\n OFF\n CACHE BOOL \"Disable LLVM_INCLUDE_UTILS\")\nset(LLVM_INCLUDE_TESTS\n OFF\n CACHE BOOL \"Disable LLVM_INCLUDE_TESTS\")\nset(LLVM_INCLUDE_BENCHMARKS\n OFF\n CACHE BOOL \"Disable LLVM_INCLUDE_BENCHMARKS\")\nset(LLVM_INCLUDE_EXAMPLES\n OFF\n CACHE BOOL \"Disable LLVM_INCLUDE_EXAMPLES\")\nset(LLVM_ENABLE_TERMINFO\n OFF\n CACHE BOOL \"Disable LLVM_ENABLE_TERMINFO\")\nset(LLVM_ENABLE_BINDINGS\n OFF\n CACHE BOOL \"Disable LLVM_ENABLE_BINDINGS\")\nset(LLVM_ENABLE_RTTI\n OFF\n CACHE BOOL \"Disable LLVM_ENABLE_RTTI\")\nset(LLVM_APPEND_VC_REV\n OFF\n CACHE BOOL \"Disable LLVM_APPEND_VC_REV\")\nset(LLVM_ENABLE_Z3_SOLVER\n OFF\n CACHE BOOL \"Disable LLVM_ENABLE_Z3_SOLVER\")\nset(LLVM_ENABLE_ZLIB\n OFF\n CACHE BOOL \"Disable LLVM_ENABLE_ZLIB\")\nset(LLVM_ENABLE_ZSTD\n OFF\n CACHE BOOL \"Disable LLVM_ENABLE_ZSTD\")\nset(LLVM_TARGET_ARCH\n ${QBDI_LLVM_ARCH}\n CACHE STRING \"set LLVM_ARCH\")\nset(LLVM_TARGETS_TO_BUILD\n ${QBDI_LLVM_ARCH}\n CACHE STRING \"set LLVM_TARGETS_TO_BUILD\")\n\nset(QBDI_LLVM_TRIPLE \"\")\nif(QBDI_ARCH_ARM)\n if(QBDI_PLATFORM_ANDROID)\n set(QBDI_LLVM_TRIPLE armv7-linux-androideabi)\n else()\n set(QBDI_LLVM_TRIPLE armv7-linux-gnu)\n endif()\nelseif(QBDI_ARCH_AARCH64)\n if(QBDI_PLATFORM_ANDROID)\n set(QBDI_LLVM_TRIPLE aarch64-linux-android)\n elseif(QBDI_PLATFORM_IOS)\n set(LLVM_ENABLE_LIBCXX\n ON\n CACHE INTERNAL \"set LLVM_ENABLE_LIBCXX\")\n set(QBDI_LLVM_TRIPLE arm64-apple-darwin)\n else()\n set(QBDI_LLVM_TRIPLE aarch64-linux-gnu)\n endif()\nelseif(QBDI_ARCH_X86)\n set(LLVM_BUILD_32_BITS\n ON\n CACHE INTERNAL \"set LLVM_BUILD_32_BITS\")\n if(QBDI_PLATFORM_MACOS)\n set(LLVM_ENABLE_LIBCXX\n ON\n CACHE INTERNAL \"set LLVM_ENABLE_LIBCXX\")\n set(QBDI_LLVM_TRIPLE i386-apple-darwin17.7.0)\n elseif(QBDI_PLATFORM_LINUX OR QBDI_PLATFORM_ANDROID)\n set(QBDI_LLVM_TRIPLE i386-pc-linux)\n endif()\nelseif(QBDI_ARCH_X86_64)\n if(QBDI_PLATFORM_LINUX)\n set(QBDI_LLVM_TRIPLE x86_64-pc-linux-gnu)\n endif()\nelse()\n message(FATAL_ERROR \"Unsupported LLVM Architecture.\")\nendif()\n\nif(QBDI_PLATFORM_WINDOWS)\n add_compile_definitions(_DISABLE_CONSTEXPR_MUTEX_CONSTRUCTOR)\nendif()\n\nif(NOT (\"${QBDI_LLVM_TRIPLE}\" STREQUAL \"\"))\n set(LLVM_HOST_TRIPLE\n \"${QBDI_LLVM_TRIPLE}\"\n CACHE STRING \"set LLVM_HOST_TRIPLE\")\nendif()\n\n# build llvm with visibility hidden\nif(DEFINED CMAKE_C_VISIBILITY_PRESET)\n set(QBDI_CACHE_CMAKE_C_VISIBILITY_PRESET ${CMAKE_C_VISIBILITY_PRESET})\nendif()\nif(DEFINED CMAKE_CXX_VISIBILITY_PRESET)\n set(QBDI_CACHE_CMAKE_CXX_VISIBILITY_PRESET ${CMAKE_CXX_VISIBILITY_PRESET})\nendif()\nset(CMAKE_C_VISIBILITY_PRESET\n \"hidden\"\n CACHE STRING \"set CMAKE_C_VISIBILITY_PRESET\" FORCE)\nset(CMAKE_CXX_VISIBILITY_PRESET\n \"hidden\"\n CACHE STRING \"set CMAKE_CXX_VISIBILITY_PRESET\" FORCE)\n\nif(NOT (\"${NATIVE_TABLEGEN_PATH}\" STREQUAL \"\"))\n set(LLVM_TABLEGEN\n \"${NATIVE_TABLEGEN_PATH}\"\n CACHE INTERNAL \"force tablegen\")\nelseif(NOT (\"${QBDI_LLVM_TABLEN_TOOLSCHAIN}\" STREQUAL \"\"))\n # create a second directory to build the native llvm-tblgen\n # mostly use when crosscompile and need another compiler to create a native\n # target\n include(QBDI_llvm_tblgen)\n set(LLVM_TABLEGEN\n \"${QBDI_LLVM_NATIVE_TBLGEN}\"\n CACHE INTERNAL \"force tablegen\")\nelse()\n # check if llvm-tblgen-X is available\n find_program(LLVM_TABLEN_BIN NAMES llvm-tblgen-${QBDI_LLVM_MAJOR_VERSION})\n message(STATUS \"LLVM Table Gen found: ${LLVM_TABLEN_BIN}\")\n if(${LLVM_TABLEN_BIN_FOUND})\n set(LLVM_TABLEGEN\n \"${LLVM_TABLEN_BIN}\"\n CACHE STRING \"force tablegen\")\n endif()\nendif()\n\nif(QBDI_PLATFORM_IOS AND \"${LLVM_TABLEGEN}\" STREQUAL \"\")\n # llvm fail to compile in this platform. Force to compile tablegen\n # with native toolchains\n set(QBDI_LLVM_TABLEN_TOOLSCHAIN\n \"${CMAKE_CURRENT_BINARY_DIR}/QBDI_empty_toolchains.cmake\")\n file(TOUCH \"${QBDI_LLVM_TABLEN_TOOLSCHAIN}\")\n include(QBDI_llvm_tblgen)\n set(LLVM_TABLEGEN\n \"${QBDI_LLVM_NATIVE_TBLGEN}\"\n CACHE INTERNAL \"force tablegen\")\nendif()\n\nif(QBDI_CCACHE AND CCACHE_FOUND)\n set(LLVM_CCACHE_BUILD\n ON\n CACHE BOOL \"Enable CCACHE in llvm\")\nelse()\n set(LLVM_CCACHE_BUILD\n OFF\n CACHE BOOL \"Enable CCACHE in llvm\")\nendif()\n\nif(QBDI_ASAN AND HAVE_FLAG_SANITIZE_ADDRESS)\n set(LLVM_USE_SANITIZER\n Address\n CACHE STRING \"Enable ASAN\")\nendif()\n\nadd_subdirectory(${llvm_SOURCE_DIR} ${llvm_BINARY_DIR} EXCLUDE_FROM_ALL)\n\n# restore visibility\nif(DEFINED QBDI_CACHE_CMAKE_C_VISIBILITY_PRESET)\n set(CMAKE_C_VISIBILITY_PRESET\n ${QBDI_CACHE_CMAKE_C_VISIBILITY_PRESET}\n CACHE INTERNAL \"set CMAKE_C_VISIBILITY_PRESET\" FORCE)\nelse()\n unset(CMAKE_C_VISIBILITY_PRESET CACHE)\nendif()\nif(DEFINED QBDI_CACHE_CMAKE_CXX_VISIBILITY_PRESET)\n set(CMAKE_CXX_VISIBILITY_PRESET\n ${QBDI_CACHE_CMAKE_CXX_VISIBILITY_PRESET}\n CACHE INTERNAL \"set CMAKE_CXX_VISIBILITY_PRESET\" FORCE)\nelse()\n unset(CMAKE_CXX_VISIBILITY_PRESET CACHE)\nendif()\n\n# list of LLVM library to build\nset(QBDI_LLVM_TARGET_LIBRARY)\nset(QBDI_LLVM_LINK_LIBRARY)\nmacro(add_llvm_lib)\n foreach(LIB ${ARGV})\n if(\"${LIB}\" MATCHES \"^::@\")\n continue()\n endif()\n string(FIND \"${LIB}\" \"::@\" pos)\n if(\"${pos}\" EQUAL -1)\n set(TARGETLIB \"${LIB}\")\n else()\n string(SUBSTRING \"${LIB}\" 0 \"${pos}\" TARGETLIB)\n endif()\n if((TARGET ${TARGETLIB}) AND NOT (${TARGETLIB} IN_LIST\n QBDI_LLVM_TARGET_LIBRARY))\n list(APPEND QBDI_LLVM_TARGET_LIBRARY ${TARGETLIB})\n get_target_property(_LIB_LINK ${TARGETLIB} INTERFACE_LINK_LIBRARIES)\n if(_LIB_LINK)\n add_llvm_lib(${_LIB_LINK})\n endif()\n elseif(NOT (TARGET ${TARGETLIB}) AND NOT (${TARGETLIB} IN_LIST\n QBDI_LLVM_LINK_LIBRARY))\n list(APPEND QBDI_LLVM_LINK_LIBRARY ${TARGETLIB})\n endif()\n endforeach()\nendmacro()\n\nadd_llvm_lib(\n LLVMBinaryFormat\n LLVMMCDisassembler\n LLVMMCParser\n LLVMMC\n LLVMSupport\n LLVMObject\n LLVMTextAPI\n LLVMCore\n LLVMBitReader\n LLVMBitstreamReader\n LLVMRemarks)\n\nif(QBDI_PLATFORM_MACOS OR QBDI_PLATFORM_IOS)\n add_llvm_lib(LLVMDemangle)\nendif()\n\nif(QBDI_ARCH_ARM)\n add_llvm_lib(LLVMARMAsmParser LLVMARMDisassembler LLVMARMDesc LLVMARMInfo\n LLVMARMUtils)\nelseif(QBDI_ARCH_AARCH64)\n add_llvm_lib(LLVMAArch64AsmParser LLVMAArch64Desc LLVMAArch64Disassembler\n LLVMAArch64Info LLVMAArch64Utils)\nelseif(QBDI_ARCH_X86_64 OR QBDI_ARCH_X86)\n add_llvm_lib(LLVMX86AsmParser LLVMX86Disassembler LLVMX86Desc LLVMX86Info)\nelse()\n message(FATAL_ERROR \"Unsupported LLVM Architecture.\")\nendif()\n\nif(QBDI_PLATFORM_MACOS)\n find_package(Python3 REQUIRED COMPONENTS Interpreter)\n\n set(LLVMSupportFixName \"${llvm_BINARY_DIR}/libLLVMSupportFix.a\")\n add_custom_command(\n OUTPUT \"${LLVMSupportFixName}\"\n COMMAND\n \"${Python3_EXECUTABLE}\"\n \"${CMAKE_CURRENT_SOURCE_DIR}/cmake/llvm/rename_object.py\" -i\n $ -o \"${LLVMSupportFixName}\" -r Memory.cpp.o 1 -r\n Error.cpp.o 1\n COMMENT \"Fix LLVMSupport library\"\n DEPENDS LLVMSupport\n VERBATIM)\n list(REMOVE_ITEM QBDI_LLVM_TARGET_LIBRARY LLVMSupport)\n list(APPEND QBDI_LLVM_TARGET_LIBRARY \"${LLVMSupportFixName}\")\n\n set(LLVMObjectFixName \"${llvm_BINARY_DIR}/libLLVMObjectFix.a\")\n add_custom_command(\n OUTPUT \"${LLVMObjectFixName}\"\n COMMAND\n \"${Python3_EXECUTABLE}\"\n \"${CMAKE_CURRENT_SOURCE_DIR}/cmake/llvm/rename_object.py\" -i\n $ -o \"${LLVMObjectFixName}\" -r Minidump.cpp.o 1\n COMMENT \"Fix LLVMObject library\"\n DEPENDS LLVMObject\n VERBATIM)\n list(REMOVE_ITEM QBDI_LLVM_TARGET_LIBRARY LLVMObject)\n list(APPEND QBDI_LLVM_TARGET_LIBRARY \"${LLVMObjectFixName}\")\n\n list(APPEND QBDI_LLVM_LINK_LIBRARY -lc++)\nelseif(QBDI_PLATFORM_LINUX)\n list(APPEND QBDI_LLVM_LINK_LIBRARY -lstdc++)\nendif()\n\nmerge_static_libs(qbdi-llvm qbdi-llvm \\${QBDI_LLVM_TARGET_LIBRARY})\ntarget_link_libraries(qbdi-llvm INTERFACE ${QBDI_LLVM_LINK_LIBRARY})\n\ntarget_include_directories(\n qbdi-llvm\n INTERFACE ${llvm_SOURCE_DIR}/include\n INTERFACE ${llvm_BINARY_DIR}/include\n INTERFACE ${llvm_SOURCE_DIR}/lib/Target/${QBDI_LLVM_ARCH}\n INTERFACE ${llvm_BINARY_DIR}/lib/Target/${QBDI_LLVM_ARCH}\n INTERFACE ${llvm_SOURCE_DIR}/lib\n INTERFACE ${llvm_BINARY_DIR}/lib)\n\nadd_custom_target(llvm DEPENDS qbdi-llvm)\n" }, { "path": "cmake/llvm/QBDI_llvm_tblgen.cmake", "content": "if(__add_qbdi_llvm_tblgen)\n return()\nendif()\nset(__add_qbdi_llvm_tblgen ON)\ninclude(ExternalProject)\n\nset(NATIVE_BUILD_DIR \"${CMAKE_CURRENT_BINARY_DIR}/QBDI_llvm_tblgen_native\")\n\nif(CMAKE_CONFIGURATION_TYPES)\n set(QBDI_LLVM_NATIVE_TBLGEN \"${NATIVE_BUILD_DIR}/Release/bin/llvm-tblgen\")\nelse()\n set(QBDI_LLVM_NATIVE_TBLGEN \"${NATIVE_BUILD_DIR}/bin/llvm-tblgen\")\nendif()\n\nExternalProject_Add(\n llvm_tblgen\n URL \"${QBDI_LLVM_URL}\"\n URL_HASH \"${QBDI_LLVM_URL_HASH}\"\n DOWNLOAD_DIR \"${QBDI_THIRD_PARTY_DIRECTORY}/llvm-download\"\n SOURCE_DIR \"${llvm_cmake_SOURCE_DIR}/../llvm_tblgen_source_dir\"\n BINARY_DIR \"${NATIVE_BUILD_DIR}\"\n CONFIGURE_COMMAND\n \"${CMAKE_COMMAND}\" -G \"${CMAKE_GENERATOR}\" -S -B \n \"-DCMAKE_MAKE_PROGRAM='${CMAKE_MAKE_PROGRAM}'\"\n \"-DCMAKE_TOOLCHAIN_FILE='${QBDI_LLVM_TABLEN_TOOLSCHAIN}'\"\n -DLLVM_TARGET_IS_CROSSCOMPILE_HOST=TRUE\n \"-DLLVM_TARGETS_TO_BUILD='${LLVM_TARGETS_TO_BUILD}'\"\n \"-DLLVM_TARGET_ARCH='${LLVM_TARGET_ARCH}'\" -DCMAKE_BUILD_TYPE=Release\n \"-DLLVM_CCACHE_BUILD='${LLVM_CCACHE_BUILD}'\" -DLLVM_INCLUDE_TESTS=OFF\n -DLLVM_INCLUDE_BENCHMARKS=OFF -DLLVM_INCLUDE_EXAMPLES=OFF\n BUILD_COMMAND \"${CMAKE_COMMAND}\" --build --target llvm-tblgen\n BUILD_BYPRODUCTS \"${QBDI_LLVM_NATIVE_TBLGEN}\"\n INSTALL_COMMAND \"\")\n" }, { "path": "cmake/llvm/rename_object.py", "content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\nimport subprocess\nimport tempfile\nimport os\nimport sys\n\nLIPO = \"lipo\"\nIOS_LIPO=\"/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/usr/bin/lipo\"\n\nif os.path.exists(IOS_LIPO):\n LIPO = IOS_LIPO\n\ndef eprint(*args, **kwargs):\n print(*args, file=sys.stderr, **kwargs)\n\ndef listArchs(archive):\n try:\n out = subprocess.check_output([LIPO, \"-info\", archive]).decode(\"utf-8\")\n except:\n out = \"\"\n\n xs = out.split(\":\")\n\n if (len(xs)) != 3:\n raise RuntimeError(\"invalid lipo -info output\")\n\n return xs[2].strip().split()\n\n\ndef extractArch(archive, arch, path):\n name = arch + \"-\" + os.path.basename(archive)\n fpath = os.path.join(path, name)\n try:\n t = subprocess.check_call([LIPO, \"-thin\", arch, archive, \"-output\", fpath])\n except:\n t = 1\n if t != 0:\n return \"\"\n return fpath\n\n\ndef extractObjs(archive, path):\n try:\n t = subprocess.check_call([\"ar\", \"-x\", archive], cwd=path)\n except:\n t = 1\n if t != 0:\n return False\n return True\n\n\ndef archiveObjs(archive, path):\n vext = lambda x: x[-2:] == \".o\" or x[-3:] == \".o2\"\n files = filter(vext, os.listdir(path))\n try:\n t = subprocess.check_call([\"libtool\", \"-static\", \"-o\", archive] + files, cwd=path)\n except:\n t = 1\n if t != 0:\n return False\n return True\n\n\ndef mergeArch(archives, outpath):\n if not archives:\n return\n try:\n t = subprocess.check_call([LIPO, \"-create\"] + archives + [\"-output\", outpath])\n except:\n t = 1\n if t != 0:\n return False\n return True\n\n\ndef rename_object(archive, ofname, suffix=\"\", remove=False):\n root, ext = os.path.splitext(ofname)\n nfname = \"{}_{}{}\".format(root, suffix, ext)\n altofname = \"{}.o2\".format(root)\n altnfname = \"{}_{}.o2\".format(root, suffix)\n\n archs = listArchs(archive)\n isFat = len(archs) > 1\n\n # Create tmp dir\n with tempfile.TemporaryDirectory() as tdir:\n marchives = []\n\n for arch in archs:\n # Extract arch from universal binary\n thinar = archive\n if isFat:\n thinar = extractArch(archive, arch, tdir)\n if not thinar:\n eprint(\"Cannot extract arch \" + arch)\n continue\n # Create tmp dir for extracted objects\n arname = os.path.basename(thinar)\n xdir = os.path.join(tdir, arname) + \".dir\"\n os.mkdir(xdir)\n # Extract objects\n if not extractObjs(thinar, xdir):\n eprint(\"Cannot extract objects for \" + arch)\n continue\n ofpath = os.path.join(xdir, ofname)\n nfpath = os.path.join(xdir, nfname)\n altofpath = os.path.join(xdir, altofname)\n altnfpath = os.path.join(xdir, altnfname)\n if remove:\n os.unlink(ofpath)\n else:\n # Rename object\n rename = False\n if os.path.exists(ofpath):\n print(\"Move {} to {}\".format(ofpath, nfpath))\n os.rename(ofpath, nfpath)\n rename = True\n if os.path.exists(altofpath):\n print(\"Move {} to {}\".format(altofpath, altnfpath))\n os.rename(altofpath, altnfpath)\n rename = True\n if not rename:\n eprint(\"Cannot find object {} for arch {}\".format(ofname, arch))\n continue\n # Archive objects\n archiveObjs(thinar, xdir)\n # Add archive to modified archive list\n marchives.append(thinar)\n\n if isFat:\n # Merge all subarch into original file\n if not mergeArch(marchives, archive):\n raise RuntimeError(\"Cannot update original file\")\n\nif __name__ == '__main__':\n import argparse\n import shutil\n parser = argparse.ArgumentParser()\n\n parser.add_argument(\"-i\", \"--input\", type=str, help=\"input archive\", required=True)\n parser.add_argument(\"-o\", \"--output\", type=str, help=\"output archive\", required=True)\n parser.add_argument(\"-r\", \"--rename-object\", type=str, help=\"Object to rename\", action='append', default=[],\n metavar=('name','suffix'), nargs=2)\n parser.add_argument(\"-R\", \"--remove-object\", type=str, help=\"Object to remove\", action='append', default=[])\n\n args = parser.parse_args()\n\n assert os.path.exists(args.input), \"Input file not found ({})\".format(args.input)\n if args.input != args.output:\n os.makedirs(os.path.split(os.path.realpath(args.input))[0], exist_ok=True)\n shutil.copy2(args.input, args.output)\n removeOnFail = True\n else:\n removeOnFail = False\n\n try:\n for oname, suffix in args.rename_object:\n rename_object(args.output, oname, suffix=suffix)\n for oname in args.remove_object:\n rename_object(args.output, oname, remove=True)\n removeOnFail = False\n finally:\n if removeOnFail:\n os.unlink(args.output)\n\n" }, { "path": "cmake/merge_archives.cmake", "content": "set(MERGE_LIBS_DUMMY_FILE ${CMAKE_CURRENT_LIST_DIR}/dummy.c)\n\nmacro(MERGE_STATIC_LIBS TARGET OUTPUT_NAME LIBS_TO_MERGE)\n\n set(SOURCE_FILE ${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_depends.c)\n\n add_custom_command(\n OUTPUT ${SOURCE_FILE}\n COMMAND ${CMAKE_COMMAND} -E copy ${MERGE_LIBS_DUMMY_FILE} ${SOURCE_FILE}\n DEPENDS ${LIBS_TO_MERGE})\n\n add_library(${TARGET} STATIC ${SOURCE_FILE})\n set_target_properties(${TARGET} PROPERTIES OUTPUT_NAME ${OUTPUT_NAME})\n\n set(LIBS_PATH \"\")\n foreach(LIB ${LIBS_TO_MERGE})\n if(TARGET ${LIB})\n add_dependencies(${TARGET} ${LIB})\n set(LIBS_PATH ${LIBS_PATH} $)\n else()\n set(LIBS_PATH ${LIBS_PATH} ${LIB})\n endif()\n endforeach()\n list(REMOVE_DUPLICATES LIBS_PATH)\n\n if(WIN32)\n\n set(LIB_COMMAND_ARGS_FILE\n \"${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_lib_exe_args\")\n string(JOIN \" \" LINK_LIBS ${LIBS_PATH})\n file(\n GENERATE\n OUTPUT ${LIB_COMMAND_ARGS_FILE}\n CONTENT \"/OUT:$ ${LINK_LIBS}\")\n\n add_custom_command(\n TARGET ${TARGET}\n POST_BUILD\n COMMAND ${CMAKE_COMMAND} -E remove $\n COMMAND \"LIB.EXE\" \"@${LIB_COMMAND_ARGS_FILE}\")\n\n elseif(APPLE)\n add_custom_command(\n TARGET ${TARGET}\n POST_BUILD\n COMMAND ${CMAKE_COMMAND} -E remove $\n COMMAND /usr/bin/libtool -static -o $ ${LIBS_PATH})\n\n elseif(UNIX)\n set(AR_COMMAND_ARGS_FILE\n \"${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_ar_script_file\")\n\n set(AR_SCRIPT \"\")\n foreach(LIB ${LIBS_PATH})\n set(AR_SCRIPT \"${AR_SCRIPT}\\naddlib ${LIB}\")\n endforeach()\n\n file(\n GENERATE\n OUTPUT ${AR_COMMAND_ARGS_FILE}\n CONTENT \"create $\\n${AR_SCRIPT}\\nsave\\nend\\n\")\n\n add_custom_command(\n TARGET ${TARGET}\n POST_BUILD\n COMMAND ${CMAKE_COMMAND} -E remove $\n COMMAND ${CMAKE_AR} \"-M\" \"<${AR_COMMAND_ARGS_FILE}\")\n\n else()\n message(\n FATAL_ERROR \"Static llvm library: unsupported system ${CMAKE_SYSTEM_NAME}\"\n )\n endif()\n\nendmacro()\n" }, { "path": "docker/.gitignore", "content": "image.hash\n" }, { "path": "docker/archlinux/Dockerfile.X86", "content": "FROM archlinux:base-devel\nLABEL maintainer=\"QBDI Team \"\n\nENV USER=\"docker\" \\\n HOME=\"/home/docker\" \\\n PREFIX=\"/usr\" \\\n QBDI_PLATFORM=\"linux\" \\\n QBDI_ARCH=\"X86\"\n\n# Get latest package list, upgrade packages, install required packages \n# and cleanup to keep container as small as possible\nRUN echo \"[multilib]\" >> /etc/pacman.conf && \\\n echo \"Include = /etc/pacman.d/mirrorlist\" >> /etc/pacman.conf && \\\n pacman -Suy --noconfirm && \\\n pacman -S --noconfirm \\\n base-devel \\\n sudo \\\n gcc \\\n git \\\n ninja \\\n cmake \\\n python3 \\\n wget \\\n multilib-devel && \\\n (pacman -Sc --noconfirm || true)\n\n# create a user\nRUN useradd -Groot $USER && \\\n echo '%root ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers\n\n# switch to new user\nUSER $USER\n\n# build / test / install QBDI\n\n# git archive -o qbdi.tar.gz --prefix=qbdi/ HEAD .\nADD qbdi.tar.gz $HOME/\n\nWORKDIR $HOME/qbdi\n\nRUN sudo chown -R $USER:$USER . && \\\n rm -rf deps && \\\n ln -s $HOME/qbdi-deps/deps deps && \\\n mkdir build && \\\n cd build && \\\n cp ../docker/archlinux/PKGBUILD.$QBDI_ARCH PKGBUILD && \\\n makepkg -fc && \\\n sudo pacman -U --noconfirm QBDI-*.pkg.tar.zst\n\nWORKDIR \"$HOME/\"\nCMD [\"/bin/bash\"]\n" }, { "path": "docker/archlinux/Dockerfile.X86_64", "content": "FROM archlinux:base-devel\nLABEL maintainer=\"QBDI Team \"\n\nENV USER=\"docker\" \\\n HOME=\"/home/docker\" \\\n PREFIX=\"/usr\" \\\n QBDI_PLATFORM=\"linux\" \\\n QBDI_ARCH=\"X86_64\"\n\n# Get latest package list, upgrade packages, install required packages \n# and cleanup to keep container as small as possible\nRUN pacman -Suy --noconfirm && \\\n pacman -S --noconfirm \\\n base-devel \\\n sudo \\\n gcc \\\n git \\\n ninja \\\n cmake \\\n python3 \\\n wget && \\\n (pacman -Sc --noconfirm || true)\n\n# create a user\nRUN useradd -Groot $USER && \\\n echo '%root ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers\n\n# switch to new user\nUSER $USER\n\n# build / test / install QBDI\n\n# git archive -o qbdi.tar.gz --prefix=qbdi/ HEAD .\nADD qbdi.tar.gz $HOME/\n\nWORKDIR $HOME/qbdi\n\nRUN sudo chown -R $USER:$USER . && \\\n rm -rf deps && \\\n ln -s $HOME/qbdi-deps/deps deps && \\\n mkdir build && \\\n cd build && \\\n cp ../docker/archlinux/PKGBUILD.$QBDI_ARCH PKGBUILD && \\\n makepkg -fc && \\\n sudo pacman -U --noconfirm QBDI-*.pkg.tar.zst\n\nWORKDIR \"$HOME/\"\nCMD [\"/bin/bash\"]\n" }, { "path": "docker/archlinux/PKGBUILD.X86", "content": "# Maintainer: Charles Hubain \n# Maintainer: QBDI Team \n\npkgname=QBDI-X86\npkgver=0.12.2_devel\npkgrel=1\nepoch=\npkgdesc=\"QuarkslaB Dynamic binary Instrumentation for linux-X86\"\narch=('x86_64' 'i686')\nurl=\"https://qbdi.quarkslab.com/\"\nlicense=('apache2')\noptions=(staticlibs)\nmakedepends=('cmake' 'ninja' 'gcc' 'python' 'git')\n\nprepare() {\n mkdir \"$pkgname-$pkgver\"\n}\n\nbuild() {\n cd \"$pkgname-$pkgver\"\n cmake -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=linux \\\n -DQBDI_ARCH=X86 \\\n -DCMAKE_INSTALL_PREFIX=/usr \\\n -DQBDI_TOOLS_PYQBDI=OFF \\\n -DQBDI_CCACHE=OFF \\\n -G Ninja \\\n ../../../\n cmake --build .\n}\n\ncheck() {\n cd \"$pkgname-$pkgver\"\n ./test/QBDITest\n}\n\npackage() {\n cd \"$pkgname-$pkgver\"\n DESTDIR=\"$pkgdir/\" cmake --build . --target install\n}\n" }, { "path": "docker/archlinux/PKGBUILD.X86_64", "content": "# Maintainer: Charles Hubain \n# Maintainer: QBDI Team \n\npkgname=QBDI-X86_64\npkgver=0.12.2_devel\npkgrel=1\nepoch=\npkgdesc=\"QuarkslaB Dynamic binary Instrumentation for linux-X86_64\"\narch=('x86_64')\nurl=\"https://qbdi.quarkslab.com/\"\nlicense=('apache2')\noptions=(staticlibs)\nmakedepends=('cmake' 'ninja' 'gcc' 'python' 'git')\n\nprepare() {\n mkdir \"$pkgname-$pkgver\"\n}\n\nbuild() {\n cd \"$pkgname-$pkgver\"\n cmake -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=linux \\\n -DQBDI_ARCH=X86_64 \\\n -DCMAKE_INSTALL_PREFIX=/usr \\\n -DQBDI_TOOLS_PYQBDI=OFF \\\n -DQBDI_CCACHE=OFF \\\n -G Ninja \\\n ../../../\n cmake --build .\n}\n\ncheck() {\n cd \"$pkgname-$pkgver\"\n ./test/QBDITest\n}\n\npackage() {\n cd \"$pkgname-$pkgver\"\n DESTDIR=\"$pkgdir/\" cmake --build . --target install\n}\n" }, { "path": "docker/archlinux/build.sh", "content": "#!/usr/bin/bash\n\nset -e\nset -x\n\nBASEDIR=$(cd $(dirname \"$0\") && pwd -P)\nGITDIR=$(git rev-parse --show-toplevel)\n\n. \"${BASEDIR}/../common.sh\"\n\nARCH=\"X86_64\"\n\nif [[ \"$1\" = \"X86\" || \"$1\" = \"x86\" ]]; then\n ARCH=\"X86\"\nfi\n\nDOCKER_TAG=\"qbdi:x${ARCH: -2}_archlinux\"\n\nprepare_archive\n\ndocker build \"${BASEDIR}\" -t \"${DOCKER_TAG}\" -f \"${BASEDIR}/Dockerfile.${ARCH}\"\n\ndelete_archive\n\necho \"Success build ${DOCKER_TAG}\"\n" }, { "path": "docker/ci_linux/Dockerfile", "content": "ARG DOCKER_IMG=\"debian:13\"\n\nFROM $DOCKER_IMG\n\nENV USER=\"docker\" \\\n HOME=\"/home/docker\" \\\n PREFIX=\"/usr\" \\\n CLICOLOR_FORCE=1\n\nARG USER_ID=1000\n\n# Get latest package list, upgrade packages, install required packages \n# and cleanup to keep container as small as possible\nRUN apt-get update && \\\n DEBIAN_FRONTEND=noninteractive \\\n apt-get install -y --no-install-recommends \\\n adduser \\\n bash \\\n git \\\n build-essential \\\n ccache \\\n cmake \\\n g++ \\\n g++-multilib \\\n libstdc++-13-dev \\\n make \\\n ninja-build \\\n pkg-config \\\n wget \\\n ca-certificates \\\n python3 \\\n python3-dev \\\n python3-yaml \\\n zip \\\n git \\\n xxd && \\\n apt-get clean && \\\n rm -rf /var/lib/apt/lists/*\n\n# create a user\nRUN adduser --uid \"$USER_ID\" --disabled-password --gecos '' --home \"$HOME\" \"$USER\"\n\nWORKDIR $HOME\n\nUSER $USER\n\n" }, { "path": "docker/ci_linux/build-qbdi.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd \"${HOME}/qbdi/\"\nmkdir -p build\ncd build\n\ncmake .. \\\n -G Ninja \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=${QBDI_PLATFORM} \\\n -DQBDI_ARCH=${QBDI_ARCH} \\\n -DCMAKE_INSTALL_PREFIX=$PREFIX \\\n -DQBDI_EXAMPLES=ON \\\n -DQBDI_TOOLS_VALIDATOR=ON \\\n -DQBDI_TOOLS_PYQBDI=ON\n\nninja\n\ncpack\n\n./test/QBDITest\n\nset +e\n\ncd \"${HOME}/qbdi/\"\nmkdir -p tools/validation_runner/travis_db\n\npython3 tools/validation_runner/ValidationRunner.py tools/validation_runner/travis.cfg\n\nexit 0\n" }, { "path": "docker/ci_linux/img_build.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd $(dirname \"$0\")\nBASEDIR=$(pwd -P)\nGITDIR=$(git rev-parse --show-toplevel)\n\nif [[ \"${QBDI_ARCH}\" = \"X86_64\" ]]; then\n DOCKER_IMG=\"amd64/debian:13\"\nelif [[ \"${QBDI_ARCH}\" = \"X86\" ]]; then\n DOCKER_IMG=\"i386/debian:13\"\nelse\n echo \"Unknown QBDI_ARCH : ${QBDI_ARCH}\"\n exit 1\nfi\n\ndocker build \"${BASEDIR}\" -t qbdi_build:base_${QBDI_ARCH} --build-arg USER_ID=\"$(id -u)\" --build-arg DOCKER_IMG=\"${DOCKER_IMG}\" -f \"${BASEDIR}/Dockerfile\"\n" }, { "path": "docker/ci_linux/qbdi.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd $(dirname \"$0\")\nBASEDIR=$(pwd -P)\nGITDIR=$(git rev-parse --show-toplevel)\n\n./img_build.sh\n\ndocker run --rm \\\n -e QBDI_PLATFORM=\"${QBDI_PLATFORM}\" \\\n -e QBDI_ARCH=\"${QBDI_ARCH}\" \\\n --mount type=bind,source=\"${GITDIR}\",target=/home/docker/qbdi \\\n --mount type=bind,source=\"${HOME}/.ccache\",target=/home/docker/.ccache \\\n --cap-add=SYS_PTRACE --security-opt seccomp:unconfined \\\n qbdi_build:base_${QBDI_ARCH} \\\n /bin/bash /home/docker/qbdi/docker/ci_linux/build-qbdi.sh\n\n\n" }, { "path": "docker/ci_linux_arm/.gitignore", "content": ".dockcross-linux-AARCH64-latest\n.dockcross-linux-ARM-latest\n\n" }, { "path": "docker/ci_linux_arm/build_qbdi_linux.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd \"$(dirname \"$0\")\"\nBASEDIR=\"$(pwd -P)\"\nGITDIR=\"$(git rev-parse --show-toplevel)\"\n\nTAG_PREFIX=\"qbdi-linux/qbdi_test\"\nQBDI_PLATFORM=\"linux\"\nQBDI_ARCH=\"$1\"\n\n./images/img_build.sh \"${QBDI_ARCH}\"\n\nIMG_BUILD=\"${TAG_PREFIX}:dockcross_${QBDI_PLATFORM}_${QBDI_ARCH}\"\n\n#1 get dockcross script\nSCRIPT_PATH=\"${BASEDIR}/.dockcross-${QBDI_PLATFORM}-${QBDI_ARCH}-latest\"\ndocker run --rm \"${IMG_BUILD}\" > \"${SCRIPT_PATH}\"\nchmod +x \"${SCRIPT_PATH}\"\n\n#2 Don't mount .ssh in docker\nexport SSH_DIR=/var/empty/.ssh\n\n#3 use docker to run the package\nexport OCI_EXE=docker\n\n#4 compile and test QBDI in dockcross\npushd \"${GITDIR}\"\n\"${SCRIPT_PATH}\" \\\n -i \"${IMG_BUILD}\" \\\n -a \"-v ${HOME}/.ccache:${HOME}/.ccache\" \\\n -- env QBDI_PLATFORM=\"${QBDI_PLATFORM}\" \\\n QBDI_ARCH=\"${QBDI_ARCH}\" \\\n ./docker/ci_linux_arm/docker_internal_script/build-test-linux.sh\npopd\n\n" }, { "path": "docker/ci_linux_arm/docker_internal_script/build-test-linux.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\nmkdir -p \"build-docker-${QBDI_PLATFORM}-${QBDI_ARCH}\"\ncd \"build-docker-${QBDI_PLATFORM}-${QBDI_ARCH}\"\n\n# generate clean toolchains file\nTOOLCHAIN_FILE=\"QBDI_${QBDI_ARCH}_Toolchain.cmake\"\ncat \"${CMAKE_TOOLCHAIN_FILE}\" > \"${TOOLCHAIN_FILE}\"\nsed -e \"s#\\$ENV{CROSS_TRIPLE}#${CROSS_TRIPLE}#\" \\\n -e \"s#\\$ENV{CROSS_ROOT}#${CROSS_ROOT}#\" \\\n -e \"s#\\$ENV{CC}#${CC}#\" \\\n -e \"s#\\$ENV{CXX}#${CXX}#\" \\\n -e \"s#\\$ENV{FC}#${FC}#\" \\\n -i \"${TOOLCHAIN_FILE}\"\n\n# create an empty toolchains to break the propagation of crosscompile\n# environment when compile llvm-tblgen\nEMPTY_TOOLCHAINS=\"$(pwd)/QBDI_empty_toolchains.cmake\"\ntouch \"${EMPTY_TOOLCHAINS}\"\n\n# need to have a clear env to avoid crosscompiler\n# to be used to compile llvm-tblgen\nclean_env() {\n env -i \\\n PATH=\"${PATH}\" \\\n HOME=\"${HOME}\" \\\n CLICOLOR_FORCE=\"1\" \\\n \"$@\"\n}\n\nclean_env \\\n cmake -G Ninja \\\n -DCMAKE_TOOLCHAIN_FILE=\"${TOOLCHAIN_FILE}\" \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DQBDI_LLVM_TABLEN_TOOLSCHAIN=\"${EMPTY_TOOLCHAINS}\" \\\n -DQBDI_PLATFORM=\"${QBDI_PLATFORM}\" \\\n -DQBDI_ARCH=\"${QBDI_ARCH}\" \\\n -DQBDI_EXAMPLES=ON \\\n -DQBDI_TOOLS_VALIDATOR=OFF \\\n -DQBDI_TOOLS_PYQBDI=OFF \\\n ..\n\nclean_env ninja\n\nif [[ \"${QBDI_ARCH}\" = \"ARM\" ]]; then\n qemu-arm-static ./test/QBDITest\nelif [[ \"${QBDI_ARCH}\" = \"AARCH64\" ]]; then\n qemu-aarch64-static ./test/QBDITest\nfi\n\nclean_env cpack\n\nexit 0\n" }, { "path": "docker/ci_linux_arm/images/Dockerfile.dockcross", "content": "ARG DOCKER_IMG=\"dockcross/linux-arm64\"\n\nFROM $DOCKER_IMG\n\nENV CLICOLOR_FORCE=1\n\n# setup backport to use cmake >= 3.28\nRUN echo 'deb http://deb.debian.org/debian bookworm-backports main contrib non-free' > /etc/apt/sources.list.d/backports.list\n\nRUN apt-get update && \\\n DEBIAN_FRONTEND=noninteractive \\\n apt-get install -y --no-install-recommends \\\n bash \\\n ca-certificates \\\n ccache \\\n cmake/bookworm-backports \\\n git \\\n python3 \\\n qemu-user-static \\\n wget \\\n zip && \\\n apt-get clean && \\\n rm -rf /var/lib/apt/lists/*\n\n" }, { "path": "docker/ci_linux_arm/images/img_build.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd \"$(dirname \"$0\")\"\nBASEDIR=\"$(pwd -P)\"\nTAG_PREFIX=\"qbdi-linux/qbdi_test\"\nTARGET_ARCH=\"$1\"\n\nif [[ -n \"$TARGET_ARCH\" ]] && [[ \"$TARGET_ARCH\" != \"AARCH64\" ]] && [[ \"$TARGET_ARCH\" != \"ARM\" ]]; then\n echo \"Unrecognized architecture.\"\n echo \"Supported : AARCH64, ARM\"\n exit 1\nfi\n\nbuild_linux() {\n QBDI_PLATFORM=\"linux\"\n QBDI_ARCH=\"$1\"\n if [[ \"$QBDI_ARCH\" = \"AARCH64\" ]]; then\n DOCKCROSS_IMG=\"dockcross/linux-arm64\"\n elif [[ \"$QBDI_ARCH\" = \"ARM\" ]]; then\n DOCKCROSS_IMG=\"dockcross/linux-armv7\"\n fi\n docker pull \"${DOCKCROSS_IMG}\"\n docker build \"${BASEDIR}\" -f \"${BASEDIR}/Dockerfile.dockcross\" -t \"${TAG_PREFIX}:dockcross_${QBDI_PLATFORM}_${QBDI_ARCH}\" --build-arg DOCKER_IMG=\"${DOCKCROSS_IMG}\"\n}\n\nif [[ -n \"$TARGET_ARCH\" ]]; then\n build_linux \"$TARGET_ARCH\"\nelse\n build_linux AARCH64\n build_linux ARM\nfi\n\n" }, { "path": "docker/ci_python_linux/Dockerfile", "content": "ARG DOCKER_IMG=\"quay.io/pypa/manylinux2014\"\n\nFROM $DOCKER_IMG\n\nENV USER=\"docker\" \\\n HOME=\"/home/docker\" \\\n PREFIX=\"/usr\" \\\n QBDI_PLATFORM=\"linux\" \\\n PYTHON_OPT=\"/opt/python\" \\\n CLICOLOR_FORCE=1 \\\n CCACHE_VERSION=\"4.11.3\" \\\n CCACHE_HASH=\"28a407314f03a7bd7a008038dbaffa83448bc670e2fc119609b1d99fb33bb600\"\n\nARG USER_ID=1000\n\n# create a user\nRUN adduser --uid \"$USER_ID\" --password '' -m \"$USER\"\n\n# Get latest package list, upgrade packages, install required packages\n# and cleanup to keep container as small as possible\nRUN yum update -y && \\\n yum install -y \\\n bash \\\n wget \\\n ca-certificates && \\\n (yum install -y ccache || true) && \\\n yum clean all\n\nRUN /opt/python/cp38-cp38/bin/pip install ninja==1.10.0.post2\n\nENV PATH=$PATH:/opt/python/cp38-cp38/bin/ \\\n CCACHE_URL=\"https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}.tar.gz\" \\\n CCACHE_ARCHIVE=\"ccache-${CCACHE_VERSION}.tar.gz\" \n\nRUN if ! which ccache >/dev/null 2>&1; then \\\n set -ex; \\\n cd /tmp; \\\n wget \"${CCACHE_URL}\" -O \"${CCACHE_ARCHIVE}\"; \\\n (echo \"${CCACHE_HASH} ${CCACHE_ARCHIVE}\" | sha256sum -c -) || exit 1; \\\n tar xf \"${CCACHE_ARCHIVE}\"; \\\n cd \"/tmp/ccache-${CCACHE_VERSION}\"; \\\n mkdir build && cd build; \\\n cmake .. -G Ninja -DCMAKE_BUILD_TYPE=Release -DZSTD_FROM_INTERNET=ON; \\\n ninja install; \\\n cd /; \\\n rm -rf \"/tmp/ccache-${CCACHE_VERSION}\" \"/tmp/${CCACHE_ARCHIVE}\"; \\\n fi\n\nWORKDIR $HOME\n\nUSER $USER\n\n" }, { "path": "docker/ci_python_linux/build_whl.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd ~/qbdi\n\nPYTHON_VERSION=\"${1:-all}\"\n\nif [[ \"${PYTHON_VERSION}\" = \"all\" ]] || [[ \"${PYTHON_VERSION}\" = \"3.8\" ]]; then\n /opt/python/cp38-cp38/bin/python -m build -w\nfi\nif [[ \"${PYTHON_VERSION}\" = \"all\" ]] || [[ \"${PYTHON_VERSION}\" = \"3.9\" ]]; then\n /opt/python/cp39-cp39/bin/python -m build -w\nfi\nif [[ \"${PYTHON_VERSION}\" = \"all\" ]] || [[ \"${PYTHON_VERSION}\" = \"3.10\" ]]; then\n /opt/python/cp310-cp310/bin/python -m build -w\nfi\nif [[ \"${PYTHON_VERSION}\" = \"all\" ]] || [[ \"${PYTHON_VERSION}\" = \"3.11\" ]]; then\n /opt/python/cp311-cp311/bin/python -m build -w\nfi\nif [[ \"${PYTHON_VERSION}\" = \"all\" ]] || [[ \"${PYTHON_VERSION}\" = \"3.12\" ]]; then\n /opt/python/cp312-cp312/bin/python -m build -w\nfi\nif [[ \"${PYTHON_VERSION}\" = \"all\" ]] || [[ \"${PYTHON_VERSION}\" = \"3.13\" ]]; then\n /opt/python/cp313-cp313/bin/python -m build -w\nfi\nif [[ \"${PYTHON_VERSION}\" = \"all\" ]] || [[ \"${PYTHON_VERSION}\" = \"3.14\" ]]; then\n /opt/python/cp314-cp314/bin/python -m build -w\nfi\n\nif [[ \"${QBDI_ARCH}\" = \"X86_64\" ]]; then\n for i in dist/*_x86_64.whl; do\n auditwheel repair $i -w outwheel;\n done\nelif [[ \"${QBDI_ARCH}\" = \"X86\" ]]; then\n for i in dist/*_i686.whl; do\n auditwheel repair $i -w outwheel;\n done\nelif [[ \"${QBDI_ARCH}\" = \"AARCH64\" ]]; then\n for i in dist/*_aarch64.whl; do\n auditwheel repair $i -w outwheel;\n done\nelse\n echo \"Unknown QBDI_ARCH : ${QBDI_ARCH}\"\n exit 1\nfi\n\n" }, { "path": "docker/ci_python_linux/img_build.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd $(dirname \"$0\")\nBASEDIR=$(pwd -P)\nGITDIR=$(git rev-parse --show-toplevel)\n\nif [[ \"${QBDI_ARCH}\" = \"X86_64\" ]]; then\n DOCKER_IMG=\"quay.io/pypa/manylinux2014_x86_64\"\nelif [[ \"${QBDI_ARCH}\" = \"X86\" ]]; then\n DOCKER_IMG=\"quay.io/pypa/manylinux2014_i686\"\nelif [[ \"${QBDI_ARCH}\" = \"AARCH64\" ]]; then\n DOCKER_IMG=\"quay.io/pypa/manylinux2014_aarch64\"\nelse\n echo \"Unknown QBDI_ARCH : ${QBDI_ARCH}\"\n exit 1\nfi\n\n\ndocker build \"${BASEDIR}\" -t pyqbdi_build:base_${QBDI_ARCH} \\\n --build-arg DOCKER_IMG=\"${DOCKER_IMG}\" \\\n --build-arg USER_ID=\"$(id -u)\" \\\n -f \"${BASEDIR}/Dockerfile\"\n\n" }, { "path": "docker/ci_python_linux/whl_build.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd $(dirname \"$0\")\nBASEDIR=$(pwd -P)\nGITDIR=$(git rev-parse --show-toplevel)\n\nPYTHON_VERSION=\"${1:-all}\"\n\n./img_build.sh\n\ndocker run --rm \\\n -e QBDI_PLATFORM=\"${QBDI_PLATFORM}\" \\\n -e QBDI_ARCH=\"${QBDI_ARCH}\" \\\n --mount type=bind,source=\"${GITDIR}\",target=/home/docker/qbdi \\\n --mount type=bind,source=\"${HOME}/.ccache\",target=/home/docker/.ccache \\\n pyqbdi_build:base_${QBDI_ARCH} \\\n /bin/bash /home/docker/qbdi/docker/ci_python_linux/build_whl.sh \"${PYTHON_VERSION}\"\n\n" }, { "path": "docker/common.sh", "content": "\nQBDI_VERSION=\"0.12.2-devel\"\nDOCKERHUB_REPO=\"qbdi/qbdi\"\nDOCKER_BUILD_DIR=\"/home/docker/qbdi/build\"\n\nDEBIAN_TARGET=\"trixie\"\nUBUNTU_LTS_TARGET=\"24.04\"\nUBUNTU_LAST_TARGET=\"25.10\"\n\nprepare_archive (){\n pushd \"$(git rev-parse --show-toplevel)\" >/dev/null\n\n git archive -o \"${BASEDIR}/qbdi.tar.gz\" --prefix=qbdi/ HEAD .\n\n popd >/dev/null\n}\n\ndelete_archive() {\n rm -f \"${BASEDIR}/qbdi.tar.gz\"\n}\n\n" }, { "path": "docker/linux_arm_natif/.gitignore", "content": ".dockcross-linux-AARCH64-latest\n.dockcross-linux-ARM-latest\n\n" }, { "path": "docker/linux_arm_natif/build_qbdi_linux.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd \"$(dirname \"$0\")\"\nBASEDIR=\"$(pwd -P)\"\nGITDIR=\"$(git rev-parse --show-toplevel)\"\n\nTAG_PREFIX=\"qbdi-linux/qbdi_test\"\nQBDI_PLATFORM=\"linux\"\nQBDI_ARCH=\"$1\"\n\nif [[ \"$QBDI_ARCH\" != \"AARCH64\" ]] && [[ \"$QBDI_ARCH\" != \"ARM\" ]]; then\n echo \"Unrecognized architecture.\"\n echo \"Supported : AARCH64, ARM\"\n exit 1\nfi\n\n./images/build_docker_img.sh \"${QBDI_ARCH}\"\n\nIMG_BUILD=\"${TAG_PREFIX}:native_${QBDI_PLATFORM}_${QBDI_ARCH}\"\n\ndocker run -it --rm \\\n -v \"${HOME}/.ccache:/home/docker/.ccache\" \\\n -v \"${GITDIR}:/home/docker/QBDI\" \\\n -e QBDI_PLATFORM=\"${QBDI_PLATFORM}\" \\\n -e QBDI_ARCH=\"${QBDI_ARCH}\" \\\n \"${IMG_BUILD}\" \\\n /home/docker/QBDI/docker/linux_arm_natif/docker_internal_script/build-test-linux.sh\n\n" }, { "path": "docker/linux_arm_natif/docker_internal_script/build-test-linux.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\nmkdir -p \"build-docker-native-${QBDI_PLATFORM}-${QBDI_ARCH}\"\ncd \"build-docker-native-${QBDI_PLATFORM}-${QBDI_ARCH}\"\n\n\ncmake -G Ninja \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DQBDI_PLATFORM=\"${QBDI_PLATFORM}\" \\\n -DQBDI_ARCH=\"${QBDI_ARCH}\" \\\n -DQBDI_EXAMPLES=ON \\\n -DQBDI_TOOLS_VALIDATOR=ON \\\n -DQBDI_TOOLS_PYQBDI=ON \\\n ..\n\nninja\n\n./test/QBDITest\n\ncpack\n\ncd ../tools/validation_runner\n#./ValidationRunner.py coverage.cfg -l \"../../build-docker-native-${QBDI_PLATFORM}-${QBDI_ARCH}/tools/validator/libvalidator.so\"\n\nexit 0\n" }, { "path": "docker/linux_arm_natif/images/Dockerfile", "content": "ARG DOCKER_IMG=\"debian:latest\"\nFROM $DOCKER_IMG\n\nARG QBDI_ARCH=\"AARCH64\"\n\nENV USER=\"docker\" \\\n HOME=\"/home/docker\" \\\n PREFIX=\"/usr\" \\\n QBDI_PLATFORM=\"linux\" \\\n CLICOLOR_FORCE=1\n\n# Get latest package list, upgrade packages, install required packages\n# and cleanup to keep container as small as possible\nRUN apt-get update && \\\n DEBIAN_FRONTEND=noninteractive \\\n apt-get install -y --no-install-recommends \\\n adduser \\\n bash \\\n build-essential \\\n ca-certificates \\\n ccache \\\n cmake \\\n file \\\n g++ \\\n git \\\n gzip \\\n imagemagick \\\n libstdc++-13-dev \\\n ninja-build \\\n openssl \\\n pkg-config \\\n python3 \\\n python3-dev \\\n python3-pip \\\n python3-yaml \\\n wget \\\n xxd \\\n zip \\\n && \\\n apt-get clean && \\\n rm -rf /var/lib/apt/lists/*\n\n# create a user\nRUN adduser --disabled-password --gecos '' --home \"$HOME\" \"$USER\"\n\n# switch to new user\nUSER $USER\n\nRUN mkdir \"$HOME/QBDI\"\n\nWORKDIR $HOME/QBDI\n" }, { "path": "docker/linux_arm_natif/images/build_docker_img.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd \"$(dirname \"$0\")\"\nBASEDIR=\"$(pwd -P)\"\nTAG_PREFIX=\"qbdi-linux/qbdi_test\"\nTARGET_ARCH=\"$1\"\n\nif [[ -n \"$TARGET_ARCH\" ]] && [[ \"$TARGET_ARCH\" != \"AARCH64\" ]] && [[ \"$TARGET_ARCH\" != \"ARM\" ]]; then\n echo \"Unrecognized architecture.\"\n echo \"Supported : AARCH64, ARM\"\n exit 1\nfi\n\nbuild_linux() {\n QBDI_PLATFORM=\"linux\"\n QBDI_ARCH=\"$1\"\n if [[ \"$QBDI_ARCH\" = \"AARCH64\" ]]; then\n BASE_IMG=\"arm64v8/debian:latest\"\n elif [[ \"$QBDI_ARCH\" = \"ARM\" ]]; then\n BASE_IMG=\"arm32v7/debian:latest\"\n fi\n docker build \"${BASEDIR}\" -f \"${BASEDIR}/Dockerfile\" -t \"${TAG_PREFIX}:native_${QBDI_PLATFORM}_${QBDI_ARCH}\" --build-arg DOCKER_IMG=\"${BASE_IMG}\"\n}\n\nif [[ -n \"$TARGET_ARCH\" ]]; then\n build_linux \"$TARGET_ARCH\"\nelse\n build_linux AARCH64\n build_linux ARM\nfi\n\n" }, { "path": "docker/python_linux_arm/docker_internal_script/build_wheel.sh", "content": "#!/usr/bin/env bash\n\n# change python host platform to armv7 arch\n# This is needed when compile on X86 or AARCH64 platform, inside a ARM docker\nexport _PYTHON_HOST_PLATFORM=\"linux-armv7l\"\n\n# run with --skip-dependency-check and --no-isolation to\n# avoid compile cmake.whl and ninja.whl that isn't prebuild for armv7\npython -m build --skip-dependency-check --no-isolation -w\n" }, { "path": "docker/python_linux_arm/images/Dockerfile", "content": "ARG DOCKER_IMG=\"arm32v7/python:3\"\n\nFROM $DOCKER_IMG\n\nENV USER=\"docker\" \\\n HOME=\"/home/docker\" \\\n PREFIX=\"/usr\" \\\n QBDI_PLATFORM=\"linux\"\n\n# Get latest package list, upgrade packages, install required packages\n# and cleanup to keep container as small as possible\nRUN apt-get update && \\\n DEBIAN_FRONTEND=noninteractive \\\n apt-get install -y --no-install-recommends \\\n adduser \\\n bash \\\n build-essential \\\n ca-certificates \\\n ccache \\\n cmake \\\n g++ \\\n git \\\n ninja-build \\\n pkg-config \\\n python3 \\\n python3-dev \\\n python3-pip \\\n wget \\\n xxd \\\n zip \\\n && \\\n apt-get clean && \\\n rm -rf /var/lib/apt/lists/*\n\n# create a user\nRUN adduser --disabled-password --gecos '' --home \"$HOME\" \"$USER\"\n\n# switch to new user\nUSER $USER\n\nENV PATH=\"${PATH}:${HOME}/.local/bin\"\n\nRUN mkdir \"${HOME}/QBDI\" && \\\n pip install --upgrade --user pip build setuptools\n\nWORKDIR $HOME/QBDI\n\nARG USER_ID=1000\n\n" }, { "path": "docker/python_linux_arm/images/build_docker_img.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd \"$(dirname \"$0\")\"\nBASEDIR=\"$(pwd -P)\"\nTAG_PREFIX=\"pyqbdi/wheel_arm_building\"\nBASE_DEBIAN=\"trixie\"\nPYTHON_VERSION=\"$1\"\n\nbuild_python_image() {\n QBDI_PLATFORM=\"linux\"\n QBDI_ARCH=\"ARM\"\n PYTHON_VERSION=\"$1\"\n BASE_IMG=\"arm32v7/python:${PYTHON_VERSION}-${BASE_DEBIAN}\"\n docker build \"${BASEDIR}\" -f \"${BASEDIR}/Dockerfile\" \\\n --platform=\"linux/arm/v7\" \\\n -t \"${TAG_PREFIX}:${QBDI_PLATFORM}_${QBDI_ARCH}_${PYTHON_VERSION}\" \\\n --build-arg DOCKER_IMG=\"${BASE_IMG}\"\n}\n\nif [[ -n \"$PYTHON_VERSION\" ]]; then\n build_python_image \"$PYTHON_VERSION\"\nelse\n build_python_image 3.9\n build_python_image 3.10\n build_python_image 3.11\n build_python_image 3.12\n build_python_image 3.13\n build_python_image 3.14\nfi\n\n\n" }, { "path": "docker/python_linux_arm/whl_build.sh", "content": "#!/usr/bin/env bash\n\nset -ex\n\ncd $(dirname \"$0\")\nBASEDIR=$(pwd -P)\nGITDIR=$(git rev-parse --show-toplevel)\nTAG_PREFIX=\"pyqbdi/wheel_arm_building\"\nBASE_DEBIAN=\"trixie\"\nPYTHON_VERSION=\"$1\"\n\n./images/build_docker_img.sh \"${PYTHON_VERSION}\"\n\nbuild_wheel() {\n QBDI_PLATFORM=\"linux\"\n QBDI_ARCH=\"ARM\"\n PYTHON_VERSION=\"$1\"\n\n docker run --rm -it \\\n --platform=\"linux/arm/v7\" \\\n -e QBDI_PLATFORM=\"${QBDI_PLATFORM}\" \\\n -e QBDI_ARCH=\"${QBDI_ARCH}\" \\\n --mount type=bind,source=\"${GITDIR}\",target=/home/docker/QBDI \\\n --mount type=bind,source=\"${HOME}/.ccache\",target=/home/docker/.ccache \\\n \"${TAG_PREFIX}:${QBDI_PLATFORM}_${QBDI_ARCH}_${PYTHON_VERSION}\" \\\n bash /home/docker/QBDI/docker/python_linux_arm/docker_internal_script/build_wheel.sh\n}\n\n\nif [[ -n \"$PYTHON_VERSION\" ]]; then\n build_wheel \"$PYTHON_VERSION\"\nelse\n build_wheel 3.9\n build_wheel 3.10\n build_wheel 3.11\n build_wheel 3.12\n build_wheel 3.13\n build_wheel 3.14\nfi\n\n" }, { "path": "docker/release.sh", "content": "#!/usr/bin/bash\n\nset -e\n\nHASHFILE=\"image.hash\"\nPUSH_IMAGE=0\nTARGET_ARCH=\"$1\"\n\nBASEDIR=$(cd $(dirname \"$0\") && pwd -P)\nGITDIR=$(git rev-parse --show-toplevel)\n\ntouch \"$HASHFILE\"\n. \"${BASEDIR}/common.sh\"\n\ndocker_login() {\n if [[ \"${PUSH_IMAGE}\" -ne 0 ]]; then\n docker login\n fi\n}\n\npush_image() {\n if [[ \"${PUSH_IMAGE}\" -ne 0 ]]; then\n docker push \"$1\"\n fi\n}\n\ndocker_logout() {\n if [[ \"${PUSH_IMAGE}\" -ne 0 ]]; then\n docker logout\n fi\n}\n\npush_images() {\n TAG=\"$1\"\n shift\n while [[ -n \"$1\" ]]; do\n docker tag \"$TAG\" \"${DOCKERHUB_REPO}:$1\"\n push_image \"${DOCKERHUB_REPO}:$1\"\n if [[ \"$1\" != \"latest\" ]]; then\n docker tag \"$TAG\" \"${DOCKERHUB_REPO}:${QBDI_VERSION}_$1\"\n push_image \"${DOCKERHUB_REPO}:${QBDI_VERSION}_$1\"\n fi\n shift\n done\n}\n\nprint_hash() {\n IMG=\"${DOCKERHUB_REPO}:${QBDI_VERSION}_$1\"\n echo -n \"${IMG} \" >> \"$HASHFILE\"\n docker inspect --format='{{.Id}}' \"${IMG}\" >> \"$HASHFILE\"\n}\n\nperform_action() {\n ACTION=\"$1\"; shift\n ARCH=\"$1\"; shift\n DOCKER_IMG_BASE=\"$1\"; shift\n\n INTERNAL_DOCKER_TAG=\"qbdi:${ARCH}_${DOCKER_IMG_BASE%%:*}_${DOCKER_IMG_BASE##*:}\"\n TARGET_DOCKER_TAG=\"$1\"\n\n if [[ -n \"$TARGET_ARCH\" ]] && [[ \"$ARCH\" != \"$TARGET_ARCH\" ]]; then\n return\n fi\n\n if [[ \"${ACTION}\" = \"build\" ]]; then\n \"${BASEDIR}/ubuntu_debian/build.sh\" \"${ARCH}\" \"${DOCKER_IMG_BASE}\"\n elif [[ \"${ACTION}\" = \"push\" ]]; then\n push_images \"${INTERNAL_DOCKER_TAG}\" \"$@\"\n elif [[ \"${ACTION}\" = \"hash\" ]]; then\n print_hash \"${TARGET_DOCKER_TAG}\"\n else\n echo \"Unknown action ${ACTION}\"\n exit 1\n fi\n}\n\n\nperform_action_by_image() {\n ACTION=\"$1\"\n\n perform_action \"$ACTION\" \"ARM\" \"debian:${DEBIAN_TARGET}\" \"armv7_debian_${DEBIAN_TARGET}\" \"armv7_debian\" \"armv7\"\n perform_action \"$ACTION\" \"AARCH64\" \"debian:${DEBIAN_TARGET}\" \"arm64_debian_${DEBIAN_TARGET}\" \"arm64_debian\" \"arm64\"\n perform_action \"$ACTION\" \"X86\" \"debian:${DEBIAN_TARGET}\" \"x86_debian_${DEBIAN_TARGET}\" \"x86_debian\" \"x86\"\n perform_action \"$ACTION\" \"X86_64\" \"debian:${DEBIAN_TARGET}\" \"x64_debian_${DEBIAN_TARGET}\" \"x64_debian\" \"x64\" \"latest\"\n\n perform_action \"$ACTION\" \"ARM\" \"ubuntu:${UBUNTU_LTS_TARGET}\" \"armv7_ubuntu_${UBUNTU_LTS_TARGET}\" \"armv7_ubuntu_lts\" \"armv7_ubuntu\"\n perform_action \"$ACTION\" \"AARCH64\" \"ubuntu:${UBUNTU_LTS_TARGET}\" \"arm64_ubuntu_${UBUNTU_LTS_TARGET}\" \"arm64_ubuntu_lts\" \"arm64_ubuntu\"\n perform_action \"$ACTION\" \"X86_64\" \"ubuntu:${UBUNTU_LTS_TARGET}\" \"x64_ubuntu_${UBUNTU_LTS_TARGET}\" \"x64_ubuntu_lts\" \"x64_ubuntu\"\n\n perform_action \"$ACTION\" \"ARM\" \"ubuntu:${UBUNTU_LAST_TARGET}\" \"armv7_ubuntu_${UBUNTU_LAST_TARGET}\"\n perform_action \"$ACTION\" \"AARCH64\" \"ubuntu:${UBUNTU_LAST_TARGET}\" \"arm64_ubuntu_${UBUNTU_LAST_TARGET}\"\n perform_action \"$ACTION\" \"X86_64\" \"ubuntu:${UBUNTU_LAST_TARGET}\" \"x64_ubuntu_${UBUNTU_LAST_TARGET}\"\n}\n\nperform_action_by_image \"build\"\ndocker_login\nperform_action_by_image \"push\"\ndocker_logout\nperform_action_by_image \"hash\"\n\ncat \"$HASHFILE\"\n\n" }, { "path": "docker/ubuntu_debian/Dockerfile", "content": "ARG DOCKER_IMG=\"ubuntu:latest\"\n\nFROM $DOCKER_IMG AS builder\n\nARG QBDI_ARCH=\"X86_64\"\n\nENV USER=\"docker\" \\\n HOME=\"/home/docker\" \\\n PREFIX=\"/usr\" \\\n QBDI_PLATFORM=\"linux\"\n\n# setup backport to use cmake >= 3.28\nRUN ( cat /etc/debian_version | grep -v -q 12 ) || \\\n ( echo 'deb http://deb.debian.org/debian bookworm-backports main contrib non-free' > /etc/apt/sources.list.d/backports.list )\n\n# Get latest package list, upgrade packages, install required packages\n# and cleanup to keep container as small as possible\nRUN apt-get update && \\\n DEBIAN_FRONTEND=noninteractive \\\n apt-get install -y --no-install-recommends \\\n adduser \\\n bash \\\n build-essential \\\n cmake \\\n g++ \\\n git \\\n libstdc++-13-dev \\\n ninja-build \\\n pkg-config \\\n wget \\\n ca-certificates \\\n python3 \\\n python3-dev && \\\n ( ( cat /etc/debian_version | grep -v -q 12 ) || ( apt-get install -y --no-install-recommends cmake/bookworm-backports ) ) && \\\n apt-get clean && \\\n rm -rf /var/lib/apt/lists/*\n\n# create a user\nRUN adduser --disabled-password --gecos '' --home \"$HOME\" \"$USER\"\n\n# build / test / install QBDI\nARG CMAKE_ARGUMENT=\"\"\n\n# git archive -o qbdi.tar.gz --prefix=qbdi/ HEAD .\nADD qbdi.tar.gz $HOME/\n\nWORKDIR $HOME/qbdi\n\nRUN chown -R $USER:$USER .\n\n# switch to new user\nUSER $USER\n\nRUN mkdir build && \\\n cd build && \\\n cmake -G Ninja \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=$QBDI_PLATFORM \\\n -DQBDI_ARCH=$QBDI_ARCH \\\n -DCMAKE_INSTALL_PREFIX=$PREFIX \\\n -DQBDI_TOOLS_PYQBDI=OFF \\\n -DQBDI_CCACHE=OFF \\\n $CMAKE_ARGUMENT \\\n ../ && \\\n ninja && \\\n # test\n ./test/QBDITest && \\\n # create package and install\n rm -f QBDI-*-$QBDI_PLATFORM.deb && \\\n cpack -G DEB\n\n\nFROM $DOCKER_IMG\n\nWORKDIR /root\n\nCOPY --from=builder /home/docker/qbdi/build/*.deb .\nRUN apt-get update && \\\n DEBIAN_FRONTEND=noninteractive \\\n apt-get install -y ./*.deb && \\\n apt-get clean && \\\n rm -rf /var/lib/apt/lists/*\n\nCMD [\"/bin/bash\"]\n" }, { "path": "docker/ubuntu_debian/build.sh", "content": "#!/usr/bin/bash\n\nset -e\nset -x\n\nBASEDIR=$(cd $(dirname \"$0\") && pwd -P)\nGITDIR=$(git rev-parse --show-toplevel)\n\n. \"${BASEDIR}/../common.sh\"\n\nARCH=\"X86_64\"\nDOCKER_IMG=\"ubuntu\"\nTAG=\"latest\"\nDOCKER_PLATFORM=\"linux/amd64\"\n\nif [[ -n \"$2\" ]]; then\n TAG=\"${2##*:}\"\n DOCKER_IMG=\"${2%%:*}\"\nfi\n\nif [[ \"$1\" = \"X86\" ]] || [[ \"$1\" = \"x86\" ]]; then\n ARCH=\"X86\"\n DOCKER_IMG=\"i386/$DOCKER_IMG\"\n DOCKER_PLATFORM=\"linux/386\"\nelif [[ \"$1\" = \"ARM\" ]] || [[ \"$1\" = \"arm\" ]] || [[ \"$1\" = \"arm32\" ]]; then\n ARCH=\"ARM\"\n DOCKER_IMG=\"arm32v7/$DOCKER_IMG\"\n DOCKER_PLATFORM=\"linux/arm/v7\"\nelif [[ \"$1\" = \"AARCH64\" ]] || [[ \"$1\" = \"aarch64\" ]] || [[ \"$1\" = \"arm64\" ]]; then\n ARCH=\"AARCH64\"\n DOCKER_IMG=\"arm64v8/$DOCKER_IMG\"\n DOCKER_PLATFORM=\"linux/arm64/v8\"\nfi\n\nCMAKE_ARGUMENT=\"$3\"\n\nDISTRIB=\"${DOCKER_IMG##*/}\"\n\nDOCKER_TAG=\"qbdi:${ARCH}_${DOCKER_IMG##*/}_${TAG}\"\n\nDOCKERFILE=\"${BASEDIR}/Dockerfile\"\n\nprepare_archive\n\ndocker build \"${BASEDIR}\" -t \"${DOCKER_TAG}\" -f \"${DOCKERFILE}\" \\\n --platform=\"$DOCKER_PLATFORM\" \\\n --build-arg DOCKER_IMG=\"${DOCKER_IMG}:${TAG}\" \\\n --build-arg QBDI_ARCH=\"$ARCH\" \\\n --build-arg CMAKE_ARGUMENT=\"${CMAKE_ARGUMENT}\"\n\ndelete_archive\n\necho \"Success build ${DOCKER_TAG}\"\n" }, { "path": "docker/ubuntu_debian_devel/Dockerfile", "content": "ARG DOCKER_IMG=\"ubuntu:latest\"\n\nFROM $DOCKER_IMG\n\nARG QBDI_ARCH=\"X86_64\"\n\nENV USER=\"docker\" \\\n HOME=\"/home/docker\" \\\n PREFIX=\"/usr\" \\\n QBDI_PLATFORM=\"linux\"\n\n# Get latest package list, upgrade packages, install required packages\n# and cleanup to keep container as small as possible\nRUN apt-get update && \\\n DEBIAN_FRONTEND=noninteractive \\\n apt-get install -y --no-install-recommends \\\n adduser \\\n bash \\\n sudo \\\n build-essential \\\n cmake \\\n g++ \\\n git \\\n libstdc++-13-dev \\\n ninja-build \\\n pkg-config \\\n wget \\\n ca-certificates \\\n python3 \\\n python3-dev \\\n python3-yaml \\\n imagemagick \\\n zip \\\n less \\\n file \\\n xxd \\\n git && \\\n apt-get clean && \\\n rm -rf /var/lib/apt/lists/*\n\n# create a user and add user in sudo to ease debug\nRUN adduser --disabled-password --gecos '' --home \"$HOME\" \"$USER\" && \\\n adduser $USER sudo && \\\n echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers\n\n# build / test / install QBDI\nARG CMAKE_ARGUMENT=\"\"\n\n# git archive -o qbdi.tar.gz --prefix=qbdi/ HEAD .\nADD qbdi.tar.gz $HOME/\n\nWORKDIR $HOME/qbdi\n\nRUN chown -R $USER:$USER .\n\n# switch to new user\nUSER $USER\n\nRUN mkdir build && \\\n cd build && \\\n cmake -G Ninja \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DCMAKE_CROSSCOMPILING=FALSE \\\n -DQBDI_PLATFORM=$QBDI_PLATFORM \\\n -DQBDI_ARCH=$QBDI_ARCH \\\n -DCMAKE_INSTALL_PREFIX=$PREFIX \\\n -DQBDI_CCACHE=OFF \\\n -DQBDI_LOG_DEBUG=ON \\\n -DQBDI_EXAMPLES=ON \\\n -DQBDI_TOOLS_PYQBDI=ON \\\n -DQBDI_TOOLS_VALIDATOR=ON \\\n $CMAKE_ARGUMENT \\\n ../ && \\\n ninja && \\\n # test\n ./test/QBDITest && \\\n # create package and install\n rm -f QBDI-*-$QBDI_PLATFORM.deb && \\\n cpack -G DEB && \\\n sudo dpkg -i QBDI-*-$QBDI_PLATFORM-$QBDI_ARCH.deb\n\nWORKDIR $HOME\n\nCMD [\"/bin/bash\"]\n" }, { "path": "docker/ubuntu_debian_devel/build.sh", "content": "#!/usr/bin/bash\n\nset -e\n\nBASEDIR=$(cd $(dirname \"$0\") && pwd -P)\nGITDIR=$(git rev-parse --show-toplevel)\n\n. \"${BASEDIR}/../common.sh\"\n\nARCH=\"X86_64\"\nDOCKER_IMG=\"ubuntu\"\nTAG=\"latest\"\nDOCKER_PLATFORM=\"linux/amd64\"\n\nif [[ -n \"$2\" ]]; then\n TAG=\"${2##*:}\"\n DOCKER_IMG=\"${2%%:*}\"\nfi\n\nif [[ \"$1\" = \"X86\" || \"$1\" = \"x86\" ]]; then\n ARCH=\"X86\"\n DOCKER_IMG=\"i386/$DOCKER_IMG\"\n DOCKER_PLATFORM=\"linux/386\"\nelif [[ \"$1\" = \"ARM\" ]] || [[ \"$1\" = \"arm\" ]] || [[ \"$1\" = \"arm32\" ]]; then\n ARCH=\"ARM\"\n DOCKER_IMG=\"arm32v7/$DOCKER_IMG\"\n DOCKER_PLATFORM=\"linux/arm/v7\"\nelif [[ \"$1\" = \"AARCH64\" ]] || [[ \"$1\" = \"aarch64\" ]] || [[ \"$1\" = \"arm64\" ]]; then\n ARCH=\"AARCH64\"\n DOCKER_IMG=\"arm64v8/$DOCKER_IMG\"\n DOCKER_PLATFORM=\"linux/arm64/v8\"\nfi\n\nCMAKE_ARGUMENT=\"$3\"\n\nDISTRIB=\"${DOCKER_IMG##*/}\"\n\nDOCKER_TAG=\"qbdi:${ARCH}_${DOCKER_IMG##*/}_${TAG}_devel\"\n\nDOCKERFILE=\"${BASEDIR}/Dockerfile\"\n\nprepare_archive\n\ndocker build \"${BASEDIR}\" -t \"${DOCKER_TAG}\" \\\n --platform=\"$DOCKER_PLATFORM\" \\\n --build-arg DOCKER_IMG=\"${DOCKER_IMG}:${TAG}\" \\\n --build-arg QBDI_ARCH=\"$ARCH\" \\\n --build-arg CMAKE_ARGUMENT=\"$CMAKE_ARGUMENT\"\n\ndelete_archive\n\necho \"Success build ${DOCKER_TAG}\"\n" }, { "path": "docs/CMakeLists.txt", "content": "configure_file(qbdi_cpp.doxygen.in ${CMAKE_CURRENT_BINARY_DIR}/qbdi_cpp.doxygen\n @ONLY)\nconfigure_file(qbdi_c.doxygen.in ${CMAKE_CURRENT_BINARY_DIR}/qbdi_c.doxygen\n @ONLY)\nconfigure_file(qbdipreload.doxygen.in\n ${CMAKE_CURRENT_BINARY_DIR}/qbdipreload.doxygen @ONLY)\n\nadd_custom_target(docs DEPENDS docs-doxygen docs-sphinx)\n\nadd_custom_target(\n docs-doxygen\n WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}\n COMMAND doxygen qbdi_cpp.doxygen\n COMMAND doxygen qbdi_c.doxygen\n COMMAND doxygen qbdipreload.doxygen)\n\nadd_custom_target(\n docs-install-jsdoc\n WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}\n COMMAND npm install jsdoc)\n\nexecute_process(COMMAND npm install jsdoc\n WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})\nexecute_process(\n COMMAND npm root\n WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}\n OUTPUT_VARIABLE NPM_JSDOC_ROOT\n OUTPUT_STRIP_TRAILING_WHITESPACE)\n\nadd_custom_target(\n docs-sphinx\n WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/source\n DEPENDS docs-doxygen pyqbdi\n COMMAND\n ${CMAKE_COMMAND} -E env\n \"PYTHONPATH=${PROJECT_BINARY_DIR}/docs:$ENV{PYTHONPATH}\"\n \"SPHINX_JS_NODE_MODULES=${NPM_JSDOC_ROOT}\"\n \"QBDI_DOXYGEN_DIRS=${CMAKE_CURRENT_BINARY_DIR}\" sphinx-build -a -b html .\n \"${CMAKE_CURRENT_BINARY_DIR}/build\")\n\nadd_custom_target(\n docs-sphinx-fast\n WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/source\n DEPENDS pyqbdi\n COMMAND\n ${CMAKE_COMMAND} -E env\n \"PYTHONPATH=${PROJECT_BINARY_DIR}/docs:$ENV{PYTHONPATH}\"\n \"QBDI_DOXYGEN_DIRS=${CMAKE_CURRENT_BINARY_DIR}\" sphinx-build -a -b html .\n \"${CMAKE_CURRENT_BINARY_DIR}/build\")\n" }, { "path": "docs/qbdi_c.doxygen.in", "content": "# Doxyfile 1.9.2\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org) for a project.\n#\n# All text after a double hash (##) is considered a comment and is placed in\n# front of the TAG it is preceding.\n#\n# All text after a single hash (#) is considered a comment and will be ignored.\n# The format is:\n# TAG = value [value, ...]\n# For lists, items can also be appended using:\n# TAG += value [value, ...]\n# Values that contain spaces should be placed between quotes (\\\" \\\").\n\n#---------------------------------------------------------------------------\n# Project related configuration options\n#---------------------------------------------------------------------------\n\n# This tag specifies the encoding used for all characters in the configuration\n# file that follow. The default is UTF-8 which is also the encoding used for all\n# text before the first occurrence of this tag. Doxygen uses libiconv (or the\n# iconv built into libc) for the transcoding. See\n# https://www.gnu.org/software/libiconv/ for the list of possible encodings.\n# The default value is: UTF-8.\n\nDOXYFILE_ENCODING = UTF-8\n\n# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by\n# double-quotes, unless you are using Doxywizard) that should identify the\n# project for which the documentation is generated. This name is used in the\n# title of most generated pages and in a few other places.\n# The default value is: My Project.\n\nPROJECT_NAME = QBDI\n\n# The PROJECT_NUMBER tag can be used to enter a project or revision number. This\n# could be handy for archiving the generated documentation or if some version\n# control system is used.\n\nPROJECT_NUMBER = @QBDI_VERSION_MAJOR@.@QBDI_VERSION_MINOR@.@QBDI_VERSION_PATCH@\n\n# Using the PROJECT_BRIEF tag one can provide an optional one line description\n# for a project that appears at the top of each page and should give viewer a\n# quick idea about the purpose of the project. Keep the description short.\n\nPROJECT_BRIEF =\n\n# With the PROJECT_LOGO tag one can specify a logo or an icon that is included\n# in the documentation. The maximum height of the logo should not exceed 55\n# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy\n# the logo to the output directory.\n\nPROJECT_LOGO =\n\n# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path\n# into which the generated documentation will be written. If a relative path is\n# entered, it will be relative to the location where doxygen was started. If\n# left blank the current directory will be used.\n\nOUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/doxygen_c\n\n# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-\n# directories (in 2 levels) under the output directory of each output format and\n# will distribute the generated files over these directories. Enabling this\n# option can be useful when feeding doxygen a huge amount of source files, where\n# putting all generated files in the same directory would otherwise causes\n# performance problems for the file system.\n# The default value is: NO.\n\nCREATE_SUBDIRS = NO\n\n# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII\n# characters to appear in the names of generated files. If set to NO, non-ASCII\n# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode\n# U+3044.\n# The default value is: NO.\n\nALLOW_UNICODE_NAMES = NO\n\n# The OUTPUT_LANGUAGE tag is used to specify the language in which all\n# documentation generated by doxygen is written. Doxygen will use this\n# information to generate all constant output in the proper language.\n# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,\n# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),\n# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,\n# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),\n# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,\n# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,\n# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,\n# Ukrainian and Vietnamese.\n# The default value is: English.\n\nOUTPUT_LANGUAGE = English\n\n# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member\n# descriptions after the members that are listed in the file and class\n# documentation (similar to Javadoc). Set to NO to disable this.\n# The default value is: YES.\n\nBRIEF_MEMBER_DESC = YES\n\n# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief\n# description of a member or function before the detailed description\n#\n# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\n# brief descriptions will be completely suppressed.\n# The default value is: YES.\n\nREPEAT_BRIEF = YES\n\n# This tag implements a quasi-intelligent brief description abbreviator that is\n# used to form the text in various listings. Each string in this list, if found\n# as the leading text of the brief description, will be stripped from the text\n# and the result, after processing the whole list, is used as the annotated\n# text. Otherwise, the brief description is used as-is. If left blank, the\n# following values are used ($name is automatically replaced with the name of\n# the entity):The $name class, The $name widget, The $name file, is, provides,\n# specifies, contains, represents, a, an and the.\n\nABBREVIATE_BRIEF =\n\n# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\n# doxygen will generate a detailed section even if there is only a brief\n# description.\n# The default value is: NO.\n\nALWAYS_DETAILED_SEC = NO\n\n# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all\n# inherited members of a class in the documentation of that class as if those\n# members were ordinary class members. Constructors, destructors and assignment\n# operators of the base classes will not be shown.\n# The default value is: NO.\n\nINLINE_INHERITED_MEMB = NO\n\n# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path\n# before files name in the file list and in the header files. If set to NO the\n# shortest path that makes the file name unique will be used\n# The default value is: YES.\n\nFULL_PATH_NAMES = YES\n\n# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.\n# Stripping is only done if one of the specified strings matches the left-hand\n# part of the path. The tag can be used to show relative paths in the file list.\n# If left blank the directory from which doxygen is run is used as the path to\n# strip.\n#\n# Note that you can specify absolute paths here, but also relative paths, which\n# will be relative from the directory where doxygen is started.\n# This tag requires that the tag FULL_PATH_NAMES is set to YES.\n\nSTRIP_FROM_PATH =\n\n# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the\n# path mentioned in the documentation of a class, which tells the reader which\n# header file to include in order to use a class. If left blank only the name of\n# the header file containing the class definition is used. Otherwise one should\n# specify the list of include paths that are normally passed to the compiler\n# using the -I flag.\n\nSTRIP_FROM_INC_PATH =\n\n# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but\n# less readable) file names. This can be useful is your file systems doesn't\n# support long names like on DOS, Mac, or CD-ROM.\n# The default value is: NO.\n\nSHORT_NAMES = NO\n\n# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the\n# first line (until the first dot) of a Javadoc-style comment as the brief\n# description. If set to NO, the Javadoc-style will behave just like regular Qt-\n# style comments (thus requiring an explicit @brief command for a brief\n# description.)\n# The default value is: NO.\n\nJAVADOC_AUTOBRIEF = NO\n\n# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line\n# such as\n# /***************\n# as being the beginning of a Javadoc-style comment \"banner\". If set to NO, the\n# Javadoc-style will behave just like regular comments and it will not be\n# interpreted by doxygen.\n# The default value is: NO.\n\nJAVADOC_BANNER = NO\n\n# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first\n# line (until the first dot) of a Qt-style comment as the brief description. If\n# set to NO, the Qt-style will behave just like regular Qt-style comments (thus\n# requiring an explicit \\brief command for a brief description.)\n# The default value is: NO.\n\nQT_AUTOBRIEF = NO\n\n# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a\n# multi-line C++ special comment block (i.e. a block of //! or /// comments) as\n# a brief description. This used to be the default behavior. The new default is\n# to treat a multi-line C++ comment block as a detailed description. Set this\n# tag to YES if you prefer the old behavior instead.\n#\n# Note that setting this tag to YES also means that rational rose comments are\n# not recognized any more.\n# The default value is: NO.\n\nMULTILINE_CPP_IS_BRIEF = NO\n\n# By default Python docstrings are displayed as preformatted text and doxygen's\n# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the\n# doxygen's special commands can be used and the contents of the docstring\n# documentation blocks is shown as doxygen documentation.\n# The default value is: YES.\n\nPYTHON_DOCSTRING = YES\n\n# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the\n# documentation from any documented member that it re-implements.\n# The default value is: YES.\n\nINHERIT_DOCS = YES\n\n# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new\n# page for each member. If set to NO, the documentation of a member will be part\n# of the file/class/namespace that contains it.\n# The default value is: NO.\n\nSEPARATE_MEMBER_PAGES = NO\n\n# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen\n# uses this value to replace tabs by spaces in code fragments.\n# Minimum value: 1, maximum value: 16, default value: 4.\n\nTAB_SIZE = 4\n\n# This tag can be used to specify a number of aliases that act as commands in\n# the documentation. An alias has the form:\n# name=value\n# For example adding\n# \"sideeffect=@par Side Effects:^^\"\n# will allow you to put the command \\sideeffect (or @sideeffect) in the\n# documentation, which will result in a user-defined paragraph with heading\n# \"Side Effects:\". Note that you cannot put \\n's in the value part of an alias\n# to insert newlines (in the resulting output). You can put ^^ in the value part\n# of an alias to insert a newline as if a physical newline was in the original\n# file. When you need a literal { or } or , in the value part of an alias you\n# have to escape them by means of a backslash (\\), this can lead to conflicts\n# with the commands \\{ and \\} for these it is advised to use the version @{ and\n# @} or use a double escape (\\\\{ and \\\\})\n\nALIASES =\n\n# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources\n# only. Doxygen will then generate output that is more tailored for C. For\n# instance, some of the names that are used will be different. The list of all\n# members will be omitted, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_FOR_C = NO\n\n# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or\n# Python sources only. Doxygen will then generate output that is more tailored\n# for that language. For instance, namespaces will be presented as packages,\n# qualified scopes will look different, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_JAVA = NO\n\n# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\n# sources. Doxygen will then generate output that is tailored for Fortran.\n# The default value is: NO.\n\nOPTIMIZE_FOR_FORTRAN = NO\n\n# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\n# sources. Doxygen will then generate output that is tailored for VHDL.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_VHDL = NO\n\n# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice\n# sources only. Doxygen will then generate output that is more tailored for that\n# language. For instance, namespaces will be presented as modules, types will be\n# separated into more groups, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_SLICE = NO\n\n# Doxygen selects the parser to use depending on the extension of the files it\n# parses. With this tag you can assign which parser to use for a given\n# extension. Doxygen has a built-in mapping, but you can override or extend it\n# using this tag. The format is ext=language, where ext is a file extension, and\n# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,\n# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,\n# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:\n# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser\n# tries to guess whether the code is fixed or free formatted code, this is the\n# default for Fortran type files). For instance to make doxygen treat .inc files\n# as Fortran files (default is PHP), and .f files as C (default is Fortran),\n# use: inc=Fortran f=C.\n#\n# Note: For files without extension you can use no_extension as a placeholder.\n#\n# Note that for custom extensions you also need to set FILE_PATTERNS otherwise\n# the files are not read by doxygen. When specifying no_extension you should add\n# * to the FILE_PATTERNS.\n#\n# Note see also the list of default file extension mappings.\n\nEXTENSION_MAPPING = in=C\n\n# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments\n# according to the Markdown format, which allows for more readable\n# documentation. See https://daringfireball.net/projects/markdown/ for details.\n# The output of markdown processing is further processed by doxygen, so you can\n# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in\n# case of backward compatibilities issues.\n# The default value is: YES.\n\nMARKDOWN_SUPPORT = YES\n\n# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up\n# to that level are automatically included in the table of contents, even if\n# they do not have an id attribute.\n# Note: This feature currently applies only to Markdown headings.\n# Minimum value: 0, maximum value: 99, default value: 5.\n# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.\n\nTOC_INCLUDE_HEADINGS = 5\n\n# When enabled doxygen tries to link words that correspond to documented\n# classes, or namespaces to their corresponding documentation. Such a link can\n# be prevented in individual cases by putting a % sign in front of the word or\n# globally by setting AUTOLINK_SUPPORT to NO.\n# The default value is: YES.\n\nAUTOLINK_SUPPORT = YES\n\n# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n# to include (a tag file for) the STL sources as input, then you should set this\n# tag to YES in order to let doxygen match functions declarations and\n# definitions whose arguments contain STL classes (e.g. func(std::string);\n# versus func(std::string) {}). This also make the inheritance and collaboration\n# diagrams that involve STL classes more complete and accurate.\n# The default value is: NO.\n\nBUILTIN_STL_SUPPORT = YES\n\n# If you use Microsoft's C++/CLI language, you should set this option to YES to\n# enable parsing support.\n# The default value is: NO.\n\nCPP_CLI_SUPPORT = NO\n\n# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:\n# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen\n# will parse them like normal C++ but will assume all classes use public instead\n# of private inheritance when no explicit protection keyword is present.\n# The default value is: NO.\n\nSIP_SUPPORT = NO\n\n# For Microsoft's IDL there are propget and propput attributes to indicate\n# getter and setter methods for a property. Setting this option to YES will make\n# doxygen to replace the get and set methods by a property in the documentation.\n# This will only work if the methods are indeed getting or setting a simple\n# type. If this is not the case, or you want to show the methods anyway, you\n# should set this option to NO.\n# The default value is: YES.\n\nIDL_PROPERTY_SUPPORT = YES\n\n# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC\n# tag is set to YES then doxygen will reuse the documentation of the first\n# member in the group (if any) for the other members of the group. By default\n# all members of a group must be documented explicitly.\n# The default value is: NO.\n\nDISTRIBUTE_GROUP_DOC = NO\n\n# If one adds a struct or class to a group and this option is enabled, then also\n# any nested class or struct is added to the same group. By default this option\n# is disabled and one has to add nested compounds explicitly via \\ingroup.\n# The default value is: NO.\n\nGROUP_NESTED_COMPOUNDS = NO\n\n# Set the SUBGROUPING tag to YES to allow class member groups of the same type\n# (for instance a group of public functions) to be put as a subgroup of that\n# type (e.g. under the Public Functions section). Set it to NO to prevent\n# subgrouping. Alternatively, this can be done per class using the\n# \\nosubgrouping command.\n# The default value is: YES.\n\nSUBGROUPING = YES\n\n# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions\n# are shown inside the group in which they are included (e.g. using \\ingroup)\n# instead of on a separate page (for HTML and Man pages) or section (for LaTeX\n# and RTF).\n#\n# Note that this feature does not work in combination with\n# SEPARATE_MEMBER_PAGES.\n# The default value is: NO.\n\nINLINE_GROUPED_CLASSES = NO\n\n# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions\n# with only public data fields or simple typedef fields will be shown inline in\n# the documentation of the scope in which they are defined (i.e. file,\n# namespace, or group documentation), provided this scope is documented. If set\n# to NO, structs, classes, and unions are shown on a separate page (for HTML and\n# Man pages) or section (for LaTeX and RTF).\n# The default value is: NO.\n\nINLINE_SIMPLE_STRUCTS = NO\n\n# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or\n# enum is documented as struct, union, or enum with the name of the typedef. So\n# typedef struct TypeS {} TypeT, will appear in the documentation as a struct\n# with name TypeT. When disabled the typedef will appear as a member of a file,\n# namespace, or class. And the struct will be named TypeS. This can typically be\n# useful for C code in case the coding convention dictates that all compound\n# types are typedef'ed and only the typedef is referenced, never the tag name.\n# The default value is: NO.\n\nTYPEDEF_HIDES_STRUCT = NO\n\n# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This\n# cache is used to resolve symbols given their name and scope. Since this can be\n# an expensive process and often the same symbol appears multiple times in the\n# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small\n# doxygen will become slower. If the cache is too large, memory is wasted. The\n# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range\n# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536\n# symbols. At the end of a run doxygen will report the cache usage and suggest\n# the optimal cache size from a speed point of view.\n# Minimum value: 0, maximum value: 9, default value: 0.\n\nLOOKUP_CACHE_SIZE = 0\n\n# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use\n# during processing. When set to 0 doxygen will based this on the number of\n# cores available in the system. You can set it explicitly to a value larger\n# than 0 to get more control over the balance between CPU load and processing\n# speed. At this moment only the input processing can be done using multiple\n# threads. Since this is still an experimental feature the default is set to 1,\n# which effectively disables parallel processing. Please report any issues you\n# encounter. Generating dot graphs in parallel is controlled by the\n# DOT_NUM_THREADS setting.\n# Minimum value: 0, maximum value: 32, default value: 1.\n\nNUM_PROC_THREADS = 1\n\n#---------------------------------------------------------------------------\n# Build related configuration options\n#---------------------------------------------------------------------------\n\n# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in\n# documentation are documented, even if no documentation was available. Private\n# class members and static file members will be hidden unless the\n# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.\n# Note: This will also disable the warnings about undocumented members that are\n# normally produced when WARNINGS is set to YES.\n# The default value is: NO.\n\nEXTRACT_ALL = YES\n\n# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will\n# be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIVATE = YES\n\n# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual\n# methods of a class will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIV_VIRTUAL = NO\n\n# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal\n# scope will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PACKAGE = NO\n\n# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be\n# included in the documentation.\n# The default value is: NO.\n\nEXTRACT_STATIC = YES\n\n# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined\n# locally in source files will be included in the documentation. If set to NO,\n# only classes defined in header files are included. Does not have any effect\n# for Java sources.\n# The default value is: YES.\n\nEXTRACT_LOCAL_CLASSES = YES\n\n# This flag is only useful for Objective-C code. If set to YES, local methods,\n# which are defined in the implementation section but not in the interface are\n# included in the documentation. If set to NO, only methods in the interface are\n# included.\n# The default value is: NO.\n\nEXTRACT_LOCAL_METHODS = NO\n\n# If this flag is set to YES, the members of anonymous namespaces will be\n# extracted and appear in the documentation as a namespace called\n# 'anonymous_namespace{file}', where file will be replaced with the base name of\n# the file that contains the anonymous namespace. By default anonymous namespace\n# are hidden.\n# The default value is: NO.\n\nEXTRACT_ANON_NSPACES = NO\n\n# If this flag is set to YES, the name of an unnamed parameter in a declaration\n# will be determined by the corresponding definition. By default unnamed\n# parameters remain unnamed in the output.\n# The default value is: YES.\n\nRESOLVE_UNNAMED_PARAMS = YES\n\n# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all\n# undocumented members inside documented classes or files. If set to NO these\n# members will be included in the various overviews, but no documentation\n# section is generated. This option has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_MEMBERS = NO\n\n# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all\n# undocumented classes that are normally visible in the class hierarchy. If set\n# to NO, these classes will be included in the various overviews. This option\n# has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_CLASSES = NO\n\n# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend\n# declarations. If set to NO, these declarations will be included in the\n# documentation.\n# The default value is: NO.\n\nHIDE_FRIEND_COMPOUNDS = NO\n\n# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any\n# documentation blocks found inside the body of a function. If set to NO, these\n# blocks will be appended to the function's detailed documentation block.\n# The default value is: NO.\n\nHIDE_IN_BODY_DOCS = NO\n\n# The INTERNAL_DOCS tag determines if documentation that is typed after a\n# \\internal command is included. If the tag is set to NO then the documentation\n# will be excluded. Set it to YES to include the internal documentation.\n# The default value is: NO.\n\nINTERNAL_DOCS = NO\n\n# With the correct setting of option CASE_SENSE_NAMES doxygen will better be\n# able to match the capabilities of the underlying filesystem. In case the\n# filesystem is case sensitive (i.e. it supports files in the same directory\n# whose names only differ in casing), the option must be set to YES to properly\n# deal with such files in case they appear in the input. For filesystems that\n# are not case sensitive the option should be be set to NO to properly deal with\n# output files written for symbols that only differ in casing, such as for two\n# classes, one named CLASS and the other named Class, and to also support\n# references to files without having to specify the exact matching casing. On\n# Windows (including Cygwin) and MacOS, users should typically set this option\n# to NO, whereas on Linux or other Unix flavors it should typically be set to\n# YES.\n# The default value is: system dependent.\n\nCASE_SENSE_NAMES = YES\n\n# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with\n# their full class and namespace scopes in the documentation. If set to YES, the\n# scope will be hidden.\n# The default value is: NO.\n\nHIDE_SCOPE_NAMES = NO\n\n# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will\n# append additional text to a page's title, such as Class Reference. If set to\n# YES the compound reference will be hidden.\n# The default value is: NO.\n\nHIDE_COMPOUND_REFERENCE= NO\n\n# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class\n# will show which file needs to be included to use the class.\n# The default value is: YES.\n\nSHOW_HEADERFILE = YES\n\n# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of\n# the files that are included by a file in the documentation of that file.\n# The default value is: YES.\n\nSHOW_INCLUDE_FILES = YES\n\n# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each\n# grouped member an include statement to the documentation, telling the reader\n# which file to include in order to use the member.\n# The default value is: NO.\n\nSHOW_GROUPED_MEMB_INC = NO\n\n# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include\n# files with double quotes in the documentation rather than with sharp brackets.\n# The default value is: NO.\n\nFORCE_LOCAL_INCLUDES = NO\n\n# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the\n# documentation for inline members.\n# The default value is: YES.\n\nINLINE_INFO = YES\n\n# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the\n# (detailed) documentation of file and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order.\n# The default value is: YES.\n\nSORT_MEMBER_DOCS = YES\n\n# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief\n# descriptions of file, namespace and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order. Note that\n# this will also influence the order of the classes in the class list.\n# The default value is: NO.\n\nSORT_BRIEF_DOCS = NO\n\n# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the\n# (brief and detailed) documentation of class members so that constructors and\n# destructors are listed first. If set to NO the constructors will appear in the\n# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.\n# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief\n# member documentation.\n# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting\n# detailed member documentation.\n# The default value is: NO.\n\nSORT_MEMBERS_CTORS_1ST = NO\n\n# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy\n# of group names into alphabetical order. If set to NO the group names will\n# appear in their defined order.\n# The default value is: NO.\n\nSORT_GROUP_NAMES = NO\n\n# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by\n# fully-qualified names, including namespaces. If set to NO, the class list will\n# be sorted only by class name, not including the namespace part.\n# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\n# Note: This option applies only to the class list, not to the alphabetical\n# list.\n# The default value is: NO.\n\nSORT_BY_SCOPE_NAME = NO\n\n# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper\n# type resolution of all parameters of a function it will reject a match between\n# the prototype and the implementation of a member function even if there is\n# only one candidate or it is obvious which candidate to choose by doing a\n# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still\n# accept a match between prototype and implementation in such cases.\n# The default value is: NO.\n\nSTRICT_PROTO_MATCHING = NO\n\n# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo\n# list. This list is created by putting \\todo commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TODOLIST = YES\n\n# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test\n# list. This list is created by putting \\test commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TESTLIST = YES\n\n# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug\n# list. This list is created by putting \\bug commands in the documentation.\n# The default value is: YES.\n\nGENERATE_BUGLIST = YES\n\n# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)\n# the deprecated list. This list is created by putting \\deprecated commands in\n# the documentation.\n# The default value is: YES.\n\nGENERATE_DEPRECATEDLIST= YES\n\n# The ENABLED_SECTIONS tag can be used to enable conditional documentation\n# sections, marked by \\if ... \\endif and \\cond \n# ... \\endcond blocks.\n\nENABLED_SECTIONS =\n\n# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the\n# initial value of a variable or macro / define can have for it to appear in the\n# documentation. If the initializer consists of more lines than specified here\n# it will be hidden. Use a value of 0 to hide initializers completely. The\n# appearance of the value of individual variables and macros / defines can be\n# controlled using \\showinitializer or \\hideinitializer command in the\n# documentation regardless of this setting.\n# Minimum value: 0, maximum value: 10000, default value: 30.\n\nMAX_INITIALIZER_LINES = 30\n\n# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at\n# the bottom of the documentation of classes and structs. If set to YES, the\n# list will mention the files that were used to generate the documentation.\n# The default value is: YES.\n\nSHOW_USED_FILES = YES\n\n# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This\n# will remove the Files entry from the Quick Index and from the Folder Tree View\n# (if specified).\n# The default value is: YES.\n\nSHOW_FILES = YES\n\n# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces\n# page. This will remove the Namespaces entry from the Quick Index and from the\n# Folder Tree View (if specified).\n# The default value is: YES.\n\nSHOW_NAMESPACES = YES\n\n# The FILE_VERSION_FILTER tag can be used to specify a program or script that\n# doxygen should invoke to get the current version for each file (typically from\n# the version control system). Doxygen will invoke the program by executing (via\n# popen()) the command command input-file, where command is the value of the\n# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided\n# by doxygen. Whatever the program writes to standard output is used as the file\n# version. For an example see the documentation.\n\nFILE_VERSION_FILTER =\n\n# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\n# by doxygen. The layout file controls the global structure of the generated\n# output files in an output format independent way. To create the layout file\n# that represents doxygen's defaults, run doxygen with the -l option. You can\n# optionally specify a file name after the option, if omitted DoxygenLayout.xml\n# will be used as the name of the layout file. See also section \"Changing the\n# layout of pages\" for information.\n#\n# Note that if you run doxygen from a directory containing a file called\n# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE\n# tag is left empty.\n\nLAYOUT_FILE =\n\n# The CITE_BIB_FILES tag can be used to specify one or more bib files containing\n# the reference definitions. This must be a list of .bib files. The .bib\n# extension is automatically appended if omitted. This requires the bibtex tool\n# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.\n# For LaTeX the style of the bibliography can be controlled using\n# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the\n# search path. See also \\cite for info how to create references.\n\nCITE_BIB_FILES =\n\n#---------------------------------------------------------------------------\n# Configuration options related to warning and progress messages\n#---------------------------------------------------------------------------\n\n# The QUIET tag can be used to turn on/off the messages that are generated to\n# standard output by doxygen. If QUIET is set to YES this implies that the\n# messages are off.\n# The default value is: NO.\n\nQUIET = NO\n\n# The WARNINGS tag can be used to turn on/off the warning messages that are\n# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES\n# this implies that the warnings are on.\n#\n# Tip: Turn warnings on while writing the documentation.\n# The default value is: YES.\n\nWARNINGS = YES\n\n# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate\n# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag\n# will automatically be disabled.\n# The default value is: YES.\n\nWARN_IF_UNDOCUMENTED = YES\n\n# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for\n# potential errors in the documentation, such as documenting some parameters in\n# a documented function twice, or documenting parameters that don't exist or\n# using markup commands wrongly.\n# The default value is: YES.\n\nWARN_IF_DOC_ERROR = YES\n\n# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete\n# function parameter documentation. If set to NO, doxygen will accept that some\n# parameters have no documentation without warning.\n# The default value is: YES.\n\nWARN_IF_INCOMPLETE_DOC = YES\n\n# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that\n# are documented, but have no documentation for their parameters or return\n# value. If set to NO, doxygen will only warn about wrong parameter\n# documentation, but not about the absence of documentation. If EXTRACT_ALL is\n# set to YES then this flag will automatically be disabled. See also\n# WARN_IF_INCOMPLETE_DOC\n# The default value is: NO.\n\nWARN_NO_PARAMDOC = NO\n\n# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when\n# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS\n# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but\n# at the end of the doxygen process doxygen will return with a non-zero status.\n# Possible values are: NO, YES and FAIL_ON_WARNINGS.\n# The default value is: NO.\n\nWARN_AS_ERROR = NO\n\n# The WARN_FORMAT tag determines the format of the warning messages that doxygen\n# can produce. The string should contain the $file, $line, and $text tags, which\n# will be replaced by the file and line number from which the warning originated\n# and the warning text. Optionally the format may contain $version, which will\n# be replaced by the version of the file (if it could be obtained via\n# FILE_VERSION_FILTER)\n# The default value is: $file:$line: $text.\n\nWARN_FORMAT = \"$file:$line: $text\"\n\n# The WARN_LOGFILE tag can be used to specify a file to which warning and error\n# messages should be written. If left blank the output is written to standard\n# error (stderr).\n\nWARN_LOGFILE =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the input files\n#---------------------------------------------------------------------------\n\n# The INPUT tag is used to specify the files and/or directories that contain\n# documented source files. You may enter file names like myfile.cpp or\n# directories like /usr/src/myproject. Separate the files or directories with\n# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING\n# Note: If this tag is empty the current directory is searched.\n\nINPUT = @CMAKE_CURRENT_SOURCE_DIR@/../include \\\n @CMAKE_CURRENT_BINARY_DIR@/../include\n\n# This tag can be used to specify the character encoding of the source files\n# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses\n# libiconv (or the iconv built into libc) for the transcoding. See the libiconv\n# documentation (see:\n# https://www.gnu.org/software/libiconv/) for the list of possible encodings.\n# The default value is: UTF-8.\n\nINPUT_ENCODING = UTF-8\n\n# If the value of the INPUT tag contains directories, you can use the\n# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and\n# *.h) to filter out the source-files in the directories.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# read by doxygen.\n#\n# Note the list of default checked file patterns might differ from the list of\n# default file extension mappings.\n#\n# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,\n# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,\n# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,\n# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C\n# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,\n# *.vhdl, *.ucf, *.qsf and *.ice.\n\nFILE_PATTERNS = *.c \\\n *.cpp \\\n *.h \\\n *.hpp\n\n# The RECURSIVE tag can be used to specify whether or not subdirectories should\n# be searched for input files as well.\n# The default value is: NO.\n\nRECURSIVE = YES\n\n# The EXCLUDE tag can be used to specify files and/or directories that should be\n# excluded from the INPUT source files. This way you can easily exclude a\n# subdirectory from a directory tree whose root is specified with the INPUT tag.\n#\n# Note that relative paths are relative to the directory from which doxygen is\n# run.\n\nEXCLUDE = @CMAKE_CURRENT_SOURCE_DIR@/../include/QBDI/VM.h \\\n @CMAKE_CURRENT_SOURCE_DIR@/../include/QBDI/Memory.hpp \\\n @CMAKE_CURRENT_SOURCE_DIR@/../include/QBDI/arch\n\n# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\n# directories that are symbolic links (a Unix file system feature) are excluded\n# from the input.\n# The default value is: NO.\n\nEXCLUDE_SYMLINKS = NO\n\n# If the value of the INPUT tag contains directories, you can use the\n# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude\n# certain files from those directories.\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories for example use the pattern */test/*\n\nEXCLUDE_PATTERNS =\n\n# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names\n# (namespaces, classes, functions, etc.) that should be excluded from the\n# output. The symbol name can be a fully qualified name, a word, or if the\n# wildcard * is used, a substring. Examples: ANamespace, AClass,\n# AClass::ANamespace, ANamespace::*Test\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories use the pattern */test/*\n\nEXCLUDE_SYMBOLS =\n\n# The EXAMPLE_PATH tag can be used to specify one or more files or directories\n# that contain example code fragments that are included (see the \\include\n# command).\n\nEXAMPLE_PATH =\n\n# If the value of the EXAMPLE_PATH tag contains directories, you can use the\n# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and\n# *.h) to filter out the source-files in the directories. If left blank all\n# files are included.\n\nEXAMPLE_PATTERNS =\n\n# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\n# searched for input files to be used with the \\include or \\dontinclude commands\n# irrespective of the value of the RECURSIVE tag.\n# The default value is: NO.\n\nEXAMPLE_RECURSIVE = NO\n\n# The IMAGE_PATH tag can be used to specify one or more files or directories\n# that contain images that are to be included in the documentation (see the\n# \\image command).\n\nIMAGE_PATH =\n\n# The INPUT_FILTER tag can be used to specify a program that doxygen should\n# invoke to filter for each input file. Doxygen will invoke the filter program\n# by executing (via popen()) the command:\n#\n# \n#\n# where is the value of the INPUT_FILTER tag, and is the\n# name of an input file. Doxygen will then use the output that the filter\n# program writes to standard output. If FILTER_PATTERNS is specified, this tag\n# will be ignored.\n#\n# Note that the filter must not add or remove lines; it is applied before the\n# code is scanned, but not when the output code is generated. If lines are added\n# or removed, the anchors will not be placed correctly.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nINPUT_FILTER =\n\n# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\n# basis. Doxygen will compare the file name with each pattern and apply the\n# filter if there is a match. The filters are a list of the form: pattern=filter\n# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how\n# filters are used. If the FILTER_PATTERNS tag is empty or if none of the\n# patterns match the file name, INPUT_FILTER is applied.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nFILTER_PATTERNS =\n\n# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\n# INPUT_FILTER) will also be used to filter the input files that are used for\n# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).\n# The default value is: NO.\n\nFILTER_SOURCE_FILES = NO\n\n# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\n# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and\n# it is also possible to disable source filtering for a specific pattern using\n# *.ext= (so without naming a filter).\n# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.\n\nFILTER_SOURCE_PATTERNS =\n\n# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that\n# is part of the input, its contents will be placed on the main page\n# (index.html). This can be useful if you have a project on for instance GitHub\n# and want to reuse the introduction page also for the doxygen output.\n\nUSE_MDFILE_AS_MAINPAGE =\n\n#---------------------------------------------------------------------------\n# Configuration options related to source browsing\n#---------------------------------------------------------------------------\n\n# If the SOURCE_BROWSER tag is set to YES then a list of source files will be\n# generated. Documented entities will be cross-referenced with these sources.\n#\n# Note: To get rid of all source code in the generated output, make sure that\n# also VERBATIM_HEADERS is set to NO.\n# The default value is: NO.\n\nSOURCE_BROWSER = NO\n\n# Setting the INLINE_SOURCES tag to YES will include the body of functions,\n# classes and enums directly into the documentation.\n# The default value is: NO.\n\nINLINE_SOURCES = NO\n\n# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any\n# special comment blocks from generated source code fragments. Normal C, C++ and\n# Fortran comments will always remain visible.\n# The default value is: YES.\n\nSTRIP_CODE_COMMENTS = YES\n\n# If the REFERENCED_BY_RELATION tag is set to YES then for each documented\n# entity all documented functions referencing it will be listed.\n# The default value is: NO.\n\nREFERENCED_BY_RELATION = NO\n\n# If the REFERENCES_RELATION tag is set to YES then for each documented function\n# all documented entities called/used by that function will be listed.\n# The default value is: NO.\n\nREFERENCES_RELATION = NO\n\n# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set\n# to YES then the hyperlinks from functions in REFERENCES_RELATION and\n# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will\n# link to the documentation.\n# The default value is: YES.\n\nREFERENCES_LINK_SOURCE = YES\n\n# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the\n# source code will show a tooltip with additional information such as prototype,\n# brief description and links to the definition and documentation. Since this\n# will make the HTML file larger and loading of large files a bit slower, you\n# can opt to disable this feature.\n# The default value is: YES.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nSOURCE_TOOLTIPS = YES\n\n# If the USE_HTAGS tag is set to YES then the references to source code will\n# point to the HTML generated by the htags(1) tool instead of doxygen built-in\n# source browser. The htags tool is part of GNU's global source tagging system\n# (see https://www.gnu.org/software/global/global.html). You will need version\n# 4.8.6 or higher.\n#\n# To use it do the following:\n# - Install the latest version of global\n# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file\n# - Make sure the INPUT points to the root of the source tree\n# - Run doxygen as normal\n#\n# Doxygen will invoke htags (and that will in turn invoke gtags), so these\n# tools must be available from the command line (i.e. in the search path).\n#\n# The result: instead of the source browser generated by doxygen, the links to\n# source code will now point to the output of htags.\n# The default value is: NO.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nUSE_HTAGS = NO\n\n# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a\n# verbatim copy of the header file for each class for which an include is\n# specified. Set to NO to disable this.\n# See also: Section \\class.\n# The default value is: YES.\n\nVERBATIM_HEADERS = YES\n\n#---------------------------------------------------------------------------\n# Configuration options related to the alphabetical class index\n#---------------------------------------------------------------------------\n\n# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all\n# compounds will be generated. Enable this if the project contains a lot of\n# classes, structs, unions or interfaces.\n# The default value is: YES.\n\nALPHABETICAL_INDEX = YES\n\n# In case all classes in a project start with a common prefix, all classes will\n# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag\n# can be used to specify a prefix (or a list of prefixes) that should be ignored\n# while generating the index headers.\n# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\n\nIGNORE_PREFIX =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the HTML output\n#---------------------------------------------------------------------------\n\n# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output\n# The default value is: YES.\n\nGENERATE_HTML = NO\n\n# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a\n# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n# it.\n# The default directory is: html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_OUTPUT = html\n\n# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each\n# generated HTML page (for example: .htm, .php, .asp).\n# The default value is: .html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FILE_EXTENSION = .html\n\n# The HTML_HEADER tag can be used to specify a user-defined HTML header file for\n# each generated HTML page. If the tag is left blank doxygen will generate a\n# standard header.\n#\n# To get valid HTML the header file that includes any scripts and style sheets\n# that doxygen needs, which is dependent on the configuration options used (e.g.\n# the setting GENERATE_TREEVIEW). It is highly recommended to start with a\n# default header using\n# doxygen -w html new_header.html new_footer.html new_stylesheet.css\n# YourConfigFile\n# and then modify the file new_header.html. See also section \"Doxygen usage\"\n# for information on how to generate the default header that doxygen normally\n# uses.\n# Note: The header is subject to change so you typically have to regenerate the\n# default header when upgrading to a newer version of doxygen. For a description\n# of the possible markers and block names see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_HEADER =\n\n# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each\n# generated HTML page. If the tag is left blank doxygen will generate a standard\n# footer. See HTML_HEADER for more information on how to generate a default\n# footer and what special commands can be used inside the footer. See also\n# section \"Doxygen usage\" for information on how to generate the default footer\n# that doxygen normally uses.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FOOTER =\n\n# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style\n# sheet that is used by each HTML page. It can be used to fine-tune the look of\n# the HTML output. If left blank doxygen will generate a default style sheet.\n# See also section \"Doxygen usage\" for information on how to generate the style\n# sheet that doxygen normally uses.\n# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as\n# it is more robust and this tag (HTML_STYLESHEET) will in the future become\n# obsolete.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_STYLESHEET =\n\n# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined\n# cascading style sheets that are included after the standard style sheets\n# created by doxygen. Using this option one can overrule certain style aspects.\n# This is preferred over using HTML_STYLESHEET since it does not replace the\n# standard style sheet and is therefore more robust against future updates.\n# Doxygen will copy the style sheet files to the output directory.\n# Note: The order of the extra style sheet files is of importance (e.g. the last\n# style sheet in the list overrules the setting of the previous ones in the\n# list). For an example see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_STYLESHEET =\n\n# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\n# other source files which should be copied to the HTML output directory. Note\n# that these files will be copied to the base HTML output directory. Use the\n# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\n# files. In the HTML_STYLESHEET file, use the file name only. Also note that the\n# files will be copied as-is; there are no commands or markers available.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_FILES =\n\n# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen\n# will adjust the colors in the style sheet and background images according to\n# this color. Hue is specified as an angle on a color-wheel, see\n# https://en.wikipedia.org/wiki/Hue for more information. For instance the value\n# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300\n# purple, and 360 is red again.\n# Minimum value: 0, maximum value: 359, default value: 220.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_HUE = 220\n\n# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors\n# in the HTML output. For a value of 0 the output will use gray-scales only. A\n# value of 255 will produce the most vivid colors.\n# Minimum value: 0, maximum value: 255, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_SAT = 100\n\n# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the\n# luminance component of the colors in the HTML output. Values below 100\n# gradually make the output lighter, whereas values above 100 make the output\n# darker. The value divided by 100 is the actual gamma applied, so 80 represents\n# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not\n# change the gamma.\n# Minimum value: 40, maximum value: 240, default value: 80.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_GAMMA = 80\n\n# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\n# page will contain the date and time when the page was generated. Setting this\n# to YES can help to show when doxygen was last run and thus if the\n# documentation is up to date.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_TIMESTAMP = NO\n\n# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML\n# documentation will contain a main index with vertical navigation menus that\n# are dynamically created via JavaScript. If disabled, the navigation index will\n# consists of multiple levels of tabs that are statically embedded in every HTML\n# page. Disable this option to support browsers that do not have JavaScript,\n# like the Qt help browser.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_MENUS = YES\n\n# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\n# documentation will contain sections that can be hidden and shown after the\n# page has loaded.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_SECTIONS = NO\n\n# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries\n# shown in the various tree structured indices initially; the user can expand\n# and collapse entries dynamically later on. Doxygen will expand the tree to\n# such a level that at most the specified number of entries are visible (unless\n# a fully collapsed tree already exceeds this amount). So setting the number of\n# entries 1 will produce a full collapsed tree by default. 0 is a special value\n# representing an infinite number of entries and will result in a full expanded\n# tree by default.\n# Minimum value: 0, maximum value: 9999, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_INDEX_NUM_ENTRIES = 100\n\n# If the GENERATE_DOCSET tag is set to YES, additional index files will be\n# generated that can be used as input for Apple's Xcode 3 integrated development\n# environment (see:\n# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To\n# create a documentation set, doxygen will generate a Makefile in the HTML\n# output directory. Running make will produce the docset in that directory and\n# running make install will install the docset in\n# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at\n# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy\n# genXcode/_index.html for more information.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_DOCSET = NO\n\n# This tag determines the name of the docset feed. A documentation feed provides\n# an umbrella under which multiple documentation sets from a single provider\n# (such as a company or product suite) can be grouped.\n# The default value is: Doxygen generated docs.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_FEEDNAME = \"Doxygen generated docs\"\n\n# This tag specifies a string that should uniquely identify the documentation\n# set bundle. This should be a reverse domain-name style string, e.g.\n# com.mycompany.MyDocSet. Doxygen will append .docset to the name.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_BUNDLE_ID = org.doxygen.Project\n\n# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify\n# the documentation publisher. This should be a reverse domain-name style\n# string, e.g. com.mycompany.MyDocSet.documentation.\n# The default value is: org.doxygen.Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_ID = org.doxygen.Publisher\n\n# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.\n# The default value is: Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_NAME = Publisher\n\n# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three\n# additional HTML index files: index.hhp, index.hhc, and index.hhk. The\n# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop\n# on Windows. In the beginning of 2021 Microsoft took the original page, with\n# a.o. the download links, offline the HTML help workshop was already many years\n# in maintenance mode). You can download the HTML help workshop from the web\n# archives at Installation executable (see:\n# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo\n# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).\n#\n# The HTML Help Workshop contains a compiler that can convert all HTML output\n# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML\n# files are now used as the Windows 98 help format, and will replace the old\n# Windows help format (.hlp) on all Windows platforms in the future. Compressed\n# HTML files also contain an index, a table of contents, and you can search for\n# words in the documentation. The HTML workshop also contains a viewer for\n# compressed HTML files.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_HTMLHELP = NO\n\n# The CHM_FILE tag can be used to specify the file name of the resulting .chm\n# file. You can add a path in front of the file if the result should not be\n# written to the html output directory.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_FILE =\n\n# The HHC_LOCATION tag can be used to specify the location (absolute path\n# including file name) of the HTML help compiler (hhc.exe). If non-empty,\n# doxygen will try to run the HTML help compiler on the generated index.hhp.\n# The file has to be specified with full path.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nHHC_LOCATION =\n\n# The GENERATE_CHI flag controls if a separate .chi index file is generated\n# (YES) or that it should be included in the main .chm file (NO).\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nGENERATE_CHI = NO\n\n# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)\n# and project file content.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_INDEX_ENCODING =\n\n# The BINARY_TOC flag controls whether a binary table of contents is generated\n# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it\n# enables the Previous and Next buttons.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nBINARY_TOC = NO\n\n# The TOC_EXPAND flag can be set to YES to add extra items for group members to\n# the table of contents of the HTML help documentation and to the tree view.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nTOC_EXPAND = NO\n\n# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\n# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that\n# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help\n# (.qch) of the generated HTML documentation.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_QHP = NO\n\n# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify\n# the file name of the resulting .qch file. The path specified is relative to\n# the HTML output folder.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQCH_FILE =\n\n# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help\n# Project output. For more information please see Qt Help Project / Namespace\n# (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_NAMESPACE = org.doxygen.Project\n\n# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt\n# Help Project output. For more information please see Qt Help Project / Virtual\n# Folders (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).\n# The default value is: doc.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_VIRTUAL_FOLDER = doc\n\n# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom\n# filter to add. For more information please see Qt Help Project / Custom\n# Filters (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_NAME =\n\n# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the\n# custom filter to add. For more information please see Qt Help Project / Custom\n# Filters (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_ATTRS =\n\n# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\n# project's filter section matches. Qt Help Project / Filter Attributes (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_SECT_FILTER_ATTRS =\n\n# The QHG_LOCATION tag can be used to specify the location (absolute path\n# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to\n# run qhelpgenerator on the generated .qhp file.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHG_LOCATION =\n\n# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be\n# generated, together with the HTML files, they form an Eclipse help plugin. To\n# install this plugin and make it available under the help contents menu in\n# Eclipse, the contents of the directory containing the HTML and XML files needs\n# to be copied into the plugins directory of eclipse. The name of the directory\n# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.\n# After copying Eclipse needs to be restarted before the help appears.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_ECLIPSEHELP = NO\n\n# A unique identifier for the Eclipse help plugin. When installing the plugin\n# the directory name containing the HTML and XML files should also have this\n# name. Each documentation set should have its own identifier.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.\n\nECLIPSE_DOC_ID = org.doxygen.Project\n\n# If you want full control over the layout of the generated HTML pages it might\n# be necessary to disable the index and replace it with your own. The\n# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\n# of each HTML page. A value of NO enables the index and the value YES disables\n# it. Since the tabs in the index contain the same information as the navigation\n# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nDISABLE_INDEX = NO\n\n# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\n# structure should be generated to display hierarchical information. If the tag\n# value is set to YES, a side panel will be generated containing a tree-like\n# index structure (just like the one that is generated for HTML Help). For this\n# to work a browser that supports JavaScript, DHTML, CSS and frames is required\n# (i.e. any modern browser). Windows users are probably better off using the\n# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can\n# further fine tune the look of the index (see \"Fine-tuning the output\"). As an\n# example, the default style sheet generated by doxygen has an example that\n# shows how to put an image at the root of the tree instead of the PROJECT_NAME.\n# Since the tree basically has the same information as the tab index, you could\n# consider setting DISABLE_INDEX to YES when enabling this option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_TREEVIEW = NO\n\n# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the\n# FULL_SIDEBAR option determines if the side bar is limited to only the treeview\n# area (value NO) or if it should extend to the full height of the window (value\n# YES). Setting this to YES gives a layout similar to\n# https://docs.readthedocs.io with more room for contents, but less room for the\n# project logo, title, and description. If either GENERATOR_TREEVIEW or\n# DISABLE_INDEX is set to NO, this option has no effect.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFULL_SIDEBAR = NO\n\n# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that\n# doxygen will group on one line in the generated HTML documentation.\n#\n# Note that a value of 0 will completely suppress the enum values from appearing\n# in the overview section.\n# Minimum value: 0, maximum value: 20, default value: 4.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nENUM_VALUES_PER_LINE = 4\n\n# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used\n# to set the initial width (in pixels) of the frame in which the tree is shown.\n# Minimum value: 0, maximum value: 1500, default value: 250.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nTREEVIEW_WIDTH = 250\n\n# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to\n# external symbols imported via tag files in a separate window.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nEXT_LINKS_IN_WINDOW = NO\n\n# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg\n# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see\n# https://inkscape.org) to generate formulas as SVG images instead of PNGs for\n# the HTML output. These images will generally look nicer at scaled resolutions.\n# Possible values are: png (the default) and svg (looks nicer but requires the\n# pdf2svg or inkscape tool).\n# The default value is: png.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FORMULA_FORMAT = png\n\n# Use this tag to change the font size of LaTeX formulas included as images in\n# the HTML documentation. When you change the font size after a successful\n# doxygen run you need to manually remove any form_*.png images from the HTML\n# output directory to force them to be regenerated.\n# Minimum value: 8, maximum value: 50, default value: 10.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_FONTSIZE = 10\n\n# Use the FORMULA_TRANSPARENT tag to determine whether or not the images\n# generated for formulas are transparent PNGs. Transparent PNGs are not\n# supported properly for IE 6.0, but are supported on all modern browsers.\n#\n# Note that when changing this option you need to delete any form_*.png files in\n# the HTML output directory before the changes have effect.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_TRANSPARENT = YES\n\n# The FORMULA_MACROFILE can contain LaTeX \\newcommand and \\renewcommand commands\n# to create new LaTeX commands to be used in formulas as building blocks. See\n# the section \"Including formulas\" for details.\n\nFORMULA_MACROFILE =\n\n# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see\n# https://www.mathjax.org) which uses client side JavaScript for the rendering\n# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX\n# installed or if you want to formulas look prettier in the HTML output. When\n# enabled you may also need to install MathJax separately and configure the path\n# to it using the MATHJAX_RELPATH option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nUSE_MATHJAX = NO\n\n# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.\n# Note that the different versions of MathJax have different requirements with\n# regards to the different settings, so it is possible that also other MathJax\n# settings have to be changed when switching between the different MathJax\n# versions.\n# Possible values are: MathJax_2 and MathJax_3.\n# The default value is: MathJax_2.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_VERSION = MathJax_2\n\n# When MathJax is enabled you can set the default output format to be used for\n# the MathJax output. For more details about the output format see MathJax\n# version 2 (see:\n# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3\n# (see:\n# http://docs.mathjax.org/en/latest/web/components/output.html).\n# Possible values are: HTML-CSS (which is slower, but has the best\n# compatibility. This is the name for Mathjax version 2, for MathJax version 3\n# this will be translated into chtml), NativeMML (i.e. MathML. Only supported\n# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This\n# is the name for Mathjax version 3, for MathJax version 2 this will be\n# translated into HTML-CSS) and SVG.\n# The default value is: HTML-CSS.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_FORMAT = HTML-CSS\n\n# When MathJax is enabled you need to specify the location relative to the HTML\n# output directory using the MATHJAX_RELPATH option. The destination directory\n# should contain the MathJax.js script. For instance, if the mathjax directory\n# is located at the same level as the HTML output directory, then\n# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax\n# Content Delivery Network so you can quickly see the result without installing\n# MathJax. However, it is strongly recommended to install a local copy of\n# MathJax from https://www.mathjax.org before deployment. The default value is:\n# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2\n# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest\n\n# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax\n# extension names that should be enabled during MathJax rendering. For example\n# for MathJax version 2 (see\n# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):\n# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols\n# For example for MathJax version 3 (see\n# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):\n# MATHJAX_EXTENSIONS = ams\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_EXTENSIONS =\n\n# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces\n# of code that will be used on startup of the MathJax code. See the MathJax site\n# (see:\n# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an\n# example see the documentation.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_CODEFILE =\n\n# When the SEARCHENGINE tag is enabled doxygen will generate a search box for\n# the HTML output. The underlying search engine uses javascript and DHTML and\n# should work on any modern browser. Note that when using HTML help\n# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)\n# there is already a search function so this one should typically be disabled.\n# For large projects the javascript based search engine can be slow, then\n# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to\n# search using the keyboard; to jump to the search box use + S\n# (what the is depends on the OS and browser, but it is typically\n# , /