Add skyfunction to return all registered toolchain labels.

Part of bazelbuild#2219. Change-Id: I7293fd13bd8e0931f92afd051e18a9e7ce63762d
katre · Jul 10, 2017 · 397a10c · 397a10c
1 parent 661187b
commit 397a10c
Show file tree

Hide file tree

Showing 6 changed files with 368 additions and 0 deletions.
diff --git a/src/main/java/com/google/devtools/build/lib/skyframe/RegisteredToolchainsFunction.java b/src/main/java/com/google/devtools/build/lib/skyframe/RegisteredToolchainsFunction.java
@@ -0,0 +1,132 @@
+package com.google.devtools.build.lib.skyframe;
+
+import com.google.common.base.Function;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Lists;
+import com.google.devtools.build.lib.analysis.ConfiguredTarget;
+import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
+import com.google.devtools.build.lib.analysis.platform.DeclaredToolchainInfo;
+import com.google.devtools.build.lib.analysis.platform.ToolchainInfo;
+import com.google.devtools.build.lib.cmdline.Label;
+import com.google.devtools.build.lib.rules.ExternalPackageUtil;
+import com.google.devtools.build.lib.skyframe.ConfiguredTargetFunction.ConfiguredValueCreationException;
+import com.google.devtools.build.lib.syntax.EvalException;
+import com.google.devtools.build.skyframe.LegacySkyKey;
+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 com.google.devtools.build.skyframe.ValueOrException;
+import java.util.List;
+import java.util.Map;
+import javax.annotation.Nullable;
+
+/**
+ * {@link SkyFunction} that returns all registered toolchains available for toolchain resolution.
+ */
+public class RegisteredToolchainsFunction implements SkyFunction {
+
+  @Nullable
+  @Override
+  public SkyValue compute(SkyKey skyKey, Environment env)
+      throws SkyFunctionException, InterruptedException {
+
+    BuildConfiguration configuration = (BuildConfiguration) skyKey.argument();
+
+    // Get the registered toolchains.
+    List<Label> registeredToolchainLabels = ExternalPackageUtil.getRegisteredToolchainLabels(env);
+    if (registeredToolchainLabels == null) {
+      return null;
+    }
+
+    // Load the configured target for each, and get the declared toolchain providers.
+    ImmutableList<DeclaredToolchainInfo> registeredToolchains =
+        configureRegisteredToolchains(env, configuration, registeredToolchainLabels);
+    if (env.valuesMissing()) {
+      return null;
+    }
+
+    return RegisteredToolchainsValue.create(registeredToolchains);
+  }
+
+  private ImmutableList<DeclaredToolchainInfo> configureRegisteredToolchains(
+      Environment env, final BuildConfiguration configuration, List<Label> labels)
+      throws InterruptedException, RegisteredToolchainsFunctionException {
+    List<SkyKey> keys =
+        Lists.transform(
+            labels,
+            new Function<Label, SkyKey>() {
+              @Override
+              public SkyKey apply(Label label) {
+                return LegacySkyKey.create(
+                    SkyFunctions.CONFIGURED_TARGET, new ConfiguredTargetKey(label, configuration));
+              }
+            });
+
+    Map<SkyKey, ValueOrException<ConfiguredValueCreationException>> values =
+        env.getValuesOrThrow(keys, ConfiguredValueCreationException.class);
+    if (env.valuesMissing()) {
+      return null;
+    }
+    ImmutableList.Builder<DeclaredToolchainInfo> toolchains = new ImmutableList.Builder<>();
+    for (SkyKey key : keys) {
+      ConfiguredTargetKey configuredTargetKey = (ConfiguredTargetKey) key.argument();
+      Label toolchainLabel = configuredTargetKey.getLabel();
+      try {
+        ConfiguredTarget target =
+            ((ConfiguredTargetValue) values.get(key).get()).getConfiguredTarget();
+        DeclaredToolchainInfo toolchainInfo = target.getProvider(DeclaredToolchainInfo.class);
+        if (toolchainInfo == null) {
+          throw new RegisteredToolchainsFunctionException(
+              new InvalidTargetException(toolchainLabel), Transience.PERSISTENT);
+        }
+        toolchains.add(toolchainInfo);
+      } catch (ConfiguredValueCreationException e) {
+        throw new RegisteredToolchainsFunctionException(e, Transience.PERSISTENT);
+      }
+    }
+    return toolchains.build();
+  }
+
+  @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 DeclaredToolchainInfo} provider.
+   */
+  public static final class InvalidTargetException extends Exception {
+
+    private final Label invalidLabel;
+
+    public InvalidTargetException(Label invalidLabel) {
+      super(String.format("target '%s' does not provide a toolchain", invalidLabel));
+      this.invalidLabel = invalidLabel;
+    }
+
+    public Label getInvalidLabel() {
+      return invalidLabel;
+    }
+  }
+
+  public static class RegisteredToolchainsFunctionException extends SkyFunctionException {
+
+    public RegisteredToolchainsFunctionException(EvalException cause, Transience transience) {
+      super(cause, transience);
+    }
+
+    public RegisteredToolchainsFunctionException(
+        InvalidTargetException cause, Transience transience) {
+      super(cause, transience);
+    }
+
+    public RegisteredToolchainsFunctionException(
+        ConfiguredValueCreationException cause, Transience persistent) {
+      super(cause, persistent);
+    }
+  }
+}
diff --git a/src/main/java/com/google/devtools/build/lib/skyframe/RegisteredToolchainsValue.java b/src/main/java/com/google/devtools/build/lib/skyframe/RegisteredToolchainsValue.java
@@ -0,0 +1,28 @@
+package com.google.devtools.build.lib.skyframe;
+
+import com.google.auto.value.AutoValue;
+import com.google.common.collect.ImmutableList;
+import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
+import com.google.devtools.build.lib.analysis.platform.DeclaredToolchainInfo;
+import com.google.devtools.build.skyframe.LegacySkyKey;
+import com.google.devtools.build.skyframe.SkyKey;
+import com.google.devtools.build.skyframe.SkyValue;
+
+/**
+ * A value which represents every toolchain known to Bazel and available for toolchain resolution.
+ */
+@AutoValue
+public abstract class RegisteredToolchainsValue implements SkyValue {
+
+  /** Returns the {@link SkyKey} for {@link RegisteredToolchainsValue}s. */
+  public static SkyKey key(BuildConfiguration configuration) {
+    return LegacySkyKey.create(SkyFunctions.REGISTERED_TOOLCHAINS, configuration);
+  }
+
+  public static RegisteredToolchainsValue create(
+      Iterable<DeclaredToolchainInfo> registeredToolchains) {
+    return new AutoValue_RegisteredToolchainsValue(ImmutableList.copyOf(registeredToolchains));
+  }
+
+  public abstract ImmutableList<DeclaredToolchainInfo> registeredToolchains();
+}
diff --git a/src/main/java/com/google/devtools/build/lib/skyframe/SkyFunctions.java b/src/main/java/com/google/devtools/build/lib/skyframe/SkyFunctions.java
@@ -107,6 +107,8 @@ public final class SkyFunctions {
       SkyFunctionName.create("ACTION_TEMPLATE_EXPANSION");
   public static final SkyFunctionName LOCAL_REPOSITORY_LOOKUP =
       SkyFunctionName.create("LOCAL_REPOSITORY_LOOKUP");
+  public static final SkyFunctionName REGISTERED_TOOLCHAINS =
+      SkyFunctionName.create("REGISTERED_TOOLCHAINS");
 
   public static Predicate<SkyKey> isSkyFunction(final SkyFunctionName functionName) {
     return new Predicate<SkyKey>() {

diff --git a/src/main/java/com/google/devtools/build/lib/skyframe/SkyframeExecutor.java b/src/main/java/com/google/devtools/build/lib/skyframe/SkyframeExecutor.java
@@ -455,6 +455,7 @@ private ImmutableMap<SkyFunctionName, SkyFunction> skyFunctions(
         SkyFunctions.ACTION_TEMPLATE_EXPANSION,
         new ActionTemplateExpansionFunction(removeActionsAfterEvaluation));
     map.put(SkyFunctions.LOCAL_REPOSITORY_LOOKUP, new LocalRepositoryLookupFunction());
+    map.put(SkyFunctions.REGISTERED_TOOLCHAINS, new RegisteredToolchainsFunction());
     map.putAll(extraSkyFunctions);
     return map.build();
   }

diff --git a/src/test/java/com/google/devtools/build/lib/skyframe/BUILD b/src/test/java/com/google/devtools/build/lib/skyframe/BUILD
@@ -25,6 +25,7 @@ java_library(
         "//src/main/java/com/google/devtools/build/lib:vfs",
         "//src/main/java/com/google/devtools/build/lib/actions",
         "//src/main/java/com/google/devtools/build/lib/cmdline",
+        "//src/main/java/com/google/devtools/build/lib/rules/platform",
         "//src/main/java/com/google/devtools/build/skyframe",
         "//src/main/java/com/google/devtools/build/skyframe:skyframe-objects",
         "//src/test/java/com/google/devtools/build/lib:actions_testutil",
@@ -69,15 +70,18 @@ java_test(
         "//src/main/java/com/google/devtools/build/lib:util",
         "//src/main/java/com/google/devtools/build/lib:vfs",
         "//src/main/java/com/google/devtools/build/lib/actions",
+        "//src/main/java/com/google/devtools/build/lib/analysis/platform",
         "//src/main/java/com/google/devtools/build/lib/cmdline",
         "//src/main/java/com/google/devtools/build/lib/rules/cpp",
+        "//src/main/java/com/google/devtools/build/lib/rules/platform",
         "//src/main/java/com/google/devtools/build/skyframe",
         "//src/main/java/com/google/devtools/build/skyframe:skyframe-objects",
         "//src/test/java/com/google/devtools/build/lib:actions_testutil",
         "//src/test/java/com/google/devtools/build/lib:analysis_testutil",
         "//src/test/java/com/google/devtools/build/lib:foundations_testutil",
         "//src/test/java/com/google/devtools/build/lib:packages_testutil",
         "//src/test/java/com/google/devtools/build/lib:testutil",
+        "//src/test/java/com/google/devtools/build/lib/skylark:testutil",
         "//third_party:guava",
         "//third_party:guava-testlib",
         "//third_party:jsr305",