// Copyright 2014 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.buildtool;

import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static com.google.common.collect.ImmutableList.toImmutableList;
import static com.google.common.collect.ImmutableSet.toImmutableSet;
import static com.google.devtools.build.lib.buildtool.AnalysisPhaseRunner.evaluateProjectFile;
import static com.google.devtools.common.options.OptionsParser.STARLARK_SKIPPED_PREFIXES;
import static java.util.Comparator.comparing;
import static java.util.stream.Collectors.joining;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.base.Splitter;
import com.google.common.base.Stopwatch;
import com.google.common.base.Throwables;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import com.google.common.flogger.GoogleLogger;
import com.google.devtools.build.lib.actions.BuildFailedException;
import com.google.devtools.build.lib.actions.CommandLineExpansionException;
import com.google.devtools.build.lib.actions.TestExecException;
import com.google.devtools.build.lib.analysis.AnalysisAndExecutionResult;
import com.google.devtools.build.lib.analysis.AnalysisResult;
import com.google.devtools.build.lib.analysis.BuildView;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.ViewCreationFailedException;
import com.google.devtools.build.lib.analysis.actions.TemplateExpansionException;
import com.google.devtools.build.lib.analysis.config.BuildOptions;
import com.google.devtools.build.lib.analysis.config.CoreOptions;
import com.google.devtools.build.lib.analysis.config.InvalidConfigurationException;
import com.google.devtools.build.lib.buildeventstream.BuildEvent.LocalFile.LocalFileType;
import com.google.devtools.build.lib.buildeventstream.BuildEventArtifactUploader.UploadContext;
import com.google.devtools.build.lib.buildeventstream.BuildEventIdUtil;
import com.google.devtools.build.lib.buildeventstream.BuildEventProtocolOptions;
import com.google.devtools.build.lib.buildtool.AnalysisPhaseRunner.ProjectEvaluationResult;
import com.google.devtools.build.lib.buildtool.SkyframeMemoryDumper.DisplayMode;
import com.google.devtools.build.lib.buildtool.buildevent.BuildCompleteEvent;
import com.google.devtools.build.lib.buildtool.buildevent.BuildInterruptedEvent;
import com.google.devtools.build.lib.buildtool.buildevent.BuildStartingEvent;
import com.google.devtools.build.lib.buildtool.buildevent.NoExecutionEvent;
import com.google.devtools.build.lib.buildtool.buildevent.ReleaseReplaceableBuildEvent;
import com.google.devtools.build.lib.buildtool.buildevent.StartingAqueryDumpAfterBuildEvent;
import com.google.devtools.build.lib.buildtool.buildevent.UpdateOptionsEvent;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.LabelSyntaxException;
import com.google.devtools.build.lib.cmdline.TargetParsingException;
import com.google.devtools.build.lib.collect.PathFragmentPrefixTrie;
import com.google.devtools.build.lib.collect.PathFragmentPrefixTrie.PathFragmentPrefixTrieException;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.ExtendedEventHandler;
import com.google.devtools.build.lib.events.OutputFilter;
import com.google.devtools.build.lib.events.Reporter;
import com.google.devtools.build.lib.exec.ExecutionOptions;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.pkgcache.LoadingFailedException;
import com.google.devtools.build.lib.pkgcache.LoadingOptions;
import com.google.devtools.build.lib.profiler.MemoryProfiler;
import com.google.devtools.build.lib.profiler.ProfilePhase;
import com.google.devtools.build.lib.profiler.Profiler;
import com.google.devtools.build.lib.profiler.SilentCloseable;
import com.google.devtools.build.lib.query2.aquery.ActionGraphProtoOutputFormatterCallback;
import com.google.devtools.build.lib.runtime.BlazeOptionHandler.SkyframeExecutorTargetLoader;
import com.google.devtools.build.lib.runtime.BlazeRuntime;
import com.google.devtools.build.lib.runtime.CommandEnvironment;
import com.google.devtools.build.lib.runtime.CommandLineEvent;
import com.google.devtools.build.lib.runtime.CommandLineEvent.CanonicalCommandLineEvent;
import com.google.devtools.build.lib.runtime.ExecRootEvent;
import com.google.devtools.build.lib.runtime.KeepStateAfterBuildOption;
import com.google.devtools.build.lib.runtime.StarlarkOptionsParser;
import com.google.devtools.build.lib.runtime.StarlarkOptionsParser.BuildSettingLoader;
import com.google.devtools.build.lib.server.FailureDetails.ActionQuery;
import com.google.devtools.build.lib.server.FailureDetails.BuildConfiguration.Code;
import com.google.devtools.build.lib.server.FailureDetails.FailureDetail;
import com.google.devtools.build.lib.server.FailureDetails.RemoteAnalysisCaching;
import com.google.devtools.build.lib.skyframe.BuildResultListener;
import com.google.devtools.build.lib.skyframe.ProjectValue;
import com.google.devtools.build.lib.skyframe.RepositoryMappingValue.RepositoryMappingResolutionException;
import com.google.devtools.build.lib.skyframe.SequencedSkyframeExecutor;
import com.google.devtools.build.lib.skyframe.SkyframeBuildView.BuildDriverKeyTestContext;
import com.google.devtools.build.lib.skyframe.SkyframeExecutor;
import com.google.devtools.build.lib.skyframe.TargetPatternPhaseValue;
import com.google.devtools.build.lib.skyframe.actiongraph.v2.ActionGraphDump;
import com.google.devtools.build.lib.skyframe.actiongraph.v2.AqueryOutputHandler;
import com.google.devtools.build.lib.skyframe.actiongraph.v2.AqueryOutputHandler.OutputType;
import com.google.devtools.build.lib.skyframe.actiongraph.v2.InvalidAqueryOutputFormatException;
import com.google.devtools.build.lib.skyframe.serialization.FingerprintValueService;
import com.google.devtools.build.lib.skyframe.serialization.FingerprintValueStore;
import com.google.devtools.build.lib.skyframe.serialization.SkycacheMetadataParams;
import com.google.devtools.build.lib.skyframe.serialization.analysis.FrontierSerializer;
import com.google.devtools.build.lib.skyframe.serialization.analysis.RemoteAnalysisCacheClient;
import com.google.devtools.build.lib.skyframe.serialization.analysis.RemoteAnalysisCacheFactory;
import com.google.devtools.build.lib.skyframe.serialization.analysis.RemoteAnalysisCacheReaderDepsProvider;
import com.google.devtools.build.lib.skyframe.serialization.analysis.RemoteAnalysisCachingDependenciesProvider;
import com.google.devtools.build.lib.skyframe.serialization.analysis.RemoteAnalysisMetadataWriter;
import com.google.devtools.build.lib.skyframe.serialization.analysis.SerializationDependenciesProvider;
import com.google.devtools.build.lib.util.AbruptExitException;
import com.google.devtools.build.lib.util.CrashFailureDetails;
import com.google.devtools.build.lib.util.DetailedExitCode;
import com.google.devtools.build.lib.util.ExitCode;
import com.google.devtools.build.lib.util.InterruptedFailureDetails;
import com.google.devtools.build.lib.util.RegexFilter;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.build.skyframe.EvaluationResult;
import com.google.devtools.build.skyframe.SkyFunctionName;
import com.google.devtools.build.skyframe.SkyValue;
import com.google.devtools.common.options.OptionDefinition;
import com.google.devtools.common.options.OptionPriority.PriorityCategory;
import com.google.devtools.common.options.OptionsParser;
import com.google.devtools.common.options.OptionsParsingException;
import com.google.devtools.common.options.OptionsParsingResult;
import com.google.devtools.common.options.RegexPatternOption;
import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintStream;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.atomic.AtomicLong;
import java.util.stream.Stream;
import javax.annotation.Nullable;

/**
 * Provides the bulk of the implementation of the 'blaze build' command.
 *
 * <p>The various concrete build command classes handle the command options and request setup, then
 * delegate the handling of the request (the building of targets) to this class.
 *
 * <p>The main entry point is {@link #buildTargets}.
 *
 * <p>Most of analysis is handled in {@link com.google.devtools.build.lib.analysis.BuildView}, and
 * execution in {@link ExecutionTool}.
 */
public class BuildTool {

  private static final GoogleLogger logger = GoogleLogger.forEnclosingClass();

  private static final String SKYFRAME_MEMORY_DUMP_FILE = "skyframe_memory.json";

  private static final AnalysisPostProcessor NOOP_POST_PROCESSOR =
      (unusedRequest, unusedEnv, unusedRuntime, unusedAnalysisResult) -> {};

  /** Hook for inserting extra post-analysis-phase processing. Used for implementing {a,c}query. */
  public interface AnalysisPostProcessor {
    void process(
        BuildRequest request,
        CommandEnvironment env,
        BlazeRuntime runtime,
        AnalysisResult analysisResult)
        throws InterruptedException, ViewCreationFailedException, ExitException;
  }

  private final CommandEnvironment env;
  private final BlazeRuntime runtime;
  private final AnalysisPostProcessor analysisPostProcessor;

  /**
   * Constructs a BuildTool.
   *
   * @param env a reference to the command environment of the currently executing command
   */
  public BuildTool(CommandEnvironment env) {
    this(env, NOOP_POST_PROCESSOR);
  }

  public BuildTool(CommandEnvironment env, AnalysisPostProcessor postProcessor) {
    this.env = env;
    this.runtime = env.getRuntime();
    this.analysisPostProcessor = postProcessor;
  }

  /**
   * The crux of the build system: builds the targets specified in the request.
   *
   * <p>Performs loading, analysis and execution for the specified set of targets, honoring the
   * configuration options in the BuildRequest. Returns normally iff successful, throws an exception
   * otherwise.
   *
   * <p>Callers must ensure that {@link #stopRequest} is called after this method, even if it
   * throws.
   *
   * <p>The caller is responsible for setting up and syncing the package cache.
   *
   * <p>During this function's execution, the actualTargets and successfulTargets fields of the
   * request object are set.
   *
   * @param request the build request that this build tool is servicing, which specifies various
   *     options; during this method's execution, the actualTargets and successfulTargets fields of
   *     the request object are populated
   * @param result the build result that is the mutable result of this build
   * @param validator target validator
   * @param optionsParser the {@link OptionsParser} that was used to parse the command line options.
   *     Also used to parse the options applied by the project file.
   * @param targetsForProjectResolution if not null, the targets for which to perform project file
   *     resolution. If null (the common behavior), derive the targets from the {@code request}
   *     instead.
   */
  public void buildTargets(
      BuildRequest request,
      BuildResult result,
      TargetValidator validator,
      OptionsParser optionsParser,
      @Nullable List<String> targetsForProjectResolution)
      throws BuildFailedException,
          InterruptedException,
          ViewCreationFailedException,
          TargetParsingException,
          LoadingFailedException,
          AbruptExitException,
          InvalidConfigurationException,
          TestExecException,
          LabelSyntaxException,
          ExitException,
          PostExecutionDumpException,
          RepositoryMappingResolutionException,
          OptionsParsingException {
    try (SilentCloseable c = Profiler.instance().profile("validateOptions")) {
      validateOptions(request);
    }
    BuildOptions buildOptions;
    try (SilentCloseable c = Profiler.instance().profile("createBuildOptions")) {
      buildOptions = runtime.createBuildOptions(request);
    }

    RemoteAnalysisCachingDependenciesProvider analysisCachingDeps = null;
    RemoteAnalysisCacheReaderDepsProvider analysisCacheReaderDeps = null;
    SerializationDependenciesProvider serializationDependenciesProvider = null;
    boolean catastrophe = false;
    try {
      try (SilentCloseable c = Profiler.instance().profile("BuildStartingEvent")) {
        env.getEventBus()
            .post(BuildStartingEvent.create(env.getDirectories(), env.getOutputService(), request));
      }
      logger.atInfo().log("Build identifier: %s", request.getId());

      // Exit if there are any pending exceptions from modules.
      env.throwPendingException();

      initializeOutputFilter(request);

      TargetPatternPhaseValue targetPatternPhaseValue;
      MemoryProfiler.instance().markPhase(ProfilePhase.TARGET_PATTERN_EVAL);
      Profiler.instance().markPhase(ProfilePhase.TARGET_PATTERN_EVAL);
      try (SilentCloseable c = Profiler.instance().profile("evaluateTargetPatterns")) {
        targetPatternPhaseValue =
            evaluateTargetPatterns(
                env.getReporter(),
                env.getSkyframeExecutor(),
                env.getRelativeWorkingDirectory(),
                request.getKeepGoing(),
                request.getTargets(),
                request.getLoadingOptions(),
                request.getLoadingPhaseThreadCount(),
                request.shouldRunTests(),
                validator);
      }

      env.getEventBus().post(new ExecRootEvent(env.getExecRoot()));

      TargetPatternPhaseValue targetPatternsForProjectResolution =
          targetsForProjectResolution == null
              ? targetPatternPhaseValue
              : evaluateTargetPatterns(
                  ExtendedEventHandler
                      .NOOP, // Don't report this because it'll throw off our tracking of the
                  // complete target set.
                  env.getSkyframeExecutor(),
                  env.getRelativeWorkingDirectory(),
                  request.getKeepGoing(),
                  targetsForProjectResolution,
                  request.getLoadingOptions(),
                  request.getLoadingPhaseThreadCount(),
                  request.shouldRunTests(),
                  validator);

      ImmutableSet<OptionDefinition> optionDefinitions =
          optionsParser.getOptionsSortedByCategory().values().stream()
              .flatMap(Collection::stream)
              .collect(toImmutableSet());
      ImmutableSet.Builder<String> allOptionNames = ImmutableSet.builder();
      for (OptionDefinition optionDefinition : optionDefinitions) {
        allOptionNames.add(optionDefinition.getOptionName());
        // --no[flag_name] is a valid flag only if [flag_name] is a boolean flag.
        if (optionDefinition.usesBooleanValueSyntax()) {
          allOptionNames.add("no" + optionDefinition.getOptionName());
        }
      }
      ProjectEvaluationResult projectEvaluationResult =
          evaluateProjectFile(
              request,
              buildOptions,
              allOptionNames.build(),
              request.getUserOptions(),
              targetPatternsForProjectResolution,
              env);

      if (!projectEvaluationResult.buildOptions().isEmpty()) {
        // First parse the native options from the project file.
        optionsParser.parse(
            PriorityCategory.COMMAND_LINE,
            projectEvaluationResult.projectFile().get().toString(),
            projectEvaluationResult.buildOptions().stream()
                .filter(o -> STARLARK_SKIPPED_PREFIXES.stream().noneMatch(o::startsWith))
                .collect(toImmutableList()));
        // Then parse the starlark options from the project file.
        BuildSettingLoader buildSettingLoader = new SkyframeExecutorTargetLoader(env);
        StarlarkOptionsParser starlarkOptionsParser =
            StarlarkOptionsParser.builder()
                .buildSettingLoader(buildSettingLoader)
                .nativeOptionsParser(optionsParser)
                .build();
        Preconditions.checkState(
            starlarkOptionsParser.parseGivenArgs(
                Stream.concat(
                        projectEvaluationResult.buildOptions().stream()
                            .filter(
                                o -> STARLARK_SKIPPED_PREFIXES.stream().anyMatch(o::startsWith)),
                        optionsParser.getSkippedArgs().stream())
                    .collect(toImmutableList())));

        env.getEventBus()
            .post(
                new CanonicalCommandLineEvent(
                    runtime.getProductName(),
                    runtime.getStartupOptionsProvider(),
                    request.getCommandName(),
                    optionsParser.getResidue(),
                    optionsParser
                        .getOptions(BuildEventProtocolOptions.class)
                        .getIncludeResidueInRunBepEvent(),
                    optionsParser.getExplicitCommandLineStarlarkOptions(),
                    optionsParser.getStarlarkOptions(),
                    optionsParser.getStarlarkOptionsAllowingMultiple(),
                    optionsParser.asListOfCanonicalOptions(),
                    // This replaces the tentative CanonicalCommandLineEvent posted earlier in the
                    // build in BlazeCommandDispatcher.
                    /* replaceable= */ false));
        env.getEventBus().post(new UpdateOptionsEvent(optionsParser));
      } else {
        // No PROJECT.scl flag updates. Release the original CanonicalCommandLineEvent for posting.
        env.getEventBus()
            .post(
                new ReleaseReplaceableBuildEvent(
                    BuildEventIdUtil.structuredCommandlineId(
                        CommandLineEvent.CanonicalCommandLineEvent.LABEL)));
      }
      buildOptions = runtime.createBuildOptions(optionsParser);
      if (request.needsInstrumentationFilter()) {
        applyHeuristicInstrumentationFilter(buildOptions, targetPatternPhaseValue);
      }
      var analysisDeps =
          RemoteAnalysisCacheFactory.create(
              env,
              projectEvaluationResult.activeDirectoriesMatcher(),
              targetPatternPhaseValue.getTargetLabels(),
              BuildView.getTopLevelConfigurationTrimmedOfTestOptions(
                  buildOptions, env.getReporter()),
              request.getUserOptions(),
              projectEvaluationResult.buildOptions());
      analysisCachingDeps = analysisDeps.deps();
      analysisCacheReaderDeps = analysisDeps.readerDeps();
      serializationDependenciesProvider = analysisDeps.serializationDeps();

      if (env.withMergedAnalysisAndExecutionSourceOfTruth()) {
        // a.k.a. Skymeld.
        buildTargetsWithMergedAnalysisExecution(
            request,
            result,
            targetPatternPhaseValue,
            buildOptions,
            analysisCachingDeps,
            analysisCacheReaderDeps);
      } else {
        buildTargetsWithoutMergedAnalysisExecution(
            request,
            result,
            targetPatternPhaseValue,
            buildOptions,
            analysisCachingDeps,
            analysisCacheReaderDeps);
      }

      if (analysisCacheReaderDeps.mode().serializesValues()) {
        Preconditions.checkState(!analysisCachingDeps.bailedOut());
        serializeValues(serializationDependenciesProvider);
      }

      if (env.getSkyframeExecutor().getSkyfocusState().enabled()) {
        // Skyfocus only works at the end of a successful build.
        ImmutableSet<Label> topLevelTargets =
            result.getActualTargets().stream()
                .map(ConfiguredTarget::getLabel)
                .collect(toImmutableSet());
        env.getSkyframeExecutor()
            .runSkyfocus(
                topLevelTargets,
                projectEvaluationResult.activeDirectoriesMatcher(),
                env.getReporter(),
                env.getBlazeWorkspace().getPersistentActionCache(),
                env.getOptions());
      }
    } catch (Error | RuntimeException e) {
      // Don't handle the error here. We will do so in stopRequest.
      catastrophe = true;
      throw e;
    } finally {
      if (!catastrophe) {
        // Delete dirty nodes to ensure that they do not accumulate indefinitely.
        long versionWindow = request.getViewOptions().getVersionWindowForDirtyNodeGc();
        if (versionWindow != -1) {
          env.getSkyframeExecutor().deleteOldNodes(versionWindow);
        }
        // The workspace status actions will not run with certain flags, or if an error occurs early
        // in the build. Ensure that build info is posted on every build.
        env.ensureBuildInfoPosted();

        // Log stats and sync state even on failure.
        if (analysisCachingDeps != null) {
          if (analysisCacheReaderDeps.mode().isRetrievalEnabled()
              && (analysisCacheReaderDeps.shouldBailOutOnMissingFingerprint()
                  || analysisCachingDeps.bailedOut())) {
            reportOnlyBailOutReason(analysisCacheReaderDeps);
          } else {
            logAnalysisCachingStats(analysisCacheReaderDeps);
          }
        }
      }
    }
  }

  private static TargetPatternPhaseValue evaluateTargetPatterns(
      ExtendedEventHandler reporter,
      SkyframeExecutor skyframeExecutor,
      PathFragment relativeWorkingDirectory,
      boolean keepGoing,
      List<String> targets,
      LoadingOptions loadingOptions,
      int loadingPhaseThreadCount,
      boolean shouldRunTests,
      final TargetValidator validator)
      throws LoadingFailedException, TargetParsingException, InterruptedException {
    TargetPatternPhaseValue result =
        skyframeExecutor.loadTargetPatternsWithFilters(
            reporter,
            targets,
            relativeWorkingDirectory,
            loadingOptions,
            loadingPhaseThreadCount,
            keepGoing,
            shouldRunTests);
    if (validator != null) {
      ImmutableSet<Target> targetLabels =
          result.getTargets(reporter, skyframeExecutor.getPackageManager());
      validator.validateTargets(targetLabels, keepGoing);
    }
    return result;
  }

  private void applyHeuristicInstrumentationFilter(
      BuildOptions buildOptions, TargetPatternPhaseValue targetPatternPhaseValue)
      throws InterruptedException, InvalidConfigurationException {
    try (SilentCloseable c = Profiler.instance().profile("Compute instrumentation filter")) {
      String instrumentationFilter =
          InstrumentationFilterSupport.computeInstrumentationFilter(
              env.getReporter(),
              // TODO(ulfjack): Expensive. Make this part of the TargetPatternPhaseValue or write
              // a new SkyFunction to compute it?
              targetPatternPhaseValue.getTestsToRun(env.getReporter(), env.getPackageManager()));
      try {
        // We're modifying the buildOptions in place, which is not ideal, but we also don't want
        // to pay the price for making a copy. Maybe reconsider later if this turns out to be a
        // problem (and the performance loss may not be a big deal). Notably, one must not call
        // .checksum() before mutating the BuildOptions instance, lest the checksum and the option
        // values get out of sync.
        buildOptions
            .get(CoreOptions.class)
            .setInstrumentationFilter(
                new RegexFilter.RegexFilterConverter().convert(instrumentationFilter));
      } catch (OptionsParsingException e) {
        throw new InvalidConfigurationException(Code.HEURISTIC_INSTRUMENTATION_FILTER_INVALID, e);
      }
    }
  }

  private void buildTargetsWithoutMergedAnalysisExecution(
      BuildRequest request,
      BuildResult result,
      TargetPatternPhaseValue targetPatternPhaseValue,
      BuildOptions buildOptions,
      RemoteAnalysisCachingDependenciesProvider remoteAnalysisCachingDeps,
      RemoteAnalysisCacheReaderDepsProvider remoteAnalysisCacheReaderDeps)
      throws BuildFailedException,
          ViewCreationFailedException,
          AbruptExitException,
          RepositoryMappingResolutionException,
          InterruptedException,
          InvalidConfigurationException,
          TestExecException,
          ExitException,
          PostExecutionDumpException {
    AnalysisResult analysisResult =
        AnalysisPhaseRunner.execute(
            env,
            request,
            targetPatternPhaseValue,
            buildOptions,
            remoteAnalysisCachingDeps,
            remoteAnalysisCacheReaderDeps);
    ExecutionTool executionTool = null;
    try {
      // We cannot move the executionTool down to the execution phase part since it does set up the
      // symlinks for tools.
      // TODO(twerth): Extract embedded tool setup from execution tool and move object creation to
      // execution phase.
      executionTool = new ExecutionTool(env, request);
      if (request.getBuildOptions().getPerformAnalysisPhase()) {
        if (!analysisResult.getExclusiveTests().isEmpty()
            && executionTool.getTestActionContext().forceExclusiveTestsInParallel()) {
          String testStrategy = request.getOptions(ExecutionOptions.class).getTestStrategy();
          for (ConfiguredTarget test : analysisResult.getExclusiveTests()) {
            getReporter()
                .handle(
                    Event.warn(
                        test.getLabel()
                            + " is tagged exclusive, but --test_strategy="
                            + testStrategy
                            + " forces parallel test execution."));
          }
          analysisResult = analysisResult.withExclusiveTestsAsParallelTests();
        }
        if (!analysisResult.getExclusiveIfLocalTests().isEmpty()
            && executionTool.getTestActionContext().forceExclusiveIfLocalTestsInParallel()) {
          analysisResult = analysisResult.withExclusiveIfLocalTestsAsParallelTests();
        }

        result.setBuildConfiguration(analysisResult.getConfiguration());
        result.setActualTargets(analysisResult.getTargetsToBuild());
        result.setTestTargets(analysisResult.getTargetsToTest());

        try (SilentCloseable c = Profiler.instance().profile("analysisPostProcessor.process")) {
          analysisPostProcessor.process(request, env, runtime, analysisResult);
        }

        if (needsExecutionPhase(request.getBuildOptions())) {
          try (SilentCloseable closeable = Profiler.instance().profile("ExecutionTool.init")) {
            executionTool.init();
          }
          executionTool.executeBuild(
              request.getId(),
              analysisResult,
              result,
              analysisResult.getPackageRoots(),
              request.getTopLevelArtifactContext());
        } else {
          env.getReporter().post(new NoExecutionEvent());
        }
        FailureDetail delayedFailureDetail = analysisResult.getFailureDetail();
        if (delayedFailureDetail != null) {
          throw new BuildFailedException(
              delayedFailureDetail.getMessage(), DetailedExitCode.of(delayedFailureDetail));
        }

        // Only run this post-build step for builds with SequencedSkyframeExecutor. Enabling the
        // aquery dump format feature will disable Skymeld, so it only runs in the non-Skymeld path.
        if ((env.getSkyframeExecutor() instanceof SequencedSkyframeExecutor)
            && request.getBuildOptions().getAqueryDumpAfterBuildFormat() != null) {
          try (SilentCloseable c = Profiler.instance().profile("postExecutionDumpSkyframe")) {
            dumpSkyframeStateAfterBuild(
                request.getOptions(BuildEventProtocolOptions.class),
                request.getBuildOptions().getAqueryDumpAfterBuildFormat(),
                request.getBuildOptions().getAqueryDumpAfterBuildOutputFile());
          } catch (CommandLineExpansionException | IOException | TemplateExpansionException e) {
            throw new PostExecutionDumpException(e);
          } catch (InvalidAqueryOutputFormatException e) {
            throw new PostExecutionDumpException(
                "--skyframe_state must be used with "
                    + "--output=proto|streamed_proto|textproto|jsonproto.",
                e);
          }
        }
      }
    } finally {
      if (executionTool != null) {
        executionTool.shutdown();
      }
    }
  }

  /** Performs the merged analysis and execution phase. */
  private void buildTargetsWithMergedAnalysisExecution(
      BuildRequest request,
      BuildResult result,
      TargetPatternPhaseValue targetPatternPhaseValue,
      BuildOptions buildOptions,
      RemoteAnalysisCachingDependenciesProvider remoteAnalysisCachingDependenciesProvider,
      RemoteAnalysisCacheReaderDepsProvider remoteAnalysisCacheReaderDeps)
      throws InterruptedException,
          AbruptExitException,
          ViewCreationFailedException,
          BuildFailedException,
          TestExecException,
          InvalidConfigurationException,
          RepositoryMappingResolutionException {
    // See https://github.com/bazelbuild/rules_nodejs/issues/3693.
    env.getSkyframeExecutor().clearSyscallCache();

    boolean hasCatastrophe = false;

    ExecutionTool executionTool = new ExecutionTool(env, request);
    // This timer measures time from the first execution activity to the last.
    Stopwatch executionTimer = Stopwatch.createUnstarted();

    // TODO(b/199053098): implement support for --nobuild.
    AnalysisAndExecutionResult analysisAndExecutionResult = null;
    boolean buildCompleted = false;
    try {
      analysisAndExecutionResult =
          AnalysisAndExecutionPhaseRunner.execute(
              env,
              request,
              buildOptions,
              targetPatternPhaseValue,
              () -> executionTool.prepareForExecution(executionTimer),
              result::setBuildConfiguration,
              new BuildDriverKeyTestContext() {
                @Override
                public String getTestStrategy() {
                  return request.getOptions(ExecutionOptions.class).getTestStrategy();
                }

                @Override
                public boolean forceExclusiveTestsInParallel() {
                  return executionTool.getTestActionContext().forceExclusiveTestsInParallel();
                }

                @Override
                public boolean forceExclusiveIfLocalTestsInParallel() {
                  return executionTool
                      .getTestActionContext()
                      .forceExclusiveIfLocalTestsInParallel();
                }
              },
              remoteAnalysisCachingDependenciesProvider,
              remoteAnalysisCacheReaderDeps);
      buildCompleted = true;

      // This value is null when there's no analysis.
      if (analysisAndExecutionResult == null) {
        return;
      }
    } catch (InvalidConfigurationException
        | RepositoryMappingResolutionException
        | ViewCreationFailedException
        | BuildFailedException
        | TestExecException e) {
      // These are non-catastrophic.
      buildCompleted = true;
      throw e;
    } catch (Error | RuntimeException e) {
      // These are catastrophic.
      hasCatastrophe = true;
      throw e;
    } finally {
      if (result.getBuildConfiguration() != null) {
        // We still need to do this even in case of an exception.
        result.setConvenienceSymlinks(
            executionTool.handleConvenienceSymlinks(
                env.getBuildResultListener().getAnalyzedTargets(), result.getBuildConfiguration()));
      }
      executionTool.unconditionalExecutionPhaseFinalizations(
          executionTimer, env.getSkyframeExecutor());

      // For the --noskymeld code path, this is done after the analysis phase.
      BuildResultListener buildResultListener = env.getBuildResultListener();
      result.setActualTargets(buildResultListener.getAnalyzedTargets());
      result.setTestTargets(buildResultListener.getAnalyzedTests());

      if (!hasCatastrophe) {
        executionTool.nonCatastrophicFinalizations(
            result,
            env.getBlazeWorkspace().getPersistentActionCache(),
            /* explanationHandler= */ null,
            buildCompleted);
      }
    }

    // This is the --keep_going code path: Time to throw the delayed exceptions.
    // Keeping legacy behavior: for execution errors, keep the message of the BuildFailedException
    // empty.
    if (analysisAndExecutionResult.getExecutionDetailedExitCode() != null) {
      throw new BuildFailedException(
          null, analysisAndExecutionResult.getExecutionDetailedExitCode());
    }

    FailureDetail delayedFailureDetail = analysisAndExecutionResult.getFailureDetail();
    if (delayedFailureDetail != null) {
      throw new BuildFailedException(
          delayedFailureDetail.getMessage(), DetailedExitCode.of(delayedFailureDetail));
    }
  }

  private void dumpSkyframeMemory(
      BuildResult buildResult, BuildEventProtocolOptions bepOptions, String format)
      throws PostExecutionDumpException, InterruptedException {
    if (!env.getSkyframeExecutor().tracksStateForIncrementality()) {
      throw new PostExecutionDumpException(
          "Skyframe memory dump requested, but incremental state is not tracked", null);
    }

    boolean reportTransient = true;
    boolean reportConfiguration = true;
    boolean reportPrecomputed = true;
    boolean reportWorkspaceStatus = true;

    for (String flag : Splitter.on(",").split(format)) {
      switch (flag) {
        case "json" -> {} // JSON is the only format we support, no need to note it explicitly
        case "notransient" -> reportTransient = false;
        case "noconfig" -> reportConfiguration = false;
        case "noprecomputed" -> reportPrecomputed = false;
        case "noworkspacestatus" -> reportWorkspaceStatus = false;
        default -> throw new PostExecutionDumpException("Unknown flag: '" + flag + "'", null);
      }
    }

    try {
      OutputStream outputStream;
      UploadContext streamingContext = null;

      if (bepOptions.getStreamingLogFileUploads()) {
        streamingContext =
            runtime
                .getBuildEventArtifactUploaderFactoryMap()
                .select(bepOptions.getBuildEventUploadStrategy())
                .create(env)
                .startUpload(LocalFileType.PERFORMANCE_LOG, null);
        outputStream = streamingContext.getOutputStream();
        buildResult
            .getBuildToolLogCollection()
            .addUriFuture(SKYFRAME_MEMORY_DUMP_FILE, streamingContext.uriFuture());
      } else {
        Path localPath = env.getOutputBase().getRelative(SKYFRAME_MEMORY_DUMP_FILE);
        outputStream = localPath.getOutputStream();
        buildResult.getBuildToolLogCollection().addLocalFile(SKYFRAME_MEMORY_DUMP_FILE, localPath);
      }

      try (PrintStream printStream = new PrintStream(outputStream)) {

        SkyframeMemoryDumper dumper =
            new SkyframeMemoryDumper(
                DisplayMode.SUMMARY,
                null,
                runtime.getRuleClassProvider(),
                env.getSkyframeExecutor().getEvaluator().getInMemoryGraph(),
                reportTransient,
                reportConfiguration,
                reportPrecomputed,
                reportWorkspaceStatus);
        dumper.dumpFull(printStream);
      }
    } catch (IOException | SkyframeMemoryDumper.DumpFailedException e) {
      throw new PostExecutionDumpException("cannot write Skyframe dump: " + e.getMessage(), e);
    }
  }

  /**
   * Produces an aquery dump of the state of Skyframe.
   *
   * <p>There are 2 possible output channels: a local file or a remote FS.
   */
  private void dumpSkyframeStateAfterBuild(
      @Nullable BuildEventProtocolOptions besOptions,
      String format,
      @Nullable PathFragment outputFilePathFragment)
      throws CommandLineExpansionException,
          IOException,
          InvalidAqueryOutputFormatException,
          TemplateExpansionException {
    Preconditions.checkState(env.getSkyframeExecutor() instanceof SequencedSkyframeExecutor);

    UploadContext streamingContext = null;
    Path localOutputFilePath = null;
    String outputFileName;

    if (outputFilePathFragment == null) {
      outputFileName = getDefaultOutputFileName(format);
      if (besOptions != null && besOptions.getStreamingLogFileUploads()) {
        streamingContext =
            runtime
                .getBuildEventArtifactUploaderFactoryMap()
                .select(besOptions.getBuildEventUploadStrategy())
                .create(env)
                .startUpload(LocalFileType.PERFORMANCE_LOG, /* inputSupplier= */ null);
      } else {
        localOutputFilePath = env.getOutputBase().getRelative(outputFileName);
      }
    } else {
      localOutputFilePath = env.getOutputBase().getRelative(outputFilePathFragment);
      outputFileName = localOutputFilePath.getBaseName();
    }

    if (localOutputFilePath != null) {
      getReporter().handle(Event.info("Writing aquery dump to " + localOutputFilePath));
      getReporter()
          .post(new StartingAqueryDumpAfterBuildEvent(localOutputFilePath, outputFileName));
    } else {
      getReporter().handle(Event.info("Streaming aquery dump."));
      getReporter().post(new StartingAqueryDumpAfterBuildEvent(streamingContext, outputFileName));
    }

    try (OutputStream outputStream = initOutputStream(streamingContext, localOutputFilePath);
        PrintStream printStream = new PrintStream(outputStream);
        AqueryOutputHandler aqueryOutputHandler =
            ActionGraphProtoOutputFormatterCallback.constructAqueryOutputHandler(
                OutputType.fromString(format), outputStream, printStream)) {
      // These options are fixed for simplicity. We'll add more configurability if the need arises.
      ActionGraphDump actionGraphDump =
          new ActionGraphDump(
              /* includeActionCmdLine= */ false,
              /* includeArtifacts= */ true,
              /* includePrunedInputs= */ true,
              /* actionFilters= */ null,
              /* includeParamFiles= */ false,
              /* includeFileWriteContents= */ false,
              aqueryOutputHandler,
              getReporter());
      AqueryProcessor.dumpActionGraph(env, aqueryOutputHandler, actionGraphDump);
    }
  }

  private static String getDefaultOutputFileName(String format) {
    return switch (format) {
      case "proto" -> "aquery_dump.proto";
      case "streamed_proto" -> "aquery_dump.pb";
      case "textproto" -> "aquery_dump.textproto";
      case "jsonproto" -> "aquery_dump.json";
      default -> throw new IllegalArgumentException("Unsupported format type: " + format);
    };
  }

  private static OutputStream initOutputStream(
      @Nullable UploadContext streamingContext, Path outputFilePath) throws IOException {
    if (streamingContext != null) {
      return new BufferedOutputStream(streamingContext.getOutputStream());
    }
    return new BufferedOutputStream(outputFilePath.getOutputStream());
  }

  private void reportExceptionError(Exception e) {
    if (e.getMessage() != null) {
      getReporter().handle(Event.error(e.getMessage()));
    }
  }

  public BuildResult processRequest(
      BuildRequest request, TargetValidator validator, OptionsParsingResult options) {
    return processRequest(
        request,
        validator,
        /* postBuildCallback= */ null,
        options,
        /* targetsForProjectResolution= */ null);
  }

  /**
   * The crux of the build system. Builds the targets specified in the request using the specified
   * Executor.
   *
   * <p>Performs loading, analysis and execution for the specified set of targets, honoring the
   * configuration options in the BuildRequest. Returns normally iff successful, throws an exception
   * otherwise.
   *
   * <p>The caller is responsible for setting up and syncing the package cache.
   *
   * <p>During this function's execution, the actualTargets and successfulTargets fields of the
   * request object are set.
   *
   * @param request the build request that this build tool is servicing, which specifies various
   *     options; during this method's execution, the actualTargets and successfulTargets fields of
   *     the request object are populated
   * @param validator an optional target validator
   * @param postBuildCallback an optional callback called after the build has been completed
   *     successfully.
   * @param options the options parsing result containing the options parsed so far, excluding those
   *     from flagsets. This will be cast to an {@link OptionsParser} in order to add any options
   *     from flagsets.
   * @return the result as a {@link BuildResult} object
   */
  public BuildResult processRequest(
      BuildRequest request,
      TargetValidator validator,
      PostBuildCallback postBuildCallback,
      OptionsParsingResult options,
      @Nullable List<String> targetsForProjectResolution) {
    BuildResult result = new BuildResult(request.getStartTime());
    maybeSetStopOnFirstFailure(request, result);
    Throwable crash = null;
    DetailedExitCode detailedExitCode = null;
    try {
      try (SilentCloseable c = Profiler.instance().profile("buildTargets")) {
        // This OptionsParsingResult is essentially a wrapper around the OptionsParser in
        // https://github.com/bazelbuild/bazel/blob/master/src/main/java/com/google/devtools/build/lib/runtime/BlazeCommandDispatcher.java#L341. Casting it back to
        // an OptionsParser is safe, and necessary in order to add any options from flagsets.
        buildTargets(
            request, result, validator, (OptionsParser) options, targetsForProjectResolution);
      }
      detailedExitCode = DetailedExitCode.success();
      if (postBuildCallback != null) {
        try (SilentCloseable c = Profiler.instance().profile("postBuildCallback.process")) {
          result.setPostBuildCallbackFailureDetail(
              postBuildCallback.process(result.getSuccessfulTargets()));
        } catch (InterruptedException e) {
          detailedExitCode =
              InterruptedFailureDetails.detailedExitCode("post build callback interrupted");
        }
      }

      if (env.getSkyframeExecutor() instanceof SequencedSkyframeExecutor
          && request.getBuildOptions().getSkyframeMemoryDump() != null) {
        try (SilentCloseable c = Profiler.instance().profile("BuildTool.dumpSkyframeMemory")) {
          dumpSkyframeMemory(
              result,
              request.getOptions(BuildEventProtocolOptions.class),
              request.getBuildOptions().getSkyframeMemoryDump());
        }
      }
    } catch (BuildFailedException e) {
      if (!e.isErrorAlreadyShown()) {
        // The actual error has not already been reported by the Builder.
        // TODO(janakr): This is wrong: --keep_going builds with errors don't have a message in
        //  this BuildFailedException, so any error message that is only reported here will be
        //  missing for --keep_going builds. All error reporting should be done at the site of the
        //  error, if only for clearer behavior.
        reportExceptionError(e);
      }
      if (e.isCatastrophic()) {
        result.setCatastrophe();
      }
      detailedExitCode = e.getDetailedExitCode();
    } catch (InterruptedException e) {
      // We may have been interrupted by an error, or the user's interruption may have raced with
      // an error, so check to see if we should report that error code instead.
      detailedExitCode = env.getRuntime().getCrashExitCode();
      AbruptExitException environmentPendingAbruptExitException = env.getPendingException();
      if (detailedExitCode == null && environmentPendingAbruptExitException != null) {
        detailedExitCode = environmentPendingAbruptExitException.getDetailedExitCode();
        // Report the exception from the environment - the exception we're handling here is just an
        // interruption.
        reportExceptionError(environmentPendingAbruptExitException);
      }
      if (detailedExitCode == null) {
        String message = "build interrupted";
        detailedExitCode = InterruptedFailureDetails.detailedExitCode(message);
        env.getReporter().handle(Event.error(message));
        env.getEventBus().post(new BuildInterruptedEvent());
      } else {
        result.setCatastrophe();
      }
    } catch (TargetParsingException | LoadingFailedException e) {
      detailedExitCode = e.getDetailedExitCode();
      reportExceptionError(e);
    } catch (RepositoryMappingResolutionException e) {
      detailedExitCode = e.getDetailedExitCode();
      reportExceptionError(e);
    } catch (ViewCreationFailedException e) {
      detailedExitCode = DetailedExitCode.of(ExitCode.PARSING_FAILURE, e.getFailureDetail());
      reportExceptionError(e);
    } catch (ExitException e) {
      detailedExitCode = e.getDetailedExitCode();
      reportExceptionError(e);
    } catch (TestExecException e) {
      // ExitCode.SUCCESS means that build was successful. Real return code of program
      // is going to be calculated in TestCommand.doTest().
      detailedExitCode = DetailedExitCode.success();
      reportExceptionError(e);
    } catch (InvalidConfigurationException e) {
      detailedExitCode = e.getDetailedExitCode();
      reportExceptionError(e);
      // TODO(gregce): With "global configurations" we cannot tie a configuration creation failure
      // to a single target and have to halt the entire build. Once configurations are genuinely
      // created as part of the analysis phase they should report their error on the level of the
      // target(s) that triggered them.
      result.setCatastrophe();
    } catch (AbruptExitException e) {
      detailedExitCode = e.getDetailedExitCode();
      reportExceptionError(e);
      result.setCatastrophe();
    } catch (PostExecutionDumpException e) {
      detailedExitCode =
          DetailedExitCode.of(
              FailureDetail.newBuilder()
                  .setMessage(e.getMessage())
                  .setActionQuery(
                      ActionQuery.newBuilder()
                          .setCode(ActionQuery.Code.SKYFRAME_STATE_AFTER_EXECUTION)
                          .build())
                  .build());
      reportExceptionError(e);
    } catch (Throwable throwable) {
      crash = throwable;
      detailedExitCode = CrashFailureDetails.detailedExitCodeForThrowable(crash);
      Throwables.throwIfUnchecked(throwable);
      throw new IllegalStateException(throwable);
    } finally {
      if (detailedExitCode == null) {
        detailedExitCode =
            CrashFailureDetails.detailedExitCodeForThrowable(
                new IllegalStateException("Unspecified DetailedExitCode"));
      }
      try (SilentCloseable c = Profiler.instance().profile("stopRequest")) {
        stopRequest(result, crash, detailedExitCode);
      }
    }

    return result;
  }

  private void reportRemoteAnalysisServiceStats(
      @Nullable FingerprintValueService fingerprintValueService,
      @Nullable RemoteAnalysisCacheClient analysisCacheClient) {
    FingerprintValueStore.Stats fingerprintValueServiceStats =
        fingerprintValueService == null
            ? FingerprintValueStore.EMPTY_STATS
            : fingerprintValueService.getStats();
    RemoteAnalysisCacheClient.Stats remoteAnalysisCacheClientStats =
        analysisCacheClient == null
            ? RemoteAnalysisCacheClient.EMPTY_STATS
            : analysisCacheClient.getStats();
    env.getRemoteAnalysisCachingEventListener()
        .recordServiceStats(fingerprintValueServiceStats, remoteAnalysisCacheClientStats);
  }

  private void reportOnlyBailOutReason(RemoteAnalysisCacheReaderDepsProvider readerDeps)
      throws InterruptedException {
    RemoteAnalysisCacheClient remoteAnalysisCacheClient = readerDeps.getAnalysisCacheClient();
    if (remoteAnalysisCacheClient == null) {
      return;
    }
    env.getRemoteAnalysisCachingEventListener()
        .recordServiceStats(
            /* fvsStats= */ FingerprintValueStore.EMPTY_STATS,
            remoteAnalysisCacheClient.getStats());
  }

  /**
   * Handles post-build analysis caching operations.
   *
   * <ol>
   *   <li>If this is a cache-writing build, then this will serialize and upload the frontier
   *       Skyframe values.
   *   <li>If this is a cache-reading build, then this will report the cache hit stats while
   *       downloading the frontier Skyframe values during analysis.
   * </ol>
   */
  private void logAnalysisCachingStats(RemoteAnalysisCacheReaderDepsProvider dependenciesProvider)
      throws InterruptedException {
    if (!(env.getSkyframeExecutor() instanceof SequencedSkyframeExecutor)) {
      return;
    }

    if (dependenciesProvider.mode().requiresBackendConnectivity()) {
      reportRemoteAnalysisServiceStats(
          dependenciesProvider.getFingerprintValueService(),
          dependenciesProvider.getAnalysisCacheClient());
    }
    if (dependenciesProvider.mode().isRetrievalEnabled()) {
      reportRemoteAnalysisCachingStats();
      env.getSkyframeExecutor()
          .syncRemoteAnalysisCachingState(
              env.getRemoteAnalysisCachingEventListener().getSkyValueVersion(),
              env.getRemoteAnalysisCachingEventListener().getClientId());
    }
  }

  private void tryWriteSkycacheMetadata(
      SerializationDependenciesProvider serializationDependenciesProvider)
      throws InterruptedException {
    String message = "No local crash but the RPC failed in the backend";
    boolean success = false;
    SkycacheMetadataParams skycacheMetadataParams =
        env.getBlazeWorkspace().remoteAnalysisCachingServicesSupplier().getSkycacheMetadataParams();
    if (skycacheMetadataParams == null) {
      return;
    }
    try (SilentCloseable c = Profiler.instance().profile("skycache.metadata.upload")) {
      // This is a blocking call. We cannot finish the build until the metadata has been written
      // and at this point there is nothing else to do in the build that could be done in
      // parallel.
      RemoteAnalysisMetadataWriter metadataWriter =
          serializationDependenciesProvider.getMetadataWriter();
      if (metadataWriter == null) {
        message = "MetadataAnalysisCacheWriterService is unavailable";
      } else {
        success =
            metadataWriter.addTopLevelTargets(
                env.getCommandId().toString(),
                skycacheMetadataParams.getEvaluatingVersion(),
                skycacheMetadataParams.getConfigurationHash(),
                skycacheMetadataParams.getUseFakeStampData(),
                skycacheMetadataParams.getBazelVersion(),
                skycacheMetadataParams.getTargets(),
                skycacheMetadataParams.getConfigFlags());
      }
    } catch (IOException e) {
      // To avoid build failures for a UX-enhancing feature, errors writing build metadata do not
      // cause the build to fail. Instead, we log the error and rely on external monitoring to
      // detect issues with metadata writes.
      message = e.getMessage();
    }
    if (success) {
      env.getReporter().handle(Event.info("Skycache: Successfully wrote metadata to backend"));
    } else {
      env.getReporter()
          .handle(
              Event.warn(
                  "Skycache: Failed to write metadata to backend"
                      + (message != null ? ": " + message : "")));
    }
  }

  private static void maybeSetStopOnFirstFailure(BuildRequest request, BuildResult result) {
    if (shouldStopOnFailure(request)) {
      result.setStopOnFirstFailure(true);
    }
  }

  private static boolean shouldStopOnFailure(BuildRequest request) {
    return !(request.getKeepGoing() && request.getExecutionOptions().getTestKeepGoing());
  }

  /** Initializes the output filter to the value given with {@code --output_filter}. */
  private void initializeOutputFilter(BuildRequest request) {
    RegexPatternOption outputFilterOption = request.getBuildOptions().getOutputFilter();
    if (outputFilterOption != null) {
      getReporter()
          .setOutputFilter(
              OutputFilter.RegexOutputFilter.forPattern(outputFilterOption.regexPattern()));
    }
  }

  private static boolean needsExecutionPhase(BuildRequestOptions options) {
    return options.getPerformAnalysisPhase() && options.getPerformExecutionPhase();
  }

  /**
   * Stops processing the specified request.
   *
   * <p>This logs the build result, cleans up and stops the clock.
   *
   * @param result result to update
   * @param crash any unexpected {@link RuntimeException} or {@link Error}, may be null
   * @param detailedExitCode describes the exit code and an optional detailed failure value to add
   *     to {@code result}
   */
  public void stopRequest(
      BuildResult result, @Nullable Throwable crash, DetailedExitCode detailedExitCode) {
    Preconditions.checkState((crash == null) || !detailedExitCode.isSuccess());
    result.setUnhandledThrowable(crash);
    result.setDetailedExitCode(detailedExitCode);
    if (!detailedExitCode.isSuccess()) {
      logger.atInfo().log(
          "Unsuccessful command ended with FailureDetail: %s", detailedExitCode.getFailureDetail());
    }

    InterruptedException ie = null;

    // The stop time has to be captured before we send the BuildCompleteEvent.
    result.setStopTime(runtime.getClock().currentTimeMillis());

    // Skip the build complete events so that modules can run blazeShutdownOnCrash without thinking
    // that the build completed normally. BlazeCommandDispatcher will call handleCrash.
    if (crash == null) {
      try {
        MemoryProfiler.instance().markPhase(ProfilePhase.FINISH);
        Profiler.instance().markPhase(ProfilePhase.FINISH);
      } catch (InterruptedException e) {
        env.getReporter().handle(Event.error("Build interrupted during command completion"));
        ie = e;
      }

      env.getEventBus()
          .post(
              new BuildCompleteEvent(
                  result,
                  ImmutableList.of(
                      BuildEventIdUtil.buildToolLogs(), BuildEventIdUtil.buildMetrics())));
    }
    // Post the build tool logs event; the corresponding local files may be contributed from
    // modules, and this has to happen after posting the BuildCompleteEvent because that's when
    // modules add their data to the collection.
    env.getEventBus().post(result.getBuildToolLogCollection().freeze().toEvent());
    if (ie != null) {
      if (detailedExitCode.isSuccess()) {
        result.setDetailedExitCode(
            InterruptedFailureDetails.detailedExitCode(
                "Build interrupted during command completion"));
      } else if (!detailedExitCode.getExitCode().equals(ExitCode.INTERRUPTED)) {
        logger.atWarning().withCause(ie).log(
            "Suppressed interrupted exception during stop request because already failing with: %s",
            detailedExitCode);
      }
    }
  }

  /**
   * Validates the options for this BuildRequest.
   *
   * <p>Issues warnings for the use of deprecated options, and warnings or errors for any option
   * settings that conflict.
   */
  @VisibleForTesting
  public void validateOptions(BuildRequest request) {
    for (String issue : request.validateOptions()) {
      getReporter().handle(Event.warn(issue));
    }
  }

  /** Returns the project directories found in a project file. */
  public static PathFragmentPrefixTrie getActiveDirectoriesMatcher(
      Label projectFile, SkyframeExecutor skyframeExecutor, ExtendedEventHandler eventHandler)
      throws InvalidConfigurationException {
    ProjectValue.Key key = new ProjectValue.Key(projectFile);
    EvaluationResult<SkyValue> result =
        skyframeExecutor.evaluateSkyKeys(
            eventHandler, ImmutableList.of(key), /* keepGoing= */ false);

    if (result.hasError()) {
      // InvalidConfigurationException is chosen for convenience, and it's distinguished from
      // the other InvalidConfigurationException cases by Code.INVALID_PROJECT.
      throw new InvalidConfigurationException(
          "unexpected error reading project configuration: " + result.getError(),
          Code.INVALID_PROJECT);
    }

    try {
      return PathFragmentPrefixTrie.of(
          ((ProjectValue) result.get(key)).getDefaultProjectDirectories());
    } catch (PathFragmentPrefixTrieException e) {
      throw new InvalidConfigurationException(
          "Active directories configuration error: " + e.getMessage(), Code.INVALID_PROJECT);
    }
  }

  private Reporter getReporter() {
    return env.getReporter();
  }

  /** Describes a failure that isn't severe enough to halt the command in keep_going mode. */
  // TODO(mschaller): consider promoting this to be a sibling of AbruptExitException.
  public static class ExitException extends Exception {

    private final DetailedExitCode detailedExitCode;

    ExitException(DetailedExitCode detailedExitCode) {
      super(checkNotNull(detailedExitCode.getFailureDetail(), "failure detail").getMessage());
      this.detailedExitCode = detailedExitCode;
    }

    DetailedExitCode getDetailedExitCode() {
      return detailedExitCode;
    }
  }

  private void serializeValues(SerializationDependenciesProvider serializationDependenciesProvider)
      throws InterruptedException, AbruptExitException {
    if (!(env.getSkyframeExecutor() instanceof SequencedSkyframeExecutor)) {
      return;
    }

    checkState(serializationDependenciesProvider.mode().serializesValues());

    if (serializationDependenciesProvider.mode().isAsyncUpload()) {
      try {
        serializationDependenciesProvider.waitForUploadCompletion();
      } catch (ExecutionException e) {
        Throwables.throwIfInstanceOf(e.getCause(), AbruptExitException.class);
        throw new AbruptExitException(
            DetailedExitCode.of(
                FailureDetail.newBuilder()
                    .setMessage("Skycache upload failed: " + e.getCause().getMessage())
                    .setRemoteAnalysisCaching(
                        RemoteAnalysisCaching.newBuilder()
                            .setCode(RemoteAnalysisCaching.Code.UPLOAD_FAILED))
                    .build()));
      }
      return;
    }

    try (SilentCloseable closeable = Profiler.instance().profile("serializeAndUploadFrontier")) {
      Optional<FailureDetail> maybeFailureDetail =
          FrontierSerializer.serializeAndUploadFrontier(
              serializationDependenciesProvider,
              env.getSkyframeExecutor().getEvaluator(),
              env.getVersionGetter(),
              env.getReporter(),
              env.getEventBus(),
              env.getOptions()
                  .getOptions(KeepStateAfterBuildOption.class)
                  .getKeepStateAfterBuild());
      if (maybeFailureDetail.isPresent()) {
        throw new AbruptExitException(DetailedExitCode.of(maybeFailureDetail.get()));
      }
    }

    if (serializationDependenciesProvider.mode().isSyncUpload()) {
      tryWriteSkycacheMetadata(serializationDependenciesProvider);
    }
  }

  private void reportRemoteAnalysisCachingStats() {
    var listener = env.getRemoteAnalysisCachingEventListener();
    var hitsByFunction = listener.getHitsBySkyFunctionName();
    var missesByFunction = listener.getMissesBySkyFunctionName();
    long totalHits = hitsByFunction.values().stream().mapToLong(AtomicLong::get).sum();
    long totalMisses = missesByFunction.values().stream().mapToLong(AtomicLong::get).sum();
    long totalRequests = totalHits + totalMisses;

    checkState(totalRequests >= 0, "totalRequests should be non-negative");
    if (totalRequests == 0) {
      // Don't report stats if there were no requests.
      return;
    }

    // Combine keys from both maps
    Set<SkyFunctionName> allFunctionNames =
        Sets.union(hitsByFunction.keySet(), missesByFunction.keySet());
    // Format the stats per function, sorted alphabetically by function name
    String statsByFunction =
        allFunctionNames.stream()
            .sorted(comparing(SkyFunctionName::getName))
            .map(
                functionName -> {
                  long hits = hitsByFunction.getOrDefault(functionName, new AtomicLong(0)).get();
                  long misses =
                      missesByFunction.getOrDefault(functionName, new AtomicLong(0)).get();
                  long functionTotal = hits + misses;
                  double functionHitRate =
                      functionTotal == 0 ? 0.0 : (double) hits / functionTotal * 100;
                  return String.format(
                      "%s: %d/%d (%.2f%%)",
                      functionName.getName(), hits, functionTotal, functionHitRate);
                })
            .collect(joining(", "));

    FingerprintValueStore.Stats fvsStats = listener.getFingerprintValueStoreStats();
    long bytesReceived = fvsStats.valueBytesReceived();
    long requests = fvsStats.entriesFound() + fvsStats.entriesNotFound();

    RemoteAnalysisCacheClient.Stats raccStats = listener.getRemoteAnalysisCacheStats();
    bytesReceived += raccStats.bytesReceived();
    requests += raccStats.requestsSent();

    // totalRequests is already checked to be non-zero above.
    double overallHitRate = (double) totalHits / totalRequests * 100;
    env.getReporter()
        .handle(
            Event.info(
                String.format(
                    "Skycache stats: %s received in %s requests, %s/%s cache"
                        + " hits (%.2f%%) [Breakdown: %s]",
                    formatBytes(bytesReceived),
                    requests,
                    totalHits,
                    totalRequests,
                    overallHitRate,
                    statsByFunction)));
  }

  /** Formats a number of bytes in a human-readable prefixed format. */
  private static String formatBytes(long bytes) {
    var k = 1024;
    if (bytes < k) {
      return bytes + " B";
    }
    int exponent = (int) (Math.log((double) bytes) / Math.log(k));
    String prefixedUnit = "KMGTPE".charAt(exponent - 1) + "B";
    return String.format("%.2f %s", bytes / Math.pow(k, exponent), prefixedUnit);
  }
}
