optimized pag's vertex and edge properties

pdschubert · pdschubert · commit 8851fe91c692 · 2020-01-23T10:09:32.000+01:00
diff --git a/include/phasar/PhasarLLVM/ControlFlow/LLVMBasedBackwardICFG.h b/include/phasar/PhasarLLVM/ControlFlow/LLVMBasedBackwardICFG.h
@@ -98,7 +98,7 @@ class LLVMBasedBackwardsICFG
 
   void printAsDot(std::ostream &OS) const;
 
-  void printInternalPTGAsDot(const std::string &filename);
+  void printInternalPTGAsDot(std::ostream &OS) const;
 
   using LLVMBasedBackwardCFG::getAsJson; // tell the compiler we wish to have
                                          // both prints
diff --git a/include/phasar/PhasarLLVM/ControlFlow/LLVMBasedICFG.h b/include/phasar/PhasarLLVM/ControlFlow/LLVMBasedICFG.h
@@ -75,7 +75,7 @@ class LLVMBasedICFG
     const llvm::Function *F = nullptr;
     VertexProperties() = default;
     VertexProperties(const llvm::Function *F);
-    std::string getFunctionName() const;    
+    std::string getFunctionName() const;
   };
 
   // The EdgeProperties for our call-graph.
@@ -160,7 +160,7 @@ class LLVMBasedICFG
   using LLVMBasedCFG::print; // tell the compiler we wish to have both prints
   void print(std::ostream &OS = std::cout) const override;
 
-    // provide a VertexPropertyWrite to tell boost how to write a vertex
+  // provide a VertexPropertyWrite to tell boost how to write a vertex
   class CallGraphVertexWriter {
   public:
     CallGraphVertexWriter(const bidigraph_t &CGraph) : CGraph(CGraph) {}
@@ -193,14 +193,13 @@ class LLVMBasedICFG
   };
 
   // a function to conveniently create the edge writer
-  CallGraphEdgeWriter
-  makeCallGraphEdgeWriter(const bidigraph_t &CGraph) const {
+  CallGraphEdgeWriter makeCallGraphEdgeWriter(const bidigraph_t &CGraph) const {
     return CallGraphEdgeWriter(CGraph);
   }
 
   void printAsDot(std::ostream &OS = std::cout) const;
 
-  void printInternalPTGAsDot(const std::string &filename);
+  void printInternalPTGAsDot(std::ostream &OS = std::cout) const;
 
   using LLVMBasedCFG::getAsJson; // tell the compiler we wish to have both
                                  // prints
diff --git a/include/phasar/PhasarLLVM/Pointer/LLVMPointsToGraph.h b/include/phasar/PhasarLLVM/Pointer/LLVMPointsToGraph.h
@@ -74,24 +74,20 @@ class PointsToGraph {
      * Variable or a formal Argument.
      */
     const llvm::Value *V = nullptr;
-    /// Holds the llvm IR code for that vertex.
-    std::string IR;
-
     VertexProperties() = default;
     VertexProperties(const llvm::Value *v);
+    std::string getValueAsString() const;
   };
 
   /**
    * 	@brief Holds the information of an edge in the points-to graph.
    */
   struct EdgeProperties {
-    /// This might be an Instruction, in particular a Call Instruction.
+    /// This may contain a call or invoke instruction.
     const llvm::Value *V = nullptr;
-    /// Holds the llvm IR code for that edge.
-    std::string IR;
-
     EdgeProperties() = default;
     EdgeProperties(const llvm::Value *v);
+    std::string getValueAsString() const;
   };
 
   /// Data structure for holding the points-to graph.
@@ -106,9 +102,9 @@ class PointsToGraph {
   typedef boost::graph_traits<graph_t>::edge_descriptor edge_t;
 
   /// The type for a vertex iterator.
-  typedef boost::graph_traits<graph_t>::vertex_iterator vertex_iterator_t;
-  typedef boost::graph_traits<graph_t>::out_edge_iterator out_edge_iterator_t;
-  typedef boost::graph_traits<graph_t>::in_edge_iterator in_edge_iterator_t;
+  typedef boost::graph_traits<graph_t>::vertex_iterator vertex_iterator;
+  typedef boost::graph_traits<graph_t>::out_edge_iterator out_edge_iterator;
+  typedef boost::graph_traits<graph_t>::in_edge_iterator in_edge_iterator;
 
   /// Set of functions that allocate heap memory, e.g. new, new[], malloc.
   inline const static std::set<std::string> HeapAllocationFunctions = {
@@ -236,11 +232,29 @@ class PointsToGraph {
    */
   void print(std::ostream &OS = std::cout) const;
 
+  class PointerVertexOrEdgePrinter {
+  public:
+    PointerVertexOrEdgePrinter(const graph_t &PAG) : PAG(PAG) {}
+    template <class VertexOrEdge>
+    void operator()(std::ostream &out, const VertexOrEdge &v) const {
+      out << "[label=\"" << PAG[v].getValueAsString() << "\"]";
+    }
+
+  private:
+    const graph_t &PAG;
+  };
+
+  static inline PointerVertexOrEdgePrinter
+  makePointerVertexOrEdgePrinter(const graph_t &PAG) {
+    return PointerVertexOrEdgePrinter(PAG);
+  }
+
   /**
-   * @brief Prints the points-to graph as a .dot file.
-   * @param filename Filename of the .dot file.
+   * @brief Prints the points-to graph in .dot format to the given output
+   * stream.
+   * @param outputstream.
    */
-  void printAsDot(const std::string &filename);
+  void printAsDot(std::ostream &OS = std::cout) const;
 
   size_t getNumVertices() const;
 
diff --git a/include/phasar/PhasarLLVM/TypeHierarchy/LLVMTypeHierarchy.h b/include/phasar/PhasarLLVM/TypeHierarchy/LLVMTypeHierarchy.h
@@ -83,8 +83,7 @@ class LLVMTypeHierarchy
   typedef boost::graph_traits<bidigraph_t>::edge_descriptor edge_t;
   // Let us have some further handy typedefs.
   typedef boost::graph_traits<bidigraph_t>::vertex_iterator vertex_iterator;
-  typedef boost::graph_traits<bidigraph_t>::out_edge_iterator
-      out_edge_iterator;
+  typedef boost::graph_traits<bidigraph_t>::out_edge_iterator out_edge_iterator;
   typedef boost::graph_traits<bidigraph_t>::in_edge_iterator in_edge_iterator;
 
 private:
diff --git a/lib/PhasarLLVM/ControlFlow/LLVMBasedBackwardICFG.cpp b/lib/PhasarLLVM/ControlFlow/LLVMBasedBackwardICFG.cpp
@@ -153,9 +153,8 @@ void LLVMBasedBackwardsICFG::printAsDot(std::ostream &OS) const {
   ForwardICFG.printAsDot(OS);
 }
 
-void LLVMBasedBackwardsICFG::printInternalPTGAsDot(
-    const std::string &filename) {
-  ForwardICFG.printInternalPTGAsDot(filename);
+void LLVMBasedBackwardsICFG::printInternalPTGAsDot(std::ostream &OS) const {
+  ForwardICFG.printInternalPTGAsDot(OS);
 }
 
 nlohmann::json LLVMBasedBackwardsICFG::getAsJson() const {
diff --git a/lib/PhasarLLVM/ControlFlow/LLVMBasedICFG.cpp b/lib/PhasarLLVM/ControlFlow/LLVMBasedICFG.cpp
@@ -46,6 +46,7 @@
 
 #include <phasar/DB/ProjectIRDB.h>
 
+#include <phasar/PhasarLLVM/Pointer/LLVMPointsToGraph.h>
 #include <phasar/PhasarLLVM/Pointer/LLVMPointsToInfo.h>
 
 #include <phasar/PhasarLLVM/TypeHierarchy/LLVMTypeHierarchy.h>
@@ -525,14 +526,11 @@ void LLVMBasedICFG::printAsDot(std::ostream &OS) const {
                         makeCallGraphEdgeWriter(CallGraph));
 }
 
-void LLVMBasedICFG::printInternalPTGAsDot(const string &filename) {
-  ofstream ofs(filename);
+void LLVMBasedICFG::printInternalPTGAsDot(std::ostream &OS) const {
   boost::write_graphviz(
-      ofs, WholeModulePTG.PAG,
-      boost::make_label_writer(
-          boost::get(&PointsToGraph::VertexProperties::IR, WholeModulePTG.PAG)),
-      boost::make_label_writer(
-          boost::get(&PointsToGraph::EdgeProperties::IR, WholeModulePTG.PAG)));
+      OS, WholeModulePTG.PAG,
+      PointsToGraph::makePointerVertexOrEdgePrinter(WholeModulePTG.PAG),
+      PointsToGraph::makePointerVertexOrEdgePrinter(WholeModulePTG.PAG));
 }
 
 nlohmann::json LLVMBasedICFG::getAsJson() const {
diff --git a/lib/PhasarLLVM/Plugins/ICFGTestPlugin.cxx b/lib/PhasarLLVM/Plugins/ICFGTestPlugin.cxx
@@ -99,7 +99,9 @@ std::string ICFGTestPlugin::getFunctionName(ICFGTestPlugin::m_t fun) const {
 
 void ICFGTestPlugin::print(ICFGTestPlugin::m_t F, std::ostream &OS) const {}
 
-nlohmann::json ICFGTestPlugin::getAsJson(ICFGTestPlugin::m_t F) const { return ""; }
+nlohmann::json ICFGTestPlugin::getAsJson(ICFGTestPlugin::m_t F) const {
+  return "";
+}
 
 // ICFG parts
 
diff --git a/lib/PhasarLLVM/Pointer/LLVMPointsToGraph.cpp b/lib/PhasarLLVM/Pointer/LLVMPointsToGraph.cpp
@@ -117,15 +117,16 @@ struct PointsToGraph::ReachabilityDFSVisitor : boost::default_dfs_visitor {
 // points-to graph internal stuff
 
 PointsToGraph::VertexProperties::VertexProperties(const llvm::Value *V)
-    : V(V), IR(llvmIRToString(V)) {
-  // WARNING: equivalent to llvmIRToString
-  // WARNING 2 : really really really slow (yes it is)
+    : V(V) {}
+
+std::string PointsToGraph::VertexProperties::getValueAsString() const {
+  return llvmIRToString(V);
 }
 
-PointsToGraph::EdgeProperties::EdgeProperties(const llvm::Value *V)
-    : V(V), IR(llvmIRToString(V)) {
-  // WARNING: equivalent to llvmIRToString
-  // WARNING 2 : really really really slow (yes it is)
+PointsToGraph::EdgeProperties::EdgeProperties(const llvm::Value *V) : V(V) {}
+
+std::string PointsToGraph::EdgeProperties::getValueAsString() const {
+  return llvmIRToString(V);
 }
 
 // points-to graph stuff
@@ -235,7 +236,7 @@ PointsToGraph::PointsToGraph(llvm::Function *F, llvm::AAResults &AA) {
 vector<pair<unsigned, const llvm::Value *>>
 PointsToGraph::getPointersEscapingThroughParams() {
   vector<pair<unsigned, const llvm::Value *>> escaping_pointers;
-  for (pair<vertex_iterator_t, vertex_iterator_t> vp = boost::vertices(PAG);
+  for (pair<vertex_iterator, vertex_iterator> vp = boost::vertices(PAG);
        vp.first != vp.second; ++vp.first) {
     if (const llvm::Argument *arg =
             llvm::dyn_cast<llvm::Argument>(PAG[*vp.first].V)) {
@@ -248,7 +249,7 @@ PointsToGraph::getPointersEscapingThroughParams() {
 vector<const llvm::Value *>
 PointsToGraph::getPointersEscapingThroughReturns() const {
   vector<const llvm::Value *> escaping_pointers;
-  for (pair<vertex_iterator_t, vertex_iterator_t> vp = boost::vertices(PAG);
+  for (pair<vertex_iterator, vertex_iterator> vp = boost::vertices(PAG);
        vp.first != vp.second; ++vp.first) {
     for (auto user : PAG[*vp.first].V->users()) {
       if (llvm::isa<llvm::ReturnInst>(user)) {
@@ -263,7 +264,7 @@ vector<const llvm::Value *>
 PointsToGraph::getPointersEscapingThroughReturnsForFunction(
     const llvm::Function *F) const {
   vector<const llvm::Value *> escaping_pointers;
-  for (pair<vertex_iterator_t, vertex_iterator_t> vp = boost::vertices(PAG);
+  for (pair<vertex_iterator, vertex_iterator> vp = boost::vertices(PAG);
        vp.first != vp.second; ++vp.first) {
     for (auto user : PAG[*vp.first].V->users()) {
       if (auto R = llvm::dyn_cast<llvm::ReturnInst>(user)) {
@@ -289,7 +290,7 @@ set<const llvm::Value *> PointsToGraph::getReachableAllocationSites(
 }
 
 bool PointsToGraph::containsValue(llvm::Value *V) {
-  pair<vertex_iterator_t, vertex_iterator_t> vp;
+  pair<vertex_iterator, vertex_iterator> vp;
   for (vp = boost::vertices(PAG); vp.first != vp.second; ++vp.first)
     if (PAG[*vp.first].V == V)
       return true;
@@ -353,33 +354,37 @@ bool PointsToGraph::representsSingleFunction() {
 void PointsToGraph::print(std::ostream &OS) const {
   for (const auto &Fn : ContainedFunctions) {
     cout << "PointsToGraph for " << Fn << ":\n";
-    boost::print_graph(
-        PAG, boost::get(&PointsToGraph::VertexProperties::IR, PAG), OS);
+    vertex_iterator ui, ui_end;
+    for (boost::tie(ui, ui_end) = boost::vertices(PAG); ui != ui_end; ++ui) {
+      OS << PAG[*ui].getValueAsString() << " <--> ";
+      out_edge_iterator ei, ei_end;
+      for (boost::tie(ei, ei_end) = boost::out_edges(*ui, PAG); ei != ei_end;
+           ++ei) {
+        OS << PAG[target(*ei, PAG)].getValueAsString() << " ";
+      }
+      OS << '\n';
+    }
   }
 }
 
-void PointsToGraph::printAsDot(const string &filename) {
-  ofstream ofs(filename);
-  boost::write_graphviz(ofs, PAG,
-                        boost::make_label_writer(boost::get(
-                            &PointsToGraph::VertexProperties::IR, PAG)),
-                        boost::make_label_writer(boost::get(
-                            &PointsToGraph::EdgeProperties::IR, PAG)));
+void PointsToGraph::printAsDot(std::ostream &OS) const {
+  boost::write_graphviz(OS, PAG, makePointerVertexOrEdgePrinter(PAG),
+                        makePointerVertexOrEdgePrinter(PAG));
 }
 
 nlohmann::json PointsToGraph::getAsJson() {
   nlohmann::json J;
-  vertex_iterator_t vi_v, vi_v_end;
-  out_edge_iterator_t ei, ei_end;
+  vertex_iterator vi_v, vi_v_end;
+  out_edge_iterator ei, ei_end;
   // iterate all graph vertices
   for (boost::tie(vi_v, vi_v_end) = boost::vertices(PAG); vi_v != vi_v_end;
        ++vi_v) {
-    J[PhasarConfig::JsonPointToGraphID()][llvmIRToString(PAG[*vi_v].V)];
+    J[PhasarConfig::JsonPointToGraphID()][PAG[*vi_v].getValueAsString()];
     // iterate all out edges of vertex vi_v
     for (boost::tie(ei, ei_end) = boost::out_edges(*vi_v, PAG); ei != ei_end;
          ++ei) {
-      J[PhasarConfig::JsonPointToGraphID()][llvmIRToString(PAG[*vi_v].V)] +=
-          llvmIRToString(PAG[boost::target(*ei, PAG)].V);
+      J[PhasarConfig::JsonPointToGraphID()][PAG[*vi_v].getValueAsString()] +=
+          PAG[boost::target(*ei, PAG)].getValueAsString();
     }
   }
   return J;
@@ -398,7 +403,7 @@ void PointsToGraph::mergeWith(const PointsToGraph *Other,
     copy_graph<PointsToGraph::graph_t, PointsToGraph::vertex_t>(PAG,
                                                                 Other->PAG);
     ValueVertexMap.clear();
-    vertex_iterator_t vi, vi_end;
+    vertex_iterator vi, vi_end;
     for (boost::tie(vi, vi_end) = boost::vertices(PAG); vi != vi_end; ++vi) {
       ValueVertexMap.insert(make_pair(PAG[*vi].V, *vi));
     }
@@ -447,7 +452,7 @@ void PointsToGraph::mergeWith(
                PointsToGraph::EdgeProperties, const llvm::Instruction *>(
       PAG, Other.PAG, v_in_g1_u_in_g2);
   ValueVertexMap.clear();
-  vertex_iterator_t vi, vi_end;
+  vertex_iterator vi, vi_end;
   for (boost::tie(vi, vi_end) = boost::vertices(PAG); vi != vi_end; ++vi) {
     ValueVertexMap.insert(make_pair(PAG[*vi].V, *vi));
   }
@@ -478,10 +483,9 @@ void PointsToGraph::mergeWith(PointsToGraph *Other, llvm::ImmutableCallSite CS,
     }
   } else {
     ContainedFunctions.insert(F->getName().str());
-    // TODO this function has to check if F's points-to graph is already merged
-    // into the 'this' points-to graph. If so, is is not allowed to copy it a
-    // second
-    // time into 'this' PAG.
+    // TODO this function has to check if F's points-to graph is already
+    // merged into the 'this' points-to graph. If so, is is not allowed to
+    // copy it a second time into 'this' PAG.
     vector<pair<PointsToGraph::vertex_t, PointsToGraph::vertex_t>>
         v_in_g1_u_in_g2;
     for (unsigned i = 0; i < CS.getNumArgOperands(); ++i) {
@@ -509,8 +513,8 @@ void PointsToGraph::mergeWith(PointsToGraph *Other, llvm::ImmutableCallSite CS,
         typename std::vector<PointsToGraph::vertex_t>::iterator, index_map_t,
         PointsToGraph::vertex_t, PointsToGraph::vertex_t &>
         IsoMap;
-    // for more generic graphs, one can try typedef std::map<vertex_t, vertex_t>
-    // IsoMap;
+    // for more generic graphs, one can try typedef std::map<vertex_t,
+    // vertex_t> IsoMap;
     vector<PointsToGraph::vertex_t> orig2copy_data(
         boost::num_vertices(Other->PAG));
     IsoMap mapV = boost::make_iterator_property_map(
@@ -523,7 +527,7 @@ void PointsToGraph::mergeWith(PointsToGraph *Other, llvm::ImmutableCallSite CS,
     }
   }
   ValueVertexMap.clear();
-  vertex_iterator_t vi, vi_end;
+  vertex_iterator vi, vi_end;
   for (boost::tie(vi, vi_end) = boost::vertices(PAG); vi != vi_end; ++vi) {
     ValueVertexMap.insert(make_pair(PAG[*vi].V, *vi));
   }
diff --git a/tools/example-tool/myphasartool.cpp b/tools/example-tool/myphasartool.cpp
@@ -50,8 +50,6 @@ int main(int argc, const char **argv) {
     LLVMBasedICFG I(DB, CallGraphAnalysisType::OTF, {"main"}, &H, &P);
     // print inter-procedural control-flow graph
     I.print();
-    std::ofstream ofs("cg.dot");
-    I.printAsDot(ofs);
     // IFDS template parametrization test
     std::cout << "Testing IFDS:\n";
     IFDSLinearConstantAnalysis L(&DB, &H, &I, &P, {"main"});
diff --git a/unittests/PhasarLLVM/ControlFlow/LLVMBasedICFG_OTFTest.cpp b/unittests/PhasarLLVM/ControlFlow/LLVMBasedICFG_OTFTest.cpp
@@ -51,8 +51,8 @@ TEST_F(LLVMBasedICFG_OTFTest, VirtualCallSite_7) {
 //   LLVMPointsToInfo PT(IRDB);
 //   LLVMBasedICFG ICFG(IRDB, CallGraphAnalysisType::OTF, {"main"}, &TH, &PT);
 //   const llvm::Function *F = IRDB.getFunctionDefinition("main");
-//   const llvm::Function *FooC = IRDB.getFunctionDefinition("_ZZ4mainEN1C3fooEv");
-//   ASSERT_TRUE(F);
+//   const llvm::Function *FooC =
+//   IRDB.getFunctionDefinition("_ZZ4mainEN1C3fooEv"); ASSERT_TRUE(F);
 //   ASSERT_TRUE(FooC);
 
 //   auto CS1 = getNthInstruction(F, 15);

Original file line number	Diff line number	Diff line change
`@@ -153,9 +153,8 @@ void LLVMBasedBackwardsICFG::printAsDot(std::ostream &OS) const {`
`153`	`153`	`ForwardICFG.printAsDot(OS);`
`154`	`154`	`}`
`155`	`155`
`156`		`-void LLVMBasedBackwardsICFG::printInternalPTGAsDot(`
`157`		`- const std::string &filename) {`
`158`		`- ForwardICFG.printInternalPTGAsDot(filename);`
	`156`	`+void LLVMBasedBackwardsICFG::printInternalPTGAsDot(std::ostream &OS) const {`
	`157`	`+ ForwardICFG.printInternalPTGAsDot(OS);`
`159`	`158`	`}`
`160`	`159`
`161`	`160`	`nlohmann::json LLVMBasedBackwardsICFG::getAsJson() const {`