DbiCache.cxx

Go to the documentation of this file.

// $Id: DbiCache.cxx,v 1.25 2006/08/08 10:51:32 west Exp $

#include "DatabaseInterface/DbiCache.h"
#include "DatabaseInterface/DbiResult.h"
#include "DatabaseInterface/DbiResultKey.h"
#include "DatabaseInterface/DbiResultNonAgg.h"
#include "DatabaseInterface/DbiSimFlagAssociation.h"
#include "DatabaseInterface/DbiValidityRec.h"
#include "LeakChecker/Lea.h"
#include "MessageService/MsgFormat.h"
#include "MessageService/MsgService.h"
#include "Validity/VldContext.h"

ClassImp(DbiCache)

// Typedefs

  typedef DbiCache::ResultList_t ResultList_t;
  typedef map<Int_t,ResultList_t>::const_iterator ConstCacheItr_t;
  typedef map<Int_t,ResultList_t>::iterator CacheItr_t;
  typedef ResultList_t::const_iterator ConstSubCacheItr_t;
  typedef ResultList_t::iterator SubCacheItr_t;


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

CVSID("$Id: DbiCache.cxx,v 1.25 2006/08/08 10:51:32 west Exp $");

//    Definition of all member functions (static or otherwise)
//    *******************************************************
//
//    -  ordered: ctors, dtor, operators then in alphabetical order.



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

DbiCache::DbiCache(DbiTableProxy& qp,const string& tableName) :
fTableProxy(qp),
fTableName(tableName),
fCurSize(0),
fMaxSize(0),
fNumAdopted(0),
fNumReused(0)
{
//
//
//  Purpose:  Constructor
//
//  Arguments:   
//             in  qp         Owning DbiTableProxy.
//             in  tableName  Name of associated table
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Create empty cache.


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

//  None.

  LEA_CTOR    //Leak Checker

  MSG("Dbi", Msg::kVerbose) << "Creating DbiCache" << endl;

}

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

DbiCache::~DbiCache() {
//
//
//  Purpose: Destructor
//
//  Arguments: 
//    None.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Destroy cache and all owned DbiResults.


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

//  None.

  LEA_DTOR    //Leak Checker

  MSG("Dbi", Msg::kVerbose) << "Destroying DbiCache" << endl;

  // Purge the AggNo == -1 cache before deleting.  For extended
  // context queries it can have DbiResultAggs that are clients of 
  // DbiResultNonAggs in the same cache, so purging will remove clientless
  // DbiResultAggs which should in turn make their DbiResultNonAggs 
  // clientless.
  if ( this->GetSubCache(-1) ) this->Purge(fCache[-1]);

  for ( CacheItr_t itr = fCache.begin(); itr != fCache.end(); ++itr) {
    ResultList_t& subCache = itr->second;
    for ( SubCacheItr_t sitr = subCache.begin();
          sitr != subCache.end();
          ++sitr) delete *sitr;
  }

}

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

void DbiCache::Adopt(DbiResult* res,bool registerKey) {
//
//
//  Purpose:  Adopt and own a DbiResult
//
//  Arguments: 
//    res          in    The DbiResiult to be adopted.
//    registerKey  in    If true, register key with DbiRecord.
//
//  Return:  None.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Create new sub-cache for aggregate if necessary.
//
//  o Purge sub-cache of unwanted data and adopt new result.

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

//  New entries are added to the end of the sub-cache unwanted entries
//  are always removed from the beginning so sub-cache is a FIFO.

  if ( ! res ) return;
  int aggNo = res->GetValidityRec().GetAggregateNo();

//  Prime sub-cache if necessary.
  if ( ! this->GetSubCache(aggNo) ) {
    ResultList_t emptyList;
    fCache[aggNo] = emptyList;
  }

//  Purge expired entries and add new result to cache.
  ResultList_t& subCache = fCache[aggNo];
  Purge(subCache, res);
  subCache.push_back(res);
  ++fCurSize;
  ++fNumAdopted;
  MSG("Dbi",Msg::kDebug) << "Adopting result for " << res->TableName()
                         << "  " <<   res->GetValidityRecGlobal() 
                         << "\nCache size now " << fCurSize << endl;
  if ( fCurSize > fMaxSize ) fMaxSize = fCurSize;
  // If required register key with DbiRecord
  if ( registerKey ) {
    res->RegisterKey();
    MSG("Dbi",Msg::kInfo) << "Caching new results: ResultKey: " <<  *res->GetKey();
  }
}

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

const ResultList_t* DbiCache::GetSubCache(Int_t aggNo) const {
//
//
//  Purpose:  Return sub-cache for aggregate or 0 if none..

  ConstCacheItr_t itr = fCache.find(aggNo);
  return ( itr == fCache.end() ) ? 0 : &itr->second;

}

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

void DbiCache::Purge() {
//
//
//  Purpose: Purge all sub-caches. 
//
//  Arguments:  None.
//
//  Return:   None. 
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Purge all sub_caches.

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

//  The first sub-cached to be purged must be sub-cache -1 as
//  its members may be aggregated and consequently will be
//  connected to members in other caches.



  for ( CacheItr_t itr = fCache.begin(); itr != fCache.end(); ++itr
      ) Purge(itr->second);

}
//.....................................................................

void DbiCache::Purge(ResultList_t& subCache, const DbiResult* res) {
//
//
//  Purpose: Purge surplus sub-cache memebers. 
//
//  Arguments:
//    subCache   in/out  The sub-cache to be purged
//    res        in      Optional DbiResult (default =0)
//
//  Return:   None. 
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Purge surplus sub-cache members i.e. those without clients.
//
//  o If a DbiResult is supplied, only purge entries that have
//    expired relative to it or are stale.

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

//  Passing a DbiResult allows the sub-cache to hold entries
//  for different detector types, simulation masks and tasks.

    for ( SubCacheItr_t itr = subCache.begin(); itr != subCache.end(); ) {
    DbiResult* pRes = *itr;

     if (      pRes->GetNumClients() == 0 
          && (    ! res 
               || pRes->CanDelete(res)  ) ) {

      MSG("Dbi",Msg::kDebug) << "Purging " << pRes->GetValidityRec()
                             << " from " << pRes->TableName() 
                             << " cache. Cache size now " 
                             << fCurSize-1 << endl;
      delete pRes;
//    Erasing increments iterator.
      itr = subCache.erase(itr);
      --fCurSize;

    }
    else {
      ++itr;
    }
  }

}
//.....................................................................

const DbiResult* DbiCache::Search(const DbiValidityRec& vrec,
                                  const string& sqlQualifiers) const {
//
//
//  Purpose:  Search sub-cache for DbiResult set matching a DbiValidityRec. 
//            with an optional sqlQualifiers string.
//  Return:   Pointer to matching DbiResult, or = 0 if none. 


  Int_t aggNo = vrec.GetAggregateNo();

  MSG("Dbi",Msg::kSynopsis) << "Secondary cache search of table " << fTableName
                         << " for  " << vrec
                            << (sqlQualifiers != "" ? sqlQualifiers : "" ) << endl;
  const ResultList_t* subCache = this->GetSubCache(aggNo);
  if ( ! subCache ) {
    MSG("Dbi",Msg::kSynopsis) << "Secondary cache search failed." << endl;
    return 0;
  }

  ConstSubCacheItr_t itrEnd = subCache->end();
  for ( ConstSubCacheItr_t itr = subCache->begin();
        itr != itrEnd;
        ++itr) {
    DbiResult* res = *itr;
    if ( res->Satisfies(vrec,sqlQualifiers) ) {
      fNumReused += res->GetNumAggregates();
      MSG("Dbi",Msg::kSynopsis) << "Secondary cache search succeeded.  Result set no. of rows: " 
                                << res->GetNumRows() << endl;
      return res;
    }
  }

  MSG("Dbi",Msg::kSynopsis) << "Secondary cache search failed." << endl;
  return 0;
}

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

const DbiResult* DbiCache::Search(const VldContext& vc,
                                  const Dbi::Task& task ) const {
//
//
//  Purpose:  Search primary cache for DbiResult set matching a new query. 
//
//  Arguments: 
//    vc           in    Context of new query
//    task         in    Task of new query
//
//  Return:   Pointer to matching DbiResult, or = 0 if none. 

  MSG("Dbi",Msg::kSynopsis) << "Primary cache search of table " << fTableName
                         << " for  " << vc
                         << " with task " << task << endl;
  const ResultList_t* subCache = this->GetSubCache(-1);
  if ( ! subCache ) {
    MSG("Dbi",Msg::kSynopsis) << "Primary cache search failed - sub-cache -1 is empty" << endl;
    return 0;
  }

  // Loop over all possible SimFlag associations.

  Detector::Detector_t     det(vc.GetDetector());
  SimFlag::SimFlag_t       sim(vc.GetSimFlag());
  VldTimeStamp              ts(vc.GetTimeStamp());

  DbiSimFlagAssociation::SimList_t simList 
                  = DbiSimFlagAssociation::Instance().Get(sim);

  DbiSimFlagAssociation::SimList_t::iterator listItr    = simList.begin();
  DbiSimFlagAssociation::SimList_t::iterator listItrEnd = simList.end();
  while ( listItr !=  listItrEnd ) {

    SimFlag::SimFlag_t simTry = *listItr;
    VldContext vcTry(det,simTry,ts);

    MSG("Dbi",Msg::kDebug) << "  Searching cache with SimFlag: "
                           << SimFlag::AsString(simTry) << endl;
    for ( ConstSubCacheItr_t itr = subCache->begin();
          itr != subCache->end();
          ++itr) {
      DbiResult* res = *itr;
      if ( res->Satisfies(vcTry,task) ) {
        fNumReused += res->GetNumAggregates();
        MSG("Dbi",Msg::kSynopsis) << "Primary cache search succeeded. Result set no. of rows: " 
                                  << res->GetNumRows() << endl; 
        return res;
      }
    }

  MSG("Dbi",Msg::kSynopsis) << "Primary cache search failed." << endl;
  ++listItr;
  }

  return 0;
}
//.....................................................................

const DbiResult* DbiCache::Search(const string& sqlQualifiers) const {
//
//
//  Purpose:  Search primary cache for DbiResult set matching a new query. 
//
//  Arguments: 
//    sqlQualifiers  in  The SQL qualifiers (context-sql;data-sql;fill-options)
//
//  Return:   Pointer to matching DbiResult, or = 0 if none. 

  MSG("Dbi",Msg::kSynopsis) << "Primary cache search of table " << fTableName
                         << " for  SQL " << sqlQualifiers << endl;
  const ResultList_t* subCache = this->GetSubCache(-1);
  if ( ! subCache ) {
    MSG("Dbi",Msg::kSynopsis) << "Primary cache search failed" << endl;
    return 0;
  }
  for ( ConstSubCacheItr_t itr = subCache->begin();
        itr != subCache->end();
        ++itr) {
    DbiResult* res = *itr;
    if ( res->Satisfies(sqlQualifiers) ) {
      fNumReused += res->GetNumAggregates();
      MSG("Dbi",Msg::kSynopsis) << "Primary cache search succeeded Result set no. of rows: " 
                                << res->GetNumRows() << endl;
      return res;
    }
  }
  MSG("Dbi",Msg::kSynopsis) << "Primary cache search failed" << endl;
  return 0;
}

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

void DbiCache::SetStale() {
//
//
//  Purpose: Set all entries in the cache as stale i.e. don't reuse. 
//
//  Arguments: None
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Set all entries in the cache as stale i.e. don't reuse. 

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

//  This member function can be used to effectively clear the cache.
//  As existing DbiResult objects currently in the cache may currently
//  have clients, its not possible simply to delete them, so instead
//  this function marks them as stale so they will not be reused and
//  will eventually be dropped once all their clients have disconnected.


  for ( CacheItr_t cacheItr = fCache.begin(); 
        cacheItr != fCache.end(); 
        ++cacheItr
        ) {
    ResultList_t& subcache = cacheItr->second;

    for ( SubCacheItr_t subcacheItr = subcache.begin(); 
          subcacheItr != subcache.end();
          ++subcacheItr ) (*subcacheItr)->SetCanReuse(kFALSE);
  }

}

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

MsgStream& DbiCache::ShowStatistics(MsgStream& msg) const {
//
//
//  Purpose: Display statistics for cache on supplied MsgStream.  
//
//  Arguments: 
//    msg          in    MsgStream to output on.
//
//  Return: Updated MsgStream. 
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Output : Current Size, Max size, Adopted and Resused as
//             4 10 character wide fields.

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

//  None.

  MsgFormat ifmt("%10i");

  msg << ifmt(fCurSize) << ifmt(fMaxSize) 
      << ifmt(fNumAdopted) << ifmt(fNumReused);
  return msg;

}

/*    Template for New Member Function

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

DbiCache:: {
//
//
//  Purpose:  
//
//  Arguments: 
//    xxxxxxxxx    in    yyyyyy
//
//  Return:    
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o 

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

//  None.


}

*/

---