ErrorCheckerBase Class Reference

#include <ErrorCheckerBase.h>

Inheritance diagram for ErrorCheckerBase:

Public Member Functions
bool	checkCRC (bool &errorsInEvent, int fedId, const Word64 *trailer, SiPixelFormatterErrors &errors) const
bool	checkHeader (bool &errorsInEvent, int fedId, const Word64 *header, SiPixelFormatterErrors &errors) const
virtual bool	checkROC (bool &errorsInEvent, int fedId, const SiPixelFrameConverter *converter, const SiPixelFedCabling *theCablingTree, Word32 &errorWord, SiPixelFormatterErrors &errors) const =0
bool	checkTrailer (bool &errorsInEvent, int fedId, unsigned int nWords, const Word64 *trailer, SiPixelFormatterErrors &errors) const
void	conversionError (int fedId, const SiPixelFrameConverter *converter, int status, Word32 &errorWord, SiPixelFormatterErrors &errors) const
	ErrorCheckerBase ()
void	setErrorStatus (bool ErrorStatus)
virtual	~ErrorCheckerBase ()=default

Protected Member Functions
void	addErrorToCollectionDummy (int errorType, int fedId, Word64 word, SiPixelFormatterErrors &errors) const
virtual cms_uint32_t	errorDetId (const SiPixelFrameConverter *converter, int errorType, const Word32 &word) const =0
int	getConversionErrorTypeAndIssueLogMessage (int status, int fedId) const

Protected Attributes
bool	includeErrors_

Detailed Description

Definition at line 14 of file ErrorCheckerBase.h.

Constructor & Destructor Documentation

ErrorCheckerBase()

ErrorCheckerBase::ErrorCheckerBase

(

)

Definition at line 21 of file ErrorCheckerBase.cc.

: includeErrors_(false) {}

~ErrorCheckerBase()

virtual ErrorCheckerBase::~ErrorCheckerBase ( )

virtualdefault

Member Function Documentation

addErrorToCollectionDummy()

void ErrorCheckerBase::addErrorToCollectionDummy ( int  errorType, int  fedId, Word64  word, SiPixelFormatterErrors &  errors  ) const

protected

Definition at line 25 of file ErrorCheckerBase.cc.

References sipixelconstants::dummyDetId, relativeConstraints::error, l1tstage2_dqm_sourceclient-live_cfg::fedId, and includeErrors_.

Referenced by checkCRC(), checkHeader(), and checkTrailer().

                                                                                       {
  if (includeErrors_) {
    SiPixelRawDataError error(word, errorType, fedId);
    errors[sipixelconstants::dummyDetId].push_back(error);
  }
}

checkCRC()

bool ErrorCheckerBase::checkCRC	(	bool &	errorsInEvent,
		int	fedId,
		const Word64 *	trailer,
		SiPixelFormatterErrors &	errors
	)		const

Definition at line 35 of file ErrorCheckerBase.cc.

References addErrorToCollectionDummy(), sipixelconstants::CRC_mask, sipixelconstants::CRC_shift, and l1tstage2_dqm_sourceclient-live_cfg::fedId.

                                                                      {
  const int CRC_BIT = (*trailer >> CRC_shift) & CRC_mask;
  const bool isCRCcorrect = (CRC_BIT == 0);
  if (!isCRCcorrect)
    addErrorToCollectionDummy(39, fedId, *trailer, errors);
  errorsInEvent = (errorsInEvent || !isCRCcorrect);
  return isCRCcorrect;
}

checkHeader()

bool ErrorCheckerBase::checkHeader	(	bool &	errorsInEvent,
		int	fedId,
		const Word64 *	header,
		SiPixelFormatterErrors &	errors
	)		const

Definition at line 47 of file ErrorCheckerBase.cc.

References addErrorToCollectionDummy(), FEDHeader::check(), l1tstage2_dqm_sourceclient-live_cfg::fedId, RecoTauValidation_cfi::header, LogDebug, FEDHeader::moreHeaders(), and FEDHeader::sourceID().

                                                                         {
  FEDHeader fedHeader(reinterpret_cast<const unsigned char*>(header));
  const bool fedHeaderCorrect = fedHeader.check();
  // if not fedHeaderCorrect throw exception?
  if (fedHeaderCorrect && (fedHeader.sourceID() != fedId)) {
    int errorType = 32;
    addErrorToCollectionDummy(errorType, fedId, *header, errors);
    LogDebug("PixelDataFormatter::interpretRawData, fedHeader.sourceID() != fedId")
        << ", sourceID = " << fedHeader.sourceID() << ", fedId = " << fedId << ", errorType = " << errorType;
    errorsInEvent = true;
  }
  return fedHeaderCorrect && fedHeader.moreHeaders();
}

checkROC()

virtual bool ErrorCheckerBase::checkROC ( bool &  errorsInEvent, int  fedId, const SiPixelFrameConverter *  converter, const SiPixelFedCabling *  theCablingTree, Word32 &  errorWord, SiPixelFormatterErrors &  errors  ) const

pure virtual

Implemented in ErrorChecker, and ErrorCheckerPhase0.

checkTrailer()

bool ErrorCheckerBase::checkTrailer	(	bool &	errorsInEvent,
		int	fedId,
		unsigned int	nWords,
		const Word64 *	trailer,
		SiPixelFormatterErrors &	errors
	)		const

Definition at line 64 of file ErrorCheckerBase.cc.

References addErrorToCollectionDummy(), FEDTrailer::check(), l1tstage2_dqm_sourceclient-live_cfg::fedId, FEDTrailer::fragmentLength(), and FEDTrailer::moreTrailers().

                                                                                                                      {
  FEDTrailer fedTrailer(reinterpret_cast<const unsigned char*>(trailer));
  const bool fedTrailerCorrect = fedTrailer.check();
  if (!fedTrailerCorrect) {
    int errorType = 33;
    addErrorToCollectionDummy(errorType, fedId, *trailer, errors);
    LogError("FedTrailerCheck") << "fedTrailer.check failed, Fed: " << fedId << ", errorType = " << errorType;
    errorsInEvent = true;
  } else if (fedTrailer.fragmentLength() != nWords) {
    int errorType = 34;
    addErrorToCollectionDummy(errorType, fedId, *trailer, errors);
    LogError("FedTrailerLenght") << "fedTrailer.fragmentLength()!= nWords !! Fed: " << fedId
                                 << ", errorType = " << errorType;
    errorsInEvent = true;
  }
  return fedTrailerCorrect && fedTrailer.moreTrailers();
}

conversionError()

void ErrorCheckerBase::conversionError	(	int	fedId,
		const SiPixelFrameConverter *	converter,
		int	status,
		Word32 &	errorWord,
		SiPixelFormatterErrors &	errors
	)		const

Definition at line 83 of file ErrorCheckerBase.cc.

References relativeConstraints::error, errorDetId(), l1tstage2_dqm_sourceclient-live_cfg::fedId, getConversionErrorTypeAndIssueLogMessage(), includeErrors_, and mps_update::status.

                                                                             {
  const int errorType = getConversionErrorTypeAndIssueLogMessage(status, fedId);
  // errorType == 0 means unexpected error, in this case we don't include it in the error collection
  if (errorType && includeErrors_) {
    SiPixelRawDataError error(errorWord, errorType, fedId);
    cms_uint32_t detId = errorDetId(converter, errorType, errorWord);
    errors[detId].push_back(error);
  }
}

errorDetId()

virtual cms_uint32_t ErrorCheckerBase::errorDetId ( const SiPixelFrameConverter *  converter, int  errorType, const Word32 &  word  ) const

protectedpure virtual

Implemented in ErrorChecker, and ErrorCheckerPhase0.

Referenced by conversionError().

getConversionErrorTypeAndIssueLogMessage()

int ErrorCheckerBase::getConversionErrorTypeAndIssueLogMessage ( int  status, int  fedId  ) const

protected

Definition at line 97 of file ErrorCheckerBase.cc.

References l1tstage2_dqm_sourceclient-live_cfg::fedId, LogDebug, mps_update::status, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by conversionError().

                                                                                          {
  int errorType = 0;
  std::string debugMessage;
  switch (status) {
    case (1): {
      debugMessage = "invalid channel Id";
      errorType = 35;
      break;
    }
    case (2): {
      debugMessage = "invalid ROC Id";
      errorType = 36;
      break;
    }
    case (3): {
      debugMessage = "invalid dcol/pixel value";
      errorType = 37;
      break;
    }
    case (4): {
      debugMessage = "dcol/pixel read out of order";
      errorType = 38;
      break;
    }
  };
  if (errorType) {
    LogDebug("ErrorChecker::conversionError") << "Fed:" << fedId << debugMessage << "(errorType =" << errorType << ")";
  } else {
    LogDebug("ErrorChecker::conversionError") << "cabling check returned unexpected result, status =" << status;
  }
  return errorType;
}

setErrorStatus()

void ErrorCheckerBase::setErrorStatus

(

bool

ErrorStatus

)

Definition at line 23 of file ErrorCheckerBase.cc.

References includeErrors_.

{ includeErrors_ = ErrorStatus; }

Member Data Documentation

includeErrors_

bool ErrorCheckerBase::includeErrors_

protected

Definition at line 43 of file ErrorCheckerBase.h.

Referenced by addErrorToCollectionDummy(), ErrorCheckerPhase0::checkROC(), ErrorChecker::checkROC(), conversionError(), and setErrorStatus().