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 in the 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 with 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 in the graph.
54 typedef llvm::SmallVector<llvm::IntrusiveRefCntPtr<Edge>, 3> container_type;
55 typedef container_type::iterator iterator;
56 typedef container_type::const_iterator const_iterator;
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) {}
63 bool HasChildren() const { return !OutEdges.empty(); }
64 const std::string Name() const
65 { return ToolPtr ? ToolPtr->Name() : "root"; }
68 iterator EdgesBegin() { return OutEdges.begin(); }
69 const_iterator EdgesBegin() const { return OutEdges.begin(); }
70 iterator EdgesEnd() { return OutEdges.end(); }
71 const_iterator EdgesEnd() const { return OutEdges.end(); }
73 // Add an outward edge. Takes ownership of the Edge object.
75 { OutEdges.push_back(llvm::IntrusiveRefCntPtr<Edge>(E)); }
77 // Inward edge counter. Used by Build() to implement topological
79 // TOTHINK: Move the counter back into Tool classes? Makes us more
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: For the root node, ToolPtr is NULL.
89 llvm::IntrusiveRefCntPtr<Tool> ToolPtr;
91 container_type OutEdges;
92 // Number of parents. Used for topological sorting.
98 // The compilation graph itself.
99 class CompilationGraph {
100 // Main data structure.
101 typedef llvm::StringMap<Node> nodes_map_type;
102 // These are used to map from language names-> tools. (We can have
103 // several tools associated with each language name.)
105 llvm::SmallVector<llvm::IntrusiveRefCntPtr<Edge>, 3> tools_vector_type;
106 typedef llvm::StringMap<tools_vector_type> tools_map_type;
108 // Map from file extensions to language names.
109 LanguageMap ExtsToLangs;
110 // Map from language names to lists of tool names.
111 tools_map_type ToolsMap;
112 // Map from tool names to Tool objects.
113 nodes_map_type NodesMap;
119 // insertVertex - insert a new node into the graph. Takes
120 // ownership of the object.
121 void insertNode(Tool* T);
123 // insertEdge - Insert a new edge into the graph. Takes ownership
124 // of the Edge object.
125 void insertEdge(const std::string& A, Edge* E);
127 // Build - Build target(s) from the input file set. Command-line
128 // options are passed implicitly as global variables.
129 int Build(llvm::sys::Path const& tempDir);
131 // Return a reference to the node correponding to the given tool
132 // name. Throws std::runtime_error.
133 Node& getNode(const std::string& ToolName);
134 const Node& getNode(const std::string& ToolName) const;
136 // viewGraph - This function is meant for use from the debugger.
137 // You can just say 'call G->viewGraph()' and a ghostview window
138 // should pop up from the program, displaying the compilation
139 // graph. This depends on there being a 'dot' and 'gv' program
143 // Write a CompilationGraph.dot file.
146 // GraphTraits support
147 friend NodesIterator GraphBegin(CompilationGraph*);
148 friend NodesIterator GraphEnd(CompilationGraph*);
149 friend void PopulateCompilationGraph(CompilationGraph&);
154 // Find out which language corresponds to the suffix of this file.
155 const std::string& getLanguage(const llvm::sys::Path& File) const;
157 // Return a reference to the list of tool names corresponding to
158 // the given language name. Throws std::runtime_error.
159 const tools_vector_type& getToolsVector(const std::string& LangName) const;
161 // Pass the input file through the toolchain.
162 const JoinTool* PassThroughGraph (llvm::sys::Path& In,
163 const Node* StartNode,
164 const llvm::sys::Path& TempDir) const;
166 // Find head of the toolchain corresponding to the given file.
167 const Node* FindToolChain(const llvm::sys::Path& In) const;
169 // Sort the nodes in topological order.
170 void TopologicalSort(std::vector<const Node*>& Out);
171 // Call TopologicalSort and filter the resulting list to include
173 void TopologicalSortFilterJoinNodes(std::vector<const Node*>& Out);
176 /// GraphTraits support code.
178 // Auxiliary class needed to implement GraphTraits support. Can be
179 // generalised to something like value_iterator for map-like
181 class NodesIterator : public llvm::StringMap<Node>::iterator {
182 typedef llvm::StringMap<Node>::iterator super;
183 typedef NodesIterator ThisType;
184 typedef Node* pointer;
185 typedef Node& reference;
188 NodesIterator(super I) : super(I) {}
190 inline reference operator*() const {
191 return super::operator->()->second;
193 inline pointer operator->() const {
194 return &super::operator->()->second;
198 inline NodesIterator GraphBegin(CompilationGraph* G) {
199 return NodesIterator(G->NodesMap.begin());
202 inline NodesIterator GraphEnd(CompilationGraph* G) {
203 return NodesIterator(G->NodesMap.end());
207 // Another auxiliary class needed by GraphTraits.
208 class NodeChildIterator : public bidirectional_iterator<Node, ptrdiff_t> {
209 typedef NodeChildIterator ThisType;
210 typedef Node::container_type::iterator iterator;
212 CompilationGraph* OwningGraph;
215 typedef Node* pointer;
216 typedef Node& reference;
218 NodeChildIterator(Node* N, iterator I) :
219 OwningGraph(N->OwningGraph), EdgeIter(I) {}
221 const ThisType& operator=(const ThisType& I) {
222 assert(OwningGraph == I.OwningGraph);
223 EdgeIter = I.EdgeIter;
227 inline bool operator==(const ThisType& I) const
228 { return EdgeIter == I.EdgeIter; }
229 inline bool operator!=(const ThisType& I) const
230 { return EdgeIter != I.EdgeIter; }
232 inline pointer operator*() const {
233 return &OwningGraph->getNode((*EdgeIter)->ToolName());
235 inline pointer operator->() const {
236 return &OwningGraph->getNode((*EdgeIter)->ToolName());
239 ThisType& operator++() { ++EdgeIter; return *this; } // Preincrement
240 ThisType operator++(int) { // Postincrement
241 ThisType tmp = *this;
246 inline ThisType& operator--() { --EdgeIter; return *this; } // Predecrement
247 inline ThisType operator--(int) { // Postdecrement
248 ThisType tmp = *this;
258 struct GraphTraits<llvmcc::CompilationGraph*> {
259 typedef llvmcc::CompilationGraph GraphType;
260 typedef llvmcc::Node NodeType;
261 typedef llvmcc::NodeChildIterator ChildIteratorType;
263 static NodeType* getEntryNode(GraphType* G) {
264 return &G->getNode("root");
267 static ChildIteratorType child_begin(NodeType* N) {
268 return ChildIteratorType(N, N->OutEdges.begin());
270 static ChildIteratorType child_end(NodeType* N) {
271 return ChildIteratorType(N, N->OutEdges.end());
274 typedef llvmcc::NodesIterator nodes_iterator;
275 static nodes_iterator nodes_begin(GraphType *G) {
276 return GraphBegin(G);
278 static nodes_iterator nodes_end(GraphType *G) {
285 #endif // LLVM_TOOLS_LLVMC2_COMPILATION_GRAPH_H