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
|
// Copyright 2014 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.query2.output;
import com.google.devtools.build.lib.collect.CollectionUtils;
import com.google.devtools.build.lib.collect.EquivalenceRelation;
import com.google.devtools.build.lib.graph.Digraph;
import com.google.devtools.build.lib.graph.DotOutputVisitor;
import com.google.devtools.build.lib.graph.LabelSerializer;
import com.google.devtools.build.lib.graph.Node;
import com.google.devtools.build.lib.packages.Target;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
/**
* An output formatter that prints the result as factored graph in AT&T
* GraphViz format.
*/
class GraphOutputFormatter extends OutputFormatter {
private int graphNodeStringLimit;
private boolean graphFactored;
@Override
public String getName() {
return "graph";
}
@Override
public void output(QueryOptions options, Digraph<Target> result, PrintStream out) {
this.graphNodeStringLimit = options.graphNodeStringLimit;
this.graphFactored = options.graphFactored;
if (graphFactored) {
outputFactored(result, new PrintWriter(out));
} else {
outputUnfactored(result, new PrintWriter(out));
}
}
private void outputUnfactored(Digraph<Target> result, PrintWriter out) {
result.visitNodesBeforeEdges(
new DotOutputVisitor<Target>(out, LABEL_STRINGIFIER) {
@Override
public void beginVisit() {
super.beginVisit();
// TODO(bazel-team): (2009) make this the default in Digraph.
out.println(" node [shape=box];");
}
});
}
private void outputFactored(Digraph<Target> result, PrintWriter out) {
EquivalenceRelation<Node<Target>> equivalenceRelation = createEquivalenceRelation();
// Notes on ordering:
// - Digraph.getNodes() returns nodes in no particular order
// - CollectionUtils.partition inserts elements into unordered sets
// This means partitions may contain nodes in a different order than perhaps expected.
// Example (package //foo):
// some_rule(
// name = 'foo',
// srcs = ['a', 'b', 'c'],
// )
// Querying for deps('foo') will return (among others) the 'foo' node with successors 'a', 'b'
// and 'c' (in this order), however when asking the Digraph for all of its nodes, the returned
// collection may be ordered differently.
Collection<Set<Node<Target>>> partition =
CollectionUtils.partition(result.getNodes(), equivalenceRelation);
Digraph<Set<Node<Target>>> factoredGraph = result.createImageUnderPartition(partition);
// Concatenate the labels of all topologically-equivalent nodes.
LabelSerializer<Set<Node<Target>>> labelSerializer = new LabelSerializer<Set<Node<Target>>>() {
@Override
public String serialize(Node<Set<Node<Target>>> node) {
int actualLimit = graphNodeStringLimit - RESERVED_LABEL_CHARS;
boolean firstItem = true;
StringBuffer buf = new StringBuffer();
int count = 0;
for (Node<Target> eqNode : node.getLabel()) {
String labelString = eqNode.getLabel().getLabel().toString();
if (!firstItem) {
buf.append("\\n");
// Use -1 to denote no limit, as it is easier than trying to pass MAX_INT on the cmdline
if (graphNodeStringLimit != -1 && (buf.length() + labelString.length() > actualLimit)) {
buf.append("...and ");
buf.append(node.getLabel().size() - count);
buf.append(" more items");
break;
}
}
buf.append(labelString);
count++;
firstItem = false;
}
return buf.toString();
}
};
factoredGraph.visitNodesBeforeEdges(
new DotOutputVisitor<Set<Node<Target>>>(out, labelSerializer) {
@Override
public void beginVisit() {
super.beginVisit();
// TODO(bazel-team): (2009) make this the default in Digraph.
out.println(" node [shape=box];");
}
});
}
/**
* Returns an equivalence relation for nodes in the specified graph.
*
* <p>Two nodes are considered equal iff they have equal topology (predecessors and successors).
*
* TODO(bazel-team): Make this a method of Digraph.
*/
private static <LABEL> EquivalenceRelation<Node<LABEL>> createEquivalenceRelation() {
return new EquivalenceRelation<Node<LABEL>>() {
@Override
public int compare(Node<LABEL> x, Node<LABEL> y) {
if (x == y) {
return 0;
}
if (x.numPredecessors() != y.numPredecessors()
|| x.numSuccessors() != y.numSuccessors()) {
return -1;
}
Set<Node<LABEL>> xpred = new HashSet<>(x.getPredecessors());
Set<Node<LABEL>> ypred = new HashSet<>(y.getPredecessors());
if (!xpred.equals(ypred)) {
return -1;
}
Set<Node<LABEL>> xsucc = new HashSet<>(x.getSuccessors());
Set<Node<LABEL>> ysucc = new HashSet<>(y.getSuccessors());
if (!xsucc.equals(ysucc)) {
return -1;
}
return 0;
}
};
}
private static final int RESERVED_LABEL_CHARS = "\\n...and 9999999 more items".length();
private static final LabelSerializer<Target> LABEL_STRINGIFIER = new LabelSerializer<Target>() {
@Override
public String serialize(Node<Target> node) {
return node.getLabel().getLabel().toString();
}
};
}
|
