MemStatAuditor.cpp

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2024 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
 
#include "CommonAuditor.h"
#include "ProcStats.h"
#include <GaudiKernel/IChronoStatSvc.h>
#include <GaudiKernel/MsgStream.h>
#include <GaudiKernel/Stat.h>
 
class MemStatAuditor : public CommonAuditor {
public:
  using CommonAuditor::CommonAuditor;
 
  StatusCode initialize() override;
 
  void i_before( CustomEventTypeRef /*evt*/, std::string_view /*caller*/ ) override {
    // It's not interesting to monitor the memory usage before the methods.
  }
 
  void i_after( CustomEventTypeRef evt, std::string_view caller, const StatusCode& ) override {
    i_printinfo( "Memory usage has changed after", evt, caller );
  }
 
private:
  void                    i_printinfo( std::string_view msg, CustomEventTypeRef evt, std::string_view caller );
  SmartIF<IChronoStatSvc> m_stat;
 
  double m_vSize = -1;
};
 
DECLARE_COMPONENT( MemStatAuditor )
 
StatusCode MemStatAuditor::initialize() {
  return CommonAuditor::initialize().andThen( [&]() -> StatusCode {
    m_stat = serviceLocator()->service( "ChronoStatSvc" );
    if ( !m_stat ) {
      error() << "Cannot get ChronoStatSvc" << endmsg;
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  } );
}
 
void MemStatAuditor::i_printinfo( std::string_view msg, CustomEventTypeRef evt, std::string_view caller ) {
  // cannot be exactly 0
  double deltaVSize = 0.00001;
 
  if ( procInfo pInfo; ProcStats::instance()->fetch( pInfo ) ) {
 
    if ( pInfo.vsize > 0 ) {
      if ( m_vSize > 0 ) { deltaVSize = pInfo.vsize - m_vSize; }
      // store the current VSize to be able to monitor the increment
      m_vSize = pInfo.vsize;
    }
 
    info() << msg << " " << caller << " " << evt << " \tvirtual size = " << pInfo.vsize << " MB"
           << " \tresident set size = " << pInfo.rss << " MB"
           << " deltaVsize = " << deltaVSize << "  MB" << endmsg;
  }
  // fill the stat for every call, not just when there is a change
  // only monitor the increment in VSize
  // Stat stv(m_stat, caller + ":VMemUsage", pInfo.vsize);
  // Stat str(m_stat, caller + ":RMemUsage", pInfo.rss);
  Stat sts( m_stat, std::string{ caller }.append( ":VMem" ), deltaVSize );
}