DIPLumiProducer.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:    LumiProducer
// Class:      DIPLumiProducer
//
//#include <memory>
#include "FWCore/Framework/interface/SourceFactory.h"
#include "FWCore/Framework/interface/ESProducer.h"
#include "FWCore/Framework/interface/ESHandle.h"
#include "FWCore/Framework/interface/EventSetup.h"

#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/LuminosityBlock.h"
#include "FWCore/Framework/interface/Run.h"
#include "DataFormats/Provenance/interface/LuminosityBlockID.h"
#include "FWCore/ServiceRegistry/interface/Service.h"

#include "FWCore/Framework/interface/IOVSyncValue.h"

#include "CoralBase/Exception.h"
#include "CoralBase/AttributeList.h"
#include "CoralBase/Attribute.h"
#include "CoralBase/AttributeSpecification.h"
#include "CoralBase/Exception.h"
#include "RelationalAccess/ISessionProxy.h"
#include "RelationalAccess/ITransaction.h"
#include "RelationalAccess/AccessMode.h"
#include "RelationalAccess/ITypeConverter.h"
#include "RelationalAccess/IQuery.h"
#include "RelationalAccess/ICursor.h"
#include "RelationalAccess/ISchema.h"
#include "RelationalAccess/ITable.h"
#include "RecoLuminosity/LumiProducer/interface/DBService.h"
#include "RecoLuminosity/LumiProducer/interface/Exception.h"
#include "RecoLuminosity/LumiProducer/interface/ConstantDef.h"
#include "RecoLuminosity/LumiProducer/interface/DIPLumiSummary.h"
#include "RecoLuminosity/LumiProducer/interface/DIPLumiDetail.h"
#include "RecoLuminosity/LumiProducer/interface/DIPLuminosityRcd.h"
#include "DIPLumiProducer.h"
#include <iostream>
#include <sstream>
#include <string>
#include <memory>
#include <algorithm>
#include <vector>
#include <cstring>
#include <iterator>
#include <boost/tokenizer.hpp>
#include <xercesc/dom/DOM.hpp>
#include <xercesc/parsers/XercesDOMParser.hpp>
#include "Utilities/Xerces/interface/Xerces.h"
#include <xercesc/util/XMLString.hpp>

DIPLumiProducer::DIPLumiProducer(const edm::ParameterSet& iConfig)
    : m_connectStr(""), m_summarycachedrun(0), m_detailcachedrun(0), m_cachesize(0) {
  setWhatProduced(this, &DIPLumiProducer::produceSummary);
  setWhatProduced(this, &DIPLumiProducer::produceDetail);
  findingRecord<DIPLuminosityRcd>();
  m_connectStr = iConfig.getParameter<std::string>("connect");
  m_cachesize = iConfig.getUntrackedParameter<unsigned int>("ncacheEntries", 3);
}

DIPLumiProducer::ReturnSummaryType DIPLumiProducer::produceSummary(const DIPLuminosityRcd&) {
  unsigned int currentrun = m_pcurrentTime->eventID().run();
  unsigned int currentls = m_pcurrentTime->luminosityBlockNumber();
  if (currentls == 0 || currentls == 4294967295) {
    return std::make_shared<const DIPLumiSummary>();
  }
  if (m_summarycachedrun != currentrun) {                          //i'm in a new run
    fillsummarycache(currentrun, currentls);                       //starting ls
  } else {                                                         //i'm in an old run
    if (m_summarycache.find(currentls) == m_summarycache.end()) {  //i'm not cached
      fillsummarycache(currentrun, currentls);                     //
    }
  }
  if (m_summarycache.empty()) {
    return std::make_shared<const DIPLumiSummary>();
  }
  if (m_summarycache.find(currentls) == m_summarycache.end()) {
    std::vector<unsigned int> v;
    for (std::map<unsigned int, std::shared_ptr<const DIPLumiSummary> >::iterator it = m_summarycache.begin();
         it != m_summarycache.end();
         ++it) {
      v.push_back(it->first);
    }
    m_summaryresult = m_summarycache[v.back()];
  } else {
    m_summaryresult = m_summarycache[currentls];
  }
  if (m_summaryresult.get() == nullptr) {
    return std::make_shared<const DIPLumiSummary>();
  }
  return m_summaryresult;
}
DIPLumiProducer::ReturnDetailType DIPLumiProducer::produceDetail(const DIPLuminosityRcd&) {
  unsigned int currentrun = m_pcurrentTime->eventID().run();
  unsigned int currentls = m_pcurrentTime->luminosityBlockNumber();
  if (currentls == 0 || currentls == 4294967295) {
    return std::make_shared<const DIPLumiDetail>();
  }
  if (m_detailcachedrun != currentrun) {                         //i'm in a new run
    filldetailcache(currentrun, currentls);                      //starting ls
  } else {                                                       //i'm in an known run
    if (m_detailcache.find(currentls) == m_detailcache.end()) {  //i'm in a unknown ls
      filldetailcache(currentrun, currentls);                    //cache all ls>=currentls
    }
  }
  if (m_detailcache.empty()) {
    return std::make_shared<const DIPLumiDetail>();
  }
  if (m_detailcache.find(currentls) == m_detailcache.end()) {
    std::vector<unsigned int> v;
    for (std::map<unsigned int, std::shared_ptr<const DIPLumiDetail> >::iterator it = m_detailcache.begin();
         it != m_detailcache.end();
         ++it) {
      v.push_back(it->first);
    }
    m_detailresult = m_detailcache[v.back()];
  } else {
    m_detailresult = m_detailcache[currentls];
  }
  if (m_detailresult.get() == nullptr) {
    return std::make_shared<const DIPLumiDetail>();
  }
  return m_detailresult;
}

void DIPLumiProducer::setIntervalFor(const edm::eventsetup::EventSetupRecordKey& iKey,
                                     const edm::IOVSyncValue& iTime,
                                     edm::ValidityInterval& oValidity) {
  m_pcurrentTime = &iTime;
  oValidity.setFirst(iTime);
  oValidity.setLast(iTime);
}

void DIPLumiProducer::fillsummarycache(unsigned int runnumber, unsigned int currentlsnum) {
  m_summarycache.clear();
  m_summarycachedrun = runnumber;
  //
  // queries once per cache refill
  //
  // select max(lumi_sections) as maxavailable from  cms_runtime_logger.lumi_sections where runnumber=:runnumber;
  //
  // if maxavailable<currentls: get lsmax=maxavailable ; else: get lsmax=currentls
  // lsmin=lsmax-cachesize
  // select runnumber,lumisection,instlumi,delivlumi,livelumi from cms_runtime_logger.lumi_sections where lumisection>=:lsmin and lumisection<=:lsmax and runnumber=:runnumber;
  //
  edm::Service<lumi::service::DBService> mydbservice;
  if (!mydbservice.isAvailable()) {
    throw cms::Exception("Non existing service lumi::service::DBService");
  }
  auto session = mydbservice->connectReadOnly(m_connectStr);
  coral::ITypeConverter& tconverter = session->typeConverter();
  tconverter.setCppTypeForSqlType(std::string("float"), std::string("FLOAT(63)"));
  tconverter.setCppTypeForSqlType(std::string("unsigned int"), std::string("NUMBER(10)"));
  tconverter.setCppTypeForSqlType(std::string("unsigned short"), std::string("NUMBER(1)"));
  unsigned int lsmin = 1;
  unsigned int lsmax = currentlsnum;
  try {
    session->transaction().start(true);
    coral::ISchema& schema = session->nominalSchema();
    unsigned int maxavailableLS = maxavailableLSforRun(schema, std::string("LUMI_SECTIONS"), m_summarycachedrun);
    if (maxavailableLS != 0 && maxavailableLS < currentlsnum) {
      lsmax = maxavailableLS;
    } else if (maxavailableLS == 0) {
      //this run not existing (yet)
      session->transaction().commit();
      return;
    }
    if (m_cachesize != 0) {
      lsmin = (lsmax - m_cachesize) > 0 ? (lsmax - m_cachesize + 1) : 1;
    }
    //std::cout<<"lsmin "<<lsmin<<" lsmax "<<lsmax<<std::endl;
    coral::AttributeList lumisummaryBindVariables;
    lumisummaryBindVariables.extend("lsmin", typeid(unsigned int));
    lumisummaryBindVariables.extend("lsmax", typeid(unsigned int));
    lumisummaryBindVariables.extend("runnumber", typeid(unsigned int));
    lumisummaryBindVariables["runnumber"].data<unsigned int>() = m_summarycachedrun;
    lumisummaryBindVariables["lsmin"].data<unsigned int>() = lsmin;
    lumisummaryBindVariables["lsmax"].data<unsigned int>() = lsmax;
    std::string conditionStr("RUNNUMBER=:runnumber AND LUMISECTION>=:lsmin AND LUMISECTION<=:lsmax");
    coral::AttributeList lumisummaryOutput;
    lumisummaryOutput.extend("LUMISECTION", typeid(unsigned int));
    lumisummaryOutput.extend("INSTLUMI", typeid(float));
    lumisummaryOutput.extend("DELIVLUMISECTION", typeid(float));
    lumisummaryOutput.extend("LIVELUMISECTION", typeid(float));
    lumisummaryOutput.extend("CMS_ACTIVE", typeid(unsigned short));
    coral::IQuery* lumisummaryQuery = schema.newQuery();
    lumisummaryQuery->addToTableList(std::string("LUMI_SECTIONS"));
    lumisummaryQuery->addToOutputList("LUMISECTION");
    lumisummaryQuery->addToOutputList("INSTLUMI");
    lumisummaryQuery->addToOutputList("DELIVLUMISECTION");
    lumisummaryQuery->addToOutputList("LIVELUMISECTION");
    lumisummaryQuery->addToOutputList("CMS_ACTIVE");
    lumisummaryQuery->setCondition(conditionStr, lumisummaryBindVariables);
    lumisummaryQuery->defineOutput(lumisummaryOutput);
    coral::ICursor& lumisummarycursor = lumisummaryQuery->execute();
    while (lumisummarycursor.next()) {
      const coral::AttributeList& row = lumisummarycursor.currentRow();
      unsigned int lsnum = row["LUMISECTION"].data<unsigned int>();
      float instlumi = 0.0;
      if (!row["INSTLUMI"].isNull()) {
        instlumi = row["INSTLUMI"].data<float>();  //Hz/ub
      }
      float intgdellumi = 0.0;
      if (!row["DELIVLUMISECTION"].isNull()) {
        intgdellumi = row["DELIVLUMISECTION"].data<float>() * 1000.0;  //convert to /ub
      }
      float intgreclumi = 0.0;
      if (!row["LIVELUMISECTION"].isNull()) {
        intgreclumi = row["LIVELUMISECTION"].data<float>() * 1000.0;  //convert to /ub
      }
      unsigned short cmsalive = 0;
      if (!row["CMS_ACTIVE"].isNull()) {
        cmsalive = row["CMS_ACTIVE"].data<unsigned short>();
      }
      auto tmpls = std::make_unique<DIPLumiSummary>(instlumi, intgdellumi, intgreclumi, cmsalive);
      tmpls->setOrigin(m_summarycachedrun, lsnum);
      //std::cout<<"filling "<<lsnum<<std::endl;
      std::shared_ptr<const DIPLumiSummary> const_tmpls = std::move(tmpls);
      m_summarycache.insert(std::make_pair(lsnum, const_tmpls));
    }
    delete lumisummaryQuery;
    session->transaction().commit();
  } catch (const coral::Exception& er) {
    session->transaction().rollback();
    throw cms::Exception("DatabaseError ") << er.what();
  }
}
unsigned int DIPLumiProducer::maxavailableLSforRun(coral::ISchema& schema,
                                                   const std::string& tablename,
                                                   unsigned int runnumber) {
  unsigned int result = 0;
  coral::AttributeList bindVariables;
  bindVariables.extend("runnumber", typeid(unsigned int));
  bindVariables["runnumber"].data<unsigned int>() = runnumber;
  std::string conditionStr("RUNNUMBER=:runnumber");
  coral::AttributeList MyOutput;
  MyOutput.extend("maxavailablels", typeid(unsigned int));
  coral::IQuery* myQuery = schema.newQuery();
  myQuery->addToTableList(tablename);
  myQuery->addToOutputList("max(LUMISECTION)", "maxavailablels");
  myQuery->setCondition(conditionStr, bindVariables);
  myQuery->defineOutput(MyOutput);
  coral::ICursor& mycursor = myQuery->execute();
  while (mycursor.next()) {
    const coral::AttributeList& row = mycursor.currentRow();
    if (!row["maxavailablels"].isNull()) {
      result = row["maxavailablels"].data<unsigned int>();
    }
  }
  return result;
}
void DIPLumiProducer::filldetailcache(unsigned int runnumber, unsigned int currentlsnum) {
  m_detailcache.clear();
  m_detailcachedrun = runnumber;

  std::map<unsigned int, std::unique_ptr<DIPLumiDetail> > detailcache;
  //
  //queries once per cache refill
  //
  //select lumisection,bunch,bunchlumi from cms_runtime_logger.bunch_lumi_sections where lumisection>=:lsmin and lumisection<:lsmax and runnumber=:runnumber ;
  //
  edm::Service<lumi::service::DBService> mydbservice;
  if (!mydbservice.isAvailable()) {
    throw cms::Exception("Non existing service lumi::service::DBService");
  }
  auto session = mydbservice->connectReadOnly(m_connectStr);
  coral::ITypeConverter& tconverter = session->typeConverter();
  tconverter.setCppTypeForSqlType(std::string("float"), std::string("FLOAT(63)"));
  tconverter.setCppTypeForSqlType(std::string("unsigned int"), std::string("NUMBER(10)"));
  unsigned int lsmin = 1;
  unsigned int lsmax = currentlsnum;
  try {
    session->transaction().start(true);
    coral::ISchema& schema = session->nominalSchema();
    unsigned int maxavailableLS = maxavailableLSforRun(schema, std::string("BUNCH_LUMI_SECTIONS"), m_summarycachedrun);
    if (maxavailableLS != 0 && maxavailableLS < currentlsnum) {
      lsmax = maxavailableLS;
    } else if (maxavailableLS == 0) {
      //this run not existing (yet)
      session->transaction().commit();
      return;
    }
    if (m_cachesize != 0) {
      lsmin = (lsmax - m_cachesize) > 0 ? (lsmax - m_cachesize + 1) : 1;
    }
    coral::AttributeList lumidetailBindVariables;
    lumidetailBindVariables.extend("lsmin", typeid(unsigned int));
    lumidetailBindVariables.extend("lsmax", typeid(unsigned int));
    lumidetailBindVariables.extend("runnumber", typeid(unsigned int));
    lumidetailBindVariables["runnumber"].data<unsigned int>() = m_detailcachedrun;
    lumidetailBindVariables["lsmin"].data<unsigned int>() = lsmin;
    lumidetailBindVariables["lsmax"].data<unsigned int>() = lsmax;
    std::string conditionStr("RUNNUMBER=:runnumber AND LUMISECTION>=:lsmin AND LUMISECTION<=:lsmax AND BUNCHLUMI>0 ");
    coral::AttributeList lumidetailOutput;
    lumidetailOutput.extend("LUMISECTION", typeid(unsigned int));
    lumidetailOutput.extend("BUNCH", typeid(unsigned int));
    lumidetailOutput.extend("BUNCHLUMI", typeid(float));
    coral::IQuery* lumidetailQuery = schema.newQuery();
    lumidetailQuery->addToTableList(std::string("BUNCH_LUMI_SECTIONS"));
    lumidetailQuery->addToOutputList("LUMISECTION");
    lumidetailQuery->addToOutputList("BUNCH");
    lumidetailQuery->addToOutputList("BUNCHLUMI");
    lumidetailQuery->setCondition(conditionStr, lumidetailBindVariables);
    lumidetailQuery->defineOutput(lumidetailOutput);
    coral::ICursor& lumidetailcursor = lumidetailQuery->execute();
    while (lumidetailcursor.next()) {
      const coral::AttributeList& row = lumidetailcursor.currentRow();
      unsigned int lsnum = row["LUMISECTION"].data<unsigned int>();
      if (detailcache.find(lsnum) == detailcache.end()) {
        detailcache.insert(std::make_pair(lsnum, std::make_unique<DIPLumiDetail>()));
        detailcache[lsnum]->setOrigin(m_detailcachedrun, lsnum);
      }
      if (!row["BUNCH"].isNull()) {
        unsigned int bxidx = row["BUNCH"].data<unsigned int>();
        float bxlumi = 0.0;
        if (!row["BUNCHLUMI"].isNull()) {
          bxlumi = row["BUNCHLUMI"].data<float>();  //Hz/ub
        }
        detailcache[lsnum]->fillbxdata(bxidx, bxlumi);
      }
    }
    for (auto& item : detailcache) {
      m_detailcache[item.first] = std::move(item.second);
    }
    delete lumidetailQuery;
    session->transaction().commit();
  } catch (const coral::Exception& er) {
    session->transaction().rollback();
    throw cms::Exception("DatabaseError ") << er.what();
  }
}
DIPLumiProducer::~DIPLumiProducer() {}
//define this as a plug-in
DEFINE_FWK_EVENTSETUP_SOURCE(DIPLumiProducer);