tim::signal_settings Class Reference

#include "timemory/utility/declaration.hpp"

Collaboration diagram for tim::signal_settings:

Classes
struct	signals_data

Public Types
using	signal_set_t = std::set< sys_signal >
using	signal_function_t = std::function< void(int)>

Static Public Member Functions
static bool &	allow ()
static bool	is_active ()
static void	set_active (bool val)
static void	enable (const sys_signal &)
static void	disable (const sys_signal &)
static std::string	str (const sys_signal &)
static std::string	str (bool report_disabled=false)
static void	check_environment ()
static void	set_exit_action (signal_function_t _f)
static void	exit_action (int errcode)
static signal_set_t	get_enabled ()
static signal_set_t	get_disabled ()
static signal_set_t	get_default ()
static bool &	enable_all ()
static bool &	disable_all ()

Static Protected Member Functions
static signals_data &	f_signals ()

Detailed Description

Definition at line 97 of file declaration.hpp.

Member Typedef Documentation

signal_function_t

using tim::signal_settings::signal_function_t = std::function<void(int)>

Definition at line 101 of file declaration.hpp.

signal_set_t

using tim::signal_settings::signal_set_t = std::set<sys_signal>

Definition at line 100 of file declaration.hpp.

Member Function Documentation

allow()

bool & tim::signal_settings::allow ( )

inlinestatic

Definition at line 160 of file declaration.hpp.

{
    static bool _instance = true;
    return _instance;
}

Referenced by tim::update_signal_detection().

check_environment()

void tim::signal_settings::check_environment ( )

inlinestatic

Definition at line 90 of file signals.hpp.

{
    using match_t = std::pair<std::string, sys_signal>;
 
    auto _list = {
        match_t("HANGUP", sys_signal::Hangup),
        match_t("INTERRUPT", sys_signal::Interrupt),
        match_t("QUIT", sys_signal::Quit),
        match_t("ILLEGAL", sys_signal::Illegal),
        match_t("TRAP", sys_signal::Trap),
        match_t("ABORT", sys_signal::Abort),
        match_t("EMULATE", sys_signal::Emulate),
        match_t("FPE", sys_signal::FPE),
        match_t("KILL", sys_signal::Kill),
        match_t("BUS", sys_signal::Bus),
        match_t("SEGFAULT", sys_signal::SegFault),
        match_t("SYSTEM", sys_signal::System),
        match_t("PIPE", sys_signal::Pipe),
        match_t("ALARM", sys_signal::Alarm),
        match_t("TERMINATE", sys_signal::Terminate),
        match_t("URGENT", sys_signal::Urgent),
        match_t("STOP", sys_signal::Stop),
        match_t("CPUTIME", sys_signal::CPUtime),
        match_t("FILESIZE", sys_signal::FileSize),
        match_t("VIRTUALALARM", sys_signal::VirtualAlarm),
        match_t("PROFILEALARM", sys_signal::ProfileAlarm),
        match_t("USER1", sys_signal::User1),
        match_t("USER2", sys_signal::User2),
    };
 
    for(const auto& itr : _list)
    {
        auto _enable  = get_env("SIGNAL_ENABLE_" + itr.first, false);
        auto _disable = get_env("SIGNAL_DISABLE_" + itr.first, false);
 
        if(_enable)
            signal_settings::enable(itr.second);
        if(_disable)
            signal_settings::disable(itr.second);
    }
 
    if(enable_all())
    {
        for(const auto& itr : _list)
            signal_settings::enable(itr.second);
    }
 
    if(disable_all())
    {
        for(const auto& itr : _list)
            signal_settings::disable(itr.second);
    }
}

References tim::Abort, tim::Alarm, tim::Bus, tim::CPUtime, disable(), disable_all(), tim::Emulate, enable(), enable_all(), tim::FileSize, tim::FPE, tim::get_env(), tim::Hangup, tim::Illegal, tim::Interrupt, tim::Kill, tim::Pipe, tim::ProfileAlarm, tim::Quit, tim::SegFault, tim::Stop, tim::System, tim::Terminate, tim::Trap, tim::Urgent, tim::User1, tim::User2, and tim::VirtualAlarm.

disable()

void tim::signal_settings::disable ( const sys_signal &  _type )

inlinestatic

Definition at line 82 of file signals.hpp.

{
    insert_and_remove(_type, &f_signals().signals_disabled, &f_signals().signals_enabled);
}

References f_signals(), and tim::insert_and_remove().

Referenced by check_environment().

disable_all()

bool & tim::signal_settings::disable_all ( )

inlinestatic

Definition at line 264 of file signals.hpp.

{
    return f_signals().disable_all;
}

References tim::signal_settings::signals_data::disable_all, and f_signals().

Referenced by check_environment().

enable()

void tim::signal_settings::enable ( const sys_signal &  _type )

inlinestatic

Definition at line 74 of file signals.hpp.

{
    insert_and_remove(_type, &f_signals().signals_enabled, &f_signals().signals_disabled);
}

References f_signals(), and tim::insert_and_remove().

Referenced by check_environment(), and tim::if().

enable_all()

bool & tim::signal_settings::enable_all ( )

inlinestatic

Definition at line 256 of file signals.hpp.

{
    return f_signals().enable_all;
}

References tim::signal_settings::signals_data::enable_all, and f_signals().

Referenced by check_environment().

exit_action()

void tim::signal_settings::exit_action ( int  errcode )

inlinestatic

Definition at line 288 of file signals.hpp.

{
    f_signals().signals_exit_func(errcode);
}

References f_signals(), and tim::signal_settings::signals_data::signals_exit_func.

f_signals()

static signals_data & tim::signal_settings::f_signals ( )

inlinestaticprotected

Definition at line 150 of file declaration.hpp.

    {
        static signal_settings::signals_data instance{};
        return instance;
    }

Referenced by disable(), disable_all(), enable(), enable_all(), exit_action(), get_default(), get_disabled(), get_enabled(), is_active(), set_active(), and set_exit_action().

get_default()

signal_settings::signal_set_t tim::signal_settings::get_default ( )

inlinestatic

Definition at line 312 of file signals.hpp.

{
    return f_signals().signals_default;
}

References f_signals(), and tim::signal_settings::signals_data::signals_default.

Referenced by tim::if().

get_disabled()

signal_settings::signal_set_t tim::signal_settings::get_disabled ( )

inlinestatic

Definition at line 304 of file signals.hpp.

{
    return f_signals().signals_disabled;
}

References f_signals(), and tim::signal_settings::signals_data::signals_disabled.

get_enabled()

signal_settings::signal_set_t tim::signal_settings::get_enabled ( )

inlinestatic

Definition at line 296 of file signals.hpp.

{
    return f_signals().signals_enabled;
}

References f_signals(), and tim::signal_settings::signals_data::signals_enabled.

Referenced by tim::if().

is_active()

bool tim::signal_settings::is_active ( )

inlinestatic

Definition at line 248 of file signals.hpp.

{
    return f_signals().signals_active;
}

References f_signals(), and tim::signal_settings::signals_data::signals_active.

set_active()

void tim::signal_settings::set_active ( bool  val )

inlinestatic

Definition at line 272 of file signals.hpp.

{
    f_signals().signals_active = val;
}

References f_signals(), and tim::signal_settings::signals_data::signals_active.

set_exit_action()

void tim::signal_settings::set_exit_action ( signal_function_t  _f )

inlinestatic

Definition at line 280 of file signals.hpp.

{
    f_signals().signals_exit_func = std::move(_f);
}

References f_signals(), and tim::signal_settings::signals_data::signals_exit_func.

Referenced by tim::if().

str() [1/2]

std::string tim::signal_settings::str ( bool  report_disabled = false )

inlinestatic

Definition at line 212 of file signals.hpp.

{
    std::stringstream ss;
    auto              spacer = []() { return "    "; };
 
#if defined(SIGNAL_AVAILABLE)
 
    ss << std::endl
       << spacer() << "Signal detection activated. Signal exception settings:\n"
       << std::endl;
 
    if(report_disabled)
        ss << spacer() << "Enabled:" << std::endl;
    for(const auto& itr : f_signals().signals_enabled)
        ss << spacer() << spacer() << signal_settings::str(itr) << '\n';
 
    if(report_disabled)
    {
        ss << "\n" << spacer() << "Disabled:" << std::endl;
        for(const auto& itr : f_signals().signals_disabled)
            ss << spacer() << spacer() << signal_settings::str(itr) << '\n';
    }
 
#else
 
    ss << std::endl << spacer() << "Signal detection not available" << std::endl;
 
    (void) report_disabled;
#endif
 
    return ss.str();
}

str() [2/2]

std::string tim::signal_settings::str ( const sys_signal &  _type )

inlinestatic

Definition at line 147 of file signals.hpp.

{
    using descript_tuple_t = std::tuple<std::string, int, std::string>;
 
    std::stringstream ss;
    auto              _descript = [&](const descript_tuple_t& _data) {
        ss << " Signal: " << std::setw(10) << std::get<0>(_data)
           << " (error code: " << std::setw(3) << std::get<1>(_data) << ") "
           << std::setw(40) << std::get<2>(_data);
    };
 
    // some of these signals are not handled but added in case they are
    // enabled in the future
    static std::vector<descript_tuple_t> descript_data = {
        descript_tuple_t("SIGHUP", SIGHUP, "terminal line hangup"),
        descript_tuple_t("SIGINT", SIGINT, "interrupt program"),
        descript_tuple_t("SIGQUIT", SIGQUIT, "quit program"),
        descript_tuple_t("SIGILL", SIGILL, "illegal instruction"),
        descript_tuple_t("SIGTRAP", SIGTRAP, "trace trap"),
        descript_tuple_t("SIGABRT", SIGABRT, "abort program (formerly SIGIOT)"),
        descript_tuple_t("SIGEMT", SIGEMT, "emulate instruction executed"),
        descript_tuple_t("SIGFPE", SIGFPE, "floating-point exception"),
        descript_tuple_t("SIGKILL", SIGKILL, "kill program"),
        descript_tuple_t("SIGBUS", SIGBUS, "bus error"),
        descript_tuple_t("SIGSEGV", SIGSEGV, "segmentation violation"),
        descript_tuple_t("SIGSYS", SIGSYS, "non-existent system call invoked"),
        descript_tuple_t("SIGPIPE", SIGPIPE, "write on a pipe with no reader"),
        descript_tuple_t("SIGALRM", SIGALRM, "real-time timer expired"),
        descript_tuple_t("SIGTERM", SIGTERM, "software termination signal"),
        descript_tuple_t("SIGURG", SIGURG, "urgent condition present on socket"),
        descript_tuple_t("SIGSTOP", SIGSTOP, "stop (cannot be caught or ignored)"),
        descript_tuple_t("SIGTSTP", SIGTSTP, "stop signal generated from keyboard"),
        descript_tuple_t("SIGCONT", SIGCONT, "continue after stop"),
        descript_tuple_t("SIGCHLD", SIGCHLD, "child status has changed"),
        descript_tuple_t("SIGTTIN", SIGTTIN,
                         "background read attempted from control terminal"),
        descript_tuple_t("SIGTTOU", SIGTTOU,
                         "background write attempted to control terminal"),
        descript_tuple_t("SIGIO ", SIGIO, "I/O is possible on a descriptor"),
        descript_tuple_t("SIGXCPU", SIGXCPU, "cpu time limit exceeded"),
        descript_tuple_t("SIGXFSZ", SIGXFSZ, "file size limit exceeded"),
        descript_tuple_t("SIGVTALRM", SIGVTALRM, "virtual time alarm"),
        descript_tuple_t("SIGPROF", SIGPROF, "profiling timer alarm"),
        descript_tuple_t("SIGWINCH", SIGWINCH, "Window size change"),
        descript_tuple_t("SIGINFO", SIGINFO, "status request from keyboard"),
        descript_tuple_t("SIGUSR1", SIGUSR1, "User defined signal 1"),
        descript_tuple_t("SIGUSR2", SIGUSR2, "User defined signal 2")
    };
 
    int key = (int) _type;
    for(const auto& itr : descript_data)
    {
        if(std::get<1>(itr) == key)
        {
            _descript(itr);
            break;
        }
    }
 
    return ss.str();
}

Referenced by tim::if().

---

The documentation for this class was generated from the following files:

• timemory/utility/declaration.hpp
• timemory/utility/bits/signals.hpp