src/util/tmp_file.cc - master - Neitrinok/seastar

src/util/tmp_file.cc
168 строк5 KB
Tyler Rockwood
treewide: replace assert with SEASTAR_ASSERT
18 фев 2025, 01:25
18 фев 2025, 01:257a91062
/*
 * This file is open source software, licensed to you under the terms
 * of the Apache License, Version 2.0 (the "License").  See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership.  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.
 */

/*
 * Copyright 2020 ScyllaDB
 */

#include <iostream>
#include <random>

#include <seastar/core/seastar.hh>
#include <seastar/util/assert.hh>
#include <seastar/util/exceptions.hh>
#include <seastar/util/std-compat.hh>
#include <seastar/util/tmp_file.hh>
#include <seastar/util/file.hh>

namespace seastar {

namespace fs = std::filesystem;

static constexpr const char* default_tmp_name_template = "XXXXXX.tmp";

static fs::path
generate_tmp_name(const fs::path& path_template) {
    fs::path parent = path_template.parent_path();
    std::string filename = path_template.filename().native();
    if (parent.empty()) {
        parent = ".";
    }
    auto pos = filename.find("XX");
    if (pos == std::string::npos) {
        parent = path_template;
        filename = default_tmp_name_template;
        pos = filename.find("XX");
        SEASTAR_ASSERT(pos != std::string::npos);
    }
    auto end = filename.size();
    static constexpr char charset[] = "0123456789abcdef";
    static thread_local std::default_random_engine engine(std::random_device{}());
    static thread_local std::uniform_int_distribution<int> dist(0, sizeof(charset) - 2);
    while (pos < end && filename[pos] == 'X') {
        filename[pos++] = charset[dist(engine)];
    }
    parent /= filename;
    return parent;
}

static fs::path default_tmpdir_path;

const fs::path& default_tmpdir() {
    if (default_tmpdir_path.empty()) {
        auto TMPDIR = getenv("TMPDIR");
        default_tmpdir_path = TMPDIR ? TMPDIR : "/tmp";
    }
    return default_tmpdir_path;
}

void set_default_tmpdir(fs::path path) {
    default_tmpdir_path = std::move(path);
}

tmp_file::tmp_file(tmp_file&& x) noexcept
    : _path(std::move(x._path))
    , _file(std::move(x._file))
{
    std::swap(_is_open, x._is_open);
}

tmp_file::~tmp_file() {
    SEASTAR_ASSERT(!has_path());
    SEASTAR_ASSERT(!is_open());
}

future<> tmp_file::open(fs::path path_template, open_flags oflags, file_open_options options) noexcept {
    SEASTAR_ASSERT(!has_path());
    SEASTAR_ASSERT(!is_open());
    oflags |= open_flags::create | open_flags::exclusive;
    fs::path path;
    try {
        path = generate_tmp_name(std::move(path_template));
    } catch (...) {
        return current_exception_as_future();
    }
    return open_file_dma(path.native(), oflags, std::move(options)).then([this, path = std::move(path)] (file f) mutable {
        _path = std::move(path);
        _file = std::move(f);
        _is_open = true;
        return make_ready_future<>();
    });
}

future<> tmp_file::close() noexcept {
    if (!is_open()) {
        return make_ready_future<>();
    }
    return _file.close().then([this] {
        _is_open = false;
    });
}

future<> tmp_file::remove() noexcept {
    if (!has_path()) {
        return make_ready_future<>();
    }
    return remove_file(get_path().native()).then([this] {
        _path.clear();
    });
}

future<tmp_file>
make_tmp_file(fs::path path_template, open_flags oflags, file_open_options options) noexcept {
    return do_with(tmp_file(), [path_template = std::move(path_template), oflags, options = std::move(options)] (tmp_file& t) mutable {
        return t.open(std::move(path_template), oflags, std::move(options)).then([&t] {
            return make_ready_future<tmp_file>(std::move(t));
        });
    });
}

tmp_dir::~tmp_dir() {
    SEASTAR_ASSERT(!has_path());
}

future<> tmp_dir::create(fs::path path_template, file_permissions create_permissions) noexcept {
    SEASTAR_ASSERT(!has_path());
    fs::path path;
    try {
        path = generate_tmp_name(std::move(path_template));
    } catch (...) {
        return current_exception_as_future();
    }
    return touch_directory(path.native(), create_permissions).then([this, path = std::move(path)] () mutable {
        _path = std::move(path);
        return make_ready_future<>();
    });
}

future<> tmp_dir::remove() noexcept {
    if (!has_path()) {
        return make_ready_future<>();
    }
    return recursive_remove_directory(std::move(_path));
}

future<tmp_dir> make_tmp_dir(std::filesystem::path path_template, file_permissions create_permissions) noexcept {
    return do_with(tmp_dir(), [path_template = std::move(path_template), create_permissions] (tmp_dir& t) mutable {
        return t.create(std::move(path_template), create_permissions).then([&t] () mutable {
            return make_ready_future<tmp_dir>(std::move(t));
        });
    });
}

} //namespace seastar