DbuDaqFileSummary.cxx

Go to the documentation of this file.

// $Id: DbuDaqFileSummary.cxx,v 1.14 2007/02/15 14:15:48 rhatcher Exp $
//
// DbuDaqFileSummary
//
// Package: DatabaseUpdater
//
// R. Hatcher  2002-04-19
//
// Concept:
//   
// Purpose:
//

#include "DatabaseUpdater/DbuDaqFileSummary.h"
#include "DatabaseUpdater/DbuSignalHandler.h"

#include "MessageService/MsgService.h"

#include "DatabaseInterface/DbiOutRowStream.h"
#include "DatabaseInterface/DbiResultSet.h"
#include "DatabaseInterface/DbiValidityRec.h"
#include "DatabaseInterface/DbiString.h"

#include <iostream>
#include <cassert>
#include <sstream>

#include "DatabaseUpdater/RunTypeName.h"
#include "OnlineUtil/msgLogLib/msgLog.h"
#include "Util/UtilString.h"
#include "RawData/RawTriggerCodes.h"

ClassImp(DbuDaqFileSummary)

//   Definition of static data members
//   *********************************

CVSID("$Id: DbuDaqFileSummary.cxx,v 1.14 2007/02/15 14:15:48 rhatcher Exp $ CVSID_DBIRESULTPTR ");

const std::string DbuDaqFileSummary::kNoBaseName = "<<No BaseName>>";
const std::string DbuDaqFileSummary::kNoDirName  = "<<No DirName>>";

UInt_t DbuDaqFileSummary::fgFmtFlag = 0xffff;

//  Instantiate associated Result Pointer class.
//  *******************************************

#include "DatabaseInterface/DbiResultPtr.tpl"
template class  DbiResultPtr<DbuDaqFileSummary>;

#include "DatabaseInterface/DbiWriter.tpl"
template class  DbiWriter<DbuDaqFileSummary>;

//.....................................................................

std::ostream& operator<<(std::ostream& os, const DbuDaqFileSummary& ddfs)
{
   os << ddfs.GetName() 
      << " " << Detector::AsString(ddfs.fDetector)
      << " Run " << ddfs.fRun
      << " SubRun " << ddfs.fSubRun
      << endl
      << " RecSets " << ddfs.fRecSets
      << " (" << ddfs.fRecSetsNotLIOnly << ")"
      << std::right
      << "  TimeFrames "
      << "# [" << setw(8) << ddfs.fFirstTimeFrame << ":"
      << setw(8) << ddfs.fLastTimeFrame << "] "
      << endl
      << "  Snarls " 
      << setw(8) << ddfs.fSnarlRecs << " : "
      << "  {" << ddfs.fFirstSnarlTime.AsString("sql") 
      << "} {" << ddfs.fLastSnarlTime.AsString("sql") << "}"
      << endl
      << "   " 
      << " TrigBits 0x" << setfill('0') << setw(8) << hex << ddfs.fTrigBitsSeen
      << dec << setfill(' ')
      << " \"" << RawTriggerCodes::MaskToString(ddfs.fTrigBitsSeen) << "\""
      << endl
      << "    Snarl # [" << setw(8) << ddfs.fFirstSnarlNum << ":"
      << setw(8) << ddfs.fLastSnarlNum << "] "
      << endl
      << "   "
      << " Digits: " 
      << ddfs.fTotalDigits << " (" << ddfs.fErrorDigits << ")"
      << " in "
      << ddfs.fTotalDigitBlocks << " (" << ddfs.fErrorDigitBlocks << ") blocks (errors)"
      << endl
      << "  Other  "
      << setw(8) << (ddfs.fMonitorRecs+ddfs.fLightInjRecs) << " : "
      << "  {" << ddfs.fFirstMonitorTime.AsString("sql") 
      << "} {" << ddfs.fLastMonitorTime.AsString("sql") << "}"
      << endl
      << "    Monitors " << ddfs.fMonitorRecs
      << " LightInj " << ddfs.fLightInjRecs
      << "  (LI Blocks: Adc " << ddfs.fAdcLIBlocks 
      << ", Timing " << ddfs.fTimingLIBlocks << ")"
      << resetiosflags(ios::adjustfield) // undo "right"/"left"
      << endl;

   if ( DbuDaqFileSummary::fgFmtFlag & DbuDaqFileSummary::fmt_BlockCount ) {
     os << "  Block Counts:" << endl;
     bool doendl = false;
     std::map<string,int>::const_iterator mapItr = ddfs.fBlockCount.begin();
     while (mapItr != ddfs.fBlockCount.end()) {
       string blkName = mapItr->first;
       int    blkCnt  = mapItr->second;
       os << "    " << std::left << setw(26) << blkName 
          << " " << std::right << setw(8) << blkCnt;
       if (doendl) os  << endl;
       doendl = !doendl; // toggle
       mapItr++;  // move on
     }
     os << std::right;
     if (doendl) os  << endl;  // if last line still hanging complete it
   }
   os << resetiosflags(ios::adjustfield); // undo "right"/"left"

   os << "  BaseName: " << ddfs.fBaseName 
      << endl
      << "  DirName: " << ddfs.fDirName << endl;

   os << "  Size " << ddfs.fSize << " bytes,"
      << " Compression level " << ddfs.fCompressLevel
      << " factor " << ddfs.fCompressFactor
      << " ROOT " << ddfs.fRootVersion
      << endl
      << "  ModTime " << ddfs.fModTime.AsString("sql")
      << ", processed on " << ddfs.fProcHost
      << endl;

   return os;
}

//.....................................................................

// Definition of member functions (alphabetical order)
// ***************************************************

//.....................................................................

void DbuDaqFileSummary::Fill(DbiResultSet& rs,
                                      const DbiValidityRec* vrec) {
//
//
//  Purpose:  Fill object from Result Set
//
//  Arguments: 
//    rs           in    Result Set used to fill object
//    vrec         in    Associated validity record (or 0 if filling
//                                                    DbiValidityRec)
//
//  Return:    
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//
//  o Fill object from current row of Result Set.

//  Program Notes:-
//  =============

//  None.

   Detector::Detector_t det =
      (Detector::Detector_t) 
      ((vrec) ? vrec->GetVldRange().GetDetectorMask() : 0);

   string detname, runtypename, mapstring;   
   Int_t size_32;

   // count of data columns (not including SEQNO and ROW_COUNTER)
   Int_t numDataCol = rs.NumCols() - (rs.HasRowCounter() ? 1 : 0) - 1;
   if ( 32 == numDataCol ) {  
       rs >> detname
          >> fRun
          >> fSubRun
          >> fFirstTimeFrame
          >> fLastTimeFrame
          >> fRecSets
          >> fRecSetsNotLIOnly
          >> fFirstSnarlTime
          >> fLastSnarlTime
          >> fFirstSnarlNum
          >> fLastSnarlNum
          >> fSnarlRecs
          >> fTrigBitsSeen
          >> fTotalDigitBlocks
          >> fErrorDigitBlocks
          >> fTotalDigits
          >> fErrorDigits
          >> fFirstMonitorTime
          >> fLastMonitorTime
          >> fMonitorRecs
          >> fLightInjRecs
          >> fAdcLIBlocks
          >> fTimingLIBlocks
          >> mapstring
          >> fBaseName
          >> fDirName
          >> size_32
          >> fCompressLevel
          >> fCompressFactor
          >> fRootVersion
          >> fModTime
          >> fProcHost;
   }
   else if ( 31 == numDataCol ) {    // before fRecSetsNotLIOnly
       rs >> detname
          >> fRun
          >> fSubRun
          >> fFirstTimeFrame
          >> fLastTimeFrame
          >> fRecSets
          >> fFirstSnarlTime
          >> fLastSnarlTime
          >> fFirstSnarlNum
          >> fLastSnarlNum
          >> fSnarlRecs
          >> fTrigBitsSeen
          >> fTotalDigitBlocks
          >> fErrorDigitBlocks
          >> fTotalDigits
          >> fErrorDigits
          >> fFirstMonitorTime
          >> fLastMonitorTime
          >> fMonitorRecs
          >> fLightInjRecs
          >> fAdcLIBlocks
          >> fTimingLIBlocks
          >> mapstring
          >> fBaseName
          >> fDirName
          >> size_32
          >> fCompressLevel
          >> fCompressFactor
          >> fRootVersion
          >> fModTime
          >> fProcHost;
   }
   else {
       MAXMSG("Dbu",Msg::kWarning,25)
           << "Table " << GetName() << " has " << numDataCol
           << ", but we only know how to handle 19 or 18."
           << endl;
   }

   
   fSize = size_32;

   fDetector = Detector::CharToEnum(detname.c_str()[0]);
   if (fDetector != det) 
      MSG("Dbu",Msg::kWarning)
         << "Detector column '" << detname << "' (" << (int)fDetector
         << ") did not match DetectorMask (" << (int)det << ")" << endl;

   FillMapFromString(mapstring);

}

//.....................................................................

void DbuDaqFileSummary::Store(DbiOutRowStream& ors,
                             const DbiValidityRec* /* vrec */) const {
//
//
//  Purpose:  Stream object to output row stream
//
//  Arguments: 
//    ors          in     Output row stream.
//    vrec         in     Associated validity record (or 0 if filling
//                                                    DbiValidityRec)
//
//  Return:    
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//
//  o  Stream object to output row stream.

//  Program Notes:-
//  =============

//  None.

   Int_t size_32 = fSize;  // hope it doesn't overflow
   string mapstring;
   GetStringFromMap(mapstring);

   ors << Detector::AsString(fDetector)
       << fRun
       << fSubRun
       << fFirstTimeFrame
       << fLastTimeFrame
       << fRecSets
       << fRecSetsNotLIOnly
       << fFirstSnarlTime
       << fLastSnarlTime
       << fFirstSnarlNum
       << fLastSnarlNum
       << fSnarlRecs
       << fTrigBitsSeen
       << fTotalDigitBlocks
       << fErrorDigitBlocks
       << fTotalDigits
       << fErrorDigits
       << fFirstMonitorTime
       << fLastMonitorTime
       << fMonitorRecs
       << fLightInjRecs
       << fAdcLIBlocks
       << fTimingLIBlocks
       << mapstring
       << fBaseName
       << fDirName
       << size_32
       << fCompressLevel
       << fCompressFactor
       << fRootVersion
       << fModTime
       << fProcHost;
   
}

//.....................................................................

Int_t DbuDaqFileSummary::CalcUniqueSeqNo(Detector::Detector_t det, 
                                         Int_t run, Short_t subrun)
{
//
//
//  Purpose:  Calculate unique SeqNo
//
//  Return:   an integer
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//

//  Program Notes:-
//  =============

//  None.

// similar to file naming convention
//   Char_t detchar = Detector::AsString(det)[0];
//   string fname = Form("%c%8.8d_%4.4d",detchar,run,subrun);
// take care since can overflow int
//  use two fewers places for sub and two fewer for run
//  "drrrrrrss"

   return subrun%kModSubRun + kModSubRun*(run%kModRun + kModRun*det);
}

//.....................................................................

const char* DbuDaqFileSummary::GetTableDescr()
{
//
//
//  Purpose:  Return a string describing rows in the table
//            Used in creating temporary tables
//
//  Return:   const char* to parenthesized comma separated list
//            of column name and type pairs
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//

//  Program Notes:-
//  =============

//  None.

   const char* const_tabledescr = "(\
       SEQNO              int,          \
       ROW_COUNTER        int,          \
       DETECTOR           varchar(10),  \
       RUN                int,          \
       SUBRUN             smallint,     \
       FIRST_TIMEFRAME    int,          \
       LAST_TIMEFRAME     int,          \
       REC_SETS           int,          \
       REC_SETS_NOTLIONLY int,          \
       FIRST_SNARL_TIME   datetime,     \
       LAST_SNARL_TIME    datetime,     \
       FIRST_SNARL_NUM    int,          \
       LAST_SNARL_NUM     int,          \
       SNARL_RECS         int,          \
       TRIGBITS_SEEN      int,          \
       DIGITBLOCKS_TOTAL  int,          \
       DIGITBLOCKS_ERROR  int,          \
       DIGITS_TOTAL       int,          \
       DIGITS_ERROR       int,          \
       FIRST_MONITOR_TIME datetime,     \
       LAST_MONITOR_TIME  datetime,     \
       MONITOR_RECS       int,          \
       LIGHTINJ_RECS      int,          \
       ADC_LI_BLKS        int,          \
       TIMING_LI_BLKS     int,          \
       BLOCK_COUNT        text,         \
       BASENAME           varchar(24),  \
       DIRNAME            varchar(255), \
       FILESIZE           int,          \
       COMPRESSLEVEL      smallint,     \
       COMPRESSFACTOR     float,        \
       ROOTVERSION        int,          \
       MODTIME            datetime,     \
       PROC_HOST          varchar(80),  \
       primary key (SEQNO,ROW_COUNTER), \
       index (RUN) )";

   return const_tabledescr;
}

//.....................................................................

Bool_t DbuDaqFileSummary::Commit(DbiStatement* stmt)
{
//
//
//  Purpose:  
//
//  Arguments: 
//    xxxxxxxxx    in    yyyyyy
//
//  Return:    
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//
//  o 

//  Program Notes:-
//  =============

//  None.

  if (!stmt) return false; 

  // protect ODBC code against signals
  DbuSignalHandler::Instance().Delay();
  
  Int_t seqno = GetSeqNo();
  string tbl  = "DBUDAQFILESUMMARY";
  string tblv = "DBUDAQFILESUMMARYVLD";
  
  // just blast away any existing entry

  DbiString sqlrm, sqlrmv;
  
  sqlrm  << "delete from " << tbl  << " where SEQNO=" << seqno << ";\0";
  Int_t nrm  = stmt->ExecuteUpdate(sqlrm.c_str());
  stmt->PrintExceptions();

  sqlrmv << "delete from " << tblv << " where SEQNO=" << seqno << ";\0";
  Int_t nrmv = stmt->ExecuteUpdate(sqlrmv.c_str());
  stmt->PrintExceptions();

  // prepare to fill table

  string mapstring;
  GetStringFromMap(mapstring);
  string printableMapString;
  UtilString::MakePrintable(mapstring.c_str(),printableMapString);

  DbiString sqlcol, sqlval;
  sqlcol << " SEQNO ";
  sqlval << seqno;
  sqlcol << ", DETECTOR ";
  sqlval << ",'" << Detector::AsString(fDetector) << "'";
  sqlcol << ", RUN ";
  sqlval << "," << fRun;
  sqlcol << ", SUBRUN ";
  sqlval << "," << fSubRun;
  sqlcol << ", FIRST_TIMEFRAME ";
  sqlval << "," << fFirstTimeFrame;
  sqlcol << ", LAST_TIMEFRAME ";
  sqlval << "," << fLastTimeFrame;
  sqlcol << ", REC_SETS ";
  sqlval << "," << fRecSets;
  sqlcol << ", REC_SETS_NOTLIONLY ";
  sqlval << "," << fRecSetsNotLIOnly;
  sqlcol << ", FIRST_SNARL_TIME ";
  sqlval << ",'" << fFirstSnarlTime.AsString("s") << "'";
  sqlcol << ", LAST_SNARL_TIME ";
  sqlval << ",'" << fLastSnarlTime.AsString("s") << "'";
  sqlcol << ", FIRST_SNARL_NUM ";
  sqlval << "," << fFirstSnarlNum;
  sqlcol << ", LAST_SNARL_NUM ";
  sqlval << "," << fLastSnarlNum;
  sqlcol << ", SNARL_RECS ";
  sqlval << "," << fSnarlRecs;
  sqlcol << ", TRIGBITS_SEEN ";
  sqlval << "," << fTrigBitsSeen;

  sqlcol << ", DIGITBLOCKS_TOTAL ";
  sqlval << "," << fTotalDigitBlocks;
  sqlcol << ", DIGITBLOCKS_ERROR ";
  sqlval << "," << fErrorDigitBlocks;
  sqlcol << ", DIGITS_TOTAL ";
  sqlval << "," << fTotalDigits;
  sqlcol << ", DIGITS_ERROR ";
  sqlval << "," << fErrorDigits;

  sqlcol << ", FIRST_MONITOR_TIME ";
  sqlval << ",'" << fFirstMonitorTime.AsString("s") << "'";
  sqlcol << ", LAST_MONITOR_TIME ";
  sqlval << ",'" << fLastMonitorTime.AsString("s") << "'";
  sqlcol << ", MONITOR_RECS ";
  sqlval << "," << fMonitorRecs;
  sqlcol << ", LIGHTINJ_RECS ";
  sqlval << "," << fLightInjRecs;
  sqlcol << ", ADC_LI_BLKS ";
  sqlval << "," << fAdcLIBlocks;
  sqlcol << ", TIMING_LI_BLKS ";
  sqlval << "," << fTimingLIBlocks;

  sqlcol << ", BLOCK_COUNT ";
  sqlval << ",'" << printableMapString << "'";
  
  sqlcol << ", BASENAME ";
  sqlval << ",'" << fBaseName << "'";
  sqlcol << ", DIRNAME ";
  sqlval << ",'" << fDirName << "'";
  sqlcol << ", FILESIZE ";
  Int_t size_32 = fSize;  // hope it doesn't overflow
  sqlval << "," << size_32;
  sqlcol << ", COMPRESSLEVEL ";
  sqlval << "," << fCompressLevel;
  sqlcol << ", COMPRESSFACTOR ";
  sqlval << "," << fCompressFactor;
  sqlcol << ", ROOTVERSION ";
  sqlval << "," << fRootVersion;
  sqlcol << ", MODTIME ";
  sqlval << ",'" << fModTime.AsString("s") << "'";
  sqlcol << ", PROC_HOST ";
  sqlval << ",'" << fProcHost << "'";

  DbiString sqlinsert;
  sqlinsert << "insert into " << tbl
            << " ( " << sqlcol.c_str() << " ) "
            << " values ( " << sqlval.c_str() << " ) ;\0";
  
  MSG("Dbu",Msg::kDebug) << sqlinsert.c_str() << endl;

  VldTimeStamp now;
  VldTimeStamp startTime = fFirstMonitorTime;
  VldTimeStamp endTime   = fLastMonitorTime;
  // the above _should_ do in general ... but sometimes things are weird
  const VldTimeStamp nullTime = VldTimeStamp((time_t)0,0);  
  if ( nullTime != fFirstSnarlTime ) {
    if ( nullTime        == startTime || 
         fFirstSnarlTime  < startTime    ) startTime = fFirstSnarlTime;
  }
  if ( nullTime != fLastSnarlTime ) {
    if ( nullTime        == endTime || 
         fFirstSnarlTime  > endTime    ) endTime = fLastSnarlTime;
  }

  const Int_t task = 0;

  DbiString sqlcolv, sqlvalv;
  sqlcolv << " SEQNO";
  sqlvalv << seqno;
  sqlcolv << ", TIMESTART ";
  sqlvalv << ",'" << startTime.AsString("s") << "'";
  sqlcolv << ", TIMEEND ";
  sqlvalv << ",'" << endTime.AsString("s") << "'";
  sqlcolv << ", DETECTORMASK ";
  sqlvalv << "," << fDetector;
  sqlcolv << ", SIMMASK ";
  sqlvalv << "," << fSimFlag;
  sqlcolv << ", TASK ";
  sqlvalv << "," << task;
  sqlcolv << ", AGGREGATENO ";
  sqlvalv << "," << fSubRun;
  sqlcolv << ", CREATIONDATE ";
  sqlvalv << ",'" << now.AsString("s") << "'" ;
  sqlcolv << ", INSERTDATE ";
  sqlvalv << ",'" << now.AsString("s") << "'";
  
  DbiString sqlinsertv;
  sqlinsertv << "insert into " << tblv
             << " ( " << sqlcolv.c_str() << " ) "
             << " VALUES ( " << sqlvalv.c_str() << " ) ;\0";
  
  MSG("Dbu",Msg::kDebug) 
    << "insert into " << tblv
    << " ( " << sqlcolv.c_str() << " ) "
    << " VALUES ( " << sqlvalv.c_str() << " ) ;"
    << endl;
  
  Int_t ninsert = stmt->ExecuteUpdate(sqlinsert.c_str());
  stmt->PrintExceptions();
  
  Int_t ninsertv = stmt->ExecuteUpdate(sqlinsertv.c_str());
  stmt->PrintExceptions();
  
  MSG("Dbu",Msg::kVerbose)
    << sqlinsert.c_str() << endl;
  MSG("Dbu",Msg::kVerbose)
    << sqlinsertv.c_str() << endl;
  
  char tmpbuf[1024];
  sprintf(tmpbuf,"Commit DbuDaqFileSummary %c%8.8d_%4.4d",
          Detector::AsString(fDetector)[0],fRun,fSubRun);

  MSG("Dbu",Msg::kDebug) 
    << tmpbuf
    //<< " Cbits " << fCurrentSubRun->fConsistency 
    << " rm/in " 
    << nrm << "," << nrmv << "/"
    << ninsert << "," << ninsertv 
    << endl;

  logDebug(1,"%s rm=%d,%d in=%d,%d @ %s",
           tmpbuf,nrm,nrmv,ninsert,ninsertv,now.AsString("s"));
  
  bool success = (ninsert==1) && (ninsertv==1);
  
  // done protecting ODBC code against signals
  DbuSignalHandler::Instance().HandleDelayedSignal();


  //rwh!
  MSG("Dbu",Msg::kVerbose)
    << "DbuDaqFileSummary::Commit " << endl << *this << endl;

  return success;
}

//.....................................................................

void DbuDaqFileSummary::FillMapFromString(const string& rstring) {
//
//
//  Purpose:  
//
//  Arguments: 
//    xxxxxxxxx    in    yyyyyy
//
//  Return:    
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//
//  o 

//  Program Notes:-
//  =============

//  Two step dance:
//    2) fill Registry from string
//    1) fill map from Registry

  fBlockCount.clear();  // clear it out first

  Registry reg;
  reg.UnLockKeys();
  reg.UnLockValues();
  reg.Clear();
  istringstream is(rstring);
  reg.ReadStream(is);
  reg.LockKeys();
  reg.LockValues();

  // unsigned int n = reg.Size();

  Registry::RegistryKey rk = reg.Key();
  const char* keyname;
  while ( ( keyname = rk() ) ) {
    string blkName = keyname;
    string valType = reg.GetType(keyname).name();
    if ( "i" != valType ) {  // this may be platform dependent!
      MSG("Dbu",Msg::kWarning)
        << "BlockCount string had non-int entry: key='"
        << blkName << "' value-type='" << valType << "'" << endl;
      continue;  // skip on
    }
    fBlockCount[blkName] = reg.GetInt(keyname);
  }

}

//.....................................................................

void DbuDaqFileSummary::GetStringFromMap(string& rstring) const {
//
//
//  Purpose:  
//
//  Arguments: 
//    xxxxxxxxx    in    yyyyyy
//
//  Return:    
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//
//  o 

//  Program Notes:-
//  =============

//  Two step dance:
//    1) fill Registry from map
//    2) fill string from Registry

  Registry reg;
  reg.SetName("BlockCount");
  std::map<string,int>::const_iterator mapItr = fBlockCount.begin();
  while (mapItr != fBlockCount.end()) {
    string blkName = mapItr->first;
    int    blkCnt  = mapItr->second;
    reg.Set(blkName.c_str(),blkCnt);
    mapItr++;  // move on
  }
  reg.LockKeys();
  reg.LockValues();

  ostringstream os;
  reg.PrintStream(os);

  rstring = os.str();

}

/*    Template for New Member Function

//.....................................................................

DbuDaqFileSummary:: {
//
//
//  Purpose:  
//
//  Arguments: 
//    xxxxxxxxx    in    yyyyyy
//
//  Return:    
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//
//  o 

//  Program Notes:-
//  =============

//  None.


}

*/

---