GoogleAuditor.cpp

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 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 <GaudiKernel/Auditor.h>
#include <GaudiKernel/GaudiException.h>
#include <GaudiKernel/IAlgorithm.h>
#include <GaudiKernel/IAuditorSvc.h>
#include <GaudiKernel/IIncidentListener.h>
#include <GaudiKernel/IIncidentSvc.h>
#include <GaudiKernel/MsgStream.h>
#include <algorithm>
#include <gperftools/heap-checker.h>
#include <gperftools/heap-profiler.h>
#include <gperftools/profiler.h>
#include <memory>
#include <string>
#include <utility>
#include <vector>
 
namespace Google {
 
  class AuditorBase : public extends<Auditor, IIncidentListener> {
 
  public:
    using extends::extends;
 
    StatusCode initialize() override {
      info() << "Initialised" << endmsg;
 
      // add a listener for begin event
      auto inSvc = serviceLocator()->service<IIncidentSvc>( "IncidentSvc" );
      if ( !inSvc ) return StatusCode::FAILURE;
      inSvc->addListener( this, IncidentType::BeginEvent );
 
      // sort various lists for speed when searching
      std::sort( m_when.begin(), m_when.end() );
      std::sort( m_veto.begin(), m_veto.end() );
      std::sort( m_list.begin(), m_list.end() );
 
      return StatusCode::SUCCESS;
    }
 
    StatusCode finalize() override {
      if ( alreadyRunning() ) stopAudit();
      return StatusCode::SUCCESS;
    }
 
  private:
    inline void startAudit() {
      info() << " -> Starting full audit from event " << m_nEvts << " to " << m_nEvts + m_nSampleEvents << endmsg;
      m_inFullAudit      = true;
      m_sampleEventCount = 1;
      std::ostringstream t;
      t << "FULL-Events" << m_nEvts << "To" << m_nEvts + m_nSampleEvents;
      google_before( t.str() );
    }
 
    inline void stopAudit() {
      info() << " -> Stopping full audit" << endmsg;
      std::ostringstream t;
      t << "FULL-Events" << m_nEvts << "To" << m_nEvts + m_nSampleEvents;
      google_after( t.str() );
      m_inFullAudit      = false;
      m_sampleEventCount = 0;
    }
 
    // Check if the component in question is a Sequencer
    inline bool isSequencer( INamedInterface* i ) const {
      if ( auto alg = dynamic_cast<IAlgorithm*>( i ) ) { return alg->isSequence(); }
      return false;
    }
 
    inline bool isPhaseEnabled( CustomEventTypeRef type ) const {
      return ( std::find( m_when.begin(), m_when.end(), type ) != m_when.end() );
    }
 
    inline bool isComponentEnabled( std::string_view name ) const {
      return ( std::find( m_veto.begin(), m_veto.end(), name ) == m_veto.end() &&
               ( m_list.empty() || std::find( m_list.begin(), m_list.end(), name ) != m_list.end() ) );
    }
 
    // Construct the dump name based on processing phase and component name
    std::string getDumpName( CustomEventTypeRef type, std::string_view name ) const {
      std::ostringstream t;
      t << name << "-" << type;
      if ( type == "Execute" ) t << "-Event" << m_nEvts;
      return t.str();
    }
 
  public:
    void handle( const Incident& incident ) override {
      if ( IncidentType::BeginEvent == incident.type() ) {
        ++m_nEvts;
        m_audit = ( m_nEvts > m_eventsToSkip && ( m_freq < 0 || m_nEvts == 1 || m_nEvts % m_freq == 0 ) );
        if ( msgLevel( MSG::DEBUG ) ) debug() << "Event " << m_nEvts << " Audit=" << m_audit << endmsg;
        if ( m_fullEventAudit ) {
          if ( m_inFullAudit ) {
            if ( m_sampleEventCount >= m_nSampleEvents && alreadyRunning() ) {
              stopAudit();
            } else {
              ++m_sampleEventCount;
            }
          }
          if ( m_audit && !m_inFullAudit && !alreadyRunning() ) { startAudit(); }
        }
      }
    }
 
  public:
    void before( StandardEventType type, INamedInterface* i ) override {
      if ( !m_skipSequencers || !isSequencer( i ) ) { before( type, i->name() ); }
    }
 
    void before( CustomEventTypeRef type, INamedInterface* i ) override {
      if ( !m_skipSequencers || !isSequencer( i ) ) { before( type, i->name() ); }
    }
 
    void before( StandardEventType type, const std::string& s ) override {
      std::ostringstream t;
      t << type;
      before( t.str(), s );
    }
 
    void before( CustomEventTypeRef type, const std::string& s ) override {
      if ( !m_fullEventAudit && m_audit && isPhaseEnabled( type ) && isComponentEnabled( s ) ) {
        if ( !alreadyRunning() ) {
          info() << "Starting Auditor for " << s << ":" << type << endmsg;
          m_startedBy = s;
          google_before( getDumpName( type, s ) );
        } else {
          warning() << "Auditor already running. Cannot be started for " << s << endmsg;
        }
      }
    }
 
    void after( StandardEventType type, INamedInterface* i, const StatusCode& sc ) override {
      if ( !m_skipSequencers || !isSequencer( i ) ) {
        std::ostringstream t;
        t << type;
        after( t.str(), i, sc );
      }
    }
 
    void after( CustomEventTypeRef type, INamedInterface* i, const StatusCode& sc ) override {
      if ( !m_skipSequencers || !isSequencer( i ) ) { after( type, i->name(), sc ); }
    }
 
    void after( StandardEventType type, const std::string& s, const StatusCode& sc ) override {
      std::ostringstream t;
      t << type;
      after( t.str(), s, sc );
    }
 
    void after( CustomEventTypeRef type, const std::string& s, const StatusCode& ) override {
      if ( !m_fullEventAudit && m_audit && isPhaseEnabled( type ) && isComponentEnabled( s ) ) {
        if ( s == m_startedBy ) { google_after( getDumpName( type, s ) ); }
      }
    }
 
  protected:
    virtual void google_before( const std::string& s ) = 0;
 
    virtual void google_after( const std::string& s ) = 0;
 
    virtual bool alreadyRunning() = 0;
 
  private:
    Gaudi::Property<std::vector<std::string>> m_when{ this,
                                                      "ActivateAt",
                                                      { "Initialize", "ReInitialize", "Execute", "Finalize" },
                                                      "List of phases to activate the Auditoring during" };
    Gaudi::Property<std::vector<std::string>> m_veto{
        this, "DisableFor", {}, "List of component names to disable the auditing for" };
    Gaudi::Property<std::vector<std::string>> m_list{
        this, "EnableFor", {}, "Any component in this list will be audited. If empty,  all will be done." };
    Gaudi::Property<int>  m_freq{ this, "ProfileFreq", -1, "The frequence to audit events. -1 means all events" };
    Gaudi::Property<bool> m_fullEventAudit{
        this, "DoFullEventProfile", false,
        "If true, instead of individually auditing components,  the full event (or events) will be audited in one go" };
    Gaudi::Property<unsigned long long> m_nSampleEvents{
        this, "FullEventNSampleEvents", 1, "The number of events to include in a full event audit,  if enabled" };
    Gaudi::Property<unsigned long long> m_eventsToSkip{ this, "SkipEvents", 0,
                                                        "Number of events to skip before activating the auditing" };
    Gaudi::Property<bool>               m_skipSequencers{ this, "SkipSequencers", true,
                                            "If true,  auditing will be skipped for Sequencer objects." };
 
    bool               m_audit = true; 
    unsigned long long m_nEvts = 0;    
    unsigned long long m_sampleEventCount =
        0;                             
    bool        m_inFullAudit = false; 
    std::string m_startedBy;           
  };
 
  class HeapProfiler : public AuditorBase {
 
  public:
    using AuditorBase::AuditorBase;
 
  protected:
    void google_before( const std::string& s ) override { HeapProfilerStart( s.c_str() ); }
 
    void google_after( const std::string& s ) override {
      if ( m_dumpProfileHeaps ) { HeapProfilerDump( s.c_str() ); }
      if ( m_printProfilesToLog ) {
        const char* profile = GetHeapProfile();
        info() << profile << endmsg;
        delete profile;
      }
      HeapProfilerStop();
    }
 
    bool alreadyRunning() override { return IsHeapProfilerRunning(); }
 
  private:
    Gaudi::Property<bool> m_dumpProfileHeaps{ this, "DumpHeapProfiles", true, "" };
    Gaudi::Property<bool> m_printProfilesToLog{ this, "PrintProfilesToLog", false, "" };
  };
 
  class HeapChecker : public AuditorBase {
 
  public:
    using AuditorBase::AuditorBase;
 
    StatusCode initialize() override {
      const StatusCode sc = AuditorBase::initialize();
      if ( sc.isFailure() ) return sc;
 
      const char* HEAPCHECK = getenv( "HEAPCHECK" );
      if ( !HEAPCHECK ) {
        fatal() << "Environment variable HEAPCHECK must be set to 'local'" << endmsg;
        return StatusCode::FAILURE;
      }
      if ( std::string( HEAPCHECK ) != "local" ) {
        warning() << "Environment variable HEAPCHECK is set to " << HEAPCHECK
                  << " Partial Program Heap Checking is disabled" << endmsg;
        m_enabled = false;
      }
 
      return sc;
    }
 
  protected:
    void google_before( const std::string& s ) override {
      if ( m_enabled && !m_checker ) { m_checker.reset( new HeapLeakChecker( s.c_str() ) ); }
    }
 
    void google_after( const std::string& s ) override {
      if ( m_enabled && m_checker ) {
        if ( !m_checker->NoLeaks() ) { warning() << "Leak detected for " << s << endmsg; }
        m_checker.reset();
      }
    }
 
    bool alreadyRunning() override { return m_enabled && m_checker; }
 
  private:
    bool                             m_enabled = true;
    std::unique_ptr<HeapLeakChecker> m_checker;
  };
 
  class CPUProfiler : public AuditorBase {
 
  public:
    using AuditorBase::AuditorBase;
 
  protected:
    void google_before( const std::string& s ) override {
      if ( !m_running ) {
        m_running = true;
        ProfilerStart( ( s + ".prof" ).c_str() );
      }
    }
 
    void google_after( const std::string& ) override {
      if ( m_running ) {
        ProfilerStop();
        m_running = false;
      }
    }
 
    bool alreadyRunning() override { return m_running; }
 
  private:
    bool m_running = false;
  };
 
  DECLARE_COMPONENT( HeapProfiler )
  DECLARE_COMPONENT( HeapChecker )
  DECLARE_COMPONENT( CPUProfiler )
} // namespace Google