-
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.
Create and stage symlink artifacts with unmodified target path
Unresolved symlink artifacts created with `ctx.actions.symlink(target_path = ...)` are now created without making the target path absolute by prepending the exec root, which diverged from the documentation and intended goal and also gave rise to hermeticity issues as such symlinks would regularly resolve outside the sandbox. Furthermore, in order to bring local execution in line with other execution types, the runfiles manifest entry (and thus the runfiles directory contents) for symlink artifacts are now their target paths rather than their exec paths, which along the way resolves another soure of non-hermetic resolution outside the runfiles directory. This requires making symlink artifacts (but not artifacts representing regular files) inputs of `SourceManifestAction`, which previously had no inputs. The change flattens a nested set in `getInputs`, but benchmarks confirm that this does not result in a performance regression. Alternatives considered either result in a substantially worse Starlark API or wouldn't work for symlinks created by spawns. Work towards #10298 Closes #16272. PiperOrigin-RevId: 474784371 Change-Id: I15d318c30542c1da54d86d9b1ae769fe2a0ec970
- Loading branch information
1 parent
720dc5f
commit d834905
Showing
13 changed files
with
574 additions
and
29 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
113 changes: 113 additions & 0 deletions
113
src/main/java/com/google/devtools/build/lib/analysis/starlark/UnresolvedSymlinkAction.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,113 @@ | ||
| // Copyright 2022 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.analysis.starlark; | ||
|
|
||
| import com.google.common.base.Preconditions; | ||
| import com.google.common.collect.ImmutableSet; | ||
| import com.google.devtools.build.lib.actions.AbstractAction; | ||
| import com.google.devtools.build.lib.actions.ActionExecutionContext; | ||
| import com.google.devtools.build.lib.actions.ActionExecutionException; | ||
| import com.google.devtools.build.lib.actions.ActionKeyContext; | ||
| import com.google.devtools.build.lib.actions.ActionOwner; | ||
| import com.google.devtools.build.lib.actions.ActionResult; | ||
| import com.google.devtools.build.lib.actions.Artifact; | ||
| import com.google.devtools.build.lib.actions.Artifact.ArtifactExpander; | ||
| import com.google.devtools.build.lib.analysis.actions.SymlinkAction; | ||
| import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder; | ||
| import com.google.devtools.build.lib.collect.nestedset.Order; | ||
| import com.google.devtools.build.lib.server.FailureDetails; | ||
| import com.google.devtools.build.lib.server.FailureDetails.FailureDetail; | ||
| import com.google.devtools.build.lib.server.FailureDetails.SymlinkAction.Code; | ||
| import com.google.devtools.build.lib.util.DetailedExitCode; | ||
| import com.google.devtools.build.lib.util.Fingerprint; | ||
| import com.google.devtools.build.lib.vfs.Path; | ||
| import com.google.devtools.build.lib.vfs.PathFragment; | ||
| import java.io.IOException; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * Action to create a possibly unresolved symbolic link to a raw path. | ||
| * | ||
| * <p>To create a symlink to a known-to-exist target with alias semantics similar to a true copy of | ||
| * the input, use {@link SymlinkAction} instead. | ||
| */ | ||
| public final class UnresolvedSymlinkAction extends AbstractAction { | ||
| private static final String GUID = "0f302651-602c-404b-881c-58913193cfe7"; | ||
|
|
||
| private final PathFragment target; | ||
| private final String progressMessage; | ||
|
|
||
| private UnresolvedSymlinkAction( | ||
| ActionOwner owner, Artifact primaryOutput, String target, String progressMessage) { | ||
| super(owner, NestedSetBuilder.emptySet(Order.STABLE_ORDER), ImmutableSet.of(primaryOutput)); | ||
| // TODO: PathFragment#create normalizes the symlink target, which may change how it resolves | ||
| // when combined with directory symlinks. Ideally, Bazel's file system abstraction would | ||
| // offer a way to create symlinks without any preprocessing of the target. | ||
| this.target = PathFragment.create(target); | ||
| this.progressMessage = progressMessage; | ||
| } | ||
|
|
||
| public static UnresolvedSymlinkAction create( | ||
| ActionOwner owner, Artifact primaryOutput, String target, String progressMessage) { | ||
| Preconditions.checkArgument(primaryOutput.isSymlink()); | ||
| return new UnresolvedSymlinkAction(owner, primaryOutput, target, progressMessage); | ||
| } | ||
|
|
||
| @Override | ||
| public ActionResult execute(ActionExecutionContext actionExecutionContext) | ||
| throws ActionExecutionException { | ||
|
|
||
| Path outputPath = actionExecutionContext.getInputPath(getPrimaryOutput()); | ||
| try { | ||
| outputPath.createSymbolicLink(target); | ||
| } catch (IOException e) { | ||
| String message = | ||
| String.format( | ||
| "failed to create symbolic link '%s' with target '%s' due to I/O error: %s", | ||
| getPrimaryOutput().getExecPathString(), target, e.getMessage()); | ||
| DetailedExitCode code = createDetailedExitCode(message, Code.LINK_CREATION_IO_EXCEPTION); | ||
| throw new ActionExecutionException(message, e, this, false, code); | ||
| } | ||
|
|
||
| return ActionResult.EMPTY; | ||
| } | ||
|
|
||
| @Override | ||
| protected void computeKey( | ||
| ActionKeyContext actionKeyContext, | ||
| @Nullable ArtifactExpander artifactExpander, | ||
| Fingerprint fp) { | ||
| fp.addString(GUID); | ||
| fp.addPath(target); | ||
| } | ||
|
|
||
| @Override | ||
| public String getMnemonic() { | ||
| return "UnresolvedSymlink"; | ||
| } | ||
|
|
||
| @Override | ||
| protected String getRawProgressMessage() { | ||
| return progressMessage; | ||
| } | ||
|
|
||
| private static DetailedExitCode createDetailedExitCode(String message, Code detailedCode) { | ||
| return DetailedExitCode.of( | ||
| FailureDetail.newBuilder() | ||
| .setMessage(message) | ||
| .setSymlinkAction(FailureDetails.SymlinkAction.newBuilder().setCode(detailedCode)) | ||
| .build()); | ||
| } | ||
| } |
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
Oops, something went wrong.