rts/Trace.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team 2006
   4  *
   5  * Debug and performance tracing.
   6  *
   7  * This is a layer over RtsMessages, which provides for generating
   8  * trace messages with timestamps and thread Ids attached
   9  * automatically.  Also, multiple classes of messages are supported,
  10  * which can be enabled separately via RTS flags.
  11  *
  12  * All debug trace messages go through here.  Additionally, we
  13  * generate timestamped trace messages for consumption by profiling
  14  * tools using this API.
  15  *
  16  * ---------------------------------------------------------------------------*/
  17
  18 #ifndef TRACE_H
  19 #define TRACE_H
  20
  21 // -----------------------------------------------------------------------------
  22 // Tracing functions
  23 // -----------------------------------------------------------------------------
  24
  25 void initTracing (void);
  26
  27 // The simple way:
  28 void trace (StgWord32 class, const char *str, ...)
  29     GNUC3_ATTRIBUTE(format (printf, 2, 3));
  30
  31 // The harder way: sometimes we want to generate a trace message that
  32 // consists of multiple components generated by different functions.
  33 // So we provide the functionality of trace() split into 3 parts:
  34 //   - traceClass(): a check that the required class is enabled
  35 //   - traceBegin(): print the beginning of the trace message
  36 //   - traceEnd(): complete the trace message (release the lock too).
  37 //
  38 INLINE_HEADER rtsBool traceClass (StgWord32 class);
  39
  40 void traceBegin (const char *str, ...)
  41     GNUC3_ATTRIBUTE(format (printf, 1, 2));
  42
  43 void traceEnd (void);
  44
  45 #ifdef DEBUG
  46 #define debugTrace(class, str, ...) trace(class,str, ## __VA_ARGS__)
  47 // variable arg macros are C99, and supported by gcc.
  48 #define debugTraceBegin(str, ...) traceBegin(str, ## __VA_ARGS__)
  49 #define debugTraceEnd() traceEnd()
  50 #else
  51 #define debugTrace(class, str, ...) /* nothing */
  52 #define debugTraceBegin(str, ...) /* nothing */
  53 #define debugTraceEnd() /* nothing */
  54 #endif
  55
  56
  57 // -----------------------------------------------------------------------------
  58 // Message classes, these may be OR-ed together
  59 // -----------------------------------------------------------------------------
  60
  61 // debugging flags, set with +RTS -D<something>
  62 #define DEBUG_sched                (1<<0)
  63 #define DEBUG_interp               (1<<1)
  64 #define DEBUG_weak                 (1<<2)
  65 #define DEBUG_gccafs               (1<<3)
  66 #define DEBUG_gc                   (1<<4)
  67 #define DEBUG_block_alloc          (1<<5)
  68 #define DEBUG_sanity               (1<<6)
  69 #define DEBUG_stable               (1<<7)
  70 #define DEBUG_stm                  (1<<8)
  71 #define DEBUG_prof                 (1<<9)
  72 #define DEBUG_gran                 (1<<10)
  73 #define DEBUG_par                  (1<<11)
  74 #define DEBUG_linker               (1<<12)
  75 #define DEBUG_squeeze              (1<<13)
  76 #define DEBUG_hpc                  (1<<14)
  77
  78 // Tracing flags
  79 #define TRACE_sched                (1<<20)
  80 #define TRACE_gc                   (1<<21)
  81
  82 // -----------------------------------------------------------------------------
  83 // PRIVATE below here
  84 // -----------------------------------------------------------------------------
  85
  86 extern StgWord32 classes_enabled;
  87
  88 INLINE_HEADER rtsBool
  89 traceClass (StgWord32 class) { return (classes_enabled & class); }
  90
  91 // -----------------------------------------------------------------------------
  92
  93 #endif /* TRACE_H */