WorkerInPath.h

Go to the documentation of this file.

#ifndef FWCore_Framework_WorkerInPath_h
#define FWCore_Framework_WorkerInPath_h

/*

    Author: Jim Kowalkowski 28-01-06


    A wrapper around a Worker, so that statistics can be managed
    per path.  A Path holds Workers as these things.

*/

#include "FWCore/Framework/interface/maker/Worker.h"
#include "FWCore/Concurrency/interface/WaitingTaskHolder.h"
#include "FWCore/ServiceRegistry/interface/ParentContext.h"
#include "FWCore/ServiceRegistry/interface/PlaceInPathContext.h"

namespace edm {

  class PathContext;
  class StreamID;
  class ServiceToken;

  class WorkerInPath {
  public:
    enum FilterAction { Normal = 0, Ignore, Veto };

    WorkerInPath(Worker*, FilterAction theAction, unsigned int placeInPath, bool runConcurrently);

    template <typename T>
    void runWorkerAsync(WaitingTaskHolder,
                        typename T::TransitionInfoType const&,
                        ServiceToken const&,
                        StreamID,
                        typename T::Context const*);

    bool checkResultsOfRunWorker(bool wasEvent);

    void skipWorker(EventPrincipal const& iPrincipal) { worker_->skipOnPath(iPrincipal); }
    void skipWorker(RunPrincipal const&) {}
    void skipWorker(LuminosityBlockPrincipal const&) {}

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

    int timesVisited() const { return timesVisited_; }
    int timesPassed() const { return timesPassed_; }
    int timesFailed() const { return timesFailed_; }
    int timesExcept() const { return timesExcept_; }

    FilterAction filterAction() const { return filterAction_; }
    Worker* getWorker() const { return worker_; }
    bool runConcurrently() const noexcept { return runConcurrently_; }
    unsigned int bitPosition() const noexcept { return placeInPathContext_.placeInPath(); }

    void setPathContext(PathContext const* v) { placeInPathContext_.setPathContext(v); }

  private:
    int timesVisited_;
    int timesPassed_;
    int timesFailed_;
    int timesExcept_;

    FilterAction filterAction_;
    Worker* worker_;

    PlaceInPathContext placeInPathContext_;
    bool runConcurrently_;
  };

  inline bool WorkerInPath::checkResultsOfRunWorker(bool wasEvent) {
    if (not wasEvent) {
      return true;
    }
    auto state = worker_->state();
    bool rc = true;
    switch (state) {
      case Worker::Fail: {
        rc = false;
        break;
      }
      case Worker::Pass:
        break;
      case Worker::Exception: {
        ++timesExcept_;
        return true;
      }

      default:
        assert(false);
    }

    if (Ignore == filterAction()) {
      rc = true;
    } else if (Veto == filterAction()) {
      rc = !rc;
    }

    if (rc) {
      ++timesPassed_;
    } else {
      ++timesFailed_;
    }
    return rc;
  }

  template <typename T>
  void WorkerInPath::runWorkerAsync(WaitingTaskHolder iTask,
                                    typename T::TransitionInfoType const& info,
                                    ServiceToken const& token,
                                    StreamID streamID,
                                    typename T::Context const* context) {
    if constexpr (T::isEvent_) {
      ++timesVisited_;
    }

    if constexpr (T::isEvent_) {
      ParentContext parentContext(&placeInPathContext_);
      worker_->doWorkAsync<T>(iTask, info, token, streamID, parentContext, context);
    } else {
      ParentContext parentContext(context);

      // We do not need to run prefetching here because this only handles
      // stream transitions for runs and lumis. There are no products put
      // into the runs or lumis in stream transitions, so there can be
      // no data dependencies which require prefetching. Prefetching is
      // needed for global transitions, but they are run elsewhere.
      worker_->doWorkNoPrefetchingAsync<T>(iTask, info, token, streamID, parentContext, context);
    }
  }
}  // namespace edm

#endif