app-template.cc

/*
 * 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 (C) 2014 Cloudius Systems, Ltd.
 */

#ifdef SEASTAR_MODULE
module;
#endif

#include <fstream>
#include <cstdlib>
#include <chrono>
#include <iostream>
#include <fmt/format.h>
#include <boost/program_options.hpp>
#include <boost/make_shared.hpp>

#ifdef SEASTAR_MODULE
module seastar;
#else
#include <seastar/core/app-template.hh>
#include <seastar/core/reactor.hh>
#include <seastar/core/alien.hh>
#include <seastar/core/scollectd.hh>
#include <seastar/core/metrics_api.hh>
#include <seastar/core/print.hh>
#include <seastar/util/log.hh>
#include <seastar/util/log-cli.hh>
#include <seastar/net/native-stack.hh>
#include "program_options.hh"
#endif

namespace seastar {

namespace bpo = boost::program_options;

using namespace std::chrono_literals;

static
app_template::seastar_options
seastar_options_from_config(app_template::config cfg) {
    app_template::seastar_options opts;
    opts.name = std::move(cfg.name);
    opts.description = std::move(cfg.description);
    opts.auto_handle_sigint_sigterm = std::move(cfg.auto_handle_sigint_sigterm);
    opts.reactor_opts.task_quota_ms.set_default_value(cfg.default_task_quota / 1ms);
    opts.reactor_opts.max_networking_io_control_blocks.set_default_value(cfg.max_networking_aio_io_control_blocks);
    opts.smp_opts.reserve_additional_memory_per_shard = cfg.reserve_additional_memory_per_shard;
    return opts;
}

app_template::seastar_options::seastar_options()
    : program_options::option_group(nullptr, "seastar")
    , reactor_opts(this)
    , metrics_opts(this)
    , smp_opts(this)
    , scollectd_opts(this)
    , log_opts(this)
{
}

app_template::app_template(app_template::seastar_options opts)
    : _alien(std::make_unique<alien::instance>())
    , _smp(std::make_shared<smp>(*_alien))
    , _opts(std::move(opts))
    , _app_opts(_opts.name + " options")
    , _conf_reader(get_default_configuration_reader()) {

        if (!alien::internal::default_instance) {
            alien::internal::default_instance = _alien.get();
        }
        add_extra_options(_app_opts);
        {
            program_options::options_description_building_visitor visitor;
            _opts.describe(visitor);
            _opts_conf_file.add(std::move(visitor).get_options_description());
        }

        _seastar_opts.add(_opts_conf_file);
}

app_template::app_template(app_template::config cfg)
    : app_template(seastar_options_from_config(std::move(cfg)))
{
}

void
app_template::add_extra_options(boost::program_options::options_description& opts) {
    opts.add_options()
            ("help,h", "show help message")
            ;
    opts.add_options()
            ("help-seastar", "show help message about seastar options")
            ;
    opts.add_options()
            ("help-loggers", "print a list of logger names and exit")
            ;
}

app_template::~app_template() = default;

const app_template::seastar_options& app_template::options() const {
    return _opts;
}

void
app_template::set_app_visible_options_for_help(boost::program_options::options_description* opts) {
    _app_visible_opts_for_help = opts;
    if (_app_visible_opts_for_help) {
        add_extra_options(*_app_visible_opts_for_help);
    }
}

app_template::configuration_reader app_template::get_default_configuration_reader() {
    return [this] (bpo::variables_map& configuration) {
        auto home = std::getenv("HOME");
        if (home) {
            std::ifstream ifs(std::string(home) + "/.config/seastar/seastar.conf");
            if (ifs) {
                bpo::store(bpo::parse_config_file(ifs, _opts_conf_file), configuration);
            }
            std::ifstream ifs_io(std::string(home) + "/.config/seastar/io.conf");
            if (ifs_io) {
                bpo::store(bpo::parse_config_file(ifs_io, _opts_conf_file), configuration);
            }
        }
    };
}

void app_template::set_configuration_reader(configuration_reader conf_reader) {
    _conf_reader = conf_reader;
}

boost::program_options::options_description& app_template::get_options_description() {
    return _app_opts;
}

boost::program_options::options_description& app_template::get_conf_file_options_description() {
    return _opts_conf_file;
}

boost::program_options::options_description_easy_init
app_template::add_options() {
    return _app_opts.add_options();
}

void
app_template::add_positional_options(std::initializer_list<positional_option> options) {
    for (auto&& o : options) {
        _app_opts.add(boost::make_shared<bpo::option_description>(o.name, o.value_semantic, o.help));
        _pos_opts.add(o.name, o.max_count);
    }
}


bpo::variables_map&
app_template::configuration() {
    return *_configuration;
}

int
app_template::run(int ac, char ** av, std::function<future<int> ()>&& func) noexcept {
    return run_deprecated(ac, av, [func = std::move(func)] () mutable {
        auto func_done = make_lw_shared<promise<>>();
        engine().at_exit([func_done] { return func_done->get_future(); });
        // No need to wait for this future.
        // func's returned exit_code is communicated via engine().exit()
        (void)futurize_invoke(func).finally([func_done] {
            func_done->set_value();
        }).then([] (int exit_code) {
            return engine().exit(exit_code);
        }).or_terminate();
    });
}

int
app_template::run(int ac, char ** av, std::function<future<> ()>&& func) noexcept {
    return run(ac, av, [func = std::move(func)] {
        return func().then([] () {
            return 0;
        });
    });
}

int
app_template::run_deprecated(int ac, char ** av, std::function<void ()>&& func) noexcept {
#ifdef SEASTAR_DEBUG
    fmt::print(std::cerr, "WARNING: debug mode. Not for benchmarking or production\n");
#endif
    boost::program_options::options_description all_opts;
    all_opts.add(_app_opts);
    all_opts.add(_seastar_opts);

    bpo::variables_map configuration;
    try {
        bpo::store(bpo::command_line_parser(ac, av)
                    .options(all_opts)
                    .positional(_pos_opts)
                    .run()
            , configuration);
        _conf_reader(configuration);
    } catch (bpo::error& e) {
        fmt::print("error: {}\n\nTry --help.\n", e.what());
        return 2;
    }
    if (configuration.count("help")) {
        if (!_opts.description.empty()) {
            std::cout << _opts.description << "\n";
        }
        auto& which_opts = _app_visible_opts_for_help ? *_app_visible_opts_for_help : _app_opts;
        std::cout << which_opts << "\n";
        return 0;
    }
    if (configuration.count("help-seastar")) {
        std::cout << _seastar_opts << "\n";
        return 0;
    }
    if (configuration.count("help-loggers")) {
        log_cli::print_available_loggers(std::cout);
        return 0;
    }

    try {
        bpo::notify(configuration);
    } catch (const bpo::error& ex) {
        std::cout << ex.what() << std::endl;
        return 1;
    }

    {
        program_options::variables_map_extracting_visitor visitor(configuration);
        _opts.mutate(visitor);
    }
    _opts.reactor_opts._argv0 = std::string(av[0]);
    _opts.reactor_opts._auto_handle_sigint_sigterm = _opts.auto_handle_sigint_sigterm;
    if (auto* native_stack = dynamic_cast<net::native_stack_options*>(_opts.reactor_opts.network_stack.get_selected_candidate_opts())) {
        native_stack->_hugepages = _opts.smp_opts.hugepages;
    }

    // Needs to be before `smp::configure()`.
    try {
        apply_logging_settings(log_cli::extract_settings(_opts.log_opts));
    } catch (const std::runtime_error& exn) {
        std::cout << "logging configuration error: " << exn.what() << '\n';
        return 1;
    }

    try {
        _smp->configure(_opts.smp_opts, _opts.reactor_opts);
    } catch (...) {
        std::cerr << "Could not initialize seastar: " << std::current_exception() << std::endl;
        return 1;
    }
    _configuration = {std::move(configuration)};
    // No need to wait for this future.
    // func is waited on via engine().run()
    (void)engine().when_started().then([this] {
        return seastar::metrics::configure(_opts.metrics_opts).then([this] {
            // set scollectd use the metrics configuration, so the later
            // need to be set first
            scollectd::configure( _opts.scollectd_opts);
        });
    }).then(
        std::move(func)
    ).then_wrapped([] (auto&& f) {
        try {
            f.get();
        } catch (std::exception& ex) {
            std::cout << "program failed with uncaught exception: " << ex.what() << "\n";
            engine().exit(1);
        }
    });
    auto exit_code = engine().run();
    _smp->cleanup();
    return exit_code;
}

}