//===- Printer.cpp - Code for printing data structure graphs nicely -------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
//
// This file implements the 'dot' graph printer.
//
//===----------------------------------------------------------------------===//
-#include "llvm/Analysis/DataStructure.h"
+#include "llvm/Analysis/DataStructure/DataStructure.h"
+#include "llvm/Analysis/DataStructure/EquivClassGraphs.h"
+#include "llvm/Analysis/DataStructure/DSGraph.h"
+#include "llvm/Analysis/DataStructure/DSGraphTraits.h"
#include "llvm/Module.h"
+#include "llvm/Constants.h"
#include "llvm/Assembly/Writer.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/GraphWriter.h"
+#include "llvm/ADT/Statistic.h"
#include <fstream>
#include <sstream>
-using std::string;
+using namespace llvm;
+
+// OnlyPrintMain - The DataStructure printer exposes this option to allow
+// printing of only the graph for "main".
+//
+namespace {
+ cl::opt<bool> OnlyPrintMain("only-print-main-ds", cl::ReallyHidden);
+ cl::opt<bool> DontPrintAnything("dont-print-ds", cl::ReallyHidden);
+ Statistic<> MaxGraphSize ("dsa", "Maximum graph size");
+ Statistic<> NumFoldedNodes ("dsa", "Number of folded nodes (in final graph)");
+}
void DSNode::dump() const { print(std::cerr, 0); }
-string DSNode::getCaption(const DSGraph *G) const {
+static std::string getCaption(const DSNode *N, const DSGraph *G) {
std::stringstream OS;
- Module *M = G && &G->getFunction()? G->getFunction().getParent() : 0;
- WriteTypeSymbolic(OS, getType(), M);
-
- OS << " ";
- if (NodeType & ScalarNode) OS << "S";
- if (NodeType & AllocaNode) OS << "A";
- if (NodeType & NewNode ) OS << "N";
- if (NodeType & GlobalNode) OS << "G";
- if (NodeType & SubElement) OS << "E";
- if (NodeType & CastNode ) OS << "C";
- if (NodeType & Incomplete) OS << "I";
-
- for (unsigned i = 0, e = Globals.size(); i != e; ++i) {
+ Module *M = 0;
+
+ if (!G) G = N->getParentGraph();
+
+ // Get the module from ONE of the functions in the graph it is available.
+ if (G && G->retnodes_begin() != G->retnodes_end())
+ M = G->retnodes_begin()->first->getParent();
+ if (M == 0 && G) {
+ // If there is a global in the graph, we can use it to find the module.
+ const DSScalarMap &SM = G->getScalarMap();
+ if (SM.global_begin() != SM.global_end())
+ M = (*SM.global_begin())->getParent();
+ }
+
+ if (N->isNodeCompletelyFolded())
+ OS << "COLLAPSED";
+ else {
+ WriteTypeSymbolic(OS, N->getType(), M);
+ if (N->isArray())
+ OS << " array";
+ }
+ if (unsigned NodeType = N->getNodeFlags()) {
+ OS << ": ";
+ if (NodeType & DSNode::AllocaNode ) OS << "S";
+ if (NodeType & DSNode::HeapNode ) OS << "H";
+ if (NodeType & DSNode::GlobalNode ) OS << "G";
+ if (NodeType & DSNode::UnknownNode) OS << "U";
+ if (NodeType & DSNode::Incomplete ) OS << "I";
+ if (NodeType & DSNode::Modified ) OS << "M";
+ if (NodeType & DSNode::Read ) OS << "R";
+#ifndef NDEBUG
+ if (NodeType & DSNode::DEAD ) OS << "<dead>";
+#endif
OS << "\n";
- WriteAsOperand(OS, Globals[i], false, true, M);
}
- if ((NodeType & ScalarNode) && G) {
- const std::map<Value*, DSNodeHandle> &VM = G->getValueMap();
- for (std::map<Value*, DSNodeHandle>::const_iterator I = VM.begin(),
- E = VM.end(); I != E; ++I)
- if (I->second == this) {
- OS << "\n";
- WriteAsOperand(OS, I->first, false, true, M);
- }
+ for (unsigned i = 0, e = N->getGlobals().size(); i != e; ++i) {
+ WriteAsOperand(OS, N->getGlobals()[i], false, true, M);
+ OS << "\n";
}
return OS.str();
}
-static string getValueName(Value *V, Function &F) {
- std::stringstream OS;
- WriteAsOperand(OS, V, true, true, F.getParent());
- return OS.str();
-}
+namespace llvm {
+template<>
+struct DOTGraphTraits<const DSGraph*> : public DefaultDOTGraphTraits {
+ static std::string getGraphName(const DSGraph *G) {
+ switch (G->getReturnNodes().size()) {
+ case 0: return G->getFunctionNames();
+ case 1: return "Function " + G->getFunctionNames();
+ default: return "Functions: " + G->getFunctionNames();
+ }
+ }
+ static std::string getNodeLabel(const DSNode *Node, const DSGraph *Graph) {
+ return getCaption(Node, Graph);
+ }
+ static std::string getNodeAttributes(const DSNode *N) {
+ return "shape=Mrecord";
+ }
+
+ static bool edgeTargetsEdgeSource(const void *Node,
+ DSNode::const_iterator I) {
+ unsigned O = I.getNode()->getLink(I.getOffset()).getOffset();
+ return (O >> DS::PointerShift) != 0;
+ }
+
+ static DSNode::const_iterator getEdgeTarget(const DSNode *Node,
+ DSNode::const_iterator I) {
+ unsigned O = I.getNode()->getLink(I.getOffset()).getOffset();
+ unsigned LinkNo = O >> DS::PointerShift;
+ const DSNode *N = *I;
+ DSNode::const_iterator R = N->begin();
+ for (; LinkNo; --LinkNo)
+ ++R;
+ return R;
+ }
-static void replaceIn(string &S, char From, const string &To) {
- for (unsigned i = 0; i < S.size(); )
- if (S[i] == From) {
- S.replace(S.begin()+i, S.begin()+i+1,
- To.begin(), To.end());
- i += To.size();
- } else {
- ++i;
+
+ /// addCustomGraphFeatures - Use this graph writing hook to emit call nodes
+ /// and the return node.
+ ///
+ static void addCustomGraphFeatures(const DSGraph *G,
+ GraphWriter<const DSGraph*> &GW) {
+ Module *CurMod = 0;
+ if (G->retnodes_begin() != G->retnodes_end())
+ CurMod = G->retnodes_begin()->first->getParent();
+ else {
+ // If there is a global in the graph, we can use it to find the module.
+ const DSScalarMap &SM = G->getScalarMap();
+ if (SM.global_begin() != SM.global_end())
+ CurMod = (*SM.global_begin())->getParent();
}
-}
-static std::string escapeLabel(const std::string &In) {
- std::string Label(In);
- replaceIn(Label, '\\', "\\\\"); // Escape caption...
- replaceIn(Label, '\n', "\\n");
- replaceIn(Label, ' ', "\\ ");
- replaceIn(Label, '{', "\\{");
- replaceIn(Label, '}', "\\}");
- return Label;
-}
-static void writeEdge(std::ostream &O, const void *SrcNode,
- const char *SrcNodePortName, int SrcNodeIdx,
- const DSNode *VS, const std::string &EdgeAttr = "") {
- O << "\tNode" << SrcNode << SrcNodePortName;
- if (SrcNodeIdx != -1) O << SrcNodeIdx;
- O << " -> Node" << (void*)VS;
+ // Add scalar nodes to the graph...
+ const DSGraph::ScalarMapTy &VM = G->getScalarMap();
+ for (DSGraph::ScalarMapTy::const_iterator I = VM.begin(); I != VM.end();++I)
+ if (!isa<GlobalValue>(I->first)) {
+ std::stringstream OS;
+ WriteAsOperand(OS, I->first, false, true, CurMod);
+ GW.emitSimpleNode(I->first, "", OS.str());
+
+ // Add edge from return node to real destination
+ DSNode *DestNode = I->second.getNode();
+ int EdgeDest = I->second.getOffset() >> DS::PointerShift;
+ if (EdgeDest == 0) EdgeDest = -1;
+ GW.emitEdge(I->first, -1, DestNode,
+ EdgeDest, "arrowtail=tee,color=gray63");
+ }
- if (!EdgeAttr.empty())
- O << "[" << EdgeAttr << "]";
- O << ";\n";
-}
-void DSNode::print(std::ostream &O, const DSGraph *G) const {
- std::string Caption = escapeLabel(getCaption(G));
+ // Output the returned value pointer...
+ for (DSGraph::retnodes_iterator I = G->retnodes_begin(),
+ E = G->retnodes_end(); I != E; ++I)
+ if (I->second.getNode()) {
+ std::string Label;
+ if (G->getReturnNodes().size() == 1)
+ Label = "returning";
+ else
+ Label = I->first->getName() + " ret node";
+ // Output the return node...
+ GW.emitSimpleNode((void*)I->first, "plaintext=circle", Label);
+
+ // Add edge from return node to real destination
+ DSNode *RetNode = I->second.getNode();
+ int RetEdgeDest = I->second.getOffset() >> DS::PointerShift;;
+ if (RetEdgeDest == 0) RetEdgeDest = -1;
+ GW.emitEdge((void*)I->first, -1, RetNode,
+ RetEdgeDest, "arrowtail=tee,color=gray63");
+ }
- O << "\tNode" << (void*)this << " [ label =\"{" << Caption;
+ // Output all of the call nodes...
+ const std::list<DSCallSite> &FCs =
+ G->shouldPrintAuxCalls() ? G->getAuxFunctionCalls()
+ : G->getFunctionCalls();
+ for (std::list<DSCallSite>::const_iterator I = FCs.begin(), E = FCs.end();
+ I != E; ++I) {
+ const DSCallSite &Call = *I;
+ std::vector<std::string> EdgeSourceCaptions(Call.getNumPtrArgs()+2);
+ EdgeSourceCaptions[0] = "r";
+ if (Call.isDirectCall())
+ EdgeSourceCaptions[1] = Call.getCalleeFunc()->getName();
+ else
+ EdgeSourceCaptions[1] = "f";
+
+ GW.emitSimpleNode(&Call, "shape=record", "call", Call.getNumPtrArgs()+2,
+ &EdgeSourceCaptions);
+
+ if (DSNode *N = Call.getRetVal().getNode()) {
+ int EdgeDest = Call.getRetVal().getOffset() >> DS::PointerShift;
+ if (EdgeDest == 0) EdgeDest = -1;
+ GW.emitEdge(&Call, 0, N, EdgeDest, "color=gray63,tailclip=false");
+ }
+
+ // Print out the callee...
+ if (Call.isIndirectCall()) {
+ DSNode *N = Call.getCalleeNode();
+ assert(N && "Null call site callee node!");
+ GW.emitEdge(&Call, 1, N, -1, "color=gray63,tailclip=false");
+ }
- if (!Links.empty()) {
- O << "|{";
- for (unsigned i = 0; i < Links.size(); ++i) {
- if (i) O << "|";
- O << "<g" << i << ">";
+ for (unsigned j = 0, e = Call.getNumPtrArgs(); j != e; ++j)
+ if (DSNode *N = Call.getPtrArg(j).getNode()) {
+ int EdgeDest = Call.getPtrArg(j).getOffset() >> DS::PointerShift;
+ if (EdgeDest == 0) EdgeDest = -1;
+ GW.emitEdge(&Call, j+2, N, EdgeDest, "color=gray63,tailclip=false");
+ }
}
- O << "}";
}
- O << "}\"];\n";
+};
+} // end namespace llvm
- for (unsigned i = 0; i < Links.size(); ++i)
- if (Links[i])
- writeEdge(O, this, ":g", i, Links[i]);
+void DSNode::print(std::ostream &O, const DSGraph *G) const {
+ GraphWriter<const DSGraph *> W(O, G);
+ W.writeNode(this);
}
void DSGraph::print(std::ostream &O) const {
- O << "digraph DataStructures {\n"
- << "\tnode [shape=Mrecord];\n"
- << "\tedge [arrowtail=\"dot\"];\n"
- << "\tsize=\"10,7.5\";\n"
- << "\trotate=\"90\";\n";
-
- if (&Func != 0)
- O << "\tlabel=\"Function\\ " << Func.getName() << "\";\n\n";
- else
- O << "\tlabel=\"Global Graph\";\n\n";
-
- // Output all of the nodes...
- for (unsigned i = 0, e = Nodes.size(); i != e; ++i)
- Nodes[i]->print(O, this);
-
- O << "\n";
-
- // Output the returned value pointer...
- if (RetNode != 0) {
- O << "\tNode0x1" << "[ plaintext=circle, label =\""
- << escapeLabel("returning") << "\"];\n";
- writeEdge(O, (void*)1, "", -1, RetNode, "arrowtail=tee,color=gray63");
- }
-
- // Output all of the call nodes...
- for (unsigned i = 0, e = FunctionCalls.size(); i != e; ++i) {
- const std::vector<DSNodeHandle> &Call = FunctionCalls[i];
- O << "\tNode" << (void*)&Call << " [shape=record,label=\"{call|{";
- for (unsigned j = 0, e = Call.size(); j != e; ++j) {
- if (j) O << "|";
- O << "<g" << j << ">";
- }
- O << "}}\"];\n";
-
- for (unsigned j = 0, e = Call.size(); j != e; ++j)
- if (Call[j])
- writeEdge(O, &Call, ":g", j, Call[j], "color=gray63");
- }
-
-
- O << "}\n";
+ WriteGraph(O, this, "DataStructures");
}
-
-static void printGraph(const DSGraph &Graph, std::ostream &O,
- const string &GraphName, const string &Prefix) {
- string Filename = Prefix + "." + GraphName + ".dot";
+void DSGraph::writeGraphToFile(std::ostream &O,
+ const std::string &GraphName) const {
+ std::string Filename = GraphName + ".dot";
O << "Writing '" << Filename << "'...";
std::ofstream F(Filename.c_str());
if (F.good()) {
- Graph.print(F);
- O << " [" << Graph.getGraphSize() << "+"
- << Graph.getFunctionCalls().size() << "]\n";
+ print(F);
+ unsigned NumCalls = shouldPrintAuxCalls() ?
+ getAuxFunctionCalls().size() : getFunctionCalls().size();
+ O << " [" << getGraphSize() << "+" << NumCalls << "]\n";
} else {
O << " error opening file for writing!\n";
}
}
+/// viewGraph - Emit a dot graph, run 'dot', run gv on the postscript file,
+/// then cleanup. For use from the debugger.
+///
+void DSGraph::viewGraph() const {
+ std::ofstream F("/tmp/tempgraph.dot");
+ if (!F.good()) {
+ std::cerr << "Error opening '/tmp/tempgraph.dot' for temporary graph!\n";
+ return;
+ }
+ print(F);
+ F.close();
+ if (system("dot -Tps -Gsize=10,7.5 -Grotate=90 /tmp/tempgraph.dot > /tmp/tempgraph.ps"))
+ std::cerr << "Error running dot: 'dot' not in path?\n";
+ system("gv /tmp/tempgraph.ps");
+ system("rm /tmp/tempgraph.dot /tmp/tempgraph.ps");
+}
+
+
template <typename Collection>
static void printCollection(const Collection &C, std::ostream &O,
- const Module *M, const string &Prefix) {
+ const Module *M, const std::string &Prefix) {
if (M == 0) {
O << "Null Module pointer, cannot continue!\n";
return;
}
+ unsigned TotalNumNodes = 0, TotalCallNodes = 0;
for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
- if (!I->isExternal())
- printGraph(C.getDSGraph((Function&)*I), O, I->getName(), Prefix);
+ if (C.hasGraph(*I)) {
+ DSGraph &Gr = C.getDSGraph((Function&)*I);
+ TotalNumNodes += Gr.getGraphSize();
+ unsigned NumCalls = Gr.shouldPrintAuxCalls() ?
+ Gr.getAuxFunctionCalls().size() : Gr.getFunctionCalls().size();
+
+ TotalCallNodes += NumCalls;
+ if (I->getName() == "main" || !OnlyPrintMain) {
+ Function *SCCFn = Gr.retnodes_begin()->first;
+ if (&*I == SCCFn)
+ Gr.writeGraphToFile(O, Prefix+I->getName());
+ else
+ O << "Didn't write '" << Prefix+I->getName()
+ << ".dot' - Graph already emitted to '" << Prefix+SCCFn->getName()
+ << "\n";
+ } else {
+ O << "Skipped Writing '" << Prefix+I->getName() << ".dot'... ["
+ << Gr.getGraphSize() << "+" << NumCalls << "]\n";
+ }
+
+ unsigned GraphSize = Gr.getGraphSize();
+ if (MaxGraphSize < GraphSize) MaxGraphSize = GraphSize;
+
+ for (DSGraph::node_iterator NI = Gr.node_begin(), E = Gr.node_end();
+ NI != E; ++NI)
+ if ((*NI)->isNodeCompletelyFolded())
+ ++NumFoldedNodes;
+ }
+
+ DSGraph &GG = C.getGlobalsGraph();
+ TotalNumNodes += GG.getGraphSize();
+ TotalCallNodes += GG.getFunctionCalls().size();
+ if (!OnlyPrintMain) {
+ GG.writeGraphToFile(O, Prefix+"GlobalsGraph");
+ } else {
+ O << "Skipped Writing '" << Prefix << "GlobalsGraph.dot'... ["
+ << GG.getGraphSize() << "+" << GG.getFunctionCalls().size() << "]\n";
+ }
+
+ O << "\nGraphs contain [" << TotalNumNodes << "+" << TotalCallNodes
+ << "] nodes total" << std::endl;
}
// print - Print out the analysis results...
void LocalDataStructures::print(std::ostream &O, const Module *M) const {
- printCollection(*this, O, M, "ds");
+ if (DontPrintAnything) return;
+ printCollection(*this, O, M, "ds.");
}
void BUDataStructures::print(std::ostream &O, const Module *M) const {
- printCollection(*this, O, M, "bu");
-
- for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
- if (!I->isExternal()) {
- printGraph(*getDSGraph(*I).GlobalsGraph, O, "program", "gg");
- break;
- }
+ if (DontPrintAnything) return;
+ printCollection(*this, O, M, "bu.");
}
void TDDataStructures::print(std::ostream &O, const Module *M) const {
- printCollection(*this, O, M, "td");
+ if (DontPrintAnything) return;
+ printCollection(*this, O, M, "td.");
+}
- for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
- if (!I->isExternal()) {
- printGraph(*getDSGraph(*I).GlobalsGraph, O, "program", "gg");
- break;
- }
+void CompleteBUDataStructures::print(std::ostream &O, const Module *M) const {
+ if (DontPrintAnything) return;
+ printCollection(*this, O, M, "cbu.");
}
+
+
+void EquivClassGraphs::print(std::ostream &O, const Module *M) const {
+ if (DontPrintAnything) return;
+ printCollection(*this, O, M, "eq.");
+}
+
projects / oota-llvm.git / blobdiff