EventLog.h 2.62 KB
Newer Older
Simon Marlow's avatar
Simon Marlow committed
1 2 3 4 5 6 7 8 9 10 11
/* -----------------------------------------------------------------------------
 *
 * (c) The GHC Team, 2008-2009
 *
 * Support for fast binary event logging.
 *
 * ---------------------------------------------------------------------------*/

#ifndef EVENTLOG_H
#define EVENTLOG_H

Simon Marlow's avatar
Simon Marlow committed
12
#include "rts/EventLogFormat.h"
Simon Marlow's avatar
Simon Marlow committed
13 14
#include "Capability.h"

15
#include "BeginPrivate.h"
16

17
#ifdef TRACING
Simon Marlow's avatar
Simon Marlow committed
18 19 20 21 22 23 24 25 26

/*
 * Descriptions of EventTags for events.
 */
extern char *EventTagDesc[];

void initEventLogging(void);
void endEventLogging(void);
void freeEventLogging(void);
27 28
void abortEventLogging(void); // #4512 - after fork child needs to abort
void flushEventLog(void);     // event log inherited from parent
Simon Marlow's avatar
Simon Marlow committed
29 30

/* 
31 32
 * Post a scheduler event to the capability's event buffer (an event
 * that has an associated thread).
Simon Marlow's avatar
Simon Marlow committed
33
 */
34
void postSchedEvent(Capability *cap, EventTypeNum tag, 
35
                    StgThreadID id, StgWord info1, StgWord info2);
36

37 38 39 40 41
/*
 * Post a nullary event.
 */
void postEvent(Capability *cap, EventTypeNum tag);

42 43
void postMsg(char *msg, va_list ap);

44
void postUserMsg(Capability *cap, char *msg, va_list ap);
45

46
void postCapMsg(Capability *cap, char *msg, va_list ap);
Simon Marlow's avatar
Simon Marlow committed
47

48 49
void postEventStartup(EventCapNo n_caps);

50 51 52 53 54 55 56
/*
 * Post a capability set modification event
 */
void postCapsetModifyEvent (EventTypeNum tag,
                            EventCapsetID capset,
                            StgWord32 other);

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
/*
 * Post a capability set event with a string payload
 */
void postCapsetStrEvent (EventTypeNum tag,
                         EventCapsetID capset,
                         char *msg);

/*
 * Post a capability set event with several strings payload
 */
void postCapsetVecEvent (EventTypeNum tag,
                         EventCapsetID capset,
                         int argc,
                         char *msg[]);

72 73 74 75 76
#else /* !TRACING */

INLINE_HEADER void postSchedEvent (Capability *cap  STG_UNUSED,
                                   EventTypeNum tag STG_UNUSED,
                                   StgThreadID id   STG_UNUSED,
77 78
                                   StgWord info1    STG_UNUSED,
                                   StgWord info2    STG_UNUSED)
79 80
{ /* nothing */ }

81 82 83 84
INLINE_HEADER void postEvent (Capability *cap  STG_UNUSED,
                              EventTypeNum tag STG_UNUSED)
{ /* nothing */ }

85 86 87
INLINE_HEADER void postMsg (char *msg STG_UNUSED, 
                            va_list ap STG_UNUSED)
{ /* nothing */ }
Simon Marlow's avatar
Simon Marlow committed
88

89
INLINE_HEADER void postCapMsg (Capability *cap STG_UNUSED,
90 91 92
                               char *msg STG_UNUSED, 
                               va_list ap STG_UNUSED)
{ /* nothing */ }
Simon Marlow's avatar
Simon Marlow committed
93 94 95

#endif

96
#include "EndPrivate.h"
97

98
#endif /* TRACING_H */