Merge pull request #758 from secure-software-engineering/development

Release v2503

Author: fabianbs96

.clang-tidy

@@ -17,6 +17,8 @@ Checks: '-*,
            -readability-convert-member-functions-to-static,
            -readability-isolate-declaration,
            -readability-identifier-length,
+           -readability-redundant-member-init,
+           -readability-use-anyofallof,
          cppcoreguidelines-*,
            -cppcoreguidelines-avoid-non-const-global-variables,
            -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
@@ -57,7 +59,7 @@ CheckOptions:
   - key:             readability-identifier-naming.ParameterIgnoredRegexp
     value:           (d|d1|d2|d3|d4|d5|eP|f|n)
   - key:             readability-identifier-naming.FunctionIgnoredRegexp
-    value:           (try_emplace|from_json|to_json|equal_to|to_string|DToString|NToString|FToString|LToString)
+    value:           (try_emplace|from_json|to_json|equal_to|to_string|DToString|NToString|FToString|LToString|hash_value)
   - key:             cppcoreguidelines-special-member-functions.AllowSoleDefaultDtor
     value:           1
   - key:             cppcoreguidelines-special-member-functions.AllowMissingMoveFunctions

.dockerignore

@@ -1,2 +1,16 @@
-./docker
-./build
+*
+!.git
+!cmake/
+!config/
+!include/
+!lib/
+!test/
+!tools/
+!unittests/
+!utils/*.sh
+!utils/*.py
+
+!.gitmodules
+!CMakeLists.txt
+!Config.cmake.in
+!config.h.in

.github/CODEOWNERS

@@ -32,3 +32,6 @@ Dockerfile @janniclas
 /include/phasar/Utils/OnTheFlyAnalysisPrinter.h @sritejakv
 /include/phasar/PhasarLLVM/Utils/SourceMgrPrinter.h @sritejakv
 /lib/PhasarLLVM/Utils/SourceMgrPrinter.cpp @sritejakv
+
+/conanfile.py @jusito
+/utils/conan/ @jusito

.github/workflows/ci.yml

@@ -6,19 +6,32 @@ on:
   pull_request:
     branches: [ master, development ]
 
+# TODO test in tree build?
+# TODO test conan build
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: true
       matrix:
-        compiler: [ [clang++-14, clang-14] ]
-        build: [ Debug, Release ]
+        os: [ubuntu-20.04, ubuntu-24.04-arm]
+        compiler: [ [clang++-19, clang-19, "clang-19 libclang-rt-19-dev"] ]
+        build: [ Debug, Release, DebugLibdeps ]
         include:
           - build: Debug
-            flags: -DPHASAR_BUILD_DYNLIB=ON -DPHASAR_ENABLE_SANITIZERS=ON
+            cmake_build_type: Debug
+            flags: -DPHASAR_ENABLE_SANITIZERS=ON
           - build: Release
-            flags: -DPHASAR_ENABLE_DYNAMIC_LOG=OFF -DPHASAR_DEBUG_LIBDEPS=ON -DBUILD_SHARED_LIBS=ON
+            cmake_build_type: Release
+            flags: -DPHASAR_ENABLE_DYNAMIC_LOG=OFF -DPHASAR_BUILD_DYNLIB=ON -DPHASAR_ENABLE_SANITIZERS=ON
+          - build: DebugLibdeps
+            cmake_build_type: Debug
+            flags: -DPHASAR_DEBUG_LIBDEPS=ON -DBUILD_SHARED_LIBS=ON
+        exclude:
+          - os: ubuntu-24.04-arm
+            build: Debug
+          - os: ubuntu-24.04-arm
+            build: DebugLibdeps
 
     continue-on-error: false
     steps:
@@ -31,43 +44,42 @@ jobs:
       - name: Install Phasar Dependencies
         shell: bash
         run: |
-          ./utils/InstallAptDependencies.sh
-          sudo apt-get -y install --no-install-recommends libboost-graph-dev
+          ./utils/InstallAptDependencies.sh --noninteractive tzdata ${{ matrix.compiler[2] }}
 
-      - name: Install Strategy Dependencies
+      - uses: swift-actions/setup-swift@v2
+        if: matrix.os == 'ubuntu-20.04'
+        with:
+          swift-version: "5.8.1"
+      - name: Building Phasar in ${{ matrix.build }} with ${{ matrix.compiler[0] }} including swift
+        if: matrix.os == 'ubuntu-20.04'
+        env:
+          CXX: ${{ matrix.compiler[0] }}
+          CC: ${{ matrix.compiler[1] }}
         shell: bash
         run: |
-          sudo apt-key adv --fetch-keys https://apt.llvm.org/llvm-snapshot.gpg.key
-          sudo add-apt-repository -y 'deb http://apt.llvm.org/focal/ llvm-toolchain-focal-14 main'
-          sudo apt-get update
-          sudo apt-get -y install --no-install-recommends \
-              ${{ matrix.compiler[1] }} \
-              llvm-14-dev \
-              libllvm14 \
-              libclang-common-14-dev \
-              libclang-14-dev \
-              libclang-cpp14-dev \
-              clang-tidy-14 \
-              libclang-rt-14-dev
+          cmake -S . -B build \
+            -DCMAKE_BUILD_TYPE=${{ matrix.cmake_build_type }} \
+            -DBUILD_PHASAR_CLANG=OFF \
+            -DBUILD_SWIFT_TESTS=ON \
+            -DPHASAR_USE_Z3=ON \
+            ${{ matrix.flags }} \
+            -G Ninja
+          ninja -C build
 
-      - uses: swift-actions/setup-swift@v1
-        with:
-          swift-version: "5.8.1"
       - name: Building Phasar in ${{ matrix.build }} with ${{ matrix.compiler[0] }}
+        if: matrix.os != 'ubuntu-20.04'
         env:
           CXX: ${{ matrix.compiler[0] }}
           CC: ${{ matrix.compiler[1] }}
         shell: bash
         run: |
-          mkdir build
-          cd build
-          cmake .. \
-            -DCMAKE_BUILD_TYPE=${{ matrix.build }} \
-            -DBUILD_SWIFT_TESTS=ON \
+          cmake -S . -B build \
+            -DCMAKE_BUILD_TYPE=${{ matrix.cmake_build_type }} \
+            -DBUILD_PHASAR_CLANG=OFF \
             -DPHASAR_USE_Z3=ON \
             ${{ matrix.flags }} \
             -G Ninja
-          cmake --build .
+          ninja -C build
 
       - name: Run Unittests
         shell: bash

.github/workflows/docker.yml

@@ -2,49 +2,40 @@ name: Docker Image
 
 on:
   push:
-    branches: [ development ]
+    branches: [ master, development ]
+  pull_request:
+    branches: [ master, development ]
 
 jobs:
   push_to_registries:
     name: Push Docker image to multiple registries
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-24.04, ubuntu-24.04-arm]
     permissions:
       packages: write
       contents: read
     steps:
       - name: Check out the repo
-        uses: actions/checkout@v3
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: actions/checkout@v4
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-      # If we want to publish an image of PhASAR to the official docker hub we
-      # can just use the following code and set the corresponding secrets.
-      # - name: Log in to Docker Hub
-      #   uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
-      #   with:
-      #     username: ${{ secrets.DOCKER_USERNAME }}
-      #     password: ${{ secrets.DOCKER_TOKEN }}
-
+        uses: docker/setup-buildx-action@v3
       - name: Log in to the Container registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
-
       - name: Extract metadata (tags, labels) for Docker
         id: meta
         uses: docker/metadata-action@v4
         with:
           images: ghcr.io/${{ github.repository }}
-            # here we could add a second image for the official docker registry
-            # sse/phasar
       - name: Build and push Docker images
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v6
         with:
           context: .
-          platforms: linux/amd64,linux/arm64
-          push: true
+          push: ${{ github.ref == 'refs/heads/development' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -4,9 +4,11 @@
 bin/*
 
 # build directories for cmake
-build/
-build_*/
-build-*/
+build*/
+cmake-build*/
+cmake-install*/
+CMakeUserPresets.json
+venv/
 
 # LLVM project
 llvm-project/*
@@ -26,6 +28,7 @@ doc/*
 
 # log/ directory
 log/*
+**/*/logs/
 
 # CMake build dir
 build/*
@@ -43,12 +46,15 @@ build/*
 .idea/*
 
 # cache
-.cache/*
+.cache/
 
 ##### ignored files
 
 # ignore all auto-generated LLVM IR code
 *.ll
+!utils/conan/llvm-core/all/test_package/test_function.ll
+!test_package/example.ll
+!test_package_cmake/example.ll
 
 # auto generated test files
 *.test

.pre-commit-config.yaml

@@ -5,7 +5,9 @@ repos:
     rev: v4.3.0
     hooks:
     -   id: trailing-whitespace
+        exclude: "^.*\\.patch$"
     -   id: end-of-file-fixer
+        exclude: "^.*\\.patch$"
     -   id: check-yaml
     -   id: check-added-large-files
     -   id: requirements-txt-fixer

BreakingChanges.md

@@ -1,5 +1,25 @@
 # Breaking Changes
 
+## development HEAD
+
+*None*
+
+## v2503
+
+- The `DTAResolver` and the cli option `--call-graph-analysis=dta` do not work anymore (due to opaque pointers) and will be removed for the next release. Please use the `OTF` or `RTA` resolver instead.
+- The default type-hierarchy implementation has been changed from `LLVMTypeHierarchy` to `DIBasedTypeHierarchy`. This also requires all affected analyses to be performed on LLVM IR that contains debug information.
+- Removed the phasar-library `phasar_controller`. It is now part of the tool `phasar-cli`.
+- The API of the `TypeHierarchy` interface (and thus the `LLVMTypeHierarchy` and `DIBasedTypeHierarchy` as well) has changed:
+  - No handling of the super-type relation (only sub-types)
+  - No VTable handling anymore -- has been out-sourced into `LLVMVFTableProvider`
+  - minor API changes
+- The constructors of the call-graph resolvers have changed. They:
+  - take the `LLVMProjectIRDB` as pointer-to-const
+  - take an additional second parameter of type `const LLVMVFTableProvider *`
+  - not necessarily require a `LLVMTypeHierarchy` anymore
+- Some constructors of `LLVMBasedICFG` do not accept a `LLVMTypeHierarchy` pointer anymore
+- Removed IfdsFieldSensTaintAnalysis as it relies on LLVM's deprecated typed-pointers.
+
 ## v2403
 
 - Versioning scheme has been changed from `<month><year>` to `<year><month>`