| // 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.toolchains; |
| |
| import static com.google.common.collect.ImmutableList.toImmutableList; |
| import static java.util.stream.Collectors.joining; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.collect.ImmutableSet; |
| import com.google.devtools.build.lib.analysis.PlatformConfiguration; |
| import com.google.devtools.build.lib.analysis.config.BuildConfigurationValue; |
| import com.google.devtools.build.lib.analysis.config.ConfigMatchingProvider; |
| import com.google.devtools.build.lib.analysis.config.InvalidConfigurationException; |
| import com.google.devtools.build.lib.analysis.config.ToolchainTypeRequirement; |
| import com.google.devtools.build.lib.analysis.platform.ConstraintCollection; |
| import com.google.devtools.build.lib.analysis.platform.ConstraintSettingInfo; |
| import com.google.devtools.build.lib.analysis.platform.DeclaredToolchainInfo; |
| import com.google.devtools.build.lib.analysis.platform.PlatformInfo; |
| import com.google.devtools.build.lib.analysis.platform.ToolchainTypeInfo; |
| import com.google.devtools.build.lib.cmdline.Label; |
| import com.google.devtools.build.lib.events.Event; |
| import com.google.devtools.build.lib.server.FailureDetails.Toolchain.Code; |
| import com.google.devtools.build.lib.skyframe.ConfiguredTargetKey; |
| import com.google.devtools.build.lib.skyframe.toolchains.PlatformLookupUtil.InvalidPlatformException; |
| import com.google.devtools.build.lib.skyframe.toolchains.RegisteredToolchainsFunction.InvalidToolchainLabelException; |
| import com.google.devtools.build.lib.skyframe.toolchains.SingleToolchainResolutionValue.SingleToolchainResolutionKey; |
| 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 com.google.errorprone.annotations.FormatMethod; |
| import com.google.errorprone.annotations.FormatString; |
| import java.util.ArrayList; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Set; |
| import javax.annotation.Nullable; |
| |
| /** {@link SkyFunction} which performs toolchain resolution for a single toolchain type. */ |
| public class SingleToolchainResolutionFunction implements SkyFunction { |
| |
| @Nullable |
| @Override |
| public SkyValue compute(SkyKey skyKey, Environment env) |
| throws ToolchainResolutionFunctionException, InterruptedException { |
| SingleToolchainResolutionKey key = (SingleToolchainResolutionKey) skyKey.argument(); |
| |
| // This call could be combined with the call below, but this SkyFunction is evaluated so rarely |
| // it's not worth optimizing. |
| BuildConfigurationValue configuration = |
| (BuildConfigurationValue) env.getValue(key.configurationKey()); |
| if (env.valuesMissing()) { |
| return null; |
| } |
| |
| // Get all toolchains. |
| RegisteredToolchainsValue toolchains; |
| try { |
| toolchains = |
| (RegisteredToolchainsValue) |
| env.getValueOrThrow( |
| RegisteredToolchainsValue.key(key.configurationKey()), |
| InvalidToolchainLabelException.class); |
| if (toolchains == null) { |
| return null; |
| } |
| } catch (InvalidToolchainLabelException e) { |
| throw new ToolchainResolutionFunctionException(e); |
| } |
| |
| // Check if we are debugging the target or the toolchain type. |
| boolean debug = |
| key.debugTarget() |
| || configuration |
| .getFragment(PlatformConfiguration.class) |
| .debugToolchainResolution(key.toolchainType().toolchainType()); |
| |
| // Find the right one. |
| List<String> resolutionTrace = debug ? new ArrayList<>() : null; |
| SingleToolchainResolutionValue toolchainResolution = |
| resolveConstraints( |
| key.toolchainType(), |
| key.toolchainTypeInfo(), |
| key.availableExecutionPlatformKeys(), |
| key.targetPlatformKey(), |
| toolchains.registeredToolchains(), |
| env, |
| resolutionTrace); |
| |
| if (debug) { |
| env.getListener().handle(Event.info(String.join("\n", resolutionTrace))); |
| } |
| |
| return toolchainResolution; |
| } |
| |
| /** |
| * Given the available execution platforms and toolchains, find the set of platform, toolchain |
| * pairs that are compatible a) with each other, and b) with the toolchain type and target |
| * platform. |
| */ |
| @Nullable |
| private static SingleToolchainResolutionValue resolveConstraints( |
| ToolchainTypeRequirement toolchainType, |
| ToolchainTypeInfo toolchainTypeInfo, |
| List<ConfiguredTargetKey> availableExecutionPlatformKeys, |
| ConfiguredTargetKey targetPlatformKey, |
| ImmutableList<DeclaredToolchainInfo> toolchains, |
| Environment env, |
| @Nullable List<String> resolutionTrace) |
| throws ToolchainResolutionFunctionException, InterruptedException { |
| |
| // Load the PlatformInfo needed to check constraints. |
| Map<ConfiguredTargetKey, PlatformInfo> platforms; |
| try { |
| platforms = |
| PlatformLookupUtil.getPlatformInfo( |
| ImmutableList.<ConfiguredTargetKey>builderWithExpectedSize( |
| availableExecutionPlatformKeys.size() + 1) |
| .add(targetPlatformKey) |
| .addAll(availableExecutionPlatformKeys) |
| .build(), |
| env); |
| if (env.valuesMissing()) { |
| return null; |
| } |
| } catch (InvalidPlatformException e) { |
| throw new ToolchainResolutionFunctionException(e); |
| } |
| |
| PlatformInfo targetPlatform = platforms.get(targetPlatformKey); |
| |
| // Platforms may exist multiple times in availableExecutionPlatformKeys. The Set lets this code |
| // check whether a platform has already been seen during processing. |
| Set<ConfiguredTargetKey> platformKeysSeen = new HashSet<>(); |
| ImmutableMap.Builder<ConfiguredTargetKey, Label> builder = ImmutableMap.builder(); |
| |
| // Pre-filter for the correct toolchain type. This simplifies the loop and makes debugging |
| // toolchain resolution much, much easier. |
| ImmutableList<DeclaredToolchainInfo> filteredToolchains = |
| toolchains.stream() |
| .filter( |
| toolchain -> |
| toolchain.toolchainType().typeLabel().equals(toolchainType.toolchainType())) |
| .collect(toImmutableList()); |
| |
| debugMessage( |
| resolutionTrace, |
| IndentLevel.TARGET_PLATFORM_LEVEL, |
| "Performing resolution of %s for target platform %s", |
| toolchainType.toolchainType(), |
| targetPlatform.label()); |
| |
| for (DeclaredToolchainInfo toolchain : filteredToolchains) { |
| // Make sure the target setting matches but watch out for resolution errors. |
| ArrayList<String> nonmatchingSettings = new ArrayList<>(); |
| ArrayList<String> errors = new ArrayList<>(); |
| |
| // TODO(blaze-configurability-team): If this pattern comes up more often, add a central |
| // facility for merging multiple MatchResult |
| for (ConfigMatchingProvider configProvider : toolchain.targetSettings()) { |
| ConfigMatchingProvider.MatchResult matchResult = configProvider.result(); |
| if (matchResult.getError() != null) { |
| String message = matchResult.getError(); |
| errors.add("For config_setting " + configProvider.label().getName() + ", " + message); |
| } else if (matchResult.equals(ConfigMatchingProvider.MatchResult.NOMATCH)) { |
| nonmatchingSettings.add(configProvider.label().getName()); |
| } |
| } |
| if (!errors.isEmpty()) { |
| // TODO(blaze-configurability-team): This should only be due to feature flag trimming. So, |
| // would be better to just ensure toolchain resolution isn't transitively dependent on |
| // feature flags at all. |
| throw new ToolchainResolutionFunctionException( |
| new InvalidConfigurationDuringToolchainResolutionException( |
| new InvalidConfigurationException( |
| "Unrecoverable errors resolving config_setting associated with " |
| + toolchain.toolchainLabel() |
| + ": " |
| + String.join("; ", errors)))); |
| } |
| if (!nonmatchingSettings.isEmpty()) { |
| debugMessage( |
| resolutionTrace, |
| IndentLevel.TOOLCHAIN_LEVEL, |
| "Rejected toolchain %s; mismatching config settings: %s", |
| toolchain.toolchainLabel(), |
| String.join(", ", nonmatchingSettings)); |
| continue; |
| } |
| |
| // Make sure the target platform matches. |
| if (!checkConstraints( |
| resolutionTrace, |
| toolchain.targetConstraints(), |
| /* isTargetPlatform= */ true, |
| targetPlatform, |
| toolchain.toolchainLabel())) { |
| continue; |
| } |
| |
| debugMessage( |
| resolutionTrace, |
| IndentLevel.TOOLCHAIN_LEVEL, |
| "Toolchain %s is compatible with target plaform, searching for execution platforms:", |
| toolchain.toolchainLabel()); |
| |
| boolean done = true; |
| |
| // Find the matching execution platforms. |
| for (ConfiguredTargetKey executionPlatformKey : availableExecutionPlatformKeys) { |
| // Only check the toolchains if this is a new platform. |
| if (platformKeysSeen.contains(executionPlatformKey)) { |
| debugMessage( |
| resolutionTrace, |
| IndentLevel.EXECUTION_PLATFORM_LEVEL, |
| "Skipping execution platform %s; it has already selected a toolchain", |
| executionPlatformKey.getLabel()); |
| continue; |
| } |
| |
| PlatformInfo executionPlatform = platforms.get(executionPlatformKey); |
| if (!checkConstraints( |
| resolutionTrace, |
| toolchain.execConstraints(), |
| /* isTargetPlatform= */ false, |
| executionPlatform, |
| toolchain.toolchainLabel())) { |
| // Keep looking for a valid toolchain for this exec platform |
| done = false; |
| continue; |
| } |
| |
| debugMessage( |
| resolutionTrace, |
| IndentLevel.EXECUTION_PLATFORM_LEVEL, |
| "Compatible execution platform %s", |
| executionPlatformKey.getLabel()); |
| builder.put(executionPlatformKey, toolchain.toolchainLabel()); |
| platformKeysSeen.add(executionPlatformKey); |
| } |
| |
| if (done) { |
| debugMessage( |
| resolutionTrace, |
| IndentLevel.TOOLCHAIN_LEVEL, |
| "All execution platforms have been assigned a %s toolchain, stopping", |
| toolchainType.toolchainType()); |
| break; |
| } |
| } |
| |
| ImmutableMap<ConfiguredTargetKey, Label> resolvedToolchainLabels = builder.buildOrThrow(); |
| if (resolutionTrace != null) { |
| if (resolvedToolchainLabels.isEmpty()) { |
| debugMessage( |
| resolutionTrace, |
| IndentLevel.TARGET_PLATFORM_LEVEL, |
| "No %s toolchain found for target platform %s.", |
| toolchainType.toolchainType(), |
| targetPlatform.label()); |
| } else { |
| debugMessage( |
| resolutionTrace, |
| IndentLevel.TARGET_PLATFORM_LEVEL, |
| "Recap of selected %s toolchains for target platform %s:", |
| toolchainType.toolchainType(), |
| targetPlatform.label()); |
| resolvedToolchainLabels.forEach( |
| (executionPlatformKey, toolchainLabel) -> |
| debugMessage( |
| resolutionTrace, |
| IndentLevel.TOOLCHAIN_LEVEL, |
| "Selected %s to run on execution platform %s", |
| toolchainLabel, |
| executionPlatformKey.getLabel())); |
| } |
| } |
| |
| return SingleToolchainResolutionValue.create(toolchainTypeInfo, resolvedToolchainLabels); |
| } |
| |
| /** Helper enum to define the three indentation levels used in {@code debugMessage}. */ |
| private enum IndentLevel { |
| TARGET_PLATFORM_LEVEL(""), |
| TOOLCHAIN_LEVEL(" "), |
| EXECUTION_PLATFORM_LEVEL(" "); |
| |
| final String value; |
| |
| IndentLevel(String value) { |
| this.value = value; |
| } |
| |
| public String indent() { |
| return value; |
| } |
| } |
| |
| /** |
| * Helper method to print a debugging message, if the given {@code resolutionTrace} is not {@code |
| * null}. |
| */ |
| @FormatMethod |
| private static void debugMessage( |
| @Nullable List<String> resolutionTrace, |
| IndentLevel indent, |
| @FormatString String template, |
| Object... args) { |
| if (resolutionTrace == null) { |
| return; |
| } |
| String padding = resolutionTrace.isEmpty() ? "" : " ".repeat("INFO: ".length()); |
| resolutionTrace.add( |
| padding + "ToolchainResolution: " + indent.indent() + String.format(template, args)); |
| } |
| |
| /** |
| * Returns {@code true} iff all constraints set by the toolchain and in the {@link PlatformInfo} |
| * match. |
| */ |
| private static boolean checkConstraints( |
| @Nullable List<String> resolutionTrace, |
| ConstraintCollection toolchainConstraints, |
| boolean isTargetPlatform, |
| PlatformInfo platform, |
| Label toolchainLabel) { |
| |
| // Check every constraint_setting in either the toolchain or the platform. |
| ImmutableSet<ConstraintSettingInfo> mismatchSettings = |
| toolchainConstraints.diff(platform.constraints()); |
| |
| // If a constraint_setting has a default_constraint_value, and the platform |
| // sets a non-default constraint value for the same constraint_setting, then |
| // even toolchains with no reference to that constraint_setting will detect |
| // a mismatch here. This manifests as a toolchain resolution failure (#8778). |
| // |
| // To allow combining rulesets with their own toolchains in a single top-level |
| // workspace, toolchains that do not reference a constraint_setting should not |
| // be forced to match with it. |
| ImmutableSet<ConstraintSettingInfo> mismatchSettingsWithDefault = |
| mismatchSettings.stream() |
| .filter(toolchainConstraints::hasWithoutDefault) |
| .collect(ImmutableSet.toImmutableSet()); |
| |
| if (resolutionTrace != null && !mismatchSettingsWithDefault.isEmpty()) { |
| String mismatchValues = |
| mismatchSettingsWithDefault.stream() |
| .filter(toolchainConstraints::has) |
| .map(s -> toolchainConstraints.get(s).label().getName()) |
| .collect(joining(", ")); |
| if (!mismatchValues.isEmpty()) { |
| mismatchValues = "; mismatching values: " + mismatchValues; |
| } |
| |
| String missingSettings = |
| mismatchSettingsWithDefault.stream() |
| .filter(s -> !toolchainConstraints.has(s)) |
| .map(s -> s.label().getName()) |
| .collect(joining(", ")); |
| if (!missingSettings.isEmpty()) { |
| missingSettings = "; missing: " + missingSettings; |
| } |
| if (isTargetPlatform) { |
| debugMessage( |
| resolutionTrace, |
| IndentLevel.TOOLCHAIN_LEVEL, |
| "Rejected toolchain %s%s", |
| toolchainLabel, |
| mismatchValues + missingSettings); |
| } else { |
| debugMessage( |
| resolutionTrace, |
| IndentLevel.EXECUTION_PLATFORM_LEVEL, |
| "Incompatible execution platform %s%s", |
| platform.label(), |
| mismatchValues + missingSettings); |
| } |
| } |
| |
| return mismatchSettingsWithDefault.isEmpty(); |
| } |
| |
| /** |
| * Exception used when there was some issue with the toolchain making it impossible to resolve |
| * constraints. |
| */ |
| static final class InvalidConfigurationDuringToolchainResolutionException |
| extends ToolchainException { |
| InvalidConfigurationDuringToolchainResolutionException(InvalidConfigurationException e) { |
| super(e); |
| } |
| |
| @Override |
| protected Code getDetailedCode() { |
| return Code.INVALID_CONSTRAINT_VALUE; |
| } |
| } |
| |
| /** |
| * Used to indicate errors during the computation of an {@link SingleToolchainResolutionValue}. |
| */ |
| private static final class ToolchainResolutionFunctionException extends SkyFunctionException { |
| ToolchainResolutionFunctionException(InvalidConfigurationDuringToolchainResolutionException e) { |
| super(e, Transience.PERSISTENT); |
| } |
| |
| ToolchainResolutionFunctionException(InvalidToolchainLabelException e) { |
| super(e, Transience.PERSISTENT); |
| } |
| |
| ToolchainResolutionFunctionException(InvalidPlatformException e) { |
| super(e, Transience.PERSISTENT); |
| } |
| } |
| } |
