#882

Committed 31 Aug 2023 07:44PM UTC coverage: 41.798% (-44.7%) from 86.546%
Build # #882
Build Type
push
Committed by
Commit Message
Run Details
19442 of 46514 relevant lines covered (41.8%)
126375.38 hits per line
Source File
Press 'n' to go to next uncovered line, 'b' for previous

51.13
/libs/core/init_runtime_local/src/init_logging.cpp
//  Copyright (c) 2007-2024 Hartmut Kaiser
//  Copyright (c)      2011 Bryce Lelbach
//
//  SPDX-License-Identifier: BSL-1.0
//  Distributed under the Boost Software License, Version 1.0. (See accompanying
//  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

#include <hpx/config.hpp>

#if defined(HPX_HAVE_LOGGING)
#include <hpx/init_runtime_local/detail/init_logging.hpp>
#include <hpx/modules/logging.hpp>
#include <hpx/modules/runtime_configuration.hpp>
#include <hpx/modules/runtime_local.hpp>
#include <hpx/modules/threading_base.hpp>

#include <cstddef>
#include <cstdint>
#include <cstdlib>
#include <string>

#if defined(ANDROID) || defined(__ANDROID__)
#include <android/log.h>
#endif

///////////////////////////////////////////////////////////////////////////////
namespace hpx::util {

    using logger_writer_type = logging::writer::named_write;

    ///////////////////////////////////////////////////////////////////////////
    // custom formatter: shepherd
    struct shepherd_thread_id final : logging::formatter::manipulator
    {
        void operator()(std::ostream& to) const override
        {
            error_code ec(throwmode::lightweight);
            std::size_t const thread_num = hpx::get_worker_thread_num(ec);

            if (static_cast<std::size_t>(-1) != thread_num)
            {
                util::format_to(to, "{:016x}", thread_num);
            }
            else
            {
                to << std::string(16, '-');
            }
        }
    };

    ///////////////////////////////////////////////////////////////////////////
    // custom formatter: locality prefix
    struct locality_prefix final : logging::formatter::manipulator
    {
        void operator()(std::ostream& to) const override
        {
            std::uint32_t const locality_id = hpx::get_locality_id();

            if (~static_cast<std::uint32_t>(0) != locality_id)
            {
                util::format_to(to, "{:08x}", locality_id);
            }
            else
            {
                // called from outside a HPX thread
                to << std::string(8, '-');
            }
        }
    };

    ///////////////////////////////////////////////////////////////////////////
    // custom formatter: HPX thread id
    struct thread_id final : logging::formatter::manipulator
    {
        void operator()(std::ostream& to) const override
        {
            threads::thread_self const* self = threads::get_self_ptr();
            if (nullptr != self)
            {
                // called from inside a HPX thread
                threads::thread_id_type const id = threads::get_self_id();
                if (id != threads::invalid_thread_id)
                {
                    auto const value =
                        reinterpret_cast<std::ptrdiff_t>(id.get());
                    util::format_to(to, "{:016x}", value);
                    return;
                }
            }

            // called from outside a HPX thread or invalid thread id
            to << std::string(16, '-');
        }
    };

    ///////////////////////////////////////////////////////////////////////////
    // custom formatter: HPX thread phase
    struct thread_phase final : logging::formatter::manipulator
    {
        void operator()(std::ostream& to) const override
        {
            threads::thread_self const* self = threads::get_self_ptr();
            if (nullptr != self)
            {
                // called from inside a HPX thread
                std::size_t const phase = self->get_thread_phase();
                if (0 != phase)
                {
                    util::format_to(to, "{:04x}", self->get_thread_phase());
                    return;
                }
            }

            // called from outside a HPX thread or no phase given
            to << std::string(4, '-');    //-V112
        }
    };

    ///////////////////////////////////////////////////////////////////////////
    // custom formatter: locality prefix of parent thread
    struct parent_thread_locality final : logging::formatter::manipulator
    {
        void operator()(std::ostream& to) const override
        {
            std::uint32_t const parent_locality_id =
                threads::get_parent_locality_id();
            if (~static_cast<std::uint32_t>(0) != parent_locality_id)
            {
                // called from inside a HPX thread
                util::format_to(to, "{:08x}", parent_locality_id);
            }
            else
            {
                // called from outside a HPX thread
                to << std::string(8, '-');
            }
        }
    };

    ///////////////////////////////////////////////////////////////////////////
    // custom formatter: HPX parent thread id
    struct parent_thread_id final : logging::formatter::manipulator
    {
        void operator()(std::ostream& to) const override
        {
            threads::thread_id_type const parent_id = threads::get_parent_id();
            if (nullptr != parent_id)
            {
                // called from inside a HPX thread
                auto const value =
                    reinterpret_cast<std::ptrdiff_t>(parent_id.get());
                util::format_to(to, "{:016x}", value);
            }
            else
            {
                // called from outside a HPX thread
                to << std::string(16, '-');
            }
        }
    };

    ///////////////////////////////////////////////////////////////////////////
    // custom formatter: HPX parent thread phase
    struct parent_thread_phase final : logging::formatter::manipulator
    {
        void operator()(std::ostream& to) const override
        {
            std::size_t const parent_phase = threads::get_parent_phase();
            if (0 != parent_phase)
            {
                // called from inside a HPX thread
                util::format_to(to, "{:04x}", parent_phase);
            }
            else
            {
                // called from outside a HPX thread
                to << std::string(4, '-');    //-V112
            }
        }
    };

#if defined(ANDROID) || defined(__ANDROID__)
    // default log destination for Android
    struct android_log final : logging::destination::manipulator
    {
        android_log(char const* tag_)
          : tag(tag_)
        {
        }

        void operator()(logging::message const& msg) override
        {
            __android_log_write(
                ANDROID_LOG_DEBUG, tag.c_str(), msg.full_string().c_str());
        }

        friend bool operator==(android_log const& lhs, android_log const& rhs)
        {
            return lhs.tag == rhs.tag;
        }
        friend bool operator!=(android_log const& lhs, android_log const& rhs)
        {
            return !(lhs == rhs);
        }

        std::string tag;
    };
#endif

    ///////////////////////////////////////////////////////////////////////////
    struct dummy_thread_component_id final : logging::formatter::manipulator
    {
        void operator()(std::ostream& to) const override
        {
            to << std::string(16, '-');
        }
    };

    ///////////////////////////////////////////////////////////////////////////
    // custom log destination: send generated strings to console
    void console_local::operator()(logging::message const& msg)
    {
        switch (dest_)
        {
        // NOLINTNEXTLINE(bugprone-branch-clone)
        case logging_destination::hpx:
            LHPX_CONSOLE_(level_) << msg;
            break;

        case logging_destination::timing:
            LTIM_CONSOLE_(level_) << msg;
            break;

        case logging_destination::agas:
            LAGAS_CONSOLE_(level_) << msg;
            break;

        case logging_destination::parcel:
            LPT_CONSOLE_(level_) << msg;
            break;

        case logging_destination::app:
            LAPP_CONSOLE_(level_) << msg;
            break;

        case logging_destination::debuglog:
            LDEB_CONSOLE_ << msg;
            break;
        }
    }

    namespace detail {

        // unescape config entry
        std::string unescape(std::string const& value)
        {
            std::string result;
            if (std::string::size_type pos1 = value.find_first_of('\\', 0);
                std::string::npos != pos1)
            {
                std::string::size_type pos = 0;
                do
                {
                    switch (value[pos1 + 1])
                    {
                    case '\\':
                    case '\"':
                    case '?':
                        result = result + value.substr(pos, pos1 - pos);
                        pos1 = value.find_first_of('\\', (pos = pos1 + 1) + 1);
                        break;

                    case 'n':
                        result = result + value.substr(pos, pos1 - pos) + "\n";
                        pos1 = value.find_first_of('\\', pos = pos1 + 1);
                        ++pos;
                        break;

                    default:
                        result = result + value.substr(pos, pos1 - pos + 1);
                        pos1 = value.find_first_of('\\', pos = pos1 + 1);
                    }

                } while (pos1 != std::string::npos);
                result = result + value.substr(pos);
            }
            else
            {
                // the string doesn't contain any escaped character sequences
                result = value;
            }
            return result;
        }

        void define_common_formatters(logger_writer_type& writer)
        {
            writer.set_formatter("osthread", shepherd_thread_id());
            writer.set_formatter("locality", locality_prefix());
            writer.set_formatter("hpxthread", thread_id());
            writer.set_formatter("hpxphase", thread_phase());
            writer.set_formatter("hpxparent", parent_thread_id());
            writer.set_formatter("hpxparentphase", parent_thread_phase());
            writer.set_formatter("parentloc", parent_thread_locality());
        }

        void define_formatters_local(logger_writer_type& writer)
        {
            define_common_formatters(writer);
            writer.set_formatter("hpxcomponent", dummy_thread_component_id());
        }

        ///////////////////////////////////////////////////////////////////////
        namespace {

            std::string empty_string;
        }

        log_settings get_log_settings(util::section const& ini, char const* sec)
        {
            log_settings result;
            if (ini.has_section(sec))
            {
                util::section const* logini = ini.get_section(sec);
                HPX_ASSERT(nullptr != logini);

                result.level_ = logini ?
                    logini->get_entry("level", empty_string) :
                    empty_string;
                if (logini && !result.level_.empty())
                {
                    result.dest_ =
                        logini->get_entry("destination", empty_string);
                    result.format_ = detail::unescape(
                        logini->get_entry("format", empty_string));
                }
            }
            return result;
        }

        ///////////////////////////////////////////////////////////////////////
        void get_console_local(logger_writer_type& writer, char const* name,
            logging::level lvl, logging_destination dest)
        {
            writer.set_destination(name, console_local(lvl, dest));
        }

#if defined(HPX_LOGGING_HAVE_SEPARATE_DESTINATIONS)
        ///////////////////////////////////////////////////////////////////////
        // initialize logging for AGAS
        void init_agas_log(logging::level lvl, std::string logdest,
            std::string logformat, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            if (hpx::util::logging::level::disable_all != lvl)
            {
                logger_writer_type& writer = agas_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
                if (logdest.empty())    // ensure minimal defaults
                    logdest = isconsole ? "android_log" : "console";
                agas_logger()->writer().set_destination(
                    "android_log", android_log("hpx.agas"));
#else
                if (logdest.empty())    // ensure minimal defaults
                    logdest = isconsole ? "cerr" : "console";
#endif
                if (logformat.empty())
                    logformat = "|\\n";

                set_console_dest(writer, "console", lvl,
                    logging_destination::agas);    //-V106
                writer.write(logformat, logdest);
                define_formatters(writer);

                agas_logger()->mark_as_initialized();
            }
            agas_logger()->set_enabled(lvl);
        }

        void init_agas_log(runtime_configuration const& ini, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            auto settings = detail::get_log_settings(ini, "hpx.logging.agas");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_agas_log(lvl, HPX_MOVE(settings.dest_),
                HPX_MOVE(settings.format_), isconsole, set_console_dest,
                define_formatters);
        }

        ///////////////////////////////////////////////////////////////////////
        // initialize logging for the parcel transport
        void init_parcel_log(logging::level lvl, std::string logdest,
            std::string logformat, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            if (hpx::util::logging::level::disable_all != lvl)
            {
                logger_writer_type& writer = parcel_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
                if (logdest.empty())    // ensure minimal defaults
                    logdest = isconsole ? "android_log" : "console";
                parcel_logger()->writer().set_destination(
                    "android_log", android_log("hpx.parcel"));
#else
                if (logdest.empty())    // ensure minimal defaults
                    logdest = isconsole ? "cerr" : "console";
#endif
                if (logformat.empty())
                    logformat = "|\\n";

                set_console_dest(writer, "console", lvl,
                    logging_destination::parcel);    //-V106
                writer.write(logformat, logdest);
                define_formatters(writer);

                parcel_logger()->mark_as_initialized();
            }
            parcel_logger()->set_enabled(lvl);
        }

        void init_parcel_log(runtime_configuration const& ini, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            auto settings = detail::get_log_settings(ini, "hpx.logging.parcel");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_parcel_log(lvl, HPX_MOVE(settings.dest_),
                HPX_MOVE(settings.format_), isconsole, set_console_dest,
                define_formatters);
        }

        ///////////////////////////////////////////////////////////////////////
        // initialize logging for performance measurements
        void init_timing_log(logging::level lvl, std::string logdest,
            std::string logformat, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            if (hpx::util::logging::level::disable_all != lvl)
            {
                logger_writer_type& writer = timing_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
                if (logdest.empty())    // ensure minimal defaults
                    logdest = isconsole ? "android_log" : "console";

                writer.set_destination(
                    "android_log", android_log("hpx.timing"));
#else
                if (logdest.empty())    // ensure minimal defaults
                    logdest = isconsole ? "cerr" : "console";
#endif
                if (logformat.empty())
                    logformat = "|\\n";

                set_console_dest(writer, "console", lvl,
                    logging_destination::timing);    //-V106
                writer.write(logformat, logdest);
                define_formatters(writer);

                timing_logger()->mark_as_initialized();
            }
            timing_logger()->set_enabled(lvl);
        }

        void init_timing_log(runtime_configuration const& ini, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            auto settings = detail::get_log_settings(ini, "hpx.logging.timing");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_timing_log(lvl, HPX_MOVE(settings.dest_),
                HPX_MOVE(settings.format_), isconsole, set_console_dest,
                define_formatters);
        }
#endif

        ///////////////////////////////////////////////////////////////////////
        void init_hpx_log(logging::level lvl, std::string logdest,
            std::string logformat, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            logger_writer_type& writer = hpx_logger()->writer();
            logger_writer_type& error_writer = hpx_error_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
            if (logdest.empty())    // ensure minimal defaults
                logdest = isconsole ? "android_log" : "console";

            writer.set_destination("android_log", android_log("hpx"));
            error_writer.set_destination("android_log", android_log("hpx"));
#else
            if (logdest.empty())    // ensure minimal defaults
                logdest = isconsole ? "cerr" : "console";
#endif
            if (logformat.empty())
                logformat = "|\\n";

            if (hpx::util::logging::level::disable_all != lvl)
            {
                set_console_dest(writer, "console", lvl,
                    logging_destination::hpx);    //-V106
                writer.write(logformat, logdest);
                define_formatters(writer);

                hpx_logger()->mark_as_initialized();
                hpx_logger()->set_enabled(lvl);

                // errors are logged to the given destination and to cerr
                set_console_dest(error_writer, "console", lvl,
                    logging_destination::hpx);    //-V106
#if !defined(ANDROID) && !defined(__ANDROID__)
                if (logdest != "cerr")
                    error_writer.write(logformat, logdest + " cerr");
#endif
                define_formatters(error_writer);

                hpx_error_logger()->mark_as_initialized();
                hpx_error_logger()->set_enabled(lvl);
            }
            else
            {
                // errors are always logged to cerr
                if (!isconsole)
                {
                    set_console_dest(writer, "console", lvl,
                        logging_destination::hpx);    //-V106
                    error_writer.write(logformat, "console");
                }
                else
                {
#if defined(ANDROID) || defined(__ANDROID__)
                    error_writer.write(logformat, "android_log");
#else
                    error_writer.write(logformat, "cerr");
#endif
                }
                define_formatters(error_writer);

                hpx_error_logger()->mark_as_initialized();
                hpx_error_logger()->set_enabled(
                    hpx::util::logging::level::fatal);
            }
        }

        void init_hpx_log(runtime_configuration const& ini, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            auto settings = detail::get_log_settings(ini, "hpx.logging");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_hpx_log(lvl, HPX_MOVE(settings.dest_),
                HPX_MOVE(settings.format_), isconsole, set_console_dest,
                define_formatters);
        }

        ///////////////////////////////////////////////////////////////////////
        // initialize logging for application
        void init_app_log(logging::level lvl, std::string logdest,
            std::string logformat, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            if (hpx::util::logging::level::disable_all != lvl)
            {
                logger_writer_type& writer = app_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
                if (logdest.empty())    // ensure minimal defaults
                    logdest = isconsole ? "android_log" : "console";
                writer.set_destination(
                    "android_log", android_log("hpx.application"));
#else
                if (logdest.empty())    // ensure minimal defaults
                    logdest = isconsole ? "cerr" : "console";
#endif
                if (logformat.empty())
                    logformat = "|\\n";

                set_console_dest(writer, "console", lvl,
                    logging_destination::app);    //-V106
                writer.write(logformat, logdest);
                define_formatters(writer);

                app_logger()->mark_as_initialized();
            }
            app_logger()->set_enabled(lvl);
        }

        void init_app_log(runtime_configuration const& ini, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            auto settings =
                detail::get_log_settings(ini, "hpx.logging.application");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_app_log(lvl, HPX_MOVE(settings.dest_),
                HPX_MOVE(settings.format_), isconsole, set_console_dest,
                define_formatters);
        }

        ///////////////////////////////////////////////////////////////////////
        // initialize logging for application
        void init_debuglog_log(logging::level lvl, std::string logdest,
            std::string logformat, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            if (hpx::util::logging::level::disable_all != lvl)
            {
                logger_writer_type& writer = debuglog_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
                if (logdest.empty())    // ensure minimal defaults
                    logdest = isconsole ? "android_log" : "console";
                writer.set_destination(
                    "android_log", android_log("hpx.debuglog"));
#else
                if (logdest.empty())    // ensure minimal defaults
                    logdest = isconsole ? "cerr" : "console";
#endif
                if (logformat.empty())
                    logformat = "|\\n";

                set_console_dest(writer, "console", lvl,
                    logging_destination::debuglog);    //-V106
                writer.write(logformat, logdest);
                define_formatters(writer);

                debuglog_logger()->mark_as_initialized();
            }
            debuglog_logger()->set_enabled(lvl);
        }

        void init_debuglog_log(runtime_configuration const& ini, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            auto settings =
                detail::get_log_settings(ini, "hpx.logging.debuglog");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_debuglog_log(lvl, HPX_MOVE(settings.dest_),
                HPX_MOVE(settings.format_), isconsole, set_console_dest,
                define_formatters);
        }

#if defined(HPX_LOGGING_HAVE_SEPARATE_DESTINATIONS)
        ///////////////////////////////////////////////////////////////////////
        void init_agas_console_log(
            logging::level lvl, std::string logdest, std::string logformat)
        {
            if (hpx::util::logging::level::disable_all != lvl)
            {
                logger_writer_type& writer = agas_console_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "android_log";
                writer.set_destination("android_log", android_log("hpx.agas"));
#else
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "cerr";
#endif
                if (logformat.empty())
                    logformat = "|\\n";

                writer.write(logformat, logdest);

                agas_console_logger()->mark_as_initialized();
            }
            agas_console_logger()->set_enabled(lvl);
        }

        void init_agas_console_log(util::section const& ini)
        {
            auto settings =
                detail::get_log_settings(ini, "hpx.logging.console.agas");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_agas_console_log(
                lvl, HPX_MOVE(settings.dest_), HPX_MOVE(settings.format_));
        }

        ///////////////////////////////////////////////////////////////////////
        void init_parcel_console_log(
            logging::level lvl, std::string logdest, std::string logformat)
        {
            if (hpx::util::logging::level::disable_all != lvl)
            {
                logger_writer_type& writer = parcel_console_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "android_log";
                writer.set_destination(
                    "android_log", android_log("hpx.parcel"));
#else
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "cerr";
#endif
                if (logformat.empty())
                    logformat = "|\\n";

                writer.write(logformat, logdest);

                parcel_console_logger()->mark_as_initialized();
            }
            parcel_console_logger()->set_enabled(lvl);
        }

        void init_parcel_console_log(util::section const& ini)
        {
            auto settings =
                detail::get_log_settings(ini, "hpx.logging.console.parcel");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_parcel_console_log(
                lvl, HPX_MOVE(settings.dest_), HPX_MOVE(settings.format_));
        }

        ///////////////////////////////////////////////////////////////////////
        void init_timing_console_log(
            logging::level lvl, std::string logdest, std::string logformat)
        {
            if (hpx::util::logging::level::disable_all != lvl)
            {
                logger_writer_type& writer = timing_console_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "android_log";
                writer.set_destination(
                    "android_log", android_log("hpx.timing"));
#else
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "cerr";
#endif
                if (logformat.empty())
                    logformat = "|\\n";

                writer.write(logformat, logdest);

                timing_console_logger()->mark_as_initialized();
            }
            timing_console_logger()->set_enabled(lvl);
        }

        void init_timing_console_log(util::section const& ini)
        {
            auto settings =
                detail::get_log_settings(ini, "hpx.logging.console.timing");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_timing_console_log(
                lvl, HPX_MOVE(settings.dest_), HPX_MOVE(settings.format_));
        }
#endif

        ///////////////////////////////////////////////////////////////////////
        void init_hpx_console_log(
            logging::level lvl, std::string logdest, std::string logformat)
        {
            if (hpx::util::logging::level::disable_all != lvl)
            {
                logger_writer_type& writer = hpx_console_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "android_log";
                writer.set_destination("android_log", android_log("hpx"));
#else
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "cerr";
#endif
                if (logformat.empty())
                    logformat = "|\\n";

                writer.write(logformat, logdest);

                hpx_console_logger()->mark_as_initialized();
            }
            hpx_console_logger()->set_enabled(lvl);
        }

        void init_hpx_console_log(util::section const& ini)
        {
            auto settings =
                detail::get_log_settings(ini, "hpx.logging.console");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_hpx_console_log(
                lvl, HPX_MOVE(settings.dest_), HPX_MOVE(settings.format_));
        }

        ///////////////////////////////////////////////////////////////////////
        void init_app_console_log(
            logging::level lvl, std::string logdest, std::string logformat)
        {
            if (hpx::util::logging::level::disable_all != lvl)
            {
                logger_writer_type& writer = app_console_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "android_log";
                writer.set_destination(
                    "android_log", android_log("hpx.application"));
#else
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "cerr";
#endif
                if (logformat.empty())
                    logformat = "|\\n";

                writer.write(logformat, logdest);

                app_console_logger()->mark_as_initialized();
            }
            app_console_logger()->set_enabled(lvl);
        }

        void init_app_console_log(util::section const& ini)
        {
            auto settings = detail::get_log_settings(
                ini, "hpx.logging.console.application");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_app_console_log(
                lvl, HPX_MOVE(settings.dest_), HPX_MOVE(settings.format_));
        }

        ///////////////////////////////////////////////////////////////////////
        void init_debuglog_console_log(
            logging::level lvl, std::string logdest, std::string logformat)
        {
            if (hpx::util::logging::level::disable_all != lvl)
            {
                logger_writer_type& writer =
                    debuglog_console_logger()->writer();

#if defined(ANDROID) || defined(__ANDROID__)
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "android_log";
                writer.set_destination(
                    "android_log", android_log("hpx.debuglog"));
#else
                if (logdest.empty())    // ensure minimal defaults
                    logdest = "cerr";
#endif
                if (logformat.empty())
                    logformat = "|\\n";

                writer.write(logformat, logdest);

                debuglog_console_logger()->mark_as_initialized();
            }
            debuglog_console_logger()->set_enabled(lvl);
        }

        void init_debuglog_console_log(util::section const& ini)
        {
            auto settings =
                detail::get_log_settings(ini, "hpx.logging.console.debuglog");

            auto lvl = hpx::util::logging::level::disable_all;
            if (!settings.level_.empty())
                lvl = detail::get_log_level(settings.level_, true);

            init_debuglog_console_log(
                lvl, HPX_MOVE(settings.dest_), HPX_MOVE(settings.format_));
        }

        ///////////////////////////////////////////////////////////////////////
        namespace {

            void (*default_set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination) = get_console_local;

            void (*default_define_formatters)(
                logging::writer::named_write&) = define_formatters_local;

            bool default_isconsole = true;
        }    // namespace

        void init_logging(runtime_configuration& ini, bool isconsole,
            void (*set_console_dest)(logger_writer_type&, char const*,
                logging::level, logging_destination),
            void (*define_formatters)(logging::writer::named_write&))
        {
            default_isconsole = isconsole;
            default_set_console_dest = set_console_dest;
            default_define_formatters = define_formatters;

#if defined(HPX_LOGGING_HAVE_SEPARATE_DESTINATIONS)
            // initialize normal logs
            init_agas_log(ini, isconsole, set_console_dest, define_formatters);
            init_parcel_log(
                ini, isconsole, set_console_dest, define_formatters);
            init_timing_log(
                ini, isconsole, set_console_dest, define_formatters);
#endif
            init_hpx_log(ini, isconsole, set_console_dest, define_formatters);
            init_app_log(ini, isconsole, set_console_dest, define_formatters);
            init_debuglog_log(
                ini, isconsole, set_console_dest, define_formatters);

            // initialize console logs
#if defined(HPX_LOGGING_HAVE_SEPARATE_DESTINATIONS)
            init_agas_console_log(ini);
            init_parcel_console_log(ini);
            init_timing_console_log(ini);
#endif
            init_hpx_console_log(ini);
            init_app_console_log(ini);
            init_debuglog_console_log(ini);
        }

        void init_logging_local(runtime_configuration& ini)
        {
            init_logging(ini, true, util::detail::get_console_local,
                util::detail::define_formatters_local);
        }
    }    // namespace detail

    ///////////////////////////////////////////////////////////////////////////
    void disable_logging(logging_destination dest) noexcept
    {
        switch (dest)
        {
#if defined(HPX_LOGGING_HAVE_SEPARATE_DESTINATIONS)
        case logging_destination::timing:
            timing_logger()->set_enabled(logging::level::disable_all);
            timing_console_logger()->set_enabled(logging::level::disable_all);
            break;

        case logging_destination::agas:
            agas_logger()->set_enabled(logging::level::disable_all);
            agas_console_logger()->set_enabled(logging::level::disable_all);
            break;

        case logging_destination::parcel:
            parcel_logger()->set_enabled(logging::level::disable_all);
            parcel_console_logger()->set_enabled(logging::level::disable_all);
            break;
#else
        case logging_destination::agas:
        case logging_destination::timing:
        case logging_destination::parcel:
            [[fallthrough]];
#endif

        case logging_destination::hpx:
            hpx_logger()->set_enabled(logging::level::disable_all);
            hpx_console_logger()->set_enabled(logging::level::disable_all);
            break;

        case logging_destination::app:
            app_logger()->set_enabled(logging::level::disable_all);
            app_console_logger()->set_enabled(logging::level::disable_all);
            break;

        case logging_destination::debuglog:
            debuglog_logger()->set_enabled(logging::level::disable_all);
            debuglog_console_logger()->set_enabled(logging::level::disable_all);
            break;
        }
    }

    void enable_logging(logging_destination dest, std::string const& level,
        std::string logdest, std::string logformat)
    {
        auto lvl = hpx::util::logging::level::enable_all;
        if (!level.empty())
        {
            lvl = detail::get_log_level(level, true);
        }

        switch (dest)
        {
#if defined(HPX_LOGGING_HAVE_SEPARATE_DESTINATIONS)
        case logging_destination::timing:
            detail::init_timing_log(lvl, logdest, logformat,
                detail::default_isconsole, detail::default_set_console_dest,
                detail::default_define_formatters);
            detail::init_debuglog_console_log(
                lvl, HPX_MOVE(logdest), HPX_MOVE(logformat));
            break;

        case logging_destination::agas:
            detail::init_agas_log(lvl, logdest, logformat,
                detail::default_isconsole, detail::default_set_console_dest,
                detail::default_define_formatters);
            detail::init_agas_console_log(
                lvl, HPX_MOVE(logdest), HPX_MOVE(logformat));
            break;

        case logging_destination::parcel:
            detail::init_parcel_log(lvl, logdest, logformat,
                detail::default_isconsole, detail::default_set_console_dest,
                detail::default_define_formatters);
            detail::init_parcel_console_log(
                lvl, HPX_MOVE(logdest), HPX_MOVE(logformat));
            break;
#else
        case logging_destination::agas:
        case logging_destination::timing:
        case logging_destination::parcel:
            [[fallthrough]];
#endif

        case logging_destination::hpx:
            detail::init_hpx_log(lvl, logdest, logformat,
                detail::default_isconsole, detail::default_set_console_dest,
                detail::default_define_formatters);
            detail::init_hpx_console_log(
                lvl, HPX_MOVE(logdest), HPX_MOVE(logformat));
            break;

        case logging_destination::app:
            detail::init_app_log(lvl, logdest, logformat,
                detail::default_isconsole, detail::default_set_console_dest,
                detail::default_define_formatters);
            detail::init_app_console_log(
                lvl, HPX_MOVE(logdest), HPX_MOVE(logformat));
            break;

        case logging_destination::debuglog:
            detail::init_debuglog_log(lvl, logdest, logformat,
                detail::default_isconsole, detail::default_set_console_dest,
                detail::default_define_formatters);
            detail::init_debuglog_console_log(
                lvl, HPX_MOVE(logdest), HPX_MOVE(logformat));
            break;
        }
    }
}    // namespace hpx::util

#else

#include <hpx/init_runtime_local/detail/init_logging.hpp>
#include <hpx/modules/logging.hpp>
#include <hpx/modules/util.hpp>

#include <iostream>
#include <string>

namespace hpx::util {

    //////////////////////////////////////////////////////////////////////////
    void enable_logging(logging_destination, std::string const&,
        std::string const&, std::string const&)
    {
    }

    void disable_logging(logging_destination) noexcept {}

    //////////////////////////////////////////////////////////////////////////
    namespace detail {

        void warn_if_logging_requested(runtime_configuration& ini)
        {
            using util::get_entry_as;

            // warn if logging is requested
            if (get_entry_as<int>(ini, "hpx.logging.level", -1) > 0 ||
                get_entry_as<int>(ini, "hpx.logging.timing.level", -1) > 0 ||
                get_entry_as<int>(ini, "hpx.logging.agas.level", -1) > 0 ||
                get_entry_as<int>(ini, "hpx.logging.debuglog.level", -1) > 0 ||
                get_entry_as<int>(ini, "hpx.logging.application.level", -1) > 0)
            {
                std::cerr
                    << "hpx::init_logging: warning: logging is requested even "
                       "while it was disabled at compile time. If you "
                       "need logging to be functional, please reconfigure and "
                       "rebuild HPX with HPX_WITH_LOGGING set to ON."
                    << std::endl;
            }
        }
    }    // namespace detail
}    // namespace hpx::util

#endif    // HPX_HAVE_LOGGING
STEllAR-GROUP / hpx / #882

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous
