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

Release 2604

Author: fabianbs96

.github/workflows/ci.yml

@@ -15,8 +15,9 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-24.04, ubuntu-24.04-arm]
-        compiler: [ [clang++-19, clang-19, "clang-19 libclang-rt-19-dev"] ]
-        build: [ Debug, Release, DebugLibdeps ]
+        compiler: [ [clang++-19, clang-19, "clang-19 libclang-rt-19-dev clang-tools-19"] ]
+        build: [ Debug, Release, DebugLibdeps, DebugCov ]
+        llvm-version: [ 16, 17 ]
         include:
           - build: Debug
             cmake_build_type: Debug
@@ -27,11 +28,17 @@ jobs:
           - build: DebugLibdeps
             cmake_build_type: Debug
             flags: -DPHASAR_DEBUG_LIBDEPS=ON -DBUILD_SHARED_LIBS=ON
+          - build: DebugCov
+            cmake_build_type: Debug
+            flags: -DCODE_COVERAGE=ON
+            extra_dependencies: llvm-19 # For coverage
         exclude:
           - os: ubuntu-24.04-arm
             build: Debug
           - os: ubuntu-24.04-arm
             build: DebugLibdeps
+          - os: ubuntu-24.04-arm
+            build: DebugCov
 
     continue-on-error: false
     steps:
@@ -41,10 +48,15 @@ jobs:
           fetch-depth: 0
           submodules: recursive
 
+      - name: ccache  # This should always come after the actions/checkout step.
+        uses: hendrikmuhs/ccache-action@v1.2
+        with:
+          key: ${{ github.job }}-${{ matrix.os }}-llvm${{ matrix.llvm-version }}-${{ matrix.build }}
+
       - name: Install Phasar Dependencies
         shell: bash
         run: |
-          ./utils/InstallAptDependencies.sh --noninteractive tzdata ${{ matrix.compiler[2] }}
+          ./utils/InstallAptDependencies.sh --llvm-version ${{ matrix.llvm-version }} --noninteractive tzdata ccache ${{ matrix.compiler[2] }} ${{ matrix.extra_dependencies }}
 
       - name: Building Phasar in ${{ matrix.build }} with ${{ matrix.compiler[0] }}
         env:
@@ -54,8 +66,12 @@ jobs:
         run: |
           cmake -S . -B build \
             -DCMAKE_BUILD_TYPE=${{ matrix.cmake_build_type }} \
+            -DCMAKE_C_COMPILER_LAUNCHER=ccache \
+            -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
             -DBUILD_PHASAR_CLANG=OFF \
             -DPHASAR_USE_Z3=ON \
+            -DPHASAR_BUILD_MODULES=ON \
+            -DPHASAR_LLVM_VERSION=${{ matrix.llvm-version }} \
             ${{ matrix.flags }} \
             -G Ninja
           ninja -C build
@@ -77,3 +93,18 @@ jobs:
           cd ./examples/how-to
           cmake -S . -B build -Dphasar_ROOT="$PHASAR_ROOT_DIR/INSTALL"
           cmake --build ./build --target run_sample_programs
+
+      - name: Check test coverage and generate HTML report
+        if: matrix.build == 'DebugCov'
+        shell: bash
+        run: |
+          cmake --build ./build --target ccov-all
+
+      - name: Upload coverage HTML report artifact
+        if: matrix.build == 'DebugCov'
+        uses: actions/upload-artifact@v4
+        with:
+          name: phasar-coverage-report-llvm-${{ matrix.llvm-version }}
+          path: ./build/ccov/all-merged/
+          if-no-files-found: error
+          retention-days: 7

.github/workflows/deploy-docs.yml

@@ -8,6 +8,7 @@ permissions:
   contents: write
 jobs:
   build-and-deploy:
+    if: github.repository == 'secure-software-engineering/phasar'
     runs-on: ubuntu-24.04
     strategy:
       fail-fast: true
@@ -28,8 +29,8 @@ jobs:
       - name: Build Doxygen Docs
         shell: bash
         env:
-          CXX: clang++-15
-          CC: clang-15
+          CXX: clang++-16
+          CC: clang-16
         run: |
            cmake -S . -B build -DPHASAR_BUILD_DOC=ON
            cmake --build ./build --target doc_doxygen

.gitignore

@@ -33,6 +33,8 @@ log/*
 # MS VS Code
 .vscode/
 
+.devcontainer/
+
 # Eclipse
 .cproject
 .project

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v6.0.0
     hooks:
     -   id: trailing-whitespace
         exclude: "^.*\\.patch$"

BUILD.md

@@ -79,7 +79,8 @@ When using CMake to compile PhASAR the following optional parameters can be used
 | **PHASAR_ENABLE_PAMM** : STRING | Enable the performance measurement mechanism ('Off', 'Core' or 'Full', default is Off) |
 | **PHASAR_ENABLE_PIC** : BOOL | Build Position-Independed Code (default is ON) |
 | **PHASAR_ENABLE_WARNINGS** : BOOL | Enable compiler warnings (default is ON) |
-| **CMAKE_CXX_STANDARD** : INT|Build phasar in C++17 or C++20 mode (default is 17)|
+| **CMAKE_CXX_STANDARD** : INT|Adapt the used C++ standard (minimum required is 20)|
+| **PHASAR_LLVM_VERSION** : INT|The LLVM major-version to use. Can be 16 or 17 (default is 16)|
 
 You can use these parameters either directly or modify the installer-script `bootstrap.sh`
 

BreakingChanges.md

@@ -4,6 +4,30 @@
 
 *None*
 
+## v2604
+
+- The function `HelperAnalyses::getAliasInfo()` no longer returns a `LLVMAliasSet &`, but a `LLVMAliasInfoRef`.
+- The location of the library summary `FunctionDataFlowFacts` and `LLVMFunctionDataFlowFacts` has moved to `phasar/Utils/` and `phasar/PhasarLLVM/Utils`, respectively.
+- `IDESolver::initialize()` does no longer return a `bool`. Now, you are always allowed to call `next()` at least once.
+- `IntraMonoProblem` and `InterMonoProblem`, and all reference-implementations of these problems do not receive a TypeHierarchy-pointer anymore in the ctor.
+- Requiring C++20 instead of C++17
+  - Type-traits and other templates that are specialized now use `requires` instead of `enable_if`, wherever possible. This may reduce the number of (defaulted) template parameters in some cases.
+- The `AdjacencyList` struct now now has one more template argument to denote the intege-like `vertex_t` type. It is the second template argument (which previously was the EdgeType). The edge-type is now denoted by the *third* template argument.
+- The `AdjacencyList` switches from using `llvm::NoneType` as empty-node marker to `psr::EmptyType` for forward-compatibility with LLVM-16 that removes `llvm::NoneType`.
+
+- Removed `SpecialSummaries`.
+- Removed `Hexastore` and the corresponding database queries.
+- Removed `LLVMTypeHierarchy` (and `LLVMTypeHierarchyData`), which is superceeded by `DIBasedTypeHierarchy`.
+- Removed `Resolver::preCall()`, `Resolver::postCall()`, and `Resolver::otherInst()`.
+- Removed `TypestateDescription::start()`. Instead apply `TypestateDescription::getNextState()` on `TypestateDescription::uninit()`.
+- Removed `LLVMProjectIRDB::getParsedIRModuleOrNull()`. Use `LLVMProjectIRDB::getParsedIRModuleOrErr()` instead.
+- Removed `DIBasedTypeHierarchy::isVTable()` and `DIBasedTypeHierarchy::removeVTablePrefix()`. Use the corresponding functions from `LLVMVFTableProvider` instead.
+- Removed the CMake variable `PHASAR_HAS_SQLITE` as we removed the dependency on sqlite3.
+- The CMake Option `BUILD_PHASAR_CLANG` is no longer `ON` by default.
+- Removed the dependency to boost:
+  - Removed the boost-related command-line options in `bootstrap.sh`
+  - `InstallAptDependencies.sh` no longer installs boost (so, boost is also no longer built into PhASAR's Docker containers)
+
 ## v2510
 
 - Removed some old APIs from `PhasarConfig`

CMakeLists.txt

@@ -23,14 +23,14 @@ if (DEFINED LLVM_MAIN_SRC_DIR)
   set(PHASAR_IN_TREE 1)
 endif()
 
+set(PHASAR_VERSION 2604)
 if (NOT PHASAR_IN_TREE)
   project (phasar
     LANGUAGES C CXX
     DESCRIPTION "A LLVM-based static analysis framework."
-    VERSION 2510
+    VERSION ${PHASAR_VERSION}
   )
 endif ()
-set(PHASAR_VERSION ${PROJECT_VERSION})
 
 # NOTE: When we require cmake >= 3.21, we can use PROJECT_IS_TOP_LEVEL instead
 if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
@@ -245,10 +245,18 @@ endif()
 set(PHASAR_DEPS_INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/phasar/deps)
 
 # Filesystem
-if (LLVM_ENABLE_LIBCXX)
-  set(PHASAR_STD_FILESYSTEM c++fs)
-else()
-  set(PHASAR_STD_FILESYSTEM stdc++fs)
+
+# Check if the underlying toolchain has a default std filesystem header
+include(CheckIncludeFileCXX)
+check_include_file_cxx(filesystem HAS_FILESYSTEM_HEADER)
+
+if (NOT HAS_FILESYSTEM_HEADER)
+  # If no file system exists, link a filesystem explicitly
+  if (LLVM_ENABLE_LIBCXX)
+    set(PHASAR_STD_FILESYSTEM c++fs)
+  else()
+    set(PHASAR_STD_FILESYSTEM stdc++fs)
+  endif()
 endif()
 
 # Config
@@ -264,18 +272,47 @@ endif()
 # Threads
 find_package(Threads)
 
-# Boost
-find_package(Boost 1.65.1 COMPONENTS graph REQUIRED CONFIG)
-
 # Disable clang-tidy for the external projects
 set(CMAKE_CXX_CLANG_TIDY "")
 
 # Nlohmann JSON
-
 include(add_nlohmann_json)
 add_nlohmann_json()
 add_json_schema_validator()
 
+# Coverage
+if (CODE_COVERAGE)
+  set(CODE_COVERAGE_SCRIPT "${CMAKE_CURRENT_BINARY_DIR}/code-coverage.cmake")
+  file(DOWNLOAD "https://raw.githubusercontent.com/StableCoder/cmake-scripts/refs/tags/25.08/code-coverage.cmake" "${CODE_COVERAGE_SCRIPT}"
+    EXPECTED_HASH SHA256=cad4dd2bdf944f77627687e0298debc8341bfdeffaf949937f319c7c4ff3fdaf
+    TLS_VERIFY ON
+    STATUS CODE_COVERAGE_SCRIPT_DOWNLOAD_STATUS
+  )
+  message(STATUS "Download code-coverage.cmake: ${CODE_COVERAGE_SCRIPT_DOWNLOAD_STATUS}")
+
+  if (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+    string(REGEX MATCH "^[0-9]+" COMPILER_VERSION_MAJOR "${CMAKE_CXX_COMPILER_VERSION}")
+    message(STATUS "Clang major version: ${COMPILER_VERSION_MAJOR}")
+    set(LLVM_TOOL_VERSION_SUFFIX "-${COMPILER_VERSION_MAJOR}")
+  endif()
+
+  # pre-populate these cmake variables as we require specific versions:
+  find_program(LLVM_COV_PATH "llvm-cov${LLVM_TOOL_VERSION_SUFFIX}" REQUIRED)
+  find_program(LLVM_PROFDATA_PATH "llvm-profdata${LLVM_TOOL_VERSION_SUFFIX}" REQUIRED)
+  message(STATUS "Found llvm-cov: ${LLVM_COV_PATH}")
+  message(STATUS "Found llvm-profdata: ${LLVM_PROFDATA_PATH}")
+
+  include("${CODE_COVERAGE_SCRIPT}")
+
+  find_program(cxxfilt "c++filt" QUIET)
+  if (cxxfilt)
+    set(DEMANGLER_OPTIONS LLVM_COV_HTML_OPTIONS "-Xdemangler=${cxxfilt}")
+  endif()
+
+  set(COV_FILEPATH_FILTER "(usr/*|external/|unittests/)")
+  add_code_coverage_all_targets(EXCLUDE ${COV_FILEPATH_FILTER} ${DEMANGLER_OPTIONS})
+endif()
+
 # Googletest
 if (NOT PHASAR_IN_TREE)
   if(PHASAR_BUILD_UNITTESTS AND NOT TARGET gtest)
@@ -294,20 +331,11 @@ else()
   set(GTEST_INCLUDE_DIR "${LLVM_MAIN_SRC_DIR}/utils/unittest/googletest/include")
 endif()
 
-# SQL
-find_package(SQLite3)
-if(SQLite3_FOUND)
-  set(PHASAR_HAS_SQLITE ON)
-else()
-  set(PHASAR_HAS_SQLITE OFF)
-endif()
-
 option(USE_LLVM_FAT_LIB  "Link against libLLVM.so instead of the individual LLVM libraries if possible (default is OFF; always on if BUILD_SHARED_LIBS is ON)" OFF)
 
 # LLVM
-if (NOT PHASAR_LLVM_VERSION)
-  set(PHASAR_LLVM_VERSION 15)
-endif()
+set(PHASAR_LLVM_VERSION 16 CACHE STRING "The LLVM major-version that PhASAR should use")
+
 include(add_llvm)
 add_llvm()
 
@@ -328,29 +356,34 @@ if(PHASAR_IN_TREE)
   set (PHASAR_USE_Z3 OFF)
 else()
   if(PHASAR_USE_Z3)
-    # This z3-version is the same version LLVM requires; however, we cannot just use Z3 via the LLVM interface
-    # as it lacks some functionality (such as z3::expr::simplify()) that we require
-
-    # FindZ3.cmake by llvm tries to compile a snippet with Z3 which crashes on arm with sanitizers enabled
-    set(SAFE_CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
-    set(CMAKE_CXX_FLAGS "")
-    find_package(Z3 4.7.1 REQUIRED)
-    set(CMAKE_CXX_FLAGS "${SAFE_CMAKE_CXX_FLAGS}")
-
-    if(Z3_FOUND)
-      if (NOT TARGET z3)
-        add_library(z3 IMPORTED SHARED)
-        set_property(TARGET z3 PROPERTY
-                IMPORTED_LOCATION ${Z3_LIBRARIES})
-        set_property(TARGET z3 PROPERTY
-                INTERFACE_INCLUDE_DIRECTORIES ${Z3_INCLUDE_DIR})
+    if (TARGET z3::libz3)
+      # When including SVF, it also tries to find z3, but in addition to LLVM's search it already creates a target: z3::libz3.
+      # Reuse it here:
+      if(NOT TARGET z3)
+        add_library(z3 ALIAS z3::libz3)
+      endif()
+    else()
+      # FindZ3.cmake by llvm tries to compile a snippet with Z3 which crashes on arm with sanitizers enabled
+      set(SAFE_CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
+      set(CMAKE_CXX_FLAGS "")
+      find_package(Z3 REQUIRED)
+      set(CMAKE_CXX_FLAGS "${SAFE_CMAKE_CXX_FLAGS}")
+
+      if(Z3_FOUND)
+        if (NOT TARGET z3)
+          add_library(z3 IMPORTED SHARED)
+          set_target_properties(z3 PROPERTIES
+            IMPORTED_LOCATION ${Z3_LIBRARIES}
+            INTERFACE_INCLUDE_DIRECTORIES ${Z3_INCLUDE_DIR}
+          )
+        endif()
       endif()
     endif()
   endif()
 endif()
 
 # Clang
-option(BUILD_PHASAR_CLANG "Build the phasar_clang library (default is ON)" ON)
+option(BUILD_PHASAR_CLANG "Build the phasar_clang library (default is OFF)" OFF)
 if(BUILD_PHASAR_CLANG)
   add_clang()
 endif()
@@ -377,7 +410,7 @@ if (PHASAR_ENABLE_WARNINGS)
   if (MSVC)
     string(APPEND CMAKE_CXX_FLAGS " /W4")
   else()
-    string(APPEND CMAKE_CXX_FLAGS " -Wall -Wextra -Wno-unused-parameter")
+    string(APPEND CMAKE_CXX_FLAGS " -Wall -Wextra -Wno-unused-parameter -Werror=return-type")
   endif()
 endif (PHASAR_ENABLE_WARNINGS)
 

Config.cmake.in

@@ -9,21 +9,16 @@ include (CMakeFindDependencyMacro)
 set(PHASAR_LLVM_VERSION @PHASAR_LLVM_VERSION@)
 
 include("${CMAKE_CURRENT_LIST_DIR}/PhasarDepsExports.cmake")
-find_dependency(Boost 1.65.1 COMPONENTS graph REQUIRED CONFIG)
 find_dependency(LLVM ${PHASAR_LLVM_VERSION} REQUIRED CONFIG)
 
 set(PHASAR_USE_LLVM_FAT_LIB @USE_LLVM_FAT_LIB@)
 set(PHASAR_BUILD_DYNLIB @PHASAR_BUILD_DYNLIB@)
 set(PHASAR_USE_Z3 @PHASAR_USE_Z3@)
-set(PHASAR_HAS_SQLITE @PHASAR_HAS_SQLITE@)
 set(PHASAR_BUILD_MODULES @PHASAR_BUILD_MODULES@)
 
 if (PHASAR_USE_Z3)
   find_dependency(Z3 REQUIRED)
 endif()
-if(PHASAR_HAS_SQLITE)
-  find_dependency(SQLite3 REQUIRED)
-endif()
 
 set(PHASAR_COMPONENTS
   utils

Dockerfile

@@ -1,9 +1,9 @@
 ARG baseimage="ubuntu:24.04"
-FROM "$baseimage" as build
+FROM "$baseimage" AS build
 
 RUN --mount=type=bind,source=./utils/InstallAptDependencies.sh,target=/InstallAptDependencies.sh \
   set -eux; \
-  ./InstallAptDependencies.sh --noninteractive tzdata clang-19 libclang-rt-19-dev
+  ./InstallAptDependencies.sh --noninteractive tzdata clang-19 libclang-rt-19-dev clang-tools-19
 
 ENV CC=/usr/bin/clang-19 \
     CXX=/usr/bin/clang++-19