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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
|
// 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;
import com.google.common.base.Preconditions;
import com.google.common.base.Predicate;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.cmdline.ResolvedTargets;
import com.google.devtools.build.lib.cmdline.TargetParsingException;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.graph.Digraph;
import com.google.devtools.build.lib.graph.Node;
import com.google.devtools.build.lib.packages.Attribute;
import com.google.devtools.build.lib.packages.NoSuchThingException;
import com.google.devtools.build.lib.packages.OutputFile;
import com.google.devtools.build.lib.packages.Package;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.pkgcache.PackageProvider;
import com.google.devtools.build.lib.pkgcache.TargetEdgeObserver;
import com.google.devtools.build.lib.pkgcache.TargetPatternEvaluator;
import com.google.devtools.build.lib.pkgcache.TargetProvider;
import com.google.devtools.build.lib.pkgcache.TransitivePackageLoader;
import com.google.devtools.build.lib.query2.engine.BlazeQueryEvalResult;
import com.google.devtools.build.lib.query2.engine.QueryEvalResult;
import com.google.devtools.build.lib.query2.engine.QueryException;
import com.google.devtools.build.lib.query2.engine.QueryExpression;
import com.google.devtools.build.lib.query2.engine.SkyframeRestartQueryException;
import com.google.devtools.build.lib.syntax.Label;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
/**
* The environment of a Blaze query. Not thread-safe.
*/
public class BlazeQueryEnvironment extends AbstractBlazeQueryEnvironment<Target> {
private static final int MAX_DEPTH_FULL_SCAN_LIMIT = 20;
private final TargetPatternEvaluator targetPatternEvaluator;
private final TransitivePackageLoader transitivePackageLoader;
private final TargetProvider targetProvider;
private final Digraph<Target> graph = new Digraph<>();
private final ErrorPrintingTargetEdgeErrorObserver errorObserver;
private final LabelVisitor labelVisitor;
protected final int loadingPhaseThreads;
private final BlazeTargetAccessor accessor = new BlazeTargetAccessor(this);
/**
* Note that the correct operation of this class critically depends on the Reporter being a
* singleton object, shared by all cooperating classes contributing to Query.
* @param strictScope if true, fail the whole query if a label goes out of scope.
* @param loadingPhaseThreads the number of threads to use during loading
* the packages for the query.
* @param labelFilter a predicate that determines if a specific label is
* allowed to be visited during query execution. If it returns false,
* the query execution is stopped with an error message.
* @param settings a set of enabled settings
*/
BlazeQueryEnvironment(TransitivePackageLoader transitivePackageLoader,
PackageProvider packageProvider,
TargetPatternEvaluator targetPatternEvaluator,
boolean keepGoing,
boolean strictScope,
int loadingPhaseThreads,
Predicate<Label> labelFilter,
EventHandler eventHandler,
Set<Setting> settings,
Iterable<QueryFunction> extraFunctions) {
super(keepGoing, strictScope, labelFilter, eventHandler, settings, extraFunctions);
this.targetPatternEvaluator = targetPatternEvaluator;
this.transitivePackageLoader = transitivePackageLoader;
this.targetProvider = packageProvider;
this.errorObserver = new ErrorPrintingTargetEdgeErrorObserver(this.eventHandler);
this.loadingPhaseThreads = loadingPhaseThreads;
this.labelVisitor = new LabelVisitor(packageProvider, dependencyFilter);
}
@Override
public BlazeQueryEvalResult<Target> evaluateQuery(QueryExpression expr) throws QueryException {
// Some errors are reported as QueryExceptions and others as ERROR events (if --keep_going). The
// result is set to have an error iff there were errors emitted during the query, so we reset
// errors here.
eventHandler.resetErrors();
QueryEvalResult<Target> queryEvalResult = super.evaluateQuery(expr);
return new BlazeQueryEvalResult<>(queryEvalResult.getSuccess(), queryEvalResult.getResultSet(),
graph);
}
@Override
public Set<Target> getTargetsMatchingPattern(QueryExpression caller,
String pattern) throws QueryException {
// We can safely ignore the boolean error flag. The evaluateQuery() method above wraps the
// entire query computation in an error sensor.
Set<Target> targets = new LinkedHashSet<>(resolvedTargetPatterns.get(pattern).getTargets());
// Sets.filter would be more convenient here, but can't deal with exceptions.
Iterator<Target> targetIterator = targets.iterator();
while (targetIterator.hasNext()) {
Target target = targetIterator.next();
if (!validateScope(target.getLabel(), strictScope)) {
targetIterator.remove();
}
}
Set<PathFragment> packages = new HashSet<>();
for (Target target : targets) {
packages.add(target.getLabel().getPackageFragment());
}
Set<Target> result = new LinkedHashSet<>();
for (Target target : targets) {
result.add(getOrCreate(target));
// Preservation of graph order: it is important that targets obtained via
// a wildcard such as p:* are correctly ordered w.r.t. each other, so to
// ensure this, we add edges between any pair of directly connected
// targets in this set.
if (target instanceof OutputFile) {
OutputFile outputFile = (OutputFile) target;
if (targets.contains(outputFile.getGeneratingRule())) {
makeEdge(outputFile, outputFile.getGeneratingRule());
}
} else if (target instanceof Rule) {
Rule rule = (Rule) target;
for (Label label : rule.getLabels(dependencyFilter)) {
if (!packages.contains(label.getPackageFragment())) {
continue; // don't cause additional package loading
}
try {
if (!validateScope(label, strictScope)) {
continue; // Don't create edges to targets which are out of scope.
}
Target to = getTargetOrThrow(label);
if (targets.contains(to)) {
makeEdge(rule, to);
}
} catch (NoSuchThingException e) {
/* ignore */
} catch (InterruptedException e) {
throw new QueryException("interrupted");
}
}
}
}
return result;
}
public Target getTarget(Label label) throws TargetNotFoundException, QueryException {
// Can't use strictScope here because we are expecting a target back.
validateScope(label, true);
try {
return getNode(getTargetOrThrow(label)).getLabel();
} catch (NoSuchThingException e) {
throw new TargetNotFoundException(e);
} catch (InterruptedException e) {
throw new QueryException("interrupted");
}
}
private Node<Target> getNode(Target target) {
return graph.createNode(target);
}
private Collection<Node<Target>> getNodes(Iterable<Target> target) {
Set<Node<Target>> result = new LinkedHashSet<>();
for (Target t : target) {
result.add(getNode(t));
}
return result;
}
@Override
public Target getOrCreate(Target target) {
return getNode(target).getLabel();
}
@Override
public Collection<Target> getFwdDeps(Target target) {
return getTargetsFromNodes(getNode(target).getSuccessors());
}
@Override
public Collection<Target> getReverseDeps(Target target) {
return getTargetsFromNodes(getNode(target).getPredecessors());
}
@Override
public Set<Target> getTransitiveClosure(Set<Target> targetNodes) {
for (Target node : targetNodes) {
checkBuilt(node);
}
return getTargetsFromNodes(graph.getFwdReachable(getNodes(targetNodes)));
}
/**
* Checks that the graph rooted at 'targetNode' has been completely built;
* fails if not. Callers of {@link #getTransitiveClosure} must ensure that
* {@link #buildTransitiveClosure} has been called before.
*
* <p>It would be inefficient and failure-prone to make getTransitiveClosure
* call buildTransitiveClosure directly. Also, it would cause
* nondeterministic behavior of the operators, since the set of packages
* loaded (and hence errors reported) would depend on the ordering details of
* the query operators' implementations.
*/
private void checkBuilt(Target targetNode) {
Preconditions.checkState(
labelVisitor.hasVisited(targetNode.getLabel()),
"getTransitiveClosure(%s) called without prior call to buildTransitiveClosure()",
targetNode);
}
@Override
public void buildTransitiveClosure(QueryExpression caller,
Set<Target> targetNodes,
int maxDepth) throws QueryException {
Set<Target> targets = targetNodes;
preloadTransitiveClosure(targets, maxDepth);
try {
labelVisitor.syncWithVisitor(eventHandler, targets, keepGoing,
loadingPhaseThreads, maxDepth, errorObserver, new GraphBuildingObserver());
} catch (InterruptedException e) {
throw new QueryException(caller, "transitive closure computation was interrupted");
}
if (errorObserver.hasErrors()) {
reportBuildFileError(caller, "errors were encountered while computing transitive closure");
}
}
@Override
public Set<Target> getNodesOnPath(Target from, Target to) {
return getTargetsFromNodes(graph.getShortestPath(getNode(from), getNode(to)));
}
private void preloadTransitiveClosure(Set<Target> targets, int maxDepth) throws QueryException {
if (maxDepth >= MAX_DEPTH_FULL_SCAN_LIMIT && transitivePackageLoader != null) {
// Only do the full visitation if "maxDepth" is large enough. Otherwise, the benefits of
// preloading will be outweighed by the cost of doing more work than necessary.
try {
transitivePackageLoader.sync(eventHandler, targets, ImmutableSet.<Label>of(), keepGoing,
loadingPhaseThreads, -1);
} catch (InterruptedException e) {
throw new QueryException("interrupted");
}
}
}
/**
* It suffices to synchronize the modifications of this.graph from within the
* GraphBuildingObserver, because that's the only concurrent part.
* Concurrency is always encapsulated within the evaluation of a single query
* operator (e.g. deps(), somepath(), etc).
*/
private class GraphBuildingObserver implements TargetEdgeObserver {
@Override
public synchronized void edge(Target from, Attribute attribute, Target to) {
Preconditions.checkState(attribute == null ||
dependencyFilter.apply(((Rule) from), attribute),
"Disallowed edge from LabelVisitor: %s --> %s", from, to);
makeEdge(from, to);
}
@Override
public synchronized void node(Target node) {
graph.createNode(node);
}
@Override
public void missingEdge(Target target, Label to, NoSuchThingException e) {
// No - op.
}
}
private void makeEdge(Target from, Target to) {
graph.addEdge(from, to);
}
private Target getTargetOrThrow(Label label)
throws NoSuchThingException, SkyframeRestartQueryException, InterruptedException {
Target target = targetProvider.getTarget(eventHandler, label);
if (target == null) {
throw new SkyframeRestartQueryException();
}
return target;
}
// TODO(bazel-team): rename this to getDependentFiles when all implementations
// of QueryEnvironment is fixed.
@Override
public Set<Target> getBuildFiles(final QueryExpression caller, Set<Target> nodes)
throws QueryException {
Set<Target> dependentFiles = new LinkedHashSet<>();
Set<Package> seenPackages = new HashSet<>();
// Keep track of seen labels, to avoid adding a fake subinclude label that also exists as a
// real target.
Set<Label> seenLabels = new HashSet<>();
// Adds all the package definition files (BUILD files and build
// extensions) for package "pkg", to "buildfiles".
for (Target x : nodes) {
Package pkg = x.getPackage();
if (seenPackages.add(pkg)) {
addIfUniqueLabel(getNode(pkg.getBuildFile()), seenLabels, dependentFiles);
for (Label subinclude
: Iterables.concat(pkg.getSubincludeLabels(), pkg.getSkylarkFileDependencies())) {
addIfUniqueLabel(getSubincludeTarget(subinclude, pkg), seenLabels, dependentFiles);
// Also add the BUILD file of the subinclude.
try {
addIfUniqueLabel(getSubincludeTarget(
subinclude.getLocalTargetLabel("BUILD"), pkg), seenLabels, dependentFiles);
} catch (Label.SyntaxException e) {
throw new AssertionError("BUILD should always parse as a target name", e);
}
}
}
}
return dependentFiles;
}
protected Map<String, ResolvedTargets<Target>> preloadOrThrow(QueryExpression caller,
Collection<String> patterns) throws TargetParsingException {
try {
// Note that this may throw a RuntimeException if deps are missing in Skyframe and this is
// being called from within a SkyFunction.
return targetPatternEvaluator.preloadTargetPatterns(
eventHandler, patterns, keepGoing);
} catch (InterruptedException e) {
// TODO(bazel-team): Propagate the InterruptedException from here [skyframe-loading].
throw new TargetParsingException("interrupted");
}
}
private static void addIfUniqueLabel(Node<Target> node, Set<Label> labels, Set<Target> nodes) {
if (labels.add(node.getLabel().getLabel())) {
nodes.add(node.getLabel());
}
}
private Node<Target> getSubincludeTarget(final Label label, Package pkg) {
return getNode(new FakeSubincludeTarget(label, pkg));
}
@Override
public TargetAccessor<Target> getAccessor() {
return accessor;
}
/** Given a set of target nodes, returns the targets. */
private static Set<Target> getTargetsFromNodes(Iterable<Node<Target>> input) {
Set<Target> result = new LinkedHashSet<>();
for (Node<Target> node : input) {
result.add(node.getLabel());
}
return result;
}
}
|