Pepper the code that sets up sandboxes for workers and non-workers with interrupt checks.

This will make it faster to interrupt them under dynamic execution.

PiperOrigin-RevId: 530574318
Change-Id: I98e8322858ce6b7bd67661bc23d105d7a82382a7

Author: larsrc-google

src/main/java/com/google/devtools/build/lib/sandbox/AbstractContainerizingSandboxedSpawn.java

@@ -99,7 +99,7 @@ public String getMnemonic() {
   }
 
   @Override
-  public void createFileSystem() throws IOException {
+  public void createFileSystem() throws IOException, InterruptedException {
     // First compute all the inputs and directories that we need. This is based only on
     // `workerFiles`, `inputs` and `outputs` and won't do any I/O.
     Set<PathFragment> inputsToCreate = new LinkedHashSet<>();
@@ -128,7 +128,7 @@ public void createFileSystem() throws IOException {
 
   protected void filterInputsAndDirsToCreate(
       Set<PathFragment> inputsToCreate, LinkedHashSet<PathFragment> dirsToCreate)
-      throws IOException {}
+      throws IOException, InterruptedException {}
 
   /**
    * Creates all inputs needed for this spawn's sandbox.
@@ -138,8 +138,11 @@ protected void filterInputsAndDirsToCreate(
    * @param inputs All the inputs for this spawn.
    */
   void createInputs(Iterable<PathFragment> inputsToCreate, SandboxInputs inputs)
-      throws IOException {
+      throws IOException, InterruptedException {
     for (PathFragment fragment : inputsToCreate) {
+      if (Thread.interrupted()) {
+        throw new InterruptedException("Interrupted creating inputs");
+      }
       Path key = sandboxExecRoot.getRelative(fragment);
       if (inputs.getFiles().containsKey(fragment)) {
         RootedPath fileDest = inputs.getFiles().get(fragment);

src/main/java/com/google/devtools/build/lib/sandbox/DarwinSandboxedSpawnRunner.java

@@ -316,7 +316,7 @@ public void createFileSystem() throws IOException {
           statisticsPath,
           spawn.getMnemonic()) {
         @Override
-        public void createFileSystem() throws IOException {
+        public void createFileSystem() throws IOException, InterruptedException {
           super.createFileSystem();
           writeConfig(
               sandboxConfigPath,

src/main/java/com/google/devtools/build/lib/sandbox/SandboxHelpers.java

@@ -132,11 +132,14 @@ public static void cleanExisting(
       Set<PathFragment> inputsToCreate,
       Set<PathFragment> dirsToCreate,
       Path workDir)
-      throws IOException {
+      throws IOException, InterruptedException {
     // To avoid excessive scanning of dirsToCreate for prefix dirs, we prepopulate this set of
     // prefixes.
     Set<PathFragment> prefixDirs = new HashSet<>();
     for (PathFragment dir : dirsToCreate) {
+      if (Thread.interrupted()) {
+        throw new InterruptedException();
+      }
       PathFragment parent = dir.getParentDirectory();
       while (parent != null && !prefixDirs.contains(parent)) {
         prefixDirs.add(parent);
@@ -157,9 +160,12 @@ private static void cleanRecursively(
       Set<PathFragment> dirsToCreate,
       Path workDir,
       Set<PathFragment> prefixDirs)
-      throws IOException {
+      throws IOException, InterruptedException {
     Path execroot = workDir.getParentDirectory();
     for (Dirent dirent : root.readdir(Symlinks.NOFOLLOW)) {
+      if (Thread.interrupted()) {
+        throw new InterruptedException();
+      }
       Path absPath = root.getChild(dirent.getName());
       PathFragment pathRelativeToWorkDir;
       if (absPath.startsWith(workDir)) {
@@ -280,7 +286,8 @@ public static void createDirectoryAndParentsInSandboxRoot(
    *     are disallowed, for stricter sandboxing.
    */
   public static void createDirectories(
-      Iterable<PathFragment> dirsToCreate, Path dir, boolean strict) throws IOException {
+      Iterable<PathFragment> dirsToCreate, Path dir, boolean strict)
+      throws IOException, InterruptedException {
     Set<Path> knownDirectories = new HashSet<>();
     // Add sandboxExecRoot and it's parent -- all paths must fall under the parent of
     // sandboxExecRoot and we know that sandboxExecRoot exists. This stops the recursion in
@@ -289,6 +296,9 @@ public static void createDirectories(
     knownDirectories.add(dir.getParentDirectory());
 
     for (PathFragment path : dirsToCreate) {
+      if (Thread.interrupted()) {
+        throw new InterruptedException();
+      }
       if (strict) {
         Preconditions.checkArgument(!path.isAbsolute(), path);
         if (path.containsUplevelReferences() && path.isMultiSegment()) {

src/main/java/com/google/devtools/build/lib/sandbox/SandboxedSpawn.java

@@ -41,12 +41,12 @@ default boolean useSubprocessTimeout() {
 
   /**
    * Creates the sandboxed execution root, making all {@code inputs} available for reading, making
-   * sure that the parent directories of all {@code outputs} and that all {@code writableDirs}
-   * exist and can be written into.
+   * sure that the parent directories of all {@code outputs} and that all {@code writableDirs} exist
+   * and can be written into.
    *
    * @throws IOException
    */
-  void createFileSystem() throws IOException;
+  void createFileSystem() throws IOException, InterruptedException;
 
   /**
    * Moves all {@code outputs} to {@code execRoot} while keeping the directory structure.

src/main/java/com/google/devtools/build/lib/sandbox/SymlinkedSandboxedSpawn.java

@@ -65,7 +65,7 @@ public SymlinkedSandboxedSpawn(
   @Override
   public void filterInputsAndDirsToCreate(
       Set<PathFragment> inputsToCreate, LinkedHashSet<PathFragment> dirsToCreate)
-      throws IOException {
+      throws IOException, InterruptedException {
     boolean gotStash = SandboxStash.takeStashedSandbox(sandboxPath, mnemonic);
     sandboxExecRoot.createDirectoryAndParents();
     if (gotStash) {

src/main/java/com/google/devtools/build/lib/worker/SandboxedWorkerProxy.java

@@ -67,7 +67,7 @@ public boolean isSandboxed() {
   @Override
   public void prepareExecution(
       SandboxInputs inputFiles, SandboxOutputs outputs, Set<PathFragment> workerFiles)
-      throws IOException {
+      throws IOException, InterruptedException {
     workerMultiplexer.createSandboxedProcess(workDir, workerFiles, inputFiles);
 
     sandboxDir.createDirectoryAndParents();

src/main/java/com/google/devtools/build/lib/worker/WorkerExecRoot.java

@@ -46,7 +46,7 @@ public WorkerExecRoot(Path workDir, List<PathFragment> extraDirs) {
 
   public void createFileSystem(
       Set<PathFragment> workerFiles, SandboxInputs inputs, SandboxOutputs outputs)
-      throws IOException {
+      throws IOException, InterruptedException {
     workDir.createDirectoryAndParents();
 
     // First compute all the inputs and directories that we need. This is based only on
@@ -77,8 +77,11 @@ public void createFileSystem(
   }
 
   static void createInputs(Iterable<PathFragment> inputsToCreate, SandboxInputs inputs, Path dir)
-      throws IOException {
+      throws IOException, InterruptedException {
     for (PathFragment fragment : inputsToCreate) {
+      if (Thread.interrupted()) {
+        throw new InterruptedException();
+      }
       Path key = dir.getRelative(fragment);
       if (inputs.getFiles().containsKey(fragment)) {
         RootedPath fileDest = inputs.getFiles().get(fragment);

src/main/java/com/google/devtools/build/lib/worker/WorkerMultiplexer.java

@@ -140,7 +140,8 @@ private synchronized void report(@Nullable String s) {
    * sets up the sandbox root dir with the required worker files.
    */
   public synchronized void createSandboxedProcess(
-      Path workDir, Set<PathFragment> workerFiles, SandboxInputs inputFiles) throws IOException {
+      Path workDir, Set<PathFragment> workerFiles, SandboxInputs inputFiles)
+      throws IOException, InterruptedException {
     // TODO: Make blaze clean remove the workdir.
     if (this.process == null) {
       // This should be a once-only operation.

src/main/java/com/google/devtools/build/lib/worker/WorkerProxy.java

@@ -59,7 +59,7 @@ void setReporter(EventHandler reporter) {
   @Override
   public void prepareExecution(
       SandboxInputs inputFiles, SandboxOutputs outputs, Set<PathFragment> workerFiles)
-      throws IOException {
+      throws IOException, InterruptedException {
     workerMultiplexer.createProcess(workDir);
   }
 

src/test/java/com/google/devtools/build/lib/sandbox/SandboxHelpersTest.java

@@ -240,7 +240,7 @@ public void atomicallyWriteVirtualInput_writesArbitraryVirtualInput() throws Exc
   }
 
   @Test
-  public void cleanExisting_updatesDirs() throws IOException {
+  public void cleanExisting_updatesDirs() throws IOException, InterruptedException {
     RootedPath inputTxt =
         RootedPath.toRootedPath(
             Root.fromPath(scratch.getFileSystem().getPath("/")), PathFragment.create("hello.txt"));