MessageSvc.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.                                             *
\***********************************************************************************/
#ifdef _WIN32
// Avoid conflicts between windows and the message service.
#  define NOMSG
#  define NOGDI
#endif
 
#include "MessageSvc.h"
#include <GaudiKernel/IAppMgrUI.h>
#include <GaudiKernel/Kernel.h>
#include <GaudiKernel/Message.h>
#include <GaudiKernel/StatusCode.h>
#include <GaudiKernel/System.h>
#include <fstream>
#include <iostream>
#include <sstream>
 
namespace {
 
  // erase_if functions for containers which do NOT invalidate iterators
  // after the erase point, eg.std::{unordered_}{,multi}map, std::{forward_,}list.
  // To be explicit: this does NOT work with std::vector.
 
  // TODO: replace with std::experimental::erase_if (Libraries Fundamental TS v2)
 
  template <typename Container, typename Iterator, typename Predicate>
  void erase_if( Container& c, Iterator first, Iterator last, Predicate pred ) {
    while ( first != last ) {
      if ( pred( *first ) )
        first = c.erase( first );
      else
        ++first;
    }
  }
 
  template <typename Container, typename Iterator, typename Predicate>
  void erase_if( Container& c, std::pair<Iterator, Iterator> range, Predicate pred ) {
    return erase_if( c, std::move( range.first ), std::move( range.second ), std::forward<Predicate>( pred ) );
  }
 
  std::string colTrans( std::string_view col, int offset ) {
    int icol = ( col == "black"    ? MSG::BLACK
                 : col == "red"    ? MSG::RED
                 : col == "green"  ? MSG::GREEN
                 : col == "yellow" ? MSG::YELLOW
                 : col == "blue"   ? MSG::BLUE
                 : col == "purple" ? MSG::PURPLE
                 : col == "cyan"   ? MSG::CYAN
                 : col == "white"  ? MSG::WHITE
                                   : 8 );
    return std::to_string( icol + offset );
  }
} // namespace
 
DECLARE_COMPONENT( MessageSvc )
 
static const std::string levelNames[MSG::NUM_LEVELS] = { "NIL",     "VERBOSE", "DEBUG", "INFO",
                                                         "WARNING", "ERROR",   "FATAL", "ALWAYS" };
 
MessageSvc::MessageSvc( const std::string& name, ISvcLocator* svcloc ) : base_class( name, svcloc ) {
 
  m_outputLevel.declareUpdateHandler( [svcloc]( Gaudi::Details::PropertyBase& ) {
    SmartIF<IAppMgrUI> app = svcloc;
    if ( app ) app->outputLevelUpdate();
  } );
 
#ifndef NDEBUG
  // initialize the MsgStream static flag.
  MsgStream::enableCountInactive( m_inactCount );
#endif
 
  for ( int ic = 0; ic < MSG::NUM_LEVELS; ++ic ) {
    m_logColors[ic].declareUpdateHandler( &MessageSvc::setupColors, this );
    m_msgLimit[ic].declareUpdateHandler( &MessageSvc::setupLimits, this );
    m_thresholdProp[ic].declareUpdateHandler( &MessageSvc::setupThreshold, this );
  }
 
  m_logColors[MSG::FATAL].set( { "blue", "red" } );
  m_logColors[MSG::ERROR].set( { "white", "red" } );
  m_logColors[MSG::WARNING].set( { "yellow" } );
 
  std::fill( std::begin( m_msgCount ), std::end( m_msgCount ), 0 );
}
 
StatusCode MessageSvc::initialize() {
  StatusCode sc = Service::initialize();
  if ( sc.isFailure() ) return sc;
 
#ifdef _WIN32
  m_color = false;
#endif
 
  // make sure the map of logged stream names is initialized
  setupLogStreams();
 
  return StatusCode::SUCCESS;
}
 
StatusCode MessageSvc::reinitialize() {
  m_state       = Gaudi::StateMachine::OFFLINE;
  StatusCode sc = initialize();
  if ( sc.isSuccess() ) m_state = Gaudi::StateMachine::INITIALIZED;
 
  return sc;
}
 
void MessageSvc::setupColors( Gaudi::Details::PropertyBase& prop ) {
  const auto& pname = prop.name();
  int         level =
      ( pname == "fatalColorCode"     ? MSG::FATAL
        : pname == "errorColorCode"   ? MSG::ERROR
        : pname == "warningColorCode" ? MSG::WARNING
        : pname == "infoColorCode"    ? MSG::INFO
        : pname == "debugColorCode"   ? MSG::DEBUG
        : pname == "verboseColorCode" ? MSG::VERBOSE
        : pname == "alwaysColorCode"
            ? MSG::ALWAYS
            : ( throw GaudiException( "ERROR: Unknown message color parameter: " + pname, name(), StatusCode::FAILURE ),
                -1 ) );
 
  auto& code = m_logColorCodes[level];
 
  const auto& col_desc = m_logColors[level].value();
 
  if ( col_desc.size() == 1 ) {
    const std::string& desc = col_desc[0];
    if ( desc.empty() ) {
      code = "";
    } else if ( desc[0] == '[' ) {
      code = "\033" + desc;
    } else {
      code = "\033[" + colTrans( desc, 90 ) + ";1m";
    }
  } else if ( col_desc.size() == 2 ) {
    code = "\033[" + colTrans( col_desc[0], 90 ) + ";" + colTrans( col_desc[1], 100 ) + ";1m";
  } else { // empty desc: no color
    code = "";
  }
}
 
void MessageSvc::setupLimits( Gaudi::Details::PropertyBase& prop ) {
  // Just report problems in the settings of the limits and unknown limit parameters
  if ( prop.name() == "alwaysLimit" ) {
    Gaudi::Property<int>* p = dynamic_cast<Gaudi::Property<int>*>( &prop );
    if ( p && p->value() != 0 ) {
      std::cout << "MessageSvc ERROR: cannot suppress ALWAYS messages" << std::endl;
      p->setValue( 0 );
    }
  } else if ( prop.name() == "defaultLimit" ) {
    for ( int i = MSG::VERBOSE; i < MSG::NUM_LEVELS; ++i ) {
      if ( i != MSG::ALWAYS ) { m_msgLimit[i] = m_msgLimit[MSG::NIL].value(); }
    }
  } else if ( prop.name() != "fatalLimit" && prop.name() != "errorLimit" && prop.name() != "warningLimit" &&
              prop.name() == "infoLimit" && prop.name() == "debugLimit" && prop.name() == "verboseLimit" ) {
    std::cout << "MessageSvc ERROR: Unknown message limit parameter: " << prop.name() << std::endl;
    return;
  }
}
 
void MessageSvc::setupThreshold( Gaudi::Details::PropertyBase& prop ) {
 
  static const std::array<std::pair<const char*, MSG::Level>, 7> tbl{ { { "setFatal", MSG::FATAL },
                                                                        { "setError", MSG::ERROR },
                                                                        { "setWarning", MSG::WARNING },
                                                                        { "setInfo", MSG::INFO },
                                                                        { "setDebug", MSG::DEBUG },
                                                                        { "setVerbose", MSG::VERBOSE },
                                                                        { "setAlways", MSG::ALWAYS } } };
 
  auto i = std::find_if( std::begin( tbl ), std::end( tbl ),
                         [&]( const std::pair<const char*, MSG::Level>& t ) { return prop.name() == t.first; } );
  if ( i == std::end( tbl ) ) {
    std::cerr << "MessageSvc ERROR: Unknown message threshold parameter: " << prop.name() << std::endl;
    return;
  }
  int ic = i->second;
 
  Gaudi::Property<std::vector<std::string>>* sap = dynamic_cast<Gaudi::Property<std::vector<std::string>>*>( &prop );
  if ( !sap ) {
    std::cerr << "could not dcast " << prop.name()
              << " to a Gaudi::Property<std::vector<std::string>> (which it should be!)" << std::endl;
  } else {
    for ( auto& i : sap->value() ) setOutputLevel( i, ic );
  }
}
 
#ifdef NDEBUG
void MessageSvc::setupInactCount( Gaudi::Details::PropertyBase& ) {}
#else
void MessageSvc::setupInactCount( Gaudi::Details::PropertyBase& prop ) {
  if ( prop.name() == "countInactive" ) {
    Gaudi::Property<bool>* p = dynamic_cast<Gaudi::Property<bool>*>( &prop );
    if ( p ) MsgStream::enableCountInactive( p->value() );
  }
}
#endif
 
StatusCode MessageSvc::finalize() {
  m_suppress = false;
 
  {
    std::ostringstream os;
 
    if ( m_stats ) {
      os << "Summarizing all message counts" << std::endl;
    } else {
      os << "Listing sources of suppressed message: " << std::endl;
    }
 
    os << "=====================================================" << std::endl;
    os << " Message Source              |   Level |    Count" << std::endl;
    os << "-----------------------------+---------+-------------" << std::endl;
 
    bool found( false );
 
    for ( auto itr = m_sourceMap.begin(); itr != m_sourceMap.end(); ++itr ) {
      for ( unsigned int ic = 0; ic < MSG::NUM_LEVELS; ++ic ) {
        if ( ( itr->second.msg[ic] >= m_msgLimit[ic] && m_msgLimit[ic] != 0 ) ||
             ( m_stats && itr->second.msg[ic] > 0 && ic >= m_statLevel.value() ) ) {
          os << " ";
          os.width( 28 );
          os.setf( std::ios_base::left, std::ios_base::adjustfield );
          os << itr->first;
          os << "|";
 
          os.width( 8 );
          os.setf( std::ios_base::right, std::ios_base::adjustfield );
          os << levelNames[ic];
          os << " |";
 
          os.width( 9 );
          os << itr->second.msg[ic];
          os << std::endl;
 
          found = true;
        }
      }
    }
    os << "=====================================================" << std::endl;
    if ( found || m_stats ) std::cout << os.str() << std::flush;
  }
 
#ifndef NDEBUG
  if ( m_inactCount.value() ) {
 
    std::ostringstream os;
    os << "Listing sources of Unprotected and Unseen messages\n";
 
    bool found( false );
 
    unsigned int ml( 0 );
    for ( const auto& itr : m_inactiveMap ) {
      for ( unsigned int ic = 0; ic < MSG::NUM_LEVELS; ++ic ) {
        if ( itr.second.msg[ic] != 0 && itr.first.length() > ml ) { ml = itr.first.length(); }
      }
    }
 
    for ( unsigned int i = 0; i < ml + 25; ++i ) os << "=";
 
    os << std::endl << " ";
    os.width( ml + 2 );
    os.setf( std::ios_base::left, std::ios_base::adjustfield );
    os << "Message Source";
    os.width( 1 );
    os << "|   Level |    Count" << std::endl;
 
    for ( unsigned int i = 0; i < ml + 3; ++i ) os << "-";
    os << "+---------+-----------" << std::endl;
 
    for ( auto itr = m_inactiveMap.begin(); itr != m_inactiveMap.end(); ++itr ) {
      for ( unsigned int ic = 0; ic < MSG::NUM_LEVELS; ++ic ) {
        if ( itr->second.msg[ic] != 0 ) {
          os << " ";
          os.width( ml + 2 );
          os.setf( std::ios_base::left, std::ios_base::adjustfield );
          os << itr->first;
 
          os << "|";
 
          os.width( 8 );
          os.setf( std::ios_base::right, std::ios_base::adjustfield );
          os << levelNames[ic];
 
          os << " |";
 
          os.width( 9 );
          os << itr->second.msg[ic];
 
          os << std::endl;
 
          found = true;
        }
      }
    }
    for ( unsigned int i = 0; i < ml + 25; ++i ) os << "=";
    os << std::endl;
 
    if ( found ) std::cout << os.str() << std::flush;
  }
#endif
 
  return StatusCode::SUCCESS;
}
 
void MessageSvc::reportMessage( const Message& msg, int outputLevel ) {
  auto lock = std::scoped_lock{ m_reportMutex };
  i_reportMessage( msg, outputLevel );
}
 
void MessageSvc::i_reportMessage( const Message& msg, int outputLevel ) {
  int key = msg.getType();
 
  ++m_msgCount[key];
 
  const Message* cmsg = &msg;
 
  // processing logged streams
  if ( !m_loggedStreams.empty() ) {
    auto iLog = m_loggedStreams.find( msg.getSource() );
    if ( m_loggedStreams.end() != iLog ) { ( *iLog->second ) << *cmsg << std::endl; }
  }
 
  if ( m_suppress.value() || m_stats.value() ) {
 
    // Increase the counter of 'key' type of messages for the source and
    // get the new value.
    const int nmsg = ++( m_sourceMap[msg.getSource()].msg[key] );
 
    if ( m_suppress.value() && m_msgLimit[key] != 0 ) {
      if ( nmsg > m_msgLimit[key] ) return;
      if ( nmsg == m_msgLimit[key] ) {
        std::string txt = levelNames[key] + " message limit (" + std::to_string( m_msgLimit[key].value() ) +
                          ") reached for " + msg.getSource() + ". Suppressing further output.";
        cmsg = new Message( msg.getSource(), MSG::WARNING, std::move( txt ) );
        cmsg->setFormat( msg.getFormat() );
      }
    }
  }
 
  auto range = m_streamMap.equal_range( key );
  if ( range.first != m_streamMap.end() ) {
    std::for_each( range.first, range.second,
                   [&]( StreamMap::const_reference sm ) { *sm.second.second << *cmsg << std::endl; } );
  } else if ( key >= outputLevel ) {
    msg.setFormat( m_defaultFormat );
    msg.setTimeFormat( m_defaultTimeFormat );
    if ( !m_color ) {
      ( *m_defaultStream ) << *cmsg << std::endl << std::flush;
    } else {
      ( *m_defaultStream ) << m_logColorCodes[key] << *cmsg << "\033[m" << std::endl << std::flush;
    }
  }
 
  if ( cmsg != &msg ) { delete cmsg; } // cppcheck-suppress autovarInvalidDeallocation; false positive
}
 
void MessageSvc::reportMessage( const Message& msg ) { reportMessage( msg, outputLevel( msg.getSource() ) ); }
 
void MessageSvc::reportMessage( std::string source, int type, std::string message ) {
  reportMessage( Message{ std::move( source ), type, std::move( message ) } );
}
 
void MessageSvc::reportMessage( const StatusCode& code, std::string_view source ) {
  auto lock = std::scoped_lock{ m_messageMapMutex };
  i_reportMessage( code, source );
}
 
void MessageSvc::i_reportMessage( const StatusCode& code, std::string_view source ) {
  int  level  = outputLevel( source );
  auto report = [&]( Message mesg ) {
    mesg.setSource( source );
    Message stat_code( std::string{ source }, mesg.getType(), "Status Code " + std::to_string( code.getCode() ) );
    i_reportMessage( std::move( stat_code ), level );
    i_reportMessage( std::move( mesg ), level );
  };
 
  auto range = m_messageMap.equal_range( code );
  if ( range.first != m_messageMap.end() ) {
    std::for_each( range.first, range.second, [&]( MessageMap::const_reference sm ) { report( sm.second ); } );
  } else {
    report( m_defaultMessage );
  }
}
 
void MessageSvc::insertStream( int key, std::string name, std::ostream* stream ) {
  m_streamMap.emplace( key, NamedStream( std::move( name ), stream ) );
}
 
void MessageSvc::eraseStream() { m_streamMap.clear(); }
 
void MessageSvc::eraseStream( int message_type ) { m_streamMap.erase( message_type ); }
 
void MessageSvc::eraseStream( int key, std::ostream* stream ) {
  if ( stream ) {
    erase_if( m_streamMap, m_streamMap.equal_range( key ),
              [&]( StreamMap::const_reference j ) { return j.second.second == stream; } );
  }
}
 
void MessageSvc::eraseStream( std::ostream* stream ) {
  if ( stream ) {
    erase_if( m_streamMap, [&]( StreamMap::const_reference j ) { return j.second.second == stream; } );
  }
}
 
void MessageSvc::insertMessage( const StatusCode& key, Message msg ) {
  auto lock = std::scoped_lock{ m_messageMapMutex };
  m_messageMap.emplace( key, std::move( msg ) );
}
 
void MessageSvc::eraseMessage() {
  auto lock = std::scoped_lock{ m_messageMapMutex };
  m_messageMap.clear();
}
 
void MessageSvc::eraseMessage( const StatusCode& key ) {
  auto lock = std::scoped_lock{ m_messageMapMutex };
  m_messageMap.erase( key );
}
 
void MessageSvc::eraseMessage( const StatusCode& key, const Message& msg ) {
  auto lock = std::scoped_lock{ m_messageMapMutex };
 
  erase_if( m_messageMap, m_messageMap.equal_range( key ),
            [&]( MessageMap::const_reference j ) { return j.second == msg; } );
}
 
int MessageSvc::outputLevel() const { return m_outputLevel; }
 
int MessageSvc::outputLevel( std::string_view source ) const {
  auto lock = std::scoped_lock{ m_thresholdMapMutex };
  auto it   = m_thresholdMap.find( source );
  return it != m_thresholdMap.end() ? it->second : m_outputLevel.value();
}
 
void MessageSvc::setOutputLevel( int new_level ) { m_outputLevel = new_level; }
 
void MessageSvc::setOutputLevel( std::string_view source, int level ) {
  auto lock = std::scoped_lock{ m_thresholdMapMutex };
 
  // only write if we really have to...
  auto i = m_thresholdMap.find( source );
  if ( i == m_thresholdMap.end() ) {
    m_thresholdMap.emplace( source, level );
  } else if ( i->second != level ) {
    i->second = level;
  }
}
 
std::string MessageSvc::getLogColor( int logLevel ) const {
  return ( logLevel < MSG::NUM_LEVELS ) ? m_logColorCodes[logLevel] : "";
}
 
int MessageSvc::messageCount( MSG::Level level ) const { return m_msgCount[level]; }
 
void MessageSvc::incrInactiveCount( MSG::Level level, std::string_view source ) {
  auto entry = m_inactiveMap.find( source );
  if ( entry == m_inactiveMap.end() ) { entry = m_inactiveMap.emplace( source, MsgAry{} ).first; }
  ++entry->second.msg[level];
 
  if ( std::find( begin( m_tracedInactiveSources ), end( m_tracedInactiveSources ), source ) !=
       end( m_tracedInactiveSources ) ) {
    std::cout << "== inactive message detected from " << source << " ==\n";
    std::string t;
    System::backTrace( t, 25, 0 );
    std::cout << t << std::endl;
  }
}
 
void MessageSvc::setupLogStreams() {
  // reset state
  m_loggedStreams.clear();
 
  // make the unique set of output filenames
  std::set<std::string_view> outFileNames;
  std::transform( m_loggedStreamsName.begin(), m_loggedStreamsName.end(),
                  std::inserter( outFileNames, outFileNames.end() ),
                  []( const auto& p ) -> std::string_view { return p.second; } );
  // map each unique filename to an ofstream
  std::map<std::string_view, std::shared_ptr<std::ofstream>> outStreams;
  std::transform( outFileNames.begin(), outFileNames.end(), std::inserter( outStreams, outStreams.end() ),
                  []( std::string_view fname ) {
                    return std::pair{ fname, std::make_shared<std::ofstream>(
                                                 std::string{ fname }, std::ios_base::out | std::ios_base::trunc ) };
                  } );
  // associate the stream to ofstream...
  for ( auto& iProp : m_loggedStreamsName ) {
    auto& stream = outStreams.at( iProp.second );
    if ( stream->good() ) m_loggedStreams.emplace( iProp.first, stream );
  }
}