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
213
214
|
// Copyright 2017 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.PlatformConfiguration;
import com.google.devtools.build.lib.analysis.PlatformOptions;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.platform.ConstraintValueInfo;
import com.google.devtools.build.lib.analysis.platform.DeclaredToolchainInfo;
import com.google.devtools.build.lib.analysis.platform.PlatformInfo;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.packages.NoSuchThingException;
import com.google.devtools.build.lib.skyframe.ConfiguredTargetFunction.ConfiguredValueCreationException;
import com.google.devtools.build.lib.skyframe.RegisteredToolchainsFunction.InvalidTargetException;
import com.google.devtools.build.lib.skyframe.ToolchainResolutionValue.ToolchainResolutionKey;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.skyframe.SkyFunction;
import com.google.devtools.build.skyframe.SkyFunctionException;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import javax.annotation.Nullable;
/** {@link SkyFunction} which performs toolchain resolution for a class of rules. */
public class ToolchainResolutionFunction implements SkyFunction {
@Nullable
@Override
public SkyValue compute(SkyKey skyKey, Environment env)
throws SkyFunctionException, InterruptedException {
ToolchainResolutionKey key = (ToolchainResolutionKey) skyKey.argument();
BuildConfiguration configuration = key.configuration();
PlatformConfiguration platformConfiguration =
configuration.getFragment(PlatformConfiguration.class);
if (platformConfiguration.hasToolchainOverride(key.toolchainType())) {
// Short circuit everything and just return the override.
return ToolchainResolutionValue.create(
platformConfiguration.getToolchainOverride(key.toolchainType()));
}
// Get all toolchains.
RegisteredToolchainsValue toolchains;
try {
toolchains =
(RegisteredToolchainsValue)
env.getValueOrThrow(
RegisteredToolchainsValue.key(key.configuration()),
ConfiguredValueCreationException.class,
InvalidTargetException.class,
EvalException.class);
if (toolchains == null) {
return null;
}
} catch (ConfiguredValueCreationException e) {
throw new ToolchainResolutionFunctionException(e);
} catch (InvalidTargetException e) {
throw new ToolchainResolutionFunctionException(e);
} catch (EvalException e) {
throw new ToolchainResolutionFunctionException(e);
}
// Find the right one.
boolean debug = configuration.getOptions().get(PlatformOptions.class).toolchainResolutionDebug;
DeclaredToolchainInfo toolchain =
resolveConstraints(
key.toolchainType(),
key.execPlatform(),
key.targetPlatform(),
toolchains.registeredToolchains(),
debug ? env.getListener() : null);
if (toolchain == null) {
throw new ToolchainResolutionFunctionException(
new NoToolchainFoundException(key.toolchainType()));
}
return ToolchainResolutionValue.create(toolchain.toolchainLabel());
}
@VisibleForTesting
static DeclaredToolchainInfo resolveConstraints(
Label toolchainType,
PlatformInfo execPlatform,
PlatformInfo targetPlatform,
ImmutableList<DeclaredToolchainInfo> toolchains,
@Nullable EventHandler eventHandler) {
debugMessage(eventHandler, "Looking for toolchain of type %s...", toolchainType);
for (DeclaredToolchainInfo toolchain : toolchains) {
// Make sure the type matches.
if (!toolchain.toolchainType().equals(toolchainType)) {
continue;
}
debugMessage(eventHandler, " Considering toolchain %s...", toolchain.toolchainLabel());
if (!checkConstraints(eventHandler, toolchain.execConstraints(), "execution", execPlatform)) {
debugMessage(
eventHandler,
" Rejected toolchain %s, because of execution platform mismatch",
toolchain.toolchainLabel());
continue;
}
if (!checkConstraints(
eventHandler, toolchain.targetConstraints(), "target", targetPlatform)) {
debugMessage(
eventHandler,
" Rejected toolchain %s, because of target platform mismatch",
toolchain.toolchainLabel());
continue;
}
debugMessage(eventHandler, " Selected toolchain %s", toolchain.toolchainLabel());
return toolchain;
}
debugMessage(eventHandler, " No toolchain found");
return null;
}
/**
* Helper method to print a debugging message, if the given {@link EventHandler} is not {@code
* null}.
*/
private static void debugMessage(
@Nullable EventHandler eventHandler, String template, Object... args) {
if (eventHandler == null) {
return;
}
eventHandler.handle(Event.info("ToolchainResolution: " + String.format(template, args)));
}
/**
* Returns {@code true} iff all constraints set by the toolchain are present in the {@link
* PlatformInfo}.
*/
private static boolean checkConstraints(
@Nullable EventHandler eventHandler,
Iterable<ConstraintValueInfo> toolchainConstraints,
String platformType,
PlatformInfo platform) {
for (ConstraintValueInfo constraint : toolchainConstraints) {
ConstraintValueInfo found = platform.getConstraint(constraint.constraint());
if (!constraint.equals(found)) {
debugMessage(
eventHandler,
" Toolchain constraint %s has value %s, "
+ "which does not match value %s from the %s platform %s",
constraint.constraint().label(),
constraint.label(),
found != null ? found.label() : "<missing>",
platformType,
platform.label());
return false;
}
}
return true;
}
@Nullable
@Override
public String extractTag(SkyKey skyKey) {
return null;
}
/** Used to indicate that a toolchain was not found for the current request. */
public static final class NoToolchainFoundException extends NoSuchThingException {
private final Label missingToolchainType;
public NoToolchainFoundException(Label missingToolchainType) {
super(String.format("no matching toolchain found for %s", missingToolchainType));
this.missingToolchainType = missingToolchainType;
}
public Label missingToolchainType() {
return missingToolchainType;
}
}
/** Used to indicate errors during the computation of an {@link ToolchainResolutionValue}. */
private static final class ToolchainResolutionFunctionException extends SkyFunctionException {
public ToolchainResolutionFunctionException(NoToolchainFoundException e) {
super(e, Transience.PERSISTENT);
}
public ToolchainResolutionFunctionException(ConfiguredValueCreationException e) {
super(e, Transience.PERSISTENT);
}
public ToolchainResolutionFunctionException(InvalidTargetException e) {
super(e, Transience.PERSISTENT);
}
public ToolchainResolutionFunctionException(EvalException e) {
super(e, Transience.PERSISTENT);
}
}
}
|
