summaryrefslogtreecommitdiff
path: root/src/buildtool/execution_api/execution_service/bytestream_server.cpp
blob: 4a3fa3003ae51069ebe260f118e359d922a8d6da (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
// Copyright 2023 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 "bytestream_server.hpp"

#include <cstddef>
#include <fstream>
#include <sstream>
#include <utility>

#include "fmt/core.h"
#include "src/buildtool/compatibility/native_support.hpp"
#include "src/buildtool/execution_api/common/bytestream_common.hpp"
#include "src/buildtool/execution_api/execution_service/cas_utils.hpp"
#include "src/buildtool/file_system/file_system_manager.hpp"
#include "src/buildtool/logging/log_level.hpp"
#include "src/buildtool/storage/garbage_collector.hpp"
#include "src/utils/cpp/tmp_dir.hpp"
#include "src/utils/cpp/verify_hash.hpp"

namespace {
auto ParseResourceName(std::string const& x) -> std::optional<std::string> {
    // resource name is like this
    // remote-execution/uploads/c4f03510-7d56-4490-8934-01bce1b1288e/blobs/62183d7a696acf7e69e218efc82c93135f8c85f895/4424712
    if (auto end = x.rfind('/'); end != std::string::npos) {
        if (auto start = x.rfind('/', end - 1); start != std::string::npos) {
            return x.substr(start + 1, end - start - 1);
        }
    }
    return std::nullopt;
}
}  // namespace

auto BytestreamServiceImpl::Read(
    ::grpc::ServerContext* /*context*/,
    const ::google::bytestream::ReadRequest* request,
    ::grpc::ServerWriter<::google::bytestream::ReadResponse>* writer)
    -> ::grpc::Status {
    logger_.Emit(LogLevel::Trace, "Read {}", request->resource_name());
    // resource_name is of type
    // remote-execution/blobs/62f408d64bca5de775c4b1dbc3288fc03afd6b19eb/0
    auto hash = ParseResourceName(request->resource_name());
    if (not hash) {
        auto str = fmt::format("could not parse {}", request->resource_name());
        logger_.Emit(LogLevel::Error, "{}", str);
        return ::grpc::Status{::grpc::StatusCode::INVALID_ARGUMENT, str};
    }

    if (auto error_msg = IsAHash(*hash); error_msg) {
        logger_.Emit(LogLevel::Debug, "{}", *error_msg);
        return ::grpc::Status{::grpc::StatusCode::INVALID_ARGUMENT, *error_msg};
    }

    auto lock = GarbageCollector::SharedLock(storage_config_);
    if (not lock) {
        auto str = fmt::format("Could not acquire SharedLock");
        logger_.Emit(LogLevel::Error, str);
        return grpc::Status{grpc::StatusCode::INTERNAL, str};
    }

    std::optional<std::filesystem::path> path{};

    if (NativeSupport::IsTree(*hash)) {
        ArtifactDigest dgst{NativeSupport::Unprefix(*hash), 0, true};
        path = storage_.CAS().TreePath(dgst);
    }
    else {
        ArtifactDigest dgst{NativeSupport::Unprefix(*hash), 0, false};
        path = storage_.CAS().BlobPath(dgst, false);
    }
    if (not path) {
        auto str = fmt::format("could not find {}", *hash);
        logger_.Emit(LogLevel::Error, "{}", str);
        return ::grpc::Status{::grpc::StatusCode::NOT_FOUND, str};
    }

    std::ifstream stream{*path, std::ios::binary};
    stream.seekg(request->read_offset(), std::ios::beg);

    ::google::bytestream::ReadResponse response;
    std::string& buffer = *response.mutable_data();
    buffer.resize(kChunkSize);

    while (not stream.eof()) {
        stream.read(buffer.data(), kChunkSize);
        if (stream.bad()) {
            auto const str = fmt::format("Failed to read data for {}", *hash);
            logger_.Emit(LogLevel::Error, str);
            return grpc::Status{grpc::StatusCode::INTERNAL, str};
        }

        if (stream.eof()) {
            // do not send random bytes
            buffer.resize(static_cast<std::size_t>(stream.gcount()));
        }
        writer->Write(response);
    }
    return ::grpc::Status::OK;
}

auto BytestreamServiceImpl::Write(
    ::grpc::ServerContext* /*context*/,
    ::grpc::ServerReader<::google::bytestream::WriteRequest>* reader,
    ::google::bytestream::WriteResponse* response) -> ::grpc::Status {
    ::google::bytestream::WriteRequest request;
    reader->Read(&request);
    logger_.Emit(LogLevel::Debug, "write {}", request.resource_name());
    auto hash = ParseResourceName(request.resource_name());
    if (not hash) {
        auto str = fmt::format("could not parse {}", request.resource_name());
        logger_.Emit(LogLevel::Error, "{}", str);
        return ::grpc::Status{::grpc::StatusCode::INVALID_ARGUMENT, str};
    }
    if (auto error_msg = IsAHash(*hash); error_msg) {
        logger_.Emit(LogLevel::Debug, "{}", *error_msg);
        return ::grpc::Status{::grpc::StatusCode::INVALID_ARGUMENT, *error_msg};
    }
    logger_.Emit(LogLevel::Trace,
                 "Write: {}, offset {}, finish write {}",
                 *hash,
                 request.write_offset(),
                 request.finish_write());
    auto lock = GarbageCollector::SharedLock(storage_config_);
    if (not lock) {
        auto str = fmt::format("Could not acquire SharedLock");
        logger_.Emit(LogLevel::Error, str);
        return grpc::Status{grpc::StatusCode::INTERNAL, str};
    }
    auto tmp_dir = storage_config_.CreateTypedTmpDir("execution-service");
    if (not tmp_dir) {
        return ::grpc::Status{::grpc::StatusCode::INTERNAL,
                              "could not create TmpDir"};
    }

    auto tmp = tmp_dir->GetPath() / *hash;
    {
        std::ofstream stream{tmp, std::ios::binary};
        do {
            if (not stream.good()) {
                auto const str =
                    fmt::format("Failed to write data for {}", *hash);
                logger_.Emit(LogLevel::Error, "{}", str);
                return ::grpc::Status{::grpc::StatusCode::INTERNAL, str};
            }
            stream.write(request.data().data(),
                         static_cast<std::streamsize>(request.data().size()));
        } while (not request.finish_write() and reader->Read(&request));
    }

    // Before storing a tree, we have to verify that its parts are present
    bool const is_tree = NativeSupport::IsTree(*hash);
    if (is_tree) {
        // ... unfortunately, this requires us to read the whole tree object
        // into memory
        auto content = FileSystemManager::ReadFile(tmp);
        if (not content) {
            auto const msg = fmt::format(
                "Failed to read temporary file {} for {}", tmp.string(), *hash);
            logger_.Emit(LogLevel::Error, "{}", msg);
            return ::grpc::Status{::grpc::StatusCode::INTERNAL, msg};
        }

        ArtifactDigest dgst{NativeSupport::Unprefix(*hash), 0, true};
        if (auto err =
                CASUtils::EnsureTreeInvariant(dgst, *content, storage_)) {
            auto const str = fmt::format("Write: {}", *std::move(err));
            logger_.Emit(LogLevel::Error, "{}", str);
            return ::grpc::Status{grpc::StatusCode::FAILED_PRECONDITION, str};
        }
    }

    // Store blob and verify hash
    auto const stored = is_tree ? storage_.CAS().StoreTree</*kOwner=*/true>(tmp)
                                : storage_.CAS().StoreBlob</*kOwner=*/true>(
                                      tmp, /*is_executable=*/false);
    if (not stored) {
        // This is a serious problem: we have a sequence of bytes, but cannot
        // write them to CAS.
        auto str = fmt::format("Failed to store object {}", *hash);
        logger_.Emit(LogLevel::Error, "{}", str);
        return ::grpc::Status{::grpc::StatusCode::INTERNAL, str};
    }

    if (static_cast<bazel_re::Digest>(*stored).hash() != *hash) {
        // User error: did not get a file with the announced hash
        auto str = fmt::format("In upload for {} received object with hash {}",
                               *hash,
                               stored->hash());
        logger_.Emit(LogLevel::Error, "{}", str);
        return ::grpc::Status{::grpc::StatusCode::INVALID_ARGUMENT, str};
    }

    response->set_committed_size(
        static_cast<google::protobuf::int64>(std::filesystem::file_size(tmp)));
    return ::grpc::Status::OK;
}

auto BytestreamServiceImpl::QueryWriteStatus(
    ::grpc::ServerContext* /*context*/,
    const ::google::bytestream::QueryWriteStatusRequest* /*request*/,
    ::google::bytestream::QueryWriteStatusResponse* /*response*/)
    -> ::grpc::Status {
    auto const* str = "QueryWriteStatus not implemented";
    logger_.Emit(LogLevel::Error, "{}", str);
    return ::grpc::Status{grpc::StatusCode::UNIMPLEMENTED, str};
}