Skip to content

Disallow output bases under GC-able directories #26138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Disallow output bases under GC-able directories #26138

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b5eea3e
Disallow output bases under GC-able directories
fmeum May 23, 2025
eca2631
Address review comments
fmeum May 26, 2025
5a8197e
Handle non-existence
fmeum May 26, 2025
219eceb
Fix output_base
fmeum May 27, 2025
822192a
Add comments
fmeum May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/main/java/com/google/devtools/build/lib/bazel/BazelRepositoryModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,18 @@ public void beforeCommand(CommandEnvironment env) throws AbruptExitException {
repositoryCache.getRepoContentsCache().setPath(toPath(repoOptions.repoContentsCache, env));
}
Path repoContentsCachePath = repositoryCache.getRepoContentsCache().getPath();
if (repoContentsCachePath != null && env.getOutputBase().startsWith(repoContentsCachePath)) {
// This is dangerous as the repo contents cache GC may delete files in the output base.
throw new AbruptExitException(
detailedExitCode(
"""
The repo contents cache [%s] is inside the output base [%s]. This can cause \
spurious failures. Disable the repo contents cache with `--repo_contents_cache=`, \
or specify `--repo_contents_cache=<path outside the output base>`.
"""
.formatted(repoContentsCachePath, env.getOutputBase()),
Code.BAD_REPO_CONTENTS_CACHE));
}
if (repoContentsCachePath != null
&& env.getWorkspace() != null
&& repoContentsCachePath.startsWith(env.getWorkspace())) {
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/com/google/devtools/build/lib/remote/RemoteModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,12 @@ public void beforeCommand(CommandEnvironment env) throws AbruptExitException {
boolean enableRemoteDownloader = shouldEnableRemoteDownloader(remoteOptions);

if (enableDiskCache) {
if (env.getOutputBase().startsWith(remoteOptions.diskCache)) {
// This is dangerous as the disk cache GC may delete files in the output base.
throw createOptionsExitException(
"The --disk_cache directory cannot be a subdirectory of the output base",
FailureDetails.RemoteOptions.Code.EXECUTION_WITH_INVALID_CACHE);
}
var gcIdleTask =
DiskCacheGarbageCollectorIdleTask.create(remoteOptions, env.getWorkingDirectory());
if (gcIdleTask != null) {
Expand Down