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 llvmcc {
  30
  31   // An edge in the 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 with 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 in the graph.
  53   struct Node {
  54     typedef llvm::SmallVector<llvm::IntrusiveRefCntPtr<Edge>, 3> container_type;
  55     typedef container_type::iterator iterator;
  56     typedef container_type::const_iterator const_iterator;
  57
  58     Node() : OwningGraph(0), InEdges(0) {}
  59     Node(CompilationGraph* G) : OwningGraph(G), InEdges(0) {}
  60     Node(CompilationGraph* G, Tool* T) :
  61       OwningGraph(G), ToolPtr(T), InEdges(0) {}
  62
  63     bool HasChildren() const { return !OutEdges.empty(); }
  64     const std::string Name() const { return ToolPtr->Name(); }
  65
  66     // Iteration.
  67     iterator EdgesBegin() { return OutEdges.begin(); }
  68     const_iterator EdgesBegin() const { return OutEdges.begin(); }
  69     iterator EdgesEnd() { return OutEdges.end(); }
  70     const_iterator EdgesEnd() const { return OutEdges.end(); }
  71
  72     // Choose one of the outward edges based on command-line options.
  73     const Edge* ChooseEdge() const;
  74
  75     // Add an outward edge. Takes ownership of the Edge object.
  76     void AddEdge(Edge* E)
  77     { OutEdges.push_back(llvm::IntrusiveRefCntPtr<Edge>(E)); }
  78
  79     // Inward edge counter. Used by Build() to implement topological
  80     // sort.
  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     llvm::IntrusiveRefCntPtr<Tool> ToolPtr;
  89     // Links to children.
  90     container_type OutEdges;
  91     // Number of parents.
  92     unsigned InEdges;
  93   };
  94
  95   class NodesIterator;
  96
  97   class CompilationGraph {
  98     typedef llvm::SmallVector<std::string, 3> tools_vector_type;
  99     typedef llvm::StringMap<tools_vector_type> tools_map_type;
 100     typedef llvm::StringMap<Node> nodes_map_type;
 101
 102     // Map from file extensions to language names.
 103     LanguageMap ExtsToLangs;
 104     // Map from language names to lists of tool names.
 105     tools_map_type ToolsMap;
 106     // Map from tool names to Tool objects.
 107     nodes_map_type NodesMap;
 108
 109   public:
 110
 111     CompilationGraph();
 112
 113     // insertVertex - insert a new node into the graph. Takes
 114     // ownership of the object.
 115     void insertNode(Tool* T);
 116
 117     // insertEdge - Insert a new edge into the graph. Takes ownership
 118     // of the Edge object.
 119     void insertEdge(const std::string& A, Edge* E);
 120
 121     // Build - Build target(s) from the input file set. Command-line
 122     // options are passed implicitly as global variables.
 123     int Build(llvm::sys::Path const& tempDir) const;
 124
 125     // Return a reference to the node correponding to the given tool
 126     // name. Throws std::runtime_error.
 127     Node& getNode(const std::string& ToolName);
 128     const Node& getNode(const std::string& ToolName) const;
 129
 130     // viewGraph - This function is meant for use from the debugger.
 131     // You can just say 'call G->viewGraph()' and a ghostview window
 132     // should pop up from the program, displaying the compilation
 133     // graph. This depends on there being a 'dot' and 'gv' program
 134     // in your path.
 135     void viewGraph();
 136
 137     // Write a CompilationGraph.dot file.
 138     void writeGraph();
 139
 140     // GraphTraits support
 141     friend NodesIterator GraphBegin(CompilationGraph*);
 142     friend NodesIterator GraphEnd(CompilationGraph*);
 143     friend void PopulateCompilationGraph(CompilationGraph&);
 144
 145   private:
 146     // Helper functions.
 147
 148     // Find out which language corresponds to the suffix of this file.
 149     const std::string& getLanguage(const llvm::sys::Path& File) const;
 150
 151     // Return a reference to the list of tool names corresponding to
 152     // the given language name. Throws std::runtime_error.
 153     const tools_vector_type& getToolsVector(const std::string& LangName) const;
 154
 155     // Pass the input file through the toolchain.
 156     const JoinTool* PassThroughGraph (llvm::sys::Path& In, llvm::sys::Path Out,
 157                                       const llvm::sys::Path& TempDir) const;
 158
 159   };
 160
 161   /// GraphTraits support code.
 162
 163   // Auxiliary class needed to implement GraphTraits support.  Can be
 164   // generalised to something like value_iterator for map-like
 165   // containers.
 166   class NodesIterator : public llvm::StringMap<Node>::iterator {
 167     typedef llvm::StringMap<Node>::iterator super;
 168     typedef NodesIterator ThisType;
 169     typedef Node* pointer;
 170     typedef Node& reference;
 171
 172   public:
 173     NodesIterator(super I) : super(I) {}
 174
 175     inline reference operator*() const {
 176       return super::operator->()->second;
 177     }
 178     inline pointer operator->() const {
 179       return &super::operator->()->second;
 180     }
 181   };
 182
 183   inline NodesIterator GraphBegin(CompilationGraph* G) {
 184     return NodesIterator(G->NodesMap.begin());
 185   }
 186
 187   inline NodesIterator GraphEnd(CompilationGraph* G) {
 188     return NodesIterator(G->NodesMap.end());
 189   }
 190
 191
 192   // Another auxiliary class needed by GraphTraits.
 193   class NodeChildIterator : public bidirectional_iterator<Node, ptrdiff_t> {
 194     typedef NodeChildIterator ThisType;
 195     typedef Node::container_type::iterator iterator;
 196
 197     CompilationGraph* OwningGraph;
 198     iterator EdgeIter;
 199   public:
 200     typedef Node* pointer;
 201     typedef Node& reference;
 202
 203     NodeChildIterator(Node* N, iterator I) :
 204       OwningGraph(N->OwningGraph), EdgeIter(I) {}
 205
 206     const ThisType& operator=(const ThisType& I) {
 207       assert(OwningGraph == I.OwningGraph);
 208       EdgeIter = I.EdgeIter;
 209       return *this;
 210     }
 211
 212     inline bool operator==(const ThisType& I) const
 213     { return EdgeIter == I.EdgeIter; }
 214     inline bool operator!=(const ThisType& I) const
 215     { return EdgeIter != I.EdgeIter; }
 216
 217     inline pointer operator*() const {
 218       return &OwningGraph->getNode((*EdgeIter)->ToolName());
 219     }
 220     inline pointer operator->() const {
 221       return &OwningGraph->getNode((*EdgeIter)->ToolName());
 222     }
 223
 224     ThisType& operator++() { ++EdgeIter; return *this; } // Preincrement
 225     ThisType operator++(int) { // Postincrement
 226       ThisType tmp = *this;
 227       ++*this;
 228       return tmp;
 229     }
 230
 231     inline ThisType& operator--() { --EdgeIter; return *this; }  // Predecrement
 232     inline ThisType operator--(int) { // Postdecrement
 233       ThisType tmp = *this;
 234       --*this;
 235       return tmp;
 236     }
 237
 238   };
 239 }
 240
 241 namespace llvm {
 242   template <>
 243   struct GraphTraits<llvmcc::CompilationGraph*> {
 244     typedef llvmcc::CompilationGraph GraphType;
 245     typedef llvmcc::Node NodeType;
 246     typedef llvmcc::NodeChildIterator ChildIteratorType;
 247
 248     static NodeType* getEntryNode(GraphType* G) {
 249       return &G->getNode("root");
 250     }
 251
 252     static ChildIteratorType child_begin(NodeType* N) {
 253       return ChildIteratorType(N, N->OutEdges.begin());
 254     }
 255     static ChildIteratorType child_end(NodeType* N) {
 256       return ChildIteratorType(N, N->OutEdges.end());
 257     }
 258
 259     typedef llvmcc::NodesIterator nodes_iterator;
 260     static nodes_iterator nodes_begin(GraphType *G) {
 261       return GraphBegin(G);
 262     }
 263     static nodes_iterator nodes_end(GraphType *G) {
 264       return GraphEnd(G);
 265     }
 266   };
 267
 268 }
 269
 270 #endif // LLVM_TOOLS_LLVMC2_COMPILATION_GRAPH_H