Sync EventLogFormat.h with ghc-events
[ghc.git] / includes / rts / EventLogFormat.h
1 /* -----------------------------------------------------------------------------
2 *
3 * (c) The GHC Team, 2008-2009
4 *
5 * Event log format
6 *
7 * The log format is designed to be extensible: old tools should be
8 * able to parse (but not necessarily understand all of) new versions
9 * of the format, and new tools will be able to understand old log
10 * files.
11 *
12 * Each event has a specific format. If you add new events, give them
13 * new numbers: we never re-use old event numbers.
14 *
15 * - The format is endian-independent: all values are represented in
16 * bigendian order.
17 *
18 * - The format is extensible:
19 *
20 * - The header describes each event type and its length. Tools
21 * that don't recognise a particular event type can skip those events.
22 *
23 * - There is room for extra information in the event type
24 * specification, which can be ignored by older tools.
25 *
26 * - Events can have extra information added, but existing fields
27 * cannot be changed. Tools should ignore extra fields at the
28 * end of the event record.
29 *
30 * - Old event type ids are never re-used; just take a new identifier.
31 *
32 *
33 * The format
34 * ----------
35 *
36 * log : EVENT_HEADER_BEGIN
37 * EventType*
38 * EVENT_HEADER_END
39 * EVENT_DATA_BEGIN
40 * Event*
41 * EVENT_DATA_END
42 *
43 * EventType :
44 * EVENT_ET_BEGIN
45 * Word16 -- unique identifier for this event
46 * Int16 -- >=0 size of the event in bytes (minus the header)
47 * -- -1 variable size
48 * Word32 -- length of the next field in bytes
49 * Word8* -- string describing the event
50 * Word32 -- length of the next field in bytes
51 * Word8* -- extra info (for future extensions)
52 * EVENT_ET_END
53 *
54 * Event :
55 * Word16 -- event_type
56 * Word64 -- time (nanosecs)
57 * [Word16] -- length of the rest (for variable-sized events only)
58 * ... extra event-specific info ...
59 *
60 *
61 * To add a new event
62 * ------------------
63 *
64 * - In this file:
65 * - give it a new number, add a new #define EVENT_XXX below
66 * - In EventLog.c
67 * - add it to the EventDesc array
68 * - emit the event type in initEventLogging()
69 * - emit the new event in postEvent_()
70 * - generate the event itself by calling postEvent() somewhere
71 * - In the Haskell code to parse the event log file:
72 * - add types and code to read the new event
73 *
74 * -------------------------------------------------------------------------- */
75
76 #ifndef RTS_EVENTLOGFORMAT_H
77 #define RTS_EVENTLOGFORMAT_H
78
79 /*
80 * Markers for begin/end of the Header.
81 */
82 #define EVENT_HEADER_BEGIN 0x68647262 /* 'h' 'd' 'r' 'b' */
83 #define EVENT_HEADER_END 0x68647265 /* 'h' 'd' 'r' 'e' */
84
85 #define EVENT_DATA_BEGIN 0x64617462 /* 'd' 'a' 't' 'b' */
86 #define EVENT_DATA_END 0xffff
87
88 /*
89 * Markers for begin/end of the list of Event Types in the Header.
90 * Header, Event Type, Begin = hetb
91 * Header, Event Type, End = hete
92 */
93 #define EVENT_HET_BEGIN 0x68657462 /* 'h' 'e' 't' 'b' */
94 #define EVENT_HET_END 0x68657465 /* 'h' 'e' 't' 'e' */
95
96 #define EVENT_ET_BEGIN 0x65746200 /* 'e' 't' 'b' 0 */
97 #define EVENT_ET_END 0x65746500 /* 'e' 't' 'e' 0 */
98
99 /*
100 * Types of event
101 */
102 #define EVENT_CREATE_THREAD 0 /* (thread) */
103 #define EVENT_RUN_THREAD 1 /* (thread) */
104 #define EVENT_STOP_THREAD 2 /* (thread, status, blockinfo) */
105 #define EVENT_THREAD_RUNNABLE 3 /* (thread) */
106 #define EVENT_MIGRATE_THREAD 4 /* (thread, new_cap) */
107 /* 5, 6 deprecated */
108 #define EVENT_SHUTDOWN 7 /* () */
109 #define EVENT_THREAD_WAKEUP 8 /* (thread, other_cap) */
110 #define EVENT_GC_START 9 /* () */
111 #define EVENT_GC_END 10 /* () */
112 #define EVENT_REQUEST_SEQ_GC 11 /* () */
113 #define EVENT_REQUEST_PAR_GC 12 /* () */
114 /* 13, 14 deprecated */
115 #define EVENT_CREATE_SPARK_THREAD 15 /* (spark_thread) */
116 #define EVENT_LOG_MSG 16 /* (message ...) */
117 #define EVENT_STARTUP 17 /* (num_capabilities) */
118 #define EVENT_BLOCK_MARKER 18 /* (size, end_time, capability) */
119 #define EVENT_USER_MSG 19 /* (message ...) */
120 #define EVENT_GC_IDLE 20 /* () */
121 #define EVENT_GC_WORK 21 /* () */
122 #define EVENT_GC_DONE 22 /* () */
123 /* 23, 24 used by eden */
124 #define EVENT_CAPSET_CREATE 25 /* (capset, capset_type) */
125 #define EVENT_CAPSET_DELETE 26 /* (capset) */
126 #define EVENT_CAPSET_ASSIGN_CAP 27 /* (capset, cap) */
127 #define EVENT_CAPSET_REMOVE_CAP 28 /* (capset, cap) */
128 /* the RTS identifier is in the form of "GHC-version rts_way" */
129 #define EVENT_RTS_IDENTIFIER 29 /* (capset, name_version_string) */
130 /* the vectors in these events are null separated strings */
131 #define EVENT_PROGRAM_ARGS 30 /* (capset, commandline_vector) */
132 #define EVENT_PROGRAM_ENV 31 /* (capset, environment_vector) */
133 #define EVENT_OSPROCESS_PID 32 /* (capset, pid) */
134 #define EVENT_OSPROCESS_PPID 33 /* (capset, parent_pid) */
135 #define EVENT_SPARK_COUNTERS 34 /* (crt,dud,ovf,cnv,fiz,gcd,rem) */
136 #define EVENT_SPARK_CREATE 35 /* () */
137 #define EVENT_SPARK_DUD 36 /* () */
138 #define EVENT_SPARK_OVERFLOW 37 /* () */
139 #define EVENT_SPARK_RUN 38 /* () */
140 #define EVENT_SPARK_STEAL 39 /* (victim_cap) */
141 #define EVENT_SPARK_FIZZLE 40 /* () */
142 #define EVENT_SPARK_GC 41 /* () */
143 #define EVENT_INTERN_STRING 42 /* (string, id) {not used by ghc} */
144
145
146 /* Range 43 - 59 is available for new GHC and common events */
147
148 /* Range 60 - 80 is used by eden for parallel tracing
149 * see http://www.mathematik.uni-marburg.de/~eden/
150 */
151
152 /* Range 100 - 139 is reserved for Mercury */
153
154 /*
155 * The highest event code +1 that ghc itself emits. Note that some event
156 * ranges higher than this are reserved but not currently emitted by ghc.
157 * This must match the size of the EventDesc[] array in EventLog.c
158 */
159 #define NUM_GHC_EVENT_TAGS 42
160
161 #if 0 /* DEPRECATED EVENTS: */
162 /* we don't actually need to record the thread, it's implicit */
163 #define EVENT_RUN_SPARK 5 /* (thread) */
164 #define EVENT_STEAL_SPARK 6 /* (thread, victim_cap) */
165 /* ghc changed how it handles sparks so these are no longer applicable */
166 #define EVENT_CREATE_SPARK 13 /* (cap, thread) */
167 #define EVENT_SPARK_TO_THREAD 14 /* (cap, thread, spark_thread) */
168 /* these are used by eden but are replaced by new alternatives for ghc */
169 #define EVENT_VERSION 23 /* (version_string) */
170 #define EVENT_PROGRAM_INVOCATION 24 /* (commandline_string) */
171 #endif
172
173 /*
174 * Status values for EVENT_STOP_THREAD
175 *
176 * 1-5 are the StgRun return values (from includes/Constants.h):
177 *
178 * #define HeapOverflow 1
179 * #define StackOverflow 2
180 * #define ThreadYielding 3
181 * #define ThreadBlocked 4
182 * #define ThreadFinished 5
183 * #define ForeignCall 6
184 * #define BlockedOnMVar 7
185 * #define BlockedOnBlackHole 8
186 * #define BlockedOnRead 9
187 * #define BlockedOnWrite 10
188 * #define BlockedOnDelay 11
189 * #define BlockedOnSTM 12
190 * #define BlockedOnDoProc 13
191 * #define BlockedOnCCall -- not used (see ForeignCall)
192 * #define BlockedOnCCall_NoUnblockExc -- not used (see ForeignCall)
193 * #define BlockedOnMsgThrowTo 16
194 */
195 #define THREAD_SUSPENDED_FOREIGN_CALL 6
196
197 /*
198 * Capset type values for EVENT_CAPSET_CREATE
199 */
200 #define CAPSET_TYPE_CUSTOM 1 /* reserved for end-user applications */
201 #define CAPSET_TYPE_OSPROCESS 2 /* caps belong to the same OS process */
202 #define CAPSET_TYPE_CLOCKDOMAIN 3 /* caps share a local clock/time */
203
204 #ifndef EVENTLOG_CONSTANTS_ONLY
205
206 typedef StgWord16 EventTypeNum;
207 typedef StgWord64 EventTimestamp; /* in nanoseconds */
208 typedef StgWord32 EventThreadID;
209 typedef StgWord16 EventCapNo;
210 typedef StgWord16 EventPayloadSize; /* variable-size events */
211 typedef StgWord16 EventThreadStatus; /* status for EVENT_STOP_THREAD */
212 typedef StgWord32 EventCapsetID;
213 typedef StgWord16 EventCapsetType; /* types for EVENT_CAPSET_CREATE */
214
215 #endif
216
217 #endif /* RTS_EVENTLOGFORMAT_H */