RootPerfMonSvc.h

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.                                             *
\***********************************************************************************/
//====================================================================
//  RootPerfMonSvc definition
//--------------------------------------------------------------------
//
//  Author     : M.Frank
//====================================================================
#pragma once
 
#include <memory>
// Framework include files
#include <GaudiKernel/IIncidentListener.h>
#include <GaudiKernel/IIncidentSvc.h>
#include <GaudiKernel/Service.h>
 
#include <TFile.h>
#include <TTree.h>
 
#include <RootCnv/SysProcStat.h>
 
// C/C++ include files
#include <set>
 
/*
 * Gaudi namespace declaration
 */
namespace Gaudi {

  class GAUDI_API RootPerfMonSvc : public extends<Service, IIncidentListener> {
  protected:
    Gaudi::Property<std::string> m_ioPerfStats{
        this, "IOPerfStats", "", "Enable TTree IOperfStats if not empty; otherwise perf stat file name" };
    // Passed parameters
    Gaudi::Property<std::string> m_setStreams{ this, "Streams", "", "" };
    Gaudi::Property<std::string> m_basketSize{ this, "BasketSize", "", "" };
    Gaudi::Property<std::string> m_bufferSize{ this, "BufferSize", "", "" };
    Gaudi::Property<std::string> m_splitLevel{ this, "SplitLevel", "", "" };

    SmartIF<IIncidentSvc> m_incidentSvc;
    std::unique_ptr<MsgStream> m_log;
    // Reference to a tree with statistics
    TTree* m_perfTree;
    // Reference to a file where statistics are persisted
    std::unique_ptr<TFile> m_perfFile;
    // Reference to all connected output files
    std::set<std::string> m_outputs;
    // The newest observed values
    Int_t   m_eventType;
    ULong_t m_utime, m_stime, m_vsize;
    Long_t  m_eventNumber, m_rss, m_time;
 
    // Types of records
    enum EventType { EVENT = 1, FSR = 2 };
 
    // Adding newest observed values to the tree with statistics
    virtual void record( EventType eventType );

    MsgStream& log() const { return *m_log; }
 
  public:
    using extends::extends;

    StatusCode error( const std::string& msg );

    StatusCode initialize() override;

    StatusCode finalize() override;

    void handle( const Incident& incident ) override;
 
    // Service overload: Stop the service
    StatusCode stop() override;
  };
} // namespace Gaudi