scylladb/tools/utils.cc

/*
 * Copyright (C) 2021-present ScyllaDB
 */

/*
 * SPDX-License-Identifier: LicenseRef-ScyllaDB-Source-Available-1.0
 */

#include <seastar/core/thread.hh>
#include <fmt/ranges.h>
#include <boost/make_shared.hpp>

#include "db/config.hh"
#include "db/extensions.hh"
#include "tools/utils.hh"
#include "utils/assert.hh"
#include "utils/logalloc.hh"
#include "init.hh"

namespace bpo = boost::program_options;

namespace tools::utils {

bool operation::matches(std::string_view name) const {
    return _name[0] == name || std::ranges::find(_aliases, name) != _aliases.end();
}

namespace {

bool is_help(const sstring& op) {
    return op == "--help" || op == "-h";
}

std::vector<std::string_view> get_all_operation_names(const std::vector<operation>& operations) {
    std::vector<std::string_view> all_operation_names;
    for (const auto& op : operations) {
        all_operation_names.push_back(op.name());
        for (const auto& alias : op.aliases()) {
            all_operation_names.push_back(alias);
        }
    }
    return all_operation_names;
}

// Extract the operation from the argv.
//
// Do an initial parsing of command-line options to identify the operation
// command-line argument.
// If found, it is shifted out to the end (effectively removed) and the
// corresponding operation* is returned.
// If not found:
// * If any of the tool_app_template::help_arguments was used, nullptr is returned, to allow the tool to produce a proper help.
// * If no help was invoked, the application exits with return-code 1.
// If the operation is not recognized, the application exits with return-code 100.
// If parsing the command-line arguments fails, the application exits with return-code 2.
const operation* get_selected_operation(int& ac, char**& av, const std::vector<operation>& operations, const std::vector<operation_option>* global_options) {
    bpo::positional_options_description pos_opts;
    bpo::options_description opts("scylla-tool options");
    for (const auto& [option, help] : tool_app_template::help_arguments) {
        opts.add_options()(option, help);
    }
    opts.add(boost::make_shared<bpo::option_description>("operation", bpo::value<sstring>(), "Operation"));
    pos_opts.add("operation", 1);
    opts.add(boost::make_shared<bpo::option_description>("operation_options", bpo::value<std::vector<std::string>>(), "Operation specific options"));
    pos_opts.add("operation_options", -1);

    if (global_options) {
        for (const auto& go : *global_options) {
            go.add_option(opts);
        }
    }

    bpo::variables_map vm;
    try {
        bpo::store(bpo::command_line_parser(ac, av)
                    .options(opts)
                    .positional(pos_opts)
                    .allow_unregistered()
                    .run()
            , vm);
    } catch (bpo::error& e) {
        fmt::print("error: {}\n\nTry --help.\n", e.what());
        exit(2);
    }

    if (!vm.count("operation")) {
        // We allow no operation only when help was requested.
        for (const auto& [op, _] : tool_app_template::help_arguments) {
            std::string option(op);
            if (auto comma_pos = option.find(","); comma_pos != sstring::npos) {
                option = option.substr(0, comma_pos);
            }
            if (vm.count(option)) {
                return nullptr;
            }
        }
        fmt::print(std::cerr, "error: missing mandatory operation argument\n");
        exit(1);
    }

    sstring op_name = vm["operation"].as<sstring>();
    if (auto found = std::ranges::find_if(operations, [op_name] (auto& op) {
            return op.matches(op_name);
        });
        found != operations.end()) {
        for (int i = 0; i < ac; ++i) {
            if (op_name == av[i]) {
                std::shift_left(av + i, av + ac, 1);
                --ac;
                while (!found->suboperations().empty()) {
                    sstring subop = i < ac ? av[i] : "";
                    if (is_help(subop)) {
                        break;
                    }
                    auto& suboperations = found->suboperations();
                    found = std::ranges::find_if(suboperations, [&subop] (auto& op) {
                        return op.matches(subop);
                    });
                    if (found != suboperations.end()) {
                        op_name += format(" {}", subop);
                        std::shift_left(av + i, av + ac, 1);
                        --ac;
                        continue;
                    }
                    fmt::print(std::cerr, "error: unrecognized suboperation of {}: expected one of ({}), got {}\n", op_name, get_all_operation_names(suboperations), subop);
                    exit(100);
                }
                break;
            }
        }
        return &*found;
    }

    fmt::print(std::cerr, "error: unrecognized operation argument: expected one of ({}), got {}\n", get_all_operation_names(operations), op_name);
    exit(100);
}

// Configure seastar with defaults more appropriate for a tool.
// Make seastar not act as if it owns the place, taking over all system resources.
// Set ERROR as the default log level, except for the logger \p logger_name, which
// is configured with INFO level.
void configure_tool_mode(app_template::seastar_options& opts, const sstring& logger_name) {
    // Disable handling of SIGINT/SIGTERM by seastar, allow the tool to be
    // interrupted by way of not handling these signals.
    opts.auto_handle_sigint_sigterm = false;

    opts.reactor_opts.blocked_reactor_notify_ms.set_value(60000);
    opts.reactor_opts.overprovisioned.set_value();
    opts.reactor_opts.idle_poll_time_us.set_value(0);
    opts.reactor_opts.poll_aio.set_value(false);
    opts.reactor_opts.relaxed_dma.set_value();
    opts.reactor_opts.unsafe_bypass_fsync.set_value(true);
    opts.reactor_opts.kernel_page_cache.set_value(true);
    if (std::ranges::contains(opts.reactor_opts.reactor_backend.get_candidate_names(), "io_uring")) {
        opts.reactor_opts.reactor_backend.select_candidate("io_uring");
    } else {
        // On some systems (e.g. docker), io_uring is not available.
        // In this case fall back to epoll.
        opts.reactor_opts.reactor_backend.select_candidate("epoll");
    }
    opts.smp_opts.thread_affinity.set_value(false);
    opts.smp_opts.mbind.set_value(false);
    opts.smp_opts.smp.set_value(1);
    opts.smp_opts.lock_memory.set_value(false);
    opts.smp_opts.memory_allocator = memory_allocator::standard;
    opts.log_opts.default_log_level.set_value(log_level::error);
    if (!logger_name.empty()) {
        opts.log_opts.logger_log_level.set_value({});
        opts.log_opts.logger_log_level.get_value()[logger_name] = log_level::info;
    }
}

} // anonymous namespace

db_config_and_extensions::db_config_and_extensions() 
    : extensions(std::make_shared<db::extensions>())
    , db_cfg(std::make_unique<db::config>(extensions))
{}

db_config_and_extensions::db_config_and_extensions(db_config_and_extensions&&) = default;
db_config_and_extensions::~db_config_and_extensions() = default;

const std::vector<std::pair<const char*, const char*>> tool_app_template::help_arguments{
    {"help,h", "show help message"},
    {"help-seastar", "show help message about seastar options"},
    {"help-loggers", "print a list of logger names and exit"},
};

tool_app_template::tool_app_template(config cfg)
    : _cfg(std::move(cfg))
{}

int tool_app_template::run_async(int argc, char** argv, noncopyable_function<int(const operation&, const boost::program_options::variables_map&)> main_func) {
    if (argc <= 1) {
        auto program_name = argc ? std::filesystem::path(argv[0]).filename().native() : "scylla";
        fmt::print(std::cerr, "Usage: {} {} OPERATION [OPTIONS] ...\nTry `{} {} --help` for more information.\n",
                program_name, _cfg.name, program_name, _cfg.name);
        return 2;
    }

    const operation* found_op = tools::utils::get_selected_operation(argc, argv, _cfg.operations, _cfg.global_options);

    app_template::seastar_options app_cfg;
    app_cfg.name = format("scylla-{}", _cfg.name);

    if (found_op) {
        app_cfg.description = seastar::format("{}\n\n{}\n", found_op->summary(), found_op->description());
    } else {
        app_cfg.description = _cfg.description;
    }

    tools::utils::configure_tool_mode(app_cfg, _cfg.logger_name);

    app_template app(std::move(app_cfg));

    if (_cfg.global_options) {
        auto& global_desc = app.get_options_description();
        for (const auto& go : *_cfg.global_options) {
            go.add_option(global_desc);
        }
    }
    if (_cfg.global_positional_options) {
        for (const auto& gpo : *_cfg.global_positional_options) {
            app.add_positional_options({gpo.to_positional_option()});
        }
    }

    if (found_op) {
        boost::program_options::options_description op_desc(found_op->name());
        for (const auto& opt : found_op->options()) {
            opt.add_option(op_desc);
        }
        for (const auto& opt : found_op->positional_options()) {
            app.add_positional_options({opt.to_positional_option()});
        }
        if (!found_op->options().empty()) {
            app.get_options_description().add(op_desc);
        }
    }

    if (_cfg.db_cfg_ext) {
        auto init = app.get_options_description().add_options();
        configurable::append_all(*_cfg.db_cfg_ext->db_cfg, init);
        _cfg.db_cfg_ext->db_cfg->add_all_default_extensions();
    }

    return app.run(argc, argv, [this, &main_func, &app, found_op] {
        return async([this, &main_func, &app, found_op] {
            configurable::notify_set ns;

            if (_cfg.db_cfg_ext) {
                ns = configurable::init_all(*_cfg.db_cfg_ext->db_cfg, *_cfg.db_cfg_ext->extensions).get();
            }

            ns.notify_all(configurable::system_state::started).get();

            logalloc::use_standard_allocator_segment_pool_backend(_cfg.lsa_segment_pool_backend_size_mb * 1024 * 1024).get();
            SCYLLA_ASSERT(found_op);
            auto res = main_func(*found_op, app.configuration());

            ns.notify_all(configurable::system_state::stopped).get();

            return res;
        });
    });
}

} // namespace tools::utils