Added LLVM copyright header (for lack of a better term).
[oota-llvm.git] / include / llvm / Analysis / DSGraph.h
index eebefa5f5dd6dd451d21e16c20b2d6d1283e1fe9..fae11f4abe2ff32b79b5efdd24e30ac47214e914 100644 (file)
@@ -1,4 +1,11 @@
 //===- DSGraph.h - Represent a collection of data structures ----*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // This header defines the data structure graph.
 //
 #define LLVM_ANALYSIS_DSGRAPH_H
 
 #include "llvm/Analysis/DSNode.h"
+class GlobalValue;
 
 //===----------------------------------------------------------------------===//
 /// DSGraph - The graph that represents a function.
 ///
-class DSGraph {
-  Function *Func;          // Func - The LLVM function this graph corresponds to
+struct DSGraph {
+  // Public data-type declarations...
+  typedef hash_map<Value*, DSNodeHandle> ScalarMapTy;
+  typedef hash_map<Function*, DSNodeHandle> ReturnNodesTy;
+  typedef hash_set<const GlobalValue*> GlobalSetTy;
+
+  /// NodeMapTy - This data type is used when cloning one graph into another to
+  /// keep track of the correspondence between the nodes in the old and new
+  /// graphs.
+  typedef hash_map<const DSNode*, DSNodeHandle> NodeMapTy;
+private:
   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;
-  hash_map<Value*, DSNodeHandle> ScalarMap;
+  ScalarMapTy ScalarMap;
+
+  // ReturnNodes - A return value for every function merged into this graph.
+  // Each DSGraph may have multiple functions merged into it at any time, which
+  // is used for representing SCCs.
+  //
+  ReturnNodesTy ReturnNodes;
 
   // FunctionCalls - This vector maintains a single entry for each call
   // instruction in the current graph.  The first entry in the vector is the
@@ -35,10 +57,16 @@ class DSGraph {
   //
   std::vector<DSCallSite> AuxFunctionCalls;
 
+  // InlinedGlobals - This set records which globals have been inlined from
+  // other graphs (callers or callees, depending on the pass) into this one.
+  // 
+  GlobalSetTy InlinedGlobals;
+
   void operator=(const DSGraph &); // DO NOT IMPLEMENT
+
 public:
   // Create a new, empty, DSGraph.
-  DSGraph() : Func(0), GlobalsGraph(0), PrintAuxCalls(false) {}
+  DSGraph() : 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
@@ -50,15 +78,9 @@ public:
   // method.
   //
   DSGraph(const DSGraph &DSG);
-  DSGraph(const DSGraph &DSG, hash_map<const DSNode*, DSNodeHandle> &NodeMap);
+  DSGraph(const DSGraph &DSG, NodeMapTy &NodeMap);
   ~DSGraph();
 
-  bool hasFunction() const { return Func != 0; }
-  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; }
 
@@ -73,6 +95,10 @@ public:
   const std::vector<DSNode*> &getNodes() const { return Nodes; }
         std::vector<DSNode*> &getNodes()       { return Nodes; }
 
+  /// getFunctionNames - Return a space separated list of the name of the
+  /// functions in this graph (if any)
+  std::string getFunctionNames() const;
+
   /// addNode - Add a new node to the graph.
   ///
   void addNode(DSNode *N) { Nodes.push_back(N); }
@@ -80,8 +106,8 @@ public:
   /// getScalarMap - Get a map that describes what the nodes the scalars in this
   /// function point to...
   ///
-  hash_map<Value*, DSNodeHandle> &getScalarMap() { return ScalarMap; }
-  const hash_map<Value*, DSNodeHandle> &getScalarMap() const {return ScalarMap;}
+  ScalarMapTy &getScalarMap() { return ScalarMap; }
+  const ScalarMapTy &getScalarMap() const { return ScalarMap; }
 
   /// getFunctionCalls - Return the list of call sites in the original local
   /// graph...
@@ -100,26 +126,52 @@ public:
     return AuxFunctionCalls;
   }
 
+  /// getInlinedGlobals - Get the set of globals that are have been inlined
+  /// (from callees in BU or from callers in TD) into the current graph.
+  ///
+  GlobalSetTy& getInlinedGlobals() {
+    return InlinedGlobals;
+  }
+
   /// getNodeForValue - Given a value that is used or defined in the body of the
   /// current function, return the DSNode that it points to.
   ///
   DSNodeHandle &getNodeForValue(Value *V) { return ScalarMap[V]; }
 
   const DSNodeHandle &getNodeForValue(Value *V) const {
-    hash_map<Value*, DSNodeHandle>::const_iterator I = ScalarMap.find(V);
+    ScalarMapTy::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;
   }
 
-  const DSNodeHandle &getRetNode() const { return RetNode; }
-        DSNodeHandle &getRetNode()       { return RetNode; }
+  /// getReturnNodes - Return the mapping of functions to their return nodes for
+  /// this graph.
+  const ReturnNodesTy &getReturnNodes() const { return ReturnNodes; }
+        ReturnNodesTy &getReturnNodes()       { return ReturnNodes; }
+
+  /// getReturnNodeFor - Return the return node for the specified function.
+  ///
+  DSNodeHandle &getReturnNodeFor(Function &F) {
+    ReturnNodesTy::iterator I = ReturnNodes.find(&F);
+    assert(I != ReturnNodes.end() && "F not in this DSGraph!");
+    return I->second;
+  }
+
+  const DSNodeHandle &getReturnNodeFor(Function &F) const {
+    ReturnNodesTy::const_iterator I = ReturnNodes.find(&F);
+    assert(I != ReturnNodes.end() && "F not in this DSGraph!");
+    return I->second;
+  }
 
+  /// getGraphSize - Return the number of nodes in this graph.
+  ///
   unsigned getGraphSize() const {
     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...
@@ -135,9 +187,9 @@ public:
   /// 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 char Mask) {
+  void maskNodeTypes(unsigned Mask) {
     for (unsigned i = 0, e = Nodes.size(); i != e; ++i)
-      Nodes[i]->NodeType &= Mask;
+      Nodes[i]->maskNodeTypes(Mask);
   }
   void maskIncompleteMarkers() { maskNodeTypes(~DSNode::Incomplete); }
 
@@ -166,25 +218,40 @@ public:
   };
   void removeDeadNodes(unsigned Flags);
 
-  // CloneFlags enum - Bits that may be passed into the cloneInto method to
-  // specify how to clone the function graph.
+  /// CloneFlags enum - Bits that may be passed into the cloneInto method to
+  /// specify how to clone the function graph.
   enum CloneFlags {
-    StripAllocaBit        = 1 << 0, KeepAllocaBit     = 0 << 0,
-    DontCloneCallNodes    = 1 << 1, CloneCallNodes    = 0 << 0,
-    DontCloneAuxCallNodes = 1 << 2, CloneAuxCallNodes = 0 << 0,
-    StripModRefBits       = 1 << 3, KeepModRefBits    = 0 << 0,
+    StripAllocaBit        = 1 << 0, KeepAllocaBit     = 0,
+    DontCloneCallNodes    = 1 << 1, CloneCallNodes    = 0,
+    DontCloneAuxCallNodes = 1 << 2, CloneAuxCallNodes = 0,
+    StripModRefBits       = 1 << 3, KeepModRefBits    = 0,
+    StripIncompleteBit    = 1 << 4, KeepIncompleteBit = 0,
   };
 
-  // cloneInto - Clone the specified DSGraph into the current graph, returning
-  // the Return node of the graph.  The translated ScalarMap for the old
-  // function is filled into the OldValMap member.  If StripAllocas is set to
-  // 'StripAllocaBit', Alloca markers are removed from the graph as the graph is
-  // being cloned.
-  //
-  DSNodeHandle cloneInto(const DSGraph &G,
-                         hash_map<Value*, DSNodeHandle> &OldValMap,
-                         hash_map<const DSNode*, DSNodeHandle> &OldNodeMap,
-                         unsigned CloneFlags = 0);
+private:
+  void cloneReachableNodes(const DSNode*  Node,
+                           unsigned BitsToClear,
+                           NodeMapTy& OldNodeMap,
+                           NodeMapTy& CompletedNodeMap);
+
+public:
+  void updateFromGlobalGraph();
+
+  void cloneReachableSubgraph(const DSGraph& G,
+                              const hash_set<const DSNode*>& RootNodes,
+                              NodeMapTy& OldNodeMap,
+                              NodeMapTy& CompletedNodeMap,
+                              unsigned CloneFlags = 0);
+
+  /// cloneInto - Clone the specified DSGraph into the current graph.  The
+  /// translated ScalarMap for the old function is filled into the OldValMap
+  /// member, and the translated ReturnNodes map is returned into ReturnNodes.
+  ///
+  /// The CloneFlags member controls various aspects of the cloning process.
+  ///
+  void cloneInto(const DSGraph &G, ScalarMapTy &OldValMap,
+                 ReturnNodesTy &OldReturnNodes, NodeMapTy &OldNodeMap,
+                 unsigned CloneFlags = 0);
 
   /// mergeInGraph - The method is used for merging graphs together.  If the
   /// argument graph is not *this, it makes a clone of the specified graph, then
@@ -192,7 +259,14 @@ public:
   /// the graph.  If the StripAlloca's argument is 'StripAllocaBit' then Alloca
   /// markers are removed from nodes.
   ///
-  void mergeInGraph(DSCallSite &CS, const DSGraph &Graph, unsigned CloneFlags);
+  void mergeInGraph(const DSCallSite &CS, Function &F, const DSGraph &Graph,
+                    unsigned CloneFlags);
+
+
+  /// getCallSiteForArguments - Get the arguments and return value bindings for
+  /// the specified function in the current graph.
+  ///
+  DSCallSite getCallSiteForArguments(Function &F) const;
 
   // Methods for checking to make sure graphs are well formed...
   void AssertNodeInGraph(const DSNode *N) const {
@@ -223,12 +297,18 @@ public:
 
   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.
-  //
+  /// mergeInGlobalsGraph - This method is useful for clients to incorporate the
+  /// globals graph into the DS, BU or TD graph for a function.  This code
+  /// retains all globals, i.e., does not delete unreachable globals after they
+  /// are inlined.
+  ///
+  void mergeInGlobalsGraph();
+
+  /// 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();
 };