edm::StreamerInputSource Class Reference

#include <StreamerInputSource.h>

Inheritance diagram for edm::StreamerInputSource:

Classes
class	EventPrincipalHolder

Public Member Functions
void	deserializeAndMergeWithRegistry (InitMsgView const &initView, bool subsequent=false)
void	deserializeEvent (EventMsgView const &eventView)
std::unique_ptr< SendJobHeader >	deserializeRegistry (InitMsgView const &initView)
bool	isBufferLZMA (unsigned char const *inputBuffer, unsigned int inputSize)
bool	isBufferZSTD (unsigned char const *inputBuffer, unsigned int inputSize)
	StreamerInputSource (ParameterSet const &pset, InputSourceDescription const &desc)
	~StreamerInputSource () override
Public Member Functions inherited from edm::RawInputSource
	RawInputSource (ParameterSet const &pset, InputSourceDescription const &desc)
	~RawInputSource () override
Public Member Functions inherited from edm::InputSource
std::shared_ptr< ActivityRegistry >	actReg () const
	Accessor for Activity Registry. More...
std::shared_ptr< BranchIDListHelper const >	branchIDListHelper () const
	Accessors for branchIDListHelper. More...
std::shared_ptr< BranchIDListHelper > &	branchIDListHelper ()
void	closeFile (FileBlock *, bool cleaningUpAfterException)
	close current file More...
void	doBeginJob ()
	Called by framework at beginning of job. More...
virtual void	doBeginLumi (LuminosityBlockPrincipal &lbp, ProcessContext const *)
	Called by framework at beginning of lumi block. More...
virtual void	doBeginRun (RunPrincipal &rp, ProcessContext const *)
	Called by framework at beginning of run. More...
void	doEndJob ()
	Called by framework at end of job. More...
void	fillProcessBlockHelper ()
	Fill the ProcessBlockHelper with info for the current file. More...
ProcessingController::ForwardState	forwardState () const
bool	goToEvent (EventID const &eventID)
	InputSource (ParameterSet const &, InputSourceDescription const &)
	Constructor. More...
	InputSource (InputSource const &)=delete
void	issueReports (EventID const &eventID, StreamID streamID)
	issue an event report More...
LuminosityBlockNumber_t	luminosityBlock () const
	Accessor for current luminosity block number. More...
std::shared_ptr< LuminosityBlockAuxiliary >	luminosityBlockAuxiliary () const
	Called by the framework to merge or insert lumi in principal cache. More...
int	maxEvents () const
int	maxLuminosityBlocks () const
ModuleDescription const &	moduleDescription () const
	Accessor for 'module' description. More...
ItemType	nextItemType ()
	Advances the source to the next item. More...
bool	nextProcessBlock (ProcessBlockPrincipal &)
	Next process block, return false if there is none, sets the processName in the principal. More...
InputSource &	operator= (InputSource const &)=delete
std::shared_ptr< ProcessBlockHelper const >	processBlockHelper () const
	Accessors for processBlockHelper. More...
std::shared_ptr< ProcessBlockHelper > &	processBlockHelper ()
ProcessConfiguration const &	processConfiguration () const
	Accessor for Process Configuration. More...
std::string const &	processGUID () const
	Accessor for global process identifier. More...
ProcessHistoryRegistry const &	processHistoryRegistry () const
	Accessors for process history registry. More...
ProcessHistoryRegistry &	processHistoryRegistry ()
ProcessingMode	processingMode () const
	RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...
std::shared_ptr< ProductRegistry const >	productRegistry () const
	Accessors for product registry. More...
std::shared_ptr< ProductRegistry > &	productRegistry ()
bool	randomAccess () const
void	readAndMergeLumi (LuminosityBlockPrincipal &lbp)
	Read next luminosity block (same as a prior lumi) More...
void	readAndMergeRun (RunPrincipal &rp)
	Read next run (same as a prior run) More...
void	readEvent (EventPrincipal &ep, StreamContext &)
	Read next event. More...
bool	readEvent (EventPrincipal &ep, EventID const &, StreamContext &)
	Read a specific event. More...
std::shared_ptr< FileBlock >	readFile ()
	Read next file. More...
void	readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
	Read next luminosity block (new lumi) More...
std::shared_ptr< LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary ()
	Read next luminosity block Auxilary. More...
void	readProcessBlock (ProcessBlockPrincipal &)
	Read next process block. More...
void	readRun (RunPrincipal &runPrincipal, HistoryAppender &historyAppender)
	Read next run (new run) More...
std::shared_ptr< RunAuxiliary >	readRunAuxiliary ()
	Read next run Auxiliary. More...
ProcessHistoryID const &	reducedProcessHistoryID () const
virtual void	registerProducts ()
	Register any produced products. More...
int	remainingEvents () const
int	remainingLuminosityBlocks () const
void	repeat ()
	Reset the remaining number of events/lumis to the maximum number. More...
std::pair< SharedResourcesAcquirer *, std::recursive_mutex * >	resourceSharedWithDelayedReader ()
	Returns nullptr if no resource shared between the Source and a DelayedReader. More...
ProcessingController::ReverseState	reverseState () const
void	rewind ()
	Begin again at the first event. More...
RunNumber_t	run () const
	Accessor for current run number. More...
std::shared_ptr< RunAuxiliary >	runAuxiliary () const
	Called by the framework to merge or insert run in principal cache. More...
void	setLuminosityBlockNumber_t (LuminosityBlockNumber_t lb)
	Set the luminosity block ID. More...
void	setRunNumber (RunNumber_t r)
	Set the run number. More...
void	skipEvents (int offset)
std::shared_ptr< ThinnedAssociationsHelper const >	thinnedAssociationsHelper () const
	Accessors for thinnedAssociationsHelper. More...
std::shared_ptr< ThinnedAssociationsHelper > &	thinnedAssociationsHelper ()
Timestamp const &	timestamp () const
	Accessor for the current time, as seen by the input source. More...
virtual	~InputSource () noexcept(false)
	Destructor. More...

Static Public Member Functions
static void	fillDescription (ParameterSetDescription &description)
static void	mergeIntoRegistry (SendJobHeader const &header, ProductRegistry &, BranchIDListHelper &, ThinnedAssociationsHelper &, bool subsequent)
static unsigned int	uncompressBuffer (unsigned char *inputBuffer, unsigned int inputSize, std::vector< unsigned char > &outputBuffer, unsigned int expectedFullSize)
static unsigned int	uncompressBufferLZMA (unsigned char *inputBuffer, unsigned int inputSize, std::vector< unsigned char > &outputBuffer, unsigned int expectedFullSize, bool hasHeader=true)
static unsigned int	uncompressBufferZSTD (unsigned char *inputBuffer, unsigned int inputSize, std::vector< unsigned char > &outputBuffer, unsigned int expectedFullSize, bool hasHeader=true)
Static Public Member Functions inherited from edm::RawInputSource
static void	fillDescription (ParameterSetDescription &description)
Static Public Member Functions inherited from edm::InputSource
static const std::string &	baseType ()
static void	fillDescription (ParameterSetDescription &desc)
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)

Protected Member Functions
void	resetAfterEndRun ()
Protected Member Functions inherited from edm::RawInputSource
virtual Next	checkNext ()=0
void	makeEvent (EventPrincipal &eventPrincipal, EventAuxiliary const &eventAuxiliary)
void	setInputFileTransitionsEachEvent ()
Protected Member Functions inherited from edm::InputSource
virtual void	beginJob ()
	Begin protected makes it easier to do template programming. More...
void	decreaseRemainingEventsBy (int iSkipped)
bool	eventCached () const
bool	newLumi () const
bool	newRun () const
ProcessHistoryRegistry &	processHistoryRegistryForUpdate ()
ProductRegistry &	productRegistryUpdate ()
void	reset () const
void	resetEventCached ()
void	resetLuminosityBlockAuxiliary (bool isNewLumi=true) const
void	resetNewLumi ()
void	resetNewRun ()
void	resetRunAuxiliary (bool isNewRun=true) const
void	setEventCached ()
	Called by the framework to merge or ached() const {return eventCached_;}. More...
void	setLuminosityBlockAuxiliary (LuminosityBlockAuxiliary *lbp)
void	setNewLumi ()
void	setNewRun ()
void	setRunAuxiliary (RunAuxiliary *rp)
void	setTimestamp (Timestamp const &theTime)
	To set the current time, as seen by the input source. More...
virtual void	skip (int offset)
ItemType	state () const

Static Protected Member Functions
static void	buildClassCache (SendDescs const &descs)
static void	declareStreamers (SendDescs const &descs)

Private Member Functions
void	read (EventPrincipal &eventPrincipal) override
void	setRun (RunNumber_t r) override

Private Attributes
bool	adjustEventToNewProductRegistry_
std::vector< unsigned char >	dest_
edm::propagate_const< std::unique_ptr< EventPrincipalHolder > >	eventPrincipalHolder_
std::string	processName_
unsigned int	protocolVersion_
edm::propagate_const< std::unique_ptr< SendEvent > >	sendEvent_
std::vector< edm::propagate_const< std::unique_ptr< EventPrincipalHolder > > >	streamToEventPrincipalHolders_
edm::propagate_const< TClass * >	tc_
TBufferFile	xbuf_

Additional Inherited Members
Public Types inherited from edm::RawInputSource
enum	Next { Next::kEvent, Next::kFile, Next::kStop }
Public Types inherited from edm::InputSource
enum	ItemType {   IsInvalid, IsStop, IsFile, IsRun,   IsLumi, IsEvent, IsRepeat, IsSynchronize }
enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }
Public Attributes inherited from edm::InputSource
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	postEventReadFromSourceSignal_
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	preEventReadFromSourceSignal_

Detailed Description

Definition at line 31 of file StreamerInputSource.h.

Constructor & Destructor Documentation

StreamerInputSource()

edm::StreamerInputSource::StreamerInputSource ( ParameterSet const &  pset, InputSourceDescription const &  desc  )

explicit

Definition at line 45 of file StreamerInputSource.cc.

      : RawInputSource(pset, desc),
        tc_(getTClass(typeid(SendEvent))),
        dest_(init_size),
        xbuf_(TBuffer::kRead, init_size),
        sendEvent_(),
        eventPrincipalHolder_(),
        adjustEventToNewProductRegistry_(false),
        processName_(),
        protocolVersion_(0U) {}

~StreamerInputSource()

edm::StreamerInputSource::~StreamerInputSource ( )

override

Definition at line 56 of file StreamerInputSource.cc.

{}

Member Function Documentation

buildClassCache()

void edm::StreamerInputSource::buildClassCache ( SendDescs const &  descs )

staticprotected

Definition at line 108 of file StreamerInputSource.cc.

References edm::doBuildRealData(), FDEBUG, B2GTnPMonitor_cfi::item, AlCaHLTBitMon_QueryRunRegistry::string, and edm::wrappedClassName().

Referenced by mergeIntoRegistry().

                                                                  {
    for (auto const& item : descs) {
      //pi->init();
      std::string const real_name = wrappedClassName(item.className());
      FDEBUG(6) << "BuildReadData: " << real_name << std::endl;
      doBuildRealData(real_name);
    }
  }

declareStreamers()

void edm::StreamerInputSource::declareStreamers ( SendDescs const &  descs )

staticprotected

Definition at line 89 of file StreamerInputSource.cc.

References visDQMUpload::context, FDEBUG, B2GTnPMonitor_cfi::item, edm::loadCap(), AlCaHLTBitMon_QueryRunRegistry::string, edm::throwMissingDictionariesException(), and edm::wrappedClassName().

Referenced by mergeIntoRegistry().

                                                                   {
    std::vector<std::string> missingDictionaries;
    std::vector<std::string> branchNamesForMissing;
    std::vector<std::string> producedTypes;
    for (auto const& item : descs) {
      //pi->init();
      std::string const real_name = wrappedClassName(item.className());
      FDEBUG(6) << "declare: " << real_name << std::endl;
      if (!loadCap(real_name, missingDictionaries)) {
        branchNamesForMissing.emplace_back(item.branchName());
        producedTypes.emplace_back(item.className() + std::string(" (read from input)"));
      }
    }
    if (!missingDictionaries.empty()) {
      std::string context("Calling StreamerInputSource::declareStreamers, checking dictionaries for input types");
      throwMissingDictionariesException(missingDictionaries, context, producedTypes, branchNamesForMissing, true);
    }
  }

deserializeAndMergeWithRegistry()

void edm::StreamerInputSource::deserializeAndMergeWithRegistry	(	InitMsgView const &	initView,
		bool	subsequent = false
	)

Deserializes the specified init message into a SendJobHeader object and merges registries.

Definition at line 167 of file StreamerInputSource.cc.

References adjustEventToNewProductRegistry_, edm::InputSource::branchIDListHelper(), deserializeRegistry(), edm::pset::Registry::insertMapped(), edm::pset::Registry::instance(), B2GTnPMonitor_cfi::item, mergeIntoRegistry(), edm::InputSource::productRegistryUpdate(), muonDTDigis_cfi::pset, and edm::InputSource::thinnedAssociationsHelper().

Referenced by edm::StreamerFileReader::genuineReadFile(), edm::StreamerInputModule< Producer >::genuineReadFile(), dqmservices::DQMStreamerReader::genuineReadFile(), dqmservices::DQMStreamerReader::openFileImp_(), edm::StreamerFileReader::reset_(), and edm::StreamerInputModule< Producer >::StreamerInputModule().

                                                                                                        {
    std::unique_ptr<SendJobHeader> sd = deserializeRegistry(initView);
    mergeIntoRegistry(*sd, productRegistryUpdate(), *branchIDListHelper(), *thinnedAssociationsHelper(), subsequent);
    if (subsequent) {
      adjustEventToNewProductRegistry_ = true;
    }
    SendJobHeader::ParameterSetMap const& psetMap = sd->processParameterSet();
    pset::Registry& psetRegistry = *pset::Registry::instance();
    for (auto const& item : psetMap) {
      ParameterSet pset(item.second.pset());
      pset.setID(item.first);
      psetRegistry.insertMapped(pset);
    }
  }

deserializeEvent()

void edm::StreamerInputSource::deserializeEvent

(

EventMsgView const &

eventView

)

Deserializes the specified event message.

Definition at line 185 of file StreamerInputSource.cc.

References cms::Adler32(), EventMsgView::adler32_chksum(), EventMsgView::code(), filterCSVwithJSON::copy, dest_, Header::EVENT, EventMsgView::event(), EventMsgView::eventData(), EventMsgView::eventLength(), eventPrincipalHolder_, Exception, FDEBUG, EventMsgView::hostName(), edm::Timestamp::invalidTimestamp(), isBufferLZMA(), isBufferZSTD(), EventMsgView::lumi(), edm::InputSource::luminosityBlock(), edm::InputSource::luminosityBlockAuxiliary(), EventMsgView::origDataSize(), edm::InputSource::processHistoryRegistryForUpdate(), edm::ProcessHistoryRegistry::registerProcessHistory(), edm::InputSource::resetLuminosityBlockAuxiliary(), EventMsgView::run(), edm::InputSource::run(), edm::InputSource::runAuxiliary(), sendEvent_, edm::InputSource::setEventCached(), edm::InputSource::setLuminosityBlockAuxiliary(), edm::setRefCoreStreamer(), edm::InputSource::setRunAuxiliary(), EventMsgView::size(), tc_, uncompressBuffer(), uncompressBufferLZMA(), uncompressBufferZSTD(), and xbuf_.

Referenced by edm::StreamerFileReader::checkNext(), and dqmservices::DQMStreamerReader::checkNext().

                                                                          {
    if (eventView.code() != Header::EVENT)
      throw cms::Exception("StreamTranslation", "Event deserialization error")
          << "received wrong message type: expected EVENT, got " << eventView.code() << "\n";
    FDEBUG(9) << "Decode event: " << eventView.event() << " " << eventView.run() << " " << eventView.size() << " "
              << eventView.adler32_chksum() << " " << eventView.eventLength() << " " << eventView.eventData()
              << std::endl;
    // uncompress if we need to
    // 78 was a dummy value (for no uncompressed) - should be 0 for uncompressed
    // need to get rid of this when 090 MTCC streamers are gotten rid of
    unsigned long origsize = eventView.origDataSize();
    unsigned long dest_size;  //(should be >= eventView.origDataSize())

    uint32_t adler32_chksum = cms::Adler32((char const*)eventView.eventData(), eventView.eventLength());
    //std::cout << "Adler32 checksum of event = " << adler32_chksum << std::endl;
    //std::cout << "Adler32 checksum from header = " << eventView.adler32_chksum() << " "
    //          << "host name = " << eventView.hostName() << " len = " << eventView.hostName_len() << std::endl;
    if ((uint32)adler32_chksum != eventView.adler32_chksum()) {
      // skip event (based on option?) or throw exception?
      throw cms::Exception("StreamDeserialization", "Checksum error")
          << " chksum from event = " << adler32_chksum << " from header = " << eventView.adler32_chksum()
          << " host name = " << eventView.hostName() << std::endl;
    }
    if (origsize != 78 && origsize != 0) {
      // compressed
      if (isBufferLZMA((unsigned char const*)eventView.eventData(), eventView.eventLength())) {
        dest_size = uncompressBufferLZMA(const_cast<unsigned char*>((unsigned char const*)eventView.eventData()),
                                         eventView.eventLength(),
                                         dest_,
                                         origsize);
      } else if (isBufferZSTD((unsigned char const*)eventView.eventData(), eventView.eventLength())) {
        dest_size = uncompressBufferZSTD(const_cast<unsigned char*>((unsigned char const*)eventView.eventData()),
                                         eventView.eventLength(),
                                         dest_,
                                         origsize);
      } else
        dest_size = uncompressBuffer(const_cast<unsigned char*>((unsigned char const*)eventView.eventData()),
                                     eventView.eventLength(),
                                     dest_,
                                     origsize);
    } else {  // not compressed
      // we need to copy anyway the buffer as we are using dest in xbuf
      dest_size = eventView.eventLength();
      dest_.resize(dest_size);
      unsigned char* pos = (unsigned char*)&dest_[0];
      unsigned char const* from = (unsigned char const*)eventView.eventData();
      std::copy(from, from + dest_size, pos);
    }
    //TBuffer xbuf(TBuffer::kRead, dest_size,
    //             (char const*) &dest[0],kFALSE);
    //TBuffer xbuf(TBuffer::kRead, eventView.eventLength(),
    //             (char const*) eventView.eventData(),kFALSE);
    xbuf_.Reset();
    xbuf_.SetBuffer(&dest_[0], dest_size, kFALSE);
    RootDebug tracer(10, 10);

    //We do not yet know which EventPrincipal we will use, therefore
    // we are using a new EventPrincipalHolder as a proxy. We need to
    // make a new one instead of reusing the same one becuase when running
    // multi-threaded there will be multiple EventPrincipals being used
    // simultaneously.
    eventPrincipalHolder_ = std::make_unique<EventPrincipalHolder>();  // propagate_const<T> has no reset() function
    setRefCoreStreamer(eventPrincipalHolder_.get());
    {
      std::shared_ptr<void> refCoreStreamerGuard(nullptr, [](void*) {
        setRefCoreStreamer();
        ;
      });
      sendEvent_ = std::unique_ptr<SendEvent>((SendEvent*)xbuf_.ReadObjectAny(tc_));
    }

    if (sendEvent_.get() == nullptr) {
      throw cms::Exception("StreamTranslation", "Event deserialization error")
          << "got a null event from input stream\n";
    }
    processHistoryRegistryForUpdate().registerProcessHistory(sendEvent_->processHistory());

    FDEBUG(5) << "Got event: " << sendEvent_->aux().id() << " " << sendEvent_->products().size() << std::endl;
    if (runAuxiliary().get() == nullptr || runAuxiliary()->run() != sendEvent_->aux().run() ||
        runAuxiliary()->processHistoryID() != sendEvent_->processHistory().id()) {
      RunAuxiliary* runAuxiliary =
          new RunAuxiliary(sendEvent_->aux().run(), sendEvent_->aux().time(), Timestamp::invalidTimestamp());
      runAuxiliary->setProcessHistoryID(sendEvent_->processHistory().id());
      setRunAuxiliary(runAuxiliary);
      resetLuminosityBlockAuxiliary();
    }
    if (!luminosityBlockAuxiliary() || luminosityBlockAuxiliary()->luminosityBlock() != eventView.lumi()) {
      LuminosityBlockAuxiliary* luminosityBlockAuxiliary = new LuminosityBlockAuxiliary(
          runAuxiliary()->run(), eventView.lumi(), sendEvent_->aux().time(), Timestamp::invalidTimestamp());
      luminosityBlockAuxiliary->setProcessHistoryID(sendEvent_->processHistory().id());
      setLuminosityBlockAuxiliary(luminosityBlockAuxiliary);
    }
    setEventCached();
  }

deserializeRegistry()

std::unique_ptr< SendJobHeader > edm::StreamerInputSource::deserializeRegistry

(

InitMsgView const &

initView

)

Deserializes the specified init message into a SendJobHeader object (which is related to the product registry).

Definition at line 121 of file StreamerInputSource.cc.

References cms::Adler32(), InitMsgView::adler32_chksum(), InitMsgView::code(), submitPVResolutionJobs::desc, InitMsgView::descData(), InitMsgView::descLength(), Exception, FDEBUG, edm::getTClass(), InitMsgView::hostName(), Header::INIT, InitMsgView::processName(), processName_, InitMsgView::protocolVersion(), and protocolVersion_.

Referenced by deserializeAndMergeWithRegistry().

                                                                                                   {
    if (initView.code() != Header::INIT)
      throw cms::Exception("StreamTranslation", "Registry deserialization error")
          << "received wrong message type: expected INIT, got " << initView.code() << "\n";

    //Get the process name and store if for Protocol version 4 and above.
    if (initView.protocolVersion() > 3) {
      processName_ = initView.processName();
      protocolVersion_ = initView.protocolVersion();

      FDEBUG(10) << "StreamerInputSource::deserializeRegistry processName = " << processName_ << std::endl;
      FDEBUG(10) << "StreamerInputSource::deserializeRegistry protocolVersion_= " << protocolVersion_ << std::endl;
    }

    // calculate the adler32 checksum
    uint32_t adler32_chksum = cms::Adler32((char const*)initView.descData(), initView.descLength());
    //std::cout << "Adler32 checksum of init message = " << adler32_chksum << std::endl;
    //std::cout << "Adler32 checksum of init messsage from header = " << initView.adler32_chksum() << " "
    //          << "host name = " << initView.hostName() << " len = " << initView.hostName_len() << std::endl;
    if ((uint32)adler32_chksum != initView.adler32_chksum()) {
      // skip event (based on option?) or throw exception?
      throw cms::Exception("StreamDeserialization", "Checksum error")
          << " chksum from registry data = " << adler32_chksum << " from header = " << initView.adler32_chksum()
          << " host name = " << initView.hostName() << std::endl;
    }

    TClass* desc = getTClass(typeid(SendJobHeader));

    TBufferFile xbuf(
        TBuffer::kRead, initView.descLength(), const_cast<char*>((char const*)initView.descData()), kFALSE);
    RootDebug tracer(10, 10);
    std::unique_ptr<SendJobHeader> sd((SendJobHeader*)xbuf.ReadObjectAny(desc));

    if (sd.get() == nullptr) {
      throw cms::Exception("StreamTranslation", "Registry deserialization error")
          << "Could not read the initial product registry list\n";
    }

    sd->initializeTransients();
    return sd;
  }

fillDescription()

void edm::StreamerInputSource::fillDescription ( ParameterSetDescription &  description )

static

Definition at line 513 of file StreamerInputSource.cc.

References submitPVResolutionJobs::desc, and edm::RawInputSource::fillDescription().

Referenced by edm::StreamerFileReader::fillDescriptions(), and dqmservices::DQMStreamerReader::fillDescriptions().

{ RawInputSource::fillDescription(desc); }

isBufferLZMA()

bool edm::StreamerInputSource::isBufferLZMA	(	unsigned char const *	inputBuffer,
		unsigned int	inputSize
	)

Detect if buffer starts with "XZ\0" which means it is compressed in LZMA format

Definition at line 379 of file StreamerInputSource.cc.

Referenced by deserializeEvent().

                                                                                                 {
    if (inputSize >= 4 && !strcmp((const char*)inputBuffer, "XZ"))
      return true;
    else
      return false;
  }

isBufferZSTD()

bool edm::StreamerInputSource::isBufferZSTD	(	unsigned char const *	inputBuffer,
		unsigned int	inputSize
	)

Detect if buffer starts with "Z\0" which means it is compressed in ZStandard format

Definition at line 431 of file StreamerInputSource.cc.

Referenced by deserializeEvent().

                                                                                                 {
    if (inputSize >= 4 && !strcmp((const char*)inputBuffer, "ZS"))
      return true;
    else
      return false;
  }

mergeIntoRegistry()

void edm::StreamerInputSource::mergeIntoRegistry ( SendJobHeader const &  header, ProductRegistry &  reg, BranchIDListHelper &  branchIDListHelper, ThinnedAssociationsHelper &  thinnedHelper, bool  subsequent  )

static

Definition at line 59 of file StreamerInputSource.cc.

References edm::InputSource::branchIDListHelper(), buildClassCache(), declareStreamers(), Exception, FDEBUG, edm::ProductRegistry::frozen(), RecoTauValidation_cfi::header, edm::loadExtraClasses(), edm::ProductRegistry::merge(), edm::BranchDescription::Permissive, AlCaHLTBitMon_QueryRunRegistry::string, edm::ProductRegistry::updateFromInput(), and edm::ThinnedAssociationsHelper::updateFromPrimaryInput().

Referenced by deserializeAndMergeWithRegistry().

                                                               {
    SendDescs const& descs = header.descs();

    FDEBUG(6) << "mergeIntoRegistry: Product List: " << std::endl;

    if (subsequent) {
      ProductRegistry pReg;
      pReg.updateFromInput(descs);
      std::string mergeInfo = reg.merge(pReg, std::string(), BranchDescription::Permissive);
      if (!mergeInfo.empty()) {
        throw cms::Exception("MismatchedInput", "RootInputFileSequence::previousEvent()") << mergeInfo;
      }
      branchIDListHelper.updateFromInput(header.branchIDLists());
      thinnedHelper.updateFromPrimaryInput(header.thinnedAssociationsHelper());
    } else {
      declareStreamers(descs);
      buildClassCache(descs);
      loadExtraClasses();
      if (!reg.frozen()) {
        reg.updateFromInput(descs);
      }
      branchIDListHelper.updateFromInput(header.branchIDLists());
      thinnedHelper.updateFromPrimaryInput(header.thinnedAssociationsHelper());
    }
  }

read()

void edm::StreamerInputSource::read ( EventPrincipal &  eventPrincipal )

overrideprivatevirtual

Implements edm::RawInputSource.

Definition at line 280 of file StreamerInputSource.cc.

References adjustEventToNewProductRegistry_, edm::Principal::adjustIndexesAfterProductRegistryAddition(), edm::Principal::adjustToNewProductRegistry(), cms::cuda::assert(), edm::BranchDescription::branchID(), edm::InputSource::branchIDListHelper(), eventPrincipalHolder_, FDEBUG, edm::EventPrincipal::fillEventPrincipal(), edm::ProcessHistoryRegistry::getMapped(), eostools::move(), edm::InputSource::processHistoryRegistry(), edm::InputSource::productRegistry(), edm::EventPrincipal::putOnRead(), sendEvent_, edm::Principal::size(), edm::EventPrincipal::streamID(), streamToEventPrincipalHolders_, and edm::StreamID::value().

Referenced by edmIntegrityCheck.PublishToFileSystem::get().

                                                               {
    if (adjustEventToNewProductRegistry_) {
      eventPrincipal.adjustIndexesAfterProductRegistryAddition();
      bool eventOK = eventPrincipal.adjustToNewProductRegistry(*productRegistry());
      assert(eventOK);
      adjustEventToNewProductRegistry_ = false;
    }
    EventSelectionIDVector ids(sendEvent_->eventSelectionIDs());
    BranchListIndexes indexes(sendEvent_->branchListIndexes());
    branchIDListHelper()->fixBranchListIndexes(indexes);
    auto history = processHistoryRegistry().getMapped(sendEvent_->aux().processHistoryID());
    eventPrincipal.fillEventPrincipal(sendEvent_->aux(), history, std::move(ids), std::move(indexes));

    //We now know which eventPrincipal to use and we can reuse the slot in
    // streamToEventPrincipalHolders to own the memory
    eventPrincipalHolder_->setEventPrincipal(&eventPrincipal);
    if (streamToEventPrincipalHolders_.size() < eventPrincipal.streamID().value() + 1) {
      streamToEventPrincipalHolders_.resize(eventPrincipal.streamID().value() + 1);
    }
    streamToEventPrincipalHolders_[eventPrincipal.streamID().value()] = std::move(eventPrincipalHolder_);

    // no process name list handling

    SendProds& sps = sendEvent_->products();
    for (auto& spitem : sps) {
      FDEBUG(10) << "check prodpair" << std::endl;
      if (spitem.desc() == nullptr)
        throw cms::Exception("StreamTranslation", "Empty Provenance");
      FDEBUG(5) << "Prov:"
                << " " << spitem.desc()->className() << " " << spitem.desc()->productInstanceName() << " "
                << spitem.desc()->branchID() << std::endl;

      BranchDescription const branchDesc(*spitem.desc());
      // This ProductProvenance constructor inserts into the entry description registry
      if (spitem.parents()) {
        std::optional<ProductProvenance> productProvenance{std::in_place, spitem.branchID(), *spitem.parents()};
        if (spitem.prod() != nullptr) {
          FDEBUG(10) << "addproduct next " << spitem.branchID() << std::endl;
          eventPrincipal.putOnRead(branchDesc,
                                   std::unique_ptr<WrapperBase>(const_cast<WrapperBase*>(spitem.prod())),
                                   std::move(productProvenance));
          FDEBUG(10) << "addproduct done" << std::endl;
        } else {
          FDEBUG(10) << "addproduct empty next " << spitem.branchID() << std::endl;
          eventPrincipal.putOnRead(branchDesc, std::unique_ptr<WrapperBase>(), std::move(productProvenance));
          FDEBUG(10) << "addproduct empty done" << std::endl;
        }
      } else {
        std::optional<ProductProvenance> productProvenance;
        if (spitem.prod() != nullptr) {
          FDEBUG(10) << "addproduct next " << spitem.branchID() << std::endl;
          eventPrincipal.putOnRead(
              branchDesc, std::unique_ptr<WrapperBase>(const_cast<WrapperBase*>(spitem.prod())), productProvenance);
          FDEBUG(10) << "addproduct done" << std::endl;
        } else {
          FDEBUG(10) << "addproduct empty next " << spitem.branchID() << std::endl;
          eventPrincipal.putOnRead(branchDesc, std::unique_ptr<WrapperBase>(), productProvenance);
          FDEBUG(10) << "addproduct empty done" << std::endl;
        }
      }
      spitem.clear();
    }

    FDEBUG(10) << "Size = " << eventPrincipal.size() << std::endl;
  }

resetAfterEndRun()

void edm::StreamerInputSource::resetAfterEndRun ( )

protected

Definition at line 458 of file StreamerInputSource.cc.

References cms::cuda::assert(), edm::InputSource::eventCached(), edm::InputSource::reset(), edm::InputSource::resetLuminosityBlockAuxiliary(), and edm::InputSource::resetRunAuxiliary().

                                             {
    // called from an online streamer source to reset after a stop command
    // so an enable command will work
    resetLuminosityBlockAuxiliary();
    resetRunAuxiliary();
    assert(!eventCached());
    reset();
  }

setRun()

void edm::StreamerInputSource::setRun ( RunNumber_t  r )

overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 467 of file StreamerInputSource.cc.

References Exception, and edm::errors::LogicError.

                                              {
    // Need to define a dummy setRun here or else the InputSource::setRun is called
    // if we have a source inheriting from this and wants to define a setRun method
    throw Exception(errors::LogicError) << "StreamerInputSource::setRun()\n"
                                        << "Run number cannot be modified for this type of Input Source\n"
                                        << "Contact a Storage Manager Developer\n";
  }

uncompressBuffer()

unsigned int edm::StreamerInputSource::uncompressBuffer ( unsigned char *  inputBuffer, unsigned int  inputSize, std::vector< unsigned char > &  outputBuffer, unsigned int  expectedFullSize  )

static

Uncompresses the data in the specified input buffer into the specified output buffer. The inputSize should be set to the size of the compressed data in the inputBuffer. The expectedFullSize should be set to the original size of the data (before compression). Returns the actual size of the uncompressed data. Errors are reported by throwing exceptions.

Definition at line 354 of file StreamerInputSource.cc.

References Exception, FDEBUG, and runTheMatrix::ret.

Referenced by deserializeEvent().

                                                                                    {
    unsigned long origSize = expectedFullSize;
    unsigned long uncompressedSize = expectedFullSize * 1.1;
    FDEBUG(1) << "Uncompress: original size = " << origSize << ", compressed size = " << inputSize << std::endl;
    outputBuffer.resize(uncompressedSize);
    int ret = uncompress(&outputBuffer[0], &uncompressedSize, inputBuffer, inputSize);  // do not need compression level
    //std::cout << "unCompress Return value: " << ret << " Okay = " << Z_OK << std::endl;
    if (ret == Z_OK) {
      // check the length against original uncompressed length
      FDEBUG(10) << " original size = " << origSize << " final size = " << uncompressedSize << std::endl;
      if (origSize != uncompressedSize) {
        // we throw an error and return without event! null pointer
        throw cms::Exception("StreamDeserialization", "Uncompression error")
            << "mismatch event lengths should be" << origSize << " got " << uncompressedSize << "\n";
      }
    } else {
      // we throw an error and return without event! null pointer
      throw cms::Exception("StreamDeserialization", "Uncompression error") << "Error code = " << ret << "\n ";
    }
    return (unsigned int)uncompressedSize;
  }

uncompressBufferLZMA()

unsigned int edm::StreamerInputSource::uncompressBufferLZMA ( unsigned char *  inputBuffer, unsigned int  inputSize, std::vector< unsigned char > &  outputBuffer, unsigned int  expectedFullSize, bool  hasHeader = true  )

static

Definition at line 386 of file StreamerInputSource.cc.

References Exception, FDEBUG, createfilelist::int, cms::cuda::stream, and mitigatedMETSequence_cff::U.

Referenced by deserializeEvent().

                                                                         {
    unsigned long origSize = expectedFullSize;
    unsigned long uncompressedSize = expectedFullSize * 1.1;
    FDEBUG(1) << "Uncompress: original size = " << origSize << ", compressed size = " << inputSize << std::endl;
    outputBuffer.resize(uncompressedSize);

    lzma_stream stream = LZMA_STREAM_INIT;
    lzma_ret returnStatus;

    returnStatus = lzma_stream_decoder(&stream, UINT64_MAX, 0U);
    if (returnStatus != LZMA_OK) {
      throw cms::Exception("StreamDeserializationLZM", "LZMA stream decoder error")
          << "Error code = " << returnStatus << "\n ";
    }

    size_t hdrSize = hasHeader ? 4 : 0;
    stream.next_in = (const uint8_t*)(inputBuffer + hdrSize);
    stream.avail_in = (size_t)(inputSize - hdrSize);
    stream.next_out = (uint8_t*)&outputBuffer[0];
    stream.avail_out = (size_t)uncompressedSize;

    returnStatus = lzma_code(&stream, LZMA_FINISH);
    if (returnStatus != LZMA_STREAM_END) {
      lzma_end(&stream);
      throw cms::Exception("StreamDeserializationLZM", "LZMA uncompression error")
          << "Error code = " << returnStatus << "\n ";
    }
    lzma_end(&stream);

    uncompressedSize = (unsigned int)stream.total_out;

    FDEBUG(10) << " original size = " << origSize << " final size = " << uncompressedSize << std::endl;
    if (origSize != uncompressedSize) {
      // we throw an error and return without event! null pointer
      throw cms::Exception("StreamDeserialization", "LZMA uncompression error")
          << "mismatch event lengths should be" << origSize << " got " << uncompressedSize << "\n";
    }

    return uncompressedSize;
  }

uncompressBufferZSTD()

unsigned int edm::StreamerInputSource::uncompressBufferZSTD ( unsigned char *  inputBuffer, unsigned int  inputSize, std::vector< unsigned char > &  outputBuffer, unsigned int  expectedFullSize, bool  hasHeader = true  )

static

Definition at line 438 of file StreamerInputSource.cc.

References Exception, FDEBUG, and runTheMatrix::ret.

Referenced by deserializeEvent().

                                                                         {
    unsigned long uncompressedSize = expectedFullSize * 1.1;
    FDEBUG(1) << "Uncompress: original size = " << expectedFullSize << ", compressed size = " << inputSize << std::endl;
    outputBuffer.resize(uncompressedSize);

    size_t hdrSize = hasHeader ? 4 : 0;
    size_t ret = ZSTD_decompress(
        (void*)&(outputBuffer[0]), uncompressedSize, (const void*)(inputBuffer + hdrSize), inputSize - hdrSize);

    if (ZSTD_isError(ret)) {
      throw cms::Exception("StreamDeserializationZSTD", "ZSTD uncompression error")
          << "Error core " << ret << ", message:" << ZSTD_getErrorName(ret);
    }
    return (unsigned int)ret;
  }

Member Data Documentation

adjustEventToNewProductRegistry_

bool edm::StreamerInputSource::adjustEventToNewProductRegistry_

private

Definition at line 122 of file StreamerInputSource.h.

Referenced by deserializeAndMergeWithRegistry(), and read().

dest_

std::vector<unsigned char> edm::StreamerInputSource::dest_

private

Definition at line 117 of file StreamerInputSource.h.

Referenced by deserializeEvent().

eventPrincipalHolder_

edm::propagate_const<std::unique_ptr<EventPrincipalHolder> > edm::StreamerInputSource::eventPrincipalHolder_

private

Definition at line 120 of file StreamerInputSource.h.

Referenced by deserializeEvent(), and read().

processName_

std::string edm::StreamerInputSource::processName_

private

Definition at line 124 of file StreamerInputSource.h.

Referenced by deserializeRegistry().

protocolVersion_

unsigned int edm::StreamerInputSource::protocolVersion_

private

Definition at line 125 of file StreamerInputSource.h.

Referenced by deserializeRegistry().

sendEvent_

edm::propagate_const<std::unique_ptr<SendEvent> > edm::StreamerInputSource::sendEvent_

private

Definition at line 119 of file StreamerInputSource.h.

Referenced by deserializeEvent(), and read().

streamToEventPrincipalHolders_

std::vector<edm::propagate_const<std::unique_ptr<EventPrincipalHolder> > > edm::StreamerInputSource::streamToEventPrincipalHolders_

private

Definition at line 121 of file StreamerInputSource.h.

Referenced by read().

tc_

edm::propagate_const<TClass*> edm::StreamerInputSource::tc_

private

Definition at line 116 of file StreamerInputSource.h.

Referenced by deserializeEvent().

xbuf_

TBufferFile edm::StreamerInputSource::xbuf_

private

Definition at line 118 of file StreamerInputSource.h.

Referenced by deserializeEvent().