#include <StreamerOutputModuleBase.h>

Inheritance diagram for edm::StreamerOutputModuleBase:

Public Member Functions
	StreamerOutputModuleBase (ParameterSet const &ps)

	~StreamerOutputModuleBase () override

Public Member Functions inherited from edm::one::OutputModule< one::WatchRuns, one::WatchLuminosityBlocks >
	OutputModule (edm::ParameterSet const &iPSet)

Public Member Functions inherited from edm::one::OutputModuleBase
BranchIDLists const *	branchIDLists ()

std::array< bool, NumBranchTypes > const &	hasNewlyDroppedBranch () const

SelectedProductsForBranchType const &	keptProducts () const

int	maxEvents () const

const ModuleDescription &	moduleDescription () const

OutputModuleBase &	operator= (OutputModuleBase const &)=delete

	OutputModuleBase (ParameterSet const &pset)

	OutputModuleBase (OutputModuleBase const &)=delete

std::string const &	processName () const

int	remainingEvents () const

bool	selected (BranchDescription const &desc) const

void	selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &)

SubProcessParentageHelper const *	subProcessParentageHelper () const

ThinnedAssociationsHelper const *	thinnedAssociationsHelper () const

bool	wantAllEvents () const

	~OutputModuleBase () 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 const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

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::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescription (ParameterSetDescription &desc)

Static Public Member Functions inherited from edm::one::OutputModuleBase
static const std::string &	baseType ()

static void	fillDescription (ParameterSetDescription &desc)

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Private Member Functions
void	beginJob () override

void	beginRun (RunForOutput const &) override

virtual void	doOutputEvent (EventMsgBuilder const &msg)=0

virtual void	doOutputHeader (InitMsgBuilder const &init_message)=0

void	endJob () override

void	endRun (RunForOutput const &) override

Trig	getTriggerResults (EDGetTokenT< TriggerResults > const &token, EventForOutput const &e) const

std::unique_ptr< EventMsgBuilder >	serializeEvent (EventForOutput const &e)

std::unique_ptr< InitMsgBuilder >	serializeRegistry ()

void	setHltMask (EventForOutput const &e)

void	setLumiSection ()

virtual void	start ()=0

virtual void	stop ()=0

void	write (EventForOutput const &e) override

void	writeLuminosityBlock (LuminosityBlockForOutput const &) override

void	writeRun (RunForOutput const &) override

Private Attributes
int	compressionLevel_

std::vector< unsigned char >	hltbits_

unsigned int	hltsize_

Strings	hltTriggerSelections_

char	host_name_ [255]

std::vector< bool >	l1bit_

uint32	lumi_

int	lumiSectionInterval_

int	maxEventSize_

uint32	origSize_

uint32	outputModuleId_

SelectedProducts const *	selections_

SerializeDataBuffer	serializeDataBuffer_

StreamSerializer	serializer_

double	timeInSecSinceUTC

edm::EDGetTokenT< edm::TriggerResults >	trToken_

bool	useCompression_

Additional Inherited Members
Public Types inherited from edm::one::OutputModuleBase
typedef OutputModuleBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::one::OutputModuleBase
void	configure (OutputModuleDescription const &desc)

ModuleDescription const &	description () const

void	doBeginJob ()

bool	doBeginLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetup const &c, ModuleCallingContext const *)

bool	doBeginRun (RunPrincipal const &rp, EventSetup const &c, ModuleCallingContext const *)

void	doEndJob ()

bool	doEndLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetup const &c, ModuleCallingContext const *)

bool	doEndRun (RunPrincipal const &rp, EventSetup const &c, ModuleCallingContext const *)

bool	doEvent (EventPrincipal const &ep, EventSetup const &c, ActivityRegistry , ModuleCallingContext const )

void	doPreallocate (PreallocationConfiguration const &)

std::map< BranchID::value_type, BranchID::value_type > const &	droppedBranchIDToKeptBranchID ()

ParameterSetID	selectorConfig () const

void	setEventSelectionInfo (std::map< std::string, std::vector< std::pair< std::string, int > > > const &outputModulePathPositions, bool anyProductProduced)

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

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 ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Detailed Description

Definition at line 18 of file StreamerOutputModuleBase.h.

Constructor & Destructor Documentation

edm::StreamerOutputModuleBase::StreamerOutputModuleBase ( ParameterSet const & ps )

explicit

Definition at line 57 of file StreamerOutputModuleBase.cc.

References SerializeDataBuffer::bufs_, compressionLevel_, FDEBUG, edm::EventSelector::getEventSelectionVString(), hltTriggerSelections_, host_name_, maxEventSize_, serializeDataBuffer_, timeInSecSinceUTC, and useCompression_.

                                                                            :
     one::OutputModuleBase::OutputModuleBase(ps),
     one::OutputModule<one::WatchRuns, one::WatchLuminosityBlocks>(ps),
     selections_(&keptProducts()[InEvent]),
     maxEventSize_(ps.getUntrackedParameter<int>("max_event_size")),
     useCompression_(ps.getUntrackedParameter<bool>("use_compression")),
     compressionLevel_(ps.getUntrackedParameter<int>("compression_level")),
     lumiSectionInterval_(ps.getUntrackedParameter<int>("lumiSection_interval")),
     serializer_(selections_),
     serializeDataBuffer_(),
     hltsize_(0),
     lumi_(0),
     l1bit_(0),
     hltbits_(0),
     origSize_(0),
     host_name_(),
     trToken_(consumes<edm::TriggerResults>(edm::InputTag("TriggerResults"))),
     hltTriggerSelections_(),
     outputModuleId_(0) {
     // no compression as default value - we need this!
 
     // test luminosity sections
     struct timeval now;
     struct timezone dummyTZ;
     gettimeofday(&now, &dummyTZ);
     timeInSecSinceUTC = static_cast<double>(now.tv_sec) + (static_cast<double>(now.tv_usec)/1000000.0);
 
     if(useCompression_ == true) {
       if(compressionLevel_ <= 0) {
         FDEBUG(9) << "Compression Level = " << compressionLevel_
                   << " no compression" << std::endl;
         compressionLevel_ = 0;
         useCompression_ = false;
       } else if(compressionLevel_ > 9) {
         FDEBUG(9) << "Compression Level = " << compressionLevel_
                   << " using max compression level 9" << std::endl;
         compressionLevel_ = 9;
       }
     }
     serializeDataBuffer_.bufs_.resize(maxEventSize_);
     int got_host = gethostname(host_name_, 255);
     if(got_host != 0) strncpy(host_name_, "noHostNameFoundOrTooLong", sizeof(host_name_));
     //loadExtraClasses();
 
     // 25-Jan-2008, KAB - pull out the trigger selection request
     // which we need for the INIT message
     hltTriggerSelections_ = EventSelector::getEventSelectionVString(ps);
   }

edm::StreamerOutputModuleBase::~StreamerOutputModuleBase ( )

override

Definition at line 106 of file StreamerOutputModuleBase.cc.

106 {}

Member Function Documentation

void edm::StreamerOutputModuleBase::beginJob ( void )

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 123 of file StreamerOutputModuleBase.cc.

123 {}

void edm::StreamerOutputModuleBase::beginRun ( RunForOutput const & )

overrideprivate

Definition at line 109 of file StreamerOutputModuleBase.cc.

References doOutputHeader(), SerializeDataBuffer::header_buf_, serializeDataBuffer_, serializeRegistry(), and start().

                                                         {
     start();
     std::unique_ptr<InitMsgBuilder>  init_message = serializeRegistry();
     doOutputHeader(*init_message);
     serializeDataBuffer_.header_buf_.clear();
     serializeDataBuffer_.header_buf_.shrink_to_fit();
   }

virtual void edm::StreamerOutputModuleBase::doOutputEvent ( EventMsgBuilder const & msg )

privatepure virtual

Implemented in evf::RecoEventOutputModuleForFU< Consumer >, and edm::StreamerOutputModule< Consumer >.

Referenced by write().

virtual void edm::StreamerOutputModuleBase::doOutputHeader ( InitMsgBuilder const & init_message )

privatepure virtual

Implemented in evf::RecoEventOutputModuleForFU< Consumer >, and edm::StreamerOutputModule< Consumer >.

Referenced by beginRun().

void edm::StreamerOutputModuleBase::endJob ( void )

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 126 of file StreamerOutputModuleBase.cc.

References stop().

                                    {
     stop();  // for closing of files, notify storage manager, etc.
   }

void edm::StreamerOutputModuleBase::endRun ( RunForOutput const & )

overrideprivate

Definition at line 118 of file StreamerOutputModuleBase.cc.

References stop().

                                                       {
     stop();
   }

void edm::StreamerOutputModuleBase::fillDescription ( ParameterSetDescription & desc )

static

Definition at line 301 of file StreamerOutputModuleBase.cc.

References edm::ParameterSetDescription::addUntracked(), and edm::OutputModule::fillDescription().

Referenced by edm::StreamerOutputModule< Consumer >::fillDescriptions(), and evf::RecoEventOutputModuleForFU< Consumer >::fillDescriptions().

                                                                          {
     desc.addUntracked<int>("max_event_size", 7000000)
         ->setComment("Starting size in bytes of the serialized event buffer.");
     desc.addUntracked<bool>("use_compression", true)
         ->setComment("If True, compression will be used to write streamer file.");
     desc.addUntracked<int>("compression_level", 1)
         ->setComment("ROOT compression level to use.");
     desc.addUntracked<int>("lumiSection_interval", 0)
         ->setComment("If 0, use lumi section number from event.\n"
                      "If not 0, the interval in seconds between fake lumi sections.");
     OutputModule::fillDescription(desc);
   }

Trig edm::StreamerOutputModuleBase::getTriggerResults	(	EDGetTokenT< TriggerResults > const &	token,
		EventForOutput const &	e
	)		const

private

Definition at line 201 of file StreamerOutputModuleBase.cc.

References edm::OccurrenceForOutput::getByToken(), and mps_fire::result.

Referenced by setHltMask().

                                                                                                                      {
     Trig result;
     e.getByToken<TriggerResults>(token, result);
     return result;
   }

std::unique_ptr< EventMsgBuilder > edm::StreamerOutputModuleBase::serializeEvent ( EventForOutput const & e )

private

Definition at line 249 of file StreamerOutputModuleBase.cc.

References SerializeDataBuffer::adler32_chksum(), SerializeDataBuffer::bufferPointer(), SerializeDataBuffer::bufs_, compressionLevel_, popcon2dropbox::copy(), SerializeDataBuffer::currentEventSize(), SerializeDataBuffer::currentSpaceUsed(), edm::EventID::event(), hltbits_, hltsize_, host_name_, edm::EventForOutput::id(), l1bit_, lumi_, edm::EventForOutput::luminosityBlock(), lumiSectionInterval_, mps_check::msg, origSize_, outputModuleId_, edm::EventID::run(), edm::one::OutputModuleBase::selectorConfig(), serializeDataBuffer_, edm::StreamSerializer::serializeEvent(), serializer_, setHltMask(), setLumiSection(), TrackRefitter_38T_cff::src, and useCompression_.

Referenced by write().

                                                                   {
     //Lets Build the Event Message first
 
     //Following is strictly DUMMY Data for L! Trig and will be replaced with actual
     // once figured out, there is no logic involved here.
     l1bit_.push_back(true);
     l1bit_.push_back(true);
     l1bit_.push_back(false);
     //End of dummy data
 
     setHltMask(e);
 
     if (lumiSectionInterval_ == 0) {
       lumi_ = e.luminosityBlock();
     } else {
       setLumiSection();
     }
 
     serializer_.serializeEvent(e, selectorConfig(), useCompression_, compressionLevel_, serializeDataBuffer_);
 
     // resize bufs_ to reflect space used in serializer_ + header
     // I just added an overhead for header of 50000 for now
     unsigned int src_size = serializeDataBuffer_.currentSpaceUsed();
     unsigned int new_size = src_size + 50000;
     if(serializeDataBuffer_.bufs_.size() < new_size) serializeDataBuffer_.bufs_.resize(new_size);
 
     auto msg = std::make_unique<EventMsgBuilder>(
                               &serializeDataBuffer_.bufs_[0], serializeDataBuffer_.bufs_.size(), e.id().run(),
                               e.id().event(), lumi_, outputModuleId_, 0,
                               l1bit_, (uint8*)&hltbits_[0], hltsize_,
                               (uint32)serializeDataBuffer_.adler32_chksum(), host_name_);
     msg->setOrigDataSize(origSize_); // we need this set to zero
 
     // copy data into the destination message
     // an alternative is to have serializer only to the serialization
     // in serializeEvent, and then call a new member "getEventData" that
     // takes the compression arguments and a place to put the data.
     // This will require one less copy.  The only catch is that the
     // space provided in bufs_ should be at least the uncompressed
     // size + overhead for header because we will not know the actual
     // compressed size.
 
     unsigned char* src = serializeDataBuffer_.bufferPointer();
     std::copy(src,src + src_size, msg->eventAddr());
     msg->setEventLength(src_size);
     if(useCompression_) msg->setOrigDataSize(serializeDataBuffer_.currentEventSize());
 
     l1bit_.clear();  //Clear up for the next event to come.
     return msg;
   }

std::unique_ptr< InitMsgBuilder > edm::StreamerOutputModuleBase::serializeRegistry ( )

private

Definition at line 143 of file StreamerOutputModuleBase.cc.

References SerializeDataBuffer::adler32_chksum(), edm::one::OutputModuleBase::branchIDLists(), SerializeDataBuffer::bufferPointer(), edm::Hash< I >::compactForm(), popcon2dropbox::copy(), SerializeDataBuffer::currentSpaceUsed(), edm::one::OutputModuleBase::description(), edm::getAllTriggerNames(), edm::getReleaseVersion(), SerializeDataBuffer::header_buf_, hltsize_, hltTriggerSelections_, dttmaxenums::L, edm::ModuleDescription::mainParameterSetID(), edm::one::OutputModuleBase::moduleDescription(), edm::ModuleDescription::moduleLabel(), outputModuleId_, edm::OutputModule::processName(), edm::one::OutputModuleBase::processName(), findQualityFiles::run, serializeDataBuffer_, serializer_, edm::StreamSerializer::serializeRegistry(), TrackRefitter_38T_cff::src, AlCaHLTBitMon_QueryRunRegistry::string, and edm::one::OutputModuleBase::thinnedAssociationsHelper().

Referenced by beginRun().

                                               {
 
     serializer_.serializeRegistry(serializeDataBuffer_, *branchIDLists(), *thinnedAssociationsHelper());
 
     // resize bufs_ to reflect space used in serializer_ + header
     // I just added an overhead for header of 50000 for now
     unsigned int src_size = serializeDataBuffer_.currentSpaceUsed();
     unsigned int new_size = src_size + 50000;
     if(serializeDataBuffer_.header_buf_.size() < new_size) serializeDataBuffer_.header_buf_.resize(new_size);
 
     //Build the INIT Message
     //Following values are strictly DUMMY and will be replaced
     // once available with Utility function etc.
     uint32 run = 1;
 
     //Get the Process PSet ID
     ParameterSetID toplevel = moduleDescription().mainParameterSetID();
 
     //In case we need to print it
     //  cms::Digest dig(toplevel.compactForm());
     //  cms::MD5Result r1 = dig.digest();
     //  std::string hexy = r1.toString();
     //  std::cout << "HEX Representation of Process PSetID: " << hexy << std::endl;
 
     Strings hltTriggerNames = getAllTriggerNames();
     hltsize_ = hltTriggerNames.size();
 
     //L1 stays dummy as of today
     Strings l1_names;  //3
     l1_names.push_back("t1");
     l1_names.push_back("t10");
     l1_names.push_back("t2");
 
     //Setting the process name to HLT
     std::string processName = OutputModule::processName();
 
     std::string moduleLabel = description().moduleLabel();
     uLong crc = crc32(0L, Z_NULL, 0);
     Bytef const* buf = (Bytef const*)(moduleLabel.data());
     crc = crc32(crc, buf, moduleLabel.length());
     outputModuleId_ = static_cast<uint32>(crc);
 
     auto init_message = std::make_unique<InitMsgBuilder>(
                            &serializeDataBuffer_.header_buf_[0], serializeDataBuffer_.header_buf_.size(),
                            run, Version((uint8 const*)toplevel.compactForm().c_str()),
                            getReleaseVersion().c_str() , processName.c_str(),
                            moduleLabel.c_str(), outputModuleId_,
                            hltTriggerNames, hltTriggerSelections_, l1_names,
                            (uint32)serializeDataBuffer_.adler32_chksum());
 
     // copy data into the destination message
     unsigned char* src = serializeDataBuffer_.bufferPointer();
     std::copy(src, src + src_size, init_message->dataAddress());
     init_message->setDataLength(src_size);
     return init_message;
   }

void edm::StreamerOutputModuleBase::setHltMask ( EventForOutput const & e )

private

Definition at line 208 of file StreamerOutputModuleBase.cc.

References getTriggerResults(), hltbits_, hltsize_, mps_fire::i, edm::HandleBase::isValid(), edm::hlt::Pass, parseEventContent::prod, and trToken_.

Referenced by serializeEvent().

                                                               {
 
     hltbits_.clear();  // If there was something left over from last event
 
     Handle<TriggerResults> const& prod = getTriggerResults(trToken_, e);
     //Trig const& prod = getTrigMask(e);
     std::vector<unsigned char> vHltState;
 
     if (prod.isValid()) {
       for(std::vector<unsigned char>::size_type i=0; i != hltsize_ ; ++i) {
         vHltState.push_back(((prod->at(i)).state()));
       }
     } else {
      // We fill all Trigger bits to valid state.
      for(std::vector<unsigned char>::size_type i=0; i != hltsize_ ; ++i) {
            vHltState.push_back(hlt::Pass);
       }
     }
     //Pack into member hltbits_
     packIntoString(vHltState, hltbits_);
 
     //This is Just a printing code.
     //std::cout << "Size of hltbits:" << hltbits_.size() << std::endl;
     //for(unsigned int i=0; i != hltbits_.size() ; ++i) {
     //  printBits(hltbits_[i]);
     //}
     //std::cout << "\n";
   }

void edm::StreamerOutputModuleBase::setLumiSection ( )

private

Definition at line 239 of file StreamerOutputModuleBase.cc.

References lumi_, lumiSectionInterval_, and timeInSecSinceUTC.

Referenced by serializeEvent().

                                            {
     struct timeval now;
     struct timezone dummyTZ;
     gettimeofday(&now, &dummyTZ);
     double timeInSec = static_cast<double>(now.tv_sec) + (static_cast<double>(now.tv_usec)/1000000.0) - timeInSecSinceUTC;
     // what about overflows?
     if(lumiSectionInterval_ > 0) lumi_ = static_cast<uint32>(timeInSec/lumiSectionInterval_) + 1;
   }

virtual void edm::StreamerOutputModuleBase::start ( )

privatepure virtual

Implemented in evf::RecoEventOutputModuleForFU< Consumer >, and edm::StreamerOutputModule< Consumer >.

Referenced by progressbar.ProgressBar::__next__(), and beginRun().

virtual void edm::StreamerOutputModuleBase::stop ( )

privatepure virtual

Implemented in evf::RecoEventOutputModuleForFU< Consumer >, and edm::StreamerOutputModule< Consumer >.

Referenced by endJob(), and endRun().

void edm::StreamerOutputModuleBase::write ( EventForOutput const & e )

overrideprivatevirtual

Implements edm::one::OutputModuleBase.

Definition at line 137 of file StreamerOutputModuleBase.cc.

References doOutputEvent(), mps_check::msg, and serializeEvent().

                                                          {
     std::unique_ptr<EventMsgBuilder> msg = serializeEvent(e);
     doOutputEvent(*msg); // You can't use msg in StreamerOutputModuleBase after this point
   }