// Copyright 2017 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.exec; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Preconditions; import com.google.common.collect.ImmutableList; import com.google.devtools.build.lib.actions.ActionInput; import com.google.devtools.build.lib.actions.ActionInputHelper; import com.google.devtools.build.lib.actions.Artifact; import com.google.devtools.build.lib.actions.Artifact.ArtifactExpander; import com.google.devtools.build.lib.actions.Artifact.TreeFileArtifact; import com.google.devtools.build.lib.actions.FileArtifactValue; import com.google.devtools.build.lib.actions.FilesetOutputSymlink; import com.google.devtools.build.lib.actions.MetadataProvider; import com.google.devtools.build.lib.actions.RunfilesSupplier; import com.google.devtools.build.lib.actions.Spawn; import com.google.devtools.build.lib.actions.cache.VirtualActionInput.EmptyActionInput; import com.google.devtools.build.lib.exec.FilesetManifest.RelativeSymlinkBehavior; import com.google.devtools.build.lib.vfs.Path; import com.google.devtools.build.lib.vfs.PathFragment; import java.io.IOException; import java.util.Collections; import java.util.List; import java.util.Map; import java.util.SortedMap; import java.util.TreeMap; /** * A helper class for spawn strategies to turn runfiles suppliers into input mappings. This class * performs no I/O operations, but only rearranges the files according to how the runfiles should be * laid out. */ public class SpawnInputExpander { @VisibleForTesting static final ActionInput EMPTY_FILE = new EmptyActionInput("/dev/null"); private final Path execRoot; private final boolean strict; private final RelativeSymlinkBehavior relSymlinkBehavior; /** * Creates a new instance. If strict is true, then the expander checks for directories in runfiles * and throws an exception if it finds any. Otherwise it silently ignores directories in runfiles * and adds a mapping for them. At this time, directories in filesets are always silently added as * mappings. * *
Directories in inputs are a correctness issue: Bazel only tracks dependencies at the action * level, and it does not track dependencies on directories. Making a directory available to a * spawn even though it's contents are not tracked as dependencies leads to incorrect incremental * builds, since changes to the contents do not trigger action invalidation. * *
As such, all spawn strategies should always be strict and not make directories available to * the subprocess. However, that's a breaking change, and therefore we make it depend on this flag * for now. */ public SpawnInputExpander(Path execRoot, boolean strict) { this(execRoot, strict, RelativeSymlinkBehavior.ERROR); } /** * Creates a new instance. If strict is true, then the expander checks for directories in runfiles * and throws an exception if it finds any. Otherwise it silently ignores directories in runfiles * and adds a mapping for them. At this time, directories in filesets are always silently added as * mappings. * *
Directories in inputs are a correctness issue: Bazel only tracks dependencies at the action * level, and it does not track dependencies on directories. Making a directory available to a * spawn even though it's contents are not tracked as dependencies leads to incorrect incremental * builds, since changes to the contents do not trigger action invalidation. * *
As such, all spawn strategies should always be strict and not make directories available to
* the subprocess. However, that's a breaking change, and therefore we make it depend on this flag
* for now.
*/
public SpawnInputExpander(
Path execRoot, boolean strict, RelativeSymlinkBehavior relSymlinkBehavior) {
this.execRoot = execRoot;
this.strict = strict;
this.relSymlinkBehavior = relSymlinkBehavior;
}
private void addMapping(
Map The returned map never contains {@code null} values; it uses {@link #EMPTY_FILE} for empty
* files, which is an instance of {@link
* com.google.devtools.build.lib.actions.cache.VirtualActionInput}.
*
* The returned map contains all runfiles, but not the {@code MANIFEST}.
*/
public SortedMap