Merge branch 'blipper-llvmcxxshorthands' into development

Author: pdschubert

include/phasar/Utils/LLVMCXXShorthands.h

@@ -0,0 +1,13 @@
+#ifndef INCLUDE_PHASAR_UTILS_LLVMCXXSHORTHANDS_H_
+#define INCLUDE_PHASAR_UTILS_LLVMCXXSHORTHANDS_H_
+// This contains LLVM IR Shorthands specific to C++
+// See https://mapping-high-level-constructs-to-llvm-ir.readthedocs.io/en/latest/object-oriented-constructs/classes.html
+// for examples
+
+#include "llvm/IR/Instructions.h"
+#include "llvm/IR/Value.h"
+
+namespace psr {
+bool isTouchVTableInst(const llvm::StoreInst *Store);
+}
+#endif // INCLUDE_PHASAR_UTILS_LLVMCXXSHORTHANDS_H_

include/phasar/Utils/LLVMShorthands.h

@@ -20,23 +20,12 @@
 #include <string>
 #include <vector>
 
+#include "llvm/IR/Instructions.h"
+#include "llvm/IR/Function.h"
 #include "llvm/IR/Value.h"
 
 #include "phasar/Utils/Utilities.h"
 
-namespace llvm {
-class CallInst;
-class FunctionType;
-class Function;
-class Argument;
-class Instruction;
-class TerminatorInst;
-class StoreInst;
-class Module;
-class StringRef;
-class BranchInst;
-} // namespace llvm
-
 namespace psr {
 
 static inline void deleteValue(llvm::Value *V) { V->deleteValue(); }

lib/PhasarLLVM/DataFlowSolver/IfdsIde/Problems/IFDSConstAnalysis.cpp

@@ -27,6 +27,7 @@
 
 #include "phasar/Utils/LLVMIRToSrc.h"
 #include "phasar/Utils/LLVMShorthands.h"
+#include "phasar/Utils/LLVMCXXShorthands.h"
 #include "phasar/Utils/Logger.h"
 #include "phasar/Utils/PAMMMacros.h"
 #include "phasar/Utils/Utilities.h"
@@ -55,37 +56,10 @@ IFDSConstAnalysis::getNormalFlowFunction(IFDSConstAnalysis::n_t Curr,
   if (const auto *Store = llvm::dyn_cast<llvm::StoreInst>(Curr)) {
     // If the store instruction sets up or updates the vtable, i.e. value
     // operand is vtable pointer, ignore it!
-    // Setting up the vtable is counted towards the initialization of an
-    // object - the object stays immutable.
-    // To identifiy such a store instruction, we need to check the stored
-    // value, which is of i32 (...)** type, e.g.
-    //   i32 (...)** bitcast (i8** getelementptr inbounds ([3 x i8*], [3 x i8*]*
-    //                           @_ZTV5Child, i32 0, i32 2) to i32 (...)**)
-    //
-    // WARNING: The VTT could also be stored, which would make this analysis
-    // fail
-    if (const auto *CE =
-            llvm::dyn_cast<llvm::ConstantExpr>(Store->getValueOperand())) {
-      // llvm::ConstantExpr *CE = const_cast<llvm::ConstantExpr *>(ConstCE);
-      std::unique_ptr<llvm::Instruction, decltype(&deleteValue)> CEInst(
-          CE->getAsInstruction(), &deleteValue);
-      if (auto *CF =
-              llvm::dyn_cast<llvm::ConstantExpr>(CEInst->getOperand(0))) {
-        std::unique_ptr<llvm::Instruction, decltype(&deleteValue)> CFInst(
-            CF->getAsInstruction(), &deleteValue);
-        if (auto *VTable =
-                llvm::dyn_cast<llvm::GlobalVariable>(CFInst->getOperand(0))) {
-          if (VTable->hasName() &&
-              llvm::demangle(VTable->getName().str()).find("vtable") !=
-                  string::npos) {
-            LOG_IF_ENABLE(
-                BOOST_LOG_SEV(lg::get(), DEBUG)
-                << "Store Instruction sets up or updates vtable - ignored!");
-            return Identity<IFDSConstAnalysis::d_t>::getInstance();
-          }
-        }
-      }
-    } /* end vtable set-up instruction */
+    if (isTouchVTableInst(Store)) {
+      return Identity<IFDSConstAnalysis::d_t>::getInstance();
+    }
+
     IFDSConstAnalysis::d_t PointerOp = Store->getPointerOperand();
     LOG_IF_ENABLE(BOOST_LOG_SEV(lg::get(), DEBUG)
                   << "Pointer operand of store Instruction: "

lib/Utils/LLVMCXXShorthands.cpp

@@ -0,0 +1,44 @@
+#include "phasar/Utils/LLVMCXXShorthands.h"
+#include <llvm/Demangle/Demangle.h>
+#include <llvm/IR/Constants.h>
+#include "llvm/IR/GlobalVariable.h"
+#include "llvm/IR/Instructions.h"
+#include <phasar/Utils/Logger.h>
+
+namespace psr {
+// Setting up the vtable is counted towards the initialization of an
+// object - the object stays immutable.
+// To identifiy such a store instruction, we need to check the stored
+// value, which is of i32 (...)** type, e.g.
+//   i32 (...)** bitcast (i8** getelementptr inbounds ([3 x i8*], [3 x i8*]*
+//                           @_ZTV5Child, i32 0, i32 2) to i32 (...)**)
+//
+// WARNING: The VTT could also be stored, which would make this analysis
+// fail
+bool isTouchVTableInst(const llvm::StoreInst *Store) {
+  if (const auto *CE =
+          llvm::dyn_cast<llvm::ConstantExpr>(Store->getValueOperand())) {
+    // llvm::ConstantExpr *CE = const_cast<llvm::ConstantExpr *>(ConstCE);
+    auto *CEInst = const_cast<llvm::ConstantExpr *>(CE)->getAsInstruction();
+    if (auto *CF = llvm::dyn_cast<llvm::ConstantExpr>(CEInst->getOperand(0))) {
+      auto *CFInst = CF->getAsInstruction();
+      if (auto *VTable =
+              llvm::dyn_cast<llvm::GlobalVariable>(CFInst->getOperand(0))) {
+        if (VTable->hasName() &&
+            llvm::demangle(VTable->getName().str()).find("vtable") !=
+                std::string::npos) {
+          LOG_IF_ENABLE(
+              BOOST_LOG_SEV(lg::get(), DEBUG)
+              << "Store Instruction sets up or updates vtable - ignored!");
+          CEInst->deleteValue();
+          CFInst->deleteValue();
+          return true;
+        }
+      }
+      CFInst->deleteValue();
+    }
+    CEInst->deleteValue();
+  } /* end vtable set-up instruction */
+  return false;
+}
+}