In This Package:

DybDataSvc.cpp

Go to the documentation of this file.

#define  DYBSVC_DYBDATASVC_CPP

#include "GaudiKernel/DataObject.h"
#include "GaudiKernel/GaudiException.h"
#include "GaudiKernel/IConversionSvc.h"
#include "GaudiKernel/IOpaqueAddress.h"
#include "GaudiKernel/IRegistry.h"
#include "GaudiKernel/ISvcLocator.h"
#include "GaudiKernel/RegistryEntry.h"
#include "GaudiKernel/SvcFactory.h"
#include "GaudiKernel/MsgStream.h"

#include "DataUtilities/DybArchiveList.h"
#include "Event/RegistrationSequence.h"
#include "DybDataSvc.h"

// If you absolutely need optimization: switch off dynamic_cast.
// This improves access to the data store roughly by 10 %
// for balanced trees.
//
// M.Frank
#define CAST_REGENTRY(x,y) dynamic_cast<x>(y)
//#define CAST_REGENTRY(x,y) (x)(y)
typedef DataSvcHelpers::RegistryEntry RegEntry;

DybDataSvc::DybDataSvc(const std::string& name,
                       ISvcLocator* svc)
    : DataSvc(name,svc)
    , m_archiveSvc(0)
    , m_cnvSvc(0)
    , m_useAes(true)
{


  declareProperty("RegSeqPath",
                  m_regSeqPath=RegistrationSequence::defaultLocation(),
                  "Path, in the TES, where the RegistrationSequnce object is kept");
  declareProperty("UseAes",m_useAes,
                  "Whether or not to use the AES, default is true");
  setProperty("ForceLeaves", "true");

  {
    MsgStream log(msgSvc(), "DybDataSvc::DybDataSvc()");
    log << MSG::DEBUG
        << "initializing"
        << endreq;
  }
}

DybDataSvc::~DybDataSvc()
{
  if (0 != m_archiveSvc) {
    m_archiveSvc->release();
  }

  if (0 != m_cnvSvc) {
    m_cnvSvc->release();
  }
}

StatusCode DybDataSvc::initialize()
{
  StatusCode status  = DataSvc::initialize();
  if (status.isFailure()) {
    throw GaudiException("Could not initialize super class",
                         name(),
                         status);
  }

  MsgStream log(msgSvc(), "DybDataSvc::initialize()");
  log << MSG::DEBUG << "initializing DybDataSvc @"
      << (void*)this
      << " named " << name()
      << " UseAes is " << m_useAes
      << " ForceLeaves is " << m_forceLeaves
      << endreq;

  ISvcLocator*    svc_loc = serviceLocator();

  status = svc_loc->service("EventPersistencySvc",
                            m_cnvSvc,
                            true);
  if( status.isFailure() ) {
    throw GaudiException("Service [EventPersistencySvc] not found",
                         name(),
                         status);
  }
  status = setDataLoader( m_cnvSvc );
  if( status.isFailure() ) {
    throw GaudiException("Could not set DataLoader",
                         name(),
                         status);
  }

  log << MSG::DEBUG << "DybDataSvc @" << (void*)this
      << " has UseAes = " << m_useAes << endreq;

  if (m_useAes) {
    log << MSG::INFO
        << "Using [EvtDataSvc] as the archive service"
        << endreq;

    status = svc_loc->service("EventDataArchiveSvc", m_archiveSvc, true);
    if( status.isFailure() || !m_archiveSvc ) {
      log << MSG::ERROR << "Service [EventDataArchiveSvc] not found" << endreq;
      return status;
    }
    SmartIF<IProperty> property(m_archiveSvc);
    if (!property) {
      log << MSG::ERROR
          << "The EvtDataSvc has no property interface" << endreq;
      return StatusCode::FAILURE;
    }
    property->setProperty("ForceLeaves","true");
  }
  else {
    log << MSG::DEBUG
        << "DybDataSvc @"
        << (void*)this
        << ", not using Archive Event Store (AES)"
        << endreq;
  }
  return status;
}

StatusCode DybDataSvc::reinitialize()
{
  // Do nothing for this service
  return StatusCode::SUCCESS;
}

StatusCode DybDataSvc::finalize()
{
  if( 0 != m_archiveSvc ) {
    m_archiveSvc->release();
  }
  m_archiveSvc = 0;

  if( 0 != m_cnvSvc ) {
    m_cnvSvc->release();
  }
  m_cnvSvc = 0;

  DataSvc::finalize().ignore();
  return StatusCode::SUCCESS ;
}

IDataProviderSvc* DybDataSvc::archiveSvc() const
{
  return m_archiveSvc;
}

// Override 'setRoot' to also set the root of the Archive if not
// already set.
StatusCode DybDataSvc::setRoot(const std::string& root_path,
                               DataObject* pRootObj) {
  StatusCode result = DataSvc::setRoot(root_path,
                                       pRootObj);
  if (m_useAes) {
    DataObject* existingRoot = 0;
    archiveSvc()->retrieveObject(root_path,
                                 existingRoot).ignore();
    if ( 0 == existingRoot ) {
      IDataManagerSvc* archiveMgr = dynamic_cast<IDataManagerSvc*>(archiveSvc());
      StatusCode status = archiveMgr->setRoot(root_path,
                                              new DybArchiveList());
      if (status.isFailure()) return status;
    }
  }
  return result;
}

// Override 'setRoot' to also set the root of the Archive if not
// already set.
StatusCode DybDataSvc::setRoot(const std::string& root_path,
                               IOpaqueAddress* pRootAddr) {
  StatusCode result = DataSvc::setRoot(root_path,
                                       pRootAddr);
  if (m_useAes) {
    DataObject* existingRoot = 0;
    archiveSvc()->retrieveObject(root_path,
                                 existingRoot).ignore();
    if ( 0 == existingRoot ) {
      IDataManagerSvc* archiveMgr = dynamic_cast<IDataManagerSvc*>(archiveSvc());
      StatusCode status = archiveMgr->setRoot(root_path,
                                              new DybArchiveList());
      if (status.isFailure()) return status;
    }
  }
  return result;
}

StatusCode DybDataSvc::loadObject(IConversionSvc* pLoader,
                                  IRegistry* pRegistry) {

  {
    MsgStream log(msgSvc(), "DybDataSvc::loadObject()");
    log << MSG::DEBUG
        << "loading "<<pRegistry->identifier()
        << " with loader "<<pLoader
        << endreq;
  }
  
  StatusCode result = DataSvc::loadObject(pLoader,
                                          pRegistry);

  RegEntry *pEntry = CAST_REGENTRY(RegEntry*,pRegistry);
  DataObject* pObject = pEntry->object();

  if (0 == pObject) {
    return result;
  }

  {
    MsgStream log(msgSvc(), "DybDataSvc::loadObject()");
    log << MSG::DEBUG
        << " registry->identifier() == " << pRegistry->identifier()
        << " pObject->registry()->identifier() == " << pObject->registry()->identifier()
        << endreq;
  }

  result = sequenceObject(pObject);
  if (result.isFailure()) return result;

  if (m_useAes) {
    result = archiveObject(pObject);
  }
  return result;
}

StatusCode DybDataSvc::registerAddress(IRegistry* parentObj,
                                       const std::string& objPath,
                                       IOpaqueAddress* pAddress)
{
  MsgStream log(msgSvc(), "DybDataSvc::registerAddress()");

  StatusCode result = DataSvc::registerAddress(parentObj,
                                               objPath,
                                               pAddress);
  if (result.isFailure()) {
      return result;
  }

  // Do nothing more if there is no parent object (as this will be
  // handled later by the recursion).
  if (0 == parentObj ) {
    return result;
  }

  // Do nothing more if the object path contains a separator (as this
  // will be handled later by the recursion).
  std::string::size_type sep = objPath.find(SEPARATOR,1);
  if ( sep != std::string::npos ) {
    return result;
  }

  // Get the full path of the registered object.
  if (0 == pAddress) {
    return result;
  }

  IRegistry* entry = pAddress->registry();
  if (0 == entry) {
    return result;
  }

  if (m_useAes) {
    // Retrieve collection
    DataObject* collection=0;
    archiveSvc()->retrieveObject(entry->identifier(),
                                 collection).ignore();

    if (0 == collection) {
      StatusCode status = archiveSvc()->registerObject(entry->identifier(),
                                                       new DybArchiveList());
      if (status.isFailure()) return status;
    }
  }


  return StatusCode::SUCCESS;
}

StatusCode DybDataSvc::registerObject(DataObject* parentObj,
                                      const std::string& objPath,
                                      DataObject* pObject)
{
  MsgStream log(msgSvc(), "DybDataSvc::registerObject()");
  log << MSG::DEBUG
      << "use aes = " << m_useAes << " "
      << "parent = \"" << (parentObj ? parentObj->name() : "(none)")  << "\" "
      << "path = \"" << objPath << "\" "
      << "obj = \"" << (pObject ? pObject->name() : "(none)") << "\""
      << endreq;

  // wangzhe
  // The following part makes sure put() method can deal with TES, AES
  // smoothly. User will not worry about AES usage and unregisterObject again.
  // When the second header object comes into TES, the existing object in that 
  // path will be unregistered.
  // By doing this the last data object produced is always in TES.
  // When the event rate is low the data in TES in top stage using in Fifteen
  // is the same as push method
  if(m_useAes) {
    // This story is not about usual data object.
    if( pObject->clID() != DataObject::classID() ) {
      // If choose to use AES, firstly check whether that path exists 
      // and whether there are data object with it.
      // Because some data object might already be there.
      // If it really exists unregister it since it is in AES now.
      // It is safe to remove it from TES.
      DataObject* pEstObj=0;
      StatusCode sc = DataSvc::findObject(parentObj,objPath,pEstObj);
      if(sc.isSuccess()) {
        if(pEstObj!=0) {
          DataSvc::unregisterObject(pEstObj);
          // Why there is a release? See DocDB 3242, page 2 memo
          // Gaudi isn't perfect and has defect.
          pEstObj->release();
        }
      }
    }
  } else {
    // If AES is not chosen to use, then ignore this step.
    // For the case of only using TES, such an operation will possibly remove that
    // object from memory if there is no other place holding it.
    // From this point of view it is dangerous to unregister an object like this.
    // If user really want to register two objects in the same path,
    // it is strongly encouraged that he/she should do it by themselves.
  }
  // wz

  StatusCode result = DataSvc::registerObject(parentObj,
                                              objPath,
                                              pObject);

  // Do nothing more if there is no parent object (as this will be
  // handled later by the recursion).
  if (0 == parentObj ) {
    return result;
  }

  // Do nothing more if the object path contains a separator (as this
  // will be handled later by the recursion).
  std::string::size_type sep = objPath.find(SEPARATOR,1);
  if ( sep != std::string::npos ) {
    return result;
  }

  // Get the full path of the registered object.
  if (0 == pObject) {
    return result;
  }

  IRegistry* pRegistry = pObject->registry();
  if (0 == pRegistry) {
    return result;
  }

  result = sequenceObject(pObject);
  if (result.isFailure()) return result;

  if (m_useAes) {
    result = archiveObject(pObject);
  }
  return result;
}

StatusCode DybDataSvc::archiveObject(DataObject* pObject) {

  std::string path = pObject->registry()->identifier();

  MsgStream log(msgSvc(), "DybDataSvc::archiveObject()");

  if (!m_useAes) {
    log << MSG::ERROR << "archiveObject() called but told not to use AES"
        << endreq;
    return StatusCode::FAILURE;
  }

  if (pObject->clID() == DataObject::classID()) {
      log << MSG::DEBUG
          << "Not archiving plain DataObject at "
          << path << endreq;
      return StatusCode::SUCCESS;
  }

  // Retrieve collection and add object.
  DataObject* collection=0;
  StatusCode sc =  archiveSvc()->retrieveObject(path, collection);
  sc.ignore();
  //if (sc.isFailure()) {
  //    log << MSG::WARNING << "failed to retrieve list at "
  //        << pRegistry->identifier()
  //        << " will register new one" << endreq;
  //}

  DybArchiveList* list = 0;
  if (0 == collection) {
    list = new DybArchiveList();
    StatusCode status = archiveSvc()->registerObject(path, list);
    if (!status.isSuccess()) {
      log << MSG::WARNING << "failed to register list at "
          << path << endreq;
      return StatusCode(status.getCode(),
                        status.severity());
    }
  } else {
    list = dynamic_cast<DybArchiveList*>(collection);
  }

  list->push_front((DybArchiveList::const_reference)pObject);

  return StatusCode::SUCCESS;
}

StatusCode DybDataSvc::sequenceObject(DataObject* pObject)
{
  // Record registration sequence of this object.

  // Don't sequence base DataObject, they just make up directory structure.
  if (pObject->clID() == CLID_DataObject) return StatusCode::SUCCESS;

  MsgStream log(msgSvc(), "DybDataSvc::sequenceObject()");

  std::string path = pObject->registry()->identifier();

  // Do not sequence the RegistrationSequnce to avoid infinite loop
  if (m_regSeqPath.value() == path) {
    return StatusCode::SUCCESS;
  }

  {
      DataObject* dobj = 0;
      StatusCode sc = retrieveObject("/Event",dobj);
      if (sc.isFailure()) {
          log << MSG::ERROR << "falied to retrieve /Event" << endreq;
          return sc;
      }
      else {
          //log << MSG::INFO << "got /Event" << endreq;
      }
  }

  // Retieve registration sequence object.
  DataObject* object = 0;
  StatusCode sc = retrieveObject(m_regSeqPath.value(),object);
  sc.ignore();
  //if (sc.isFailure()) {
  //    log << MSG::WARNING << "failed to retrieve reg seq obj from "
  //        << m_regSeqPath.value() << " will register new one " << endreq;
  //}
  RegistrationSequence* regSeq = 0;
  if (0 == object) {
    regSeq = new RegistrationSequence();
    StatusCode status = registerObject(0,m_regSeqPath.value(),regSeq);
    if (!status.isSuccess()) {
      log << MSG::WARNING << "failed to register object "
          << m_regSeqPath.value() << endreq;

      return StatusCode(status.getCode(),
                        status.severity());
    }
  } else {
    regSeq = dynamic_cast<RegistrationSequence*>(object);
  }
  log << MSG::DEBUG << "inserting into RegSeq: " << path << endreq;

  regSeq->insert(pObject->registry(), pObject, true);

  return StatusCode::SUCCESS;
}

// Local Variables:
// c-basic-offset: 2
// End:

---