---

IgOnCrashService Class Reference

#include <Iguana/Framework/interface/IgOnCrashService.h>

List of all members.

Public Types
typedef void(*	FatalExceptionHook )(const char *type, const char *what)
typedef bool(*	FatalSignalHook )(int sig, siginfo_t *info, void *x)
Static Public Member Functions
static void	fatalException (const char *type, const char *what)
static FatalExceptionHook	fatalExceptionHook (FatalExceptionHook hook)
	Set fatal exception handler.
static const char *	fatalMessage (void)
	Message template for crashes; has one s arg: reason.
static FatalSignalHook	fatalSignalHook (FatalSignalHook hook)
	Set fatal signal handler.
static const char *	fatalTitle (void)
	Title template for crashes; has two s args: topic, title.
static bool	init (const char *appname)
static void	printFatalException (const char *type, const char *what)
static void	printFatalMessage (const char *topic, const char *title, const char *reason)
Private Member Functions
	IgOnCrashService ()
Static Private Member Functions
static void	defaultFatalException (const char *type, const char *what)
static bool	defaultFatalSignal (int sig, siginfo_t *info, void *x)
static void	explainException (const char *type, const char *what, std::string &topic, std::string &title, std::string &reason)
static bool	fatalSignal (int sig, siginfo_t *info, void *x)
Static Private Attributes
static FatalExceptionHook	s_exceptionHook = defaultFatalException
static FatalSignalHook	s_signalHook = defaultFatalSignal

---

Detailed Description

Definition at line 17 of file IgOnCrashService.h.

---

Member Typedef Documentation

typedef void(* IgOnCrashService::FatalExceptionHook)(const char *type, const char *what)

typedef bool(* IgOnCrashService::FatalSignalHook)(int sig, siginfo_t *info, void *x)

---

Constructor & Destructor Documentation

IgOnCrashService::IgOnCrashService

(

)

[private]

---

Member Function Documentation

void IgOnCrashService::defaultFatalException	(	const char *	type,
		const char *	what
	)			[static, private]

Definition at line 237 of file IgOnCrashService.cc.

References printFatalException().

Referenced by init().

{
    printFatalException (type, what);
}

bool IgOnCrashService::defaultFatalSignal	(	int	sig,
		siginfo_t *	info,
		void *	x
	)			[static, private]

Definition at line 157 of file IgOnCrashService.cc.

References lat::Signal::fatalDump(), name, lat::Signal::name(), printFatalMessage(), and signum.

Referenced by init().

{
    char        buf [128];
    int         signum = sig < 0 ? -sig : sig;
    bool        have_core = sig < 0;
    const char  *name = lat::Signal::name (signum);

    if (name)
        sprintf (buf, "`%.100s' signal", name);
    else
        sprintf (buf, "Signal %d", signum);

    if (have_core)
        strcat (buf, " (core dumped)");

    printFatalMessage ("Internal error", buf, buf);
    return lat::Signal::fatalDump (sig, info, x);
}

void IgOnCrashService::explainException	(	const char *	type,
		const char *	what,
		std::string &	topic,
		std::string &	title,
		std::string &	reason
	)			[static, private]

Definition at line 180 of file IgOnCrashService.cc.

Referenced by printFatalException().

{
    if (! what || ! *what)
        what = "C++ exception";

    topic  = "Internal error";
    title  = what;
    reason = what;

    // GCC prepends the name length to type names, strip them off
    while (type && isdigit (*type))
        type++;

    if (type && *type)
        topic = type;

    // Convert underscores to spaces
    std::string::size_type pos = topic.find ('_');
    while (pos != std::string::npos)
    {
        topic.replace (pos, 1, 1, ' ');
        pos = topic.find ('_');
    }

    // Uppercase first character
    topic[0] = toupper (topic[0]);
    if (type && *type)
        reason.insert (0, topic + ": ");
}

void IgOnCrashService::fatalException	(	const char *	type,
		const char *	what
	)			[static]

Definition at line 226 of file IgOnCrashService.cc.

References ASSERT, and s_exceptionHook.

Referenced by IgApplication::loadDriver().

{
    // FIXME: should be dialog in a graphical app!
    // FIXME: should interrupt here any subprocesses/threads
    // FIXME: should this be a service others can hook into?
    
    ASSERT (s_exceptionHook);
    s_exceptionHook (type, what);
}

IgOnCrashService::FatalExceptionHook IgOnCrashService::fatalExceptionHook

(

FatalExceptionHook

hook

)

[static]

Set fatal exception handler.

Sets current fatal exception handler to hook and returns the old one. If hook is null, doesn't change the current value, just returns the old one. The caller should restore the old handler when the new one becomes invalid. It can also call the old handlers in a chain if desirable.

Definition at line 91 of file IgOnCrashService.cc.

References old, and s_exceptionHook.

{
    FatalExceptionHook old = s_exceptionHook;
    if (hook)
        s_exceptionHook = hook;
    return old;
}

const char * IgOnCrashService::fatalMessage

(

void

)

[static]

Message template for crashes; has one s arg: reason.

Definition at line 111 of file IgOnCrashService.cc.

References IGUANA_APP, IGUANA_COMPILER, IGUANA_CXX, IGUANA_HOST, IGUANA_UNAME, IGUANA_VERSION, and IGUANA_WHO.

Referenced by printFatalMessage().

{
    // FIXME: put in apps etc. from service constructor args?
    return "Oh dear!  You have found a bug in CMSSW.\n\n"

        "If you can reproduce this bug, please send a bug report\n"
        "to <iguana-developers@cern.ch>, giving a subject like\n\n"

        "    %s in " IGUANA_APP " " IGUANA_VERSION " (" IGUANA_HOST ")\n\n"

        "To enable us to fix the bug, please include the following information:\n"
        "* What you were doing to get this message.  Please report all the facts.\n"
        "* The following build configuration information:\n"
        "   " IGUANA_UNAME "\n"
        "   " IGUANA_CXX " (" IGUANA_COMPILER ")\n"
        "   built by " IGUANA_WHO " on " __DATE__ " " __TIME__ "\n"
        "* The stack trace and loaded libraries list following this message.\n"
        "Please read also the section \"Reporting Bugs\" in the " IGUANA_APP " manual.\n\n"

        "We thank you for your support and our apologies for the inconvenience.\n\n";
}

bool IgOnCrashService::fatalSignal	(	int	sig,
		siginfo_t *	info,
		void *	x
	)			[static, private]

Definition at line 146 of file IgOnCrashService.cc.

References ASSERT, and s_signalHook.

Referenced by init().

{
    // FIXME: should interrupt here any subprocesses/threads
    // FIXME: should this be a service others can hook into?
    // FIXME: deal with recursive crashes
    // FIXME: be smarter about SIGINT
    ASSERT (s_signalHook);
    return s_signalHook (sig, info, x);
}

IgOnCrashService::FatalSignalHook IgOnCrashService::fatalSignalHook

(

FatalSignalHook

hook

)

[static]

Set fatal signal handler.

Sets current fatal signal handler to hook and returns the old one. If hook is null, doesn't change the current value, just returns the old one. The caller should restore the old handler when the new one becomes invalid. It can also call the old handlers in a chain if desirable.

Definition at line 75 of file IgOnCrashService.cc.

References old, and s_signalHook.

{
    FatalSignalHook old = s_signalHook;
    if (hook)
        s_signalHook = hook;
    return old;
}

const char * IgOnCrashService::fatalTitle

(

void

)

[static]

Title template for crashes; has two s args: topic, title.

Definition at line 104 of file IgOnCrashService.cc.

Referenced by printFatalMessage().

{
    return "\n%s (%s).\n\n";
}

bool IgOnCrashService::init

(

const char *

appname

)

[static]

Definition at line 36 of file IgOnCrashService.cc.

References ASSERT, defaultFatalException(), defaultFatalSignal(), fatalSignal(), lat::Signal::handleFatal(), s_exceptionHook, and s_signalHook.

Referenced by IgApplication::initDebugging().

{
    // FIXME: For GUI app drivers, install fatal X error handler too
    // (or redirect whatever Qt has already), and hook it into
    // fatal_error_hook structure.

    // FIXME: Maybe install a graphical notification dialog in the app
    // driver?  If yes, create the dialog beforehand, and when showing
    // it, make sure the dialog is mapped and X is synchronised before
    // returning from the equivalent of the fatal_error_hook().  This
    // will allow us to exit if we get another signal (or an X error?)
    // during that time.

    // FIXME: If we have subprocesses that we are communicating with
    // (or a thread, or another interruptable subunit), the SIGINT
    // handler should send an interrupt to it (a C-c character for
    // example).

    // FIXME: App driver should disable core dump on fatal signals
    // while in the main event loop (that is, allow them from init
    // till exit sequence begins) -- except if the user has requested
    // otherwise.

    // FIXME: Install a quit cleanup handler?

    ASSERT (s_signalHook == defaultFatalSignal);
    ASSERT (s_exceptionHook == defaultFatalException);
    lat::Signal::handleFatal (appname, -1, fatalSignal);
    return true;
}

void IgOnCrashService::printFatalException	(	const char *	type,
		const char *	what
	)			[static]

Definition at line 215 of file IgOnCrashService.cc.

References explainException(), printFatalMessage(), and indexGen::title.

Referenced by defaultFatalException().

{
    std::string title;
    std::string reason;
    std::string topic;

    explainException (type, what, title, reason, topic);
    printFatalMessage (title.c_str (), reason.c_str (), topic.c_str ());
}

void IgOnCrashService::printFatalMessage	(	const char *	topic,
		const char *	title,
		const char *	reason
	)			[static]

Definition at line 137 of file IgOnCrashService.cc.

References TestMuL1L2Filter_cff::cerr, fatalMessage(), and fatalTitle().

Referenced by defaultFatalSignal(), and printFatalException().

{
    std::cerr.flush ();
    fprintf (stderr, fatalTitle (), topic, title);
    fprintf (stderr, fatalMessage (), reason);
}

---

Member Data Documentation

IgOnCrashService::FatalExceptionHook IgOnCrashService::s_exceptionHook = defaultFatalException [static, private]

Definition at line 57 of file IgOnCrashService.h.

Referenced by fatalException(), fatalExceptionHook(), and init().

IgOnCrashService::FatalSignalHook IgOnCrashService::s_signalHook = defaultFatalSignal [static, private]

Definition at line 56 of file IgOnCrashService.h.

Referenced by fatalSignal(), fatalSignalHook(), and init().

---

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

• Iguana/Framework/interface/IgOnCrashService.h
• Iguana/Framework/src/IgOnCrashService.cc

---