Switch to ProcessHandle for getting the PID (bazelbuild#14842)

* RELNOTES: Refactor system suspend event handling.

We are looking to add more build anomaly reporting, so refactor the current system suspend handling to match the new model where we have a module and an event that we can record.

Note this deprecates the AnomalyRecord out of BES for the time being.

PiperOrigin-RevId: 409502784

* Switch to `ProcessHandle` for getting the pid.

Uses new Java API instead of a native method.

PiperOrigin-RevId: 409973910

* fix test

Co-authored-by: dmaclach <[email protected]>
Co-authored-by: jhorvitz <[email protected]>

Author: 3 people

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

@@ -290,7 +290,6 @@ java_library(
         "//src/main/java/com/google/devtools/build/lib/packages",
         "//src/main/java/com/google/devtools/build/lib/packages/semantics",
         "//src/main/java/com/google/devtools/build/lib/pkgcache",
-        "//src/main/java/com/google/devtools/build/lib/platform:suspend_counter",
         "//src/main/java/com/google/devtools/build/lib/profiler",
         "//src/main/java/com/google/devtools/build/lib/profiler:google-auto-profiler-utils",
         "//src/main/java/com/google/devtools/build/lib/profiler/memory:allocationtracker",

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

@@ -874,7 +874,6 @@ java_library(
         ":blaze_version_info",
         "//src/main/java/com/google/devtools/build/lib/buildeventstream",
         "//src/main/java/com/google/devtools/build/lib/buildeventstream/proto:build_event_stream_java_proto",
-        "//src/main/java/com/google/devtools/build/lib/util:process",
         "//third_party:guava",
     ],
 )

src/main/java/com/google/devtools/build/lib/analysis/NoBuildEvent.java

@@ -22,8 +22,6 @@
 import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.BuildEventId;
 import com.google.devtools.build.lib.buildeventstream.GenericBuildEvent;
 import com.google.devtools.build.lib.buildeventstream.ProgressEvent;
-import com.google.devtools.build.lib.util.ProcessUtils;
-import java.util.Collection;
 
 /** This event raised to indicate that no build will be happening for the given command. */
 public final class NoBuildEvent implements BuildEvent {
@@ -55,7 +53,7 @@ public NoBuildEvent() {
   }
 
   @Override
-  public Collection<BuildEventId> getChildrenEvents() {
+  public ImmutableList<BuildEventId> getChildrenEvents() {
     if (separateFinishedEvent) {
       return ImmutableList.of(
           ProgressEvent.INITIAL_PROGRESS_UPDATE, BuildEventIdUtil.buildFinished());
@@ -83,7 +81,7 @@ public BuildEventStreamProtos.BuildEvent asStreamProto(BuildEventContext convert
     if (id != null) {
       started.setUuid(id);
     }
-    started.setServerPid(ProcessUtils.getpid());
+    started.setServerPid(ProcessHandle.current().pid());
     return GenericBuildEvent.protoChaining(this).setStarted(started.build()).build();
   }
 

src/main/java/com/google/devtools/build/lib/analysis/NoBuildRequestFinishedEvent.java

@@ -20,6 +20,6 @@
 /** {@link BuildEvent} indicating that a request that does not involve building as finished. */
 public final class NoBuildRequestFinishedEvent extends BuildCompletingEvent {
   public NoBuildRequestFinishedEvent(ExitCode exitCode, long finishTimeMillis) {
-    super(exitCode, finishTimeMillis, false);
+    super(exitCode, finishTimeMillis);
   }
 }

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

@@ -145,6 +145,7 @@ java_library(
         "//src/main/java/com/google/devtools/build/lib/outputfilter",
         "//src/main/java/com/google/devtools/build/lib/packages/metrics",
         "//src/main/java/com/google/devtools/build/lib/platform:sleep_prevention_module",
+        "//src/main/java/com/google/devtools/build/lib/platform:system_suspension_module",
         "//src/main/java/com/google/devtools/build/lib/profiler/callcounts:callcounts_module",
         "//src/main/java/com/google/devtools/build/lib/profiler/memory:allocationtracker_module",
         "//src/main/java/com/google/devtools/build/lib/remote",

src/main/java/com/google/devtools/build/lib/bazel/Bazel.java

@@ -44,6 +44,7 @@ public final class Bazel {
           com.google.devtools.build.lib.runtime.NoSpawnCacheModule.class,
           com.google.devtools.build.lib.runtime.CommandLogModule.class,
           com.google.devtools.build.lib.platform.SleepPreventionModule.class,
+          com.google.devtools.build.lib.platform.SystemSuspensionModule.class,
           com.google.devtools.build.lib.runtime.BazelFileSystemModule.class,
           com.google.devtools.build.lib.runtime.mobileinstall.MobileInstallModule.class,
           com.google.devtools.build.lib.bazel.BazelWorkspaceStatusModule.class,

src/main/java/com/google/devtools/build/lib/buildeventstream/BuildCompletingEvent.java

@@ -30,24 +30,17 @@ public abstract class BuildCompletingEvent implements BuildEvent {
   private final ExitCode exitCode;
   private final long finishTimeMillis;
 
-  /** Was the build suspended mid-build (e.g. hardware sleep, SIGSTOP). */
-  private final boolean wasSuspended;
-
   private final Collection<BuildEventId> children;
 
   public BuildCompletingEvent(
-      ExitCode exitCode,
-      long finishTimeMillis,
-      Collection<BuildEventId> children,
-      boolean wasSuspended) {
+      ExitCode exitCode, long finishTimeMillis, Collection<BuildEventId> children) {
     this.exitCode = exitCode;
     this.finishTimeMillis = finishTimeMillis;
     this.children = children;
-    this.wasSuspended = wasSuspended;
   }
 
-  public BuildCompletingEvent(ExitCode exitCode, long finishTimeMillis, boolean wasSuspended) {
-    this(exitCode, finishTimeMillis, ImmutableList.of(), wasSuspended);
+  public BuildCompletingEvent(ExitCode exitCode, long finishTimeMillis) {
+    this(exitCode, finishTimeMillis, ImmutableList.of());
   }
 
   public ExitCode getExitCode() {
@@ -72,18 +65,12 @@ public BuildEventStreamProtos.BuildEvent asStreamProto(BuildEventContext convert
             .setCode(exitCode.getNumericExitCode())
             .build();
 
-    BuildEventStreamProtos.BuildFinished.AnomalyReport protoAnamolyReport =
-        BuildEventStreamProtos.BuildFinished.AnomalyReport.newBuilder()
-            .setWasSuspended(wasSuspended)
-            .build();
-
     BuildEventStreamProtos.BuildFinished finished =
         BuildEventStreamProtos.BuildFinished.newBuilder()
             .setOverallSuccess(ExitCode.SUCCESS.equals(exitCode))
             .setExitCode(protoExitCode)
             .setFinishTime(Timestamps.fromMillis(finishTimeMillis))
             .setFinishTimeMillis(finishTimeMillis)
-            .setAnomalyReport(protoAnamolyReport)
             .build();
     return GenericBuildEvent.protoChaining(this).setFinished(finished).build();
   }

src/main/java/com/google/devtools/build/lib/buildeventstream/proto/build_event_stream.proto

@@ -792,6 +792,7 @@ message BuildFinished {
     // Examples of suspensions are SIGSTOP, or the hardware being put to sleep.
     // If was_suspended is true, then most of the timings for this build are
     // suspect.
+    // NOTE: This is no longer set and is deprecated.
     bool was_suspended = 1;
   }
 
@@ -812,7 +813,7 @@ message BuildFinished {
   // End of the build.
   google.protobuf.Timestamp finish_time = 5;
 
-  AnomalyReport anomaly_report = 4;
+  AnomalyReport anomaly_report = 4 [deprecated = true];
 }
 
 message BuildMetrics {

src/main/java/com/google/devtools/build/lib/buildtool/BuildResult.java

@@ -48,8 +48,6 @@ public final class BuildResult {
   private long startTimeMillis = 0; // milliseconds since UNIX epoch.
   private long stopTimeMillis = 0;
 
-  private boolean wasSuspended = false;
-
   private Throwable crash = null;
   private boolean catastrophe = false;
   private boolean stopOnFirstFailure;
@@ -97,16 +95,6 @@ public double getElapsedSeconds() {
     return (stopTimeMillis - startTimeMillis) / 1000.0;
   }
 
-  /** Record if the build was suspended (SIGSTOP or hardware put to sleep). */
-  public void setWasSuspended(boolean wasSuspended) {
-    this.wasSuspended = wasSuspended;
-  }
-
-  /** Whether the build was suspended (SIGSTOP or hardware put to sleep). */
-  public boolean getWasSuspended() {
-    return wasSuspended;
-  }
-
   public void setDetailedExitCode(DetailedExitCode detailedExitCode) {
     this.detailedExitCode = detailedExitCode;
   }

src/main/java/com/google/devtools/build/lib/buildtool/BuildTool.java

@@ -13,8 +13,6 @@
 // limitations under the License.
 package com.google.devtools.build.lib.buildtool;
 
-import static com.google.devtools.build.lib.platform.SuspendCounter.suspendCount;
-
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Throwables;
@@ -438,7 +436,6 @@ public BuildResult processRequest(
       BuildRequest request, TargetValidator validator, PostBuildCallback postBuildCallback) {
     BuildResult result = new BuildResult(request.getStartTime());
     maybeSetStopOnFirstFailure(request, result);
-    int startSuspendCount = suspendCount();
     Throwable crash = null;
     DetailedExitCode detailedExitCode = null;
     try {
@@ -536,7 +533,7 @@ public BuildResult processRequest(
                 new IllegalStateException("Unspecified DetailedExitCode"));
       }
       try (SilentCloseable c = Profiler.instance().profile("stopRequest")) {
-        stopRequest(result, crash, detailedExitCode, startSuspendCount);
+        stopRequest(result, crash, detailedExitCode);
       }
     }
 
@@ -576,16 +573,10 @@ private static boolean needsExecutionPhase(BuildRequestOptions options) {
    * @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}
-   * @param startSuspendCount number of suspensions before the build started
    */
   public void stopRequest(
-      BuildResult result,
-      @Nullable Throwable crash,
-      DetailedExitCode detailedExitCode,
-      int startSuspendCount) {
+      BuildResult result, @Nullable Throwable crash, DetailedExitCode detailedExitCode) {
     Preconditions.checkState((crash == null) || !detailedExitCode.isSuccess());
-    int stopSuspendCount = suspendCount();
-    Preconditions.checkState(startSuspendCount <= stopSuspendCount);
     result.setUnhandledThrowable(crash);
     result.setDetailedExitCode(detailedExitCode);
 
@@ -598,7 +589,6 @@ public void stopRequest(
     }
     // The stop time has to be captured before we send the BuildCompleteEvent.
     result.setStopTime(runtime.getClock().currentTimeMillis());
-    result.setWasSuspended(stopSuspendCount > startSuspendCount);
 
     // Skip the build complete events so that modules can run blazeShutdownOnCrash without thinking
     // that the build completed normally. BlazeCommandDispatcher will call handleCrash.