From bd006f8964e689ef08a5c98627b66d5e1f0dba0c Mon Sep 17 00:00:00 2001
From: Ahir Reddy <ahirreddy@gmail.com>
Date: Mon, 2 Oct 2023 13:48:33 -0700
Subject: [PATCH] Async tree deletion on first build

---
 .../build/lib/sandbox/SandboxModule.java      | 27 +++++++++++++++++--
 .../build/lib/sandbox/SandboxOptions.java     | 11 ++++++++
 2 files changed, 36 insertions(+), 2 deletions(-)

diff --git a/src/main/java/com/google/devtools/build/lib/sandbox/SandboxModule.java b/src/main/java/com/google/devtools/build/lib/sandbox/SandboxModule.java
index 4fe82a13f62f09..c8b8629c57eca5 100644
--- a/src/main/java/com/google/devtools/build/lib/sandbox/SandboxModule.java
+++ b/src/main/java/com/google/devtools/build/lib/sandbox/SandboxModule.java
@@ -238,8 +238,31 @@ private void setup(CommandEnvironment cmdEnv, SpawnStrategyRegistry.Builder buil
     // previous builds. However, on the very first build of an instance of the server, we must
     // wipe old contents to avoid reusing stale directories.
     if (firstBuild && sandboxBase.exists()) {
-      cmdEnv.getReporter().handle(Event.info("Deleting stale sandbox base " + sandboxBase));
-      sandboxBase.deleteTree();
+      if (options.asyncFirstBuildDelete && (treeDeleter instanceof AsynchronousTreeDeleter)) {
+        cmdEnv.getReporter().handle(Event.info("Async deleting stale sandbox base " + sandboxBase));
+        // Create a staging ground for the old sandbox base to be moved to.
+        Path oldSandboxBaseStagingGround = sandboxBase.getParentDirectory().getRelative("old-sandbox-staging");
+        // Create the staging ground dir if it doesn't exist
+        oldSandboxBaseStagingGround.createDirectoryAndParents();
+
+        // Get a random int to use as a unique identifier for this deletion. This should be a
+        // positive int. nextInt(foo) returns a value between 0 (inclusive) and foo (exclusive).
+        int identifier = new Random().nextInt(Integer.MAX_VALUE);
+        Path oldSandboxBase = oldSandboxBaseStagingGround.getRelative("old-sandbox-" + identifier);
+
+        // Move the old sandbox base to the location in the staging ground.
+        sandboxBase.renameTo(oldSandboxBase);
+
+        // At this point, it's safe for the primary thread to continue - the sandbox base is empty
+
+        // Use the async tree deleter to cleanup all the contents of the staging ground. If there
+        // were previously staged deletes that didn't complete, they're also in this directory and
+        // will be cleaned up.
+        treeDeleter.deleteTreesBelow(oldSandboxBaseStagingGround);
+      } else {
+        cmdEnv.getReporter().handle(Event.info("Deleting stale sandbox base " + sandboxBase));
+        sandboxBase.deleteTree();
+      }
     }
     firstBuild = false;
 
diff --git a/src/main/java/com/google/devtools/build/lib/sandbox/SandboxOptions.java b/src/main/java/com/google/devtools/build/lib/sandbox/SandboxOptions.java
index 2f2b7ba7a96158..8500b5a4972a01 100644
--- a/src/main/java/com/google/devtools/build/lib/sandbox/SandboxOptions.java
+++ b/src/main/java/com/google/devtools/build/lib/sandbox/SandboxOptions.java
@@ -348,6 +348,17 @@ public ImmutableSet<Path> getInaccessiblePaths(FileSystem fs) {
               + " grows to the size specified by this flag when the server is idle.")
   public int asyncTreeDeleteIdleThreads;
 
+  @Option(
+      name = "experimental_sandbox_async_tree_delete_on_first_build",
+      defaultValue = "false",
+      documentationCategory = OptionDocumentationCategory.EXECUTION_STRATEGY,
+      effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS},
+      help =
+          "If false, sandbox deletion on the first build will be done synchronously. If true, "
+              + "and experimental_sandbox_async_tree_delete_idle_threads is non-0, sandbox deletion"
+              + "on the first build will be done asynchronously.")
+  public int asyncFirstBuildDelete;
+
   @Option(
       name = "incompatible_legacy_local_fallback",
       defaultValue = "true",