Worker.h

Go to the documentation of this file.

#ifndef FWCore_Framework_Worker_h
#define FWCore_Framework_Worker_h

/*----------------------------------------------------------------------

Worker: this is a basic scheduling unit - an abstract base class to
something that is really a producer or filter.

A worker will not actually call through to the module unless it is
in a Ready state.  After a module is actually run, the state will not
be Ready.  The Ready state can only be reestablished by doing a reset().

Pre/post module signals are posted only in the Ready state.

Execution statistics are kept here.

If a module has thrown an exception during execution, that exception
will be rethrown if the worker is entered again and the state is not Ready.
In other words, execution results (status) are cached and reused until
the worker is reset().

----------------------------------------------------------------------*/

#include "DataFormats/Provenance/interface/ModuleDescription.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/Framework/src/WorkerParams.h"
#include "FWCore/Framework/interface/Actions.h"
#include "FWCore/Framework/interface/CurrentProcessingContext.h"
#include "FWCore/ServiceRegistry/interface/ActivityRegistry.h"
#include "FWCore/Utilities/interface/Exception.h"

#include "boost/shared_ptr.hpp"
#include "boost/utility.hpp"

#include "FWCore/Framework/src/RunStopwatch.h"
#include "FWCore/Framework/interface/Frameworkfwd.h"

namespace edm {

  class Worker : private boost::noncopyable {
  public:
    enum State { Ready, Pass, Fail, Exception };

    Worker(ModuleDescription const& iMD, WorkerParams const& iWP);
    virtual ~Worker();

    template <typename T>
    bool doWork(typename T::MyPrincipal&, EventSetup const& c,
        CurrentProcessingContext const* cpc,
                CPUTimer *const timer);
    void beginJob() ;
    void endJob();
    void respondToOpenInputFile(FileBlock const& fb) {implRespondToOpenInputFile(fb);}
    void respondToCloseInputFile(FileBlock const& fb) {implRespondToCloseInputFile(fb);}
    void respondToOpenOutputFiles(FileBlock const& fb) {implRespondToOpenOutputFiles(fb);}
    void respondToCloseOutputFiles(FileBlock const& fb) {implRespondToCloseOutputFiles(fb);}

    void preForkReleaseResources() {implPreForkReleaseResources();}
    void postForkReacquireResources(unsigned int iChildIndex, unsigned int iNumberOfChildren) {implPostForkReacquireResources(iChildIndex, iNumberOfChildren);}

    void reset() { state_ = Ready; }

    ModuleDescription const& description() const {return md_;}
    ModuleDescription const* descPtr() const {return &md_; }
    void setActivityRegistry(boost::shared_ptr<ActivityRegistry> areg);

    std::pair<double, double> timeCpuReal() const {
      return std::pair<double, double>(stopwatch_->cpuTime(), stopwatch_->realTime());
    }

    void clearCounters() {
      timesRun_ = timesVisited_ = timesPassed_ = timesFailed_ = timesExcept_ = 0;
    }
    
    void useStopwatch();

    int timesRun() const { return timesRun_; }
    int timesVisited() const { return timesVisited_; }
    int timesPassed() const { return timesPassed_; }
    int timesFailed() const { return timesFailed_; }
    int timesExcept() const { return timesExcept_; }
    State state() const { return state_; }

    int timesPass() const { return timesPassed(); } // for backward compatibility only - to be removed soon

  protected:
    virtual std::string workerType() const = 0;
    virtual bool implDoBegin(EventPrincipal&, EventSetup const& c,
                CurrentProcessingContext const* cpc) = 0;
    virtual bool implDoEnd(EventPrincipal&, EventSetup const& c,
                CurrentProcessingContext const* cpc) = 0;
    virtual bool implDoBegin(RunPrincipal& rp, EventSetup const& c,
                CurrentProcessingContext const* cpc) = 0;
    virtual bool implDoEnd(RunPrincipal& rp, EventSetup const& c,
                CurrentProcessingContext const* cpc) = 0;
    virtual bool implDoBegin(LuminosityBlockPrincipal& lbp, EventSetup const& c,
                CurrentProcessingContext const* cpc) = 0;
    virtual bool implDoEnd(LuminosityBlockPrincipal& lbp, EventSetup const& c,
                CurrentProcessingContext const* cpc) = 0;
    virtual void implBeginJob() = 0;
    virtual void implEndJob() = 0;

  private:
    virtual void implRespondToOpenInputFile(FileBlock const& fb) = 0;
    virtual void implRespondToCloseInputFile(FileBlock const& fb) = 0;
    virtual void implRespondToOpenOutputFiles(FileBlock const& fb) = 0;
    virtual void implRespondToCloseOutputFiles(FileBlock const& fb) = 0;

    virtual void implPreForkReleaseResources() = 0;
    virtual void implPostForkReacquireResources(unsigned int iChildIndex,
                                               unsigned int iNumberOfChildren) = 0;
    RunStopwatch::StopwatchPointer stopwatch_;

    int timesRun_;
    int timesVisited_;
    int timesPassed_;
    int timesFailed_;
    int timesExcept_;
    State state_;

    ModuleDescription md_;
    ActionTable const* actions_; // memory assumed to be managed elsewhere
    boost::shared_ptr<edm::Exception> cached_exception_; // if state is 'exception'

    boost::shared_ptr<ActivityRegistry> actReg_;
  };

  namespace {
    template <typename T>
    class ModuleSignalSentry {
    public:
      ModuleSignalSentry(ActivityRegistry *a, ModuleDescription& md) : a_(a), md_(&md) {
    if(a_) T::preModuleSignal(a_, md_);
      }
      ~ModuleSignalSentry() {
    if(a_) T::postModuleSignal(a_, md_);
      }
    private:
      ActivityRegistry* a_;
      ModuleDescription* md_;
    };

    template <typename T>
    cms::Exception& exceptionContext(ModuleDescription const& iMD,
                     T const& ip,
                     cms::Exception& iEx) {
      iEx << iMD.moduleName() << "/" << iMD.moduleLabel()
        << " " << ip.id() << "\n";
      return iEx;
    }

    cms::Exception& exceptionContext(ModuleDescription const& iMD,
                     cms::Exception& iEx) {
      iEx << iMD.moduleName() << "/" << iMD.moduleLabel() << "\n";
      return iEx;
    }
  }

   template <typename T>
   bool Worker::doWork(typename T::MyPrincipal& ep, 
                       EventSetup const& es,
                       CurrentProcessingContext const* cpc,
                       CPUTimer* const iTimer) {

    // A RunStopwatch, but only if we are processing an event.
    RunDualStopwatches stopwatch(T::isEvent_ ? stopwatch_ : RunStopwatch::StopwatchPointer(),
                                 iTimer);

    if (T::isEvent_) {
      ++timesVisited_;
    }
    bool rc = false;

    switch(state_) {
      case Ready: break;
      case Pass: return true;
      case Fail: return false;
      case Exception: {
      // rethrow the cached exception again
      // It seems impossible to
      // get here a second time until a cms::Exception has been
      // thrown prviously.
      LogWarning("repeat") << "A module has been invoked a second "
                   << "time even though it caught an "
                   << "exception during the previous "
                   << "invocation.\n"
                   << "This may be an indication of a "
                   << "configuration problem.\n";

      cached_exception_->raise();
      }
    }

    if (T::isEvent_) ++timesRun_;

    try {

    ModuleSignalSentry<T> cpp(actReg_.get(), md_);
    if (T::begin_) {
      rc = implDoBegin(ep, es, cpc);
    } else {
      rc = implDoEnd(ep, es, cpc);
        }

    if (rc) {
      state_ = Pass;
      if (T::isEvent_) ++timesPassed_;
    } else {
      state_ = Fail;
      if (T::isEvent_) ++timesFailed_;
    }
    }

    catch(cms::Exception& e) {

    // NOTE: the warning printed as a result of ignoring or failing
    // a module will only be printed during the full true processing
    // pass of this module

    // Get the action corresponding to this exception.  However, if processing
    // something other than an event (e.g. run, lumi) always rethrow.
    actions::ActionCodes action = (T::isEvent_ ? actions_->find(e.rootCause()) : actions::Rethrow);

    // If we are processing an endpath and the module was scheduled, treat SkipEvent or FailPath
    // as FailModule, so any subsequent OutputModules are still run.
        // For unscheduled modules only treat FailPath as a FailModule but still allow SkipEvent to throw
    if (cpc && cpc->isEndPath()) {
      if ((action == actions::SkipEvent && !cpc->isUnscheduled()) ||
               action == actions::FailPath) action = actions::FailModule;
    }
    switch(action) {
      case actions::IgnoreCompletely: {
          rc = true;
          ++timesPassed_;
          state_ = Pass;
          LogWarning("IgnoreCompletely")
        << "Module ignored an exception\n"
                << e.what() << "\n";
          break;
      }

      case actions::FailModule: {
          rc = true;
          LogWarning("FailModule")
                << "Module failed due to an exception\n"
                << e.what() << "\n";
          ++timesFailed_;
          state_ = Fail;
          break;
      }

      default: {

          // we should not need to include the event/run/module names
          // the exception because the error logger will pick this
          // up automatically.  I'm leaving it in until this is
          // verified

          // here we simply add a small amount of data to the
          // exception to add some context, we could have rethrown
          // it as something else and embedded with this exception
          // as an argument to the constructor.

          if (T::isEvent_) ++timesExcept_;
          state_ = Exception;
          e << "cms::Exception going through module ";
              exceptionContext(md_, ep, e);
          edm::Exception *edmEx = dynamic_cast<edm::Exception *>(&e);
          if (edmEx) {
            cached_exception_.reset(new edm::Exception(*edmEx));
          } else {
            cached_exception_.reset(new edm::Exception(errors::OtherCMS, std::string(), e));
          }
          throw;
      }
    }
      }

    catch(std::bad_alloc& bda) {
    if (T::isEvent_) ++timesExcept_;
    state_ = Exception;
    cached_exception_.reset(new edm::Exception(errors::BadAlloc));
    *cached_exception_
      << "A std::bad_alloc exception occurred during a call to the module ";
    exceptionContext(md_, ep, *cached_exception_)
      << "The job has probably exhausted the virtual memory available to the process.\n";
    cached_exception_->raise();
    }
    catch(std::exception& e) {
    if (T::isEvent_) ++timesExcept_;
    state_ = Exception;
    cached_exception_.reset(new edm::Exception(errors::StdException));
    *cached_exception_
      << "A std::exception occurred during a call to the module ";
        exceptionContext(md_, ep, *cached_exception_) << "and cannot be repropagated.\n"
      << "Previous information:\n" << e.what();
    cached_exception_->raise();
    }
    catch(std::string& s) {
    if (T::isEvent_) ++timesExcept_;
    state_ = Exception;
    cached_exception_.reset(new edm::Exception(errors::BadExceptionType, "std::string"));
    *cached_exception_
      << "A std::string thrown as an exception occurred during a call to the module ";
        exceptionContext(md_, ep, *cached_exception_) << "and cannot be repropagated.\n"
      << "Previous information:\n string = " << s;
    cached_exception_->raise();
    }
    catch(char const* c) {
    if (T::isEvent_) ++timesExcept_;
    state_ = Exception;
    cached_exception_.reset(new edm::Exception(errors::BadExceptionType, "const char *"));
    *cached_exception_
      << "A const char* thrown as an exception occurred during a call to the module ";
        exceptionContext(md_, ep, *cached_exception_) << "and cannot be repropagated.\n"
      << "Previous information:\n const char* = " << c << "\n";
    cached_exception_->raise();
    }
    catch(...) {
    if (T::isEvent_) ++timesExcept_;
    state_ = Exception;
    cached_exception_.reset(new edm::Exception(errors::Unknown, "repeated"));
    *cached_exception_
      << "An unknown occurred during a previous call to the module ";
        exceptionContext(md_, ep, *cached_exception_) << "and cannot be repropagated.\n";
    cached_exception_->raise();
    }

    return rc;
  }

}
#endif