edm::service::InitRootHandlers Class Reference

#include <InitRootHandlers.h>

Inheritance diagram for edm::service::InitRootHandlers:

Public Member Functions
	InitRootHandlers (ParameterSet const &pset, ActivityRegistry &iReg)
virtual	~InitRootHandlers ()
Public Member Functions inherited from edm::RootHandlers
template<typename F >
void	ignoreWarningsWhileDoing (F iFunc)
	RootHandlers ()
virtual	~RootHandlers ()

Static Public Member Functions
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	stacktraceFromThread ()

Private Member Functions
void	cachePidInfo ()
void	cachePidInfoHandler (unsigned int, unsigned int)
virtual void	enableWarnings_ () override
virtual void	ignoreWarnings_ () override
virtual void	initializeThisThreadForUse () override
virtual void	willBeUsingThreads () override

Static Private Member Functions
static char *const *	getPstackArgv ()
static void	stacktraceHelperThread ()

Private Attributes
bool	autoLibraryLoader_
bool	loadAllDictionaries_
bool	resetErrHandler_
std::shared_ptr< const void >	sigBusHandler_
std::shared_ptr< const void >	sigIllHandler_
std::shared_ptr< const void >	sigSegvHandler_
bool	unloadSigHandler_

Static Private Attributes
static int	childToParent_ [2] = {-1, -1}
static std::unique_ptr < std::thread >	helperThread_
static int	parentToChild_ [2] = {-1, -1}
static char	pidString_ [pidStringLength_] = {}
static const int	pidStringLength_ = 200
static char *const	pstackArgv_ [] = {pstackName, dashC, InitRootHandlers::pidString_, 0 }

Friends
int	cmssw_stacktrace (void *)

Detailed Description

Definition at line 17 of file InitRootHandlers.h.

Constructor & Destructor Documentation

edm::service::InitRootHandlers::InitRootHandlers ( ParameterSet const &  pset, ActivityRegistry &  iReg  )

explicit

Definition at line 491 of file InitRootHandlers.cc.

References autoLibraryLoader_, edm::TypeWithDict::byName(), cachePidInfo(), cachePidInfoHandler(), HLT_25ns14e33_v3_cff::debugLevel, edm::ParameterSet::getUntrackedParameter(), edm::hasDictionary(), edm::installCustomHandler(), resetErrHandler_, edm::setRefCoreStreamer(), sigBusHandler_, sigIllHandler_, sigSegvHandler_, unloadSigHandler_, and edm::ActivityRegistry::watchPostForkReacquireResources().

      : RootHandlers(),
        unloadSigHandler_(pset.getUntrackedParameter<bool> ("UnloadRootSigHandler")),
        resetErrHandler_(pset.getUntrackedParameter<bool> ("ResetRootErrHandler")),
        loadAllDictionaries_(pset.getUntrackedParameter<bool>("LoadAllDictionaries")),
        autoLibraryLoader_(loadAllDictionaries_ or pset.getUntrackedParameter<bool> ("AutoLibraryLoader"))
    {
      
      if(unloadSigHandler_) {
      // Deactivate all the Root signal handlers and restore the system defaults
        gSystem->ResetSignal(kSigChild);
        gSystem->ResetSignal(kSigBus);
        gSystem->ResetSignal(kSigSegmentationViolation);
        gSystem->ResetSignal(kSigIllegalInstruction);
        gSystem->ResetSignal(kSigSystem);
        gSystem->ResetSignal(kSigPipe);
        gSystem->ResetSignal(kSigAlarm);
        gSystem->ResetSignal(kSigUrgent);
        gSystem->ResetSignal(kSigFloatingException);
        gSystem->ResetSignal(kSigWindowChanged);
      } else if(pset.getUntrackedParameter<bool>("AbortOnSignal")){
        cachePidInfo();

        //NOTE: ROOT can also be told to abort on these kinds of problems BUT
        // it requires an TApplication to be instantiated which causes problems
        gSystem->ResetSignal(kSigBus);
        gSystem->ResetSignal(kSigSegmentationViolation);
        gSystem->ResetSignal(kSigIllegalInstruction);
        installCustomHandler(SIGBUS,sig_dostack_then_abort);
        sigBusHandler_ = std::shared_ptr<const void>(nullptr,[](void*) {
          installCustomHandler(SIGBUS,sig_abort);
        });
        installCustomHandler(SIGSEGV,sig_dostack_then_abort);
        sigSegvHandler_ = std::shared_ptr<const void>(nullptr,[](void*) {
          installCustomHandler(SIGSEGV,sig_abort);
        });
        installCustomHandler(SIGILL,sig_dostack_then_abort);
        sigIllHandler_ = std::shared_ptr<const void>(nullptr,[](void*) {
          installCustomHandler(SIGILL,sig_abort);
        });
        iReg.watchPostForkReacquireResources(this, &InitRootHandlers::cachePidInfoHandler);
      }

      if(resetErrHandler_) {

      // Replace the Root error handler with one that uses the MessageLogger
        SetErrorHandler(RootErrorHandler);
      }

      // Enable automatic Root library loading.
      if(autoLibraryLoader_) {
        gInterpreter->SetClassAutoloading(1);
      }

      // Set ROOT parameters.
      TTree::SetMaxTreeSize(kMaxLong64);
      TH1::AddDirectory(kFALSE);
      //G__SetCatchException(0);

      // Set custom streamers
      setRefCoreStreamer();

      // Load the library containing dictionaries for std:: classes, if not already loaded.
      if (!hasDictionary(typeid(std::vector<std::vector<unsigned int> >))) {
         TypeWithDict::byName("std::vector<std::vector<unsigned int> >");
      }

      int debugLevel = pset.getUntrackedParameter<int>("DebugLevel");
      if(debugLevel >0) {
    gDebug = debugLevel;
      }
    }

edm::service::InitRootHandlers::~InitRootHandlers ( )

virtual

Definition at line 564 of file InitRootHandlers.cc.

References f, and getGTfromDQMFile::obj.

                                         {
      // close all open ROOT files
      TIter iter(gROOT->GetListOfFiles());
      TObject *obj = nullptr;
      while(nullptr != (obj = iter.Next())) {
        TFile* f = dynamic_cast<TFile*>(obj);
        if(f) {
          // We get a new iterator each time,
          // because closing a file can invalidate the iterator
          f->Close();
          iter = TIter(gROOT->GetListOfFiles());
        }
      }
    }

Member Function Documentation

void edm::service::InitRootHandlers::cachePidInfo ( )

private

Definition at line 627 of file InitRootHandlers.cc.

References childToParent_, helperThread_, edm::errors::OtherCMS, parentToChild_, pidString_, pidStringLength_, and stacktraceHelperThread().

Referenced by cachePidInfoHandler(), and InitRootHandlers().

    {
      if (snprintf(pidString_, pidStringLength_-1, "gdb -quiet -p %d 2>&1 <<EOF |\n"
        "set width 0\n"
        "set height 0\n"
        "set pagination no\n"
        "thread apply all bt\n"
        "EOF\n"
        "/bin/sed -n -e 's/^\\((gdb) \\)*//' -e '/^#/p' -e '/^Thread/p'", getpid()) >= pidStringLength_)
      {
        std::ostringstream sstr;
        sstr << "Unable to pre-allocate stacktrace handler information";
        edm::Exception except(edm::errors::OtherCMS, sstr.str());
        throw except;
      }

      // These are initialized to -1; harmless to close an invalid FD.
      // If this is called post-fork, we don't want to be communicating on
      // these FDs as they are used internally by the parent.
      close(childToParent_[0]);
      close(childToParent_[1]);
      childToParent_[0] = -1; childToParent_[1] = -1;
      close(parentToChild_[0]);
      close(parentToChild_[1]);
      parentToChild_[0] = -1; parentToChild_[1] = -1;

      if (-1 == pipe2(childToParent_, O_CLOEXEC))
      {
        std::ostringstream sstr;
        sstr << "Failed to create child-to-parent pipes (errno=" << errno << "): " << strerror(errno);
        edm::Exception except(edm::errors::OtherCMS, sstr.str());
        throw except;
      }

      if (-1 == pipe2(parentToChild_, O_CLOEXEC))
      {
        close(childToParent_[0]); close(childToParent_[1]);
        childToParent_[0] = -1; childToParent_[1] = -1;
        std::ostringstream sstr;
        sstr << "Failed to create child-to-parent pipes (errno=" << errno << "): " << strerror(errno);
        edm::Exception except(edm::errors::OtherCMS, sstr.str());
        throw except;
      }

      helperThread_.reset(new std::thread(stacktraceHelperThread));
      helperThread_->detach();
    }

void edm::service::InitRootHandlers::cachePidInfoHandler ( unsigned  int, unsigned  int  )

inlineprivate

Definition at line 35 of file InitRootHandlers.h.

References cachePidInfo().

Referenced by InitRootHandlers().

{cachePidInfo();}

void edm::service::InitRootHandlers::enableWarnings_ ( )

overrideprivatevirtual

Implements edm::RootHandlers.

Definition at line 617 of file InitRootHandlers.cc.

                                      {
      s_ignoreWarnings =false;
    }

void edm::service::InitRootHandlers::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 593 of file InitRootHandlers.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), and edm::ParameterSetDescription::setComment().

                                                                                   {
      ParameterSetDescription desc;
      desc.setComment("Centralized interface to ROOT.");
      desc.addUntracked<bool>("UnloadRootSigHandler", false)
          ->setComment("If True, signals are handled by this service, rather than by ROOT.");
      desc.addUntracked<bool>("ResetRootErrHandler", true)
          ->setComment("If True, ROOT messages (e.g. errors, warnings) are handled by this service, rather than by ROOT.");
      desc.addUntracked<bool>("AutoLibraryLoader", true)
          ->setComment("If True, enables automatic loading of data dictionaries.");
      desc.addUntracked<bool>("LoadAllDictionaries",false)
          ->setComment("If True, loads all ROOT dictionaries.");
      desc.addUntracked<bool>("AbortOnSignal",true)
      ->setComment("If True, do an abort when a signal occurs that causes a crash. If False, ROOT will do an exit which attempts to do a clean shutdown.");
      desc.addUntracked<int>("DebugLevel",0)
      ->setComment("Sets ROOT's gDebug value.");
      descriptions.add("InitRootHandlers", desc);
    }

char *const * edm::service::InitRootHandlers::getPstackArgv ( )

staticprivate

Definition at line 612 of file InitRootHandlers.cc.

References pstackArgv_.

Referenced by edm::service::cmssw_stacktrace().

                                    {
      return pstackArgv_;
    }

void edm::service::InitRootHandlers::ignoreWarnings_ ( )

overrideprivatevirtual

Implements edm::RootHandlers.

Definition at line 622 of file InitRootHandlers.cc.

                                      {
      s_ignoreWarnings = true;
    }

void edm::service::InitRootHandlers::initializeThisThreadForUse ( )

overrideprivatevirtual

Implements edm::RootHandlers.

Definition at line 589 of file InitRootHandlers.cc.

                                                      {
      static thread_local TThread guard;
    }

void edm::service::InitRootHandlers::stacktraceFromThread ( )

static

Definition at line 407 of file InitRootHandlers.cc.

References childToParent_, parentToChild_, and query::result.

    {
      int result = full_write(parentToChild_[1], "1");
      if (result < 0)
      {
        full_cerr_write("\n\nAttempt to request stacktrace failed: ");
        full_cerr_write(strerror(-result));
        full_cerr_write("\n");
        return;
      }
      char buf[2]; buf[1] = '\0';
      if ((result = full_read(childToParent_[0], buf, 1, 5*60)) < 0)
      {
        full_cerr_write("\n\nWaiting for stacktrace completion failed: ");
        if (result == -ETIMEDOUT)
        {
          full_cerr_write("timed out waiting for GDB to complete.");
        }
        else
        {
          full_cerr_write(strerror(-result));
        }
        full_cerr_write("\n");
        return;
      }
    }

void edm::service::InitRootHandlers::stacktraceHelperThread ( )

staticprivate

Definition at line 356 of file InitRootHandlers.cc.

References childToParent_, edm::service::cmssw_stacktrace_fork(), parentToChild_, and query::result.

Referenced by cachePidInfo().

    {
      int toParent = childToParent_[1];
      int fromParent = parentToChild_[0];
      char buf[2]; buf[1] = '\0';
      while(true)
      {
        int result = full_read(fromParent, buf, 1);
        if (result < 0)
        {
          // To avoid a deadlock (this function is NOT re-entrant), reset signals
          // We never set them back to the CMSSW handler because we assume the parent
          // thread will abort for us.
          set_default_signals();
          close(toParent);
          full_cerr_write("\n\nTraceback helper thread failed to read from parent: ");
          full_cerr_write(strerror(-result));
          full_cerr_write("\n");
          ::abort();
        }
        if (buf[0] == '1')
        {
          set_default_signals();
          cmssw_stacktrace_fork();
          full_write(toParent, buf);
        }
        else if (buf[0] == '2')
        {
          // We have just finished forking.  Reload the file descriptors for thread
          // communication.
          close(toParent);
          close(fromParent);
          toParent = childToParent_[1];
          fromParent = parentToChild_[0];
        }
        else if (buf[0] == '3')
        {
          break;
        }
        else
        {
          set_default_signals();
          close(toParent);
          full_cerr_write("\n\nTraceback helper thread got unknown command from parent: ");
          full_cerr_write(buf);
          full_cerr_write("\n");
          ::abort();
        }
      }
    }

void edm::service::InitRootHandlers::willBeUsingThreads ( )

overrideprivatevirtual

Implements edm::RootHandlers.

Definition at line 579 of file InitRootHandlers.cc.

                                              {
      //Tell Root we want to be multi-threaded
      TThread::Initialize();
      //When threading, also have to keep ROOT from logging all TObjects into a list
      TObject::SetObjectStat(false);
      
      //Have to avoid having Streamers modify themselves after they have been used
      TVirtualStreamerInfo::Optimize(false);
    }

Friends And Related Function Documentation

int cmssw_stacktrace ( void *  )

friend

Member Data Documentation

bool edm::service::InitRootHandlers::autoLibraryLoader_

private

Definition at line 48 of file InitRootHandlers.h.

Referenced by InitRootHandlers().

int edm::service::InitRootHandlers::childToParent_ = {-1, -1}

staticprivate

Definition at line 43 of file InitRootHandlers.h.

Referenced by cachePidInfo(), stacktraceFromThread(), and stacktraceHelperThread().

std::unique_ptr< std::thread > edm::service::InitRootHandlers::helperThread_

staticprivate

Definition at line 44 of file InitRootHandlers.h.

Referenced by cachePidInfo().

bool edm::service::InitRootHandlers::loadAllDictionaries_

private

Definition at line 47 of file InitRootHandlers.h.

int edm::service::InitRootHandlers::parentToChild_ = {-1, -1}

staticprivate

Definition at line 42 of file InitRootHandlers.h.

Referenced by cachePidInfo(), stacktraceFromThread(), and stacktraceHelperThread().

char edm::service::InitRootHandlers::pidString_ = {}

staticprivate

Definition at line 40 of file InitRootHandlers.h.

Referenced by cachePidInfo().

const int edm::service::InitRootHandlers::pidStringLength_ = 200

staticprivate

Definition at line 39 of file InitRootHandlers.h.

Referenced by cachePidInfo().

char *const edm::service::InitRootHandlers::pstackArgv_ = {pstackName, dashC, InitRootHandlers::pidString_, 0 }

staticprivate

Definition at line 41 of file InitRootHandlers.h.

Referenced by getPstackArgv().

bool edm::service::InitRootHandlers::resetErrHandler_

private

Definition at line 46 of file InitRootHandlers.h.

Referenced by InitRootHandlers().

std::shared_ptr<const void> edm::service::InitRootHandlers::sigBusHandler_

private

Definition at line 49 of file InitRootHandlers.h.

Referenced by InitRootHandlers().

std::shared_ptr<const void> edm::service::InitRootHandlers::sigIllHandler_

private

Definition at line 51 of file InitRootHandlers.h.

Referenced by InitRootHandlers().

std::shared_ptr<const void> edm::service::InitRootHandlers::sigSegvHandler_

private

Definition at line 50 of file InitRootHandlers.h.

Referenced by InitRootHandlers().

bool edm::service::InitRootHandlers::unloadSigHandler_

private

Definition at line 45 of file InitRootHandlers.h.

Referenced by InitRootHandlers().