Opaque Pointers Integration

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        compiler: [ [clang++-14, clang-14] ]
+        compiler: [ [clang++-15, clang-15] ]
         build: [ Debug, Release, DebugLibdeps ]
         include:
           - build: Debug
@@ -42,18 +42,18 @@ jobs:
       - name: Install Strategy Dependencies
         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-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-15 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
+              clang-15 \
+              llvm-15-dev \
+              libllvm15 \
+              libclang-common-15-dev \
+              libclang-15-dev \
+              libclang-cpp15-dev \
+              clang-tidy-15 \
+              libclang-rt-15-dev
 
       - uses: swift-actions/setup-swift@v2
         with:

BreakingChanges.md

@@ -2,6 +2,8 @@
 
 ## development HEAD
 
+- 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.
 - 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`

Dockerfile

@@ -1,5 +1,5 @@
 FROM ubuntu:22.04
-ARG LLVM_INSTALL_DIR="/usr/local/llvm-14"
+ARG LLVM_INSTALL_DIR="/usr/local/llvm-15"
 LABEL Name=phasar Version=2403
 
 RUN apt -y update && apt install bash sudo -y
@@ -24,17 +24,17 @@ RUN apt-get update && \
     apt-get install -y software-properties-common
 
 RUN apt-key adv --fetch-keys https://apt.llvm.org/llvm-snapshot.gpg.key && \
-           add-apt-repository -y 'deb http://apt.llvm.org/focal/ llvm-toolchain-focal-14 main' && \
+           add-apt-repository -y 'deb http://apt.llvm.org/focal/ llvm-toolchain-focal-15 main' && \
            apt-get update && \
            apt-get -y install --no-install-recommends \
-              clang-14 \
-              llvm-14-dev \
-              libllvm14 \
-              libclang-common-14-dev \
-              libclang-14-dev \
-              libclang-cpp14-dev \
-              clang-tidy-14 \
-              libclang-rt-14-dev
+              clang-15 \
+              llvm-15-dev \
+              libllvm15 \
+              libclang-common-15-dev \
+              libclang-15-dev \
+              libclang-cpp15-dev \
+              clang-tidy-15 \
+              libclang-rt-15-dev
 
 RUN pip3 install Pygments pyyaml
 
@@ -43,8 +43,8 @@ RUN pip3 install Pygments pyyaml
 # installing wllvm
 RUN pip3 install wllvm
 
-ENV CC=/usr/bin/clang-14
-ENV CXX=/usr/bin/clang++-14
+ENV CC=/usr/bin/clang-15
+ENV CXX=/usr/bin/clang++-15
 
 COPY . /usr/src/phasar
 

bootstrap.sh

@@ -6,10 +6,10 @@ source ./utils/safeCommandsSet.sh
 
 readonly PHASAR_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 PHASAR_INSTALL_DIR="/usr/local/phasar"
-LLVM_INSTALL_DIR="/usr/local/llvm-14"
+LLVM_INSTALL_DIR="/usr/local/llvm-15"
 
 NUM_THREADS=$(nproc)
-LLVM_RELEASE=llvmorg-14.0.6
+LLVM_RELEASE=llvmorg-15.0.7
 DO_UNIT_TEST=true
 DO_INSTALL=false
 BUILD_TYPE=Release

cmake/add_llvm.cmake

@@ -2,7 +2,7 @@ macro(add_llvm)
 
   if (NOT PHASAR_IN_TREE)
     # Only search for LLVM if we build out of tree
-    find_package(LLVM 14 REQUIRED CONFIG)
+    find_package(LLVM 15 REQUIRED CONFIG)
     find_library(LLVM_LIBRARY NAMES LLVM PATHS ${LLVM_LIBRARY_DIRS} NO_DEFAULT_PATH)
 
     if(USE_LLVM_FAT_LIB AND ${LLVM_LIBRARY} STREQUAL "LLVM_LIBRARY-NOTFOUND")

cmake/phasar_macros.cmake

@@ -76,13 +76,6 @@ function(generate_ll_file)
   set(GEN_C_FLAGS -fno-discard-value-names -emit-llvm -S -w)
   set(GEN_CMD_COMMENT "[LL]")
 
-  if (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 15)
-    list(APPEND GEN_CXX_FLAGS -Xclang -no-opaque-pointers)
-  endif()
-  if (CMAKE_C_COMPILER_VERSION VERSION_GREATER_EQUAL 15)
-    list(APPEND GEN_C_FLAGS -Xclang -no-opaque-pointers)
-  endif()
-
   if(GEN_LL_MEM2REG)
     list(APPEND GEN_CXX_FLAGS -Xclang -disable-O0-optnone)
     list(APPEND GEN_C_FLAGS -Xclang -disable-O0-optnone)
@@ -128,7 +121,7 @@ function(generate_ll_file)
     add_custom_command(
       OUTPUT ${test_code_ll_file}
       COMMAND ${GEN_CMD} ${test_code_file_path} -o ${test_code_ll_file}
-      COMMAND ${CMAKE_CXX_COMPILER_LAUNCHER} opt -mem2reg -S -opaque-pointers=0 ${test_code_ll_file} -o ${test_code_ll_file}
+      COMMAND ${CMAKE_CXX_COMPILER_LAUNCHER} opt -mem2reg -S ${test_code_ll_file} -o ${test_code_ll_file}
       COMMENT ${GEN_CMD_COMMENT}
       DEPENDS ${GEN_LL_FILE}
       VERBATIM

include/phasar/DataFlow/IfdsIde/Solver/IDESolver.h

@@ -117,7 +117,7 @@ class IDESolver
             llvm::StringRef(NToString(Cells[I].getRowKey())).trim().str();
 
         std::string NodeStr =
-            ICF->getFunctionName(ICF->getFunctionOf(Curr)) + "::" + NStr;
+            ICF->getFunctionName(ICF->getFunctionOf(Curr)).str() + "::" + NStr;
         J[DataFlowID][NodeStr];
         std::string FactStr =
             llvm::StringRef(DToString(Cells[I].getColumnKey())).trim().str();

include/phasar/PhasarLLVM/ControlFlow/LLVMBasedICFG.h

@@ -33,12 +33,8 @@
 #include "llvm/IR/Value.h"
 #include "llvm/Support/raw_ostream.h"
 
-#include "nlohmann/json.hpp"
-
-#include <memory>
-
 namespace psr {
-class LLVMTypeHierarchy;
+class DIBasedTypeHierarchy;
 class LLVMProjectIRDB;
 class Resolver;
 
@@ -82,7 +78,7 @@ class LLVMBasedICFG : public LLVMBasedCFG, public ICFGBase<LLVMBasedICFG> {
   /// IRDB. True by default
   explicit LLVMBasedICFG(LLVMProjectIRDB *IRDB, CallGraphAnalysisType CGType,
                          llvm::ArrayRef<std::string> EntryPoints = {},
-                         LLVMTypeHierarchy *TH = nullptr,
+                         DIBasedTypeHierarchy *TH = nullptr,
                          LLVMAliasInfoRef PT = nullptr,
                          Soundness S = Soundness::Soundy,
                          bool IncludeGlobals = true);
@@ -102,7 +98,7 @@ class LLVMBasedICFG : public LLVMBasedCFG, public ICFGBase<LLVMBasedICFG> {
   explicit LLVMBasedICFG(LLVMProjectIRDB *IRDB,
                          const nlohmann::json &SerializedCG);
 
-  // Deleter of LLVMTypeHierarchy may be unknown here...
+  // Deleter of DIBasedTypeHierarchy may be unknown here...
   ~LLVMBasedICFG();
 
   LLVMBasedICFG(const LLVMBasedICFG &) = delete;

include/phasar/PhasarLLVM/ControlFlow/LLVMVFTableProvider.h

@@ -16,7 +16,7 @@
 
 namespace llvm {
 class Module;
-class StructType;
+class DIType;
 class GlobalVariable;
 } // namespace llvm
 
@@ -28,12 +28,12 @@ class LLVMVFTableProvider {
   explicit LLVMVFTableProvider(const llvm::Module &Mod);
   explicit LLVMVFTableProvider(const LLVMProjectIRDB &IRDB);
 
-  [[nodiscard]] bool hasVFTable(const llvm::StructType *Type) const;
+  [[nodiscard]] bool hasVFTable(const llvm::DIType *Type) const;
   [[nodiscard]] const LLVMVFTable *
-  getVFTableOrNull(const llvm::StructType *Type) const;
+  getVFTableOrNull(const llvm::DIType *Type) const;
 
 private:
-  std::unordered_map<const llvm::StructType *, LLVMVFTable> TypeVFTMap;
+  std::unordered_map<const llvm::DIType *, LLVMVFTable> TypeVFTMap;
 };
 } // namespace psr
 

include/phasar/PhasarLLVM/ControlFlow/Resolver/CHAResolver.h

@@ -26,11 +26,11 @@ class Function;
 } // namespace llvm
 
 namespace psr {
-class LLVMTypeHierarchy;
+class DIBasedTypeHierarchy;
 class CHAResolver : public Resolver {
 public:
   CHAResolver(const LLVMProjectIRDB *IRDB, const LLVMVFTableProvider *VTP,
-              const LLVMTypeHierarchy *TH);
+              const DIBasedTypeHierarchy *TH);
 
   ~CHAResolver() override = default;
 
@@ -39,7 +39,7 @@ class CHAResolver : public Resolver {
   [[nodiscard]] std::string str() const override;
 
 protected:
-  MaybeUniquePtr<const LLVMTypeHierarchy, true> TH;
+  MaybeUniquePtr<const DIBasedTypeHierarchy, true> TH;
 };
 } // namespace psr
 

include/phasar/PhasarLLVM/ControlFlow/Resolver/DTAResolver.h

@@ -19,6 +19,7 @@
 
 #include "phasar/PhasarLLVM/ControlFlow/Resolver/CHAResolver.h"
 #include "phasar/PhasarLLVM/Pointer/TypeGraphs/CachedTypeGraph.h"
+#include "phasar/PhasarLLVM/TypeHierarchy/DIBasedTypeHierarchy.h"
 // To switch the TypeGraph
 // #include "phasar/PhasarLLVM/Pointer/TypeGraphs/LazyTypeGraph.h"
 
@@ -33,7 +34,8 @@ class BitCastInst;
 
 namespace psr {
 
-class DTAResolver : public CHAResolver {
+class [[deprecated("Does not work with opaque pointers anymore")]] DTAResolver
+    : public CHAResolver {
 public:
   using TypeGraph_t = CachedTypeGraph;
 
@@ -44,19 +46,20 @@ class DTAResolver : public CHAResolver {
    * An heuristic that return true if the bitcast instruction is interesting to
    * take into the DTA relational graph
    */
-  static bool
-  heuristicAntiConstructorThisType(const llvm::BitCastInst *BitCast);
+  static bool heuristicAntiConstructorThisType(
+      const llvm::BitCastInst *BitCast);
 
   /**
    * Another heuristic that return true if the bitcast instruction is
    * interesting to take into the DTA relational graph (use the presence or not
    * of vtable)
+
    */
   bool heuristicAntiConstructorVtablePos(const llvm::BitCastInst *BitCast);
 
 public:
   DTAResolver(const LLVMProjectIRDB *IRDB, const LLVMVFTableProvider *VTP,
-              const LLVMTypeHierarchy *TH);
+              const DIBasedTypeHierarchy *TH);
 
   ~DTAResolver() override = default;
 

include/phasar/PhasarLLVM/ControlFlow/Resolver/OTFResolver.h

@@ -35,7 +35,7 @@ class Value;
 
 namespace psr {
 
-class LLVMTypeHierarchy;
+class DIBasedTypeHierarchy;
 
 class OTFResolver : public Resolver {
 protected:

include/phasar/PhasarLLVM/ControlFlow/Resolver/RTAResolver.h

@@ -26,13 +26,15 @@ class CallBase;
 class StructType;
 class Function;
 class StructType;
+class DICompositeType;
 } // namespace llvm
 
 namespace psr {
+class DIBasedTypeHierarchy;
 class RTAResolver : public CHAResolver {
 public:
   RTAResolver(const LLVMProjectIRDB *IRDB, const LLVMVFTableProvider *VTP,
-              const LLVMTypeHierarchy *TH);
+              const DIBasedTypeHierarchy *TH);
 
   ~RTAResolver() override = default;
 
@@ -41,9 +43,9 @@ class RTAResolver : public CHAResolver {
   [[nodiscard]] std::string str() const override;
 
 private:
-  void resolveAllocatedStructTypes();
+  void resolveAllocatedCompositeTypes();
 
-  std::vector<const llvm::StructType *> AllocatedStructTypes;
+  std::vector<const llvm::DICompositeType *> AllocatedCompositeTypes;
 };
 } // namespace psr
 

include/phasar/PhasarLLVM/ControlFlow/Resolver/Resolver.h

@@ -20,6 +20,7 @@
 #include "phasar/PhasarLLVM/Pointer/LLVMAliasInfo.h"
 
 #include "llvm/ADT/DenseSet.h"
+#include "llvm/IR/DerivedTypes.h"
 
 #include <memory>
 #include <optional>
@@ -29,19 +30,19 @@ namespace llvm {
 class Instruction;
 class CallBase;
 class Function;
-class StructType;
+class DIType;
 } // namespace llvm
 
 namespace psr {
 class LLVMProjectIRDB;
 class LLVMVFTableProvider;
-class LLVMTypeHierarchy;
+class DIBasedTypeHierarchy;
 enum class CallGraphAnalysisType;
 
 [[nodiscard]] std::optional<unsigned>
 getVFTIndex(const llvm::CallBase *CallSite);
 
-[[nodiscard]] const llvm::StructType *
+[[nodiscard]] const llvm::DIType *
 getReceiverType(const llvm::CallBase *CallSite);
 
 [[nodiscard]] std::string getReceiverTypeName(const llvm::CallBase *CallSite);
@@ -57,7 +58,7 @@ class Resolver {
   Resolver(const LLVMProjectIRDB *IRDB);
 
   const llvm::Function *
-  getNonPureVirtualVFTEntry(const llvm::StructType *T, unsigned Idx,
+  getNonPureVirtualVFTEntry(const llvm::DIType *T, unsigned Idx,
                             const llvm::CallBase *CallSite);
 
 public:
@@ -85,7 +86,7 @@ class Resolver {
   static std::unique_ptr<Resolver> create(CallGraphAnalysisType Ty,
                                           const LLVMProjectIRDB *IRDB,
                                           const LLVMVFTableProvider *VTP,
-                                          const LLVMTypeHierarchy *TH,
+                                          const DIBasedTypeHierarchy *TH,
                                           LLVMAliasInfoRef PT = nullptr);
 };
 } // namespace psr

include/phasar/PhasarLLVM/DataFlow/Mono/Problems/InterMonoFullConstantPropagation.h

@@ -32,7 +32,7 @@ class StructType;
 namespace psr {
 
 class LLVMBasedICFG;
-class LLVMTypeHierarchy;
+class DIBasedTypeHierarchy;
 
 class InterMonoFullConstantPropagation
     : public IntraMonoFullConstantPropagation,
@@ -48,7 +48,7 @@ class InterMonoFullConstantPropagation
   using mono_container_t = IntraMonoFullConstantPropagation::mono_container_t;
 
   InterMonoFullConstantPropagation(const LLVMProjectIRDB *IRDB,
-                                   const LLVMTypeHierarchy *TH,
+                                   const DIBasedTypeHierarchy *TH,
                                    const LLVMBasedICFG *ICF,
                                    LLVMAliasInfoRef PT,
                                    std::vector<std::string> EntryPoints = {});

include/phasar/PhasarLLVM/DataFlow/Mono/Problems/InterMonoSolverTest.h

@@ -36,7 +36,7 @@ class StructType;
 
 namespace psr {
 
-class LLVMTypeHierarchy;
+class DIBasedTypeHierarchy;
 
 struct InterMonoSolverTestDomain : LLVMAnalysisDomainDefault {
   using mono_container_t = BitVectorSet<LLVMAnalysisDomainDefault::d_t>;
@@ -52,8 +52,9 @@ class InterMonoSolverTest : public InterMonoProblem<InterMonoSolverTestDomain> {
   using i_t = InterMonoSolverTestDomain::i_t;
   using mono_container_t = InterMonoSolverTestDomain::mono_container_t;
 
-  InterMonoSolverTest(const LLVMProjectIRDB *IRDB, const LLVMTypeHierarchy *TH,
-                      const LLVMBasedICFG *ICF, LLVMAliasInfoRef PT,
+  InterMonoSolverTest(const LLVMProjectIRDB *IRDB,
+                      const DIBasedTypeHierarchy *TH, const LLVMBasedICFG *ICF,
+                      LLVMAliasInfoRef PT,
                       std::vector<std::string> EntryPoints = {});
 
   ~InterMonoSolverTest() override = default;