1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
// Copyright 2022 Huawei Cloud Computing Technology Co., Ltd.
//
// 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.
#ifndef INCLUDED_SRC_BUILDTOOL_EXECUTION_API_LOCAL_LOCAL_ACTION_HPP
#define INCLUDED_SRC_BUILDTOOL_EXECUTION_API_LOCAL_LOCAL_ACTION_HPP
#include <algorithm>
#include <chrono>
#include <compare>
#include <cstdint>
#include <filesystem>
#include <functional> // IWYU pragma: keep
#include <map>
#include <optional>
#include <string>
#include <unordered_map>
#include <utility> // std::move
#include <variant>
#include <vector>
#include "gsl/gsl"
#include "src/buildtool/common/artifact.hpp"
#include "src/buildtool/common/artifact_digest.hpp"
#include "src/buildtool/common/bazel_types.hpp"
#include "src/buildtool/crypto/hash_function.hpp"
#include "src/buildtool/execution_api/bazel_msg/bazel_msg_factory.hpp"
#include "src/buildtool/execution_api/common/execution_action.hpp"
#include "src/buildtool/execution_api/common/execution_response.hpp"
#include "src/buildtool/execution_api/local/context.hpp"
#include "src/buildtool/logging/logger.hpp"
#include "src/buildtool/storage/config.hpp"
#include "src/utils/cpp/tmp_dir.hpp"
/// \brief Action for local execution.
class LocalAction final : public IExecutionAction {
friend class LocalApi;
enum class RequestMode : std::uint8_t {
kV2_0, // RBEv2.0
kV2_1, // >=RBEv2.1
kBestEffort // construct both, let the server pick
};
public:
struct Output {
bazel_re::ActionResult action;
bool is_cached{};
double duration{};
};
using OutputFileOrSymlink =
std::variant<bazel_re::OutputFile, bazel_re::OutputSymlink>;
using OutputDirOrSymlink =
std::variant<bazel_re::OutputDirectory, bazel_re::OutputSymlink>;
using OutputPath = std::variant<bazel_re::OutputFile,
bazel_re::OutputDirectory,
bazel_re::OutputSymlink>;
using FileCopies = std::unordered_map<Artifact::ObjectInfo, TmpDir::Ptr>;
auto Execute(Logger const* logger) noexcept
-> IExecutionResponse::Ptr final;
void SetCacheFlag(CacheFlag flag) noexcept final { cache_flag_ = flag; }
void SetTimeout(std::chrono::milliseconds timeout) noexcept final {
timeout_ = timeout;
}
private:
Logger logger_{"LocalExecution"};
LocalContext const& local_context_;
ArtifactDigest const root_digest_;
std::vector<std::string> const cmdline_;
std::string const cwd_;
std::vector<std::string> output_files_;
std::vector<std::string> output_dirs_;
std::vector<std::string> output_paths_;
std::map<std::string, std::string> const env_vars_;
std::vector<bazel_re::Platform_Property> const properties_;
std::chrono::milliseconds timeout_{kDefaultTimeout};
CacheFlag cache_flag_{CacheFlag::CacheOutput};
RequestMode mode_{};
explicit LocalAction(gsl::not_null<LocalContext const*> local_context,
ArtifactDigest root_digest,
std::vector<std::string> command,
std::string cwd,
std::vector<std::string> output_files,
std::vector<std::string> output_dirs,
std::map<std::string, std::string> env_vars,
std::map<std::string, std::string> const& properties,
bool best_effort) noexcept
: local_context_{*local_context},
root_digest_{std::move(root_digest)},
cmdline_{std::move(command)},
cwd_{std::move(cwd)},
output_files_{std::move(output_files)},
output_dirs_{std::move(output_dirs)},
env_vars_{std::move(env_vars)},
properties_{BazelMsgFactory::CreateMessageVectorFromMap<
bazel_re::Platform_Property>(properties)},
mode_{best_effort ? RequestMode::kBestEffort : RequestMode::kV2_0} {
std::sort(output_files_.begin(), output_files_.end());
std::sort(output_dirs_.begin(), output_dirs_.end());
if (best_effort) {
output_paths_.reserve(output_files_.size() + output_dirs_.size());
output_paths_.insert(output_paths_.end(),
output_files_.begin(),
output_files_.end());
output_paths_.insert(
output_paths_.end(), output_dirs_.begin(), output_dirs_.end());
std::sort(output_paths_.begin(), output_paths_.end());
}
}
// Alternative constructor with combined output_paths for files and dirs, as
// it is used by RBEv2.1 and above.
explicit LocalAction(
gsl::not_null<LocalContext const*> local_context,
ArtifactDigest root_digest,
std::vector<std::string> command,
std::string cwd,
std::vector<std::string> output_paths,
std::map<std::string, std::string> env_vars,
std::map<std::string, std::string> const& properties) noexcept
: local_context_{*local_context},
root_digest_{std::move(root_digest)},
cmdline_{std::move(command)},
cwd_{std::move(cwd)},
output_paths_{std::move(output_paths)},
env_vars_{std::move(env_vars)},
properties_{BazelMsgFactory::CreateMessageVectorFromMap<
bazel_re::Platform_Property>(properties)},
mode_{RequestMode::kV2_1} {
std::sort(output_paths_.begin(), output_paths_.end());
}
[[nodiscard]] auto CreateActionDigest(ArtifactDigest const& exec_dir,
bool do_not_cache)
-> std::optional<ArtifactDigest> {
auto const env_vars = BazelMsgFactory::CreateMessageVectorFromMap<
bazel_re::Command_EnvironmentVariable>(env_vars_);
BazelMsgFactory::ActionDigestRequest request{
.command_line = &cmdline_,
.cwd = &cwd_,
.output_files = &output_files_,
.output_dirs = &output_dirs_,
.output_paths = &output_paths_,
.env_vars = &env_vars,
.properties = &properties_,
.exec_dir = &exec_dir,
.hash_function = local_context_.storage_config->hash_function,
.timeout = timeout_,
.skip_action_cache = do_not_cache};
return BazelMsgFactory::CreateActionDigestFromCommandLine(request);
}
[[nodiscard]] auto Run(ArtifactDigest const& action_id) const noexcept
-> std::optional<Output>;
[[nodiscard]] auto StageInput(
std::filesystem::path const& target_path,
Artifact::ObjectInfo const& info,
gsl::not_null<FileCopies*> copies) const noexcept -> bool;
/// \brief Stage input artifacts and leaf trees to the execution directory.
/// Stage artifacts and their parent directory structure from CAS to the
/// specified execution directory. The execution directory may no exist.
/// \param[in] exec_path Absolute path to the execution directory.
/// \returns Success indicator.
[[nodiscard]] auto StageInputs(
std::filesystem::path const& exec_path,
gsl::not_null<FileCopies*> copies) const noexcept -> bool;
[[nodiscard]] auto CreateDirectoryStructure(
std::filesystem::path const& exec_path) const noexcept -> bool;
[[nodiscard]] auto CollectOutputFileOrSymlink(
std::filesystem::path const& exec_path,
std::string const& local_path) const noexcept
-> std::optional<OutputFileOrSymlink>;
[[nodiscard]] auto CollectOutputDirOrSymlink(
std::filesystem::path const& exec_path,
std::string const& local_path) const noexcept
-> std::optional<OutputDirOrSymlink>;
[[nodiscard]] auto CollectOutputPath(std::filesystem::path const& exec_path,
std::string const& local_path)
const noexcept -> std::optional<OutputPath>;
[[nodiscard]] auto CollectAndStoreOutputs(
bazel_re::ActionResult* result,
std::filesystem::path const& exec_path) const noexcept -> bool;
/// \brief Store file from path in file CAS and return pointer to digest.
[[nodiscard]] auto DigestFromOwnedFile(
std::filesystem::path const& file_path) const noexcept
-> std::optional<ArtifactDigest>;
};
#endif // INCLUDED_SRC_BUILDTOOL_EXECUTION_API_LOCAL_LOCAL_ACTION_HPP
|
