(file) Return to Tracer.cpp CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/Tracer.cpp between version 1.1.2.11 and 1.23

version 1.1.2.11, 2001/11/20 06:11:35 version 1.23, 2004/06/22 22:06:23
Line 1 
Line 1 
 //%/////////////////////////////////////////////////////////////////////////////  //%2003////////////////////////////////////////////////////////////////////////
 // //
 // Copyright (c) 2000, 2001 BMC Software, Hewlett-Packard Company, IBM,  // Copyright (c) 2000, 2001, 2002  BMC Software, Hewlett-Packard Development
 // The Open Group, Tivoli Systems  // Company, L. P., IBM Corp., The Open Group, Tivoli Systems.
   // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.;
   // IBM Corp.; EMC Corporation, The Open Group.
 // //
 // Permission is hereby granted, free of charge, to any person obtaining a copy // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to // of this software and associated documentation files (the "Software"), to
Line 23 
Line 25 
 // //
 // Author: Sushma Fernandes, Hewlett-Packard Company (sushma_fernandes@hp.com) // Author: Sushma Fernandes, Hewlett-Packard Company (sushma_fernandes@hp.com)
 // //
 // Modified By:  // Modified By: Jenny Yu, Hewlett-Packard Company (jenny_yu@hp.com)
   //              Amit K Arora, IBM (amita@in.ibm.com) for PEP#101
   //              Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)
 // //
 //%///////////////////////////////////////////////////////////////////////////// //%/////////////////////////////////////////////////////////////////////////////
  
   #include <Pegasus/Common/Config.h>
 #include <Pegasus/Common/Tracer.h> #include <Pegasus/Common/Tracer.h>
 #include <Pegasus/Common/Destroyer.h>  #include <Pegasus/Common/Thread.h>
   #include <Pegasus/Common/IPC.h>
   #include <Pegasus/Common/System.h>
  
 PEGASUS_USING_STD; PEGASUS_USING_STD;
  
Line 46 
Line 53 
 // Set the return codes // Set the return codes
 const Boolean Tracer::_SUCCESS = 1; const Boolean Tracer::_SUCCESS = 1;
 const Boolean Tracer::_FAILURE = 0; const Boolean Tracer::_FAILURE = 0;
 String  Tracer::_EMPTY_STRING = String::EMPTY;  
  
 // Set the Enter and Exit messages // Set the Enter and Exit messages
 const char Tracer::_FUNC_ENTER_MSG[] = "Entering method";  const char Tracer::_METHOD_ENTER_MSG[] = "Entering method";
 const char Tracer::_FUNC_EXIT_MSG[]  = "Exiting method";  const char Tracer::_METHOD_EXIT_MSG[]  = "Exiting method";
  
 // Set Log messages // Set Log messages
 const char Tracer::_LOG_MSG1[] = "LEVEL1 not enabled with Tracer::trace call.";  const char Tracer::_LOG_MSG[] = "LEVEL1 may only be used with trace macros PEG_METHOD_ENTER/PEG_METHOD_EXIT.";
 const char  
       Tracer::_LOG_MSG2[] = "LEVEL1 not enabled with Tracer::traceBuffer call.";  
 const char Tracer::_LOG_MSG3[]="Use trace macros, PEG_FUNC_ENTER/PEG_FUNC_EXIT";  
  
 // Initialize singleton instance of Tracer // Initialize singleton instance of Tracer
 Tracer* Tracer::_tracerInstance = 0; Tracer* Tracer::_tracerInstance = 0;
Line 71 
Line 74 
 // Set the line maximum // Set the line maximum
 const Uint32 Tracer::_STRLEN_MAX_UNSIGNED_INT = 21; const Uint32 Tracer::_STRLEN_MAX_UNSIGNED_INT = 21;
  
   // Set the max PID and Thread ID Length
   const Uint32 Tracer::_STRLEN_MAX_PID_TID = 20;
   
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 // Tracer constructor // Tracer constructor
 // Constructor is private to preclude construction of Tracer objects // Constructor is private to preclude construction of Tracer objects
Line 79 
Line 85 
 Tracer::Tracer() Tracer::Tracer()
 { {
     // Initialize Trace File Handler     // Initialize Trace File Handler
     _traceHandler=new TraceFileHandler();      _traceHandler.reset(new TraceFileHandler());
     _traceLevelMask=0;     _traceLevelMask=0;
     _traceComponentMask=new Boolean[_NUM_COMPONENTS];      _traceComponentMask.reset(new Boolean[_NUM_COMPONENTS]);
  
     // Initialize ComponentMask array to false     // Initialize ComponentMask array to false
     for (Uint32 index=0;index < _NUM_COMPONENTS;     for (Uint32 index=0;index < _NUM_COMPONENTS;
         _traceComponentMask[index++]=false);          (_traceComponentMask.get())[index++]=false);
 } }
  
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
Line 93 
Line 99 
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 Tracer::~Tracer() Tracer::~Tracer()
 { {
     delete []_traceComponentMask;  
     delete _traceHandler;  
     delete _tracerInstance;     delete _tracerInstance;
 } }
  
Line 110 
Line 114 
 { {
     if ( traceLevel == LEVEL1 )     if ( traceLevel == LEVEL1 )
     {     {
         // ATTN: Setting the Log file type to DEBUG_LOG          trace( traceComponent, Tracer::LEVEL4, "%s", _LOG_MSG );
         // May need to change to an appropriate log file type  
         Logger::put(Logger::DEBUG_LOG,"Tracer",Logger::WARNING,"$0 $1",  
            _LOG_MSG1,_LOG_MSG3);  
     }     }
     else     else
     {     {
Line 139 
Line 140 
  
     if ( traceLevel == LEVEL1 )     if ( traceLevel == LEVEL1 )
     {     {
         Logger::put(Logger::DEBUG_LOG,"Tracer",Logger::WARNING,"$0 $1",          trace( traceComponent, Tracer::LEVEL4, "%s", _LOG_MSG );
            _LOG_MSG1,_LOG_MSG3);  
     }     }
     else     else
     {     {
         if (_isTraceEnabled(traceComponent,traceLevel))         if (_isTraceEnabled(traceComponent,traceLevel))
         {         {
               //
               // Allocate memory for the message string
               // Needs to be updated if additional info is added
               //
             message = new char[ strlen(fileName) +             message = new char[ strlen(fileName) +
                 _STRLEN_MAX_UNSIGNED_INT + 6 ];                  _STRLEN_MAX_UNSIGNED_INT + (_STRLEN_MAX_PID_TID * 2) + 8 ];
             sprintf(message,"[%s:%d]: ",fileName,lineNum);              sprintf(
                  message,
                  "[%d:%u:%s:%u]: ",
                  System::getPID(),
                  Uint32(pegasus_thread_self()),
                  fileName,
                  lineNum);
  
             _trace(traceComponent,message,fmt,argList);             _trace(traceComponent,message,fmt,argList);
             delete []message;             delete []message;
Line 167 
Line 177 
 { {
     if ( traceLevel == LEVEL1 )     if ( traceLevel == LEVEL1 )
     {     {
         Logger::put(Logger::DEBUG_LOG,"Tracer",Logger::WARNING,"$0 $1",          trace( traceComponent, Tracer::LEVEL4, "%s", _LOG_MSG );
            _LOG_MSG2,_LOG_MSG3);  
     }     }
     else     else
     {     {
Line 197 
Line 206 
 { {
     if ( traceLevel == LEVEL1 )     if ( traceLevel == LEVEL1 )
     {     {
         Logger::put(Logger::DEBUG_LOG,"Tracer",Logger::WARNING,"$0 $1",          trace( traceComponent, Tracer::LEVEL4, "%s", _LOG_MSG );
            _LOG_MSG2,_LOG_MSG3);  
     }     }
     else     else
     {     {
Line 216 
Line 224 
 } }
  
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
   //Traces the given string
   ////////////////////////////////////////////////////////////////////////////////
   void Tracer::_traceString(
       const Uint32   traceComponent,
       const Uint32   traceLevel,
       const String&  traceString)
   {
       if ( traceLevel == LEVEL1 )
       {
           trace( traceComponent, Tracer::LEVEL4, "%s", _LOG_MSG );
       }
       else
       {
           if (_isTraceEnabled(traceComponent,traceLevel))
           {
               trace(traceComponent,traceLevel,"%s",
                          (const char *)traceString.getCString());
           }
       }
   }
   
   ////////////////////////////////////////////////////////////////////////////////
   //Traces the given string - Overloaded to include the fileName and line number
   //of trace origin.
   ////////////////////////////////////////////////////////////////////////////////
   void Tracer::_traceString(
       const char*   fileName,
       const Uint32  lineNum,
       const Uint32  traceComponent,
       const Uint32  traceLevel,
       const String& traceString)
   {
       if ( traceLevel == LEVEL1 )
       {
           trace( traceComponent, Tracer::LEVEL4, "%s", _LOG_MSG );
       }
       else
       {
           if ( _isTraceEnabled( traceComponent, traceLevel ) )
           {
               trace(fileName,lineNum,traceComponent,traceLevel,"%s",
                        (const char *)traceString.getCString());
           }
       }
   }
   
   ////////////////////////////////////////////////////////////////////////////////
   //Traces the message in the given CIMException object.
   ////////////////////////////////////////////////////////////////////////////////
   void Tracer::_traceCIMException(
       const Uint32 traceComponent,
       const Uint32 traceLevel,
       CIMException cimException)
   {
       if ( traceLevel == LEVEL1 )
       {
           trace( traceComponent, Tracer::LEVEL4, "%s", _LOG_MSG );
       }
       else
       {
           if ( _isTraceEnabled( traceComponent, traceLevel ) )
           {
               // get the CIMException trace message string
               String traceMsg =
                   TraceableCIMException(cimException).getTraceDescription();
   
               // trace the string
               _traceString(traceComponent, traceLevel, traceMsg);
           }
       }
   }
   
   ////////////////////////////////////////////////////////////////////////////////
 //Traces method entry //Traces method entry
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 void Tracer::_traceEnter( void Tracer::_traceEnter(
Line 230 
Line 311 
  
     if (_isTraceEnabled(traceComponent,LEVEL1))     if (_isTraceEnabled(traceComponent,LEVEL1))
     {     {
   
         va_start(argList,fmt);         va_start(argList,fmt);
  
           //
           // Allocate memory for the message string
           // Needs to be updated if additional info is added
           //
         message = new char[ strlen(fileName) +         message = new char[ strlen(fileName) +
             _STRLEN_MAX_UNSIGNED_INT + 6 ];                              _STRLEN_MAX_UNSIGNED_INT + (_STRLEN_MAX_PID_TID * 2) + 8 ];
         sprintf(message,"[%s:%d]: ",fileName,lineNum);  
           sprintf(
              message,
              "[%d:%u:%s:%u]: ",
              System::getPID(),
              Uint32(pegasus_thread_self()),
              fileName,
              lineNum);
         _trace(traceComponent,message,fmt,argList);         _trace(traceComponent,message,fmt,argList);
  
         va_end(argList);         va_end(argList);
Line 259 
Line 352 
     {     {
         va_start(argList,fmt);         va_start(argList,fmt);
  
           //
           // Allocate memory for the message string
           // Needs to be updated if additional info is added
           //
         message = new char[ strlen(fileName) +         message = new char[ strlen(fileName) +
             _STRLEN_MAX_UNSIGNED_INT + 6 ];                              _STRLEN_MAX_UNSIGNED_INT + (_STRLEN_MAX_PID_TID * 2) + 8 ];
         sprintf(message,"[%s:%d]: ",fileName,lineNum);  
           sprintf(
              message,
              "[%d:%u:%s:%u]: ",
              System::getPID(),
              Uint32(pegasus_thread_self()),
              fileName,
              lineNum);
         _trace(traceComponent,message,fmt,argList);         _trace(traceComponent,message,fmt,argList);
         va_end(argList);         va_end(argList);
  
Line 280 
Line 384 
     {     {
         return false;         return false;
     }     }
     return ((instance->_traceComponentMask[traceComponent]) &&      return (((instance->_traceComponentMask.get())[traceComponent]) &&
             (traceLevel  & instance->_traceLevelMask));             (traceLevel  & instance->_traceLevelMask));
 } }
  
Line 297 
Line 401 
  
     // Get the current system time and prepend to message     // Get the current system time and prepend to message
     String currentTime = System::getCurrentASCIITime();     String currentTime = System::getCurrentASCIITime();
     ArrayDestroyer<char> timeStamp(currentTime.allocateCString());      CString timeStamp = currentTime.getCString();
  
       //
     // Allocate messageHeader.     // Allocate messageHeader.
     msgHeader = new char [strlen(message)      // Needs to be updated if additional info is added
         + strlen(TRACE_COMPONENT_LIST[traceComponent])      //
         + strlen(timeStamp.getPointer()) + 6];  
   
  
     // Construct the message header     // Construct the message header
     // The message header is in the following format     // The message header is in the following format
     // timestamp: <component name> [file name:line number]     // timestamp: <component name> [file name:line number]
     if (strcmp(message,"") != 0)     if (strcmp(message,"") != 0)
     {     {
         sprintf(msgHeader,"%s: %s %s",timeStamp.getPointer(),         // << Wed Jul 16 10:58:40 2003 mdd >> _STRLEN_MAX_PID_TID is not used in this format string
          msgHeader = new char [strlen(message)
                                + strlen(TRACE_COMPONENT_LIST[traceComponent])
                                + strlen(timeStamp) + _STRLEN_MAX_PID_TID + 5];
   
           sprintf(msgHeader,"%s: %s %s",(const char*)timeStamp,
             TRACE_COMPONENT_LIST[traceComponent] ,message);             TRACE_COMPONENT_LIST[traceComponent] ,message);
           //delete [] msgHeader;
     }     }
     else     else
     {     {
         sprintf(msgHeader,"%s: %s ",timeStamp.getPointer(),          //
             TRACE_COMPONENT_LIST[traceComponent] );          // Since the message is blank form a string using the pid and tid
           //
           char*  tmpBuffer;
   
           //
           // Allocate messageHeader.
           // Needs to be updated if additional info is added
           //
           tmpBuffer = new char[_STRLEN_MAX_PID_TID + 6];
           sprintf(tmpBuffer, "[%u:%u]: ", System::getPID(),
                   Uint32(pegasus_thread_self()));
           msgHeader = new char [ strlen(timeStamp) + strlen(TRACE_COMPONENT_LIST[traceComponent]) +
                                  strlen(tmpBuffer) + 1  + 5 ];
   
           sprintf(msgHeader,"%s: %s %s ",(const char*)timeStamp,
               TRACE_COMPONENT_LIST[traceComponent] ,tmpBuffer );
           delete []tmpBuffer;
           //delete [] msgHeader;
   
     }     }
  
     // Call trace file handler to write message     // Call trace file handler to write message
     _getInstance()->_traceHandler->handleMessage(msgHeader,fmt,argList);     _getInstance()->_traceHandler->handleMessage(msgHeader,fmt,argList);
   
     delete []msgHeader;     delete []msgHeader;
 } }
  
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 //Validate the trace file //Validate the trace file
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 Boolean Tracer::isValid(const char* filePath)  Boolean Tracer::isValidFileName(const char* filePath)
   {
       String moduleName = _getInstance()->_moduleName;
       if (moduleName == String::EMPTY)
 { {
     return (_getInstance()->_traceHandler->isValidFilePath(filePath));     return (_getInstance()->_traceHandler->isValidFilePath(filePath));
 } }
       else
       {
           String extendedFilePath = String(filePath) + "." + moduleName;
           return (_getInstance()->_traceHandler->isValidFilePath(
               extendedFilePath.getCString()));
       }
   }
  
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 //Validate the trace components //Validate the trace components
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 Boolean Tracer::isValid(  Boolean Tracer::isValidComponents(const String& traceComponents)
                      const String traceComponents, String& invalidComponents)  {
       String invalidComponents;
       return isValidComponents(traceComponents, invalidComponents);
   }
   
   Boolean Tracer::isValidComponents(
       const String& traceComponents, String& invalidComponents)
 { {
     // Validate the trace components and modify the traceComponents argument     // Validate the trace components and modify the traceComponents argument
     // to reflect the invalid components     // to reflect the invalid components
Line 359 
Line 506 
         }         }
  
         // Append _COMPONENT_SEPARATOR to the end of the traceComponents         // Append _COMPONENT_SEPARATOR to the end of the traceComponents
         componentStr += _COMPONENT_SEPARATOR;          componentStr.append(_COMPONENT_SEPARATOR);
  
         while (componentStr != String::EMPTY)         while (componentStr != String::EMPTY)
         {         {
Line 394 
Line 541 
  
             if ( !validComponent )             if ( !validComponent )
             {             {
                 invalidComponents += componentName;                  invalidComponents.append(componentName);
                 invalidComponents += _COMPONENT_SEPARATOR;                  invalidComponents.append(_COMPONENT_SEPARATOR);
             }             }
         }         }
     }     }
Line 417 
Line 564 
 } }
  
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
   //Set the name of the module being traced
   ////////////////////////////////////////////////////////////////////////////////
   void Tracer::setModuleName(const String& moduleName)
   {
       _getInstance()->_moduleName = moduleName;
   }
   
   ////////////////////////////////////////////////////////////////////////////////
 //Returns the Singleton instance of the Tracer //Returns the Singleton instance of the Tracer
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 Tracer* Tracer::_getInstance() Tracer* Tracer::_getInstance()
Line 438 
Line 593 
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 Uint32 Tracer::setTraceFile(const char* traceFile) Uint32 Tracer::setTraceFile(const char* traceFile)
 { {
       String moduleName = _getInstance()->_moduleName;
       if (moduleName == String::EMPTY)
       {
     return (_getInstance()->_traceHandler->setFileName (traceFile));     return (_getInstance()->_traceHandler->setFileName (traceFile));
 } }
       else
       {
           String extendedTraceFile = String(traceFile) + "." + moduleName;
           return (_getInstance()->_traceHandler->setFileName(
               extendedTraceFile.getCString()));
       }
   }
  
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 //Set the trace level //Set the trace level
Line 476 
Line 641 
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 // Set components to be traced. // Set components to be traced.
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 void Tracer::setTraceComponents( const String traceComponents )  void Tracer::setTraceComponents(const String& traceComponents)
 { {
     Uint32 position          = 0;     Uint32 position          = 0;
     Uint32 index             = 0;     Uint32 index             = 0;
Line 490 
Line 655 
         if (String::equalNoCase(componentStr,"ALL"))         if (String::equalNoCase(componentStr,"ALL"))
         {         {
             for (index=0; index < _NUM_COMPONENTS;             for (index=0; index < _NUM_COMPONENTS;
                     _getInstance()->_traceComponentMask[index++] = true);                      (_getInstance()->_traceComponentMask.get())[index++] = true);
             return ;             return ;
         }         }
  
         // initialise ComponentMask array to False         // initialise ComponentMask array to False
         for (index = 0;index < _NUM_COMPONENTS;         for (index = 0;index < _NUM_COMPONENTS;
                 _getInstance()->_traceComponentMask[index++] = false);                  (_getInstance()->_traceComponentMask.get())[index++] = false);
  
         // Append _COMPONENT_SEPARATOR to the end of the traceComponents         // Append _COMPONENT_SEPARATOR to the end of the traceComponents
         componentStr += _COMPONENT_SEPARATOR;          componentStr.append(_COMPONENT_SEPARATOR);
  
         while (componentStr != String::EMPTY)         while (componentStr != String::EMPTY)
         {         {
Line 515 
Line 680 
                 if (String::equalNoCase(                 if (String::equalNoCase(
                        componentName,TRACE_COMPONENT_LIST[index]))                        componentName,TRACE_COMPONENT_LIST[index]))
                 {                 {
                     _getInstance()->_traceComponentMask[index]=true;                      (_getInstance()->_traceComponentMask.get())[index]=true;
  
                     // Found component, break from the loop                     // Found component, break from the loop
                     break;                     break;
Line 534 
Line 699 
     {     {
         // initialise ComponentMask array to False         // initialise ComponentMask array to False
         for (Uint32 index = 0;index < _NUM_COMPONENTS;         for (Uint32 index = 0;index < _NUM_COMPONENTS;
                  _getInstance()->_traceComponentMask[index++] = false);                   (_getInstance()->_traceComponentMask.get())[index++] = false);
     }     }
     return ;     return ;
 } }

Legend:
Removed from v.1.1.2.11  
changed lines
  Added in v.1.23
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2