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
|
// 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.
#include "src/buildtool/build_engine/target_map/export.hpp"
#include <unordered_set>
#include "src/buildtool/build_engine/base_maps/field_reader.hpp"
#include "src/buildtool/build_engine/expression/configuration.hpp"
#include "src/buildtool/common/statistics.hpp"
#include "src/buildtool/storage/storage.hpp"
namespace {
auto const kExpectedFields = std::unordered_set<std::string>{"config_doc",
"doc",
"fixed_config",
"flexible_config",
"target",
"type"};
void FinalizeExport(
const std::vector<AnalysedTargetPtr const*>& exported,
const BuildMaps::Base::EntityName& target,
const std::vector<std::string>& vars,
const Configuration& effective_config,
const std::optional<TargetCacheKey>& target_cache_key,
const BuildMaps::Target::TargetMap::LoggerPtr& logger,
const BuildMaps::Target::TargetMap::SetterPtr& setter,
const gsl::not_null<BuildMaps::Target::ResultTargetMap*>& result_map) {
const auto* value = exported[0];
if (not(*value)->Tainted().empty()) {
(*logger)("Only untainted targets can be exported.", true);
return;
}
auto provides = (*value)->Provides();
if (not provides->IsCacheable()) {
(*logger)(fmt::format("Only cacheable values can be exported; but "
"target provides {}",
provides->ToString()),
true);
return;
}
auto deps_info = TargetGraphInformation{
std::make_shared<BuildMaps::Target::ConfiguredTarget>(
BuildMaps::Target::ConfiguredTarget{target, effective_config}),
{(*value)->GraphInformation().Node()},
{},
{}};
std::unordered_set<std::string> vars_set{};
vars_set.insert(vars.begin(), vars.end());
auto analysis_result = std::make_shared<AnalysedTarget const>(
TargetResult{(*value)->Artifacts(), provides, (*value)->RunFiles()},
std::vector<ActionDescription::Ptr>{},
std::vector<std::string>{},
std::vector<Tree::Ptr>{},
std::move(vars_set),
std::set<std::string>{},
std::move(deps_info));
analysis_result = result_map->Add(target,
effective_config,
std::move(analysis_result),
target_cache_key,
true);
(*setter)(std::move(analysis_result));
}
[[nodiscard]] auto ComputeTargetCacheKey(
BuildMaps::Base::EntityName const& exported_target,
Configuration const& target_config) -> std::optional<TargetCacheKey> {
static auto const& repos = RepositoryConfig::Instance();
auto const& target_name = exported_target.GetNamedTarget();
if (auto repo_key = repos.RepositoryKey(target_name.repository)) {
return TargetCacheKey::Create(*repo_key, target_name, target_config);
}
return std::nullopt;
}
} // namespace
void ExportRule(
const nlohmann::json& desc_json,
const BuildMaps::Target::ConfiguredTarget& key,
const BuildMaps::Target::TargetMap::SubCallerPtr& subcaller,
const BuildMaps::Target::TargetMap::SetterPtr& setter,
const BuildMaps::Target::TargetMap::LoggerPtr& logger,
const gsl::not_null<BuildMaps::Target::ResultTargetMap*> result_map) {
auto desc = BuildMaps::Base::FieldReader::CreatePtr(
desc_json, key.target, "export target", logger);
desc->ExpectFields(kExpectedFields);
auto exported_target_name = desc->ReadExpression("target");
if (not exported_target_name) {
return;
}
auto exported_target = BuildMaps::Base::ParseEntityNameFromExpression(
exported_target_name,
key.target,
[&logger, &exported_target_name](std::string const& parse_err) {
(*logger)(fmt::format("Parsing target name {} failed with:\n{}",
exported_target_name->ToString(),
parse_err),
true);
});
if (not exported_target) {
return;
}
auto flexible_vars = desc->ReadStringList("flexible_config");
if (not flexible_vars) {
return;
}
auto effective_config = key.config.Prune(*flexible_vars);
auto fixed_config =
desc->ReadOptionalExpression("fixed_config", Expression::kEmptyMap);
if (not fixed_config->IsMap()) {
(*logger)(fmt::format("fixed_config has to be a map, but found {}",
fixed_config->ToString()),
true);
return;
}
for (auto const& var : fixed_config->Map().Keys()) {
if (effective_config.VariableFixed(var)) {
(*logger)(
fmt::format("Variable {} is both fixed and flexible.", var),
true);
return;
}
}
auto target_config = effective_config.Update(fixed_config);
auto target_cache_key =
ComputeTargetCacheKey(*exported_target, target_config);
if (target_cache_key) {
if (auto target_cache_value =
Storage::Instance().TargetCache().Read(*target_cache_key)) {
auto const& [entry, info] = *target_cache_value;
if (auto result = entry.ToResult()) {
auto deps_info = TargetGraphInformation{
std::make_shared<BuildMaps::Target::ConfiguredTarget>(
BuildMaps::Target::ConfiguredTarget{key.target,
effective_config}),
{},
{},
{}};
auto analysis_result = std::make_shared<AnalysedTarget const>(
*result,
std::vector<ActionDescription::Ptr>{},
std::vector<std::string>{},
std::vector<Tree::Ptr>{},
std::unordered_set<std::string>{flexible_vars->begin(),
flexible_vars->end()},
std::set<std::string>{},
deps_info);
analysis_result = result_map->Add(key.target,
effective_config,
std::move(analysis_result),
std::nullopt,
true);
Logger::Log(LogLevel::Performance,
"Export target {} served from cache: {} -> {}",
key.target.ToString(),
target_cache_key->Id().ToString(),
info.ToString());
(*setter)(std::move(analysis_result));
Statistics::Instance().IncrementExportsCachedCounter();
return;
}
(*logger)(fmt::format("Reading target entry for key {} failed",
target_cache_key->Id().ToString()),
false);
}
else {
Statistics::Instance().IncrementExportsUncachedCounter();
Logger::Log(LogLevel::Performance,
"Export target {} registered for caching: {}",
key.target.ToString(),
target_cache_key->Id().ToString());
}
}
else {
Statistics::Instance().IncrementExportsNotEligibleCounter();
Logger::Log(LogLevel::Performance,
"Export target {} is not eligible for target caching",
key.target.ToString());
}
(*subcaller)(
{BuildMaps::Target::ConfiguredTarget{std::move(*exported_target),
std::move(target_config)}},
[setter,
logger,
vars = std::move(*flexible_vars),
result_map,
effective_config = std::move(effective_config),
target_cache_key = std::move(target_cache_key),
target = key.target](auto const& values) {
FinalizeExport(values,
target,
vars,
effective_config,
target_cache_key,
logger,
setter,
result_map);
},
logger);
}
|
