SiStripPayloadHandler< SiStripPayload > Class Template Reference

Inheritance diagram for SiStripPayloadHandler< SiStripPayload >:

Public Member Functions
void	analyze (const edm::Event &evt, const edm::EventSetup &evtSetup) override
void	endJob () override
	SiStripPayloadHandler (const edm::ParameterSet &iConfig)
	~SiStripPayloadHandler () override
Public Member Functions inherited from edm::EDAnalyzer
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
	EDAnalyzer ()
SerialTaskQueue *	globalLuminosityBlocksQueue ()
SerialTaskQueue *	globalRunsQueue ()
ModuleDescription const &	moduleDescription () const
std::string	workerType () const
	~EDAnalyzer () override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase &&)=default
	EDConsumerBase (EDConsumerBase const &)=delete
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const
std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const * > *, NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase &	operator= (EDConsumerBase &&)=default
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Private Member Functions
std::string	makeConfigHash ()
std::string	queryConfigMap (std::string configHash)
void	updateConfigMap (std::string configHash, std::string payloadHash)

Private Attributes
edm::Service< SiStripCondObjBuilderFromDb >	condObjBuilder
std::string	m_cfgMapDbFile
std::string	m_cfgMapSchemaName
std::string	m_cfgMapTableName
std::string	m_condDb
std::string	m_configMapDb
cond::persistency::ConnectionPool	m_connectionPool
std::string	m_localCondDbFile
cond::Time_t	m_since
std::string	m_targetTag
std::string	p_cfgstr
std::string	p_type

Additional Inherited Members
Public Types inherited from edm::EDAnalyzer
typedef EDAnalyzer	ModuleType
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Static Public Member Functions inherited from edm::EDAnalyzer
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)
static bool	wantsGlobalLuminosityBlocks ()
static bool	wantsGlobalRuns ()
static bool	wantsInputProcessBlocks ()
static bool	wantsProcessBlocks ()
static bool	wantsStreamLuminosityBlocks ()
static bool	wantsStreamRuns ()
Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...
template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept
template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

Detailed Description

template<typename SiStripPayload>
class SiStripPayloadHandler< SiStripPayload >

Definition at line 29 of file SiStripPayloadHandler.cc.

Constructor & Destructor Documentation

SiStripPayloadHandler()

template<typename SiStripPayload >

SiStripPayloadHandler< SiStripPayload >::SiStripPayloadHandler ( const edm::ParameterSet &  iConfig )

explicit

Definition at line 58 of file SiStripPayloadHandler.cc.

    : m_connectionPool(),
      m_cfgMapSchemaName(iConfig.getUntrackedParameter<std::string>("cfgMapSchemaName", "CMS_COND_O2O")),
      m_cfgMapTableName(iConfig.getUntrackedParameter<std::string>("cfgMapTableName", "STRIP_CONFIG_TO_PAYLOAD_MAP")),
      m_condDb(iConfig.getParameter<std::string>("conditionDatabase")),
      m_localCondDbFile(iConfig.getParameter<std::string>("condDbFile")),
      m_targetTag(iConfig.getParameter<std::string>("targetTag")),
      m_since(iConfig.getParameter<uint32_t>("since")),
      p_type(cond::demangledName(typeid(SiStripPayload))),
      p_cfgstr(condObjBuilder->getConfigString(typeid(SiStripPayload))) {
  if (iConfig.exists("configMapDatabase"))
    m_configMapDb = iConfig.getParameter<std::string>("configMapDatabase");
  if (iConfig.exists("cfgMapDbFile"))
    m_cfgMapDbFile = iConfig.getParameter<std::string>("cfgMapDbFile");
  m_connectionPool.setParameters(iConfig.getParameter<edm::ParameterSet>("DBParameters"));
  m_connectionPool.configure();
}

References cond::persistency::ConnectionPool::configure(), edm::ParameterSet::exists(), edm::ParameterSet::getParameter(), SiStripPayloadHandler< SiStripPayload >::m_cfgMapDbFile, SiStripPayloadHandler< SiStripPayload >::m_configMapDb, SiStripPayloadHandler< SiStripPayload >::m_connectionPool, cond::persistency::ConnectionPool::setParameters(), and AlCaHLTBitMon_QueryRunRegistry::string.

~SiStripPayloadHandler()

template<typename SiStripPayload >

SiStripPayloadHandler< SiStripPayload >::~SiStripPayloadHandler ( )

override

Definition at line 77 of file SiStripPayloadHandler.cc.

{}

Member Function Documentation

analyze()

template<typename SiStripPayload >

void SiStripPayloadHandler< SiStripPayload >::analyze ( const edm::Event &  evt, const edm::EventSetup &  evtSetup  )

overridevirtual

Implements edm::EDAnalyzer.

Definition at line 80 of file SiStripPayloadHandler.cc.

                                                                                                      {
  // some extra work: Getting the payload hash of the last IOV from condDb
  // Will be compared with the new payload and reported
  cond::persistency::Session condDbSession = m_connectionPool.createSession(m_condDb);
  condDbSession.transaction().start(true);
  cond::persistency::IOVProxy iovProxy = condDbSession.readIov(m_targetTag);
  cond::Hash last_hash = iovProxy.getLast().payloadId;
 
  // that's the final goal: obtain the payload to store into the sqlite file for the upload into the DB
  std::shared_ptr<SiStripPayload> payloadToUpload;
  // first compute the hash of the configuration
  std::string configHash = makeConfigHash();
  // query the configMap DB to find the corresponding payload hash
  std::string mappedPayloadHash = queryConfigMap(configHash);
  bool mapUpToDate = false;
 
  if (!mappedPayloadHash.empty()) {
    // the payload has been found ( fast O2O case )
    // copy the payload from condtition database
    mapUpToDate = true;
    edm::LogInfo("SiStripPayloadHandler") << "[SiStripPayloadHandler::" << __func__ << "] "
                                          << "Try retrieving payload from " << m_condDb;
    payloadToUpload = condDbSession.fetchPayload<SiStripPayload>(mappedPayloadHash);
    std::cout << "@@@[FastO2O:true]@@@" << std::endl;
    edm::LogInfo("SiStripPayloadHandler") << "[SiStripPayloadHandler::" << __func__ << "] "
                                          << " ... Payload is copied from offline condition database.";
  } else {
    // start the long O2O...
    edm::LogInfo("SiStripPayloadHandler") << "[SiStripPayloadHandler::" << __func__ << "] "
                                          << "NO mapping payload hash found. Will run the long O2O. ";
    SiStripPayload* obj = nullptr;
    if (typeid(SiStripPayload) == typeid(SiStripApvGain)) {
      // special treatment for ApvGain : provide last payload in DB
      condObjBuilder->setLastIovGain(condDbSession.fetchPayload<SiStripApvGain>(last_hash));
    }
    condObjBuilder->getValue(obj);
    payloadToUpload = std::shared_ptr<SiStripPayload>(obj);
    std::cout << "@@@[FastO2O:false]@@@" << std::endl;
    edm::LogInfo("SiStripPayloadHandler") << "[SiStripPayloadHandler::" << __func__ << "] "
                                          << " ... New payload has been created.";
  }
  condDbSession.transaction().commit();
 
  // write payload and iov in the local file
  edm::LogInfo("SiStripPayloadHandler") << "[SiStripPayloadHandler::" << __func__ << "] "
                                        << "Write payload to local sqlite file: " << m_localCondDbFile;
  cond::persistency::Session localFileSession = m_connectionPool.createSession(m_localCondDbFile, true);
  localFileSession.transaction().start(false);
  // write the payload
  cond::Hash thePayloadHash = localFileSession.storePayload<SiStripPayload>(*payloadToUpload);
  cond::persistency::IOVEditor iovEditor = localFileSession.createIov<SiStripPayload>(m_targetTag, cond::runnumber);
  iovEditor.setDescription("New IOV");
  // inserting the iov
  iovEditor.insert(m_since, thePayloadHash);
  iovEditor.flush();
  localFileSession.transaction().commit();
  edm::LogInfo("SiStripPayloadHandler") << "[SiStripPayloadHandler::" << __func__ << "] "
                                        << "Payload " << thePayloadHash << " inserted to sqlite with IOV " << m_since;
 
  // last step, update the configMap if required
  if (!mapUpToDate) {
    updateConfigMap(configHash, thePayloadHash);
  }
 
  // finish the extra work: Compare the new payload with last IOV
  if (last_hash == thePayloadHash) {
    std::cout << "@@@[PayloadChange:false]@@@" << last_hash << std::endl;
  } else {
    std::cout << "@@@[PayloadChange:true]@@@" << last_hash << " -> " << thePayloadHash << std::endl;
  }
}

References cond::persistency::Transaction::commit(), gather_cfg::cout, cond::persistency::Session::createIov(), cond::persistency::Session::fetchPayload(), cond::persistency::IOVEditor::flush(), cond::persistency::IOVProxy::getLast(), cond::persistency::IOVEditor::insert(), getGTfromDQMFile::obj, cond::Iov_t::payloadId, cond::persistency::Session::readIov(), cond::runnumber, cond::persistency::IOVEditor::setDescription(), cond::persistency::Transaction::start(), cond::persistency::Session::storePayload(), AlCaHLTBitMon_QueryRunRegistry::string, and cond::persistency::Session::transaction().

endJob()

template<typename SiStripPayload >

void SiStripPayloadHandler< SiStripPayload >::endJob ( void  )

overridevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 153 of file SiStripPayloadHandler.cc.

{}

makeConfigHash()

template<typename SiStripPayload >

std::string SiStripPayloadHandler< SiStripPayload >::makeConfigHash ( )

private

Definition at line 156 of file SiStripPayloadHandler.cc.

                                                                {
  edm::LogInfo("SiStripPayloadHandler") << "[SiStripPayloadHandler::" << __func__ << "] "
                                        << "Convert config string to SHA-1 hash for " << p_type
                                        << "\n... config: " << p_cfgstr;
 
  // calcuate SHA-1 hash using openssl
  // adapted from cond::persistency::makeHash() in CondCore/CondDB/src/IOVSchema.cc
  SHA_CTX ctx;
  if (!SHA1_Init(&ctx)) {
    throw cms::Exception("SHA1 initialization error.");
  }
  if (!SHA1_Update(&ctx, p_type.c_str(), p_type.size())) {
    throw cms::Exception("SHA1 processing error (1).");
  }
  if (!SHA1_Update(&ctx, p_cfgstr.c_str(), p_cfgstr.size())) {
    throw cms::Exception("SHA1 processing error (2).");
  }
  unsigned char hash[SHA_DIGEST_LENGTH];
  if (!SHA1_Final(hash, &ctx)) {
    throw cms::Exception("SHA1 finalization error.");
  }
 
  char tmp[SHA_DIGEST_LENGTH * 2 + 1];
  // re-write bytes in hex
  for (unsigned int i = 0; i < SHA_DIGEST_LENGTH; i++) {
    ::sprintf(&tmp[i * 2], "%02x", hash[i]);
  }
  tmp[SHA_DIGEST_LENGTH * 2] = 0;
 
  edm::LogInfo("SiStripPayloadHandler") << "[SiStripPayloadHandler::" << __func__
                                        << "] "
                                           "... hash: "
                                        << tmp;
  return tmp;
}

References Exception, cond::hash, mps_fire::i, and createJobs::tmp.

queryConfigMap()

template<typename SiStripPayload >

std::string SiStripPayloadHandler< SiStripPayload >::queryConfigMap ( std::string  configHash )

private

Definition at line 193 of file SiStripPayloadHandler.cc.

                                                                                    {
  if (m_configMapDb.empty())
    return "";  // return empty string if m_configMapDb is not specified
 
  edm::LogInfo("SiStripPayloadHandler") << "[SiStripPayloadHandler::" << __func__ << "] "
                                        << "Query " << m_configMapDb << " to see if the payload is already in DB.";
 
  auto cmDbSession = m_connectionPool.createCoralSession(m_configMapDb);
  // query the STRIP_CONFIG_TO_PAYLOAD_MAP table
  cmDbSession->transaction().start(true);
  coral::ITable& cmTable = cmDbSession->schema(m_cfgMapSchemaName).tableHandle(m_cfgMapTableName);
  std::unique_ptr<coral::IQuery> query(cmTable.newQuery());
  query->addToOutputList("PAYLOAD_HASH");
  query->defineOutputType("PAYLOAD_HASH", coral::AttributeSpecification::typeNameForType<std::string>());
  // also print these for debugging
  query->addToOutputList("PAYLOAD_TYPE");
  query->addToOutputList("CONFIG_STRING");
  query->addToOutputList("INSERTION_TIME");
  std::string whereClause("CONFIG_HASH = :CONFIG_HASH");
  coral::AttributeList whereData;
  whereData.extend<std::string>("CONFIG_HASH");
  whereData.begin()->data<std::string>() = configHash;
  query->setCondition(whereClause, whereData);
  coral::ICursor& cursor = query->execute();
  std::string p_hash;
  if (cursor.next()) {
    // the payload has been found ( fast O2O case )
    p_hash = cursor.currentRow()["PAYLOAD_HASH"].data<std::string>();
    edm::LogInfo("SiStripPayloadHandler")
        << "[SiStripPayloadHandler::" << __func__ << "] "
        << "Found associated payload hash " << p_hash
        << "\n...  type=" << cursor.currentRow()["PAYLOAD_TYPE"].data<std::string>()
        << "\n...  config=" << cursor.currentRow()["CONFIG_STRING"].data<std::string>()
        << "\n...  insertion_time=" << cursor.currentRow()["INSERTION_TIME"].data<coral::TimeStamp>().toString();
  }
  cmDbSession->transaction().commit();
 
  return p_hash;
}

References contentValuesFiles::query, AlCaHLTBitMon_QueryRunRegistry::string, and toolbox::toString().

updateConfigMap()

template<typename SiStripPayload >

void SiStripPayloadHandler< SiStripPayload >::updateConfigMap ( std::string  configHash, std::string  payloadHash  )

private

Definition at line 234 of file SiStripPayloadHandler.cc.

                                                                                                       {
  if (m_cfgMapDbFile.empty())
    return;  // skip this if m_cfgMapDbFile is not set
 
  edm::LogInfo("SiStripPayloadHandler") << "[SiStripPayloadHandler::" << __func__ << "] "
                                        << "Updating the config to payload hash map to " << m_cfgMapDbFile;
 
  // create a writable transaction
  auto cmSQLiteSession = m_connectionPool.createCoralSession(m_cfgMapDbFile, true);
  cmSQLiteSession->transaction().start(false);
 
  if (!cmSQLiteSession->nominalSchema().existsTable(m_cfgMapTableName)) {
    // create the table if it does not exist
    coral::TableDescription mapTable;
    mapTable.setName(m_cfgMapTableName);
    mapTable.insertColumn("CONFIG_HASH", coral::AttributeSpecification::typeNameForType<std::string>());
    mapTable.insertColumn("PAYLOAD_HASH", coral::AttributeSpecification::typeNameForType<std::string>());
    mapTable.insertColumn("PAYLOAD_TYPE", coral::AttributeSpecification::typeNameForType<std::string>());
    mapTable.insertColumn("CONFIG_STRING", coral::AttributeSpecification::typeNameForType<std::string>());
    mapTable.insertColumn("INSERTION_TIME", coral::AttributeSpecification::typeNameForType<coral::TimeStamp>());
    mapTable.setPrimaryKey("CONFIG_HASH");
    mapTable.setNotNullConstraint("CONFIG_HASH");
    mapTable.setNotNullConstraint("PAYLOAD_HASH");
    mapTable.setNotNullConstraint("PAYLOAD_TYPE");
    mapTable.setNotNullConstraint("CONFIG_STRING");
    mapTable.setNotNullConstraint("INSERTION_TIME");
    cmSQLiteSession->nominalSchema().createTable(mapTable);
  }
 
  coral::ITable& cmTable = cmSQLiteSession->nominalSchema().tableHandle(m_cfgMapTableName);
  coral::AttributeList insertData;
  insertData.extend<std::string>("CONFIG_HASH");
  insertData.extend<std::string>("PAYLOAD_HASH");
  // also insert these for bookkeeping
  insertData.extend<std::string>("PAYLOAD_TYPE");
  insertData.extend<std::string>("CONFIG_STRING");
  insertData.extend<coral::TimeStamp>("INSERTION_TIME");
  insertData["CONFIG_HASH"].data<std::string>() = configHash;
  insertData["PAYLOAD_HASH"].data<std::string>() = payloadHash;
  insertData["PAYLOAD_TYPE"].data<std::string>() = p_type;
  insertData["CONFIG_STRING"].data<std::string>() = p_cfgstr;
  insertData["INSERTION_TIME"].data<coral::TimeStamp>() = coral::TimeStamp::now();  // UTC time
  cmTable.dataEditor().insertRow(insertData);
  cmSQLiteSession->transaction().commit();
  edm::LogInfo("SiStripPayloadHandler") << "[SiStripPayloadHandler::" << __func__ << "] "
                                        << "Updated with mapping (configHash : payloadHash)" << configHash << " : "
                                        << payloadHash;
}

References submitPVValidationJobs::now, and AlCaHLTBitMon_QueryRunRegistry::string.

Member Data Documentation

condObjBuilder

template<typename SiStripPayload >

edm::Service<SiStripCondObjBuilderFromDb> SiStripPayloadHandler< SiStripPayload >::condObjBuilder

private

Definition at line 54 of file SiStripPayloadHandler.cc.

m_cfgMapDbFile

template<typename SiStripPayload >

std::string SiStripPayloadHandler< SiStripPayload >::m_cfgMapDbFile

private

Definition at line 47 of file SiStripPayloadHandler.cc.

Referenced by SiStripPayloadHandler< SiStripPayload >::SiStripPayloadHandler().

m_cfgMapSchemaName

template<typename SiStripPayload >

std::string SiStripPayloadHandler< SiStripPayload >::m_cfgMapSchemaName

private

Definition at line 44 of file SiStripPayloadHandler.cc.

m_cfgMapTableName

template<typename SiStripPayload >

std::string SiStripPayloadHandler< SiStripPayload >::m_cfgMapTableName

private

Definition at line 45 of file SiStripPayloadHandler.cc.

m_condDb

template<typename SiStripPayload >

std::string SiStripPayloadHandler< SiStripPayload >::m_condDb

private

Definition at line 46 of file SiStripPayloadHandler.cc.

m_configMapDb

template<typename SiStripPayload >

std::string SiStripPayloadHandler< SiStripPayload >::m_configMapDb

private

Definition at line 43 of file SiStripPayloadHandler.cc.

Referenced by SiStripPayloadHandler< SiStripPayload >::SiStripPayloadHandler().

m_connectionPool

template<typename SiStripPayload >

cond::persistency::ConnectionPool SiStripPayloadHandler< SiStripPayload >::m_connectionPool

private

Definition at line 42 of file SiStripPayloadHandler.cc.

Referenced by SiStripPayloadHandler< SiStripPayload >::SiStripPayloadHandler().

m_localCondDbFile

template<typename SiStripPayload >

std::string SiStripPayloadHandler< SiStripPayload >::m_localCondDbFile

private

Definition at line 48 of file SiStripPayloadHandler.cc.

m_since

template<typename SiStripPayload >

cond::Time_t SiStripPayloadHandler< SiStripPayload >::m_since

private

Definition at line 50 of file SiStripPayloadHandler.cc.

m_targetTag

template<typename SiStripPayload >

std::string SiStripPayloadHandler< SiStripPayload >::m_targetTag

private

Definition at line 49 of file SiStripPayloadHandler.cc.

p_cfgstr

template<typename SiStripPayload >

std::string SiStripPayloadHandler< SiStripPayload >::p_cfgstr

private

Definition at line 53 of file SiStripPayloadHandler.cc.

p_type

template<typename SiStripPayload >

std::string SiStripPayloadHandler< SiStripPayload >::p_type

private

Definition at line 52 of file SiStripPayloadHandler.cc.