TrackingGeometrySvc.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/

// TrackingGeometrySvc.cxx, (c) ATLAS Detector software
 
// Trk
#include "TrkDetDescrSvc/TrackingGeometrySvc.h"
#include "TrkDetDescrInterfaces/IGeometryBuilder.h"
#include "TrkDetDescrInterfaces/IGeometryProcessor.h"
#include "TrkDetDescrUtils/BinnedArray.h"
#include "TrkGeometry/Layer.h"
#include "TrkGeometry/LayerMaterialProperties.h"
#include "TrkGeometry/TrackingGeometry.h"
#include "TrkGeometry/TrackingVolume.h"
// GaudiKernel && Control
#include "GaudiKernel/ISvcLocator.h"
#include "GaudiKernel/MsgStream.h"
#include "StoreGate/StoreGateSvc.h"
 
// monitor memory usage
#ifdef TRKDETDESCR_MEMUSAGE
#include <unistd.h>
#endif

Trk::TrackingGeometrySvc::TrackingGeometrySvc(const std::string& name, ISvcLocator* svc)
  : base_class(name, svc)
  , m_geometryProcessors(this)
{
  // geometry processors to validation / distort the TrackingGeometry ------------
  declareProperty("GeometryProcessors", m_geometryProcessors);
}

Trk::TrackingGeometrySvc::~TrackingGeometrySvc() = default;

StatusCode
Trk::TrackingGeometrySvc::initialize()
{
 
  ATH_MSG_WARNING(
    "!!! Initialization of TrackingGeometrySvc !!! The Service it to be "
    "deprecated in favour of the relevant Condition Algorithm. !!!");
  m_autoRetrieveTools = false;
  m_checkToolDeps = false;
 
  if (m_geometryProcessors.retrieve().isFailure()) {
    ATH_MSG_FATAL("Could not retrieve " << m_geometryProcessors);
    return StatusCode::FAILURE;
  }
 
  if (m_buildGeometryFromTagInfo) {
    ATH_MSG_INFO("Building Geometry from TagInfo");
    // register a callback on TagInfo updates
    ServiceHandle<ITagInfoMgr> tagInfoMgr("TagInfoMgr", name());
    ATH_CHECK(tagInfoMgr.retrieve());
    tagInfoMgr->addListener(this);
  } else {
    ATH_MSG_INFO("Building Geometry at initialisation time.");
    // build with no dependency on COOL
    if (trackingGeometryInit(false).isFailure()) {
      ATH_MSG_FATAL("Unable to build the TrackingGeometry!");
      return StatusCode::FAILURE;
    }
  }
  ATH_MSG_INFO("initialize() successful! ");
  return StatusCode::SUCCESS;
}
 
void
Trk::TrackingGeometrySvc::tagInfoUpdated()
{
  ATH_MSG_INFO("tagInfoUpdated() callback trigerred");
  trackingGeometryInit().ignore();
}
 
StatusCode
Trk::TrackingGeometrySvc::trackingGeometryInit(bool needsInit)
{
  ATH_MSG_INFO("Trk::TrackingGeometrySvc::trackingGeometryInit");
 
  SmartIF<StoreGateSvc> detStore{service("DetectorStore")};
  ATH_CHECK( detStore.isValid() );
 
  // Retrieve the tracking geometry builder tool
  // ----------------------------------------------------
  if (!m_trackingGeometryBuilder.empty() && m_trackingGeometryBuilder.retrieve().isFailure()) {
    ATH_MSG_FATAL("Failed to retrieve tool '" << m_trackingGeometryBuilder << "'. Aborting.");
    return StatusCode::FAILURE;
  } else if (m_trackingGeometryBuilder.empty()) {
    ATH_MSG_FATAL("TrackingGeometrySvc " << name()
                                         << " not properly configured. No GeometryBuilder defined. Aborting.");
    return StatusCode::FAILURE;
  } else {
    ATH_MSG_DEBUG("Retrieved tool " << m_trackingGeometryBuilder);
  }
 
  // nothing to do in this case since rerun is switched off
  if (detStore->contains<Trk::TrackingGeometry>(m_trackingGeometryName) && !m_rerunOnCallback) {
    return StatusCode::SUCCESS;
  }
 
  // only build if the callback string was true
  // (MN: I set this to alwaus true if called on TagInfo update)
  if (needsInit) {
    ATH_MSG_INFO("trackingGeometryInit - initialize on TagInfoMgr callback");
    // cleanup the geometry if you have one
    // (will delete what is in detector store, because new one will overwrite old one)
    m_trackingGeometry = nullptr;
 
#ifdef TRKDETDESCR_MEMUSAGE
    // memory monitoring
    ATH_MSG_INFO("[ memory usage ] Start to monitor memory usage of PID: " << getpid());
 
    m_memoryLogger.refresh(getpid());
    ATH_MSG_INFO(m_memoryLogger);
    // record the difference
    m_changeVsize = (-1.) * m_memoryLogger.vmSize();
    m_changeRss = (-1.) * m_memoryLogger.vmRss();
#endif
 
    // build the TrackingGeometry from the builder
    m_trackingGeometry = m_trackingGeometryBuilder->trackingGeometry().release();
 
#ifdef TRKDETDESCR_MEMUSAGE
    ATH_MSG_INFO("[ memory usage ] TrackingGeometry retrieved: ");
    m_memoryLogger.refresh(getpid());
    ATH_MSG_INFO(m_memoryLogger);
#endif
 
    // cast constness away for StoreGate
    Trk::TrackingGeometry* atlasTrackingGeometry = const_cast<Trk::TrackingGeometry*>(m_trackingGeometry);
 
    // check if a second call back has occured
    if (detStore->contains<Trk::TrackingGeometry>(m_trackingGeometryName)) {
      ATH_MSG_VERBOSE("New Callback evoked remove of existing object!");
      // you need to retrieve the object first to remove it
      const Trk::TrackingGeometry* oldTrackingGeometry = nullptr;
      if (detStore->retrieve(oldTrackingGeometry, m_trackingGeometryName).isFailure())
        ATH_MSG_WARNING("Callback evoked remove of '" << m_trackingGeometryName << "'. But retrieve did not succeed! ");
      if (oldTrackingGeometry && detStore->remove<Trk::TrackingGeometry>(oldTrackingGeometry).isFailure())
        ATH_MSG_WARNING("Callback evoked remove of '" << m_trackingGeometryName << "'. But it did not succeed!");
      // delete is safe
      delete oldTrackingGeometry;
    }
 
    // loop over the recursive geometry processors
    ToolHandleArray<Trk::IGeometryProcessor>::iterator gpIter = m_geometryProcessors.begin();
    ToolHandleArray<Trk::IGeometryProcessor>::iterator gpIterE = m_geometryProcessors.end();
    for (; gpIter != gpIterE; ++gpIter) {
      if ((*gpIter)->process(*atlasTrackingGeometry).isFailure()) {
        ATH_MSG_FATAL("Processing of TrackingGeometry did not succeed. Abort.");
        return StatusCode::FAILURE;
      } else {
        ATH_MSG_VERBOSE("Successfully processed the TrackingGeometry with " << (*gpIter));
#ifdef TRKDETDESCR_MEMUSAGE
        ATH_MSG_INFO("[ memory usage ] After processing with " << (*gpIter));
        m_memoryLogger.refresh(getpid());
        ATH_MSG_INFO(m_memoryLogger);
#endif
      }
    }
    // record the resulting TrackingGeometry
    if (detStore->record(atlasTrackingGeometry, m_trackingGeometryName, false).isFailure()) {
      ATH_MSG_WARNING("Couldn't write TrackingGeometry to DetectorStore.");
    } else {
      ATH_MSG_DEBUG("initialize() successful: TrackingGeometry '" << m_trackingGeometryName
                                                                  << "' built and written to DetectorStore.");
    }
  }
  return StatusCode::SUCCESS;
}
 
void
Trk::TrackingGeometrySvc::trackingGeometryNotSet() const
{
  ATH_MSG_WARNING("TrackingGeometry not set  ptr=" << static_cast<const void*>(m_trackingGeometry));
}

StatusCode
Trk::TrackingGeometrySvc::finalize()
{
#ifdef TRKDETDESCR_MEMUSAGE
  ATH_MSG_INFO("[ memory usage ] Change in memory usage -------------------------------- ");
  ATH_MSG_INFO("[ memory usage ]    Virtual memory change (vsize) : " << m_changeVsize);
  ATH_MSG_INFO("[ memory usage ]    Real memory change (rss)      : " << m_changeRss);
  ATH_MSG_INFO("[ memory usage ] ---------------------------------------------------------");
#endif
  ATH_MSG_INFO("finalize() successful.");
  return StatusCode::SUCCESS;
}