When the optional per-action file system creates symlinks, it relies on metadata ({@link - * FileArtifactValue}) to resolve the actual underlying data. In the case of remote or inline - * files, this information is self-contained. However, in the case of source files, the path is - * required to resolve the content. + * Metadata for an output of {@link com.google.devtools.build.lib.analysis.actions.SymlinkAction} + * that resolves to a source file. */ - public static final class SourceFileArtifactValue extends FileArtifactValue { - private final PathFragment path; - private final byte[] digest; - private final long size; + public static final class SymlinkToSourceFileArtifactValue extends FileArtifactValue { - public SourceFileArtifactValue(PathFragment path, byte[] digest, long size) { - Preconditions.checkArgument(path.isAbsolute(), "path %s isn't absolute", path); - this.path = path; - this.digest = Preconditions.checkNotNull(digest); - this.size = size; + /** Creates metadata for a symlink pointing to a known {@link SourceArtifact}. */ + public static SymlinkToSourceFileArtifactValue toSourceArtifact( + SourceArtifact sourceArtifact, FileArtifactValue sourceFileMetadata) { + return new SymlinkToSourceFileArtifactValue( + sourceArtifact.getPath().asFragment(), sourceFileMetadata, sourceArtifact.getExecPath()); + } + + /** + * Creates metadata for a symlink pointing to a source file that is not a known {@link + * SourceArtifact}. + * + *
This is only expected to happen for a symlink to an FDO profile file when {@code + * --fdo_profile} is specified as an absolute path. + */ + public static SymlinkToSourceFileArtifactValue toUnknownSourceFile( + PathFragment resolvedPath, FileArtifactValue sourceFileMetadata) { + return new SymlinkToSourceFileArtifactValue( + resolvedPath, sourceFileMetadata, /* sourceArtifactExecPath= */ null); + } + + private final PathFragment resolvedPath; + private final FileArtifactValue sourceFileMetadata; + @Nullable private final PathFragment sourceArtifactExecPath; + + private SymlinkToSourceFileArtifactValue( + PathFragment resolvedPath, + FileArtifactValue sourceFileMetadata, + @Nullable PathFragment sourceArtifactExecPath) { + checkArgument(resolvedPath.isAbsolute(), "Resolved path must be absolute: %s", resolvedPath); + this.resolvedPath = resolvedPath; + this.sourceFileMetadata = checkNotNull(sourceFileMetadata); + this.sourceArtifactExecPath = sourceArtifactExecPath; } @Override @@ -878,52 +900,73 @@ public boolean equals(Object o) { if (this == o) { return true; } - if (!(o instanceof SourceFileArtifactValue that)) { + if (!(o instanceof SymlinkToSourceFileArtifactValue that)) { return false; } - return path.equals(that.path) && Arrays.equals(digest, that.digest) && size == that.size; + return resolvedPath.equals(that.resolvedPath) + && sourceFileMetadata.equals(that.sourceFileMetadata) + && Objects.equals(sourceArtifactExecPath, that.sourceArtifactExecPath); } @Override public int hashCode() { - int result = path.hashCode(); - result = 31 * result + Arrays.hashCode(digest); - result = 31 * result + Long.hashCode(size); - return result; + return HashCodes.hashObjects(resolvedPath, sourceFileMetadata, sourceArtifactExecPath); } - public PathFragment getPath() { - return path; + @Override + public String toString() { + return MoreObjects.toStringHelper(this) + .add("resolvedPath", resolvedPath) + .add("sourceFileMetadata", sourceFileMetadata) + .add("sourceArtifactExecPath", sourceArtifactExecPath) + .toString(); + } + + /** Returns the absolute path to which the symlink resolves. */ + public PathFragment getResolvedPath() { + return resolvedPath; + } + + /** + * If the symlink resolves to a {@link SourceArtifact}, returns that artifact's exec path. + * + *
Returns {@code null} when the symlink does not resolve to a known {@link SourceArtifact}. + * See {@link #toUnknownSourceFile}. + */ + @Nullable + public PathFragment getSourceArtifactExecPath() { + return sourceArtifactExecPath; } @Override public FileStateType getType() { - return FileStateType.REGULAR_FILE; + return sourceFileMetadata.getType(); } + @Nullable @Override public byte[] getDigest() { - return digest; + return sourceFileMetadata.getDigest(); } @Override public FileContentsProxy getContentsProxy() { - throw new UnsupportedOperationException(); + return sourceFileMetadata.getContentsProxy(); } @Override public long getSize() { - return size; + return sourceFileMetadata.getSize(); } @Override public long getModifiedTime() { - throw new UnsupportedOperationException(); + return sourceFileMetadata.getModifiedTime(); } @Override - public boolean wasModifiedSinceDigest(Path path) { - throw new UnsupportedOperationException(); + public boolean wasModifiedSinceDigest(Path path) throws IOException { + return sourceFileMetadata.wasModifiedSinceDigest(path); } }