Skip to content
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

Add experimental_remote_cache_key_ignore_stamping to skip volatile stamping files on compute shared cache key #16240

Closed
wants to merge 1 commit into from
Closed

Add experimental_remote_cache_key_ignore_stamping to skip volatile stamping files on compute shared cache key #16240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 36 additions & 3 deletions src/main/java/com/google/devtools/build/lib/remote/RemoteExecutionService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@
import io.reactivex.rxjava3.core.SingleObserver;
import io.reactivex.rxjava3.disposables.Disposable;
import io.reactivex.rxjava3.schedulers.Schedulers;

import java.io.IOException;
import java.time.Instant;
import java.util.ArrayList;
Expand Down Expand Up @@ -340,7 +341,8 @@ public CachePolicy getWriteCachePolicy(Spawn spawn) {
public boolean mayBeExecutedRemotely(Spawn spawn) {
return remoteCache instanceof RemoteExecutionCache
&& remoteExecutor != null
&& Spawns.mayBeExecutedRemotely(spawn);
&& Spawns.mayBeExecutedRemotely(spawn)
&& !(remoteOptions.remoteCacheKeyIgnoreStamping && hasVolatileArtifacts(spawn));
}

private SortedMap<PathFragment, ActionInput> buildOutputDirMap(Spawn spawn) {
Expand Down Expand Up @@ -398,7 +400,7 @@ private MerkleTree buildInputMerkleTree(
inputMap = newInputMap;
}
return MerkleTree.build(
inputMap,
filterInputs(inputMap),
toolSignature == null ? ImmutableSet.of() : toolSignature.toolInputs,
context.getMetadataProvider(),
execRoot,
Expand Down Expand Up @@ -430,7 +432,7 @@ public MerkleTree uncachedBuildMerkleTreeVisitor(
ConcurrentLinkedQueue<MerkleTree> subMerkleTrees = new ConcurrentLinkedQueue<>();
subMerkleTrees.add(
MerkleTree.build(
walker.getLeavesInputMapping(),
filterInputs(walker.getLeavesInputMapping()),
metadataProvider,
execRoot,
artifactPathResolver,
Expand All @@ -444,6 +446,20 @@ public MerkleTree uncachedBuildMerkleTreeVisitor(
return MerkleTree.merge(subMerkleTrees, digestUtil);
}

private SortedMap<PathFragment, ActionInput> filterInputs(SortedMap<PathFragment, ActionInput> inputs) {
if (!remoteOptions.remoteCacheKeyIgnoreStamping) {
return inputs;
}
SortedMap<PathFragment, ActionInput> result = new TreeMap<>();
for (Entry<PathFragment, ActionInput> entry : inputs.entrySet()) {
ActionInput input = entry.getValue();
if (!isConstantMetadata(input)) {
result.put(entry.getKey(), input);
}
}
return result;
}

@Nullable
private static ByteString buildSalt(Spawn spawn) {
CacheSalt.Builder saltBuilder =
Expand Down Expand Up @@ -1585,6 +1601,23 @@ void report(Event evt) {
}
}

private static boolean hasVolatileArtifacts(Spawn spawn) {
var inputFiles = spawn.getInputFiles();
for (ActionInput inputFile : inputFiles.getLeaves()) {
if (isConstantMetadata(inputFile)) {
return true;
}
}
return false;
}

private static boolean isConstantMetadata(ActionInput input) {
if (input instanceof Artifact) {
return ((Artifact) input).isConstantMetadata();
}
return false;
}

/**
* A simple value class combining a hash of the tool inputs (and their digests) as well as a set
* of the relative paths of all tool inputs.
Expand Down
8 changes: 8 additions & 0 deletions src/main/java/com/google/devtools/build/lib/remote/options/RemoteOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,14 @@ public final class RemoteOptions extends CommonRemoteOptions {
+ "disable TLS.")
public String remoteExecutor;

@Option(
name = "experimental_remote_cache_key_ignore_stamping",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.REMOTE,
effectTags = {OptionEffectTag.UNKNOWN},
help = "Don't use volatile stamping data in shared cache key. Also disable remote execution for stamping actions.")
public boolean remoteCacheKeyIgnoreStamping;

@Option(
name = "experimental_remote_execution_keepalive",
defaultValue = "false",
Expand Down
Loading