tools/llvmc2/CompilationGraph.h

   1 //===--- CompilationGraph.h - The LLVM Compiler Driver ----------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open
   6 // Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  Compilation graph - definition.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_TOOLS_LLVMC2_COMPILATION_GRAPH_H
  15 #define LLVM_TOOLS_LLVMC2_COMPILATION_GRAPH_H
  16
  17 #include "AutoGenerated.h"
  18 #include "Tool.h"
  19
  20 #include "llvm/ADT/GraphTraits.h"
  21 #include "llvm/ADT/IntrusiveRefCntPtr.h"
  22 #include "llvm/ADT/iterator"
  23 #include "llvm/ADT/SmallVector.h"
  24 #include "llvm/ADT/StringMap.h"
  25 #include "llvm/System/Path.h"
  26
  27 #include <string>
  28
  29 namespace llvmc {
  30
  31   // An edge of the compilation graph.
  32   class Edge : public llvm::RefCountedBaseVPTR<Edge> {
  33   public:
  34     Edge(const std::string& T) : ToolName_(T) {}
  35     virtual ~Edge() {};
  36
  37     const std::string& ToolName() const { return ToolName_; }
  38     virtual bool isEnabled() const = 0;
  39     virtual bool isDefault() const = 0;
  40   private:
  41     std::string ToolName_;
  42   };
  43
  44   // Edges that have no properties are instances of this class.
  45   class SimpleEdge : public Edge {
  46   public:
  47     SimpleEdge(const std::string& T) : Edge(T) {}
  48     bool isEnabled() const { return false;}
  49     bool isDefault() const { return true;}
  50   };
  51
  52   // A node of the compilation graph.
  53   struct Node {
  54     // A Node holds a list of the outward edges.
  55     typedef llvm::SmallVector<llvm::IntrusiveRefCntPtr<Edge>, 3> container_type;
  56     typedef container_type::iterator iterator;
  57     typedef container_type::const_iterator const_iterator;
  58
  59     Node() : OwningGraph(0), InEdges(0) {}
  60     Node(CompilationGraph* G) : OwningGraph(G), InEdges(0) {}
  61     Node(CompilationGraph* G, Tool* T) :
  62       OwningGraph(G), ToolPtr(T), InEdges(0) {}
  63
  64     bool HasChildren() const { return !OutEdges.empty(); }
  65     const std::string Name() const
  66     { return ToolPtr ? ToolPtr->Name() : "root"; }
  67
  68     // Iteration.
  69     iterator EdgesBegin() { return OutEdges.begin(); }
  70     const_iterator EdgesBegin() const { return OutEdges.begin(); }
  71     iterator EdgesEnd() { return OutEdges.end(); }
  72     const_iterator EdgesEnd() const { return OutEdges.end(); }
  73
  74     // Add an outward edge. Takes ownership of the Edge object.
  75     void AddEdge(Edge* E)
  76     { OutEdges.push_back(llvm::IntrusiveRefCntPtr<Edge>(E)); }
  77
  78     // Inward edge counter. Used to implement topological sort.
  79     // TOTHINK: Move the mutable counter back into Tool classes? Makes
  80     // us more const-correct.
  81     void IncrInEdges() { ++InEdges; }
  82     void DecrInEdges() { --InEdges; }
  83     bool HasNoInEdges() const { return InEdges == 0; }
  84
  85     // Needed to implement NodeChildIterator/GraphTraits
  86     CompilationGraph* OwningGraph;
  87     // The corresponding Tool.
  88     // WARNING: ToolPtr can be NULL (for the root node).
  89     llvm::IntrusiveRefCntPtr<Tool> ToolPtr;
  90     // Links to children.
  91     container_type OutEdges;
  92     // Inward edge counter. Updated in
  93     // CompilationGraph::insertEdge(). Used for topological sorting.
  94     unsigned InEdges;
  95   };
  96
  97   class NodesIterator;
  98
  99   // The compilation graph itself.
 100   class CompilationGraph {
 101     // Main data structure.
 102     typedef llvm::StringMap<Node> nodes_map_type;
 103     // These are used to map from language names to tools. (We can
 104     // have several tools associated with each language name, hence
 105     // the need for a vector of Edges.)
 106     typedef
 107     llvm::SmallVector<llvm::IntrusiveRefCntPtr<Edge>, 3> tools_vector_type;
 108     typedef llvm::StringMap<tools_vector_type> tools_map_type;
 109
 110     // Map from file extensions to language names.
 111     LanguageMap ExtsToLangs;
 112     // Map from language names to lists of tool names.
 113     tools_map_type ToolsMap;
 114     // Map from tool names to Tool objects.
 115     nodes_map_type NodesMap;
 116
 117   public:
 118
 119     CompilationGraph();
 120
 121     // insertVertex - insert a new node into the graph. Takes
 122     // ownership of the object.
 123     void insertNode(Tool* T);
 124
 125     // insertEdge - Insert a new edge into the graph. Takes ownership
 126     // of the Edge object.
 127     void insertEdge(const std::string& A, Edge* E);
 128
 129     // Build - Build target(s) from the input file set. Command-line
 130     // options are passed implicitly as global variables.
 131     int Build(llvm::sys::Path const& tempDir);
 132
 133     // Return a reference to the node correponding to the given tool
 134     // name. Throws std::runtime_error.
 135     Node& getNode(const std::string& ToolName);
 136     const Node& getNode(const std::string& ToolName) const;
 137
 138     // viewGraph - This function is meant for use from the debugger.
 139     // You can just say 'call G->viewGraph()' and a ghostview window
 140     // should pop up from the program, displaying the compilation
 141     // graph. This depends on there being a 'dot' and 'gv' program
 142     // in your path.
 143     void viewGraph();
 144
 145     // Write a CompilationGraph.dot file.
 146     void writeGraph();
 147
 148     // GraphTraits support
 149     friend NodesIterator GraphBegin(CompilationGraph*);
 150     friend NodesIterator GraphEnd(CompilationGraph*);
 151     friend void PopulateCompilationGraph(CompilationGraph&);
 152
 153   private:
 154     // Helper functions.
 155
 156     // Find out which language corresponds to the suffix of this file.
 157     const std::string& getLanguage(const llvm::sys::Path& File) const;
 158
 159     // Return a reference to the list of tool names corresponding to
 160     // the given language name. Throws std::runtime_error.
 161     const tools_vector_type& getToolsVector(const std::string& LangName) const;
 162
 163     // Pass the input file through the toolchain.
 164     void PassThroughGraph (const llvm::sys::Path& In, const Node* StartNode,
 165                            const llvm::sys::Path& TempDir) const;
 166
 167     // Find head of the toolchain corresponding to the given file.
 168     const Node* FindToolChain(const llvm::sys::Path& In,
 169                               const std::string* forceLanguage) const;
 170
 171     // Sort the nodes in topological order.
 172     void TopologicalSort(std::vector<const Node*>& Out);
 173     // Call TopologicalSort and filter the resulting list to include
 174     // only Join nodes.
 175     void TopologicalSortFilterJoinNodes(std::vector<const Node*>& Out);
 176   };
 177
 178   /// GraphTraits support code.
 179
 180   // Auxiliary class needed to implement GraphTraits support.  Can be
 181   // generalised to something like value_iterator for map-like
 182   // containers.
 183   class NodesIterator : public llvm::StringMap<Node>::iterator {
 184     typedef llvm::StringMap<Node>::iterator super;
 185     typedef NodesIterator ThisType;
 186     typedef Node* pointer;
 187     typedef Node& reference;
 188
 189   public:
 190     NodesIterator(super I) : super(I) {}
 191
 192     inline reference operator*() const {
 193       return super::operator->()->second;
 194     }
 195     inline pointer operator->() const {
 196       return &super::operator->()->second;
 197     }
 198   };
 199
 200   inline NodesIterator GraphBegin(CompilationGraph* G) {
 201     return NodesIterator(G->NodesMap.begin());
 202   }
 203
 204   inline NodesIterator GraphEnd(CompilationGraph* G) {
 205     return NodesIterator(G->NodesMap.end());
 206   }
 207
 208
 209   // Another auxiliary class needed by GraphTraits.
 210   class NodeChildIterator : public bidirectional_iterator<Node, ptrdiff_t> {
 211     typedef NodeChildIterator ThisType;
 212     typedef Node::container_type::iterator iterator;
 213
 214     CompilationGraph* OwningGraph;
 215     iterator EdgeIter;
 216   public:
 217     typedef Node* pointer;
 218     typedef Node& reference;
 219
 220     NodeChildIterator(Node* N, iterator I) :
 221       OwningGraph(N->OwningGraph), EdgeIter(I) {}
 222
 223     const ThisType& operator=(const ThisType& I) {
 224       assert(OwningGraph == I.OwningGraph);
 225       EdgeIter = I.EdgeIter;
 226       return *this;
 227     }
 228
 229     inline bool operator==(const ThisType& I) const
 230     { return EdgeIter == I.EdgeIter; }
 231     inline bool operator!=(const ThisType& I) const
 232     { return EdgeIter != I.EdgeIter; }
 233
 234     inline pointer operator*() const {
 235       return &OwningGraph->getNode((*EdgeIter)->ToolName());
 236     }
 237     inline pointer operator->() const {
 238       return &OwningGraph->getNode((*EdgeIter)->ToolName());
 239     }
 240
 241     ThisType& operator++() { ++EdgeIter; return *this; } // Preincrement
 242     ThisType operator++(int) { // Postincrement
 243       ThisType tmp = *this;
 244       ++*this;
 245       return tmp;
 246     }
 247
 248     inline ThisType& operator--() { --EdgeIter; return *this; }  // Predecrement
 249     inline ThisType operator--(int) { // Postdecrement
 250       ThisType tmp = *this;
 251       --*this;
 252       return tmp;
 253     }
 254
 255   };
 256 }
 257
 258 namespace llvm {
 259   template <>
 260   struct GraphTraits<llvmc::CompilationGraph*> {
 261     typedef llvmc::CompilationGraph GraphType;
 262     typedef llvmc::Node NodeType;
 263     typedef llvmc::NodeChildIterator ChildIteratorType;
 264
 265     static NodeType* getEntryNode(GraphType* G) {
 266       return &G->getNode("root");
 267     }
 268
 269     static ChildIteratorType child_begin(NodeType* N) {
 270       return ChildIteratorType(N, N->OutEdges.begin());
 271     }
 272     static ChildIteratorType child_end(NodeType* N) {
 273       return ChildIteratorType(N, N->OutEdges.end());
 274     }
 275
 276     typedef llvmc::NodesIterator nodes_iterator;
 277     static nodes_iterator nodes_begin(GraphType *G) {
 278       return GraphBegin(G);
 279     }
 280     static nodes_iterator nodes_end(GraphType *G) {
 281       return GraphEnd(G);
 282     }
 283   };
 284
 285 }
 286
 287 #endif // LLVM_TOOLS_LLVMC2_COMPILATION_GRAPH_H