BmnCoreDumpGuard.h

Go to the documentation of this file.

#ifndef BMNCOREDUMPGUARD_H
#define BMNCOREDUMPGUARD_H 1
 
#include "Rtypes.h"
 
/** Class preventing 'core.*' dumps when a BmnRoot process is terminated by a fatal signal.
 ** The guard is installed automatically when the library is loaded, so no changes in the macros are required.
 ** It works regardless of the 'ulimit -c' value and of the /proc/sys/kernel/core_pattern setting, which makes it
 ** usable on the user machines as well as on the cluster nodes. **/
class BmnCoreDumpGuard
{
  public:
    // install the guard for the fatal signals which are still processed by the system;
    // it is called automatically at the library loading, unless the ENABLE_CORE_DUMP environment variable is set
    // return value: true - the guard is installed, false - the core dumps are requested by ENABLE_CORE_DUMP
    static bool Install();
    // restore the default behaviour for the signals taken by Install(), i.e. let the system write the core dump again
    // return value: true - the guard was installed and is removed now, false - there was nothing to remove
    static bool Uninstall();
    // whether the guard is installed
    static bool IsInstalled() { return fgIsInstalled; }
 
  private:
    BmnCoreDumpGuard() {}
    ~BmnCoreDumpGuard() {}
 
    // whether the guard is installed for at least one signal
    static bool fgIsInstalled;
 
    ClassDef(BmnCoreDumpGuard, 1)
};
 
#endif