souffle::SignalHandler Class Reference

Class SignalHandler captures signals and reports the context where the signal occurs. More...

#include <SignalHandler.h>

Collaboration diagram for souffle::SignalHandler:

Public Member Functions
void	enableLogging ()
void	error (const std::string &error)
void	reset ()
void	set ()
void	setMsg (const char *m)

Static Public Member Functions
static SignalHandler *	instance ()

Private Member Functions
	SignalHandler ()

Static Private Member Functions
static void	handler (int signal)
	Signal handler for various types of signals. More...

Private Attributes
bool	isSet = false
bool	logMessages = false
std::atomic< const char * >	msg
void(*	prevFpeHandler )(int) = nullptr
void(*	prevIntHandler )(int) = nullptr
void(*	prevSegVHandler )(int) = nullptr

Detailed Description

Class SignalHandler captures signals and reports the context where the signal occurs.

The signal handler is implemented as a singleton.

Definition at line 41 of file SignalHandler.h.

Constructor & Destructor Documentation

SignalHandler()

souffle::SignalHandler::SignalHandler ( )

inlineprivate

Definition at line 181 of file SignalHandler.h.

Member Function Documentation

enableLogging()

void souffle::SignalHandler::enableLogging ( )

inline

Definition at line 56 of file SignalHandler.h.

                   {
                if (sameLine) {
                    sameLine = false;

error()

void souffle::SignalHandler::error ( const std::string &  error )

inline

Definition at line 138 of file SignalHandler.h.

                                    {

handler()

static void souffle::SignalHandler::handler ( int  signal )

inlinestaticprivate

Signal handler for various types of signals.

Definition at line 164 of file SignalHandler.h.

                    : msg(nullptr) {}
};
 
}  // namespace souffle

instance()

static SignalHandler* souffle::SignalHandler::instance ( )

inlinestatic

Definition at line 50 of file SignalHandler.h.

                                                       {

reset()

void souffle::SignalHandler::reset ( )

inline

Definition at line 113 of file SignalHandler.h.

                                                             {
                perror("Failed to reset SIGSEGV signal handler.");
                exit(1);
            }
            isSet = false;
        }
    }
 
    /***
     * error handling routine that prints the rule context.
     */
 
    void error(const std::string& error) {
        if (msg != nullptr) {
            std::cerr << error << " in rule:\n" << msg << std::endl;
        } else {
            std::cerr << error << std::endl;
        }
        exit(1);

set()

void souffle::SignalHandler::set ( )

inline

Definition at line 88 of file SignalHandler.h.

                                                                         {
                perror("Failed to set SIGSEGV signal handler.");
                exit(1);
            }
            isSet = true;
        }
    }
 
    /***
     * reset signal handlers
     */
    void reset() {
        if (isSet) {
            // reset floating point exception
            if (signal(SIGFPE, prevFpeHandler) == SIG_ERR) {
                perror("Failed to reset SIGFPE signal handler.");
                exit(1);
            }
            // user interrupts

setMsg()

void souffle::SignalHandler::setMsg ( const char *  m )

inline

Definition at line 60 of file SignalHandler.h.

                             : outputMessage) {
                    if (c == '\n' || c == '\t') {
                        c = ' ';
                    }
                }
                std::cout << "Starting work on " << outputMessage << std::endl;
            }
        }
        msg = m;
    }
 
    /***
     * set signal handlers
     */
    void set() {
        if (!isSet && std::getenv("SOUFFLE_ALLOW_SIGNALS") == nullptr) {
            // register signals
            // floating point exception
            if ((prevFpeHandler = signal(SIGFPE, handler)) == SIG_ERR) {
                perror("Failed to set SIGFPE signal handler.");
                exit(1);
            }

Field Documentation

isSet

bool souffle::SignalHandler::isSet = false

private

Definition at line 152 of file SignalHandler.h.

logMessages

bool souffle::SignalHandler::logMessages = false

private

Definition at line 154 of file SignalHandler.h.

msg

std::atomic<const char*> souffle::SignalHandler::msg

private

Definition at line 149 of file SignalHandler.h.

prevFpeHandler

void(* souffle::SignalHandler::prevFpeHandler) (int) = nullptr

private

Definition at line 157 of file SignalHandler.h.

prevIntHandler

void(* souffle::SignalHandler::prevIntHandler) (int) = nullptr

private

Definition at line 158 of file SignalHandler.h.

prevSegVHandler

void(* souffle::SignalHandler::prevSegVHandler) (int) = nullptr

private

Definition at line 159 of file SignalHandler.h.

---

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

• include/souffle/SignalHandler.h