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
|
// 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 com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.PlatformConfiguration;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.platform.PlatformInfo;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.TargetParsingException;
import com.google.devtools.build.lib.packages.Package;
import com.google.devtools.build.lib.pkgcache.FilteringPolicies;
import com.google.devtools.build.lib.skyframe.PlatformLookupUtil.InvalidPlatformException;
import com.google.devtools.build.skyframe.SkyFunction;
import com.google.devtools.build.skyframe.SkyFunctionException;
import com.google.devtools.build.skyframe.SkyFunctionException.Transience;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import java.util.List;
import javax.annotation.Nullable;
/** {@link SkyFunction} that returns all registered execution platforms available. */
public class RegisteredExecutionPlatformsFunction implements SkyFunction {
@Nullable
@Override
public SkyValue compute(SkyKey skyKey, Environment env)
throws SkyFunctionException, InterruptedException {
BuildConfigurationValue buildConfigurationValue =
(BuildConfigurationValue)
env.getValue(((RegisteredExecutionPlatformsValue.Key) skyKey).getConfigurationKey());
if (env.valuesMissing()) {
return null;
}
BuildConfiguration configuration = buildConfigurationValue.getConfiguration();
ImmutableList.Builder<String> targetPatterns = new ImmutableList.Builder<>();
// Get the execution platforms from the configuration.
PlatformConfiguration platformConfiguration =
configuration.getFragment(PlatformConfiguration.class);
if (platformConfiguration != null) {
targetPatterns.addAll(platformConfiguration.getExtraExecutionPlatforms());
}
// Get the registered execution platforms from the WORKSPACE.
List<String> workspaceExecutionPlatforms = getWorkspaceExecutionPlatforms(env);
if (workspaceExecutionPlatforms == null) {
return null;
}
targetPatterns.addAll(workspaceExecutionPlatforms);
// Expand target patterns.
ImmutableList<Label> platformLabels;
try {
platformLabels =
TargetPatternUtil.expandTargetPatterns(
env, targetPatterns.build(), FilteringPolicies.ruleType("platform", true));
if (env.valuesMissing()) {
return null;
}
} catch (TargetPatternUtil.InvalidTargetPatternException e) {
throw new RegisteredExecutionPlatformsFunctionException(
new InvalidExecutionPlatformLabelException(e), Transience.PERSISTENT);
}
// Load the configured target for each, and get the declared execution platforms providers.
ImmutableList<ConfiguredTargetKey> registeredExecutionPlatformKeys =
configureRegisteredExecutionPlatforms(env, configuration, platformLabels);
if (env.valuesMissing()) {
return null;
}
return RegisteredExecutionPlatformsValue.create(registeredExecutionPlatformKeys);
}
/**
* Loads the external package and then returns the registered execution platform labels.
*
* @param env the environment to use for lookups
*/
@Nullable
@VisibleForTesting
public static List<String> getWorkspaceExecutionPlatforms(Environment env)
throws InterruptedException {
PackageValue externalPackageValue =
(PackageValue) env.getValue(PackageValue.key(Label.EXTERNAL_PACKAGE_IDENTIFIER));
if (externalPackageValue == null) {
return null;
}
Package externalPackage = externalPackageValue.getPackage();
return externalPackage.getRegisteredExecutionPlatforms();
}
private ImmutableList<ConfiguredTargetKey> configureRegisteredExecutionPlatforms(
Environment env, BuildConfiguration configuration, List<Label> labels)
throws InterruptedException, RegisteredExecutionPlatformsFunctionException {
ImmutableList<ConfiguredTargetKey> keys =
labels
.stream()
.map(label -> ConfiguredTargetKey.of(label, configuration))
.collect(ImmutableList.toImmutableList());
// Load the actual configured targets and ensure that they have real, valid PlatformInfo
// instances. These are loaded later during toolchain resolution, so this is work that needs to
// be done anyway, but here we can fail fast on an error.
try {
PlatformLookupUtil.getPlatformInfo(keys, env);
if (env.valuesMissing()) {
return null;
}
} catch (InvalidPlatformException e) {
throw new RegisteredExecutionPlatformsFunctionException(e, Transience.PERSISTENT);
}
return keys;
}
@Nullable
@Override
public String extractTag(SkyKey skyKey) {
return null;
}
/**
* Used to indicate that the given {@link Label} represents a {@link ConfiguredTarget} which is
* not a valid {@link PlatformInfo} provider.
*/
static final class InvalidExecutionPlatformLabelException extends Exception {
public InvalidExecutionPlatformLabelException(
TargetPatternUtil.InvalidTargetPatternException e) {
this(e.getInvalidPattern(), e.getTpe());
}
public InvalidExecutionPlatformLabelException(String invalidPattern, TargetParsingException e) {
super(
String.format(
"invalid registered execution platform '%s': %s", invalidPattern, e.getMessage()),
e);
}
}
/**
* Used to declare all the exception types that can be wrapped in the exception thrown by {@link
* #compute}.
*/
private static class RegisteredExecutionPlatformsFunctionException extends SkyFunctionException {
private RegisteredExecutionPlatformsFunctionException(
InvalidExecutionPlatformLabelException cause, Transience transience) {
super(cause, transience);
}
private RegisteredExecutionPlatformsFunctionException(
InvalidPlatformException cause, Transience transience) {
super(cause, transience);
}
}
}
|
