Add a flag to disable execution log sorting.

YuanHao97 · copybara-github · commit 1a6ffe6d4537 · 2023-02-15T07:06:08.000-08:00
This may improve performance when the execution log gets very large. The default is still to sort, so this is a backwards-compatible change. Closes bazelbuild#17354. Closes bazelbuild#17111. PiperOrigin-RevId: 509822315 Change-Id: If948ec4a933389b6f8405985813dd76c549c445c
diff --git a/src/main/java/com/google/devtools/build/lib/bazel/BUILD b/src/main/java/com/google/devtools/build/lib/bazel/BUILD
@@ -123,6 +123,7 @@ java_library(
         "//src/main/java/com/google/devtools/build/lib/util/io",
         "//src/main/java/com/google/devtools/build/lib/vfs",
         "//src/main/protobuf:failure_details_java_proto",
+        "//src/main/protobuf:spawn_java_proto",
     ],
 )
 
diff --git a/src/main/java/com/google/devtools/build/lib/bazel/SpawnLogModule.java b/src/main/java/com/google/devtools/build/lib/bazel/SpawnLogModule.java
@@ -19,6 +19,7 @@
 import com.google.devtools.build.lib.exec.ExecutionOptions;
 import com.google.devtools.build.lib.exec.ExecutorBuilder;
 import com.google.devtools.build.lib.exec.ModuleActionContextRegistry;
+import com.google.devtools.build.lib.exec.Protos.SpawnExec;
 import com.google.devtools.build.lib.exec.SpawnLogContext;
 import com.google.devtools.build.lib.remote.options.RemoteOptions;
 import com.google.devtools.build.lib.runtime.BlazeModule;
@@ -162,7 +163,14 @@ public void afterCommand() throws AbruptExitException {
         spawnLogContext.close();
         if (!outputStreams.isEmpty()) {
           InputStream in = rawOutput.getInputStream();
-          StableSort.stableSort(in, outputStreams);
+          if (spawnLogContext.shouldSort()) {
+            StableSort.stableSort(in, outputStreams);
+          } else {
+            while (in.available() > 0) {
+              SpawnExec ex = SpawnExec.parseDelimitedFrom(in);
+              outputStreams.write(ex);
+            }
+          }
           outputStreams.close();
         }
         done = true;
diff --git a/src/main/java/com/google/devtools/build/lib/exec/ExecutionOptions.java b/src/main/java/com/google/devtools/build/lib/exec/ExecutionOptions.java
@@ -472,6 +472,17 @@ public boolean usingLocalTestJobs() {
               + " --subcommands (for displaying subcommands in terminal output).")
   public PathFragment executionLogJsonFile;
 
+  @Option(
+      name = "execution_log_sort",
+      defaultValue = "true",
+      documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+      effectTags = {OptionEffectTag.UNKNOWN},
+      help =
+          "Whether to sort the execution log. Set to false to improve memory"
+              + " performance, at the cost of producing the log in nondeterministic"
+              + " order.")
+  public boolean executionLogSort;
+
   @Option(
       name = "experimental_split_xml_generation",
       defaultValue = "true",
diff --git a/src/main/java/com/google/devtools/build/lib/exec/SpawnLogContext.java b/src/main/java/com/google/devtools/build/lib/exec/SpawnLogContext.java
@@ -332,4 +332,8 @@ private Digest computeDigest(
         .setSizeBytes(fileSize)
         .build();
   }
+
+  public boolean shouldSort() {
+    return executionOptions.executionLogSort;
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -123,6 +123,7 @@ java_library(`
`123`	`123`	`"//src/main/java/com/google/devtools/build/lib/util/io",`
`124`	`124`	`"//src/main/java/com/google/devtools/build/lib/vfs",`
`125`	`125`	`"//src/main/protobuf:failure_details_java_proto",`
	`126`	`+ "//src/main/protobuf:spawn_java_proto",`
`126`	`127`	`],`
`127`	`128`	`)`
`128`	`129`
Original file line number	Diff line number	Diff line change
`@@ -332,4 +332,8 @@ private Digest computeDigest(`
`332`	`332`	`.setSizeBytes(fileSize)`
`333`	`333`	`.build();`
`334`	`334`	`}`
	`335`	`+`
	`336`	`+ public boolean shouldSort() {`
	`337`	`+ return executionOptions.executionLogSort;`
	`338`	`+ }`
`335`	`339`	`}`