XrdClLog.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2011-2014 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// This file is part of the XRootD software suite.
//
// XRootD is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// XRootD is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//
// 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.
//------------------------------------------------------------------------------
 
#ifndef __XRD_CL_LOG_HH__
#define __XRD_CL_LOG_HH__
 
#include <cstdarg>
#include <string>
#include <map>
#include <cstdint>
#include "XrdSys/XrdSysPthread.hh"
 
//------------------------------------------------------------------------------
// C++11 atomics are used to avoid illegal behavior when setting/getting the
// log level. To minimize costs across all platforms, we use
// std::memory_order_relaxed; this means threads may reorder SetLogLevel writes
// and the visibility is relatively undefined. However, we know the stores are
// at least atomic.
//------------------------------------------------------------------------------
#include <atomic>
 
namespace XrdCl
{
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class LogOut
  {
    public:
      virtual ~LogOut() {}
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual void Write( const std::string &message ) = 0;
  };
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class LogOutFile: public LogOut
  {
    public:
      LogOutFile(): pFileDes(-1) {};
      virtual ~LogOutFile() { Close(); };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool Open( const std::string &fileName );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Close();
      virtual void Write( const std::string &message );
 
    private:
      int pFileDes;
  };
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class LogOutCerr: public LogOut
  {
    public:
      virtual void Write( const std::string &message );
      virtual ~LogOutCerr() {}
    private:
      XrdSysMutex pMutex;
  };
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class Log
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      enum LogLevel
      {
        NoMsg       = 0,  
        ErrorMsg    = 1,  
        WarningMsg  = 2,  
        InfoMsg     = 3,  
        DebugMsg    = 4,  
        DumpMsg     = 5   
      };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Log(): pLevel( NoMsg ), pTopicMaxLength( 18 ), pPid(0)
      {
        pOutput = new LogOutCerr();
        int maxMask = (int)DumpMsg+1;
        for( int i = 0; i < maxMask; ++i )
          pMask[i] = 0xffffffffffffffffULL;
      }
 
      //------------------------------------------------------------------------
      // Destructor
      //------------------------------------------------------------------------
      ~Log()
      {
        delete pOutput;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Error( uint64_t topic, const char *format, ... );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Warning( uint64_t topic, const char *format, ... );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Info( uint64_t topic, const char *format, ... );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Debug( uint64_t topic, const char *format, ... );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Dump( uint64_t topic, const char *format, ... );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Say( LogLevel level, uint64_t topic, const char *format, va_list list );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetLevel( LogLevel level )
      {
#if __cplusplus >= 201103L
        pLevel.store(level, std::memory_order_relaxed);
#else
        pLevel = level;
#endif
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetLevel( const std::string &level )
      {
        LogLevel lvl;
        if( StringToLogLevel( level, lvl ) )
          SetLevel( lvl );
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetOutput( LogOut *output )
      {
        delete pOutput;
        pOutput = output;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetMask( LogLevel level, uint64_t mask )
      {
        pMask[level] = mask;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetMask( const std::string &level, uint64_t mask )
      {
        LogLevel lvl;
        if( StringToLogLevel( level, lvl ) )
          pMask[lvl] = mask;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetTopicName( uint64_t topic, std::string name );
 
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      inline uint64_t RegisterTopic( const std::string &topic )
      {
        uint64_t tpcnb = pTopicMap.rbegin()->first << 1;
        SetTopicName( tpcnb, topic );
        return tpcnb;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      LogLevel GetLevel() const
      {
        LogLevel lvl = pLevel.load(std::memory_order_relaxed);
        return lvl;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetPid(pid_t pid)
      {
        pPid = pid;
      }
 
    private:
      typedef std::map<uint64_t, std::string> TopicMap;
      std::string LogLevelToString( LogLevel level );
      bool StringToLogLevel( const std::string &strLevel, LogLevel &level );
      std::string TopicToString( uint64_t topic );
 
      std::atomic<LogLevel> pLevel;
 
      uint64_t    pMask[DumpMsg+1];
      LogOut     *pOutput;
      TopicMap    pTopicMap;
      uint32_t    pTopicMaxLength;
      pid_t       pPid;
  };
}
 
#endif // __XRD_CL_LOG_HH__