forked from bazelbuild/bazel
-
Notifications
You must be signed in to change notification settings - Fork 0
/
PlatformLookupUtil.java
212 lines (188 loc) · 8.01 KB
/
PlatformLookupUtil.java
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
// Copyright 2018 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 static com.google.common.collect.ImmutableSet.toImmutableSet;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.actions.MutableActionGraph.ActionConflictException;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.ConfiguredTargetValue;
import com.google.devtools.build.lib.analysis.platform.PlatformInfo;
import com.google.devtools.build.lib.analysis.platform.PlatformProviderUtils;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.packages.NoSuchPackageException;
import com.google.devtools.build.lib.packages.NoSuchTargetException;
import com.google.devtools.build.lib.packages.NoSuchThingException;
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.server.FailureDetails.Toolchain.Code;
import com.google.devtools.build.skyframe.SkyFunction.Environment;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.ValueOrException;
import com.google.devtools.build.skyframe.ValueOrException3;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.Nullable;
/** Helper class that looks up {@link PlatformInfo} data. */
public class PlatformLookupUtil {
@Nullable
public static Map<ConfiguredTargetKey, PlatformInfo> getPlatformInfo(
ImmutableList<ConfiguredTargetKey> platformKeys, Environment env)
throws InterruptedException, InvalidPlatformException {
validatePlatformKeys(platformKeys, env);
if (env.valuesMissing()) {
return null;
}
Map<
SkyKey,
ValueOrException3<
ConfiguredValueCreationException, NoSuchThingException, ActionConflictException>>
values =
env.getValuesOrThrow(
platformKeys,
ConfiguredValueCreationException.class,
NoSuchThingException.class,
ActionConflictException.class);
boolean valuesMissing = env.valuesMissing();
Map<ConfiguredTargetKey, PlatformInfo> platforms = valuesMissing ? null : new HashMap<>();
for (ConfiguredTargetKey key : platformKeys) {
PlatformInfo platformInfo = findPlatformInfo(key, values.get(key));
if (!valuesMissing && platformInfo != null) {
platforms.put(key, platformInfo);
}
}
if (valuesMissing) {
return null;
}
return platforms;
}
/** Validate that all keys are for actual platform targets. */
private static void validatePlatformKeys(
ImmutableList<ConfiguredTargetKey> platformKeys, Environment env)
throws InterruptedException, InvalidPlatformException {
// Load the packages. This should already be in Skyframe and thus not require a restart.
ImmutableSet<PackageValue.Key> packageKeys =
platformKeys.stream()
.map(ConfiguredTargetKey::getLabel)
.map(Label::getPackageIdentifier)
.distinct()
.map(PackageValue::key)
.collect(toImmutableSet());
Map<SkyKey, ValueOrException<NoSuchPackageException>> values =
env.getValuesOrThrow(packageKeys, NoSuchPackageException.class);
boolean valuesMissing = env.valuesMissing();
Map<PackageIdentifier, Package> packages = valuesMissing ? null : new HashMap<>();
for (Map.Entry<SkyKey, ValueOrException<NoSuchPackageException>> value : values.entrySet()) {
try {
PackageValue packageValue = (PackageValue) value.getValue().get();
if (!valuesMissing && packageValue != null) {
packages.put(packageValue.getPackage().getPackageIdentifier(), packageValue.getPackage());
}
} catch (NoSuchPackageException e) {
throw new InvalidPlatformException(e);
}
}
if (valuesMissing) {
return;
}
// Now check each platform.
for (ConfiguredTargetKey platformKey : platformKeys) {
try {
Label platformLabel = platformKey.getLabel();
Target target =
packages.get(platformLabel.getPackageIdentifier()).getTarget(platformLabel.getName());
if (!hasPlatformInfo(target)) {
// validation failure
throw new InvalidPlatformException(platformLabel);
}
} catch (NoSuchTargetException e) {
throw new InvalidPlatformException(e);
}
}
}
/**
* Returns the {@link PlatformInfo} provider from the {@link ConfiguredTarget} in the {@link
* ValueOrException3}, or {@code null} if the {@link ConfiguredTarget} is not present. If the
* {@link ConfiguredTarget} does not have a {@link PlatformInfo} provider, a {@link
* InvalidPlatformException} is thrown.
*/
@Nullable
private static PlatformInfo findPlatformInfo(
ConfiguredTargetKey key,
ValueOrException3<
ConfiguredValueCreationException, NoSuchThingException, ActionConflictException>
valueOrException)
throws InvalidPlatformException {
try {
ConfiguredTargetValue ctv = (ConfiguredTargetValue) valueOrException.get();
if (ctv == null) {
return null;
}
ConfiguredTarget configuredTarget = ctv.getConfiguredTarget();
PlatformInfo platformInfo = PlatformProviderUtils.platform(configuredTarget);
if (platformInfo == null) {
throw new InvalidPlatformException(configuredTarget.getLabel());
}
return platformInfo;
} catch (ConfiguredValueCreationException e) {
throw new InvalidPlatformException(key.getLabel(), e);
} catch (NoSuchThingException e) {
throw new InvalidPlatformException(e);
} catch (ActionConflictException e) {
throw new InvalidPlatformException(key.getLabel(), e);
}
}
static boolean hasPlatformInfo(Target target) {
Rule rule = target.getAssociatedRule();
// If the rule uses toolchain resolution, it can't be used as a target or exec platform.
if (rule == null) {
return false;
}
if (rule.useToolchainResolution()) {
return false;
}
return rule.getRuleClassObject()
.getAdvertisedProviders()
.advertises(PlatformInfo.PROVIDER.id());
}
/** Exception used when a platform label is not a valid platform. */
public static final class InvalidPlatformException extends ToolchainException {
private static final String DEFAULT_ERROR = "does not provide PlatformInfo";
InvalidPlatformException(Label label) {
super(formatError(label, DEFAULT_ERROR));
}
InvalidPlatformException(Label label, ConfiguredValueCreationException e) {
super(formatError(label, DEFAULT_ERROR), e);
}
public InvalidPlatformException(NoSuchThingException e) {
// Just propagate the inner exception, because it's directly actionable.
super(e);
}
public InvalidPlatformException(Label label, ActionConflictException e) {
super(formatError(label, DEFAULT_ERROR), e);
}
InvalidPlatformException(Label label, String error) {
super(formatError(label, error));
}
@Override
protected Code getDetailedCode() {
return Code.INVALID_PLATFORM_VALUE;
}
private static String formatError(Label label, String error) {
return String.format("Target %s was referenced as a platform, but %s", label, error);
}
}
}