Remove a ton of extraneous #includes
[oota-llvm.git] / include / llvm / Analysis / DataStructure / DSGraph.h
index 3ec567e6655d13a68b71a3730940fc10167cd71c..9a897b2c97c153d9f94b11c052e4a73789b6019b 100644 (file)
 class DSGraph {
   Function *Func;          // Func - The LLVM function this graph corresponds to
   DSGraph *GlobalsGraph;   // Pointer to the common graph of global objects
+  bool PrintAuxCalls;      // Should this graph print the Aux calls vector?
 
   DSNodeHandle RetNode;    // The node that gets returned...
   std::vector<DSNode*> Nodes;
-  std::map<Value*, DSNodeHandle> ScalarMap;
+  hash_map<Value*, DSNodeHandle> ScalarMap;
 
   // FunctionCalls - This vector maintains a single entry for each call
   // instruction in the current graph.  The first entry in the vector is the
@@ -36,7 +37,8 @@ class DSGraph {
 
   void operator=(const DSGraph &); // DO NOT IMPLEMENT
 public:
-  DSGraph() : Func(0), GlobalsGraph(0) {}      // Create a new, empty, DSGraph.
+  // Create a new, empty, DSGraph.
+  DSGraph() : Func(0), GlobalsGraph(0), PrintAuxCalls(false) {}
   DSGraph(Function &F, DSGraph *GlobalsGraph); // Compute the local DSGraph
 
   // Copy ctor - If you want to capture the node mapping between the source and
@@ -48,15 +50,24 @@ public:
   // method.
   //
   DSGraph(const DSGraph &DSG);
-  DSGraph(const DSGraph &DSG, std::map<const DSNode*, DSNodeHandle> &NodeMap);
+  DSGraph(const DSGraph &DSG, hash_map<const DSNode*, DSNodeHandle> &NodeMap);
   ~DSGraph();
 
   bool hasFunction() const { return Func != 0; }
-  Function &getFunction() const { return *Func; }
+  Function &getFunction() const {
+    assert(hasFunction() && "Cannot call getFunction on graph without a fn!");
+    return *Func;
+  }
 
   DSGraph *getGlobalsGraph() const { return GlobalsGraph; }
   void setGlobalsGraph(DSGraph *G) { GlobalsGraph = G; }
 
+  // setPrintAuxCalls - If you call this method, the auxillary call vector will
+  // be printed instead of the standard call vector to the dot file.
+  //
+  void setPrintAuxCalls() { PrintAuxCalls = true; }
+  bool shouldPrintAuxCalls() const { return PrintAuxCalls; }
+
   /// getNodes - Get a vector of all the nodes in the graph
   /// 
   const std::vector<DSNode*> &getNodes() const { return Nodes; }
@@ -69,8 +80,8 @@ public:
   /// getScalarMap - Get a map that describes what the nodes the scalars in this
   /// function point to...
   ///
-  std::map<Value*, DSNodeHandle> &getScalarMap() { return ScalarMap; }
-  const std::map<Value*, DSNodeHandle> &getScalarMap() const {return ScalarMap;}
+  hash_map<Value*, DSNodeHandle> &getScalarMap() { return ScalarMap; }
+  const hash_map<Value*, DSNodeHandle> &getScalarMap() const {return ScalarMap;}
 
   /// getFunctionCalls - Return the list of call sites in the original local
   /// graph...
@@ -85,6 +96,9 @@ public:
   std::vector<DSCallSite> &getAuxFunctionCalls() {
     return AuxFunctionCalls;
   }
+  const std::vector<DSCallSite> &getAuxFunctionCalls() const {
+    return AuxFunctionCalls;
+  }
 
   /// getNodeForValue - Given a value that is used or defined in the body of the
   /// current function, return the DSNode that it points to.
@@ -92,7 +106,7 @@ public:
   DSNodeHandle &getNodeForValue(Value *V) { return ScalarMap[V]; }
 
   const DSNodeHandle &getNodeForValue(Value *V) const {
-    std::map<Value*, DSNodeHandle>::const_iterator I = ScalarMap.find(V);
+    hash_map<Value*, DSNodeHandle>::const_iterator I = ScalarMap.find(V);
     assert(I != ScalarMap.end() &&
            "Use non-const lookup function if node may not be in the map");
     return I->second;
@@ -105,14 +119,26 @@ public:
     return Nodes.size();
   }
 
+  /// print - Print a dot graph to the specified ostream...
   void print(std::ostream &O) const;
+
+  /// dump - call print(std::cerr), for use from the debugger...
+  ///
   void dump() const;
+
+  /// viewGraph - Emit a dot graph, run 'dot', run gv on the postscript file,
+  /// then cleanup.  For use from the debugger.
+  void viewGraph() const;
+
   void writeGraphToFile(std::ostream &O, const std::string &GraphName) const;
 
-  // maskNodeTypes - Apply a mask to all of the node types in the graph.  This
-  // is useful for clearing out markers like Scalar or Incomplete.
-  //
-  void maskNodeTypes(unsigned char Mask);
+  /// maskNodeTypes - Apply a mask to all of the node types in the graph.  This
+  /// is useful for clearing out markers like Incomplete.
+  ///
+  void maskNodeTypes(unsigned Mask) {
+    for (unsigned i = 0, e = Nodes.size(); i != e; ++i)
+      Nodes[i]->maskNodeTypes(Mask);
+  }
   void maskIncompleteMarkers() { maskNodeTypes(~DSNode::Incomplete); }
 
   // markIncompleteNodes - Traverse the graph, identifying nodes that may be
@@ -124,15 +150,21 @@ public:
   // the scope of current analysis may have modified it), the 'Incomplete' flag
   // is added to the NodeType.
   //
-  void markIncompleteNodes(bool markFormalArgs = true);
+  enum MarkIncompleteFlags {
+    MarkFormalArgs = 1, IgnoreFormalArgs = 0,
+    IgnoreGlobals = 2, MarkGlobalsIncomplete = 0,
+  };
+  void markIncompleteNodes(unsigned Flags);
 
-  // removeDeadNodes - Use a more powerful reachability analysis to eliminate
-  // subgraphs that are unreachable.  This often occurs because the data
-  // structure doesn't "escape" into it's caller, and thus should be eliminated
-  // from the caller's graph entirely.  This is only appropriate to use when
-  // inlining graphs.
+  // removeDeadNodes - Use a reachability analysis to eliminate subgraphs that
+  // are unreachable.  This often occurs because the data structure doesn't
+  // "escape" into it's caller, and thus should be eliminated from the caller's
+  // graph entirely.  This is only appropriate to use when inlining graphs.
   //
-  void removeDeadNodes(bool KeepAllGlobals);
+  enum RemoveDeadNodesFlags {
+    RemoveUnreachableGlobals = 1, KeepUnreachableGlobals = 0,
+  };
+  void removeDeadNodes(unsigned Flags);
 
   // CloneFlags enum - Bits that may be passed into the cloneInto method to
   // specify how to clone the function graph.
@@ -140,6 +172,7 @@ public:
     StripAllocaBit        = 1 << 0, KeepAllocaBit     = 0 << 0,
     DontCloneCallNodes    = 1 << 1, CloneCallNodes    = 0 << 0,
     DontCloneAuxCallNodes = 1 << 2, CloneAuxCallNodes = 0 << 0,
+    StripModRefBits       = 1 << 3, KeepModRefBits    = 0 << 0,
   };
 
   // cloneInto - Clone the specified DSGraph into the current graph, returning
@@ -149,8 +182,8 @@ public:
   // being cloned.
   //
   DSNodeHandle cloneInto(const DSGraph &G,
-                         std::map<Value*, DSNodeHandle> &OldValMap,
-                         std::map<const DSNode*, DSNodeHandle> &OldNodeMap,
+                         hash_map<Value*, DSNodeHandle> &OldValMap,
+                         hash_map<const DSNode*, DSNodeHandle> &OldNodeMap,
                          unsigned CloneFlags = 0);
 
   /// mergeInGraph - The method is used for merging graphs together.  If the
@@ -161,15 +194,42 @@ public:
   ///
   void mergeInGraph(DSCallSite &CS, const DSGraph &Graph, unsigned CloneFlags);
 
-private:
-  bool isNodeDead(DSNode *N);
+  // Methods for checking to make sure graphs are well formed...
+  void AssertNodeInGraph(const DSNode *N) const {
+    assert((!N || find(Nodes.begin(), Nodes.end(), N) != Nodes.end()) &&
+           "AssertNodeInGraph: Node is not in graph!");
+  }
+  void AssertNodeContainsGlobal(const DSNode *N, GlobalValue *GV) const {
+    assert(std::find(N->getGlobals().begin(), N->getGlobals().end(), GV) !=
+           N->getGlobals().end() && "Global value not in node!");
+  }
+
+  void AssertCallSiteInGraph(const DSCallSite &CS) const {
+    if (CS.isIndirectCall())
+      AssertNodeInGraph(CS.getCalleeNode());
+    AssertNodeInGraph(CS.getRetVal().getNode());
+    for (unsigned j = 0, e = CS.getNumPtrArgs(); j != e; ++j)
+      AssertNodeInGraph(CS.getPtrArg(j).getNode());
+  }
 
+  void AssertCallNodesInGraph() const {
+    for (unsigned i = 0, e = FunctionCalls.size(); i != e; ++i)
+      AssertCallSiteInGraph(FunctionCalls[i]);
+  }
+  void AssertAuxCallNodesInGraph() const {
+    for (unsigned i = 0, e = AuxFunctionCalls.size(); i != e; ++i)
+      AssertCallSiteInGraph(AuxFunctionCalls[i]);
+  }
+
+  void AssertGraphOK() const;
+
+public:
   // removeTriviallyDeadNodes - After the graph has been constructed, this
   // method removes all unreachable nodes that are created because they got
   // merged with other nodes in the graph.  This is used as the first step of
   // removeDeadNodes.
   //
-  void removeTriviallyDeadNodes(bool KeepAllGlobals = false);
+  void removeTriviallyDeadNodes();
 };
 
 #endif