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
|
// 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.pkgcache;
import com.google.common.collect.Multimap;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.packages.Package;
import com.google.devtools.build.lib.packages.Target;
import java.util.Collection;
import java.util.Set;
/**
* Visits a set of Targets and Labels transitively.
*/
public interface TransitivePackageLoader {
/**
* Visit the specified labels and follow the transitive closure of their
* outbound dependencies. If the targets have previously been visited,
* may do an up-to-date check which will not trigger any of the observers.
*
* @param eventHandler the error and warnings eventHandler; must be thread-safe
* @param targetsToVisit the targets to visit
* @param labelsToVisit the labels to visit in addition to the targets
* @param keepGoing if false, stop visitation upon first error.
* @param parallelThreads number of threads to use in the visitation.
* @param maxDepth the maximum depth to traverse to.
*/
boolean sync(EventHandler eventHandler,
Set<Target> targetsToVisit,
Set<Label> labelsToVisit,
boolean keepGoing,
int parallelThreads,
int maxDepth) throws InterruptedException;
/**
* Returns a read-only view of the set of targets visited since this visitor
* was constructed.
*
* <p>Not thread-safe; do not call during visitation.
*/
// TODO(bazel-team): This is only used in legacy non-Skyframe code.
Set<Label> getVisitedTargets();
/**
* Returns a read-only view of the set of packages visited since this visitor
* was constructed.
*
* <p>Not thread-safe; do not call during visitation.
*/
Set<PackageIdentifier> getVisitedPackageNames();
/**
* Returns a read-only view of the set of the actual packages visited without error since this
* visitor was constructed.
*
* <p>Use {@link #getVisitedPackageNames()} instead when possible.
*
* <p>Not thread-safe; do not call during visitation.
*/
Set<Package> getErrorFreeVisitedPackages();
/**
* Return a mapping between the specified top-level targets and root causes. Note that targets in
* the input that are transitively error free will not be in the output map. "Top-level" targets
* are the targetsToVisit and labelsToVisit specified in the last sync.
*
* <p>May only be called once a keep_going visitation is complete, and prior to
* trimErrorTracking().
*
* @param targetsToLoad the set of targets to be checked. Implementations may choose to only
* return root causes for targets in this set that were requested top-level targets.
* @return a mapping of targets to root causes
*/
Multimap<Label, Label> getRootCauses(Collection<Label> targetsToLoad);
}
|
