1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
package com.seaofnodes.simple;
import com.seaofnodes.simple.node.*;
import java.util.*;
/**
* Simple visualizer that outputs GraphViz dot format.
* The dot output must be saved to a file and run manually via dot to generate the SVG output.
* Currently, this is done manually.
*/
public class GraphVisualizer {
public String generateDotOutput(Parser parser) {
// Since the graph has cycles, we need to create a flat list of all the
// nodes in the graph.
Collection<Node> all = findAll(parser);
StringBuilder sb = new StringBuilder();
sb.append("digraph chapter05 {\n");
sb.append("/*\n");
sb.append(parser.src());
sb.append("\n*/\n");
// To keep the Scopes below the graph and pointing up into the graph we
// need to group the Nodes in a subgraph cluster, and the scopes into a
// different subgraph cluster. THEN we can draw edges between the
// scopes and nodes. If we try to cross subgraph cluster borders while
// still making the subgraphs DOT gets confused.
sb.append("\trankdir=BT;\n"); // Force Nodes before Scopes
// Preserve node input order
sb.append("\tordering=\"in\";\n");
// Merge multiple edges hitting the same node. Makes common shared
// nodes much prettier to look at.
sb.append("\tconcentrate=\"true\";\n");
// Just the Nodes first, in a cluster no edges
nodes(sb, all);
// Now the scopes, in a cluster no edges
for (ScopeNode sn: parser._xScopes)
scopes(sb, sn);
// Walk the Node edges
nodeEdges(sb, all);
// Walk the Scope edges
for (ScopeNode sn: parser._xScopes)
scopeEdges(sb, sn);
sb.append("}\n");
return sb.toString();
}
private void nodes(StringBuilder sb, Collection<Node> all) {
// Just the Nodes first, in a cluster no edges
sb.append("\tsubgraph cluster_Nodes {\n"); // Magic "cluster_" in the subgraph name
for( Node n : all ) {
if( n instanceof ProjNode || n instanceof ScopeNode )
continue; // Do not emit, rolled into MultiNode or Scope cluster already
sb.append("\t\t").append(n.uniqueName()).append(" [ ");
String lab = n.glabel();
if( n instanceof MultiNode ) {
// Make a box with the MultiNode on top, and all the projections on the bottom
sb.append("shape=plaintext label=<\n");
sb.append("\t\t\t<TABLE BORDER=\"0\" CELLBORDER=\"1\" CELLSPACING=\"0\" CELLPADDING=\"4\">\n");
sb.append("\t\t\t<TR><TD BGCOLOR=\"yellow\">").append(lab).append("</TD></TR>\n");
sb.append("\t\t\t<TR>");
boolean doProjTable = false;
for( Node use : n._outputs ) {
if( use instanceof ProjNode proj ) {
if (!doProjTable) {
doProjTable = true;
sb.append("<TD>").append("\n");
sb.append("\t\t\t\t<TABLE BORDER=\"0\" CELLBORDER=\"1\" CELLSPACING=\"0\">").append("\n");
sb.append("\t\t\t\t<TR>");
}
sb.append("<TD PORT=\"p").append(proj._idx).append("\"");
if( proj.isCFG() ) sb.append(" BGCOLOR=\"yellow\"");
sb.append(">").append(proj.glabel()).append("</TD>");
}
}
if (doProjTable) {
sb.append("</TR>").append("\n");
sb.append("\t\t\t\t</TABLE>").append("\n");
sb.append("\t\t\t</TD>");
}
sb.append("</TR>\n");
sb.append("\t\t\t</TABLE>>\n\t\t");
} else {
// control nodes have box shape
// other nodes are ellipses, i.e. default shape
if( n.isCFG() )
sb.append("shape=box style=filled fillcolor=yellow ");
if( n instanceof PhiNode )
sb.append("style=filled fillcolor=lightyellow ");
sb.append("label=\"").append(lab).append("\" ");
}
sb.append("];\n");
}
// Force Region & Phis to line up
for( Node n : all ) {
if( n instanceof RegionNode region ) {
sb.append("\t\t{ rank=same; ");
sb.append(region).append(";") ;
for( Node phi : region._outputs )
if( phi instanceof PhiNode )
sb.append(phi.uniqueName()).append(";");
sb.append("}\n");
}
}
sb.append("\t}\n"); // End Node cluster
}
private void scopes( StringBuilder sb, ScopeNode scopenode) {
sb.append("\tnode [shape=plaintext];\n");
int level=0;
for( HashMap<String,Integer> scope : scopenode._scopes ) {
String scopeName = makeScopeName(scopenode, level);
sb.append("\tsubgraph cluster_").append(scopeName).append(" {\n"); // Magic "cluster_" in the subgraph name
sb.append("\t\t").append(scopeName).append(" [label=<\n");
sb.append("\t\t\t<TABLE BORDER=\"0\" CELLBORDER=\"1\" CELLSPACING=\"0\">\n");
// Add the scope level
sb.append("\t\t\t<TR><TD BGCOLOR=\"cyan\">").append(level).append("</TD>");
for( String name : scope.keySet() )
sb.append("<TD PORT=\"").append(makePortName(scopeName, name)).append("\">").append(name).append("</TD>");
sb.append("</TR>\n");
sb.append("\t\t\t</TABLE>>];\n");
level++;
}
// Scope clusters nest, so the graphics shows the nested scopes, so
// they are not closed as they are printed; so they just keep nesting.
// We close them all at once here.
sb.append( "\t}\n".repeat( level ) ); // End all Scope clusters
}
private String makeScopeName(ScopeNode sn, int level) { return sn.uniqueName() + "_" + level; }
private String makePortName(String scopeName, String varName) { return scopeName + "_" + varName; }
// Walk the node edges
private void nodeEdges(StringBuilder sb, Collection<Node> all) {
// All them edge labels
sb.append("\tedge [ fontname=Helvetica, fontsize=8 ];\n");
for( Node n : all ) {
// Do not display the Constant->Start edge;
// ProjNodes handled by Multi;
// ScopeNodes are done separately
if( n instanceof ConstantNode || n instanceof ProjNode || n instanceof ScopeNode )
continue;
int i=0;
for( Node def : n._inputs ) {
if( n instanceof PhiNode && def instanceof RegionNode ) {
// Draw a dotted use->def edge from Phi to Region.
sb.append('\t').append(n.uniqueName());
sb.append(" -> ");
sb.append(def.uniqueName());
sb.append(" [style=dotted taillabel=").append(i).append("];\n");
} else if( def != null ) {
// Most edges land here use->def
sb.append('\t').append(n.uniqueName()).append(" -> ");
if( def instanceof ProjNode proj ) {
String mname = proj.ctrl().uniqueName();
sb.append(mname).append(":p").append(proj._idx);
} else sb.append(def.uniqueName());
// Number edges, so we can see how they track
sb.append("[taillabel=").append(i);
// control edges are colored red
if( def.isCFG() )
sb.append(" color=red");
sb.append("];\n");
}
i++;
}
}
}
// Walk the scope edges
private void scopeEdges( StringBuilder sb, ScopeNode scopenode ) {
sb.append("\tedge [style=dashed color=cornflowerblue];\n");
int level=0;
for( HashMap<String,Integer> scope : scopenode._scopes ) {
String scopeName = makeScopeName(scopenode, level);
for( String name : scope.keySet() ) {
Node def = scopenode.in(scope.get(name));
if( def==null ) continue;
sb.append("\t")
.append(scopeName).append(":")
.append('"').append(makePortName(scopeName, name)).append('"') // wrap port name with quotes because $ctrl is not valid unquoted
.append(" -> ");
if( def instanceof ProjNode proj ) {
String mname = proj.ctrl().uniqueName();
sb.append(mname).append(":p").append(proj._idx);
} else sb.append(def.uniqueName());
sb.append(";\n");
}
level++;
}
}
/**
* Finds all nodes in the graph.
*/
private Collection<Node> findAll(Parser parser) {
final StartNode start = Parser.START;
final HashMap<Integer, Node> all = new HashMap<>();
for( Node n : start._outputs )
walk(all, n);
// Scan symbol tables
for( HashMap<String,Integer> scope : parser._scope._scopes )
for (Integer i : scope.values())
walk(all, parser._scope.in(i));
return all.values();
}
/**
* Walk a subgraph and populate distinct nodes in the all list.
*/
private void walk(HashMap<Integer, Node> all, Node n) {
if(n == null ) return;
if (all.get(n._nid) != null) return; // Been there, done that
all.put(n._nid, n);
for (Node c : n._inputs)
if (c != null)
walk(all, c);
for (Node c : n._outputs)
if (c != null)
walk(all, c);
}
}
|
