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

Diff for /pegasus/src/Pegasus/Common/Tracer.h between version 1.12 and 1.23

version 1.12, 2002/08/17 00:59:36 version 1.23, 2005/11/30 21:04:52
Line 1 
Line 1 
 //%/////////////////////////////////////////////////////////////////////////////  //%2005////////////////////////////////////////////////////////////////////////
 // //
 // Copyright (c) 2000, 2001, 2002 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.
   // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
   // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
   // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
   // EMC Corporation; VERITAS Software 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 24 
Line 30 
 // Author: Sushma Fernandes, Hewlett-Packard Company (sushma_fernandes@hp.com) // Author: Sushma Fernandes, Hewlett-Packard Company (sushma_fernandes@hp.com)
 // //
 // Modified By: Jenny Yu, Hewlett-Packard Company (jenny_yu@hp.com) // 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)
   //              David Dillard, Symantec Corp. (david_dillard@symantec.com)
 // //
 //%///////////////////////////////////////////////////////////////////////////// //%/////////////////////////////////////////////////////////////////////////////
  
Line 31 
Line 40 
 #define Pegasus_Tracer_h #define Pegasus_Tracer_h
  
 #include <stdarg.h> #include <stdarg.h>
 #include <fstream>  
 #include <Pegasus/Common/String.h> #include <Pegasus/Common/String.h>
 #include <Pegasus/Common/System.h> #include <Pegasus/Common/System.h>
 #include <Pegasus/Common/Logger.h> #include <Pegasus/Common/Logger.h>
Line 39 
Line 47 
 #include <Pegasus/Common/TraceComponents.h> #include <Pegasus/Common/TraceComponents.h>
 #include <Pegasus/Common/TraceFileHandler.h> #include <Pegasus/Common/TraceFileHandler.h>
 #include <Pegasus/Common/Linkage.h> #include <Pegasus/Common/Linkage.h>
   #include <Pegasus/Common/AutoPtr.h>
  
 PEGASUS_NAMESPACE_BEGIN PEGASUS_NAMESPACE_BEGIN
  
Line 137 
Line 146 
         }         }
  
         static void setTraceComponents(         static void setTraceComponents(
           const String traceComponents)            const String& traceComponents)
         {         {
               // empty function               // empty function
         }         }
Line 156 
Line 165 
             const char*  data,             const char*  data,
             const Uint32 size)             const Uint32 size)
         {         {
               if (_traceOn)
               {
             _traceBuffer( traceComponent, traceLevel, data, size );             _traceBuffer( traceComponent, traceLevel, data, size );
         }         }
           }
  
         /** Traces the specified number of bytes in a given buffer         /** Traces the specified number of bytes in a given buffer
             Overloaded to include the filename and the line number             Overloaded to include the filename and the line number
Line 177 
Line 189 
             const char*  data,             const char*  data,
             const Uint32 size)             const Uint32 size)
         {         {
               if (_traceOn)
               {
             _traceBuffer( fileName, lineNum,             _traceBuffer( fileName, lineNum,
                           traceComponent, traceLevel, data, size );                           traceComponent, traceLevel, data, size );
         }         }
           }
  
  
         /** Traces the given message         /** Traces the given message
Line 194 
Line 209 
             const char *fmt,             const char *fmt,
             ...)             ...)
         {         {
               if (_traceOn)
               {
             va_list argList;             va_list argList;
  
             va_start(argList,fmt);             va_start(argList,fmt);
             _trace(traceComponent,traceLevel,fmt,argList);             _trace(traceComponent,traceLevel,fmt,argList);
             va_end(argList);             va_end(argList);
         }         }
           }
  
         /** Traces the given message. Overloaded to include the filename and         /** Traces the given message. Overloaded to include the filename and
             the line number of trace origin.             the line number of trace origin.
Line 218 
Line 236 
             const char* fmt,             const char* fmt,
             ...)             ...)
         {         {
               if (_traceOn)
               {
             va_list argList;             va_list argList;
  
             va_start(argList,fmt);             va_start(argList,fmt);
             _trace(fileName,lineNum,traceComponent,traceLevel,fmt,argList);             _trace(fileName,lineNum,traceComponent,traceLevel,fmt,argList);
             va_end(argList);             va_end(argList);
         }         }
           }
  
         /** Traces the given string.  Overloaded to include the filename         /** Traces the given string.  Overloaded to include the filename
             and line number of trace origin.             and line number of trace origin.
Line 240 
Line 261 
             const Uint32  traceLevel,             const Uint32  traceLevel,
             const String& traceString)             const String& traceString)
         {         {
               if (_traceOn)
               {
             _traceString( fileName, lineNum, traceComponent, traceLevel,             _traceString( fileName, lineNum, traceComponent, traceLevel,
                           traceString );                           traceString );
         }         }
           }
  
         /** Traces the message in the given CIMException object.  The message         /** Traces the message in the given CIMException object.  The message
             written to the trace file will include the source filename and             written to the trace file will include the source filename and
Line 256 
Line 280 
             const Uint32  traceLevel,             const Uint32  traceLevel,
             CIMException  cimException)             CIMException  cimException)
         {         {
               if (_traceOn)
               {
             _traceCIMException( traceComponent, traceLevel, cimException );             _traceCIMException( traceComponent, traceLevel, cimException );
         }         }
           }
  
         /** Set the trace file to the given file         /** Set the trace file to the given file
             @param    traceFile       full path of the trace file             @param    traceFile       full path of the trace file
             @return   0               if the filepath is valid             @return   0               if the filepath is valid
                       1               if an error occurs while opening the file                        1               if the traceFile is an empty string or
                                         if an error occurs while opening the file
                                       in append mode                                       in append mode
         */         */
         static Uint32 setTraceFile(const char* traceFile);         static Uint32 setTraceFile(const char* traceFile);
Line 279 
Line 307 
                       components should be separated by ','                       components should be separated by ','
         */         */
         static void setTraceComponents(         static void setTraceComponents(
            const String traceComponents);             const String& traceComponents);
  
     #endif     #endif
  
Line 297 
Line 325 
         const Uint32 traceComponent,         const Uint32 traceComponent,
         const char* methodName)         const char* methodName)
     {     {
           if (_traceOn)
           {
         _traceEnter( fileName, lineNum, traceComponent, "%s %s",         _traceEnter( fileName, lineNum, traceComponent, "%s %s",
             _METHOD_ENTER_MSG, methodName);             _METHOD_ENTER_MSG, methodName);
     }     }
       }
  
     /** Traces method exit.     /** Traces method exit.
         @param    fileName        filename of the trace originator         @param    fileName        filename of the trace originator
Line 313 
Line 344 
         const Uint32 traceComponent,         const Uint32 traceComponent,
         const char* methodName)         const char* methodName)
     {     {
           if (_traceOn)
           {
         _traceExit( fileName, lineNum, traceComponent, "%s %s",         _traceExit( fileName, lineNum, traceComponent, "%s %s",
             _METHOD_EXIT_MSG, methodName);             _METHOD_EXIT_MSG, methodName);
     }     }
       }
  
     /** Validates the File Path for the trace File     /** Validates the File Path for the trace File
         @param    filePath full path of the file         @param    filePath full path of the file
Line 329 
Line 363 
         @return   1        if the components are valid         @return   1        if the components are valid
                   0        if one or more components are invalid                   0        if one or more components are invalid
      */      */
     static Boolean isValidComponents(const String traceComponents);      static Boolean isValidComponents(const String& traceComponents);
  
     /** Validates the trace components     /** Validates the trace components
         @param    traceComponents   comma separated list of trace components         @param    traceComponents   comma separated list of trace components
Line 338 
Line 372 
                   0        if one or more components are invalid                   0        if one or more components are invalid
      */      */
     static Boolean isValidComponents(     static Boolean isValidComponents(
         const String traceComponents,          const String& traceComponents,
         String& invalidComponents);         String& invalidComponents);
  
       /** Specify the name of the module being traced.  If non-empty, this
           value is used as an extension to the name of the trace file.
           @param    moduleName   Name of the module being traced.
        */
       static void setModuleName(const String& moduleName);
   
       static Boolean isTraceOn() { return _traceOn; }
   
 private: private:
  
       /** A static single indicator if tracing is turned on allowing to
           determine the state of trace quickly without many instructions.
           Used to wrap the public static trace interface methods to avoid
           obsolete calls when tracing is turned off.
        */
       static Boolean _traceOn;
   
     static const char   _COMPONENT_SEPARATOR;     static const char   _COMPONENT_SEPARATOR;
     static const Uint32 _NUM_COMPONENTS;     static const Uint32 _NUM_COMPONENTS;
     static const Uint32 _STRLEN_MAX_UNSIGNED_INT;     static const Uint32 _STRLEN_MAX_UNSIGNED_INT;
     static const Uint32 _STRLEN_MAX_PID_TID;     static const Uint32 _STRLEN_MAX_PID_TID;
     static const Boolean _SUCCESS;     static const Boolean _SUCCESS;
     static const Boolean _FAILURE;     static const Boolean _FAILURE;
     Boolean*            _traceComponentMask;      AutoArrayPtr<Boolean> _traceComponentMask;
     Uint32              _traceLevelMask;     Uint32              _traceLevelMask;
     TraceFileHandler*   _traceHandler;      AutoPtr<TraceFileHandler> _traceHandler;
       String              _moduleName;
     static Tracer*      _tracerInstance;     static Tracer*      _tracerInstance;
  
     // Message Strings for function Entry and Exit     // Message Strings for function Entry and Exit
Line 517 
Line 567 
     #define PEG_METHOD_ENTER(traceComponent,methodName)     #define PEG_METHOD_ENTER(traceComponent,methodName)
     #define PEG_METHOD_EXIT()     #define PEG_METHOD_EXIT()
     #define PEG_TRACE_STRING(traceComponent,traceLevel,traceString)     #define PEG_TRACE_STRING(traceComponent,traceLevel,traceString)
   #   define PEG_TRACE(VAR_ARGS)
 #else #else
     /** Macro for tracing method entry     /** Macro for tracing method entry
         @param    traceComponent  component being traced         @param    traceComponent  component being traced
         @param    methodName      name of the method         @param    methodName      name of the method
      */      */
     #define PEG_METHOD_ENTER(traceComponent,methodName) \     #define PEG_METHOD_ENTER(traceComponent,methodName) \
         const char *PEG_METHOD_NAME = methodName; \          static const char *PEG_METHOD_NAME = methodName; \
         const Uint32 PEG_TRACE_COMPONENT = traceComponent; \          static const Uint32 PEG_TRACE_COMPONENT = traceComponent; \
         Tracer::traceEnter(__FILE__,__LINE__,PEG_TRACE_COMPONENT,PEG_METHOD_NAME)          if (Tracer::isTraceOn()) \
           { \
               Tracer::traceEnter( \
                   __FILE__,__LINE__,PEG_TRACE_COMPONENT,PEG_METHOD_NAME); \
           } \
  
     /** Macro for tracing method exit     /** Macro for tracing method exit
      */      */
     #define PEG_METHOD_EXIT() \     #define PEG_METHOD_EXIT() \
         Tracer::traceExit(__FILE__,__LINE__,PEG_TRACE_COMPONENT,PEG_METHOD_NAME)          do \
           { \
               if (Tracer::isTraceOn()) \
                   Tracer::traceExit( \
                       __FILE__,__LINE__,PEG_TRACE_COMPONENT,PEG_METHOD_NAME); \
           } \
           while (0)
  
     /** Macro for tracing a string     /** Macro for tracing a string
         @param    traceComponent  component being traced         @param    traceComponent  component being traced
Line 538 
Line 599 
         @param    traceString     the string to be traced         @param    traceString     the string to be traced
      */      */
     #define PEG_TRACE_STRING(traceComponent,traceLevel,traceString) \     #define PEG_TRACE_STRING(traceComponent,traceLevel,traceString) \
         Tracer::trace(__FILE__, __LINE__,traceComponent,traceLevel,traceString)          do \
           { \
               if (Tracer::isTraceOn()) \
                   Tracer::trace( \
                       __FILE__, __LINE__,traceComponent,traceLevel,traceString); \
           } \
           while (0)
   
   #   define PEG_TRACE(VAR_ARGS) \
           do \
           { \
               if (Tracer::isTraceOn()) \
                   Tracer::trace VAR_ARGS; \
           } \
           while (0)
  
 #endif #endif
  

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