summaryrefslogtreecommitdiff
path: root/src/buildtool/build_engine/target_map/utils.cpp
blob: 24e0e8a7d416386d0c2399f18b98e051b76eec7d (plain)
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
// 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/utils.hpp"

#include <algorithm>
#include <filesystem>
#include <unordered_set>
#include <vector>

#include "src/utils/cpp/path.hpp"

auto BuildMaps::Target::Utils::obtainTargetByName(
    const SubExprEvaluator& eval,
    const ExpressionPtr& expr,
    const Configuration& env,
    const Base::EntityName& current,
    std::unordered_map<BuildMaps::Target::ConfiguredTarget,
                       AnalysedTargetPtr> const& deps_by_transition)
    -> AnalysedTargetPtr {
    auto const& empty_map_exp = Expression::kEmptyMapExpr;
    auto reference = eval(expr["dep"], env);
    std::string error{};
    auto target = BuildMaps::Base::ParseEntityNameFromExpression(
        reference, current, [&error](std::string const& parse_err) {
            error = parse_err;
        });
    if (not target) {
        throw Evaluator::EvaluationError{
            fmt::format("Parsing target name {} failed with:\n{}",
                        reference->ToString(),
                        error)};
    }
    auto transition = eval(expr->Get("transition", empty_map_exp), env);
    auto it = deps_by_transition.find(BuildMaps::Target::ConfiguredTarget{
        *target, Configuration{transition}});
    if (it == deps_by_transition.end()) {
        throw Evaluator::EvaluationError{fmt::format(
            "Reference to undeclared dependency {} in transition {}",
            reference->ToString(),
            transition->ToString())};
    }
    return it->second;
}

auto BuildMaps::Target::Utils::obtainTarget(
    const SubExprEvaluator& eval,
    const ExpressionPtr& expr,
    const Configuration& env,
    std::unordered_map<BuildMaps::Target::ConfiguredTarget,
                       AnalysedTargetPtr> const& deps_by_transition)
    -> AnalysedTargetPtr {
    auto const& empty_map_exp = Expression::kEmptyMapExpr;
    auto reference = eval(expr["dep"], env);
    if (not reference->IsName()) {
        throw Evaluator::EvaluationError{
            fmt::format("Not a target name: {}", reference->ToString())};
    }
    auto transition = eval(expr->Get("transition", empty_map_exp), env);
    auto it = deps_by_transition.find(BuildMaps::Target::ConfiguredTarget{
        reference->Name(), Configuration{transition}});
    if (it == deps_by_transition.end()) {
        throw Evaluator::EvaluationError{fmt::format(
            "Reference to undeclared dependency {} in transition {}",
            reference->ToString(),
            transition->ToString())};
    }
    return it->second;
}

auto BuildMaps::Target::Utils::keys_expr(const ExpressionPtr& map)
    -> ExpressionPtr {
    auto const& m = map->Map();
    auto result = Expression::list_t{};
    result.reserve(m.size());
    std::for_each(m.begin(), m.end(), [&](auto const& item) {
        result.emplace_back(ExpressionPtr{item.first});
    });
    return ExpressionPtr{result};
}

auto BuildMaps::Target::Utils::artifacts_tree(const ExpressionPtr& map)
    -> std::variant<std::string, ExpressionPtr> {
    auto result = Expression::map_t::underlying_map_t{};
    for (auto const& [key, artifact] : map->Map()) {
        auto location = ToNormalPath(std::filesystem::path{key}).string();
        if (auto it = result.find(location);
            it != result.end() && !(it->second == artifact)) {
            return location;
        }
        result.emplace(std::move(location), artifact);
    }
    return ExpressionPtr{Expression::map_t{result}};
}

auto BuildMaps::Target::Utils::tree_conflict(const ExpressionPtr& map)
    -> std::optional<std::string> {
    // Work around the fact that std::hash<std::filesystem::path> is missing
    // in some libraries
    struct PathHash {
        auto operator()(std::filesystem::path const& p) const noexcept
            -> std::size_t {
            return std::filesystem::hash_value(p);
        }
    };
    std::unordered_set<std::filesystem::path, PathHash> blocked{};
    blocked.reserve(map->Map().size());

    for (auto const& [path, artifact] : map->Map()) {
        if (path == "." and map->Map().size() > 1) {
            return ".";
        }
        auto p = std::filesystem::path{path};
        if (p.is_absolute()) {
            return p.string();
        }
        if (*p.begin() == "..") {
            return p.string();
        }
        auto insert_result = blocked.insert(p);
        if (not insert_result.second) {
            return p.string();  // duplicate path
        }
        for (p = p.parent_path(); not p.empty(); p = p.parent_path()) {
            if (blocked.contains(p)) {
                // Another artifact at a parent path position
                return p.string();
            }
        }
    }
    return std::nullopt;
}

auto BuildMaps::Target::Utils::getTainted(
    std::set<std::string>* tainted,
    const Configuration& config,
    const ExpressionPtr& tainted_exp,
    const BuildMaps::Target::TargetMap::LoggerPtr& logger) -> bool {
    if (not tainted_exp) {
        return false;
    }
    auto tainted_val =
        tainted_exp.Evaluate(config, {}, [logger](auto const& msg) {
            (*logger)(fmt::format("While evaluating tainted:\n{}", msg), true);
        });
    if (not tainted_val) {
        return false;
    }
    if (not tainted_val->IsList()) {
        (*logger)(fmt::format("tainted should evaluate to a list of strings, "
                              "but got {}",
                              tainted_val->ToString()),
                  true);
        return false;
    }
    for (auto const& entry : tainted_val->List()) {
        if (not entry->IsString()) {
            (*logger)(fmt::format("tainted should evaluate to a list of "
                                  "strings, but got {}",
                                  tainted_val->ToString()),
                      true);
            return false;
        }
        tainted->insert(entry->String());
    }
    return true;
}

namespace {
auto hash_vector(std::vector<std::string> const& vec) -> std::string {
    auto hasher = HashFunction::Hasher();
    for (auto const& s : vec) {
        hasher.Update(HashFunction::ComputeHash(s).Bytes());
    }
    return std::move(hasher).Finalize().Bytes();
}
}  // namespace

auto BuildMaps::Target::Utils::createAction(
    const ActionDescription::outputs_t& output_files,
    const ActionDescription::outputs_t& output_dirs,
    std::vector<std::string> command,
    const ExpressionPtr& env,
    std::optional<std::string> may_fail,
    bool no_cache,
    double timeout_scale,
    const ExpressionPtr& inputs_exp) -> ActionDescription::Ptr {
    auto hasher = HashFunction::Hasher();
    hasher.Update(hash_vector(output_files));
    hasher.Update(hash_vector(output_dirs));
    hasher.Update(hash_vector(command));
    hasher.Update(env->ToHash());
    hasher.Update(hash_vector(may_fail ? std::vector<std::string>{*may_fail}
                                       : std::vector<std::string>{}));
    hasher.Update(no_cache ? std::string{"N"} : std::string{"Y"});
    hasher.Update(fmt::format("{:+24a}", timeout_scale));
    hasher.Update(inputs_exp->ToHash());

    auto action_id = std::move(hasher).Finalize().HexString();

    std::map<std::string, std::string> env_vars{};
    for (auto const& [env_var, env_value] : env->Map()) {
        env_vars.emplace(env_var, env_value->String());
    }
    ActionDescription::inputs_t inputs;
    inputs.reserve(inputs_exp->Map().size());
    for (auto const& [input_path, artifact] : inputs_exp->Map()) {
        inputs.emplace(input_path, artifact->Artifact());
    }
    return std::make_shared<ActionDescription>(output_files,
                                               output_dirs,
                                               Action{std::move(action_id),
                                                      std::move(command),
                                                      std::move(env_vars),
                                                      std::move(may_fail),
                                                      no_cache,
                                                      timeout_scale},
                                               std::move(inputs));
}