(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.31 and 1.39

version 1.31, 2007/06/15 17:35:47 version 1.39, 2008/09/02 17:33:37
Line 40 
Line 40 
 #include <Pegasus/Common/Logger.h> #include <Pegasus/Common/Logger.h>
 #include <Pegasus/Common/InternalException.h> #include <Pegasus/Common/InternalException.h>
 #include <Pegasus/Common/TraceComponents.h> #include <Pegasus/Common/TraceComponents.h>
 #include <Pegasus/Common/TraceFileHandler.h>  #include <Pegasus/Common/TraceHandler.h>
 #include <Pegasus/Common/Linkage.h> #include <Pegasus/Common/Linkage.h>
 #include <Pegasus/Common/SharedPtr.h> #include <Pegasus/Common/SharedPtr.h>
  
Line 60 
Line 60 
 { {
 public: public:
  
   
       /** Trace facilities
           File - tracing occurs to the trace file
           Log  - tracing occurs through the Pegasus Logger class
           Keep the TRACE_FACILITY_LIST in sync with the TRACE_FACILITY_INDEX,
           so that the index matches the according string in the list.
        */
       static char const* TRACE_FACILITY_LIST[];
   
       enum TRACE_FACILITY_INDEX
       {
           TRACE_FACILITY_FILE = 0,
           TRACE_FACILITY_LOG  = 1,
           TRACE_FACILITY_MEMORY = 2
       };
   
   
     /** Levels of trace     /** Levels of trace
         Trace messages are written to the trace file only if they are at or         Trace messages are written to the trace file only if they are at or
         above a given trace level         above a given trace level
         LEVEL1 - Function Entry/Exit          LEVEL1 - Severe and log messages
         LEVEL2 - Basic flow trace messages, low data detail         LEVEL2 - Basic flow trace messages, low data detail
         LEVEL3 - Inter-function logic flow, medium data detail         LEVEL3 - Inter-function logic flow, medium data detail
         LEVEL4 - High data detail         LEVEL4 - High data detail
Line 92 
Line 109 
         line number of the CIMException originator.         line number of the CIMException originator.
         @param traceComponent  component being traced         @param traceComponent  component being traced
         @param level           trace level of the trace message         @param level           trace level of the trace message
         @param CIMException    the CIMException to be traced.          @param cimException    the CIMException to be traced.
      */      */
     static void traceCIMException(     static void traceCIMException(
         const Uint32 traceComponent,         const Uint32 traceComponent,
Line 138 
Line 155 
     static void setTraceComponents(     static void setTraceComponents(
        const String& traceComponents);        const String& traceComponents);
  
       /** Set trace facility to be used
           @param traceFacility facility to be used for tracing,
                  for example Log or File.
           @return 0      if trace facility is valid
                   1      if trace facility is invalid
       */
       static Uint32 setTraceFacility(const String& traceFacility);
   
       /** Get trace facility currently in use
           @return TRACE_FACILITY_FILE - if trace facility is file
                   TRACE_FACILITY_LOG - if trace facility is the log
       */
       static Uint32 getTraceFacility();
   
       /** Set buffer size to be used for the memory tracing facility
           @param bufferSize buffer size in Kbyte to be used for memory tracing
           @return true   if function was successfully.
       */
       static Boolean setTraceMemoryBufferSize(Uint32 bufferSize);
   
       /** Flushes the trace buffer to traceFilePath. This method will only
           have an effect when traceFacility=Memory.
       */
       static void flushTrace();
   
     /** Traces method entry.     /** Traces method entry.
         @param token           TracerToken         @param token           TracerToken
         @param fileName        filename of the trace originator         @param fileName        filename of the trace originator
Line 186 
Line 228 
         const String& traceComponents,         const String& traceComponents,
         String& invalidComponents);         String& invalidComponents);
  
       /** Validates the trace facility string value
           @param  traceFacility   The trace facility as string
           @return 1        if the trace facility is valid
                   0        if the trace facility is invalid
        */
       static Boolean isValidTraceFacility( const String& traceFacility );
   
     /** Specify the name of the module being traced.  If non-empty, this     /** 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.         value is used as an extension to the name of the trace file.
         @param  moduleName Name of the module being traced.         @param  moduleName Name of the module being traced.
Line 214 
Line 263 
      */      */
     static Boolean _traceOn;     static Boolean _traceOn;
  
       /** Internal only Levels of trace
           These cannot be used in any of the trace calls directly, but are set
           by methods of the Tracer class for specific purposes, such as trace
           Enter and traceExit.
           LEVEL0 - Trace is switched off
           LEVEL5 - used for method enter & exit
        */
       static const Uint32 LEVEL0;
       static const Uint32 LEVEL5;
   
     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 _FAILURE;  
     AutoArrayPtr<Boolean> _traceComponentMask;     AutoArrayPtr<Boolean> _traceComponentMask;
       Uint32                _traceMemoryBufferSize;
       Uint32                _traceFacility;
       //Is true if any components are set at the component mask
       Boolean               _componentsAreSet;
     Uint32              _traceLevelMask;     Uint32              _traceLevelMask;
     AutoPtr<TraceFileHandler> _traceHandler;      TraceHandler*         _traceHandler;
     String              _moduleName;     String              _moduleName;
     static Tracer*      _tracerInstance;     static Tracer*      _tracerInstance;
  
Line 230 
Line 291 
     static const char _METHOD_ENTER_MSG[];     static const char _METHOD_ENTER_MSG[];
     static const char _METHOD_EXIT_MSG[];     static const char _METHOD_EXIT_MSG[];
  
     // Message Strings for Logger      // Factory function to create an instance of the matching trace handler
     static const char _LOG_MSG[];      // for the given type of traceFacility.
       // @param    traceFacility  type of trace handler to create
       void _setTraceHandler( Uint32 traceFacility );
  
     // Traces the given message. Overloaded to include the file name and the     // Traces the given message. Overloaded to include the file name and the
     // line number as one of the parameters.     // line number as one of the parameters.
Line 301 
Line 364 
     static Tracer* _getInstance();     static Tracer* _getInstance();
  
     friend class TraceCallFrame;     friend class TraceCallFrame;
       friend class TracePropertyOwner;
 }; };
  
 //============================================================================== //==============================================================================
Line 312 
Line 376 
  
 #ifdef PEGASUS_REMOVE_TRACE #ifdef PEGASUS_REMOVE_TRACE
  
   inline void Tracer::setTraceHandler( Uint32 traceFacility );
   {
       // empty function
   }
   
 inline void Tracer::traceCString( inline void Tracer::traceCString(
     const char* fileName,     const char* fileName,
     const Uint32 lineNum,     const Uint32 lineNum,
Line 353 
Line 422 
     // empty function     // empty function
 } }
  
   inline Uint32 Tracer::setTraceFacility(const String& traceComponents)
   {
       // empty function
       return 0;
   }
   
   inline Uint32 Tracer::getTraceFacility()
   {
       // empty function
       return 0;
   }
   
   inline static Boolean Trace::setTraceMemoryBufferSize(Uint32 bufferSize)
   {
       // empty function
       return true;
   }
   
   inline void Tracer::flushTrace()
   {
       // empty function
       return;
   }
   
 #endif /* PEGASUS_REMOVE_TRACE */ #endif /* PEGASUS_REMOVE_TRACE */
  
 //============================================================================== //==============================================================================
Line 375 
Line 468 
  
 # define PEG_METHOD_ENTER(comp,meth) # define PEG_METHOD_ENTER(comp,meth)
 # define PEG_METHOD_EXIT() # define PEG_METHOD_EXIT()
 # define PEG_TRACE_STRING(comp,level,string)  
 # define PEG_TRACE(VAR_ARGS) # define PEG_TRACE(VAR_ARGS)
 # define PEG_TRACE_CSTRING(comp,level,chars) # define PEG_TRACE_CSTRING(comp,level,chars)
  
 #else /* PEGASUS_REMOVE_TRACE */ #else /* PEGASUS_REMOVE_TRACE */
  
   // remover trace code for method enter/exit
   # ifdef  PEGASUS_REMOVE_METHODTRACE
   #  define PEG_METHOD_ENTER(comp,meth)
   #  define PEG_METHOD_EXIT()
   # else
 # define PEG_METHOD_ENTER(comp, meth) \ # define PEG_METHOD_ENTER(comp, meth) \
     TracerToken __tracerToken; \     TracerToken __tracerToken; \
       __tracerToken.method = 0; \
     do \     do \
     { \     { \
         if (Tracer::isTraceOn()) \         if (Tracer::isTraceOn()) \
Line 398 
Line 496 
             Tracer::traceExit(__tracerToken PEGASUS_COMMA_FILE_LINE); \             Tracer::traceExit(__tracerToken PEGASUS_COMMA_FILE_LINE); \
     } \     } \
     while (0)     while (0)
   # endif
 // Macro for Trace String.  the do construct allows this to appear  
 // as a single statement.  
 # define PEG_TRACE_STRING(comp, level, string) \  
     do \  
     { \  
         if (Tracer::isTraceOn()) \  
         { \  
             PEGASUS_ASSERT(level != Tracer::LEVEL1); \  
             if (Tracer::isTraceEnabled(comp, level)) \  
             { \  
                 Tracer::traceCString(PEGASUS_FILE_LINE_COMMA \  
                                      comp, \  
                                      (const char*) (string).getCString()); \  
             } \  
         } \  
     } \  
     while (0)  
  
 // Macro to trace character lists.  the do construct allows this to appear // Macro to trace character lists.  the do construct allows this to appear
 // as a single statement. // as a single statement.
Line 424 
Line 505 
     { \     { \
         if (Tracer::isTraceOn()) \         if (Tracer::isTraceOn()) \
         { \         { \
             PEGASUS_ASSERT(level != Tracer::LEVEL1); \  
             if (Tracer::isTraceEnabled(comp, level)) \             if (Tracer::isTraceEnabled(comp, level)) \
             { \             { \
                 Tracer::traceCString(PEGASUS_FILE_LINE_COMMA comp, chars); \                 Tracer::traceCString(PEGASUS_FILE_LINE_COMMA comp, chars); \

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