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
|
// 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_STORAGE_TARGET_CACHE_TPP
#define INCLUDED_SRC_BUILDTOOL_STORAGE_TARGET_CACHE_TPP
// IWYU pragma: private, include "src/buildtool/storage/target_cache.hpp"
#include <exception>
#include <tuple> //std::ignore
#include "nlohmann/json.hpp"
#include "src/buildtool/crypto/hash_function.hpp"
#include "src/buildtool/storage/target_cache.hpp"
template <bool kDoGlobalUplink>
auto TargetCache<kDoGlobalUplink>::Store(
TargetCacheKey const& key,
TargetCacheEntry const& value,
ArtifactDownloader const& downloader) const noexcept -> bool {
if (not DownloadKnownArtifacts(value, downloader)) {
return false;
}
if (auto digest = cas_.StoreBlob(value.ToJson().dump(2))) {
auto data = Artifact::ObjectInfo{*digest, ObjectType::File}.ToString();
logger_->Emit(LogLevel::Debug,
"Adding entry for key {} as {}",
key.Id().ToString(),
data);
return file_store_.AddFromBytes(key.Id().digest.hash(), data);
}
return false;
}
template <bool kDoGlobalUplink>
auto TargetCache<kDoGlobalUplink>::ComputeKey(
ArtifactDigest const& repo_key,
BuildMaps::Base::NamedTarget const& target_name,
Configuration const& effective_config) const noexcept
-> std::optional<TargetCacheKey> {
try {
// target's repository is content-fixed, we can compute a cache key
auto target_desc = nlohmann::json{
{"repo_key", repo_key.hash()},
{"target_name",
nlohmann::json{target_name.module, target_name.name}.dump()},
{"effective_config", effective_config.ToString()}};
if (auto target_key =
cas_.StoreBlob(target_desc.dump(2), /*is_executable=*/false)) {
return TargetCacheKey{{*target_key, ObjectType::File}};
}
} catch (std::exception const& ex) {
logger_->Emit(LogLevel::Error,
"Creating target cache key failed with:\n{}",
ex.what());
}
return std::nullopt;
}
template <bool kDoGlobalUplink>
auto TargetCache<kDoGlobalUplink>::Read(
TargetCacheKey const& key) const noexcept
-> std::optional<std::pair<TargetCacheEntry, Artifact::ObjectInfo>> {
auto id = key.Id().digest.hash();
auto entry_path = file_store_.GetPath(id);
if constexpr (kDoGlobalUplink) {
// Uplink any existing target cache entry in storage generations
std::ignore =
uplinker_.UplinkTargetCacheEntry(key, backend_description_);
}
auto const entry =
FileSystemManager::ReadFile(entry_path, ObjectType::File);
if (not entry) {
logger_->Emit(LogLevel::Debug,
"Cache miss, entry not found {}",
entry_path.string());
return std::nullopt;
}
auto const hash_type = cas_.GetHashFunction().GetType();
if (auto info = Artifact::ObjectInfo::FromString(hash_type, *entry)) {
if (auto path = cas_.BlobPath(info->digest, /*is_executable=*/false)) {
if (auto value = FileSystemManager::ReadFile(*path)) {
try {
return std::make_pair(
TargetCacheEntry{hash_type,
nlohmann::json::parse(*value)},
std::move(*info));
} catch (std::exception const& ex) {
logger_->Emit(LogLevel::Warning,
"Parsing entry for key {} failed with:\n{}",
key.Id().ToString(),
ex.what());
}
}
}
}
logger_->Emit(LogLevel::Warning,
"Reading entry for key {} failed",
key.Id().ToString());
return std::nullopt;
}
template <bool kDoGlobalUplink>
template <bool kIsLocalGeneration>
requires(kIsLocalGeneration)
auto TargetCache<kDoGlobalUplink>::LocalUplinkEntry(
LocalGenerationTC const& latest,
TargetCacheKey const& key) const noexcept -> bool {
return LocalUplinkEntry(latest, key.Id().digest.hash());
}
template <bool kDoGlobalUplink>
template <bool kIsLocalGeneration>
requires(kIsLocalGeneration)
auto TargetCache<kDoGlobalUplink>::LocalUplinkEntry(
LocalGenerationTC const& latest,
std::string const& key_digest) const noexcept -> bool {
// Determine target cache key path of given generation.
if (FileSystemManager::IsFile(latest.file_store_.GetPath(key_digest))) {
return true;
}
// Determine target cache entry location.
auto cache_key = file_store_.GetPath(key_digest);
auto raw_key = FileSystemManager::ReadFile(cache_key);
if (not raw_key) {
return false;
}
// Determine target cache entry location.
auto entry_info = Artifact::ObjectInfo::FromString(
cas_.GetHashFunction().GetType(), *raw_key);
if (not entry_info) {
return false;
}
// Determine target cache entry blob path of given generation.
auto cache_entry =
cas_.BlobPath(entry_info->digest, /*is_executable=*/false);
if (not cache_entry) {
return false;
}
// Determine artifacts referenced by target cache entry.
auto raw_entry = FileSystemManager::ReadFile(*cache_entry);
if (not raw_entry) {
return false;
}
nlohmann::json json_desc{};
try {
json_desc = nlohmann::json::parse(*raw_entry);
} catch (std::exception const& ex) {
return false;
}
auto entry =
TargetCacheEntry::FromJson(cas_.GetHashFunction().GetType(), json_desc);
// Uplink the implied export targets first
for (auto const& implied_digest : entry.ToImplied()) {
if (implied_digest != key_digest) {
if (not LocalUplinkEntry(latest, implied_digest)) {
return false;
}
}
}
std::vector<Artifact::ObjectInfo> artifacts_info;
if (not entry.ToArtifacts(&artifacts_info)) {
return false;
}
// Uplink referenced artifacts.
for (auto const& info : artifacts_info) {
if (info.type == ObjectType::Tree) {
if (not cas_.LocalUplinkTree(latest.cas_, info.digest)) {
return false;
}
}
else if (not cas_.LocalUplinkBlob(
latest.cas_, info.digest, IsExecutableObject(info.type))) {
return false;
}
}
// Uplink target cache entry blob.
if (not cas_.LocalUplinkBlob(latest.cas_,
entry_info->digest,
/*is_executable=*/false)) {
return false;
}
// Uplink target cache key
return latest.file_store_.AddFromFile(
key_digest, cache_key, /*is_owner=*/true);
}
template <bool kDoGlobalUplink>
auto TargetCache<kDoGlobalUplink>::DownloadKnownArtifacts(
TargetCacheEntry const& value,
ArtifactDownloader const& downloader) const noexcept -> bool {
std::vector<Artifact::ObjectInfo> artifacts_info;
return downloader and value.ToArtifacts(&artifacts_info) and
downloader(artifacts_info);
}
#endif // INCLUDED_SRC_BUILDTOOL_STORAGE_TARGET_CACHE_TPP
|
