-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
rctx.watch_tree() to watch a directory tree
- Added `rctx.watch_tree()` to watch a directory tree, which includes all transitive descendants' names, and if they're files, their contents. - Added a new SkyFunction DirectoryTreeDigestFunction to do the heavy lifting. - In the future, for performance, we could try to get this skyfunction to have a mode where it only digests stat(), to use as heuristics (similar to #21044) Work towards #20952.
- Loading branch information
Showing
10 changed files
with
356 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
149 changes: 149 additions & 0 deletions
149
src/main/java/com/google/devtools/build/lib/skyframe/DirectoryTreeDigestFunction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| // Copyright 2024 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.skyframe; | ||
|
|
||
| import static com.google.common.collect.ImmutableList.toImmutableList; | ||
| import static com.google.common.collect.ImmutableSet.toImmutableSet; | ||
|
|
||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.common.collect.ImmutableSet; | ||
| import com.google.devtools.build.lib.actions.FileValue; | ||
| import com.google.devtools.build.lib.util.Fingerprint; | ||
| import com.google.devtools.build.lib.vfs.Dirent; | ||
| import com.google.devtools.build.lib.vfs.RootedPath; | ||
| import com.google.devtools.build.skyframe.SkyFunction; | ||
| import com.google.devtools.build.skyframe.SkyFunctionException; | ||
| import com.google.devtools.build.skyframe.SkyKey; | ||
| import com.google.devtools.build.skyframe.SkyValue; | ||
| import com.google.devtools.build.skyframe.SkyframeLookupResult; | ||
| import java.io.IOException; | ||
| import java.util.stream.StreamSupport; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** A {@link SkyFunction} for {@link DirectoryTreeDigestValue}s. */ | ||
| public final class DirectoryTreeDigestFunction implements SkyFunction { | ||
| @Override | ||
| @Nullable | ||
| public SkyValue compute(SkyKey skyKey, Environment env) | ||
| throws InterruptedException, DirectoryTreeDigestFunctionException { | ||
| RootedPath rootedPath = (RootedPath) skyKey.argument(); | ||
| DirectoryListingValue dirListingValue = | ||
| (DirectoryListingValue) env.getValue(DirectoryListingValue.key(rootedPath)); | ||
| if (dirListingValue == null) { | ||
| return null; | ||
| } | ||
|
|
||
| // Get the names of entries directly in this directory, and sort them. This sets the basis for | ||
| // subsequent digests. | ||
| ImmutableSet<String> sortedDirents = | ||
| StreamSupport.stream(dirListingValue.getDirents().spliterator(), /* parallel= */ false) | ||
| .sorted() | ||
| .map(Dirent::getName) | ||
| .sorted() | ||
| .collect(toImmutableSet()); | ||
|
|
||
| // Turn each entry into a FileValue. | ||
| ImmutableList<FileValue> fileValues = getFileValues(env, sortedDirents, rootedPath); | ||
| if (fileValues == null) { | ||
| return null; | ||
| } | ||
|
|
||
| // For each entry that is a directory (or a symlink to a directory), find its own | ||
| // DirectoryTreeDigestValue. | ||
| ImmutableList<String> subDirTreeDigests = getSubDirTreeDigests(env, fileValues); | ||
| if (subDirTreeDigests == null) { | ||
| return null; | ||
| } | ||
|
|
||
| // Finally, we're ready to digest everything together! | ||
| Fingerprint fp = new Fingerprint(); | ||
| fp.addStrings(sortedDirents); | ||
| fp.addStrings(subDirTreeDigests); | ||
| try { | ||
| for (FileValue fileValue : fileValues) { | ||
| fp.addBoolean(fileValue.isDirectory()); | ||
| if (!fileValue.isDirectory()) { | ||
| byte[] digest = fileValue.realFileStateValue().getDigest(); | ||
| if (digest == null) { | ||
| // Fast digest not available, or it would have been in the FileValue. | ||
| digest = fileValue.realRootedPath().asPath().getDigest(); | ||
| } | ||
| fp.addBytes(digest); | ||
| } | ||
| } | ||
| } catch (IOException e) { | ||
| throw new DirectoryTreeDigestFunctionException(e); | ||
| } | ||
|
|
||
| return DirectoryTreeDigestValue.of(fp.hexDigestAndReset()); | ||
| } | ||
|
|
||
| @Nullable | ||
| private static ImmutableList<FileValue> getFileValues( | ||
| Environment env, ImmutableSet<String> sortedDirents, RootedPath rootedPath) | ||
| throws InterruptedException { | ||
| ImmutableSet<FileValue.Key> fileValueKeys = | ||
| sortedDirents.stream() | ||
| .map( | ||
| dirent -> | ||
| FileValue.key( | ||
| RootedPath.toRootedPath( | ||
| rootedPath.getRoot(), | ||
| rootedPath.getRootRelativePath().getRelative(dirent)))) | ||
| .collect(toImmutableSet()); | ||
| SkyframeLookupResult result = env.getValuesAndExceptions(fileValueKeys); | ||
| if (env.valuesMissing()) { | ||
| return null; | ||
| } | ||
| ImmutableList<FileValue> fileValues = | ||
| fileValueKeys.stream() | ||
| .map(result::get) | ||
| .map(FileValue.class::cast) | ||
| .collect(toImmutableList()); | ||
| if (env.valuesMissing()) { | ||
| return null; | ||
| } | ||
| return fileValues; | ||
| } | ||
|
|
||
| @Nullable | ||
| private static ImmutableList<String> getSubDirTreeDigests( | ||
| Environment env, ImmutableList<FileValue> fileValues) throws InterruptedException { | ||
| ImmutableSet<SkyKey> dirTreeDigestValueKeys = | ||
| fileValues.stream() | ||
| .filter(FileValue::isDirectory) | ||
| .map(fv -> DirectoryTreeDigestValue.key(fv.realRootedPath())) | ||
| .collect(toImmutableSet()); | ||
| SkyframeLookupResult result = env.getValuesAndExceptions(dirTreeDigestValueKeys); | ||
| if (env.valuesMissing()) { | ||
| return null; | ||
| } | ||
| ImmutableList<String> dirTreeDigests = | ||
| dirTreeDigestValueKeys.stream() | ||
| .map(result::get) | ||
| .map(DirectoryTreeDigestValue.class::cast) | ||
| .map(DirectoryTreeDigestValue::hexDigest) | ||
| .collect(toImmutableList()); | ||
| if (env.valuesMissing()) { | ||
| return null; | ||
| } | ||
| return dirTreeDigests; | ||
| } | ||
|
|
||
| private static final class DirectoryTreeDigestFunctionException extends SkyFunctionException { | ||
| public DirectoryTreeDigestFunctionException(IOException e) { | ||
| super(e, Transience.TRANSIENT); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.