LogStream.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow, Stephan Aiche, Andreas Bertsch$
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Macros.h>
#include <OpenMS/DATASTRUCTURES/StringUtils.h>
 
#include <sstream>
#include <iostream>
#include <list>
#include <vector>
#include <ctime>
#include <map>
 
namespace OpenMS
{
  class Colorizer;
 
  namespace Logger
  {
    // forward declarations
    class LogStream;
    class LogStreamNotifier;
 
    class OPENMS_DLLAPI LogStreamBuf :
      public std::streambuf
    {
 
      friend class LogStream;
 
public:
 
 
      static const time_t MAX_TIME;
      static const std::string UNKNOWN_LOG_LEVEL;
 
 
 
 
      LogStreamBuf(const std::string& log_level = UNKNOWN_LOG_LEVEL, Colorizer* col = nullptr);
 
      LogStreamBuf(LogStreamBuf* source_buf, Colorizer* col = nullptr);
 
      ~LogStreamBuf() override;
 
 
 
 
      int sync() override;
 
      int overflow(int c = -1) override;
 
 
 
 
      void setLevel(std::string level);
 
 
      std::string getLevel();
 
      struct OPENMS_DLLAPI StreamStruct
      {
        std::ostream * stream;
        std::string         prefix;
        LogStreamNotifier * target;
 
        StreamStruct() :
          stream(nullptr),
          target(nullptr)
        {}
 
        ~StreamStruct()
        {}
 
      };
 
      void clearCache();
 
protected:
 
      void distribute_(const std::string& outstring);
 
      std::string expandPrefix_(const std::string & prefix, time_t time) const;
 
      std::list<StreamStruct>& getStreamList_();
      const std::list<StreamStruct>& getStreamList_() const;
 
      char * pbuf_ = nullptr;
      std::string             level_;
      std::list<StreamStruct> stream_list_;  
      std::string             incomplete_line_;
      Colorizer* colorizer_ = nullptr; 
 
 
      struct LogCacheStruct
      {
        Size timestamp;
        int counter;
      };
 
      Size log_cache_counter_ = 0;
 
      std::map<std::string, LogCacheStruct> log_cache_;
      std::map<Size, std::string> log_time_cache_;
 
      bool isInCache_(std::string const & line);
 
      std::string addToCache_(std::string const & line);
 
      Size getNextLogCounter_();
 
      int syncLF_();
    };
 
    class OPENMS_DLLAPI LogStreamNotifier
    {
public:
 
      LogStreamNotifier();
 
      virtual ~LogStreamNotifier();
 
      virtual void logNotify();
 
      void registerAt(LogStream & log_stream);
 
      void unregister();
 
protected:
      std::stringstream stream_;   
 
      LogStream * registered_at_;  
    };
 
 
    class OPENMS_DLLAPI LogStream :
      public std::ostream
    {
public:
 
 
 
      LogStream(LogStreamBuf * buf = nullptr, bool delete_buf = true, std::ostream * stream = nullptr);
 
      ~LogStream() override;
 
 
 
      LogStreamBuf * rdbuf();
 
      LogStreamBuf * operator->();
 
 
 
 
      void setLevel(std::string level);
 
 
      std::string getLevel();
 
 
 
      void insert(std::ostream & s);
 
      void remove(std::ostream & s);
 
      void removeAllStreams();
 
      void insertNotification(std::ostream & s,
                              LogStreamNotifier & target);
 
      void setPrefix(const std::ostream & s, const std::string & prefix);
 
 
      void setPrefix(const std::string & prefix);
 
      void flush();
 
      void flushIncomplete();
 
      bool hasStream(std::ostream & stream);
private:
 
      typedef std::list<LogStreamBuf::StreamStruct>::iterator StreamIterator;
 
      StreamIterator findStream_(const std::ostream & stream);
      bool hasStream_(std::ostream & stream);
      bool bound_() const;
 
      bool delete_buffer_;
 
    }; //LogStream
 
    class OPENMS_DLLAPI LogSinkGuard
    {
    public:
      LogSinkGuard(LogStream& log_stream, std::ostream& stream)
        : log_stream_(log_stream), stream_(stream), was_attached_(log_stream.hasStream(stream))
      {
        if (!was_attached_)
        {
          return;
        }
        // Drain pending output so pre-guard text reaches this sink before it is detached.
        log_stream_.flushIncomplete();
        log_stream_.remove(stream_);
      }
 
      ~LogSinkGuard()
      {
        if (!was_attached_)
        {
          return;
        }
        // Drain buffered output while the sink is still detached so it does not leak through.
        log_stream_.flushIncomplete();
        log_stream_.insert(stream_);
      }
 
      // Non-copyable and non-movable
      LogSinkGuard(const LogSinkGuard&) = delete;
      LogSinkGuard& operator=(const LogSinkGuard&) = delete;
      LogSinkGuard(LogSinkGuard&&) = delete;
      LogSinkGuard& operator=(LogSinkGuard&&) = delete;
 
    private:
      LogStream& log_stream_;
      std::ostream& stream_;
      const bool was_attached_;
    };
 
  } // namespace Logger
 
  //
  // Thread-Local Log Stream Accessors
  //
  // These functions return thread-local LogStream instances, eliminating data races
  // in the logging system. Each thread gets its own buffers and state.
  // See GitHub Issue #8596 for details on the race conditions this fixes.
  //
  // RESTRICTIONS (document these clearly):
  // - Log configuration (via LogConfigHandler) should be done ONCE at program start,
  //   BEFORE spawning threads. Thread-local streams copy config from globals on first access.
  // - OpenMP thread pools reuse threads, so thread_local state persists across parallel regions.
  // - Do not reconfigure logging while threads are actively logging.
  //
 
  OPENMS_DLLAPI Logger::LogStream& getThreadLocalLogFatal();
 
  OPENMS_DLLAPI Logger::LogStream& getThreadLocalLogError();
 
  OPENMS_DLLAPI Logger::LogStream& getThreadLocalLogWarn();
 
  OPENMS_DLLAPI Logger::LogStream& getThreadLocalLogInfo();
 
  OPENMS_DLLAPI Logger::LogStream& getThreadLocalLogDebug();
 
  //
  // Logging Macros (thread-safe via thread-local streams)
  //
 
#define OPENMS_LOG_FATAL_ERROR \
  OpenMS::getThreadLocalLogFatal() << __FILE__ << "(" << __LINE__ << "): "
 
#define OPENMS_LOG_ERROR \
  OpenMS::getThreadLocalLogError()
 
#define OPENMS_LOG_WARN \
  OpenMS::getThreadLocalLogWarn()
 
#define OPENMS_LOG_INFO \
  OpenMS::getThreadLocalLogInfo()
 
#define OPENMS_LOG_DEBUG \
  OpenMS::getThreadLocalLogDebug() << past_last_slash(__FILE__) << "(" << __LINE__ << "): "
 
#define OPENMS_LOG_DEBUG_NOFILE \
  OpenMS::getThreadLocalLogDebug()
 
 
  OPENMS_DLLAPI Logger::LogStream& getGlobalLogFatal();
 
  OPENMS_DLLAPI Logger::LogStream& getGlobalLogError();
 
  OPENMS_DLLAPI Logger::LogStream& getGlobalLogWarn();
 
  OPENMS_DLLAPI Logger::LogStream& getGlobalLogInfo();
 
  OPENMS_DLLAPI Logger::LogStream& getGlobalLogDebug();
 
 
} // namespace OpenMS