Fix Type-based Call-Graphs with Multiple Inheritance

include/phasar/PhasarLLVM/ControlFlow/LLVMBasedICFG.h

@@ -26,13 +26,11 @@
 #include "phasar/PhasarLLVM/ControlFlow/LLVMVFTableProvider.h"
 #include "phasar/PhasarLLVM/Pointer/LLVMAliasInfo.h"
 #include "phasar/PhasarLLVM/Utils/LLVMBasedContainerConfig.h"
-#include "phasar/Utils/MaybeUniquePtr.h"
 #include "phasar/Utils/Soundness.h"
 
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/IR/Function.h"
-#include "llvm/IR/Instruction.h"
 #include "llvm/IR/Value.h"
 #include "llvm/Support/raw_ostream.h"
 

include/phasar/PhasarLLVM/ControlFlow/LLVMVFTableProvider.h

@@ -11,7 +11,13 @@
 #define PHASAR_PHASARLLVM_CONTROLFLOW_LLVMVFTABLEPROVIDER_H
 
 #include "phasar/PhasarLLVM/TypeHierarchy/LLVMVFTable.h"
+#include "phasar/Utils/HashUtils.h"
 
+#include "llvm/ADT/DenseSet.h"
+#include "llvm/ADT/StringMap.h"
+#include "llvm/IR/DebugInfoMetadata.h"
+
+#include <cstdint>
 #include <unordered_map>
 
 namespace llvm {
@@ -35,11 +41,35 @@ class LLVMVFTableProvider {
   explicit LLVMVFTableProvider(const LLVMProjectIRDB &IRDB);
 
   [[nodiscard]] bool hasVFTable(const llvm::DIType *Type) const;
-  [[nodiscard]] const LLVMVFTable *
-  getVFTableOrNull(const llvm::DIType *Type) const;
+  [[nodiscard]] const LLVMVFTable *getVFTableOrNull(const llvm::DIType *Type,
+                                                    uint32_t Index = 0) const;
+
+  [[nodiscard]] const llvm::GlobalVariable *
+  getVFTableGlobal(const llvm::DIType *Type) const;
+
+  [[nodiscard]] const llvm::GlobalVariable *
+  getVFTableGlobal(llvm::StringRef ClearTypeName) const;
+
+  [[nodiscard]] const llvm::SmallDenseSet<uint32_t> &
+  getVTableIndexInHierarchy(const llvm::DIType *DerivedType,
+                            const llvm::DIType *BaseType) const;
+
+  /// Supercedes DIBasedTypeHierarchy::removeVTablePrefix
+  [[nodiscard]] static llvm::StringRef
+  removeVTablePrefix(llvm::StringRef GlobName) noexcept;
+
+  /// Supercedes DIBasedTypeHierarchy::isVTable
+  [[nodiscard]] static bool isVTable(llvm::StringRef MangledVarName);
 
 private:
-  std::unordered_map<const llvm::DIType *, LLVMVFTable> TypeVFTMap;
+  llvm::StringMap<const llvm::GlobalVariable *> ClearNameTVMap;
+  std::unordered_map<std::pair<const llvm::DIType *, uint32_t>, LLVMVFTable,
+                     PairHash>
+      TypeVFTMap;
+  std::unordered_map<
+      const llvm::DIType *,
+      llvm::SmallDenseMap<const llvm::DIType *, llvm::SmallDenseSet<uint32_t>>>
+      BasesOfVirt;
 };
 } // namespace psr
 

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

@@ -38,7 +38,8 @@ class CHAResolver : public Resolver {
   // dtor in CHAResolver.cpp
   ~CHAResolver() override;
 
-  FunctionSetTy resolveVirtualCall(const llvm::CallBase *CallSite) override;
+  void resolveVirtualCall(FunctionSetTy &PossibleTargets,
+                          const llvm::CallBase *CallSite) override;
 
   [[nodiscard]] std::string str() const override;
 

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

@@ -25,9 +25,11 @@ class NOResolver final : public Resolver {
 
   ~NOResolver() override = default;
 
-  FunctionSetTy resolveVirtualCall(const llvm::CallBase *CallSite) override;
+  void resolveVirtualCall(FunctionSetTy &PossibleTargets,
+                          const llvm::CallBase *CallSite) override;
 
-  FunctionSetTy resolveFunctionPointer(const llvm::CallBase *CallSite) override;
+  void resolveFunctionPointer(FunctionSetTy &PossibleTargets,
+                              const llvm::CallBase *CallSite) override;
 
   [[nodiscard]] std::string str() const override;
 

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

@@ -48,9 +48,11 @@ class OTFResolver : public Resolver {
   void handlePossibleTargets(const llvm::CallBase *CallSite,
                              FunctionSetTy &CalleeTargets) override;
 
-  FunctionSetTy resolveVirtualCall(const llvm::CallBase *CallSite) override;
+  void resolveVirtualCall(FunctionSetTy &PossibleTargets,
+                          const llvm::CallBase *CallSite) override;
 
-  FunctionSetTy resolveFunctionPointer(const llvm::CallBase *CallSite) override;
+  void resolveFunctionPointer(FunctionSetTy &PossibleTargets,
+                              const llvm::CallBase *CallSite) override;
 
   static std::set<const llvm::Type *>
   getReachableTypes(const LLVMAliasInfo::AliasSetTy &Values);

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

@@ -38,7 +38,8 @@ class RTAResolver : public CHAResolver {
 
   ~RTAResolver() override = default;
 
-  FunctionSetTy resolveVirtualCall(const llvm::CallBase *CallSite) override;
+  void resolveVirtualCall(FunctionSetTy &PossibleTargets,
+                          const llvm::CallBase *CallSite) override;
 
   [[nodiscard]] std::string str() const override;
 

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

@@ -52,10 +52,9 @@ getReceiverType(const llvm::CallBase *CallSite);
 
 /// Assuming that `CallSite` is a virtual call, where `Idx` is retrieved through
 /// `getVFTIndex()` and `T` through `getReceiverType()`
-[[nodiscard]] const llvm::Function *
-getNonPureVirtualVFTEntry(const llvm::DIType *T, unsigned Idx,
-                          const llvm::CallBase *CallSite,
-                          const psr::LLVMVFTableProvider &VTP);
+[[nodiscard]] const llvm::Function *getNonPureVirtualVFTEntry(
+    const llvm::DIType *T, unsigned Idx, const llvm::CallBase *CallSite,
+    const psr::LLVMVFTableProvider &VTP, const llvm::DIType *ReceiverType);
 
 [[nodiscard]] std::string getReceiverTypeName(const llvm::CallBase *CallSite);
 
@@ -79,11 +78,12 @@ class Resolver {
 
   const llvm::Function *
   getNonPureVirtualVFTEntry(const llvm::DIType *T, unsigned Idx,
-                            const llvm::CallBase *CallSite) {
+                            const llvm::CallBase *CallSite,
+                            const llvm::DIType *ReceiverType) {
     if (!VTP) {
       return nullptr;
     }
-    return psr::getNonPureVirtualVFTEntry(T, Idx, CallSite, *VTP);
+    return psr::getNonPureVirtualVFTEntry(T, Idx, CallSite, *VTP, ReceiverType);
   }
 
 public:
@@ -103,16 +103,14 @@ class Resolver {
   [[nodiscard]] FunctionSetTy
   resolveIndirectCall(const llvm::CallBase *CallSite);
 
-  [[nodiscard]] virtual FunctionSetTy
-  resolveVirtualCall(const llvm::CallBase *CallSite) = 0;
-
-  [[nodiscard]] virtual FunctionSetTy
-  resolveFunctionPointer(const llvm::CallBase *CallSite);
-
   virtual void otherInst(const llvm::Instruction *Inst);
 
   [[nodiscard]] virtual std::string str() const = 0;
 
+  /// Whether the ICFG needs to reconsider all dynamic call-sites once there
+  /// have been changes through handlePossibleTargets().
+  ///
+  /// Make false for performance (may be less sound then)
   [[nodiscard]] virtual bool mutatesHelperAnalysisInformation() const noexcept {
     // Conservatively returns true. Override if possible
     return true;
@@ -122,6 +120,13 @@ class Resolver {
                                           const LLVMVFTableProvider *VTP,
                                           const DIBasedTypeHierarchy *TH,
                                           LLVMAliasInfoRef PT = nullptr);
+
+protected:
+  virtual void resolveVirtualCall(FunctionSetTy &PossibleTargets,
+                                  const llvm::CallBase *CallSite) = 0;
+
+  virtual void resolveFunctionPointer(FunctionSetTy &PossibleTargets,
+                                      const llvm::CallBase *CallSite);
 };
 } // namespace psr
 

include/phasar/PhasarLLVM/TypeHierarchy/DIBasedTypeHierarchy.h

@@ -58,7 +58,9 @@ class DIBasedTypeHierarchy
                                 const DIBasedTypeHierarchyData &SerializedData);
   ~DIBasedTypeHierarchy() override = default;
 
+  [[deprecated("Use LLVMVFTableProvider::isVTable() instead")]]
   static bool isVTable(llvm::StringRef VarName);
+  [[deprecated("Use LLVMVFTableProvider::removeVTablePrefix() instead")]]
   static std::string removeVTablePrefix(llvm::StringRef VarName);
 
   [[nodiscard]] bool hasType(ClassType Type) const override {

include/phasar/PhasarLLVM/TypeHierarchy/LLVMVFTable.h

@@ -73,26 +73,26 @@ class LLVMVFTable : public VFTable<const llvm::Function *> {
 
   void printAsJson(llvm::raw_ostream &OS) const override;
 
-  [[nodiscard]] std::vector<const llvm::Function *>::iterator begin() {
+  [[nodiscard]] std::vector<const llvm::Function *>::iterator begin() noexcept {
     return VFT.begin();
   }
 
   [[nodiscard]] std::vector<const llvm::Function *>::const_iterator
-  begin() const {
+  begin() const noexcept {
     return VFT.begin();
   };
 
-  [[nodiscard]] std::vector<const llvm::Function *>::iterator end() {
+  [[nodiscard]] std::vector<const llvm::Function *>::iterator end() noexcept {
     return VFT.end();
   };
 
   [[nodiscard]] std::vector<const llvm::Function *>::const_iterator
-  end() const {
+  end() const noexcept {
     return VFT.end();
   };
 
   [[nodiscard]] static std::vector<const llvm::Function *>
-  getVFVectorFromIRVTable(const llvm::ConstantStruct &);
+  getVFVectorFromIRVTable(const llvm::ConstantStruct &VT, uint32_t Index = 0);
 };
 
 } // namespace psr

include/phasar/PhasarLLVM/Utils/LLVMIRToSrc.h

@@ -33,7 +33,6 @@ class Value;
 class GlobalVariable;
 class Module;
 class DIFile;
-class DIType;
 class DILocation;
 } // namespace llvm
 

include/phasar/Utils/DefaultValue.h

@@ -40,6 +40,26 @@ getDefaultValue() noexcept(std::is_nothrow_default_constructible_v<T>) {
   }
 }
 
+namespace detail {
+struct DefaultCast {
+  template <typename To,
+            typename = std::enable_if_t<CanEfficientlyPassByValue<To>>>
+  operator To() && {
+    return psr::getDefaultValue<To>();
+  }
+
+  template <typename To,
+            typename = std::enable_if_t<!CanEfficientlyPassByValue<To>>>
+  operator const To &() && {
+    return psr::getDefaultValue<To>();
+  }
+};
+} // namespace detail
+
+/// Provides a value that automatically converts to (a const-ref to) the
+/// default-constructed object of the expected receiver type.
+static constexpr detail::DefaultCast default_value() noexcept { return {}; }
+
 } // namespace psr
 
 #endif // PHASAR_UTILS_DEFAULTVALUE_H

include/phasar/Utils/HashUtils.h

@@ -0,0 +1,27 @@
+/******************************************************************************
+ * Copyright (c) 2025 Fabian Schiebel.
+ * All rights reserved. This program and the accompanying materials are made
+ * available under the terms of LICENSE.txt.
+ *
+ * Contributors:
+ *     Fabian Schiebel and others
+ *****************************************************************************/
+
+#ifndef PHASAR_UTILS_HASHUTILS_H
+#define PHASAR_UTILS_HASHUTILS_H
+
+#include "llvm/ADT/DenseMapInfo.h"
+
+#include <cstddef>
+#include <utility>
+
+namespace psr {
+struct PairHash {
+  template <typename T, typename U>
+  size_t operator()(const std::pair<T, U> &Pair) const noexcept {
+    return llvm::DenseMapInfo<std::pair<T, U>>::getHashValue(Pair);
+  }
+};
+} // namespace psr
+
+#endif // PHASAR_UTILS_HASHUTILS_H

include/phasar/Utils/MapUtils.h

@@ -0,0 +1,69 @@
+/******************************************************************************
+ * Copyright (c) 2025 Fabian Schiebel.
+ * All rights reserved. This program and the accompanying materials are made
+ * available under the terms of LICENSE.txt.
+ *
+ * Contributors:
+ *     Fabian Schiebel and others
+ *****************************************************************************/
+
+#ifndef PHASAR_UTILS_MAPUTILS_H
+#define PHASAR_UTILS_MAPUTILS_H
+
+#include "phasar/Utils/ByRef.h"
+#include "phasar/Utils/DefaultValue.h"
+#include "phasar/Utils/Macros.h"
+
+#include "llvm/ADT/STLForwardCompat.h"
+
+#include <type_traits>
+#include <utility>
+
+namespace psr {
+
+template <typename MapT, typename KeyT,
+          typename = std::enable_if_t<std::is_lvalue_reference_v<MapT>>>
+static auto getOrDefault(MapT &&Map, KeyT &&Key) -> ByConstRef<
+    llvm::remove_cvref_t<decltype(Map.find(PSR_FWD(Key))->second)>> {
+  auto It = Map.find(PSR_FWD(Key));
+  if (It == Map.end()) {
+    return default_value();
+  }
+
+  return It->second;
+}
+
+template <
+    typename MapT, typename KeyT,
+    typename = std::enable_if_t<std::is_lvalue_reference_v<MapT>>,
+    std::enable_if_t<
+        !psr::CanEfficientlyPassByValue<llvm::remove_cvref_t<KeyT>>, int> = 0>
+static auto getOrNull(MapT &&Map, KeyT &&Key)
+    -> decltype(&Map.find(PSR_FWD(Key))->second) {
+  auto It = Map.find(PSR_FWD(Key));
+  decltype(&It->second) Ret = nullptr;
+  if (It != Map.end()) {
+    Ret = &It->second;
+  }
+
+  return Ret;
+}
+
+template <
+    typename MapT, typename KeyT,
+    typename = std::enable_if_t<std::is_lvalue_reference_v<MapT>>,
+    std::enable_if_t<psr::CanEfficientlyPassByValue<llvm::remove_cvref_t<KeyT>>,
+                     int> = 0>
+static auto getOrNull(MapT &&Map, KeyT Key)
+    -> decltype(&Map.find(Key)->second) {
+  auto It = Map.find(Key);
+  decltype(&It->second) Ret = nullptr;
+  if (It != Map.end()) {
+    Ret = &It->second;
+  }
+
+  return Ret;
+}
+} // namespace psr
+
+#endif // PHASAR_UTILS_MAPUTILS_H

lib/PhasarLLVM/ControlFlow/LLVMBasedCallGraphBuilder.cpp

@@ -6,7 +6,7 @@
 #include "phasar/PhasarLLVM/ControlFlow/Resolver/Resolver.h"
 #include "phasar/PhasarLLVM/DB/LLVMProjectIRDB.h"
 #include "phasar/PhasarLLVM/Pointer/LLVMAliasSet.h"
-#include "phasar/PhasarLLVM/TypeHierarchy/LLVMTypeHierarchy.h"
+#include "phasar/PhasarLLVM/TypeHierarchy/DIBasedTypeHierarchy.h"
 #include "phasar/PhasarLLVM/Utils/LLVMShorthands.h"
 #include "phasar/Utils/PAMMMacros.h"
 #include "phasar/Utils/Soundness.h"
@@ -111,8 +111,8 @@ static bool fillPossibleTargets(
     PossibleTargets.insert(StaticCallee);
 
     PHASAR_LOG_LEVEL_CAT(DEBUG, "LLVMBasedICFG",
-                         "Found static call-site: "
-                             << "  " << llvmIRToString(CS));
+                         "Found static call-site: " << "  "
+                                                    << llvmIRToString(CS));
     return true;
   }
 
@@ -122,8 +122,8 @@ static bool fillPossibleTargets(
 
   // the function call must be resolved dynamically
   PHASAR_LOG_LEVEL_CAT(DEBUG, "LLVMBasedICFG",
-                       "Found dynamic call-site: "
-                           << "  " << llvmIRToString(CS));
+                       "Found dynamic call-site: " << "  "
+                                                   << llvmIRToString(CS));
 
   PossibleTargets = Res.resolveIndirectCall(CS);
 

lib/PhasarLLVM/ControlFlow/LLVMBasedICFG.cpp

@@ -27,6 +27,7 @@
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/IR/Function.h"
 #include "llvm/IR/Instruction.h"
+#include "llvm/Support/Casting.h"
 #include "llvm/Support/ErrorHandling.h"
 
 #include <utility>