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
|
// Copyright 2014 The Bazel Authors. 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.skyframe;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.events.ExtendedEventHandler;
import com.google.devtools.build.lib.packages.PackageGroup;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.pkgcache.PackageProvider;
import com.google.devtools.build.skyframe.CycleInfo;
import com.google.devtools.build.skyframe.SkyKey;
import java.util.List;
/**
* Reports cycles between {@link TransitiveTargetValue}s. These indicates cycles between targets
* (e.g. '//a:foo' depends on '//b:bar' and '//b:bar' depends on '//a:foo').
*/
class TransitiveTargetCycleReporter extends AbstractLabelCycleReporter {
private static final Predicate<SkyKey> IS_SUPPORTED_SKY_KEY =
Predicates.or(
SkyFunctions.isSkyFunction(SkyFunctions.TRANSITIVE_TARGET),
SkyFunctions.isSkyFunction(SkyFunctions.PREPARE_ANALYSIS_PHASE));
TransitiveTargetCycleReporter(PackageProvider packageProvider) {
super(packageProvider);
}
@Override
protected boolean canReportCycle(SkyKey topLevelKey, CycleInfo cycleInfo) {
return Iterables.all(Iterables.concat(ImmutableList.of(topLevelKey),
cycleInfo.getPathToCycle(), cycleInfo.getCycle()),
IS_SUPPORTED_SKY_KEY);
}
@Override
public String prettyPrint(SkyKey key) {
return getLabel(key).toString();
}
@Override
protected Label getLabel(SkyKey key) {
return ((TransitiveTargetKey) key).getLabel();
}
@Override
protected boolean shouldSkip(SkyKey key) {
return SkyFunctions.PREPARE_ANALYSIS_PHASE.equals(key.functionName());
}
@Override
protected String getAdditionalMessageAboutCycle(
ExtendedEventHandler eventHandler, SkyKey topLevelKey, CycleInfo cycleInfo) {
List<SkyKey> keys = Lists.newArrayList();
if (!cycleInfo.getPathToCycle().isEmpty()) {
if (!shouldSkip(topLevelKey)) {
keys.add(topLevelKey);
}
cycleInfo.getPathToCycle()
.stream()
.filter(key -> !shouldSkip(key))
.forEach(keys::add);
}
keys.addAll(cycleInfo.getCycle());
// Make sure we check the edge from the last element of the cycle to the first element of the
// cycle.
keys.add(cycleInfo.getCycle().get(0));
Target currentTarget = getTargetForLabel(eventHandler, getLabel(keys.get(0)));
for (SkyKey nextKey : keys) {
Label nextLabel = getLabel(nextKey);
Target nextTarget = getTargetForLabel(eventHandler, nextLabel);
// This is inefficient but it's no big deal since we only do this when there's a cycle.
if (currentTarget.getVisibility().getDependencyLabels().contains(nextLabel)
&& !nextTarget.getTargetKind().equals(PackageGroup.targetKind())) {
return "\nThe cycle is caused by a visibility edge from " + currentTarget.getLabel()
+ " to the non-package-group target " + nextTarget.getLabel() + " . Note that "
+ "visibility labels are supposed to be package group targets (which prevents cycles "
+ "of this form)";
}
currentTarget = nextTarget;
}
return "";
}
}
|
