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
|
// 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.analysis;
import com.google.common.base.Predicate;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.RuleConfiguredTarget.Mode;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.packages.BuildType;
import com.google.devtools.build.lib.packages.ClassObjectConstructor;
import com.google.devtools.build.lib.packages.SkylarkClassObject;
import com.google.devtools.build.lib.packages.TriState;
import com.google.devtools.build.lib.vfs.PathFragment;
/**
* Utility functions for use during analysis.
*/
public final class AnalysisUtils {
private AnalysisUtils() {
throw new IllegalStateException(); // utility class
}
/**
* Returns whether link stamping is enabled for a rule.
*
* <p>This returns false for unstampable rule classes and for rules in the
* host configuration. Otherwise it returns the value of the stamp attribute,
* or of the stamp option if the attribute value is -1.
*/
public static boolean isStampingEnabled(RuleContext ruleContext, BuildConfiguration config) {
if (config.isHostConfiguration()
|| !ruleContext.attributes().has("stamp", BuildType.TRISTATE)) {
return false;
}
TriState stamp = ruleContext.attributes().get("stamp", BuildType.TRISTATE);
return stamp == TriState.YES || (stamp == TriState.AUTO && config.stampBinaries());
}
public static boolean isStampingEnabled(RuleContext ruleContext) {
return isStampingEnabled(ruleContext, ruleContext.getConfiguration());
}
// TODO(bazel-team): These need Iterable<? extends TransitiveInfoCollection> because they need to
// be called with Iterable<ConfiguredTarget>. Once the configured target lockdown is complete, we
// can eliminate the "extends" clauses.
/**
* Returns the list of providers of the specified type from a set of transitive info
* collections.
*/
public static <C extends TransitiveInfoProvider> Iterable<C> getProviders(
Iterable<? extends TransitiveInfoCollection> prerequisites, Class<C> provider) {
ImmutableList.Builder<C> result = ImmutableList.builder();
for (TransitiveInfoCollection prerequisite : prerequisites) {
C prerequisiteProvider = prerequisite.getProvider(provider);
if (prerequisiteProvider != null) {
result.add(prerequisiteProvider);
}
}
return result.build();
}
/**
* Returns the list of declared providers (native and Skylark) of the specified Skylark key from a
* set of transitive info collections.
*/
public static Iterable<SkylarkClassObject> getProviders(
Iterable<? extends TransitiveInfoCollection> prerequisites,
final ClassObjectConstructor.Key skylarkKey) {
ImmutableList.Builder<SkylarkClassObject> result = ImmutableList.builder();
for (TransitiveInfoCollection prerequisite : prerequisites) {
SkylarkClassObject prerequisiteProvider = prerequisite.get(skylarkKey);
if (prerequisiteProvider != null) {
result.add(prerequisiteProvider);
}
}
return result.build();
}
/**
* Returns the iterable of collections that have the specified provider.
*/
public static <S extends TransitiveInfoCollection, C extends TransitiveInfoProvider> Iterable<S>
filterByProvider(Iterable<S> prerequisites, final Class<C> provider) {
return Iterables.filter(prerequisites, new Predicate<S>() {
@Override
public boolean apply(S target) {
return target.getProvider(provider) != null;
}
});
}
/**
* Returns the path of the associated manifest file for the path of a Fileset. Works for both
* exec paths and root relative paths.
*/
public static PathFragment getManifestPathFromFilesetPath(PathFragment filesetDir) {
PathFragment manifestDir = filesetDir.replaceName("_" + filesetDir.getBaseName());
PathFragment outputManifestFrag = manifestDir.getRelative("MANIFEST");
return outputManifestFrag;
}
/**
* Returns the middleman artifact on the specified attribute of the specified rule, or an empty
* set if it does not exist.
*/
public static NestedSet<Artifact> getMiddlemanFor(RuleContext rule, String attribute) {
TransitiveInfoCollection prereq = rule.getPrerequisite(attribute, Mode.HOST);
if (prereq == null) {
return NestedSetBuilder.emptySet(Order.STABLE_ORDER);
}
MiddlemanProvider provider = prereq.getProvider(MiddlemanProvider.class);
if (provider == null) {
return NestedSetBuilder.emptySet(Order.STABLE_ORDER);
}
return provider.getMiddlemanArtifact();
}
/**
* Returns a path fragment qualified by the rule name and unique fragment to
* disambiguate artifacts produced from the source file appearing in
* multiple rules.
*
* <p>For example "//pkg:target" -> "pkg/<fragment>/target.
*/
public static PathFragment getUniqueDirectory(Label label, PathFragment fragment) {
return label.getPackageIdentifier().getSourceRoot().getRelative(fragment)
.getRelative(label.getName());
}
/**
* Checks that the given provider class either refers to an interface or to a value class.
*/
public static <T extends TransitiveInfoProvider> void checkProvider(Class<T> clazz) {
// Write this check in terms of getName() rather than getSimpleName(); the latter is expensive.
if (!clazz.isInterface() && clazz.getName().contains(".AutoValue_")) {
// We must have a superclass due to the generic bound above.
throw new IllegalArgumentException(
clazz + " is generated by @AutoValue; use " + clazz.getSuperclass() + " instead");
}
}
}
|
