edmplugin::PluginCapabilities Class Reference

#include <PluginCapabilities.h>

Inheritance diagram for edmplugin::PluginCapabilities:

Public Member Functions
std::vector< PluginInfo >	available () const override
	return info about all plugins which are already available in the program More...
const std::string &	category () const override
	returns the name of the category to which this plugin factory belongs More...
void	load (const std::string &iName)
const PluginCapabilities &	operator= (const PluginCapabilities &)=delete
	PluginCapabilities (const PluginCapabilities &)=delete
bool	tryToFind (const SharedLibrary &iLoadable)
	Check to see if any capabilities are in the file, returns 'true' if found. More...
bool	tryToLoad (const std::string &iName)
	~PluginCapabilities () override
Public Member Functions inherited from edmplugin::PluginFactoryBase
const PluginFactoryBase &	operator= (const PluginFactoryBase &)=delete
	PluginFactoryBase ()
	PluginFactoryBase (const PluginFactoryBase &)=delete
virtual	~PluginFactoryBase ()

Static Public Member Functions
static PluginCapabilities *	get ()

Private Member Functions
	PluginCapabilities ()

Private Attributes
std::map< std::string, std::filesystem::path >	classToLoadable_

Friends
class	DummyFriend

Additional Inherited Members
Public Types inherited from edmplugin::PluginFactoryBase
typedef oneapi::tbb::concurrent_unordered_map< std::string, PMakers >	Plugins
typedef oneapi::tbb::concurrent_vector< PluginMakerInfo, edm::zero_allocator< PluginMakerInfo > >	PMakers
Public Attributes inherited from edmplugin::PluginFactoryBase
edm::signalslot::Signal< void(const std::string &, const PluginInfo &)>	newPluginAdded_
	signal containing plugin category, and plugin info for newly added plugin More...
Protected Member Functions inherited from edmplugin::PluginFactoryBase
void	fillAvailable (std::vector< PluginInfo > &iReturn) const
void	fillInfo (const PMakers &makers, PluginInfo &iInfo, std::vector< PluginInfo > &iReturn) const
void *	findPMaker (const std::string &iName) const
void	finishedConstruction ()
void	newPlugin (const std::string &iName)
void	registerPMaker (void *iPMaker, const std::string &iName)
void *	tryToFindPMaker (const std::string &iName) const

Detailed Description

Definition at line 32 of file PluginCapabilities.h.

Constructor & Destructor Documentation

PluginCapabilities() [1/2]

edmplugin::PluginCapabilities::PluginCapabilities ( const PluginCapabilities &  )

delete

~PluginCapabilities()

PluginCapabilities::~PluginCapabilities ( )

override

Definition at line 41 of file PluginCapabilities.cc.

{}

PluginCapabilities() [2/2]

PluginCapabilities::PluginCapabilities ( )

private

Definition at line 34 of file PluginCapabilities.cc.

References edmplugin::PluginFactoryBase::finishedConstruction().

{ finishedConstruction(); }

Member Function Documentation

available()

std::vector< PluginInfo > PluginCapabilities::available ( ) const

overridevirtual

return info about all plugins which are already available in the program

Reimplemented from edmplugin::PluginFactoryBase.

Definition at line 133 of file PluginCapabilities.cc.

References classToLoadable_, info(), submitPVValidationJobs::infos, and ALPAKA_ACCELERATOR_NAMESPACE::vertexFinder::it.

                                                            {
    PluginInfo info;
    std::vector<PluginInfo> infos;
    infos.reserve(classToLoadable_.size());

    for (std::map<std::string, std::filesystem::path>::const_iterator it = classToLoadable_.begin();
         it != classToLoadable_.end();
         ++it) {
      info.name_ = it->first;
      info.loadable_ = it->second;
      infos.push_back(info);
    }
    return infos;
  }

category()

const std::string & PluginCapabilities::category ( ) const

overridevirtual

returns the name of the category to which this plugin factory belongs

Implements edmplugin::PluginFactoryBase.

Definition at line 148 of file PluginCapabilities.cc.

References AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by load(), tryToFind(), and tryToLoad().

                                                      {
    static const std::string s_cat("Capability");
    return s_cat;
  }

get()

PluginCapabilities * PluginCapabilities::get ( )

static

Definition at line 156 of file PluginCapabilities.cc.

References CMS_THREAD_SAFE.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), edm::service::LoadAllDictionaries::LoadAllDictionaries(), main(), rrapi.RRApi::report(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), and rrapi.RRApi::workspaces().

                                              {
    CMS_THREAD_SAFE static PluginCapabilities s_instance;
    return &s_instance;
  }

load()

void PluginCapabilities::load

(

const std::string &

iName

)

Definition at line 83 of file PluginCapabilities.cc.

References category(), classToLoadable_, Exception, edmplugin::PluginManager::get(), mps_check::lib, edmplugin::PluginManager::load(), and tryToFind().

Referenced by edm::service::LoadAllDictionaries::LoadAllDictionaries().

                                                      {
    if (classToLoadable_.end() == classToLoadable_.find(iName)) {
      const SharedLibrary& lib = PluginManager::get()->load(category(), iName);
      //read the items from the 'capabilities' symbol
      if (not tryToFind(lib)) {
        throw cms::Exception("PluginNotFound")
            << "The dictionary for class '" << iName << "' is supposed to be in file\n '" << lib.path().string()
            << "'\n but no dictionaries are in that file.\n"
               "It appears like the cache is wrong.  Please do 'EdmPluginRefresh "
            << lib.path().string() << "'.";
      }

      if (classToLoadable_.end() == classToLoadable_.find(iName)) {
        throw cms::Exception("PluginNotFound")
            << "The dictionary for class '" << iName << "' is supposed to be in file\n '" << lib.path().string()
            << "'\n but was not found.\n"
               "It appears like the cache is wrong.  Please do 'EdmPluginRefresh "
            << lib.path().string() << "'.";
      }
    }
  }

operator=()

const PluginCapabilities& edmplugin::PluginCapabilities::operator= ( const PluginCapabilities &  )

delete

tryToFind()

bool PluginCapabilities::tryToFind

(

const SharedLibrary &

iLoadable

)

Check to see if any capabilities are in the file, returns 'true' if found.

Definition at line 58 of file PluginCapabilities.cc.

References category(), classToLoadable_, mps_fire::i, info(), Skims_PA_cff::name, names, edmplugin::PluginFactoryBase::newPluginAdded_, edmplugin::SharedLibrary::path(), AlCaHLTBitMon_QueryRunRegistry::string, and edmplugin::SharedLibrary::symbol().

Referenced by load(), main(), and tryToLoad().

                                                                   {
    void* sym;
    if (not iLoadable.symbol("SEAL_CAPABILITIES", sym)) {
      return false;
    }

    const char** names;
    int size;
    //reinterpret_cast<void (*)(const char**&,int&)>(sym)(names,size);
    reinterpret_cast<void (*)(const char**&, int&)>(reinterpret_cast<unsigned long>(sym))(names, size);

    PluginInfo info;
    for (int i = 0; i < size; ++i) {
      std::string name(names[i]);
      classToLoadable_[name] = iLoadable.path();

      //NOTE: can't use newPlugin(name) to do the work since it assumes
      //  we haven't yet returned from PluginManager::load method
      info.name_ = name;
      info.loadable_ = iLoadable.path();
      this->newPluginAdded_(category(), info);
    }
    return true;
  }

tryToLoad()

bool PluginCapabilities::tryToLoad

(

const std::string &

iName

)

Definition at line 105 of file PluginCapabilities.cc.

References category(), classToLoadable_, Exception, edmplugin::PluginManager::get(), mps_check::lib, tryToFind(), and edmplugin::PluginManager::tryToLoad().

                                                           {
    if (classToLoadable_.end() == classToLoadable_.find(iName)) {
      const SharedLibrary* lib = PluginManager::get()->tryToLoad(category(), iName);
      if (nullptr == lib) {
        return false;
      }
      //read the items from the 'capabilities' symbol
      if (not tryToFind(*lib)) {
        throw cms::Exception("PluginNotFound")
            << "The dictionary for class '" << iName << "' is supposed to be in file\n '" << lib->path().string()
            << "'\n but no dictionaries are in that file.\n"
               "It appears like the cache is wrong.  Please do 'EdmPluginRefresh "
            << lib->path().string() << "'.";
      }

      if (classToLoadable_.end() == classToLoadable_.find(iName)) {
        throw cms::Exception("PluginNotFound")
            << "The dictionary for class '" << iName << "' is supposed to be in file\n '" << lib->path().string()
            << "'\n but was not found.\n"
               "It appears like the cache is wrong.  Please do 'EdmPluginRefresh "
            << lib->path().string() << "'.";
      }
    }
    return true;
  }

Friends And Related Function Documentation

DummyFriend

friend class DummyFriend

friend

Definition at line 33 of file PluginCapabilities.h.

Member Data Documentation

classToLoadable_

std::map<std::string, std::filesystem::path> edmplugin::PluginCapabilities::classToLoadable_

private

Definition at line 60 of file PluginCapabilities.h.

Referenced by available(), load(), tryToFind(), and tryToLoad().