XrdClLog.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// 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/>.
//------------------------------------------------------------------------------

#ifndef __XRD_CL_LOG_HH__
#define __XRD_CL_LOG_HH__

#include <stdarg.h>
#include <string>
#include <map>
#include <stdint.h>

#include "XrdCl/XrdClOptimizers.hh"

#include "XrdSys/XrdSysPthread.hh"

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 );
    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 )
      {
        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, ... )
      {
        if( unlikely( pLevel < ErrorMsg ) )
          return;

        if( unlikely( (topic & pMask[ErrorMsg]) == 0 ) )
          return;

        va_list argList;
        va_start( argList, format );
        Say( ErrorMsg, topic, format, argList );
        va_end( argList );
      }

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Warning( uint64_t topic, const char *format, ... )
      {
        if( unlikely( pLevel < WarningMsg ) )
          return;

        if( unlikely( (topic & pMask[WarningMsg]) == 0 ) )
          return;

        va_list argList;
        va_start( argList, format );
        Say( WarningMsg, topic, format, argList );
        va_end( argList );
      }

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Info( uint64_t topic, const char *format, ... )
      {
        if( likely( pLevel < InfoMsg ) )
          return;

        if( unlikely( (topic & pMask[InfoMsg]) == 0 ) )
          return;

        va_list argList;
        va_start( argList, format );
        Say( InfoMsg, topic, format, argList );
        va_end( argList );
      }

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Debug( uint64_t topic, const char *format, ... )
      {
        if( likely( pLevel < DebugMsg ) )
          return;

        if( unlikely( (topic & pMask[DebugMsg]) == 0 ) )
          return;

        va_list argList;
        va_start( argList, format );
        Say( DebugMsg, topic, format, argList );
        va_end( argList );
      }

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Dump( uint64_t topic, const char *format, ... )
      {
        if( likely( pLevel < DumpMsg ) )
          return;

        if( unlikely( (topic & pMask[DumpMsg]) == 0 ) )
          return;

        va_list argList;
        va_start( argList, format );
        Say( DumpMsg, topic, format, argList );
        va_end( argList );
      }

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Say( LogLevel level, uint64_t topic, const char *format, va_list list );

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetLevel( LogLevel level )
      {
        pLevel = level;
      }

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetLevel( const std::string &level )
      {
        LogLevel lvl;
        if( StringToLogLevel( level, lvl ) )
          pLevel = 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 );

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      LogLevel GetLevel() const
      {
        return pLevel;
      }

    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 );

      LogLevel    pLevel;
      uint64_t    pMask[DumpMsg+1];
      LogOut     *pOutput;
      TopicMap    pTopicMap;
      uint32_t    pTopicMaxLength;
  };
}

#endif // __XRD_CL_LOG_HH__