Schedule.h

Go to the documentation of this file.

#ifndef FWCore_Framework_Schedule_h
#define FWCore_Framework_Schedule_h

/*
  Author: Jim Kowalkowski  28-01-06

  A class for creating a schedule based on paths in the configuration file.
  The schedule is maintained as a sequence of paths.
  After construction, events can be fed to the object and passed through
  all the modules in the schedule.  All accounting about processing
  of events by modules and paths is contained here or in object held
  by containment.

  The trigger results producer and product are generated and managed here.
  This class also manages endpaths and calls to endjob and beginjob.
  Endpaths are just treated as a simple list of modules that need to
  do processing of the event and do not participate in trigger path
  activities.

  This class requires the high-level process pset.  It uses @process_name.
  If the high-level pset contains an "options" pset, then the
  following optional parameter can be present:
  bool wantSummary = true/false   # default false

  wantSummary indicates whether or not the pass/fail/error stats
  for modules and paths should be printed at the end-of-job.

  A TriggerResults object will always be inserted into the event
  for any schedule.  The producer of the TriggerResults EDProduct
  is always the first module in the endpath.  The TriggerResultInserter
  is given a fixed label of "TriggerResults".

  Processing of an event happens by pushing the event through the Paths.
  The scheduler performs the reset() on each of the workers independent
  of the Path objects.

  ------------------------

  About Paths:
  Paths fit into two categories:
  1) trigger paths that contribute directly to saved trigger bits
  2) end paths
  The Schedule holds these paths in two data structures:
  1) main path list
  2) end path list

  Trigger path processing always precedes endpath processing.
  The order of the paths from the input configuration is
  preserved in the main paths list.

  ------------------------

  The Schedule uses the TriggerNamesService to get the names of the
  trigger paths and end paths. When a TriggerResults object is created
  the results are stored in the same order as the trigger names from
  TriggerNamesService.

*/

#include "DataFormats/Provenance/interface/ModuleDescription.h"
#include "FWCore/Framework/interface/ExceptionActions.h"
#include "FWCore/Framework/interface/EventPrincipal.h"
#include "FWCore/Framework/interface/ExceptionHelpers.h"
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/OccurrenceTraits.h"
#include "FWCore/Framework/interface/WorkerManager.h"
#include "FWCore/Framework/src/Worker.h"
#include "FWCore/Framework/src/WorkerRegistry.h"
#include "FWCore/Framework/src/GlobalSchedule.h"
#include "FWCore/Framework/src/StreamSchedule.h"
#include "FWCore/Framework/src/SystemTimeKeeper.h"
#include "FWCore/Framework/src/PreallocationConfiguration.h"
#include "FWCore/MessageLogger/interface/ExceptionMessages.h"
#include "FWCore/MessageLogger/interface/JobReport.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/ServiceRegistry/interface/Service.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/get_underlying_safe.h"

#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>
#include <sstream>
#include <utility>

namespace edm {

  namespace service {
    class TriggerNamesService;
  }
  class ActivityRegistry;
  class BranchIDListHelper;
  class EventSetup;
  class ExceptionCollector;
  class OutputModuleCommunicator;
  class ProcessContext;
  class ProductRegistry;
  class PreallocationConfiguration;
  class StreamSchedule;
  class GlobalSchedule;
  struct TriggerTimingReport;
  class ModuleRegistry;
  class ThinnedAssociationsHelper;
  class SubProcessParentageHelper;
  class TriggerResultInserter;
  class WaitingTaskHolder;

  
  class Schedule {
  public:
    typedef std::vector<std::string> vstring;
    typedef std::vector<Worker*> AllWorkers;
    typedef std::vector<edm::propagate_const<std::shared_ptr<OutputModuleCommunicator>>> AllOutputModuleCommunicators;

    typedef std::vector<Worker*> Workers;

    Schedule(ParameterSet& proc_pset,
             service::TriggerNamesService& tns,
             ProductRegistry& pregistry,
             BranchIDListHelper& branchIDListHelper,
             ThinnedAssociationsHelper& thinnedAssociationsHelper,
             SubProcessParentageHelper const* subProcessParentageHelper,
             ExceptionToActionTable const& actions,
             std::shared_ptr<ActivityRegistry> areg,
             std::shared_ptr<ProcessConfiguration> processConfiguration,
             bool hasSubprocesses,
             PreallocationConfiguration const& config,
             ProcessContext const* processContext);

    void processOneEventAsync(WaitingTaskHolder iTask,
                              unsigned int iStreamID,
                              EventPrincipal& principal,
                              EventSetup const& eventSetup);

    template <typename T>
    void processOneGlobal(typename T::MyPrincipal& principal,
                          EventSetup const& eventSetup,
                          bool cleaningUpAfterException = false);

    template <typename T>
    void processOneGlobalAsync(WaitingTaskHolder iTask,
                               typename T::MyPrincipal& principal,
                               EventSetup const& eventSetup,
                               bool cleaningUpAfterException = false);

    template <typename T>
    void processOneStream(unsigned int iStreamID,
                          typename T::MyPrincipal& principal,
                          EventSetup const& eventSetup,
                          bool cleaningUpAfterException = false);

    template <typename T>
    void processOneStreamAsync(WaitingTaskHolder iTask,
                               unsigned int iStreamID,
                               typename T::MyPrincipal& principal,
                               EventSetup const& eventSetup,
                               bool cleaningUpAfterException = false);

    void beginJob(ProductRegistry const&);
    void endJob(ExceptionCollector & collector);
    
    void beginStream(unsigned int);
    void endStream(unsigned int);

    // Write the luminosity block
    void writeLumi(LuminosityBlockPrincipal const& lbp, ProcessContext const*);

    // Write the run
    void writeRun(RunPrincipal const& rp, ProcessContext const*);

    // Call closeFile() on all OutputModules.
    void closeOutputFiles();

    // Call openNewFileIfNeeded() on all OutputModules
    void openNewOutputFilesIfNeeded();

    // Call openFiles() on all OutputModules
    void openOutputFiles(FileBlock& fb);

    // Call respondToOpenInputFile() on all Modules
    void respondToOpenInputFile(FileBlock const& fb);

    // Call respondToCloseInputFile() on all Modules
    void respondToCloseInputFile(FileBlock const& fb);

    // Call shouldWeCloseFile() on all OutputModules.
    bool shouldWeCloseOutput() const;

    void preForkReleaseResources();
    void postForkReacquireResources(unsigned int iChildIndex, unsigned int iNumberOfChildren);


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

    void availablePaths(std::vector<std::string>& oLabelsToFill) const;

    void triggerPaths(std::vector<std::string>& oLabelsToFill) const;

    void endPaths(std::vector<std::string>& oLabelsToFill) const;

    void modulesInPath(std::string const& iPathLabel,
                       std::vector<std::string>& oLabelsToFill) const;

    void moduleDescriptionsInPath(std::string const& iPathLabel,
                                  std::vector<ModuleDescription const*>& descriptions,
                                  unsigned int hint) const;

    void moduleDescriptionsInEndPath(std::string const& iEndPathLabel,
                                     std::vector<ModuleDescription const*>& descriptions,
                                     unsigned int hint) const;

    void fillModuleAndConsumesInfo(std::vector<ModuleDescription const*>& allModuleDescriptions,
                                   std::vector<std::pair<unsigned int, unsigned int> >& moduleIDToIndex,
                                   std::vector<std::vector<ModuleDescription const*> >& modulesWhoseProductsAreConsumedBy,
                                   ProductRegistry const& preg) const;

    int totalEvents() const;

    int totalEventsPassed() const;

    int totalEventsFailed() const;

    void enableEndPaths(bool active);

    bool endPathsEnabled() const;

    void getTriggerReport(TriggerReport& rep) const;
    
    void getTriggerTimingReport(TriggerTimingReport& rep) const;

    bool terminate() const;

    void clearCounters();

    bool changeModule(std::string const& iLabel, ParameterSet const& iPSet, const ProductRegistry& iRegistry);

    AllWorkers const& allWorkers() const;

  private:

    void limitOutput(ParameterSet const& proc_pset,
                     BranchIDLists const& branchIDLists,
                     SubProcessParentageHelper const* subProcessParentageHelper);

    std::shared_ptr<TriggerResultInserter const> resultsInserter() const {return get_underlying_safe(resultsInserter_);}
    std::shared_ptr<TriggerResultInserter>& resultsInserter() {return get_underlying_safe(resultsInserter_);}
    std::shared_ptr<ModuleRegistry const> moduleRegistry() const {return get_underlying_safe(moduleRegistry_);}
    std::shared_ptr<ModuleRegistry>& moduleRegistry() {return get_underlying_safe(moduleRegistry_);}

    edm::propagate_const<std::shared_ptr<TriggerResultInserter>> resultsInserter_;
    edm::propagate_const<std::shared_ptr<ModuleRegistry>> moduleRegistry_;
    std::vector<edm::propagate_const<std::shared_ptr<StreamSchedule>>> streamSchedules_;
    //In the future, we will have one GlobalSchedule per simultaneous transition
    edm::propagate_const<std::unique_ptr<GlobalSchedule>> globalSchedule_;

    AllOutputModuleCommunicators         all_output_communicators_;
    PreallocationConfiguration           preallocConfig_;

    edm::propagate_const<std::unique_ptr<SystemTimeKeeper>> summaryTimeKeeper_;

    bool                           wantSummary_;

    volatile bool           endpathsAreActive_;
  };


  template <typename T>
  void Schedule::processOneStream(unsigned int iStreamID,
                                  typename T::MyPrincipal& ep,
                                  EventSetup const& es,
                                  bool cleaningUpAfterException) {
    assert(iStreamID<streamSchedules_.size());
    streamSchedules_[iStreamID]->processOneStream<T>(ep,es,cleaningUpAfterException);
  }
  
  template <typename T>
  void Schedule::processOneStreamAsync(WaitingTaskHolder iTaskHolder,
                                       unsigned int iStreamID,
                                       typename T::MyPrincipal& ep,
                                       EventSetup const& es,
                                       bool cleaningUpAfterException) {
    assert(iStreamID<streamSchedules_.size());
    streamSchedules_[iStreamID]->processOneStreamAsync<T>(std::move(iTaskHolder),ep,es,cleaningUpAfterException);
  }

  template <typename T>
  void
  Schedule::processOneGlobal(typename T::MyPrincipal& ep,
                                 EventSetup const& es,
                                 bool cleaningUpAfterException) {
    globalSchedule_->processOneGlobal<T>(ep,es,cleaningUpAfterException);
  }
  
  template <typename T>
  void
  Schedule::processOneGlobalAsync(WaitingTaskHolder iTaskHolder,
                                  typename T::MyPrincipal& ep,
                                  EventSetup const& es,
                                  bool cleaningUpAfterException) {
    globalSchedule_->processOneGlobalAsync<T>(iTaskHolder,ep,es,cleaningUpAfterException);
  }

}
#endif