xref: /freebsd/contrib/llvm-project/llvm/lib/CodeGen/ScheduleDAGPrinter.cpp (revision d9a42747950146bf03cda7f6e25d219253f8a57a)
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/CodeGen/MachineFunction.h"
14 #include "llvm/CodeGen/ScheduleDAG.h"
15 #include "llvm/Support/GraphWriter.h"
16 #include "llvm/Support/raw_ostream.h"
17 using namespace llvm;
18 
19 namespace llvm {
20   template<>
21   struct DOTGraphTraits<ScheduleDAG*> : public DefaultDOTGraphTraits {
22 
23   DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {}
24 
25     static std::string getGraphName(const ScheduleDAG *G) {
26       return std::string(G->MF.getName());
27     }
28 
29     static bool renderGraphFromBottomUp() {
30       return true;
31     }
32 
33     static bool isNodeHidden(const SUnit *Node, const ScheduleDAG *G) {
34       return (Node->NumPreds > 10 || Node->NumSuccs > 10);
35     }
36 
37     static std::string getNodeIdentifierLabel(const SUnit *Node,
38                                               const ScheduleDAG *Graph) {
39       std::string R;
40       raw_string_ostream OS(R);
41       OS << static_cast<const void *>(Node);
42       return R;
43     }
44 
45     /// If you want to override the dot attributes printed for a particular
46     /// edge, override this method.
47     static std::string getEdgeAttributes(const SUnit *Node,
48                                          SUnitIterator EI,
49                                          const ScheduleDAG *Graph) {
50       if (EI.isArtificialDep())
51         return "color=cyan,style=dashed";
52       if (EI.isCtrlDep())
53         return "color=blue,style=dashed";
54       return "";
55     }
56 
57 
58     std::string getNodeLabel(const SUnit *SU, const ScheduleDAG *Graph);
59     static std::string getNodeAttributes(const SUnit *N,
60                                          const ScheduleDAG *Graph) {
61       return "shape=Mrecord";
62     }
63 
64     static void addCustomGraphFeatures(ScheduleDAG *G,
65                                        GraphWriter<ScheduleDAG*> &GW) {
66       return G->addCustomGraphFeatures(GW);
67     }
68   };
69 }
70 
71 std::string DOTGraphTraits<ScheduleDAG*>::getNodeLabel(const SUnit *SU,
72                                                        const ScheduleDAG *G) {
73   return G->getGraphNodeLabel(SU);
74 }
75 
76 /// viewGraph - Pop up a ghostview window with the reachable parts of the DAG
77 /// rendered using 'dot'.
78 ///
79 void ScheduleDAG::viewGraph(const Twine &Name, const Twine &Title) {
80   // This code is only for debugging!
81 #ifndef NDEBUG
82   ViewGraph(this, Name, false, Title);
83 #else
84   errs() << "ScheduleDAG::viewGraph is only available in debug builds on "
85          << "systems with Graphviz or gv!\n";
86 #endif  // NDEBUG
87 }
88 
89 /// Out-of-line implementation with no arguments is handy for gdb.
90 void ScheduleDAG::viewGraph() {
91   viewGraph(getDAGName(), "Scheduling-Units Graph for " + getDAGName());
92 }
93