LLVM  9.0.0svn
ScheduleDAGPrinter.cpp
Go to the documentation of this file.
1 //===-- ScheduleDAGPrinter.cpp - Implement ScheduleDAG::viewGraph() -------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This implements the ScheduleDAG::viewGraph method.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/ADT/StringExtras.h"
18 #include "llvm/IR/Constants.h"
19 #include "llvm/Support/Debug.h"
22 using namespace llvm;
23 
24 namespace llvm {
25  template<>
27 
29 
30  static std::string getGraphName(const ScheduleDAG *G) {
31  return G->MF.getName();
32  }
33 
34  static bool renderGraphFromBottomUp() {
35  return true;
36  }
37 
38  static bool isNodeHidden(const SUnit *Node) {
39  return (Node->NumPreds > 10 || Node->NumSuccs > 10);
40  }
41 
42  static std::string getNodeIdentifierLabel(const SUnit *Node,
43  const ScheduleDAG *Graph) {
44  std::string R;
45  raw_string_ostream OS(R);
46  OS << static_cast<const void *>(Node);
47  return R;
48  }
49 
50  /// If you want to override the dot attributes printed for a particular
51  /// edge, override this method.
52  static std::string getEdgeAttributes(const SUnit *Node,
53  SUnitIterator EI,
54  const ScheduleDAG *Graph) {
55  if (EI.isArtificialDep())
56  return "color=cyan,style=dashed";
57  if (EI.isCtrlDep())
58  return "color=blue,style=dashed";
59  return "";
60  }
61 
62 
63  std::string getNodeLabel(const SUnit *SU, const ScheduleDAG *Graph);
64  static std::string getNodeAttributes(const SUnit *N,
65  const ScheduleDAG *Graph) {
66  return "shape=Mrecord";
67  }
68 
71  return G->addCustomGraphFeatures(GW);
72  }
73  };
74 }
75 
77  const ScheduleDAG *G) {
78  return G->getGraphNodeLabel(SU);
79 }
80 
81 /// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
82 /// rendered using 'dot'.
83 ///
84 void ScheduleDAG::viewGraph(const Twine &Name, const Twine &Title) {
85  // This code is only for debugging!
86 #ifndef NDEBUG
87  ViewGraph(this, Name, false, Title);
88 #else
89  errs() << "ScheduleDAG::viewGraph is only available in debug builds on "
90  << "systems with Graphviz or gv!\n";
91 #endif // NDEBUG
92 }
93 
94 /// Out-of-line implementation with no arguments is handy for gdb.
96  viewGraph(getDAGName(), "Scheduling-Units Graph for " + getDAGName());
97 }
raw_ostream & errs()
This returns a reference to a raw_ostream for standard error.
unsigned NumPreds
of SDep::Data preds.
Definition: ScheduleDAG.h:266
This class represents lattice values for constants.
Definition: AllocatorList.h:23
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
virtual std::string getGraphNodeLabel(const SUnit *SU) const =0
Returns a label for an SUnit node in a visualization of the ScheduleDAG.
static void addCustomGraphFeatures(ScheduleDAG *G, GraphWriter< ScheduleDAG *> &GW)
virtual void viewGraph()
Out-of-line implementation with no arguments is handy for gdb.
*ViewGraph Emit a dot run run gv on the postscript *then cleanup For use from the debugger *void ViewGraph(const GraphType &G, const Twine &Name, bool ShortNames=false, const Twine &Title="", GraphProgram::Name Program=GraphProgram::DOT)
Definition: GraphWriter.h:366
MachineFunction & MF
Machine function.
Definition: ScheduleDAG.h:560
unsigned NumSuccs
of SDep::Data sucss.
Definition: ScheduleDAG.h:267
This file declares the MachineConstantPool class which is an abstract constant pool to keep track of ...
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:80
static std::string getGraphName(const ScheduleDAG *G)
static std::string getNodeAttributes(const SUnit *N, const ScheduleDAG *Graph)
static std::string getEdgeAttributes(const SUnit *Node, SUnitIterator EI, const ScheduleDAG *Graph)
If you want to override the dot attributes printed for a particular edge, override this method...
std::string getNodeLabel(const void *, const GraphType &)
getNodeLabel - Given a node and a pointer to the top level graph, return the label to print in the no...
static bool isSimple(Instruction *I)
StringRef getName() const
getName - Return the name of the corresponding LLVM function.
This file contains the declarations for the subclasses of Constant, which represent the different fla...
DOTGraphTraits - Template class that can be specialized to customize how graphs are converted to &#39;dot...
virtual void addCustomGraphFeatures(GraphWriter< ScheduleDAG *> &) const
Adds custom features for a visualization of the ScheduleDAG.
Definition: ScheduleDAG.h:601
const DataFlowGraph & G
Definition: RDFGraph.cpp:202
static std::string getNodeIdentifierLabel(const SUnit *Node, const ScheduleDAG *Graph)
static std::string getNodeLabel(const ValueInfo &VI, GlobalValueSummary *GVS)
static bool isNodeHidden(const SUnit *Node)
#define N
bool isCtrlDep() const
Tests if this is not an SDep::Data dependence.
Definition: ScheduleDAG.h:652
A raw_ostream that writes to an std::string.
Definition: raw_ostream.h:482
DefaultDOTGraphTraits - This class provides the default implementations of all of the DOTGraphTraits ...
Scheduling unit. This is a node in the scheduling DAG.
Definition: ScheduleDAG.h:242
bool isArtificialDep() const
Definition: ScheduleDAG.h:655