src/main/java/com/google/devtools/build/lib/remote/RemoteOutputChecker.java - bazel - Git at Google

 // Copyright 2023 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.remote;

 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.base.Preconditions.checkState;
 import static com.google.devtools.build.lib.packages.TargetUtils.isTestRuleName;
 import static com.google.devtools.build.lib.skyframe.CoverageReportValue.COVERAGE_REPORT_KEY;

 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
 import com.google.devtools.build.lib.actions.ActionInput;
 import com.google.devtools.build.lib.actions.Artifact;
 import com.google.devtools.build.lib.actions.Artifact.TreeFileArtifact;
 import com.google.devtools.build.lib.actions.FileArtifactValue;
 import com.google.devtools.build.lib.actions.OutputChecker;
 import com.google.devtools.build.lib.analysis.AnalysisResult;
 import com.google.devtools.build.lib.analysis.ConfiguredAspect;
 import com.google.devtools.build.lib.analysis.ConfiguredTarget;
 import com.google.devtools.build.lib.analysis.ExtraActionArtifactsProvider;
 import com.google.devtools.build.lib.analysis.FilesToRunProvider;
 import com.google.devtools.build.lib.analysis.OutputGroupInfo;
 import com.google.devtools.build.lib.analysis.ProviderCollection;
 import com.google.devtools.build.lib.analysis.TopLevelArtifactContext;
 import com.google.devtools.build.lib.analysis.TopLevelArtifactHelper;
 import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTarget;
 import com.google.devtools.build.lib.analysis.test.TestProvider;
 import com.google.devtools.build.lib.clock.Clock;
 import com.google.devtools.build.lib.remote.options.RemoteOutputsMode;
 import com.google.devtools.build.lib.skyframe.SkyFunctions;
 import com.google.devtools.build.lib.vfs.PathFragment;
 import com.google.devtools.build.skyframe.MemoizingEvaluator;
 import java.util.concurrent.ConcurrentSkipListSet;
 import java.util.function.Predicate;
 import java.util.function.Supplier;
 import javax.annotation.Nullable;

 /**
  * An {@link OutputChecker} that checks the TTL of remote metadata and decides which outputs to
  * download.
  */
 public class RemoteOutputChecker implements OutputChecker {
   private enum CommandMode {
     UNKNOWN,
     BUILD,
     TEST,
     RUN,
     COVERAGE;
   }

   private final CommandMode commandMode;
   private final RemoteOutputsMode outputsMode;
   private final ImmutableList<Predicate<String>> patternsToDownload;
   @Nullable private final RemoteOutputChecker lastRemoteOutputChecker;

   @Nullable private Clock clock;

   private final ConcurrentArtifactPathTrie pathsToDownload = new ConcurrentArtifactPathTrie();

   public RemoteOutputChecker(
       String commandName,
       RemoteOutputsMode outputsMode,
       ImmutableList<Predicate<String>> patternsToDownload) {
     this(commandName, outputsMode, patternsToDownload, /* lastRemoteOutputChecker= */ null);
   }

   public RemoteOutputChecker(
       String commandName,
       RemoteOutputsMode outputsMode,
       ImmutableList<Predicate<String>> patternsToDownload,
       RemoteOutputChecker lastRemoteOutputChecker) {
     this.commandMode =
         switch (commandName) {
           case "build" -> CommandMode.BUILD;
           case "test" -> CommandMode.TEST;
           case "run" -> CommandMode.RUN;
           case "coverage" -> CommandMode.COVERAGE;
           default -> CommandMode.UNKNOWN;
         };
     this.outputsMode = outputsMode;
     this.patternsToDownload = patternsToDownload;
     this.lastRemoteOutputChecker = lastRemoteOutputChecker;
   }

   /** Sets this checker to check the TTL of remote metadata when deciding whether to trust it. */
   public void setCheckMetadataTtl(Clock clock) {
     this.clock = clock;
   }

   // Skymeld-only.
   public void afterTopLevelTargetAnalysis(
       ConfiguredTarget configuredTarget,
       Supplier<TopLevelArtifactContext> topLevelArtifactContextSupplier) {
     if (outputsMode == RemoteOutputsMode.ALL) {
       // For ALL, there's no need to keep track of toplevel targets - we download everything.
       return;
     }
     addTopLevelTarget(configuredTarget, configuredTarget, topLevelArtifactContextSupplier);
   }

   // Skymeld-only.
   public void afterTestAnalyzedEvent(ConfiguredTarget configuredTarget) {
     if (outputsMode == RemoteOutputsMode.ALL) {
       // For ALL, there's no need to keep track of toplevel targets - we download everything.
       return;
     }
     addTargetUnderTest(configuredTarget);
   }

   // Skymeld-only.
   public void afterAspectAnalysis(
       ConfiguredAspect configuredAspect,
       Supplier<TopLevelArtifactContext> topLevelArtifactContextSupplier) {
     if (outputsMode == RemoteOutputsMode.ALL) {
       // For ALL, there's no need to keep track of toplevel targets - we download everything.
       return;
     }
     addTopLevelTarget(
         configuredAspect, /* configuredTarget= */ null, topLevelArtifactContextSupplier);
   }

   // Skymeld-only.
   public void coverageArtifactsKnown(ImmutableSet<Artifact> coverageArtifacts) {
     if (outputsMode == RemoteOutputsMode.ALL) {
       // For ALL, there's no need to keep track of toplevel targets - we download everything.
       return;
     }
     maybeAddCoverageArtifacts(coverageArtifacts);
   }

   // Non-Skymeld only.
   public void afterAnalysis(AnalysisResult analysisResult) {
     if (outputsMode == RemoteOutputsMode.ALL) {
       // For ALL, there's no need to keep track of toplevel targets - we download everything.
       return;
     }
     for (var target : analysisResult.getTargetsToBuild()) {
       addTopLevelTarget(target, target, analysisResult::getTopLevelContext);
     }
     for (var aspect : analysisResult.getAspectsMap().values()) {
       addTopLevelTarget(aspect, /* configuredTarget= */ null, analysisResult::getTopLevelContext);
     }
     var targetsToTest = analysisResult.getTargetsToTest();
     if (targetsToTest != null) {
       for (var target : targetsToTest) {
         addTargetUnderTest(target);
       }
       maybeAddCoverageArtifacts(analysisResult.getArtifactsToBuild());
     }
   }

   private void addTopLevelTarget(
       ProviderCollection target,
       @Nullable ConfiguredTarget configuredTarget,
       Supplier<TopLevelArtifactContext> topLevelArtifactContextSupplier) {
     if (shouldAddTopLevelTarget(configuredTarget)) {
       var topLevelArtifactContext = topLevelArtifactContextSupplier.get();
       var artifactsToBuild =
           TopLevelArtifactHelper.getAllArtifactsToBuild(target, topLevelArtifactContext)
               .getImportantArtifacts();
       addOutputsToDownload(artifactsToBuild.toList());
       // RunfileTrees are requested with this special output group. We lack access to an
       // InputMetadataProvider that can expand arbitrary RunfileTrees, so we have to mirror that
       // logic here.
       if (topLevelArtifactContext.outputGroups().contains(OutputGroupInfo.HIDDEN_TOP_LEVEL)) {
         addRunfiles(target);
       }
       addExtraActionArtifacts(target);
     }
   }

   private void addRunfiles(ProviderCollection buildTarget) {
     var runfilesProvider = buildTarget.getProvider(FilesToRunProvider.class);
     if (runfilesProvider == null) {
       return;
     }
     var runfilesSupport = runfilesProvider.getRunfilesSupport();
     if (runfilesSupport == null) {
       return;
     }
     var runfiles = runfilesSupport.getRunfiles();
     for (Artifact runfile : runfiles.getArtifacts().toList()) {
       if (runfile.isSourceArtifact()) {
         continue;
       }
       addOutputToDownload(runfile);
     }
     for (var symlink : runfiles.getSymlinks().toList()) {
       var artifact = symlink.getArtifact();
       if (artifact.isSourceArtifact()) {
         continue;
       }
       addOutputToDownload(artifact);
     }
     for (var symlink : runfiles.getRootSymlinks().toList()) {
       var artifact = symlink.getArtifact();
       if (artifact.isSourceArtifact()) {
         continue;
       }
       addOutputToDownload(artifact);
     }
   }

   private void addExtraActionArtifacts(ProviderCollection target) {
     ExtraActionArtifactsProvider extraActionArtifactsProvider =
         target.getProvider(ExtraActionArtifactsProvider.class);
     if (extraActionArtifactsProvider != null) {
       addOutputsToDownload(extraActionArtifactsProvider.getExtraActionArtifacts().toList());
     }
   }

   private void addTargetUnderTest(ProviderCollection target) {
     TestProvider testProvider = checkNotNull(target.getProvider(TestProvider.class));
     if (outputsMode != RemoteOutputsMode.MINIMAL
         && (commandMode == CommandMode.TEST || commandMode == CommandMode.COVERAGE)) {
       // In test or coverage mode, download the outputs of the test runner action.
       addOutputsToDownload(testProvider.getTestParams().getOutputs());
     }
     if (commandMode == CommandMode.COVERAGE) {
       // In coverage mode, download the per-test and aggregated coverage files.
       // Do this even for MINIMAL, since coverage (unlike test) doesn't produce any observable
       // results other than outputs.
       addOutputsToDownload(testProvider.getTestParams().getCoverageArtifacts());
     }
   }

   private void maybeAddCoverageArtifacts(ImmutableSet<Artifact> artifactsToBuild) {
     if (commandMode != CommandMode.COVERAGE) {
       return;
     }
     for (Artifact artifactToBuild : artifactsToBuild) {
       if (artifactToBuild.getArtifactOwner().equals(COVERAGE_REPORT_KEY)) {
         addOutputToDownload(artifactToBuild);
       }
     }
   }

   private void addOutputsToDownload(Iterable<? extends ActionInput> files) {
     for (ActionInput file : files) {
       addOutputToDownload(file);
     }
   }

   public void addOutputToDownload(ActionInput file) {
     pathsToDownload.add(file);
   }

   private boolean shouldAddTopLevelTarget(@Nullable ConfiguredTarget configuredTarget) {
     return switch (commandMode) {
       // Always download outputs of toplevel targets in run mode.
       case RUN -> true;
       case COVERAGE, TEST -> {
         // Do not download test binary in test/coverage mode.
         if (configuredTarget instanceof RuleConfiguredTarget ruleConfiguredTarget) {
           var isTestRule = isTestRuleName(ruleConfiguredTarget.getRuleClassString());
           yield !isTestRule && outputsMode != RemoteOutputsMode.MINIMAL;
         }
         yield outputsMode != RemoteOutputsMode.MINIMAL;
       }
       default -> outputsMode != RemoteOutputsMode.MINIMAL;
     };
   }

   private boolean matchesPattern(PathFragment execPath) {
     for (var pattern : patternsToDownload) {
       if (pattern.test(execPath.toString())) {
         return true;
       }
     }
     return false;
   }

   /** Returns whether this {@link ActionInput} should be downloaded. */
   @Override
   public boolean shouldDownloadOutput(ActionInput output, FileArtifactValue metadata) {
     checkState(
         !(output instanceof Artifact artifact && artifact.isTreeArtifact()),
         "shouldDownloadOutput should not be called on a tree artifact");
     return metadata.isRemote()
         && shouldDownloadOutput(
             output.getExecPath(),
             output instanceof TreeFileArtifact artifact
                 ? artifact.getParent().getExecPath()
                 : null);
   }

   /**
    * Returns whether a remote {@link ActionInput} with the given path should be downloaded.
    *
    * @param treeRootExecPath the path of the tree artifact if the given {@link ActionInput} is
    *     contained in one
    */
   public boolean shouldDownloadOutput(
       PathFragment execPath, @Nullable PathFragment treeRootExecPath) {
     return outputsMode == RemoteOutputsMode.ALL
         || pathsToDownload.contains(execPath)
         || matchesPattern(execPath)
         || (treeRootExecPath != null && matchesPattern(treeRootExecPath));
   }

   @Override
   public boolean shouldTrustMetadata(ActionInput file, FileArtifactValue metadata) {
     // Local metadata is always trusted.
     if (!metadata.isRemote()) {
       return true;
     }

     // If Bazel should download this file, but it does not exist locally, returns false to rerun
     // the generating action to trigger the download (just like in the normal build, when local
     // outputs are missing).

     if (lastRemoteOutputChecker != null) {
       // This is an incremental build. If the file was downloaded by previous build and is now
       // missing, invalidate the action.
       if (lastRemoteOutputChecker.shouldDownloadOutput(file, metadata)) {
         return false;
       }
     }

     if (shouldDownloadOutput(file, metadata)) {
       return false;
     }

     if (clock != null) {
       return isAlive(metadata);
     }

     // The remote metadata may have passed its TTL, but we are requested to optimistically assume
     // that it's still available remotely. If it isn't, build or action rewinding will take care
     // of rerunning the actions needed to produce the file and also evict the stale metadata. This
     // incurs roughly the same performance hit, but only when actually needed.
     return true;
   }

   private boolean isAlive(FileArtifactValue metadata) {
     var expirationTime = metadata.getExpirationTime();
     return expirationTime == null || expirationTime.isAfter(clock.now());
   }

   public void maybeInvalidateSkyframeValues(MemoizingEvaluator memoizingEvaluator) {
     if (lastRemoteOutputChecker == null) {
       return;
     }

     // If the outputsMode or commandMode is changed, we invalidate completion functions. Otherwise,
     // some requested outputs might not be correctly downloaded.
     if (lastRemoteOutputChecker.outputsMode != outputsMode
         || lastRemoteOutputChecker.commandMode != commandMode) {
       memoizingEvaluator.delete(
           k -> {
             var functionName = k.functionName();
             return functionName.equals(SkyFunctions.TARGET_COMPLETION)
                 || functionName.equals(SkyFunctions.ASPECT_COMPLETION);
           });
     }
   }

   /**
    * A specialized concurrent trie that stores paths of artifacts and allows checking whether a
    * given path is contained in (in the case of a tree artifact) or exactly matches (in any other
    * case) an artifact in the trie.
    */
   private static final class ConcurrentArtifactPathTrie {
     // Invariant: no path in this set is a prefix of another path.
     private final ConcurrentSkipListSet<PathFragment> paths =
         new ConcurrentSkipListSet<>(PathFragment.HIERARCHICAL_COMPARATOR);

     /**
      * Adds the given {@link ActionInput} to the trie.
      *
      * <p>The caller must ensure that no object's path passed to this method is a prefix of any
      * previously added object's path. Bazel enforces this for non-aggregate artifacts. Callers must
      * not pass in {@link TreeFileArtifact}s (which have exec paths that have their parent tree
      * artifact's exec path as a prefix) or non-Artifact {@link ActionInput}s that violate this
      * invariant.
      */
     void add(ActionInput input) {
       checkArgument(
           !(input instanceof TreeFileArtifact),
           "TreeFileArtifacts should not be added to the trie: %s",
           input);
       paths.add(input.getExecPath());
     }

     /** Checks whether the given {@link PathFragment} is contained in an artifact in the trie. */
     boolean contains(PathFragment execPath) {
       // By the invariant of this set, there is at most one prefix of execPath in the set. Since the
       // comparator sorts all children of a path right after the path itself, if such a prefix
       // exists, it must thus sort right before execPath (or be equal to it).
       var floorPath = paths.floor(execPath);
       return floorPath != null && execPath.startsWith(floorPath);
     }
   }
 }
	// Copyright 2023 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.remote;

	import static com.google.common.base.Preconditions.checkArgument;
	import static com.google.common.base.Preconditions.checkNotNull;
	import static com.google.common.base.Preconditions.checkState;
	import static com.google.devtools.build.lib.packages.TargetUtils.isTestRuleName;
	import static com.google.devtools.build.lib.skyframe.CoverageReportValue.COVERAGE_REPORT_KEY;

	import com.google.common.collect.ImmutableList;
	import com.google.common.collect.ImmutableSet;
	import com.google.devtools.build.lib.actions.ActionInput;
	import com.google.devtools.build.lib.actions.Artifact;
	import com.google.devtools.build.lib.actions.Artifact.TreeFileArtifact;
	import com.google.devtools.build.lib.actions.FileArtifactValue;
	import com.google.devtools.build.lib.actions.OutputChecker;
	import com.google.devtools.build.lib.analysis.AnalysisResult;
	import com.google.devtools.build.lib.analysis.ConfiguredAspect;
	import com.google.devtools.build.lib.analysis.ConfiguredTarget;
	import com.google.devtools.build.lib.analysis.ExtraActionArtifactsProvider;
	import com.google.devtools.build.lib.analysis.FilesToRunProvider;
	import com.google.devtools.build.lib.analysis.OutputGroupInfo;
	import com.google.devtools.build.lib.analysis.ProviderCollection;
	import com.google.devtools.build.lib.analysis.TopLevelArtifactContext;
	import com.google.devtools.build.lib.analysis.TopLevelArtifactHelper;
	import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTarget;
	import com.google.devtools.build.lib.analysis.test.TestProvider;
	import com.google.devtools.build.lib.clock.Clock;
	import com.google.devtools.build.lib.remote.options.RemoteOutputsMode;
	import com.google.devtools.build.lib.skyframe.SkyFunctions;
	import com.google.devtools.build.lib.vfs.PathFragment;
	import com.google.devtools.build.skyframe.MemoizingEvaluator;
	import java.util.concurrent.ConcurrentSkipListSet;
	import java.util.function.Predicate;
	import java.util.function.Supplier;
	import javax.annotation.Nullable;

	/**
	* An {@link OutputChecker} that checks the TTL of remote metadata and decides which outputs to
	* download.
	*/
	public class RemoteOutputChecker implements OutputChecker {
	private enum CommandMode {
	UNKNOWN,
	BUILD,
	TEST,
	RUN,
	COVERAGE;
	}

	private final CommandMode commandMode;
	private final RemoteOutputsMode outputsMode;
	private final ImmutableList<Predicate<String>> patternsToDownload;
	@Nullable private final RemoteOutputChecker lastRemoteOutputChecker;

	@Nullable private Clock clock;

	private final ConcurrentArtifactPathTrie pathsToDownload = new ConcurrentArtifactPathTrie();

	public RemoteOutputChecker(
	String commandName,
	RemoteOutputsMode outputsMode,
	ImmutableList<Predicate<String>> patternsToDownload) {
	this(commandName, outputsMode, patternsToDownload, /* lastRemoteOutputChecker= */ null);
	}

	public RemoteOutputChecker(
	String commandName,
	RemoteOutputsMode outputsMode,
	ImmutableList<Predicate<String>> patternsToDownload,
	RemoteOutputChecker lastRemoteOutputChecker) {
	this.commandMode =
	switch (commandName) {
	case "build" -> CommandMode.BUILD;
	case "test" -> CommandMode.TEST;
	case "run" -> CommandMode.RUN;
	case "coverage" -> CommandMode.COVERAGE;
	default -> CommandMode.UNKNOWN;
	};
	this.outputsMode = outputsMode;
	this.patternsToDownload = patternsToDownload;
	this.lastRemoteOutputChecker = lastRemoteOutputChecker;
	}

	/** Sets this checker to check the TTL of remote metadata when deciding whether to trust it. */
	public void setCheckMetadataTtl(Clock clock) {
	this.clock = clock;
	}

	// Skymeld-only.
	public void afterTopLevelTargetAnalysis(
	ConfiguredTarget configuredTarget,
	Supplier<TopLevelArtifactContext> topLevelArtifactContextSupplier) {
	if (outputsMode == RemoteOutputsMode.ALL) {
	// For ALL, there's no need to keep track of toplevel targets - we download everything.
	return;
	}
	addTopLevelTarget(configuredTarget, configuredTarget, topLevelArtifactContextSupplier);
	}

	// Skymeld-only.
	public void afterTestAnalyzedEvent(ConfiguredTarget configuredTarget) {
	if (outputsMode == RemoteOutputsMode.ALL) {
	// For ALL, there's no need to keep track of toplevel targets - we download everything.
	return;
	}
	addTargetUnderTest(configuredTarget);
	}

	// Skymeld-only.
	public void afterAspectAnalysis(
	ConfiguredAspect configuredAspect,
	Supplier<TopLevelArtifactContext> topLevelArtifactContextSupplier) {
	if (outputsMode == RemoteOutputsMode.ALL) {
	// For ALL, there's no need to keep track of toplevel targets - we download everything.
	return;
	}
	addTopLevelTarget(
	configuredAspect, /* configuredTarget= */ null, topLevelArtifactContextSupplier);
	}

	// Skymeld-only.
	public void coverageArtifactsKnown(ImmutableSet<Artifact> coverageArtifacts) {
	if (outputsMode == RemoteOutputsMode.ALL) {
	// For ALL, there's no need to keep track of toplevel targets - we download everything.
	return;
	}
	maybeAddCoverageArtifacts(coverageArtifacts);
	}

	// Non-Skymeld only.
	public void afterAnalysis(AnalysisResult analysisResult) {
	if (outputsMode == RemoteOutputsMode.ALL) {
	// For ALL, there's no need to keep track of toplevel targets - we download everything.
	return;
	}
	for (var target : analysisResult.getTargetsToBuild()) {
	addTopLevelTarget(target, target, analysisResult::getTopLevelContext);
	}
	for (var aspect : analysisResult.getAspectsMap().values()) {
	addTopLevelTarget(aspect, /* configuredTarget= */ null, analysisResult::getTopLevelContext);
	}
	var targetsToTest = analysisResult.getTargetsToTest();
	if (targetsToTest != null) {
	for (var target : targetsToTest) {
	addTargetUnderTest(target);
	}
	maybeAddCoverageArtifacts(analysisResult.getArtifactsToBuild());
	}
	}

	private void addTopLevelTarget(
	ProviderCollection target,
	@Nullable ConfiguredTarget configuredTarget,
	Supplier<TopLevelArtifactContext> topLevelArtifactContextSupplier) {
	if (shouldAddTopLevelTarget(configuredTarget)) {
	var topLevelArtifactContext = topLevelArtifactContextSupplier.get();
	var artifactsToBuild =
	TopLevelArtifactHelper.getAllArtifactsToBuild(target, topLevelArtifactContext)
	.getImportantArtifacts();
	addOutputsToDownload(artifactsToBuild.toList());
	// RunfileTrees are requested with this special output group. We lack access to an
	// InputMetadataProvider that can expand arbitrary RunfileTrees, so we have to mirror that
	// logic here.
	if (topLevelArtifactContext.outputGroups().contains(OutputGroupInfo.HIDDEN_TOP_LEVEL)) {
	addRunfiles(target);
	}
	addExtraActionArtifacts(target);
	}
	}

	private void addRunfiles(ProviderCollection buildTarget) {
	var runfilesProvider = buildTarget.getProvider(FilesToRunProvider.class);
	if (runfilesProvider == null) {
	return;
	}
	var runfilesSupport = runfilesProvider.getRunfilesSupport();
	if (runfilesSupport == null) {
	return;
	}
	var runfiles = runfilesSupport.getRunfiles();
	for (Artifact runfile : runfiles.getArtifacts().toList()) {
	if (runfile.isSourceArtifact()) {
	continue;
	}
	addOutputToDownload(runfile);
	}
	for (var symlink : runfiles.getSymlinks().toList()) {
	var artifact = symlink.getArtifact();
	if (artifact.isSourceArtifact()) {
	continue;
	}
	addOutputToDownload(artifact);
	}
	for (var symlink : runfiles.getRootSymlinks().toList()) {
	var artifact = symlink.getArtifact();
	if (artifact.isSourceArtifact()) {
	continue;
	}
	addOutputToDownload(artifact);
	}
	}

	private void addExtraActionArtifacts(ProviderCollection target) {
	ExtraActionArtifactsProvider extraActionArtifactsProvider =
	target.getProvider(ExtraActionArtifactsProvider.class);
	if (extraActionArtifactsProvider != null) {
	addOutputsToDownload(extraActionArtifactsProvider.getExtraActionArtifacts().toList());
	}
	}

	private void addTargetUnderTest(ProviderCollection target) {
	TestProvider testProvider = checkNotNull(target.getProvider(TestProvider.class));
	if (outputsMode != RemoteOutputsMode.MINIMAL
	&& (commandMode == CommandMode.TEST \|\| commandMode == CommandMode.COVERAGE)) {
	// In test or coverage mode, download the outputs of the test runner action.
	addOutputsToDownload(testProvider.getTestParams().getOutputs());
	}
	if (commandMode == CommandMode.COVERAGE) {
	// In coverage mode, download the per-test and aggregated coverage files.
	// Do this even for MINIMAL, since coverage (unlike test) doesn't produce any observable
	// results other than outputs.
	addOutputsToDownload(testProvider.getTestParams().getCoverageArtifacts());
	}
	}

	private void maybeAddCoverageArtifacts(ImmutableSet<Artifact> artifactsToBuild) {
	if (commandMode != CommandMode.COVERAGE) {
	return;
	}
	for (Artifact artifactToBuild : artifactsToBuild) {
	if (artifactToBuild.getArtifactOwner().equals(COVERAGE_REPORT_KEY)) {
	addOutputToDownload(artifactToBuild);
	}
	}
	}

	private void addOutputsToDownload(Iterable<? extends ActionInput> files) {
	for (ActionInput file : files) {
	addOutputToDownload(file);
	}
	}

	public void addOutputToDownload(ActionInput file) {
	pathsToDownload.add(file);
	}

	private boolean shouldAddTopLevelTarget(@Nullable ConfiguredTarget configuredTarget) {
	return switch (commandMode) {
	// Always download outputs of toplevel targets in run mode.
	case RUN -> true;
	case COVERAGE, TEST -> {
	// Do not download test binary in test/coverage mode.
	if (configuredTarget instanceof RuleConfiguredTarget ruleConfiguredTarget) {
	var isTestRule = isTestRuleName(ruleConfiguredTarget.getRuleClassString());
	yield !isTestRule && outputsMode != RemoteOutputsMode.MINIMAL;
	}
	yield outputsMode != RemoteOutputsMode.MINIMAL;
	}
	default -> outputsMode != RemoteOutputsMode.MINIMAL;
	};
	}

	private boolean matchesPattern(PathFragment execPath) {
	for (var pattern : patternsToDownload) {
	if (pattern.test(execPath.toString())) {
	return true;
	}
	}
	return false;
	}

	/** Returns whether this {@link ActionInput} should be downloaded. */
	@Override
	public boolean shouldDownloadOutput(ActionInput output, FileArtifactValue metadata) {
	checkState(
	!(output instanceof Artifact artifact && artifact.isTreeArtifact()),
	"shouldDownloadOutput should not be called on a tree artifact");
	return metadata.isRemote()
	&& shouldDownloadOutput(
	output.getExecPath(),
	output instanceof TreeFileArtifact artifact
	? artifact.getParent().getExecPath()
	: null);
	}

	/**
	* Returns whether a remote {@link ActionInput} with the given path should be downloaded.
	*
	* @param treeRootExecPath the path of the tree artifact if the given {@link ActionInput} is
	* contained in one
	*/
	public boolean shouldDownloadOutput(
	PathFragment execPath, @Nullable PathFragment treeRootExecPath) {
	return outputsMode == RemoteOutputsMode.ALL
	\|\| pathsToDownload.contains(execPath)
	\|\| matchesPattern(execPath)
	\|\| (treeRootExecPath != null && matchesPattern(treeRootExecPath));
	}

	@Override
	public boolean shouldTrustMetadata(ActionInput file, FileArtifactValue metadata) {
	// Local metadata is always trusted.
	if (!metadata.isRemote()) {
	return true;
	}

	// If Bazel should download this file, but it does not exist locally, returns false to rerun
	// the generating action to trigger the download (just like in the normal build, when local
	// outputs are missing).

	if (lastRemoteOutputChecker != null) {
	// This is an incremental build. If the file was downloaded by previous build and is now
	// missing, invalidate the action.
	if (lastRemoteOutputChecker.shouldDownloadOutput(file, metadata)) {
	return false;
	}
	}

	if (shouldDownloadOutput(file, metadata)) {
	return false;
	}

	if (clock != null) {
	return isAlive(metadata);
	}

	// The remote metadata may have passed its TTL, but we are requested to optimistically assume
	// that it's still available remotely. If it isn't, build or action rewinding will take care
	// of rerunning the actions needed to produce the file and also evict the stale metadata. This
	// incurs roughly the same performance hit, but only when actually needed.
	return true;
	}

	private boolean isAlive(FileArtifactValue metadata) {
	var expirationTime = metadata.getExpirationTime();
	return expirationTime == null \|\| expirationTime.isAfter(clock.now());
	}

	public void maybeInvalidateSkyframeValues(MemoizingEvaluator memoizingEvaluator) {
	if (lastRemoteOutputChecker == null) {
	return;
	}

	// If the outputsMode or commandMode is changed, we invalidate completion functions. Otherwise,
	// some requested outputs might not be correctly downloaded.
	if (lastRemoteOutputChecker.outputsMode != outputsMode
	\|\| lastRemoteOutputChecker.commandMode != commandMode) {
	memoizingEvaluator.delete(
	k -> {
	var functionName = k.functionName();
	return functionName.equals(SkyFunctions.TARGET_COMPLETION)
	\|\| functionName.equals(SkyFunctions.ASPECT_COMPLETION);
	});
	}
	}

	/**
	* A specialized concurrent trie that stores paths of artifacts and allows checking whether a
	* given path is contained in (in the case of a tree artifact) or exactly matches (in any other
	* case) an artifact in the trie.
	*/
	private static final class ConcurrentArtifactPathTrie {
	// Invariant: no path in this set is a prefix of another path.
	private final ConcurrentSkipListSet<PathFragment> paths =
	new ConcurrentSkipListSet<>(PathFragment.HIERARCHICAL_COMPARATOR);

	/**
	* Adds the given {@link ActionInput} to the trie.
	*
	* <p>The caller must ensure that no object's path passed to this method is a prefix of any
	* previously added object's path. Bazel enforces this for non-aggregate artifacts. Callers must
	* not pass in {@link TreeFileArtifact}s (which have exec paths that have their parent tree
	* artifact's exec path as a prefix) or non-Artifact {@link ActionInput}s that violate this
	* invariant.
	*/
	void add(ActionInput input) {
	checkArgument(
	!(input instanceof TreeFileArtifact),
	"TreeFileArtifacts should not be added to the trie: %s",
	input);
	paths.add(input.getExecPath());
	}

	/** Checks whether the given {@link PathFragment} is contained in an artifact in the trie. */
	boolean contains(PathFragment execPath) {
	// By the invariant of this set, there is at most one prefix of execPath in the set. Since the
	// comparator sorts all children of a path right after the path itself, if such a prefix
	// exists, it must thus sort right before execPath (or be equal to it).
	var floorPath = paths.floor(execPath);
	return floorPath != null && execPath.startsWith(floorPath);
	}
	}
	}