Filter spawn strategies by execution platform (bazelbuild#24265)]

This PR implements part of the [Execution Platform Scoped Spawn Strategies](https://github.com/bazelbuild/proposals/blob/2b717b19fe805c405576c4feb9ffc6b772068898/designs/2023-06-04-exec-platform-scoped-spawn-strategies.md) proposal.

It adds a new flag `--allowed_strategies_by_exec_platform` which permits filtering spawn strategies for spawns execution platform.

## Example

```ini
# //.bazelrc
# Default strategies (order sensitive)
build --spawn_strategy=remote,worker,sandboxed,local

# Mnemonic targeted strategy override (order sensitive)
build --strategy=BAR=remote,sandboxed

# Host platform allowed strategies
build --allowed_strategies_by_exec_platform=@platforms//host:host=local,sandboxed,worker

# Remote platform allowed strategies
build --allowed_strategies_by_exec_platform=//:remote_platform=remote
```

For an action with mnemonic `FOO` configured for the host platform (`@platforms//host:host`), it will resolve `worker,sandboxed,local` as it's spawn strategy candidates.
* `remote` was eliminated as a candidate (not in allow list for platform).
* Order from `--spawn_strategy` was preserved.

For an action with mnemonic `BAR` configured for the host platform (`@platforms//host:host`), it will resolve `sandboxed` as it's spawn strategy candidate.
* `remote` was eliminated as a candidate (not in allow list for platform).
* Mnemonic override applied, leaving `sandboxed` as the final candidate.

For an action with mnemonic `BAR` configured for the remote platform (`//:remote_platform`), it will resolve `remote` as it's spawn strategy candidate.
* `sandboxed` was eliminated as a candidate (not in allow list for platform).
* Mnemonic override applied, leaving `remote` as the final candidate.

If no spawn strategy candidate remains after filtering, the standard error will be logged.
```
ERROR: /workspaces/___/BUILD.bazel:3:22: _description_ [for tool] failed: _mnemonic_ spawn \
cannot be executed with any of the available strategies: []. Your --spawn_strategy, \
--genrule_strategy, --strategy and/or --allowed_strategies_by_exec_platform flags are probably \
too strict. Visit bazelbuild#7480 for advice
```

Closes bazelbuild#24265.

PiperOrigin-RevId: 842893103
Change-Id: If2bdb19f08e5dd3c5941f4cfd6c39d7295ff0c25

Author: Silic0nS0ldier

src/main/java/com/google/devtools/build/lib/analysis/platform/BUILD

@@ -86,13 +86,12 @@ java_library(
     name = "platform_utils",
     srcs = ["PlatformUtils.java"],
     deps = [
+        ":platform",
         "//src/main/java/com/google/devtools/build/lib/actions",
         "//src/main/java/com/google/devtools/build/lib/remote/options",
         "//src/main/java/com/google/devtools/build/lib/util:string_encoding",
-        "//src/main/protobuf:failure_details_java_proto",
         "//third_party:guava",
         "//third_party:jsr305",
-        "@com_google_protobuf//:protobuf_java",
         "@remoteapis//:build_bazel_remote_execution_v2_remote_execution_java_proto",
     ],
 )

src/main/java/com/google/devtools/build/lib/analysis/platform/PlatformUtils.java

@@ -73,6 +73,28 @@ public static Platform getPlatformProto(Spawn spawn, @Nullable RemoteOptions rem
     return getPlatformProto(spawn, remoteOptions, ImmutableMap.of());
   }
 
+  private static boolean shouldProducePlatformProto(
+      Spawn spawn,
+      SortedMap<String, String> defaultExecProperties,
+      Map<String, String> additionalProperties) {
+    PlatformInfo executionPlatform = spawn.getExecutionPlatform();
+    if (executionPlatform != null) {
+      if (!executionPlatform.execProperties().isEmpty()) {
+        return true;
+      }
+    }
+    if (!spawn.getCombinedExecProperties().isEmpty()) {
+      return true;
+    }
+    if (!defaultExecProperties.isEmpty()) {
+      return true;
+    }
+    if (!additionalProperties.isEmpty()) {
+      return true;
+    }
+    return false;
+  }
+
   @Nullable
   public static Platform getPlatformProto(
       Spawn spawn, @Nullable RemoteOptions remoteOptions, Map<String, String> additionalProperties)
@@ -82,10 +104,8 @@ public static Platform getPlatformProto(
             ? remoteOptions.getRemoteDefaultExecProperties()
             : ImmutableSortedMap.of();
 
-    if (spawn.getExecutionPlatform() == null
-        && spawn.getCombinedExecProperties().isEmpty()
-        && defaultExecProperties.isEmpty()
-        && additionalProperties.isEmpty()) {
+    if (!shouldProducePlatformProto(spawn, defaultExecProperties, additionalProperties)) {
+      // Execution platform is null or functionally empty
       return null;
     }
 

src/main/java/com/google/devtools/build/lib/bazel/rules/BazelStrategyModule.java

@@ -18,6 +18,7 @@
 import com.google.devtools.build.lib.analysis.actions.FileWriteActionContext;
 import com.google.devtools.build.lib.analysis.actions.TemplateExpansionContext;
 import com.google.devtools.build.lib.buildtool.BuildRequest;
+import com.google.devtools.build.lib.cmdline.Label;
 import com.google.devtools.build.lib.exec.ExecutionOptions;
 import com.google.devtools.build.lib.exec.ModuleActionContextRegistry;
 import com.google.devtools.build.lib.exec.SpawnCache;
@@ -89,5 +90,9 @@ public void registerSpawnStrategies(
     for (Map.Entry<RegexFilter, List<String>> entry : options.strategyByRegexp) {
       registryBuilder.addDescriptionFilter(entry.getKey(), entry.getValue());
     }
+
+    for (Map.Entry<Label, List<String>> strategy : options.allowedStrategiesByExecPlatform) {
+      registryBuilder.addExecPlatformFilter(strategy.getKey(), strategy.getValue());
+    }
   }
 }

src/main/java/com/google/devtools/build/lib/exec/BUILD

@@ -92,10 +92,10 @@ java_library(
         ":regex_filter_assignment_converter",
         "//src/main/java/com/google/devtools/build/lib/actions",
         "//src/main/java/com/google/devtools/build/lib/actions:localhost_capacity",
+        "//src/main/java/com/google/devtools/build/lib/analysis/config:core_option_converters",
         "//src/main/java/com/google/devtools/build/lib/analysis/config:per_label_options",
+        "//src/main/java/com/google/devtools/build/lib/cmdline",
         "//src/main/java/com/google/devtools/build/lib/util",
-        "//src/main/java/com/google/devtools/build/lib/util:cpu_resource_converter",
-        "//src/main/java/com/google/devtools/build/lib/util:ram_resource_converter",
         "//src/main/java/com/google/devtools/build/lib/util:resource_converter",
         "//src/main/java/com/google/devtools/build/lib/vfs:pathfragment",
         "//src/main/java/com/google/devtools/common/options",
@@ -356,6 +356,7 @@ java_library(
         ":remote_local_fallback_registry",
         ":spawn_strategy_policy",
         "//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/events",
         "//src/main/java/com/google/devtools/build/lib/util",
         "//src/main/java/com/google/devtools/build/lib/util:abrupt_exit_exception",

src/main/java/com/google/devtools/build/lib/exec/ExecutionOptions.java

@@ -19,13 +19,16 @@
 import com.google.devtools.build.lib.actions.ActionExecutionContext.ShowSubcommands;
 import com.google.devtools.build.lib.actions.LocalHostCapacity;
 import com.google.devtools.build.lib.actions.ResourceSet;
+import com.google.devtools.build.lib.analysis.config.CoreOptionConverters.LabelConverter;
 import com.google.devtools.build.lib.analysis.config.PerLabelOptions;
+import com.google.devtools.build.lib.cmdline.Label;
 import com.google.devtools.build.lib.util.OptionsUtils;
 import com.google.devtools.build.lib.util.RegexFilter;
 import com.google.devtools.build.lib.util.ResourceConverter;
 import com.google.devtools.build.lib.vfs.PathFragment;
 import com.google.devtools.common.options.BoolOrEnumConverter;
 import com.google.devtools.common.options.Converters;
+import com.google.devtools.common.options.Converters.AssignmentToListOfValuesConverter;
 import com.google.devtools.common.options.Converters.CommaSeparatedNonEmptyOptionListConverter;
 import com.google.devtools.common.options.EnumConverter;
 import com.google.devtools.common.options.Option;
@@ -119,6 +122,31 @@ public class ExecutionOptions extends OptionsBase {
               + "the 'local' strategy, but reversing the order would run it with 'sandboxed'. ")
   public List<Map.Entry<RegexFilter, List<String>>> strategyByRegexp;
 
+  @Option(
+      name = "allowed_strategies_by_exec_platform",
+      allowMultiple = true,
+      converter = LabelToStringListConverter.class,
+      defaultValue = "null",
+      documentationCategory = OptionDocumentationCategory.EXECUTION_STRATEGY,
+      effectTags = {OptionEffectTag.EXECUTION},
+      help =
+          """
+          Filters spawn strategies by the execution platform without affecting order.
+          For example:
+          ```
+          common --spawn_strategy=remote,sandboxed,worker,local
+          common --strategy=Genrule=local
+          common --allowed_strategies_by_exec_platform=@platforms//host:host=local,sandboxed,worker
+          common --allowed_strategies_by_exec_platform=//:linux_amd64=remote
+          ```
+          With the above options;
+          - Actions configured for the host platform will be given `remote,sandboxed,worker`.
+          - Actions configured for the `//:linux_amd64` platform will be given `remote`.
+          - Actions configured for the `//:linux_amd64` platform with mnemonic `Genrule` will be
+            given no strategies and fail to spawn.
+          """)
+  public List<Map.Entry<Label, List<String>>> allowedStrategiesByExecPlatform;
+
   @Option(
       name = "materialize_param_files",
       defaultValue = "false",
@@ -586,4 +614,17 @@ public ShowSubcommandsConverter() {
           ShowSubcommands.class, "subcommand option", ShowSubcommands.TRUE, ShowSubcommands.FALSE);
     }
   }
+
+  private static class LabelToStringListConverter
+      extends AssignmentToListOfValuesConverter<Label, String> {
+
+    LabelToStringListConverter() {
+      super(new LabelConverter(), new Converters.StringConverter(), AllowEmptyKeys.NO);
+    }
+
+    @Override
+    public String getTypeDescription() {
+      return "a '<Label>=value[,value]' assignment";
+    }
+  }
 }

src/main/java/com/google/devtools/build/lib/exec/RemoteLocalFallbackRegistry.java

@@ -15,6 +15,7 @@
 package com.google.devtools.build.lib.exec;
 
 import com.google.devtools.build.lib.actions.ActionContext;
+import com.google.devtools.build.lib.actions.Spawn;
 import javax.annotation.Nullable;
 
 /**
@@ -29,5 +30,5 @@ public interface RemoteLocalFallbackRegistry extends ActionContext {
    * @return remote fallback strategy or {@code null} if none was registered
    */
   @Nullable
-  AbstractSpawnStrategy getRemoteLocalFallbackStrategy();
+  AbstractSpawnStrategy getRemoteLocalFallbackStrategy(Spawn spawn);
 }