1 //===--- CompilationGraph.cpp - 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 - implementation.
12 //===----------------------------------------------------------------------===//
15 #include "CompilationGraph.h"
17 #include "llvm/ADT/STLExtras.h"
18 #include "llvm/Support/CommandLine.h"
19 #include "llvm/Support/DOTGraphTraits.h"
20 #include "llvm/Support/GraphWriter.h"
29 using namespace llvmc;
31 extern cl::list<std::string> InputFilenames;
32 extern cl::opt<std::string> OutputFilename;
33 extern cl::list<std::string> Languages;
37 /// ChooseEdge - Return the edge with the maximum weight.
39 const Edge* ChooseEdge(const C& EdgesContainer,
40 const InputLanguagesSet& InLangs,
41 const std::string& NodeName = "root") {
42 const Edge* MaxEdge = 0;
43 unsigned MaxWeight = 0;
44 bool SingleMax = true;
46 for (typename C::const_iterator B = EdgesContainer.begin(),
47 E = EdgesContainer.end(); B != E; ++B) {
48 const Edge* E = B->getPtr();
49 unsigned EW = E->Weight(InLangs);
54 } else if (EW == MaxWeight) {
60 throw std::runtime_error("Node " + NodeName +
61 ": multiple maximal outward edges found!"
62 " Most probably a specification error.");
64 throw std::runtime_error("Node " + NodeName +
65 ": no maximal outward edge found!"
66 " Most probably a specification error.");
72 CompilationGraph::CompilationGraph() {
73 NodesMap["root"] = Node(this);
76 Node& CompilationGraph::getNode(const std::string& ToolName) {
77 nodes_map_type::iterator I = NodesMap.find(ToolName);
78 if (I == NodesMap.end())
79 throw std::runtime_error("Node " + ToolName + " is not in the graph");
83 const Node& CompilationGraph::getNode(const std::string& ToolName) const {
84 nodes_map_type::const_iterator I = NodesMap.find(ToolName);
85 if (I == NodesMap.end())
86 throw std::runtime_error("Node " + ToolName + " is not in the graph!");
90 // Find the language name corresponding to the given file.
91 const std::string& CompilationGraph::getLanguage(const sys::Path& File) const {
92 LanguageMap::const_iterator Lang = ExtsToLangs.find(File.getSuffix());
93 if (Lang == ExtsToLangs.end())
94 throw std::runtime_error("Unknown suffix: " + File.getSuffix());
98 // Find the tools list corresponding to the given language name.
99 const CompilationGraph::tools_vector_type&
100 CompilationGraph::getToolsVector(const std::string& LangName) const
102 tools_map_type::const_iterator I = ToolsMap.find(LangName);
103 if (I == ToolsMap.end())
104 throw std::runtime_error("No tool corresponding to the language "
105 + LangName + "found");
109 void CompilationGraph::insertNode(Tool* V) {
110 if (NodesMap.count(V->Name()) == 0) {
112 N.OwningGraph = this;
114 NodesMap[V->Name()] = N;
118 void CompilationGraph::insertEdge(const std::string& A, Edge* E) {
119 Node& B = getNode(E->ToolName());
121 const std::string& InputLanguage = B.ToolPtr->InputLanguage();
122 ToolsMap[InputLanguage].push_back(IntrusiveRefCntPtr<Edge>(E));
123 NodesMap["root"].AddEdge(E);
126 Node& N = getNode(A);
129 // Increase the inward edge counter.
134 sys::Path MakeTempFile(const sys::Path& TempDir, const std::string& BaseName,
135 const std::string& Suffix) {
136 sys::Path Out = TempDir;
137 Out.appendComponent(BaseName);
138 Out.appendSuffix(Suffix);
139 Out.makeUnique(true, NULL);
144 // Pass input file through the chain until we bump into a Join node or
145 // a node that says that it is the last.
146 void CompilationGraph::PassThroughGraph (const sys::Path& InFile,
147 const Node* StartNode,
148 const InputLanguagesSet& InLangs,
149 const sys::Path& TempDir) const {
151 sys::Path In = InFile;
152 const Node* CurNode = StartNode;
156 Tool* CurTool = CurNode->ToolPtr.getPtr();
158 if (CurTool->IsJoin()) {
159 JoinTool& JT = dynamic_cast<JoinTool&>(*CurTool);
160 JT.AddToJoinList(In);
164 // Since toolchains do not have to end with a Join node, we should
165 // check if this Node is the last.
166 if (!CurNode->HasChildren() || CurTool->IsLast()) {
167 if (!OutputFilename.empty()) {
168 Out.set(OutputFilename);
171 Out.set(In.getBasename());
172 Out.appendSuffix(CurTool->OutputSuffix());
177 Out = MakeTempFile(TempDir, In.getBasename(), CurTool->OutputSuffix());
180 if (int ret = CurTool->GenerateAction(In, Out, InLangs).Execute())
181 throw error_code(ret);
186 CurNode = &getNode(ChooseEdge(CurNode->OutEdges,
188 CurNode->Name())->ToolName());
189 In = Out; Out.clear();
193 // Find the head of the toolchain corresponding to the given file.
194 // Also, insert an input language into InLangs.
195 const Node* CompilationGraph::
196 FindToolChain(const sys::Path& In, const std::string* forceLanguage,
197 InputLanguagesSet& InLangs) const {
199 // Determine the input language.
200 const std::string& InLanguage =
201 forceLanguage ? *forceLanguage : getLanguage(In);
203 // Add the current input language to the input language set.
204 InLangs.insert(InLanguage);
206 // Find the toolchain for the input language.
207 const tools_vector_type& TV = getToolsVector(InLanguage);
209 throw std::runtime_error("No toolchain corresponding to language "
210 + InLanguage + " found");
211 return &getNode(ChooseEdge(TV, InLangs)->ToolName());
214 // Helper function used by Build().
215 // Traverses initial portions of the toolchains (up to the first Join node).
216 // This function is also responsible for handling the -x option.
217 void CompilationGraph::BuildInitial (InputLanguagesSet& InLangs,
218 const sys::Path& TempDir) {
219 // This is related to -x option handling.
220 cl::list<std::string>::const_iterator xIter = Languages.begin(),
221 xBegin = xIter, xEnd = Languages.end();
223 const std::string* xLanguage = 0;
224 unsigned xPos = 0, xPosNext = 0, filePos = 0;
228 xPos = Languages.getPosition(xIter - xBegin);
229 cl::list<std::string>::const_iterator xNext = llvm::next(xIter);
230 xPosNext = (xNext == xEnd) ? std::numeric_limits<unsigned>::max()
231 : Languages.getPosition(xNext - xBegin);
232 xLanguage = (*xIter == "none") ? 0 : &(*xIter);
235 // For each input file:
236 for (cl::list<std::string>::const_iterator B = InputFilenames.begin(),
237 CB = B, E = InputFilenames.end(); B != E; ++B) {
238 sys::Path In = sys::Path(*B);
240 // Code for handling the -x option.
241 // Output: std::string* xLanguage (can be NULL).
243 filePos = InputFilenames.getPosition(B - CB);
245 if (xPos < filePos) {
246 if (filePos < xPosNext) {
247 xLanguage = (*xIter == "none") ? 0 : &(*xIter);
249 else { // filePos >= xPosNext
250 // Skip xIters while filePos > xPosNext
251 while (filePos > xPosNext) {
255 cl::list<std::string>::const_iterator xNext = llvm::next(xIter);
257 xPosNext = std::numeric_limits<unsigned>::max();
259 xPosNext = Languages.getPosition(xNext - xBegin);
260 xLanguage = (*xIter == "none") ? 0 : &(*xIter);
266 // Find the toolchain corresponding to this file.
267 const Node* N = FindToolChain(In, xLanguage, InLangs);
268 // Pass file through the chain starting at head.
269 PassThroughGraph(In, N, InLangs, TempDir);
273 // Sort the nodes in topological order.
274 void CompilationGraph::TopologicalSort(std::vector<const Node*>& Out) {
275 std::queue<const Node*> Q;
276 Q.push(&getNode("root"));
279 const Node* A = Q.front();
282 for (Node::const_iterator EB = A->EdgesBegin(), EE = A->EdgesEnd();
284 Node* B = &getNode((*EB)->ToolName());
286 if (B->HasNoInEdges())
293 bool NotJoinNode(const Node* N) {
294 return N->ToolPtr ? !N->ToolPtr->IsJoin() : true;
298 // Call TopologicalSort and filter the resulting list to include
300 void CompilationGraph::
301 TopologicalSortFilterJoinNodes(std::vector<const Node*>& Out) {
302 std::vector<const Node*> TopSorted;
303 TopologicalSort(TopSorted);
304 std::remove_copy_if(TopSorted.begin(), TopSorted.end(),
305 std::back_inserter(Out), NotJoinNode);
308 int CompilationGraph::Build (const sys::Path& TempDir) {
310 InputLanguagesSet InLangs;
312 // Traverse initial parts of the toolchains and fill in InLangs.
313 BuildInitial(InLangs, TempDir);
315 std::vector<const Node*> JTV;
316 TopologicalSortFilterJoinNodes(JTV);
318 // For all join nodes in topological order:
319 for (std::vector<const Node*>::iterator B = JTV.begin(), E = JTV.end();
323 const Node* CurNode = *B;
324 JoinTool* JT = &dynamic_cast<JoinTool&>(*CurNode->ToolPtr.getPtr());
327 // Are there any files in the join list?
328 if (JT->JoinListEmpty())
331 // Is this the last tool in the toolchain?
332 // NOTE: we can process several toolchains in parallel.
333 if (!CurNode->HasChildren() || JT->IsLast()) {
334 if (OutputFilename.empty()) {
336 Out.appendSuffix(JT->OutputSuffix());
339 Out.set(OutputFilename);
343 Out = MakeTempFile(TempDir, "tmp", JT->OutputSuffix());
346 if (int ret = JT->GenerateAction(Out, InLangs).Execute())
347 throw error_code(ret);
350 const Node* NextNode =
351 &getNode(ChooseEdge(CurNode->OutEdges, InLangs,
352 CurNode->Name())->ToolName());
353 PassThroughGraph(Out, NextNode, InLangs, TempDir);
360 // Code related to graph visualization.
364 struct DOTGraphTraits<llvmc::CompilationGraph*>
365 : public DefaultDOTGraphTraits
368 template<typename GraphType>
369 static std::string getNodeLabel(const Node* N, const GraphType&)
372 if (N->ToolPtr->IsJoin())
373 return N->Name() + "\n (join" +
374 (N->HasChildren() ? ")"
375 : std::string(": ") + N->ToolPtr->OutputLanguage() + ')');
382 template<typename EdgeIter>
383 static std::string getEdgeSourceLabel(const Node* N, EdgeIter I) {
385 return N->ToolPtr->OutputLanguage();
387 return I->ToolPtr->InputLanguage();
393 void CompilationGraph::writeGraph() {
394 std::ofstream O("CompilationGraph.dot");
397 llvm::WriteGraph(this, "compilation-graph");
401 throw std::runtime_error("Error opening file for writing");
405 void CompilationGraph::viewGraph() {
406 llvm::ViewGraph(this, "compilation-graph");