edm::ModuleCallingContext Class Reference

#include <ModuleCallingContext.h>

Public Types
enum	State { State::kPrefetching, State::kRunning, State::kInvalid }
typedef ParentContext::Type	Type

Public Member Functions
std::uintptr_t	callID () const
unsigned	depth () const
GlobalContext const *	getGlobalContext () const
StreamContext const *	getStreamContext () const
ModuleCallingContext const *	getTopModuleCallingContext () const
GlobalContext const *	globalContext () const
InternalContext const *	internalContext () const
	ModuleCallingContext (ModuleDescription const *moduleDescription)
	ModuleCallingContext (ModuleDescription const *moduleDescription, std::uintptr_t id, State state, ParentContext const &parent, ModuleCallingContext const *previousOnThread)
ModuleCallingContext const *	moduleCallingContext () const
ModuleDescription const *	moduleDescription () const
ParentContext const &	parent () const
PlaceInPathContext const *	placeInPathContext () const
ModuleCallingContext const *	previousModuleOnThread () const
void	setContext (State state, ParentContext const &parent, ModuleCallingContext const *previousOnThread)
void	setState (State state)
State	state () const
StreamContext const *	streamContext () const
Type	type () const

Private Attributes
std::uintptr_t	id_
ModuleDescription const *	moduleDescription_
ParentContext	parent_
ModuleCallingContext const *	previousModuleOnThread_
State	state_

Detailed Description

Description: This is intended primarily to be passed to Services as an argument to their callback functions.

Usage:

Definition at line 33 of file ModuleCallingContext.h.

Member Typedef Documentation

Type

typedef ParentContext::Type edm::ModuleCallingContext::Type

Definition at line 35 of file ModuleCallingContext.h.

Member Enumeration Documentation

State

enum edm::ModuleCallingContext::State

strong

Enumerator
kPrefetching
kRunning
kInvalid

Definition at line 37 of file ModuleCallingContext.h.

                     {
      kPrefetching,  // prefetching products before starting to run
      kRunning,      // module actually running
      kInvalid
    };

Constructor & Destructor Documentation

ModuleCallingContext() [1/2]

edm::ModuleCallingContext::ModuleCallingContext

(

ModuleDescription const *

moduleDescription

)

Definition at line 14 of file ModuleCallingContext.cc.

      : previousModuleOnThread_(nullptr),
        moduleDescription_(moduleDescription),
        parent_(),
        id_(0),
        state_(State::kInvalid) {}

ModuleCallingContext() [2/2]

edm::ModuleCallingContext::ModuleCallingContext	(	ModuleDescription const *	moduleDescription,
		std::uintptr_t	id,
		State	state,
		ParentContext const &	parent,
		ModuleCallingContext const *	previousOnThread
	)

Definition at line 21 of file ModuleCallingContext.cc.

      : previousModuleOnThread_(previousOnThread),
        moduleDescription_(moduleDescription),
        parent_(parent),
        id_(id),
        state_(state) {}

Member Function Documentation

callID()

std::uintptr_t edm::ModuleCallingContext::callID ( ) const

inline

Returns a unique id for this module to differentiate possibly concurrent calls to the module. The value returned may be large so not appropriate for an index lookup. A value of 0 denotes a call to produce, analyze or filter. Other values denote a transform.

Definition at line 62 of file ModuleCallingContext.h.

References id_.

Referenced by edm::service::monitor_file_utilities::module_callid(), edm::service::Tracer::postModuleTransform(), edm::service::Tracer::postModuleTransformAcquiring(), edm::service::Tracer::postModuleTransformPrefetching(), edm::service::Tracer::preModuleTransform(), edm::service::Tracer::preModuleTransformAcquiring(), and edm::service::Tracer::preModuleTransformPrefetching().

{ return id_; }

depth()

unsigned edm::ModuleCallingContext::depth

(

void

)

const

Definition at line 74 of file ModuleCallingContext.cc.

References internalContext(), edm::ParentContext::kInternal, edm::ParentContext::kModule, edm::InternalContext::moduleCallingContext(), moduleCallingContext(), and type().

Referenced by edm::ESModuleCallingContext::depth(), edm::service::Tracer::postEventReadFromSource(), edm::service::Tracer::postModuleAccessInputProcessBlock(), edm::service::Tracer::postModuleBeginProcessBlock(), edm::service::Tracer::postModuleEndProcessBlock(), edm::service::Tracer::postModuleEvent(), edm::service::Tracer::postModuleEventAcquire(), edm::service::Tracer::postModuleEventDelayedGet(), edm::service::Tracer::postModuleEventPrefetching(), edm::service::Tracer::postModuleGlobalBeginLumi(), edm::service::Tracer::postModuleGlobalBeginRun(), edm::service::Tracer::postModuleGlobalEndLumi(), edm::service::Tracer::postModuleGlobalEndRun(), edm::service::Tracer::postModuleGlobalPrefetching(), edm::service::Tracer::postModuleStreamBeginLumi(), edm::service::Tracer::postModuleStreamBeginRun(), edm::service::Tracer::postModuleStreamEndLumi(), edm::service::Tracer::postModuleStreamEndRun(), edm::service::Tracer::postModuleStreamPrefetching(), edm::service::Tracer::postModuleTransform(), edm::service::Tracer::postModuleTransformAcquiring(), edm::service::Tracer::postModuleTransformPrefetching(), edm::service::Tracer::postModuleWriteLumi(), edm::service::Tracer::postModuleWriteProcessBlock(), edm::service::Tracer::postModuleWriteRun(), edm::service::Tracer::preEventReadFromSource(), edm::service::Tracer::preModuleAccessInputProcessBlock(), edm::service::Tracer::preModuleBeginProcessBlock(), edm::service::Tracer::preModuleEndProcessBlock(), edm::service::Tracer::preModuleEvent(), edm::service::Tracer::preModuleEventAcquire(), edm::service::Tracer::preModuleEventDelayedGet(), edm::service::Tracer::preModuleEventPrefetching(), edm::service::Tracer::preModuleGlobalBeginLumi(), edm::service::Tracer::preModuleGlobalBeginRun(), edm::service::Tracer::preModuleGlobalEndLumi(), edm::service::Tracer::preModuleGlobalEndRun(), edm::service::Tracer::preModuleGlobalPrefetching(), edm::service::Tracer::preModuleStreamBeginLumi(), edm::service::Tracer::preModuleStreamBeginRun(), edm::service::Tracer::preModuleStreamEndLumi(), edm::service::Tracer::preModuleStreamEndRun(), edm::service::Tracer::preModuleStreamPrefetching(), edm::service::Tracer::preModuleTransform(), edm::service::Tracer::preModuleTransformAcquiring(), edm::service::Tracer::preModuleTransformPrefetching(), edm::service::Tracer::preModuleWriteLumi(), edm::service::Tracer::preModuleWriteProcessBlock(), and edm::service::Tracer::preModuleWriteRun().

                                             {
    unsigned depth = 0;
    ModuleCallingContext const* mcc = this;
    while (mcc->type() == ParentContext::Type::kModule) {
      ++depth;
      mcc = mcc->moduleCallingContext();
    }
    if (mcc->type() == ParentContext::Type::kInternal) {
      ++depth;
      mcc = mcc->internalContext()->moduleCallingContext();
    }
    while (mcc->type() == ParentContext::Type::kModule) {
      ++depth;
      mcc = mcc->moduleCallingContext();
    }
    return depth;
  }

getGlobalContext()

GlobalContext const * edm::ModuleCallingContext::getGlobalContext

(

)

const

Definition at line 51 of file ModuleCallingContext.cc.

References Exception, getTopModuleCallingContext(), globalContext(), edm::ParentContext::kGlobal, edm::errors::LogicError, and type().

Referenced by edm::Worker::emitPostModuleGlobalPrefetchingSignal(), edm::Worker::prefetchAsync(), and edm::service::MessageLogger::setThreadContext().

                                                                    {
    ModuleCallingContext const* mcc = getTopModuleCallingContext();
    if (mcc->type() != ParentContext::Type::kGlobal) {
      throw Exception(errors::LogicError)
          << "ModuleCallingContext::getGlobalContext() called in context not linked to a GlobalContext\n";
    }
    return mcc->globalContext();
  }

getStreamContext()

StreamContext const * edm::ModuleCallingContext::getStreamContext

(

)

const

Definition at line 40 of file ModuleCallingContext.cc.

References Exception, getTopModuleCallingContext(), edm::ParentContext::kPlaceInPath, edm::ParentContext::kStream, edm::errors::LogicError, edm::PlaceInPathContext::pathContext(), placeInPathContext(), edm::PathContext::streamContext(), streamContext(), and type().

Referenced by edm::Worker::doTransformAsync(), edm::Worker::emitPostModuleEventPrefetchingSignal(), edm::Worker::emitPostModuleStreamPrefetchingSignal(), edm::EventAcquireSignalsSentry::EventAcquireSignalsSentry(), edm::EventSignalsSentry::EventSignalsSentry(), edm::DelayedReader::getProduct(), edm::Worker::prefetchAsync(), edm::UnscheduledProductResolver::prefetchAsync_(), edm::TransformingProductResolver::prefetchAsync_(), edm::DelayedReaderInputProductResolver::resolveProduct_(), edm::service::MessageLogger::setThreadContext(), edm::TransformerBase::transformImpAsync(), edm::EventAcquireSignalsSentry::~EventAcquireSignalsSentry(), and edm::EventSignalsSentry::~EventSignalsSentry().

                                                                    {
    ModuleCallingContext const* mcc = getTopModuleCallingContext();
    if (mcc->type() == ParentContext::Type::kPlaceInPath) {
      return mcc->placeInPathContext()->pathContext()->streamContext();
    } else if (mcc->type() != ParentContext::Type::kStream) {
      throw Exception(errors::LogicError)
          << "ModuleCallingContext::getStreamContext() called in context not linked to a StreamContext\n";
    }
    return mcc->streamContext();
  }

getTopModuleCallingContext()

ModuleCallingContext const * edm::ModuleCallingContext::getTopModuleCallingContext

(

)

const

Definition at line 60 of file ModuleCallingContext.cc.

References internalContext(), edm::ParentContext::kInternal, edm::ParentContext::kModule, edm::InternalContext::moduleCallingContext(), moduleCallingContext(), and type().

Referenced by getGlobalContext(), getStreamContext(), edm::ESModuleCallingContext::getTopModuleCallingContext(), and edm::service::MessageLogger::setThreadContext().

                                                                                     {
    ModuleCallingContext const* mcc = this;
    while (mcc->type() == ParentContext::Type::kModule) {
      mcc = mcc->moduleCallingContext();
    }
    if (mcc->type() == ParentContext::Type::kInternal) {
      mcc = mcc->internalContext()->moduleCallingContext();
    }
    while (mcc->type() == ParentContext::Type::kModule) {
      mcc = mcc->moduleCallingContext();
    }
    return mcc;
  }

globalContext()

GlobalContext const* edm::ModuleCallingContext::globalContext ( ) const

inline

Definition at line 67 of file ModuleCallingContext.h.

References edm::ParentContext::globalContext(), and parent_.

Referenced by edm::exceptionContext(), and getGlobalContext().

{ return parent_.globalContext(); }

internalContext()

InternalContext const* edm::ModuleCallingContext::internalContext ( ) const

inline

Definition at line 68 of file ModuleCallingContext.h.

References edm::ParentContext::internalContext(), and parent_.

Referenced by depth(), edm::exceptionContext(), and getTopModuleCallingContext().

{ return parent_.internalContext(); }

moduleCallingContext()

ModuleCallingContext const* edm::ModuleCallingContext::moduleCallingContext ( ) const

inline

Definition at line 64 of file ModuleCallingContext.h.

References edm::ParentContext::moduleCallingContext(), and parent_.

Referenced by depth(), edm::exceptionContext(), getTopModuleCallingContext(), and edm::operator<<().

{ return parent_.moduleCallingContext(); }

moduleDescription()

ModuleDescription const* edm::ModuleCallingContext::moduleDescription ( ) const

inline

Definition at line 55 of file ModuleCallingContext.h.

References moduleDescription_.

Referenced by edm::Worker::description(), edm::exceptionContext(), PileupRandomNumberGenerator::findPresentModule(), edm::service::RandomNumberGeneratorService::getEngine(), edm::service::monitor_file_utilities::module_id(), edm::service::RandomNumberGeneratorService::mySeed(), edm::operator<<(), edm::SystemTimeKeeper::pauseModuleEvent(), edm::service::Tracer::postEventReadFromSource(), edm::service::SimpleMemoryCheck::postModule(), edm::service::Tracer::postModuleAccessInputProcessBlock(), edm::service::Tracer::postModuleBeginProcessBlock(), ROCmMonitoringService::postModuleBeginStream(), CUDAMonitoringService::postModuleBeginStream(), edm::service::Tracer::postModuleBeginStream(), edm::service::MessageLogger::postModuleBeginStream(), NVProfilerService::postModuleBeginStream(), edm::service::Tracer::postModuleEndProcessBlock(), edm::service::Tracer::postModuleEndStream(), edm::service::MessageLogger::postModuleEndStream(), NVProfilerService::postModuleEndStream(), ROCmMonitoringService::postModuleEvent(), CUDAMonitoringService::postModuleEvent(), FWPathsPopup::postModuleEvent(), edm::service::IgProfService::postModuleEvent(), edm::service::JeProfService::postModuleEvent(), edm::service::Timing::postModuleEvent(), TFileService::postModuleEvent(), edm::service::Tracer::postModuleEvent(), FastTimerService::postModuleEvent(), NVProfilerService::postModuleEvent(), edm::service::Tracer::postModuleEventAcquire(), FastTimerService::postModuleEventAcquire(), NVProfilerService::postModuleEventAcquire(), edm::service::Tracer::postModuleEventDelayedGet(), edm::service::Tracer::postModuleEventPrefetching(), NVProfilerService::postModuleEventPrefetching(), TFileService::postModuleGlobal(), edm::service::Tracer::postModuleGlobalBeginLumi(), NVProfilerService::postModuleGlobalBeginLumi(), edm::service::Tracer::postModuleGlobalBeginRun(), NVProfilerService::postModuleGlobalBeginRun(), edm::service::Tracer::postModuleGlobalEndLumi(), NVProfilerService::postModuleGlobalEndLumi(), edm::service::Tracer::postModuleGlobalEndRun(), NVProfilerService::postModuleGlobalEndRun(), edm::service::Tracer::postModuleGlobalPrefetching(), edm::service::Tracer::postModuleStreamBeginLumi(), NVProfilerService::postModuleStreamBeginLumi(), edm::service::Tracer::postModuleStreamBeginRun(), NVProfilerService::postModuleStreamBeginRun(), edm::service::RandomNumberGeneratorService::postModuleStreamCheck(), edm::service::Tracer::postModuleStreamEndLumi(), NVProfilerService::postModuleStreamEndLumi(), edm::service::Tracer::postModuleStreamEndRun(), NVProfilerService::postModuleStreamEndRun(), edm::service::Tracer::postModuleStreamPrefetching(), edm::service::Tracer::postModuleTransform(), edm::service::Tracer::postModuleTransformAcquiring(), edm::service::Tracer::postModuleTransformPrefetching(), edm::service::Tracer::postModuleWriteLumi(), edm::service::Tracer::postModuleWriteProcessBlock(), edm::service::Tracer::postModuleWriteRun(), edm::service::Tracer::preEventReadFromSource(), VariableHelperService::preModule(), edm::service::SimpleMemoryCheck::preModule(), edm::service::Tracer::preModuleAccessInputProcessBlock(), edm::service::Tracer::preModuleBeginProcessBlock(), edm::service::Tracer::preModuleBeginStream(), edm::service::MessageLogger::preModuleBeginStream(), NVProfilerService::preModuleBeginStream(), edm::service::Tracer::preModuleEndProcessBlock(), edm::service::Tracer::preModuleEndStream(), edm::service::MessageLogger::preModuleEndStream(), NVProfilerService::preModuleEndStream(), FWPathsPopup::preModuleEvent(), edm::service::IgProfService::preModuleEvent(), edm::service::JeProfService::preModuleEvent(), TFileService::preModuleEvent(), edm::service::Tracer::preModuleEvent(), evf::FastMonitoringService::preModuleEvent(), NVProfilerService::preModuleEvent(), edm::service::Tracer::preModuleEventAcquire(), evf::FastMonitoringService::preModuleEventAcquire(), NVProfilerService::preModuleEventAcquire(), edm::service::Tracer::preModuleEventDelayedGet(), edm::service::Tracer::preModuleEventPrefetching(), NVProfilerService::preModuleEventPrefetching(), TFileService::preModuleGlobal(), edm::service::Tracer::preModuleGlobalBeginLumi(), NVProfilerService::preModuleGlobalBeginLumi(), edm::service::Tracer::preModuleGlobalBeginRun(), NVProfilerService::preModuleGlobalBeginRun(), edm::service::Tracer::preModuleGlobalEndLumi(), NVProfilerService::preModuleGlobalEndLumi(), edm::service::Tracer::preModuleGlobalEndRun(), NVProfilerService::preModuleGlobalEndRun(), edm::service::Tracer::preModuleGlobalPrefetching(), edm::service::Tracer::preModuleStreamBeginLumi(), NVProfilerService::preModuleStreamBeginLumi(), edm::service::Tracer::preModuleStreamBeginRun(), NVProfilerService::preModuleStreamBeginRun(), edm::service::RandomNumberGeneratorService::preModuleStreamCheck(), edm::service::Tracer::preModuleStreamEndLumi(), NVProfilerService::preModuleStreamEndLumi(), edm::service::Tracer::preModuleStreamEndRun(), NVProfilerService::preModuleStreamEndRun(), edm::service::Tracer::preModuleStreamPrefetching(), edm::service::Tracer::preModuleTransform(), edm::service::Tracer::preModuleTransformAcquiring(), edm::service::Tracer::preModuleTransformPrefetching(), edm::service::Tracer::preModuleWriteLumi(), edm::service::Tracer::preModuleWriteProcessBlock(), edm::service::Tracer::preModuleWriteRun(), edm::SystemTimeKeeper::restartModuleEvent(), edm::SystemTimeKeeper::startModuleEvent(), edm::SystemTimeKeeper::stopModuleEvent(), and edm::service::ConcurrentModuleTimer::trackModule().

{ return moduleDescription_; }

parent()

ParentContext const& edm::ModuleCallingContext::parent ( void  ) const

inline

Definition at line 63 of file ModuleCallingContext.h.

References parent_.

Referenced by edm::Worker::doTransformAsync(), edm::ParentContext::isAtEndTransition(), edm::operator<<(), edm::PuttableProductResolver::prefetchAsync_(), edm::SwitchProducerProductResolver::prefetchAsync_(), edm::ParentProcessProductResolver::prefetchAsync_(), edm::Worker::resetModuleDescription(), edm::ParentProcessProductResolver::resolveProduct_(), edmtest::TestServicesOnNonFrameworkThreadsAnalyzer::runOnOtherThread(), and setContext().

{ return parent_; }

placeInPathContext()

PlaceInPathContext const* edm::ModuleCallingContext::placeInPathContext ( ) const

inline

Definition at line 65 of file ModuleCallingContext.h.

References parent_, and edm::ParentContext::placeInPathContext().

Referenced by edm::exceptionContext(), getStreamContext(), edm::SystemTimeKeeper::pauseModuleEvent(), and edm::SystemTimeKeeper::stopModuleEvent().

{ return parent_.placeInPathContext(); }

previousModuleOnThread()

ModuleCallingContext const* edm::ModuleCallingContext::previousModuleOnThread ( ) const

inline

Definition at line 85 of file ModuleCallingContext.h.

References previousModuleOnThread_.

Referenced by edm::operator<<(), TFileService::postModuleEvent(), TFileService::postModuleGlobal(), and edm::Worker::resetModuleDescription().

{ return previousModuleOnThread_; }

setContext()

void edm::ModuleCallingContext::setContext	(	State	state,
		ParentContext const &	parent,
		ModuleCallingContext const *	previousOnThread
	)

Definition at line 32 of file ModuleCallingContext.cc.

References parent(), parent_, previousModuleOnThread_, state(), and state_.

Referenced by edm::Worker::doWorkAsync(), edm::Worker::doWorkNoPrefetchingAsync(), edm::Worker::prefetchAsync(), edm::Worker::runAcquireAfterAsyncPrefetch(), and edm::Worker::runModuleAfterAsyncPrefetch().

                                                                                      {
    state_ = state;
    parent_ = parent;
    previousModuleOnThread_ = previousOnThread;
  }

setState()

void edm::ModuleCallingContext::setState ( State  state )

inline

Definition at line 53 of file ModuleCallingContext.h.

References state(), and state_.

Referenced by edm::Worker::beginStream(), and edm::Worker::endStream().

{ state_ = state; }

state()

State edm::ModuleCallingContext::state ( ) const

inline

Definition at line 56 of file ModuleCallingContext.h.

References state_.

Referenced by edm::exceptionContext(), edm::operator<<(), FastTimerService::postEventReadFromSource(), FastTimerService::preEventReadFromSource(), edm::Worker::resetModuleDescription(), setContext(), and setState().

{ return state_; }

streamContext()

StreamContext const* edm::ModuleCallingContext::streamContext ( ) const

inline

Definition at line 66 of file ModuleCallingContext.h.

References parent_, and edm::ParentContext::streamContext().

Referenced by edm::exceptionContext(), and getStreamContext().

{ return parent_.streamContext(); }

type()

Type edm::ModuleCallingContext::type ( ) const

inline

Definition at line 57 of file ModuleCallingContext.h.

References parent_, and edm::ParentContext::type().

Referenced by depth(), edm::exceptionContext(), getGlobalContext(), getStreamContext(), getTopModuleCallingContext(), edm::operator<<(), edm::SystemTimeKeeper::pauseModuleEvent(), and edm::SystemTimeKeeper::stopModuleEvent().

{ return parent_.type(); }

Member Data Documentation

id_

std::uintptr_t edm::ModuleCallingContext::id_

private

Definition at line 91 of file ModuleCallingContext.h.

Referenced by callID().

moduleDescription_

ModuleDescription const* edm::ModuleCallingContext::moduleDescription_

private

Definition at line 89 of file ModuleCallingContext.h.

Referenced by moduleDescription().

parent_

ParentContext edm::ModuleCallingContext::parent_

private

Definition at line 90 of file ModuleCallingContext.h.

Referenced by globalContext(), internalContext(), moduleCallingContext(), parent(), placeInPathContext(), setContext(), streamContext(), and type().

previousModuleOnThread_

ModuleCallingContext const* edm::ModuleCallingContext::previousModuleOnThread_

private

Definition at line 88 of file ModuleCallingContext.h.

Referenced by previousModuleOnThread(), and setContext().

state_

State edm::ModuleCallingContext::state_

private

Definition at line 92 of file ModuleCallingContext.h.

Referenced by setContext(), setState(), and state().