GlobalSchedule.h

Go to the documentation of this file.

#ifndef FWCore_Framework_GlobalSchedule_h
#define FWCore_Framework_GlobalSchedule_h

/*
*/

#include "DataFormats/Provenance/interface/ModuleDescription.h"
#include "FWCore/Common/interface/FWCoreCommonFwd.h"
#include "FWCore/Framework/interface/EventPrincipal.h"
#include "FWCore/Framework/interface/ExceptionActions.h"
#include "FWCore/Framework/interface/ExceptionHelpers.h"
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/LuminosityBlockPrincipal.h"
#include "FWCore/Framework/interface/OccurrenceTraits.h"
#include "FWCore/Framework/interface/ProcessBlockPrincipal.h"
#include "FWCore/Framework/interface/RunPrincipal.h"
#include "FWCore/Framework/interface/WorkerManager.h"
#include "FWCore/Framework/interface/maker/Worker.h"
#include "FWCore/Framework/interface/WorkerRegistry.h"
#include "FWCore/MessageLogger/interface/ExceptionMessages.h"
#include "FWCore/ServiceRegistry/interface/GlobalContext.h"
#include "FWCore/Utilities/interface/Algorithms.h"
#include "FWCore/Utilities/interface/BranchType.h"
#include "FWCore/Utilities/interface/ConvertException.h"
#include "FWCore/Utilities/interface/Exception.h"
#include "FWCore/Utilities/interface/StreamID.h"
#include "FWCore/Utilities/interface/propagate_const.h"
#include "FWCore/Concurrency/interface/WaitingTaskHolder.h"
#include "FWCore/Utilities/interface/thread_safety_macros.h"

#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>
#include <sstream>
#include "boost/range/adaptor/reversed.hpp"

namespace edm {

  namespace {
    template <typename T>
    class GlobalScheduleSignalSentry {
    public:
      GlobalScheduleSignalSentry(ActivityRegistry* a, typename T::Context const* context)
          : a_(a), context_(context), allowThrow_(false) {
        if (a_)
          T::preScheduleSignal(a_, context_);
      }
      ~GlobalScheduleSignalSentry() noexcept(false) {
        // Caught exception is rethrown
        CMS_SA_ALLOW try {
          if (a_)
            T::postScheduleSignal(a_, context_);
        } catch (...) {
          if (allowThrow_) {
            throw;
          }
        }
      }

      void allowThrow() { allowThrow_ = true; }

    private:
      // We own none of these resources.
      ActivityRegistry* a_;  // We do not use propagate_const because the registry itself is mutable.
      typename T::Context const* context_;
      bool allowThrow_;
    };
  }  // namespace

  class ActivityRegistry;
  class ExceptionCollector;
  class ProcessContext;
  class PreallocationConfiguration;
  class ModuleRegistry;
  class TriggerResultInserter;
  class PathStatusInserter;
  class EndPathStatusInserter;

  class GlobalSchedule {
  public:
    typedef std::vector<std::string> vstring;
    typedef std::vector<Worker*> AllWorkers;
    typedef std::shared_ptr<Worker> WorkerPtr;
    typedef std::vector<Worker*> Workers;

    GlobalSchedule(std::shared_ptr<TriggerResultInserter> inserter,
                   std::vector<edm::propagate_const<std::shared_ptr<PathStatusInserter>>>& pathStatusInserters,
                   std::vector<edm::propagate_const<std::shared_ptr<EndPathStatusInserter>>>& endPathStatusInserters,
                   std::shared_ptr<ModuleRegistry> modReg,
                   std::vector<std::string> const& modulesToUse,
                   ParameterSet& proc_pset,
                   ProductRegistry& pregistry,
                   PreallocationConfiguration const& prealloc,
                   ExceptionToActionTable const& actions,
                   std::shared_ptr<ActivityRegistry> areg,
                   std::shared_ptr<ProcessConfiguration const> processConfiguration,
                   ProcessContext const* processContext);
    GlobalSchedule(GlobalSchedule const&) = delete;

    template <typename T>
    void processOneGlobalAsync(WaitingTaskHolder holder,
                               typename T::TransitionInfoType&,
                               ServiceToken const& token,
                               bool cleaningUpAfterException = false);

    void beginJob(ProductRegistry const&,
                  eventsetup::ESRecordsToProductResolverIndices const&,
                  ProcessBlockHelperBase const&);
    void endJob(ExceptionCollector& collector);


    std::vector<ModuleDescription const*> getAllModuleDescriptions() const;

    bool terminate() const;

    void replaceModule(maker::ModuleHolder* iMod, std::string const& iLabel);

    void deleteModule(std::string const& iLabel);

    AllWorkers const& allWorkers() const { return workerManagers_[0].allWorkers(); }

  private:
    //Sentry class to only send a signal if an
    // exception occurs. An exception is identified
    // by the destructor being called without first
    // calling completedSuccessfully().
    class SendTerminationSignalIfException {
    public:
      SendTerminationSignalIfException(edm::ActivityRegistry* iReg, edm::GlobalContext const* iContext)
          : reg_(iReg), context_(iContext) {}
      ~SendTerminationSignalIfException() {
        if (reg_) {
          reg_->preGlobalEarlyTerminationSignal_(*context_, TerminationOrigin::ExceptionFromThisContext);
        }
      }
      void completedSuccessfully() { reg_ = nullptr; }

    private:
      edm::ActivityRegistry* reg_;  // We do not use propagate_const because the registry itself is mutable.
      GlobalContext const* context_;
    };

    ExceptionToActionTable const& actionTable() const { return workerManagers_[0].actionTable(); }

    std::vector<WorkerManager> workerManagers_;
    std::shared_ptr<ActivityRegistry> actReg_;  // We do not use propagate_const because the registry itself is mutable.
    std::vector<edm::propagate_const<WorkerPtr>> extraWorkers_;
    ProcessContext const* processContext_;
    unsigned int numberOfConcurrentLumis_;
  };

  template <typename T>
  void GlobalSchedule::processOneGlobalAsync(WaitingTaskHolder iHolder,
                                             typename T::TransitionInfoType& transitionInfo,
                                             ServiceToken const& token,
                                             bool cleaningUpAfterException) {
    auto const& principal = transitionInfo.principal();

    // Caught exception is propagated via WaitingTaskHolder
    CMS_SA_ALLOW try {
      //need the doneTask to own the memory
      auto globalContext = std::make_shared<GlobalContext>(T::makeGlobalContext(principal, processContext_));

      if (actReg_) {
        //Services may depend upon each other
        ServiceRegistry::Operate op(token);
        T::preScheduleSignal(actReg_.get(), globalContext.get());
      }

      ServiceWeakToken weakToken = token;
      auto doneTask = make_waiting_task(
          [this, iHolder, cleaningUpAfterException, globalContext, weakToken](std::exception_ptr const* iPtr) mutable {
            std::exception_ptr excpt;
            if (iPtr) {
              excpt = *iPtr;
              //add context information to the exception and print message
              try {
                convertException::wrap([&]() { std::rethrow_exception(excpt); });
              } catch (cms::Exception& ex) {
                //TODO: should add the transition type info
                std::ostringstream ost;
                if (ex.context().empty()) {
                  ost << "Processing " << T::transitionName() << " ";
                }
                ServiceRegistry::Operate op(weakToken.lock());
                addContextAndPrintException(ost.str().c_str(), ex, cleaningUpAfterException);
                excpt = std::current_exception();
              }
              if (actReg_) {
                ServiceRegistry::Operate op(weakToken.lock());
                actReg_->preGlobalEarlyTerminationSignal_(*globalContext, TerminationOrigin::ExceptionFromThisContext);
              }
            }
            if (actReg_) {
              // Caught exception is propagated via WaitingTaskHolder
              CMS_SA_ALLOW try {
                ServiceRegistry::Operate op(weakToken.lock());
                T::postScheduleSignal(actReg_.get(), globalContext.get());
              } catch (...) {
                if (not excpt) {
                  excpt = std::current_exception();
                }
              }
            }
            iHolder.doneWaiting(excpt);
          });
      unsigned int managerIndex = principal.index();
      if constexpr (T::branchType_ == InRun) {
        managerIndex += numberOfConcurrentLumis_;
      }
      WorkerManager& workerManager = workerManagers_[managerIndex];
      workerManager.resetAll();

      ParentContext parentContext(globalContext.get());
      //make sure the ProductResolvers know about their
      // workers to allow proper data dependency handling
      workerManager.setupResolvers(transitionInfo.principal());

      //make sure the task doesn't get run until all workers have beens started
      WaitingTaskHolder holdForLoop(*iHolder.group(), doneTask);
      auto& aw = workerManager.allWorkers();
      for (Worker* worker : boost::adaptors::reverse(aw)) {
        worker->doWorkAsync<T>(
            holdForLoop, transitionInfo, token, StreamID::invalidStreamID(), parentContext, globalContext.get());
      }
    } catch (...) {
      iHolder.doneWaiting(std::current_exception());
    }
  }
}  // namespace edm

#endif