rts/eventlog/EventLog.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 2008-2009
   4  *
   5  * Support for fast binary event logging.
   6  *
   7  * ---------------------------------------------------------------------------*/
   8
   9 #ifndef EVENTLOG_H
  10 #define EVENTLOG_H
  11
  12 #include "rts/EventLogFormat.h"
  13 #include "Capability.h"
  14
  15 #include "BeginPrivate.h"
  16
  17 #ifdef TRACING
  18
  19 /*
  20  * Descriptions of EventTags for events.
  21  */
  22 extern char *EventTagDesc[];
  23
  24 void initEventLogging(void);
  25 void endEventLogging(void);
  26 void freeEventLogging(void);
  27 void abortEventLogging(void); // #4512 - after fork child needs to abort
  28 void flushEventLog(void);     // event log inherited from parent
  29
  30 /*
  31  * Post a scheduler event to the capability's event buffer (an event
  32  * that has an associated thread).
  33  */
  34 void postSchedEvent(Capability *cap, EventTypeNum tag,
  35                     StgThreadID id, StgWord info1, StgWord info2);
  36
  37 /*
  38  * Post a nullary event.
  39  */
  40 void postEvent(Capability *cap, EventTypeNum tag);
  41
  42 void postMsg(char *msg, va_list ap);
  43
  44 void postUserMsg(Capability *cap, char *msg, va_list ap);
  45
  46 void postCapMsg(Capability *cap, char *msg, va_list ap);
  47
  48 void postEventStartup(EventCapNo n_caps);
  49
  50 /*
  51  * Post a capability set modification event
  52  */
  53 void postCapsetModifyEvent (EventTypeNum tag,
  54                             EventCapsetID capset,
  55                             StgWord32 other);
  56
  57 /*
  58  * Post a capability set event with a string payload
  59  */
  60 void postCapsetStrEvent (EventTypeNum tag,
  61                          EventCapsetID capset,
  62                          char *msg);
  63
  64 /*
  65  * Post a capability set event with several strings payload
  66  */
  67 void postCapsetVecEvent (EventTypeNum tag,
  68                          EventCapsetID capset,
  69                          int argc,
  70                          char *msg[]);
  71
  72 #else /* !TRACING */
  73
  74 INLINE_HEADER void postSchedEvent (Capability *cap  STG_UNUSED,
  75                                    EventTypeNum tag STG_UNUSED,
  76                                    StgThreadID id   STG_UNUSED,
  77                                    StgWord info1    STG_UNUSED,
  78                                    StgWord info2    STG_UNUSED)
  79 { /* nothing */ }
  80
  81 INLINE_HEADER void postEvent (Capability *cap  STG_UNUSED,
  82                               EventTypeNum tag STG_UNUSED)
  83 { /* nothing */ }
  84
  85 INLINE_HEADER void postMsg (char *msg STG_UNUSED,
  86                             va_list ap STG_UNUSED)
  87 { /* nothing */ }
  88
  89 INLINE_HEADER void postCapMsg (Capability *cap STG_UNUSED,
  90                                char *msg STG_UNUSED,
  91                                va_list ap STG_UNUSED)
  92 { /* nothing */ }
  93
  94 #endif
  95
  96 #include "EndPrivate.h"
  97
  98 #endif /* TRACING_H */