Apply review comment to llvmIRToStableString + fix LLVMBasedICFGExportTest

Author: fabianbs96

include/phasar/Utils/LLVMShorthands.h

@@ -52,6 +52,15 @@ bool matchesSignature(const llvm::Function *F, const llvm::FunctionType *FType,
 bool matchesSignature(const llvm::FunctionType *FType1,
                       const llvm::FunctionType *FType2);
 
+/// We need to be able to remove a Module->ModuleSlotTracker mapping, because
+/// inside the same process the LLVM allocator may choose the same address for a
+/// new llvm::Module as for a previously deleted Module.
+/// Looking up the ModuleSlotTracker for the new module (that has the same
+/// address as the old module) will give the ModuleSlotTracker for the old
+/// module that is invalid for the new one. This is common behavior in the
+/// unittests and leads to several <badref> prints.
+void clearModuleSlotTrackerFor(const llvm::Module *M);
+
 /**
  * @brief Returns a string representation of a LLVM Value.
  */

lib/Utils/LLVMShorthands.cpp

@@ -142,10 +142,12 @@ bool matchesSignature(const llvm::FunctionType *FType1,
   return false;
 }
 
+static llvm::SmallDenseMap<const llvm::Module *,
+                           std::unique_ptr<llvm::ModuleSlotTracker>, 2>
+    ModuleToSlotTracker;
+
 static llvm::ModuleSlotTracker &getModuleSlotTrackerFor(const llvm::Value *V) {
-  static llvm::SmallDenseMap<const llvm::Module *,
-                             std::unique_ptr<llvm::ModuleSlotTracker>, 2>
-      ModuleToSlotTracker;
+
   const auto *M = getModuleFromVal(V);
 
   auto &Ret = ModuleToSlotTracker[M];
@@ -156,6 +158,10 @@ static llvm::ModuleSlotTracker &getModuleSlotTrackerFor(const llvm::Value *V) {
   return *Ret;
 }
 
+void clearModuleSlotTrackerFor(const llvm::Module *M) {
+  ModuleToSlotTracker.erase(M);
+}
+
 std::string llvmIRToString(const llvm::Value *V) {
   std::string IRBuffer;
   llvm::raw_string_ostream RSO(IRBuffer);
@@ -172,17 +178,17 @@ std::string llvmIRToStableString(const llvm::Value *V) {
   V->print(RSO, getModuleSlotTrackerFor(V));
   RSO.flush();
 
-  if (auto Meta = IRBuffer.find_first_of("!#"); Meta != std::string::npos) {
-    IRBuffer.erase(Meta);
+  auto IRBufferRef = llvm::StringRef(IRBuffer).ltrim();
 
-    boost::trim_right(IRBuffer);
-    assert(!IRBuffer.empty());
-    if (IRBuffer.back() == ',') {
-      IRBuffer.pop_back();
-    }
+  if (auto Meta = IRBufferRef.find_first_of("!#");
+      Meta != llvm::StringRef::npos) {
+    IRBufferRef = IRBufferRef.slice(0, Meta).rtrim();
+
+    assert(!IRBufferRef.empty());
+    IRBufferRef.consume_back(",");
   }
 
-  boost::trim_left(IRBuffer);
+  IRBuffer = IRBufferRef.str();
 
   IRBuffer.append(" | ID: ");
   IRBuffer.append(getMetaDataID(V));

unittests/PhasarLLVM/ControlFlow/LLVMBasedICFGExportTest.cpp

@@ -48,8 +48,14 @@ class LLVMBasedICFGExportTest : public ::testing::Test {
     LLVMTypeHierarchy TH(IRDB);
     LLVMBasedICFG ICFG(IRDB, CallGraphAnalysisType::OTF, {"main"}, &TH);
 
-    return asSrcCode ? ICFG.exportICFGAsSourceCodeJson()
-                     : ICFG.exportICFGAsJson();
+    std::cerr << "ModuleRef: " << IRDB.getWPAModule() << "\n";
+
+    auto Ret =
+        asSrcCode ? ICFG.exportICFGAsSourceCodeJson() : ICFG.exportICFGAsJson();
+
+    clearModuleSlotTrackerFor(IRDB.getWPAModule());
+
+    return Ret;
   }
 
   nlohmann::json exportCFGFor(const std::string &testFile,
@@ -62,8 +68,14 @@ class LLVMBasedICFGExportTest : public ::testing::Test {
     assert(F != nullptr && "Invalid function");
     // ASSERT_NE(nullptr, F);
 
-    return asSrcCode ? CFG.exportCFGAsSourceCodeJson(F)
-                     : CFG.exportCFGAsJson(F);
+    std::cerr << "ModuleRef: " << IRDB.getWPAModule() << "\n";
+
+    auto Ret =
+        asSrcCode ? CFG.exportCFGAsSourceCodeJson(F) : CFG.exportCFGAsJson(F);
+
+    clearModuleSlotTrackerFor(IRDB.getWPAModule());
+
+    return Ret;
   }
 
   MapTy getAllRetSites(const LLVMBasedICFG &ICFG) {
@@ -95,7 +107,8 @@ class LLVMBasedICFGExportTest : public ::testing::Test {
           [&](auto &&Elem) {
             return Elem == nlohmann::json{{"from", From}, {"to", To}};
           }))
-          << "No edge from " << From << " to " << To;
+          << "No edge from " << From << " to " << To << " in "
+          << ExportedICFG.dump(4);
     };
 
     auto print = [WithDebugOutput](auto &&...Args) {
@@ -173,7 +186,11 @@ class LLVMBasedICFGExportTest : public ::testing::Test {
     LLVMTypeHierarchy TH(IRDB);
     LLVMBasedICFG ICFG(IRDB, CallGraphAnalysisType::OTF, {"main"}, &TH);
 
+    std::cerr << "ModuleRef: " << IRDB.getWPAModule() << "\n";
+
     verifyIRJson(ICFG.exportICFGAsJson(), ICFG, WithDebugOutput);
+
+    clearModuleSlotTrackerFor(IRDB.getWPAModule());
   }
 };