CounterSvc.cpp

Go to the documentation of this file.

// ============================================================================
// STD & SLT
// ============================================================================
#include <utility>
#include <vector>
#include <algorithm>
#include <functional>
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/ICounterSvc.h"
#include "GaudiKernel/ISvcLocator.h"
#include "GaudiKernel/MsgStream.h"
#include "GaudiKernel/Service.h"
#include "GaudiKernel/HashMap.h"
#include "GaudiKernel/Stat.h"
// ============================================================================
class CounterSvc: public extends1<Service, ICounterSvc> {
public:
  CounterSvc ( const std::string& name   ,
               ISvcLocator*       svcLoc )
    : base_class(name, svcLoc)
    , m_counts ()
    , m_print  ( true )
    //
    // the header row
    , m_header  ( "       Counter :: Group         |     #     |    sum     | mean/eff^* | rms/err^*  |     min     |     max     |")
    // format for regular statistical printout rows
    , m_format1 ( " %|15.15s|%|-15.15s|%|32t||%|10d| |%|11.7g| |%|#11.5g| |%|#11.5g| |%|#12.5g| |%|#12.5g| |"         )
    // format for "efficiency" statistical printout rows
    , m_format2 ( "*%|15.15s|%|-15.15s|%|32t||%|10d| |%|11.5g| |(%|#9.7g| +- %|-#9.7g|)%%|   -------   |   -------   |" )
    // flag to use the special "efficiency" format
    , m_useEffFormat ( true )
    //
  {
    declareProperty ("PrintStat" , m_print ) ;
    //
    declareProperty
      ( "StatTableHeader"        , m_header                          ,
        "The header row for the output Stat-table"                   ) ;
    //
    declareProperty
      ( "RegularRowFormat"       , m_format1                         ,
        "The format for the regular row in the output Stat-table"    ) ;
    //
    declareProperty
      ( "EfficiencyRowFormat"    , m_format2                         ,
        "The format for the regular row in the outptu Stat-table"    ) ;
    //
    declareProperty
      ( "UseEfficiencyRowFormat" , m_useEffFormat                    ,
        "Use the special format for printout of efficiency counters" ) ;
  }
  virtual ~CounterSvc() { remove().ignore() ; }
  virtual StatusCode finalize()
  {
    if ( outputLevel() <= MSG::DEBUG || m_print ) { print () ; }
    remove().ignore() ;
    // finalize the base class
    return Service::finalize() ; 
  }
  // ==========================================================================
  virtual Counter* get
  ( const std::string& group ,
    const std::string& name  ) const;
  virtual ICounterSvc::Counters get ( const std::string& group ) const ;
  virtual StatusCode create
  ( const std::string& group ,
    const std::string& name  ,
    longlong initial_value   ,
    Counter*& refpCounter    ) ;
  virtual CountObject create
  ( const std::string& group    ,
    const std::string& name     ,
    longlong initial_value = 0  ) ;
  virtual StatusCode remove
  ( const std::string& group ,
    const std::string& name  ) ;
  virtual StatusCode remove
  ( const std::string& group ) ;
  virtual StatusCode remove();
  virtual StatusCode print
  ( const std::string& group,
    const std::string& name,
    Printout& printer) const;
  virtual StatusCode print
  (const std::string& group,
   Printout& printer) const;
  virtual StatusCode print
  ( const Counter* pCounter,
    Printout& printer) const;
  virtual StatusCode print
  ( const CountObject& pCounter,
    Printout& printer) const;
  virtual StatusCode print(Printout& printer) const;
  virtual StatusCode defaultPrintout
  ( MsgStream& log,
    const Counter* pCounter) const ;
private:
  // find group/name for the counter:
  inline std::pair<std::string,std::string> _find ( const Counter* c ) const
  {
    if ( c ) {
        for ( const auto& i : m_counts ) {
          auto j = std::find_if( i.second.begin(), i.second.end(),
                                 [&](const NameMap::value_type& k) {
                                     return k.second == c;
          });
          if (j!=i.second.end()) return { i.first, j->first } ;
        }
    }
    return { };
  }
  // get the overall number of counters
  inline size_t num () const
  {
    return std::accumulate( m_counts.begin(), m_counts.end(), size_t{0},
                 [](size_t r, const CountMap::value_type& i) {
                     return r + std::count_if(i.second.begin(),i.second.end(),
                                              [](const NameMap::value_type& j) -> bool { return j.second; });
                 });
  }
public:
  void print () const ;
private:
  typedef GaudiUtils::HashMap<std::string,Counter*> NameMap  ;
  typedef GaudiUtils::HashMap<std::string,NameMap>  CountMap ;
  // the actual map of counters
  CountMap m_counts ; 
  // boolean flag to print statistics
  bool     m_print  ; 
  // the header row
  std::string    m_header  ; 
  // format for regular statistical printout rows
  std::string    m_format1 ; 
  // format for "efficiency" statistical printout rows
  std::string    m_format2 ; 
  // flag to use the special "efficiency" format
  bool           m_useEffFormat ; 
} ;
// ===========================================================================
// Instantiation of a static factory class used by clients
// ===========================================================================
DECLARE_COMPONENT(CounterSvc)
// ===========================================================================
// Access a counter object by name and group
// ===========================================================================
CounterSvc::Counter* CounterSvc::get
( const std::string& grp  ,
  const std::string& nam  ) const
{
  auto i = m_counts.find  ( grp ) ;
  if (  m_counts.end() == i ) { return nullptr ; }              // RETURN
  auto  j = i->second.find ( nam ) ;
  if ( i->second.end() == j ) { return nullptr ; }              // RETURN
  return j->second ;                                            // RETURN
}
// ===========================================================================
// get all counters form the given group:
// ===========================================================================
ICounterSvc::Counters CounterSvc::get ( const std::string& group ) const
{
  ICounterSvc::Counters result ;
  auto i = m_counts.find  ( group ) ;
  if (  i != m_counts.end() ) {
    std::transform( i->second.begin(), i->second.end(),
                    std::back_inserter(result),
                    [&](const NameMap::value_type& j) {
        return CountObject{ j.second, i->first, j.first };
    } );
  }
  return result ;
}
// ===========================================================================
// Create/get a counter object.
// ===========================================================================
#ifdef __ICC
// disable icc remark #2259: non-pointer conversion from "longlong={long long}" to "double" may lose significant bits
#pragma warning(push)
#pragma warning(disable:2259)
#endif
StatusCode CounterSvc::create
( const std::string& grp ,
  const std::string& nam ,
  longlong initial_value ,
  Counter*& refpCounter  )
{
  // try to find existing counter:
  refpCounter = get ( grp , nam ) ;
  if ( refpCounter ) { return COUNTER_EXISTS ; }                // RETURN
  // create the new counter
  Counter* newc = new Counter() ;
  refpCounter = newc ;
  if ( 0 != initial_value ) {
    refpCounter->addFlag ( static_cast<double>(initial_value) ) ; // icc remark #2259
  }
  // find a proper group
  auto i = m_counts.find  ( grp ) ;
  // (create a group if needed)
  if (  m_counts.end() == i )
  { i = m_counts.emplace ( grp , NameMap() ).first ; }
  // insert new counter with proper name into proper group:
  i->second.emplace( nam , newc );
  return StatusCode::SUCCESS ;                                     // RETURN
}
#ifdef __ICC
// re-enable icc remark #2259
#pragma warning(pop)
#endif
// ===========================================================================
// Create a new counter object. If the counter object exists already,
// ===========================================================================
CounterSvc::CountObject CounterSvc::create
( const std::string& group ,
  const std::string& name  ,
  longlong initial_value   )
{
  Counter* p = nullptr;
  StatusCode sc = create ( group, name, initial_value, p ) ;
  if ( sc.isSuccess() && 0 != p ) { return CountObject ( p , group , name ) ; }
  throw std::runtime_error("CounterSvc::Counter('"+group+"::"+name+"') exists already!");
}
// ===========================================================================
// Remove a counter object. The tuple (group,name) identifies the counter uniquely
// ===========================================================================
StatusCode CounterSvc::remove
( const std::string& grp ,
  const std::string& nam )
{
  auto i = m_counts.find  ( grp ) ;
  if (  m_counts.end() == i ) { return COUNTER_NOT_PRESENT ; }  // RETURN
  auto  j = i->second.find ( nam ) ;
  if ( i->second.end() == j ) { return COUNTER_NOT_PRESENT ; }  // RETURN
  delete j->second ;
  i->second.erase ( j ) ;
  return StatusCode::SUCCESS ;
}
// ===========================================================================
// Remove a group of counter objects.
// ===========================================================================
StatusCode CounterSvc::remove ( const std::string& grp )
{
  auto i = m_counts.find ( grp  ) ;
  if (  m_counts.end() == i ) { return COUNTER_NOT_PRESENT ; }  // RETURN
  for ( auto& j : i->second ) delete j.second ;
  i->second.clear() ;
  return StatusCode::SUCCESS ;
}
// ===========================================================================
// Remove all known counter objects
// ===========================================================================
StatusCode CounterSvc::remove()
{
  // remove group by group
  for ( auto& i : m_counts ) remove ( i.first ).ignore () ;
  m_counts.clear() ;
  return StatusCode::SUCCESS;
}
// ===========================================================================
// Print counter value
// ===========================================================================
StatusCode CounterSvc::print
( const std::string& grp,
  const std::string& nam,
  Printout& printer) const
{
  const Counter* c = get( grp , nam ) ;
  if ( !c ) { return COUNTER_NOT_PRESENT ; }                  // RETURN
  // create the stream and use it!
  MsgStream log ( msgSvc() , name() ) ;
  return printer ( log , c ) ;
}

namespace {
  class conditionalPrint {
  private:
    CounterSvc::Printout *printer;
    MsgStream *log;
  public:
    conditionalPrint(CounterSvc::Printout &_p, MsgStream &_l): printer(&_p), log(&_l) {}
    template<class Pair>
    void operator() (const Pair &p) {
      if (p.second) {
        (*printer)(*log, p.second).ignore();
      }
    }
  };
}
// ===========================================================================
// Print the counter value for the whole group of counters
// ===========================================================================
StatusCode CounterSvc::print
( const std::string& grp ,
  Printout& printer      ) const
{
  auto i = m_counts.find ( grp ) ;
  if ( m_counts.end() == i ) { return COUNTER_NOT_PRESENT ; }

  MsgStream log(msgSvc(), name());
  // Force printing in alphabetical order
  std::map<std::string, Counter*> sorted_map(i->second.begin(), i->second.end());
  std::for_each(sorted_map.begin(), sorted_map.end(),
                conditionalPrint(printer, log));
  return StatusCode::SUCCESS;   // RETURN
}
// ===========================================================================
// Print counter value
// ===========================================================================
StatusCode CounterSvc::print
( const Counter* pCounter,
  Printout& printer ) const
{
  MsgStream log(msgSvc(), name() ) ;
  return printer ( log , pCounter ) ;
}
// ===========================================================================
// Print counter value
// ===========================================================================
StatusCode CounterSvc::print
( const CountObject& refCounter,
  Printout& printer) const
{ return print( refCounter.counter() , printer ) ; }
// ===========================================================================
// Print all known counters
// ===========================================================================
StatusCode CounterSvc::print( Printout& printer ) const
{
  MsgStream log ( msgSvc() , name() ) ;
  // Force printing in alphabetical order
  std::map<std::pair<std::string,std::string>, Counter*> sorted_map;
  for ( const auto& i : m_counts ) for ( const auto&  j : i.second )
      sorted_map[ { i.first, j.first } ] = j.second;
  std::for_each(sorted_map.begin(), sorted_map.end(),
                conditionalPrint(printer, log));
  return StatusCode::SUCCESS;
}
// ===========================================================================
// Print counter value
// ===========================================================================
StatusCode CounterSvc::defaultPrintout
( MsgStream& log,
  const Counter* c ) const
{
  if ( !c ) { return StatusCode::FAILURE ; }
  auto p = _find ( c ) ;

  log << MSG::ALWAYS
      << CountObject( const_cast<Counter*>(c) , p.first , p.second )
      << endmsg ;

  return StatusCode::SUCCESS;
}
// ===========================================================================
// "standard" printout a'la GaudiCommon
// ===========================================================================
void CounterSvc::print () const
{
  MsgStream log ( msgSvc() , name() ) ;
  // number of counters
  const auto _num = num() ;
  if ( 0 != _num )
  {
    log << MSG::ALWAYS
        << "Number of counters : "  << _num << endmsg
        << m_header << endmsg ;
  }
  // Force printing in alphabetical order
  std::map<std::pair<std::string,std::string>, Counter*> sorted_map;
  for ( const auto& i : m_counts ) {
    for ( const auto& j : i.second ) {
      if ( j.second ) sorted_map[ {i.first, j.first} ] = j.second;
    }
  }
  for ( const auto& i : sorted_map ) {
    log << Gaudi::Utils::formatAsTableRow( i.first.second
                                         , i.first.first
                                         , *i.second
                                         , m_useEffFormat
                                         , m_format1
                                         , m_format2 )
        << endmsg ;
  }
}
// ============================================================================

// ============================================================================
// The END
// ============================================================================