Damien Martin-Guillerez | f88f4d8 | 2015-09-25 13:56:55 +0000 | [diff] [blame] | 1 | // Copyright 2014 The Bazel Authors. All rights reserved. |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | // you may not use this file except in compliance with the License. |
| 5 | // You may obtain a copy of the License at |
| 6 | // |
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | // See the License for the specific language governing permissions and |
| 13 | // limitations under the License. |
| 14 | |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 15 | package com.google.devtools.build.lib.vfs; |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 16 | |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 17 | import com.google.common.collect.ImmutableList; |
felly | 943a9c7 | 2018-08-09 12:55:47 -0700 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableMap; |
Eric Fellheimer | f3b43af | 2015-11-13 19:51:20 +0000 | [diff] [blame] | 19 | import com.google.devtools.build.lib.actions.Action; |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 20 | import com.google.devtools.build.lib.actions.ActionInputMap; |
| 21 | import com.google.devtools.build.lib.actions.Artifact; |
shahan | 5b0e071 | 2018-10-17 07:41:03 -0700 | [diff] [blame] | 22 | import com.google.devtools.build.lib.actions.Artifact.SourceArtifact; |
tomlu | 880508c | 2018-08-03 11:21:29 -0700 | [diff] [blame] | 23 | import com.google.devtools.build.lib.actions.ArtifactPathResolver; |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 24 | import com.google.devtools.build.lib.actions.BuildFailedException; |
Eric Fellheimer | f3b43af | 2015-11-13 19:51:20 +0000 | [diff] [blame] | 25 | import com.google.devtools.build.lib.actions.EnvironmentalExecException; |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 26 | import com.google.devtools.build.lib.actions.ExecException; |
felly | 943a9c7 | 2018-08-09 12:55:47 -0700 | [diff] [blame] | 27 | import com.google.devtools.build.lib.actions.FilesetOutputSymlink; |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 28 | import com.google.devtools.build.lib.actions.MetadataConsumer; |
Eric Fellheimer | f3b43af | 2015-11-13 19:51:20 +0000 | [diff] [blame] | 29 | import com.google.devtools.build.lib.actions.cache.MetadataHandler; |
ulfjack | 75483b5 | 2017-07-11 13:36:41 +0200 | [diff] [blame] | 30 | import com.google.devtools.build.lib.events.EventHandler; |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 31 | import com.google.devtools.build.lib.util.AbruptExitException; |
felly | 943a9c7 | 2018-08-09 12:55:47 -0700 | [diff] [blame] | 32 | import com.google.devtools.build.skyframe.SkyFunction.Environment; |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 33 | import java.io.IOException; |
tomlu | fe1dd88 | 2018-08-15 12:17:42 -0700 | [diff] [blame] | 34 | import java.util.Collection; |
| 35 | import java.util.Map; |
Eric Fellheimer | 2db6a74 | 2015-04-28 21:38:43 +0000 | [diff] [blame] | 36 | import java.util.UUID; |
shahan | 5b0e071 | 2018-10-17 07:41:03 -0700 | [diff] [blame] | 37 | import java.util.function.Function; |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 38 | import javax.annotation.Nullable; |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 39 | |
| 40 | /** |
| 41 | * An OutputService retains control over the Blaze output tree, and provides a higher level of |
| 42 | * abstraction compared to the VFS layer. |
| 43 | * |
| 44 | * <p>Higher-level facilities include batch statting, cleaning the output tree, creating symlink |
| 45 | * trees, and out-of-band insertion of metadata into the tree. |
| 46 | */ |
| 47 | public interface OutputService { |
| 48 | |
buchgr | 7b51552 | 2019-03-29 04:42:17 -0700 | [diff] [blame] | 49 | /** Properties of the action file system implementation provided by this output service. */ |
| 50 | enum ActionFileSystemType { |
| 51 | |
| 52 | /** Action file system is disabled */ |
| 53 | DISABLED, |
| 54 | |
| 55 | /** |
| 56 | * The action file system implementation does not take over the output base but complements the |
| 57 | * file system by being able to stage remote outputs accessed as inputs by local actions, as |
| 58 | * used by Bazel. |
| 59 | */ |
| 60 | STAGE_REMOTE_FILES, |
| 61 | |
| 62 | /** |
| 63 | * The action file system implementation is fully featured in-memory file system implementation |
| 64 | * and takes full control of the output base, as used by Blaze. |
| 65 | */ |
| 66 | IN_MEMORY_FILE_SYSTEM; |
| 67 | |
| 68 | public boolean inMemoryFileSystem() { |
| 69 | return this == IN_MEMORY_FILE_SYSTEM; |
| 70 | } |
| 71 | |
| 72 | public boolean isEnabled() { |
| 73 | return this != DISABLED; |
| 74 | } |
| 75 | } |
| 76 | |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 77 | /** |
| 78 | * @return the name of filesystem, akin to what you might see in /proc/mounts |
| 79 | */ |
| 80 | String getFilesSystemName(); |
| 81 | |
| 82 | /** |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 83 | * Start the build. |
| 84 | * |
Eric Fellheimer | 2db6a74 | 2015-04-28 21:38:43 +0000 | [diff] [blame] | 85 | * @param buildId the UUID build identifier |
Eric Fellheimer | 1246eb3 | 2015-11-18 15:41:38 +0000 | [diff] [blame] | 86 | * @param finalizeActions whether this build is finalizing actions so that the output service |
| 87 | * can track output tree modifications |
Eric Fellheimer | f3b43af | 2015-11-13 19:51:20 +0000 | [diff] [blame] | 88 | * @return a ModifiedFileSet of changed output files. |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 89 | * @throws BuildFailedException if build preparation failed |
| 90 | * @throws InterruptedException |
| 91 | */ |
ulfjack | 75483b5 | 2017-07-11 13:36:41 +0200 | [diff] [blame] | 92 | ModifiedFileSet startBuild(EventHandler eventHandler, UUID buildId, boolean finalizeActions) |
Eric Fellheimer | 2db6a74 | 2015-04-28 21:38:43 +0000 | [diff] [blame] | 93 | throws BuildFailedException, AbruptExitException, InterruptedException; |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 94 | |
| 95 | /** |
| 96 | * Finish the build. |
| 97 | * |
| 98 | * @param buildSuccessful iff build was successful |
| 99 | * @throws BuildFailedException on failure |
| 100 | */ |
Rumou Duan | 2756c02 | 2016-10-06 15:57:36 +0000 | [diff] [blame] | 101 | void finalizeBuild(boolean buildSuccessful) |
| 102 | throws BuildFailedException, AbruptExitException, InterruptedException; |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 103 | |
Eric Fellheimer | f3b43af | 2015-11-13 19:51:20 +0000 | [diff] [blame] | 104 | /** Notify the output service of a completed action. */ |
| 105 | void finalizeAction(Action action, MetadataHandler metadataHandler) |
ulfjack | 85b0773 | 2019-09-20 09:04:55 -0700 | [diff] [blame] | 106 | throws IOException, EnvironmentalExecException, InterruptedException; |
Eric Fellheimer | f3b43af | 2015-11-13 19:51:20 +0000 | [diff] [blame] | 107 | |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 108 | /** |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 109 | * @return the BatchStat instance or null. |
| 110 | */ |
| 111 | BatchStat getBatchStatter(); |
| 112 | |
| 113 | /** |
| 114 | * @return true iff createSymlinkTree() is available. |
| 115 | */ |
| 116 | boolean canCreateSymlinkTree(); |
| 117 | |
| 118 | /** |
| 119 | * Creates the symlink tree |
| 120 | * |
| 121 | * @param inputPath the input manifest |
| 122 | * @param outputPath the output manifest |
| 123 | * @param filesetTree is true iff we're constructing a Fileset |
| 124 | * @param symlinkTreeRoot the symlink tree root, relative to the execRoot |
| 125 | * @throws ExecException on failure |
| 126 | * @throws InterruptedException |
| 127 | */ |
| 128 | void createSymlinkTree(Path inputPath, Path outputPath, boolean filesetTree, |
| 129 | PathFragment symlinkTreeRoot) throws ExecException, InterruptedException; |
| 130 | |
| 131 | /** |
| 132 | * Cleans the entire output tree. |
| 133 | * |
| 134 | * @throws ExecException on failure |
| 135 | * @throws InterruptedException |
| 136 | */ |
| 137 | void clean() throws ExecException, InterruptedException; |
| 138 | |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 139 | /** @return true iff the file actually lives on a remote server */ |
| 140 | boolean isRemoteFile(Artifact file); |
| 141 | |
buchgr | 7b51552 | 2019-03-29 04:42:17 -0700 | [diff] [blame] | 142 | default ActionFileSystemType actionFileSystemType() { |
| 143 | return ActionFileSystemType.DISABLED; |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 144 | } |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 145 | |
| 146 | /** |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 147 | * @param sourceDelegate filesystem for reading source files (excludes output files) |
| 148 | * @param execRootFragment absolute path fragment pointing to the execution root |
| 149 | * @param relativeOutputPath execution root relative path to output |
| 150 | * @param sourceRoots list of directories on the package path (from {@link |
| 151 | * com.google.devtools.build.lib.pkgcache.PathPackageLocator}) |
| 152 | * @param inputArtifactData information about required inputs to the action |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 153 | * @param outputArtifacts required outputs of the action |
shahan | 5b0e071 | 2018-10-17 07:41:03 -0700 | [diff] [blame] | 154 | * @param sourceArtifactFactory obtains source artifacts from source exec paths |
buchgr | 7b51552 | 2019-03-29 04:42:17 -0700 | [diff] [blame] | 155 | * @return an action-scoped filesystem if {@link #supportsActionFileSystem} is not {@code NONE} |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 156 | */ |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 157 | @Nullable |
| 158 | default FileSystem createActionFileSystem( |
| 159 | FileSystem sourceDelegate, |
| 160 | PathFragment execRootFragment, |
| 161 | String relativeOutputPath, |
| 162 | ImmutableList<Root> sourceRoots, |
| 163 | ActionInputMap inputArtifactData, |
shahan | 5b0e071 | 2018-10-17 07:41:03 -0700 | [diff] [blame] | 164 | Iterable<Artifact> outputArtifacts, |
| 165 | Function<PathFragment, SourceArtifact> sourceArtifactFactory) { |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 166 | return null; |
| 167 | } |
| 168 | |
| 169 | /** |
tomlu | 880508c | 2018-08-03 11:21:29 -0700 | [diff] [blame] | 170 | * Updates the context used by the filesystem returned by {@link #createActionFileSystem}. |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 171 | * |
| 172 | * <p>Should be called as context changes throughout action execution. |
| 173 | * |
tomlu | 880508c | 2018-08-03 11:21:29 -0700 | [diff] [blame] | 174 | * @param actionFileSystem must be a filesystem returned by {@link #createActionFileSystem}. |
felly | 943a9c7 | 2018-08-09 12:55:47 -0700 | [diff] [blame] | 175 | * @param filesets The Fileset symlinks known for this action. |
shahan | e35e8cf | 2018-06-18 08:14:01 -0700 | [diff] [blame] | 176 | */ |
| 177 | default void updateActionFileSystemContext( |
tomlu | 73eccc2 | 2018-09-06 08:02:37 -0700 | [diff] [blame] | 178 | FileSystem actionFileSystem, |
| 179 | Environment env, |
| 180 | MetadataConsumer consumer, |
| 181 | ImmutableMap<Artifact, ImmutableList<FilesetOutputSymlink>> filesets) |
felly | 943a9c7 | 2018-08-09 12:55:47 -0700 | [diff] [blame] | 182 | throws IOException {} |
tomlu | 880508c | 2018-08-03 11:21:29 -0700 | [diff] [blame] | 183 | |
| 184 | default boolean supportsPathResolverForArtifactValues() { |
| 185 | return false; |
| 186 | } |
| 187 | |
| 188 | default ArtifactPathResolver createPathResolverForArtifactValues( |
| 189 | PathFragment execRoot, |
felly | 2765ca4 | 2018-12-28 13:38:55 -0800 | [diff] [blame] | 190 | String relativeOutputPath, |
tomlu | 880508c | 2018-08-03 11:21:29 -0700 | [diff] [blame] | 191 | FileSystem fileSystem, |
| 192 | ImmutableList<Root> pathEntries, |
tomlu | fe1dd88 | 2018-08-15 12:17:42 -0700 | [diff] [blame] | 193 | ActionInputMap actionInputMap, |
felly | 5d5da7a | 2019-01-11 10:59:20 -0800 | [diff] [blame] | 194 | Map<Artifact, Collection<Artifact>> expandedArtifacts, |
felly | f6408d6 | 2019-07-16 12:51:14 -0700 | [diff] [blame] | 195 | Map<Artifact, ImmutableList<FilesetOutputSymlink>> filesets) |
| 196 | throws IOException { |
tomlu | 880508c | 2018-08-03 11:21:29 -0700 | [diff] [blame] | 197 | throw new IllegalStateException("Path resolver not supported by this class"); |
| 198 | } |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 199 | } |