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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
// Copyright 2024 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.
#include "src/buildtool/execution_api/local/local_cas_reader.hpp"
#include <algorithm>
#include <compare>
#include <cstddef>
#include <deque>
#include <exception>
#include <memory>
#include <stack>
#include <type_traits>
#include <unordered_map>
#include <utility>
#include <vector>
#include "fmt/core.h"
#include "google/protobuf/repeated_ptr_field.h"
#include "src/buildtool/common/artifact_digest_factory.hpp"
#include "src/buildtool/common/protocol_traits.hpp"
#include "src/buildtool/crypto/hash_function.hpp"
#include "src/buildtool/execution_api/bazel_msg/bazel_msg_factory.hpp"
#include "src/buildtool/file_system/file_system_manager.hpp"
#include "src/buildtool/file_system/object_type.hpp"
#include "src/buildtool/logging/log_level.hpp"
#include "src/buildtool/logging/logger.hpp"
#include "src/utils/cpp/incremental_reader.hpp"
#include "src/utils/cpp/path.hpp"
namespace {
[[nodiscard]] auto AssembleTree(
bazel_re::Directory root,
std::unordered_map<ArtifactDigest, bazel_re::Directory> directories)
-> bazel_re::Tree;
} // namespace
auto LocalCasReader::ReadDirectory(ArtifactDigest const& digest) const noexcept
-> std::optional<bazel_re::Directory> {
if (auto const path = cas_.TreePath(digest)) {
if (auto const content = FileSystemManager::ReadFile(*path)) {
return BazelMsgFactory::MessageFromString<bazel_re::Directory>(
*content);
}
}
Logger::Log(
LogLevel::Error, "Directory {} not found in CAS", digest.hash());
return std::nullopt;
}
auto LocalCasReader::MakeTree(ArtifactDigest const& root) const noexcept
-> std::optional<bazel_re::Tree> {
auto const hash_type = cas_.GetHashFunction().GetType();
try {
std::unordered_map<ArtifactDigest, bazel_re::Directory> directories;
std::stack<ArtifactDigest> to_check;
to_check.push(root);
while (not to_check.empty()) {
auto current = to_check.top();
to_check.pop();
if (directories.contains(current)) {
continue;
}
auto read_dir = ReadDirectory(current);
if (not read_dir) {
return std::nullopt;
}
for (auto const& node : read_dir->directories()) {
auto digest =
ArtifactDigestFactory::FromBazel(hash_type, node.digest());
if (not digest) {
return std::nullopt;
}
to_check.push(*std::move(digest));
}
directories.insert_or_assign(std::move(current),
*std::move(read_dir));
}
auto root_directory = directories.extract(root).mapped();
return AssembleTree(std::move(root_directory), std::move(directories));
} catch (...) {
return std::nullopt;
}
}
auto LocalCasReader::ReadGitTree(ArtifactDigest const& digest) const noexcept
-> std::optional<GitRepo::tree_entries_t> {
if (auto const path = cas_.TreePath(digest)) {
if (auto const content = FileSystemManager::ReadFile(*path)) {
auto check_symlinks =
[&cas = cas_](std::vector<ArtifactDigest> const& ids) {
for (auto const& id : ids) {
auto link_path = cas.BlobPath(id,
/*is_executable=*/false);
if (not link_path) {
return false;
}
// in the local CAS we store as files
auto content = FileSystemManager::ReadFile(*link_path);
if (not content or not PathIsNonUpwards(*content)) {
return false;
}
}
return true;
};
// Git-SHA1 hashing is used for reading from git.
HashFunction const hash_function{HashFunction::Type::GitSHA1};
return GitRepo::ReadTreeData(*content,
digest.hash(),
check_symlinks,
/*is_hex_id=*/true);
}
}
Logger::Log(LogLevel::Debug, "Tree {} not found in CAS", digest.hash());
return std::nullopt;
}
auto LocalCasReader::DumpRawTree(Artifact::ObjectInfo const& info,
DumpCallback const& dumper) const noexcept
-> bool {
auto path = cas_.TreePath(info.digest);
return path ? DumpRaw(*path, dumper) : false;
}
auto LocalCasReader::DumpBlob(Artifact::ObjectInfo const& info,
DumpCallback const& dumper) const noexcept
-> bool {
auto path = cas_.BlobPath(info.digest, IsExecutableObject(info.type));
return path ? DumpRaw(*path, dumper) : false;
}
auto LocalCasReader::StageBlobTo(
Artifact::ObjectInfo const& info,
std::filesystem::path const& output) const noexcept -> bool {
if (not IsBlobObject(info.type)) {
return false;
}
auto const blob_path =
cas_.BlobPath(info.digest, IsExecutableObject(info.type));
if (not blob_path) {
return false;
}
return FileSystemManager::CreateDirectory(output.parent_path()) and
FileSystemManager::CopyFileAs</*kSetEpochTime=*/true,
/*kSetWritable=*/true>(
*blob_path, output, info.type);
}
auto LocalCasReader::DumpRaw(std::filesystem::path const& path,
DumpCallback const& dumper) noexcept -> bool {
constexpr std::size_t kChunkSize{512};
auto to_read = IncrementalReader::FromFile(kChunkSize, path);
if (not to_read.has_value()) {
return false;
}
return std::all_of(
to_read->begin(), to_read->end(), [&dumper](auto const& chunk) {
return chunk.has_value() and
std::invoke(dumper, std::string{chunk.value()});
});
}
auto LocalCasReader::IsNativeProtocol() const noexcept -> bool {
return ProtocolTraits::IsNative(cas_.GetHashFunction().GetType());
}
auto LocalCasReader::IsDirectoryValid(ArtifactDigest const& digest)
const noexcept -> expected<bool, std::string> {
try {
auto const hash_type = cas_.GetHashFunction().GetType();
// read directory
if (auto const path = cas_.TreePath(digest)) {
if (auto const content = FileSystemManager::ReadFile(*path)) {
auto dir =
BazelMsgFactory::MessageFromString<bazel_re::Directory>(
*content);
// check symlinks
for (auto const& l : dir->symlinks()) {
if (not PathIsNonUpwards(l.target())) {
return false;
}
}
// traverse subdirs
for (auto const& d : dir->directories()) {
auto subdir_digest =
ArtifactDigestFactory::FromBazel(hash_type, d.digest());
if (not subdir_digest) {
return unexpected{std::move(subdir_digest).error()};
}
auto subdir_result =
IsDirectoryValid(*std::move(subdir_digest));
if (not subdir_result) {
return unexpected{std::move(subdir_result).error()};
}
if (not std::move(subdir_result).value()) {
return false;
}
}
return true;
}
}
return unexpected{
fmt::format("Directory {} not found in CAS", digest.hash())};
} catch (std::exception const& ex) {
return unexpected{fmt::format(
"An error occurred checking validity of bazel directory:\n{}",
ex.what())};
}
}
namespace {
[[nodiscard]] auto AssembleTree(
bazel_re::Directory root,
std::unordered_map<ArtifactDigest, bazel_re::Directory> directories)
-> bazel_re::Tree {
using Pair = std::pair<ArtifactDigest const, bazel_re::Directory>;
std::vector<Pair*> sorted;
sorted.reserve(directories.size());
for (auto& p : directories) {
sorted.push_back(&p);
}
std::sort(sorted.begin(), sorted.end(), [](Pair const* l, Pair const* r) {
return l->first.hash() < r->first.hash();
});
::bazel_re::Tree result{};
(*result.mutable_root()) = std::move(root);
result.mutable_children()->Reserve(gsl::narrow<int>(sorted.size()));
std::transform(sorted.begin(),
sorted.end(),
::pb::back_inserter(result.mutable_children()),
[](Pair* p) { return std::move(p->second); });
return result;
}
} // namespace
|
