1 //===--- CompilationGraph.h - The LLVM Compiler Driver ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open
6 // Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Compilation graph - definition.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_TOOLS_LLVMC2_COMPILATION_GRAPH_H
15 #define LLVM_TOOLS_LLVMC2_COMPILATION_GRAPH_H
17 #include "AutoGenerated.h"
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"
31 // An edge of the compilation graph.
32 class Edge : public llvm::RefCountedBaseVPTR<Edge> {
34 Edge(const std::string& T) : ToolName_(T) {}
37 const std::string& ToolName() const { return ToolName_; }
38 virtual bool isEnabled() const = 0;
39 virtual bool isDefault() const = 0;
41 std::string ToolName_;
44 // Edges that have no properties are instances of this class.
45 class SimpleEdge : public Edge {
47 SimpleEdge(const std::string& T) : Edge(T) {}
48 bool isEnabled() const { return false;}
49 bool isDefault() const { return true;}
52 // A node of the compilation graph.
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;
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) {}
64 bool HasChildren() const { return !OutEdges.empty(); }
65 const std::string Name() const
66 { return ToolPtr ? ToolPtr->Name() : "root"; }
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(); }
74 // Add an outward edge. Takes ownership of the Edge object.
76 { OutEdges.push_back(llvm::IntrusiveRefCntPtr<Edge>(E)); }
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; }
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;
91 container_type OutEdges;
92 // Inward edge counter. Updated in
93 // CompilationGraph::insertEdge(). Used for topological sorting.
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.)
107 llvm::SmallVector<llvm::IntrusiveRefCntPtr<Edge>, 3> tools_vector_type;
108 typedef llvm::StringMap<tools_vector_type> tools_map_type;
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;
121 // insertVertex - insert a new node into the graph. Takes
122 // ownership of the object.
123 void insertNode(Tool* T);
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);
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);
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;
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
145 // Write a CompilationGraph.dot file.
148 // GraphTraits support
149 friend NodesIterator GraphBegin(CompilationGraph*);
150 friend NodesIterator GraphEnd(CompilationGraph*);
151 friend void PopulateCompilationGraph(CompilationGraph&);
156 // Find out which language corresponds to the suffix of this file.
157 const std::string& getLanguage(const llvm::sys::Path& File) const;
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;
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;
167 // Find head of the toolchain corresponding to the given file.
168 const Node* FindToolChain(const llvm::sys::Path& In) const;
170 // Sort the nodes in topological order.
171 void TopologicalSort(std::vector<const Node*>& Out);
172 // Call TopologicalSort and filter the resulting list to include
174 void TopologicalSortFilterJoinNodes(std::vector<const Node*>& Out);
177 /// GraphTraits support code.
179 // Auxiliary class needed to implement GraphTraits support. Can be
180 // generalised to something like value_iterator for map-like
182 class NodesIterator : public llvm::StringMap<Node>::iterator {
183 typedef llvm::StringMap<Node>::iterator super;
184 typedef NodesIterator ThisType;
185 typedef Node* pointer;
186 typedef Node& reference;
189 NodesIterator(super I) : super(I) {}
191 inline reference operator*() const {
192 return super::operator->()->second;
194 inline pointer operator->() const {
195 return &super::operator->()->second;
199 inline NodesIterator GraphBegin(CompilationGraph* G) {
200 return NodesIterator(G->NodesMap.begin());
203 inline NodesIterator GraphEnd(CompilationGraph* G) {
204 return NodesIterator(G->NodesMap.end());
208 // Another auxiliary class needed by GraphTraits.
209 class NodeChildIterator : public bidirectional_iterator<Node, ptrdiff_t> {
210 typedef NodeChildIterator ThisType;
211 typedef Node::container_type::iterator iterator;
213 CompilationGraph* OwningGraph;
216 typedef Node* pointer;
217 typedef Node& reference;
219 NodeChildIterator(Node* N, iterator I) :
220 OwningGraph(N->OwningGraph), EdgeIter(I) {}
222 const ThisType& operator=(const ThisType& I) {
223 assert(OwningGraph == I.OwningGraph);
224 EdgeIter = I.EdgeIter;
228 inline bool operator==(const ThisType& I) const
229 { return EdgeIter == I.EdgeIter; }
230 inline bool operator!=(const ThisType& I) const
231 { return EdgeIter != I.EdgeIter; }
233 inline pointer operator*() const {
234 return &OwningGraph->getNode((*EdgeIter)->ToolName());
236 inline pointer operator->() const {
237 return &OwningGraph->getNode((*EdgeIter)->ToolName());
240 ThisType& operator++() { ++EdgeIter; return *this; } // Preincrement
241 ThisType operator++(int) { // Postincrement
242 ThisType tmp = *this;
247 inline ThisType& operator--() { --EdgeIter; return *this; } // Predecrement
248 inline ThisType operator--(int) { // Postdecrement
249 ThisType tmp = *this;
259 struct GraphTraits<llvmc::CompilationGraph*> {
260 typedef llvmc::CompilationGraph GraphType;
261 typedef llvmc::Node NodeType;
262 typedef llvmc::NodeChildIterator ChildIteratorType;
264 static NodeType* getEntryNode(GraphType* G) {
265 return &G->getNode("root");
268 static ChildIteratorType child_begin(NodeType* N) {
269 return ChildIteratorType(N, N->OutEdges.begin());
271 static ChildIteratorType child_end(NodeType* N) {
272 return ChildIteratorType(N, N->OutEdges.end());
275 typedef llvmc::NodesIterator nodes_iterator;
276 static nodes_iterator nodes_begin(GraphType *G) {
277 return GraphBegin(G);
279 static nodes_iterator nodes_end(GraphType *G) {
286 #endif // LLVM_TOOLS_LLVMC2_COMPILATION_GRAPH_H