optimized type hierarchy's vertex properties

Author: pdschubert

include/phasar/PhasarLLVM/TypeHierarchy/LLVMTypeHierarchy.h

@@ -18,17 +18,20 @@
 #define PHASAR_PHASARLLVM_TYPEHIERARCHY_LLVMTYPEHIERARCHY_H_
 
 #include <iostream>
+#include <optional>
 #include <set>
 #include <string>
 #include <unordered_map>
 #include <unordered_set>
 #include <vector>
 
-#include <gtest/gtest_prod.h>
-
 #include <boost/graph/adjacency_list.hpp>
 #include <boost/graph/graph_traits.hpp>
 
+#include <llvm/ADT/StringRef.h>
+
+#include <gtest/gtest_prod.h>
+
 #include <json.hpp>
 
 #include <phasar/PhasarLLVM/TypeHierarchy/LLVMVFTable.h>
@@ -38,6 +41,7 @@ namespace llvm {
 class Module;
 class StructType;
 class Function;
+class GlobalVariable;
 } // namespace llvm
 
 namespace psr {
@@ -57,9 +61,9 @@ class LLVMTypeHierarchy
     VertexProperties() = default;
     VertexProperties(const llvm::StructType *Type);
     const llvm::StructType *Type = nullptr;
-    std::string TypeName = "";
-    LLVMVFTable VFT;
+    std::optional<LLVMVFTable> VFT;
     std::set<const llvm::StructType *> ReachableTypes;
+    std::string getTypeName() const;
   };
 
   /// Edges in the class hierarchy graph doesn't hold any additional
@@ -203,6 +207,25 @@ class LLVMTypeHierarchy
    */
   void printTransitiveClosure(std::ostream &OS = std::cout) const;
 
+  // provide a VertexPropertyWrite to tell boost how to write a vertex
+  class TypeHierarchyVertexWriter {
+  public:
+    TypeHierarchyVertexWriter(const bidigraph_t &TyGraph) : TyGraph(TyGraph) {}
+    template <class VertexOrEdge>
+    void operator()(std::ostream &out, const VertexOrEdge &v) const {
+      out << "[label=\"" << TyGraph[v].getTypeName() << "\"]";
+    }
+
+  private:
+    const bidigraph_t &TyGraph;
+  };
+
+  // a function to conveniently create this writer
+  TypeHierarchyVertexWriter
+  makeTypeHierarchyVertexWriter(const bidigraph_t &TyGraph) const {
+    return TypeHierarchyVertexWriter(TyGraph);
+  }
+
   /**
    * 	@brief Prints the class hierarchy to an ostream in dot format.
    * 	@param an outputstream

lib/PhasarLLVM/TypeHierarchy/LLVMTypeHierarchy.cpp

@@ -30,6 +30,7 @@
 
 #include <llvm/IR/Constants.h>
 #include <llvm/IR/Function.h>
+#include <llvm/IR/GlobalVariable.h>
 #include <llvm/IR/InstIterator.h>
 #include <llvm/IR/Instructions.h>
 #include <llvm/IR/Module.h>
@@ -61,8 +62,11 @@ const std::string LLVMTypeHierarchy::TypeInfoPrefixDemang = "typeinfo for ";
 
 LLVMTypeHierarchy::VertexProperties::VertexProperties(
     const llvm::StructType *Type)
-    : Type(Type), TypeName(Type->getStructName().str()), VFT(),
-      ReachableTypes({Type}) {}
+    : Type(Type), ReachableTypes({Type}) {}
+
+std::string LLVMTypeHierarchy::VertexProperties::getTypeName() const {
+  return Type->getStructName().str();
+}
 
 LLVMTypeHierarchy::LLVMTypeHierarchy(ProjectIRDB &IRDB) {
   PAMM_GET_INSTANCE;
@@ -337,18 +341,16 @@ bool LLVMTypeHierarchy::empty() const { return size() == 0; }
 
 void LLVMTypeHierarchy::print(std::ostream &OS) const {
   OS << "Type Hierarchy:\n";
-  boost::print_graph(TypeGraph,
-                     boost::get(&VertexProperties::TypeName, TypeGraph), OS);
-  // vertex_iterator_t ui, ui_end;
-  // for (boost::tie(ui, ui_end) = boost::vertices(TypeGraph); ui != ui_end;
-  // ++ui) {
-  //   OS << TypeGraph[*ui].TypeName << " --> ";
-  //   out_edge_iterator_t ei, ei_end;
-  //   for (boost::tie(ei, ei_end) = boost::out_edges(*ui, TypeGraph); ei !=
-  //   ei_end; ++ei)
-  //     OS << TypeGraph[target(*ei, TypeGraph)].TypeName << " ";
-  //   OS << '\n';
-  // }
+  vertex_iterator_t ui, ui_end;
+  for (boost::tie(ui, ui_end) = boost::vertices(TypeGraph); ui != ui_end;
+       ++ui) {
+    OS << TypeGraph[*ui].getTypeName() << " --> ";
+    out_edge_iterator_t ei, ei_end;
+    for (boost::tie(ei, ei_end) = boost::out_edges(*ui, TypeGraph);
+         ei != ei_end; ++ei)
+      OS << TypeGraph[target(*ei, TypeGraph)].getTypeName() << " ";
+    OS << '\n';
+  }
   OS << "VFTables:\n";
   for (const auto &[Ty, VFT] : TypeVFTMap) {
     OS << "Virtual function table for: " << Ty->getName().str() << '\n';
@@ -365,12 +367,12 @@ nlohmann::json LLVMTypeHierarchy::getAsJson() const {
   // iterate all graph vertices
   for (boost::tie(vi_v, vi_v_end) = boost::vertices(TypeGraph);
        vi_v != vi_v_end; ++vi_v) {
-    J[PhasarConfig::JsonTypeHierarchyID()][TypeGraph[*vi_v].TypeName];
+    J[PhasarConfig::JsonTypeHierarchyID()][TypeGraph[*vi_v].getTypeName()];
     // iterate all out edges of vertex vi_v
     for (boost::tie(ei, ei_end) = boost::out_edges(*vi_v, TypeGraph);
          ei != ei_end; ++ei) {
-      J[PhasarConfig::JsonTypeHierarchyID()][TypeGraph[*vi_v].TypeName] +=
-          TypeGraph[boost::target(*ei, TypeGraph)].TypeName;
+      J[PhasarConfig::JsonTypeHierarchyID()][TypeGraph[*vi_v].getTypeName()] +=
+          TypeGraph[boost::target(*ei, TypeGraph)].getTypeName();
     }
   }
   return J;
@@ -424,8 +426,7 @@ nlohmann::json LLVMTypeHierarchy::getAsJson() const {
 
 void LLVMTypeHierarchy::printAsDot(std::ostream &OS) const {
   boost::write_graphviz(OS, TypeGraph,
-                        boost::make_label_writer(boost::get(
-                            &VertexProperties::TypeName, TypeGraph)));
+                        makeTypeHierarchyVertexWriter(TypeGraph));
 }
 
 // void LLVMTypeHierarchy::printGraphAsDot(ostream &out) {

tools/example-tool/myphasartool.cpp

@@ -8,6 +8,7 @@
  *****************************************************************************/
 
 #include <iostream>
+#include <fstream>
 
 #include <boost/filesystem/operations.hpp>
 
@@ -49,6 +50,8 @@ 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"});