edm::SharedResourcesRegistry Class Reference

#include <SharedResourcesRegistry.h>

Public Member Functions
SharedResourcesAcquirer	createAcquirer (std::vector< std::string > const &) const
SharedResourcesAcquirer	createAcquirerForSourceDelayedReader ()
void	registerSharedResource (const std::string &)
	A resource name must be registered before it can be used in the createAcquirer call. More...

Static Public Member Functions
static SharedResourcesRegistry *	instance ()

Static Public Attributes
static const std::string	kLegacyModuleResourceName {"__legacy__"}
	All legacy modules share this resource. More...

Private Member Functions
const SharedResourcesRegistry &	operator= (const SharedResourcesRegistry &)=delete
	SharedResourcesRegistry ()
	SharedResourcesRegistry (const SharedResourcesRegistry &)=delete
	~SharedResourcesRegistry ()=default

Private Attributes
unsigned int	nLegacy_
std::shared_ptr < std::recursive_mutex >	resourceForDelayedReader_
std::map< std::string, std::pair< std::shared_ptr < std::recursive_mutex > , unsigned int > >	resourceMap_

Friends
class	::testSharedResourcesRegistry

Detailed Description

Definition at line 36 of file SharedResourcesRegistry.h.

Constructor & Destructor Documentation

SharedResourcesRegistry::SharedResourcesRegistry ( )

private

Definition at line 31 of file SharedResourcesRegistry.cc.

                                                   : nLegacy_(0) {
  }

edm::SharedResourcesRegistry::~SharedResourcesRegistry ( )

privatedefault

edm::SharedResourcesRegistry::SharedResourcesRegistry ( const SharedResourcesRegistry &  )

privatedelete

Member Function Documentation

SharedResourcesAcquirer SharedResourcesRegistry::createAcquirer

(

std::vector< std::string > const &

resourceNames

)

const

Definition at line 78 of file SharedResourcesRegistry.cc.

References assert(), spr::find(), kLegacyModuleResourceName, mergeVDriftHistosByStation::name, and resourceMap_.

Referenced by edm::one::impl::SharedResourcesUser< T >::createAcquirer(), edm::EDAnalyzer::doBeginJob(), edm::EDProducer::doBeginJob(), edm::EDFilter::doBeginJob(), and edm::OutputModule::doBeginJob().

                                                                                         {

    // The acquirer will acquire the shared resources declared by a module
    // so that only it can use those resources while it runs. The other
    // modules using the same resource will not be run until the module
    // that acquired the resources completes its task.

    // The legacy shared resource is special.
    // Legacy modules cannot run concurrently with each other or
    // any other module that has declared any shared resource. Treat
    // one modules that call usesResource with no argument in the
    // same way.

    // Sort by how often used and then by name
    // Consistent sorting avoids deadlocks and this particular order optimizes performance
    std::map<std::pair<unsigned int, std::string>, std::recursive_mutex*> sortedResources;

    // Is this acquirer for a module that depends on the legacy shared resource?
    if(std::find(resourceNames.begin(), resourceNames.end(), kLegacyModuleResourceName) != resourceNames.end()) {

      for(auto const& resource : resourceMap_) {
        // It's redundant to declare legacy if the legacy modules
        // all declare all the other resources, so just skip it.
        // But if the only shared resource is the legacy resource don't skip it.
        if(resource.first == kLegacyModuleResourceName && resourceMap_.size() > 1) continue;
        //If only one module wants it, it really isn't shared
        if(resource.second.second > 1) {
          sortedResources.insert(std::make_pair(std::make_pair(resource.second.second, resource.first),resource.second.first.get()));
        }
      }
    // Handle cases where the module does not declare the legacy resource
    } else {
      for(auto const& name : resourceNames) {
        auto resource = resourceMap_.find(name);
        assert(resource != resourceMap_.end());
        //If only one module wants it, it really isn't shared
        if(resource->second.second > 1) {
          sortedResources.insert(std::make_pair(std::make_pair(resource->second.second, resource->first),resource->second.first.get()));
        }
      }
    }

    std::vector<std::recursive_mutex*> mutexes;
    mutexes.reserve(sortedResources.size());
    for(auto const& resource: sortedResources) {
      mutexes.push_back(resource.second);
    }
    return SharedResourcesAcquirer(std::move(mutexes));
  }

SharedResourcesAcquirer SharedResourcesRegistry::createAcquirerForSourceDelayedReader

(

)

Definition at line 68 of file SharedResourcesRegistry.cc.

References resourceForDelayedReader_.

Referenced by edm::PoolSource::PoolSource().

                                                                {
    if(not resourceForDelayedReader_) {
      resourceForDelayedReader_.reset(new std::recursive_mutex{});
    }
    std::vector<std::recursive_mutex*> mutexes = {resourceForDelayedReader_.get()};

    return SharedResourcesAcquirer(std::move(mutexes));
  }

SharedResourcesRegistry * SharedResourcesRegistry::instance ( )

static

Definition at line 26 of file SharedResourcesRegistry.cc.

Referenced by edm::one::impl::SharedResourcesUser< T >::createAcquirer(), edm::EDAnalyzer::doBeginJob(), edm::EDProducer::doBeginJob(), edm::EDFilter::doBeginJob(), edm::OutputModule::doBeginJob(), edm::EDAnalyzer::EDAnalyzer(), edm::EDFilter::EDFilter(), edm::EDProducer::EDProducer(), edm::OutputModule::OutputModule(), edm::PoolSource::PoolSource(), and edm::one::impl::SharedResourcesUser< T >::usesResource().

                                    {
    static SharedResourcesRegistry s_instance;
    return &s_instance;
  }

const SharedResourcesRegistry& edm::SharedResourcesRegistry::operator= ( const SharedResourcesRegistry &  )

privatedelete

void SharedResourcesRegistry::registerSharedResource

(

const std::string &

resourceName

)

A resource name must be registered before it can be used in the createAcquirer call.

Definition at line 35 of file SharedResourcesRegistry.cc.

References kLegacyModuleResourceName, nLegacy_, and resourceMap_.

Referenced by edm::EDAnalyzer::EDAnalyzer(), edm::EDFilter::EDFilter(), edm::EDProducer::EDProducer(), edm::OutputModule::OutputModule(), and edm::one::impl::SharedResourcesUser< T >::usesResource().

                                                                              {

    auto& mutexAndCounter = resourceMap_[resourceName];

    if(resourceName == kLegacyModuleResourceName) {
      ++nLegacy_;
      for(auto & resource : resourceMap_) {
        if(!resource.second.first) {
          resource.second.first = std::make_shared<std::recursive_mutex>();
        }
        ++resource.second.second;
      }
    } else {
      // count the number of times the resource was registered
      ++mutexAndCounter.second;

      // When first registering a nonlegacy resource, we have to
      // account for any legacy resource registrations already made. 
      if(mutexAndCounter.second == 1) {
        if(nLegacy_ > 0U) {
          mutexAndCounter.first = std::make_shared<std::recursive_mutex>();
          mutexAndCounter.second += nLegacy_;
        }
      // If registering a nonlegacy resource the second time and
      // the legacy resource has not been registered yet,
      // we know we will need the mutex so go ahead and create it.
      } else if(mutexAndCounter.second == 2) {
        mutexAndCounter.first = std::make_shared<std::recursive_mutex>();
      }
    }
  }

Friends And Related Function Documentation

friend class ::testSharedResourcesRegistry

friend

Definition at line 41 of file SharedResourcesRegistry.h.

Member Data Documentation

const std::string SharedResourcesRegistry::kLegacyModuleResourceName {"__legacy__"}

static

All legacy modules share this resource.

Definition at line 51 of file SharedResourcesRegistry.h.

Referenced by createAcquirer(), edm::EDAnalyzer::doBeginJob(), edm::EDProducer::doBeginJob(), edm::EDFilter::doBeginJob(), edm::OutputModule::doBeginJob(), edm::EDAnalyzer::EDAnalyzer(), edm::EDFilter::EDFilter(), edm::EDProducer::EDProducer(), edm::OutputModule::OutputModule(), registerSharedResource(), and edm::one::impl::SharedResourcesUser< T >::usesResource().

unsigned int edm::SharedResourcesRegistry::nLegacy_

private

Definition at line 75 of file SharedResourcesRegistry.h.

Referenced by registerSharedResource().

std::shared_ptr<std::recursive_mutex> edm::SharedResourcesRegistry::resourceForDelayedReader_

private

Definition at line 73 of file SharedResourcesRegistry.h.

Referenced by createAcquirerForSourceDelayedReader().

std::map<std::string, std::pair<std::shared_ptr<std::recursive_mutex>,unsigned int> > edm::SharedResourcesRegistry::resourceMap_

private

Definition at line 71 of file SharedResourcesRegistry.h.

Referenced by createAcquirer(), and registerSharedResource().