summaryrefslogtreecommitdiff
path: root/src/buildtool/storage/target_cache_entry.cpp
blob: 455569541661fa1923c1c7d6038eb04dd767851a (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
// 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/storage/target_cache_entry.hpp"

#include <algorithm>
#include <exception>
#include <iterator>
#include <memory>
#include <string>
#include <vector>

#include "src/buildtool/build_engine/expression/expression_ptr.hpp"
#include "src/buildtool/common/artifact_digest.hpp"
#include "src/buildtool/common/artifact_digest_factory.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/expected.hpp"
#include "src/utils/cpp/gsl.hpp"

auto TargetCacheEntry::FromTarget(
    HashFunction::Type hash_type,
    AnalysedTargetPtr const& target,
    std::unordered_map<ArtifactDescription, Artifact::ObjectInfo> const&
        replacements) noexcept -> std::optional<TargetCacheEntry> {
    auto result = TargetResult{.artifact_stage = target->Artifacts(),
                               .provides = target->Provides(),
                               .runfiles = target->RunFiles()};
    auto desc = result.ReplaceNonKnownAndToJson(replacements);
    if (not desc) {
        return std::nullopt;
    }
    std::vector<std::string> implied{};
    for (auto const& x : target->ImpliedExport()) {
        implied.emplace_back(x);
    }
    if (not implied.empty()) {
        (*desc)["implied export targets"] = implied;
    }
    return TargetCacheEntry{hash_type, *desc};
}

auto TargetCacheEntry::FromJson(HashFunction::Type hash_type,
                                nlohmann::json desc) noexcept
    -> TargetCacheEntry {
    return TargetCacheEntry(hash_type, std::move(desc));
}

auto TargetCacheEntry::ToResult() const noexcept
    -> std::optional<TargetResult> {
    return TargetResult::FromJson(hash_type_, desc_);
}

auto TargetCacheEntry::ToImplied() const noexcept -> std::set<std::string> {
    std::set<std::string> result{};
    if (desc_.contains("implied export targets")) {
        try {
            for (auto const& x : desc_["implied export targets"]) {
                result.emplace(x);
            }
        } catch (std::exception const& ex) {
            Logger::Log(LogLevel::Warning,
                        "Exception reading implied export targets: {}",
                        ex.what());
        }
    }
    return result;
}

auto TargetCacheEntry::ToImpliedIds(std::string const& entry_key_hash)
    const noexcept -> std::optional<std::vector<Artifact::ObjectInfo>> {
    std::vector<Artifact::ObjectInfo> result{};
    if (desc_.contains("implied export targets")) {
        try {
            for (auto const& x : desc_["implied export targets"]) {
                if (x != entry_key_hash) {
                    auto digest = ArtifactDigestFactory::Create(
                        hash_type_, x, 0, /*is_tree=*/false);
                    if (not digest) {
                        Logger::Log(
                            LogLevel::Debug, "{}", std::move(digest).error());
                        return std::nullopt;
                    }
                    result.emplace_back(
                        Artifact::ObjectInfo{.digest = *std::move(digest),
                                             .type = ObjectType::File});
                }
            }
        } catch (std::exception const& ex) {
            Logger::Log(LogLevel::Warning,
                        "Exception reading implied export targets: {}",
                        ex.what());
            return std::nullopt;
        }
    }
    return result;
}

[[nodiscard]] static auto ToObjectInfo(HashFunction::Type hash_type,
                                       nlohmann::json const& json)
    -> Artifact::ObjectInfo {
    auto const desc = ArtifactDescription::FromJson(hash_type, json);
    // The assumption is that all artifacts mentioned in a target cache
    // entry are KNOWN to the remote side.
    ExpectsAudit(desc and desc->IsKnown());
    auto const& info = desc->ToArtifact().Info();
    ExpectsAudit(info);
    return *info;
}

[[nodiscard]] static auto ScanArtifactMap(
    HashFunction::Type hash_type,
    gsl::not_null<std::vector<Artifact::ObjectInfo>*> const& infos,
    nlohmann::json const& json) -> bool {
    if (not json.is_object()) {
        return false;
    }
    infos->reserve(infos->size() + json.size());
    std::transform(json.begin(),
                   json.end(),
                   std::back_inserter(*infos),
                   [hash_type](auto const& item) {
                       return ToObjectInfo(hash_type, item);
                   });
    return true;
}

[[nodiscard]] static auto ScanProvidesMap(
    HashFunction::Type hash_type,
    gsl::not_null<std::vector<Artifact::ObjectInfo>*> const& infos,
    nlohmann::json const& json) -> bool {
    if (not json.is_object()) {
        return false;
    }
    auto const& nodes = json["nodes"];
    auto const& provided_artifacts = json["provided_artifacts"];
    infos->reserve(infos->size() + provided_artifacts.size());
    std::transform(provided_artifacts.begin(),
                   provided_artifacts.end(),
                   std::back_inserter(*infos),
                   [hash_type, &nodes](auto const& item) {
                       return ToObjectInfo(
                           hash_type, nodes[item.template get<std::string>()]);
                   });
    return true;
}

auto TargetCacheEntry::ToArtifacts(
    gsl::not_null<std::vector<Artifact::ObjectInfo>*> const& infos)
    const noexcept -> bool {
    try {
        if (ScanArtifactMap(hash_type_, infos, desc_["artifacts"]) and
            ScanArtifactMap(hash_type_, infos, desc_["runfiles"]) and
            ScanProvidesMap(hash_type_, infos, desc_["provides"])) {
            return true;
        }
    } catch (std::exception const& ex) {
        Logger::Log(
            LogLevel::Error,
            "Scanning target cache entry for artifacts failed with:\n{}",
            ex.what());
    }
    return false;
}