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
|
// 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.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.util.Preconditions;
import com.google.devtools.build.lib.util.StringCanonicalizer;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import java.util.Collection;
import java.util.Objects;
import java.util.Set;
import javax.annotation.Nullable;
/**
* A <i>transitive</i> target reference that, when built in skyframe, loads the entire transitive
* closure of a target. Retains the first error message found during the transitive traversal,
* and a set of names of providers if the target is a {@link Rule}.
*/
@Immutable
@ThreadSafe
public class TransitiveTraversalValue implements SkyValue {
private final boolean canHaveAnyProvider;
@Nullable private final ImmutableSet<String> providers;
@Nullable private final String firstErrorMessage;
private TransitiveTraversalValue(boolean canHaveAnyProvider,
@Nullable Iterable<String> providers, @Nullable String firstErrorMessage) {
this.canHaveAnyProvider = canHaveAnyProvider;
this.providers = (providers == null) ? null : canonicalSet(providers);
this.firstErrorMessage =
(firstErrorMessage == null) ? null : StringCanonicalizer.intern(firstErrorMessage);
}
public static TransitiveTraversalValue unsuccessfulTransitiveTraversal(String firstErrorMessage) {
return new TransitiveTraversalValue(false, null, Preconditions.checkNotNull(firstErrorMessage));
}
public static TransitiveTraversalValue forTarget(
Target target, @Nullable String firstErrorMessage) {
if (target instanceof Rule) {
Rule rule = (Rule) target;
return new TransitiveTraversalValue(
rule.getRuleClassObject().canHaveAnyProvider(),
toStringSet(rule.getRuleClassObject().getAdvertisedProviders()),
firstErrorMessage);
}
return new TransitiveTraversalValue(false, ImmutableList.<String>of(), firstErrorMessage);
}
public static TransitiveTraversalValue withProviders(
Collection<String> providers, @Nullable String firstErrorMessage) {
return new TransitiveTraversalValue(false, ImmutableSet.copyOf(providers), firstErrorMessage);
}
private static ImmutableSet<String> canonicalSet(Iterable<String> strIterable) {
ImmutableSet.Builder<String> builder = new ImmutableSet.Builder<>();
for (String str : strIterable) {
builder.add(StringCanonicalizer.intern(str));
}
return builder.build();
}
private static ImmutableSet<String> toStringSet(Iterable<Class<?>> providers) {
ImmutableSet.Builder<String> pBuilder = new ImmutableSet.Builder<>();
if (providers != null) {
for (Class<?> clazz : providers) {
pBuilder.add(StringCanonicalizer.intern(clazz.getName()));
}
}
return pBuilder.build();
}
/**
* Returns if the associated target can have any provider. True for "alias" rules.
*/
public boolean canHaveAnyProvider() {
return canHaveAnyProvider;
}
/**
* Returns the set of provider names from the target, if the target is a {@link Rule}. If there
* were errors loading the target, returns {@code null}.
*/
@Nullable
public Set<String> getProviders() {
return providers;
}
/**
* Returns the first error message, if any, from loading the target and its transitive
* dependencies.
*/
@Nullable
public String getFirstErrorMessage() {
return firstErrorMessage;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof TransitiveTraversalValue)) {
return false;
}
TransitiveTraversalValue that = (TransitiveTraversalValue) o;
return Objects.equals(this.firstErrorMessage, that.firstErrorMessage)
&& Objects.equals(this.providers, that.providers)
&& Objects.equals(this.canHaveAnyProvider, canHaveAnyProvider);
}
@Override
public int hashCode() {
return Objects.hash(firstErrorMessage, providers, canHaveAnyProvider);
}
@ThreadSafe
public static SkyKey key(Label label) {
Preconditions.checkArgument(!label.getPackageIdentifier().getRepository().isDefault());
return SkyKey.create(SkyFunctions.TRANSITIVE_TRAVERSAL, label);
}
}
|
