Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Write a repo mapping manifest in the runfiles directory
To ensure we can use repo mappings in the runfiles library, this change writes an extra file "my_binary_target.runfiles/_repo_mapping", which contains a bunch of (base_repo_canonical_name, apparent_repo_name, canonical_repo_name) triples. See https://github.com/bazelbuild/proposals/blob/main/designs/2022-07-21-locating-runfiles-with-bzlmod.md for more information. Work towards #16124
- Loading branch information
Showing
9 changed files
with
617 additions
and
22 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
149 changes: 149 additions & 0 deletions
149
src/main/java/com/google/devtools/build/lib/analysis/RepoMappingManifestAction.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 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; | ||
|
|
||
| import static com.google.common.collect.ImmutableSet.toImmutableSet; | ||
| import static java.nio.charset.StandardCharsets.ISO_8859_1; | ||
| import static java.util.Comparator.comparing; | ||
|
|
||
| import com.google.common.collect.ImmutableSet; | ||
| import com.google.common.collect.ImmutableSortedMap; | ||
| import com.google.devtools.build.lib.actions.ActionExecutionContext; | ||
| import com.google.devtools.build.lib.actions.ActionKeyContext; | ||
| import com.google.devtools.build.lib.actions.ActionOwner; | ||
| import com.google.devtools.build.lib.actions.Artifact; | ||
| import com.google.devtools.build.lib.actions.Artifact.ArtifactExpander; | ||
| import com.google.devtools.build.lib.actions.CommandLineExpansionException; | ||
| import com.google.devtools.build.lib.actions.ExecException; | ||
| import com.google.devtools.build.lib.analysis.actions.AbstractFileWriteAction; | ||
| import com.google.devtools.build.lib.analysis.actions.DeterministicWriter; | ||
| import com.google.devtools.build.lib.cmdline.RepositoryMapping; | ||
| import com.google.devtools.build.lib.cmdline.RepositoryName; | ||
| import com.google.devtools.build.lib.collect.nestedset.NestedSet; | ||
| import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder; | ||
| import com.google.devtools.build.lib.collect.nestedset.Order; | ||
| import com.google.devtools.build.lib.packages.Package; | ||
| import com.google.devtools.build.lib.util.Fingerprint; | ||
| import java.io.BufferedWriter; | ||
| import java.io.IOException; | ||
| import java.io.OutputStreamWriter; | ||
| import java.io.Writer; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.Map.Entry; | ||
| import java.util.UUID; | ||
| import javax.annotation.Nullable; | ||
| import net.starlark.java.eval.EvalException; | ||
|
|
||
| /** Creates a manifest file describing the repos and mappings relevant for a runfile tree. */ | ||
| public class RepoMappingManifestAction extends AbstractFileWriteAction { | ||
| private static final UUID MY_UUID = UUID.fromString("458e351c-4d30-433d-b927-da6cddd4737f"); | ||
|
|
||
| private final NestedSet<Package> transitivePackages; | ||
| private final NestedSet<Artifact> runfilesArtifacts; | ||
| private final String workspaceName; | ||
|
|
||
| public RepoMappingManifestAction( | ||
| ActionOwner owner, | ||
| Artifact output, | ||
| NestedSet<Package> transitivePackages, | ||
| NestedSet<Artifact> runfilesArtifacts, | ||
| String workspaceName) { | ||
| super(owner, NestedSetBuilder.emptySet(Order.STABLE_ORDER), output, /*makeExecutable=*/ false); | ||
| this.transitivePackages = transitivePackages; | ||
| this.runfilesArtifacts = runfilesArtifacts; | ||
| this.workspaceName = workspaceName; | ||
| } | ||
|
|
||
| @Override | ||
| public String getMnemonic() { | ||
| return "RepoMappingManifest"; | ||
| } | ||
|
|
||
| @Override | ||
| protected String getRawProgressMessage() { | ||
| return "writing repo mapping manifest for " + getOwner().getLabel(); | ||
| } | ||
|
|
||
| @Override | ||
| protected void computeKey( | ||
| ActionKeyContext actionKeyContext, | ||
| @Nullable ArtifactExpander artifactExpander, | ||
| Fingerprint fp) | ||
| throws CommandLineExpansionException, EvalException, InterruptedException { | ||
| fp.addUUID(MY_UUID); | ||
| actionKeyContext.addNestedSetToFingerprint(fp, transitivePackages); | ||
| actionKeyContext.addNestedSetToFingerprint(fp, runfilesArtifacts); | ||
| fp.addString(workspaceName); | ||
| } | ||
|
|
||
| @Override | ||
| public DeterministicWriter newDeterministicWriter(ActionExecutionContext ctx) | ||
| throws InterruptedException, ExecException { | ||
| return out -> { | ||
| Writer writer = new BufferedWriter(new OutputStreamWriter(out, ISO_8859_1)); | ||
|
|
||
| ImmutableSet<RepositoryName> reposContributingRunfiles = | ||
| runfilesArtifacts.toList().stream() | ||
| .filter(a -> a.getOwner() != null) | ||
| .map(a -> a.getOwner().getRepository()) | ||
| .collect(toImmutableSet()); | ||
| Map<RepositoryName, RepositoryMapping> reposAndMappings = new HashMap<>(); | ||
| for (Package pkg : transitivePackages.toList()) { | ||
| // Any package from the same repo would have the same repo mapping, so either `put` or | ||
| // `putIfAbsent` works here. | ||
| reposAndMappings.putIfAbsent( | ||
| pkg.getPackageIdentifier().getRepository(), pkg.getRepositoryMapping()); | ||
| } | ||
| for (Entry<RepositoryName, RepositoryMapping> repoAndMapping : | ||
| ImmutableSortedMap.copyOf(reposAndMappings, comparing(RepositoryName::getName)) | ||
| .entrySet()) { | ||
| writeRepoMapping( | ||
| writer, reposContributingRunfiles, repoAndMapping.getKey(), repoAndMapping.getValue()); | ||
| } | ||
| writer.flush(); | ||
| }; | ||
| } | ||
|
|
||
| private void writeRepoMapping( | ||
| Writer writer, | ||
| ImmutableSet<RepositoryName> reposContributingRunfiles, | ||
| RepositoryName repoName, | ||
| RepositoryMapping repoMapping) | ||
| throws IOException { | ||
| for (Entry<String, RepositoryName> mappingEntry : | ||
| ImmutableSortedMap.copyOf(repoMapping.entries()).entrySet()) { | ||
| if (mappingEntry.getKey().isEmpty()) { | ||
| // The apparent repo name can only be empty for the main repo. We skip this line. | ||
| continue; | ||
| } | ||
| if (!reposContributingRunfiles.contains(mappingEntry.getValue())) { | ||
| // We only write entries for repos that actually contribute runfiles. | ||
| continue; | ||
| } | ||
| writer.write(repoName.getName()); | ||
| writer.write(','); | ||
| writer.write(mappingEntry.getKey()); | ||
| writer.write(','); | ||
| if (mappingEntry.getValue().isMain()) { | ||
| // The canonical name of the main repo is the empty string, but we use the "workspace | ||
| // name" as the name of the directory under the runfiles tree for it. | ||
| writer.write(workspaceName); | ||
| } else { | ||
| writer.write(mappingEntry.getValue().getName()); | ||
| } | ||
| writer.write(System.lineSeparator()); | ||
| } | ||
| } | ||
| } |
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.