1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 2008-2009
5 * Support for fast binary event logging.
7 * ---------------------------------------------------------------------------*/
11 #include "PosixSource.h"
15 #include "Capability.h"
23 static char *event_log_filename = NULL;
25 // File for logging events
26 FILE *event_log_file = NULL;
28 #define EVENT_LOG_SIZE 2 * (1024 * 1024) // 2MB
30 static int flushCount;
32 // Struct for record keeping of buffer to store event types and events.
33 typedef struct _EventsBuf {
42 [EVENT_CREATE_THREAD] = "Create thread",
43 [EVENT_RUN_THREAD] = "Run thread",
44 [EVENT_STOP_THREAD] = "Stop thread",
45 [EVENT_THREAD_RUNNABLE] = "Thread runnable",
46 [EVENT_MIGRATE_THREAD] = "Migrate thread",
47 [EVENT_RUN_SPARK] = "Run spark",
48 [EVENT_STEAL_SPARK] = "Steal spark",
49 [EVENT_SHUTDOWN] = "Shutdown",
50 [EVENT_THREAD_WAKEUP] = "Wakeup thread",
51 [EVENT_GC_START] = "Starting GC",
52 [EVENT_GC_END] = "Finished GC",
53 [EVENT_REQUEST_SEQ_GC] = "Request sequential GC",
54 [EVENT_REQUEST_PAR_GC] = "Request parallel GC",
55 [EVENT_CREATE_SPARK] = "Create spark",
56 [EVENT_SPARK_TO_THREAD] = "Spark to thread", /* DEPRECATED! */
57 [EVENT_CREATE_SPARK_THREAD] = "Create spark thread"
62 typedef struct _EventType {
63 EventTypeNum etNum; // Event Type number.
64 nat size; // size of the payload in bytes
65 char *desc; // Description
68 EventType eventTypes[NUM_EVENT_TAGS];
70 static void printAndClearEventBuf (EventsBuf *eventsBuf);
71 static void initEventsBuf(EventsBuf* eb, StgWord64 size);
72 static void resetEventsBuf(EventsBuf* eb);
74 static void beginHeader(EventsBuf *eb);
75 static void endHeader(EventsBuf *eb);
77 static void beginData(EventsBuf *eb);
78 static void endData(EventsBuf *eb);
80 static void beginEventTypes(EventsBuf *eb);
81 static void endEventTypes(EventsBuf *eb);
83 static void postEventType(EventsBuf *eb, EventType *et);
85 static StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum);
87 static inline void postWord8(EventsBuf *eb, StgWord8 i)
92 static inline void postWord16(EventsBuf *eb, StgWord16 i)
94 postWord8(eb, (StgWord8)(i >> 8));
95 postWord8(eb, (StgWord8)i);
98 static inline void postWord32(EventsBuf *eb, StgWord32 i)
100 postWord16(eb, (StgWord16)(i >> 16));
101 postWord16(eb, (StgWord16)i);
104 static inline void postWord64(EventsBuf *eb, StgWord64 i)
106 postWord32(eb, (StgWord32)(i >> 32));
107 postWord32(eb, (StgWord32)i);
110 static inline void postEventTypeNum(EventsBuf *eb, EventTypeNum etNum)
111 { postWord16(eb, etNum); }
113 static inline void postTimestamp(EventsBuf *eb, EventTimestamp t)
114 { postWord64(eb,t); }
116 static inline void postThreadID(EventsBuf *eb, EventThreadID id)
117 { postWord32(eb,id); }
119 static inline void postCapNo(EventsBuf *eb, EventCapNo no)
120 { postWord16(eb,no); }
122 static inline void postInt8(EventsBuf *eb, StgInt8 i)
123 { postWord8(eb, (StgWord8)i); }
125 static inline void postInt16(EventsBuf *eb, StgInt16 i)
126 { postWord16(eb, (StgWord16)i); }
128 static inline void postInt32(EventsBuf *eb, StgInt32 i)
129 { postWord32(eb, (StgWord32)i); }
131 static inline void postInt64(EventsBuf *eb, StgInt64 i)
132 { postWord64(eb, (StgWord64)i); }
136 initEventLogging(void)
140 debugTrace(DEBUG_eventlog, "intiEventLog: start");
142 event_log_filename = stgMallocBytes(strlen(prog_name) + 10,
145 if (sizeof(EventDesc) / sizeof(char*) != NUM_EVENT_TAGS) {
146 barf("EventDesc array has the wrong number of elements");
149 sprintf(event_log_filename, "%s.eventlog", prog_name);
151 /* Open event log file for writing. */
152 if ((event_log_file = fopen(event_log_filename, "wb")) == NULL) {
153 sysErrorBelch("initEventLoggin: can't open %s", event_log_filename);
154 stg_exit(EXIT_FAILURE);
158 * Allocate buffer(s) to store events.
159 * Create buffer large enough for the header begin marker, all event
160 * types, and header end marker to prevent checking if buffer has room
161 * for each of these steps, and remove the need to flush the buffer to
162 * disk during initialization.
164 * Use a single buffer to store the header with event types, then flush
165 * the buffer so all buffers are empty for writing events.
167 eventsBuf = stgMallocBytes(n_capabilities * sizeof(EventsBuf),"initEventLogging");
169 for (c = 0; c < n_capabilities; ++c) {
170 // Init buffer for events.
171 initEventsBuf(&eventsBuf[c], EVENT_LOG_SIZE);
174 // Write in buffer: the header begin marker.
175 beginHeader(&eventsBuf[0]);
177 // Mark beginning of event types in the header.
178 beginEventTypes(&eventsBuf[0]);
179 for (t = 0; t < NUM_EVENT_TAGS; ++t) {
181 eventTypes[t].etNum = t;
182 eventTypes[t].desc = EventDesc[t];
185 case EVENT_CREATE_THREAD: // (cap, thread)
186 case EVENT_RUN_THREAD: // (cap, thread)
187 case EVENT_THREAD_RUNNABLE: // (cap, thread)
188 case EVENT_CREATE_SPARK: // (cap, thread)
189 case EVENT_RUN_SPARK: // (cap, thread)
190 case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
191 eventTypes[t].size = sizeof(EventCapNo) + sizeof(EventThreadID);
194 case EVENT_MIGRATE_THREAD: // (cap, thread, new_cap)
195 case EVENT_STEAL_SPARK: // (cap, thread, victim_cap)
196 case EVENT_THREAD_WAKEUP: // (cap, thread, other_cap)
198 sizeof(EventCapNo) + sizeof(EventThreadID) + sizeof(EventCapNo);
201 case EVENT_STOP_THREAD: // (cap, thread, status)
203 sizeof(EventCapNo) + sizeof(EventThreadID) + sizeof(StgWord16);
206 case EVENT_SHUTDOWN: // (cap)
207 case EVENT_REQUEST_SEQ_GC: // (cap)
208 case EVENT_REQUEST_PAR_GC: // (cap)
209 case EVENT_GC_START: // (cap)
210 case EVENT_GC_END: // (cap)
211 eventTypes[t].size = sizeof(EventCapNo);
215 // Write in buffer: the start event type.
216 postEventType(&eventsBuf[0], &eventTypes[t]);
219 // Mark end of event types in the header.
220 endEventTypes(&eventsBuf[0]);
222 // Write in buffer: the header end marker.
223 endHeader(&eventsBuf[0]);
225 // Prepare event buffer for events (data).
226 beginData(&eventsBuf[0]);
228 // Flush eventsBuf with header.
230 * Flush header and data begin marker to the file, thus preparing the
231 * file to have events written to it.
233 printAndClearEventBuf(&eventsBuf[0]);
235 debugTrace(DEBUG_eventlog, "initEventLog: finish");
239 endEventLogging(void)
243 debugTrace(DEBUG_eventlog,"endEventLog: start");
245 // Flush all events remaining in the buffers.
246 for (c = 0; c < n_capabilities; ++c) {
247 printAndClearEventBuf(&eventsBuf[c]);
250 // Mark end of events (data).
251 endData(&eventsBuf[0]);
253 // Flush the end of data marker.
254 printAndClearEventBuf(&eventsBuf[0]);
256 if (event_log_file != NULL) {
257 fclose(event_log_file);
260 debugTrace(DEBUG_eventlog,"endEventLog: finish");
264 freeEventLogging(void)
268 debugTrace(DEBUG_eventlog,"freeEventLog: start");
270 // Free events buffer.
271 for (c = 0; c < n_capabilities; ++c) {
272 if (eventsBuf[c].begin != NULL)
273 stgFree(eventsBuf[c].begin);
275 if (eventsBuf != NULL) {
278 if (event_log_filename != NULL) {
279 stgFree(event_log_filename);
282 debugTrace(DEBUG_eventlog,"freeEventLog: finish");
286 * Post an event message to the capability's eventlog buffer.
287 * If the buffer is full, prints out the buffer and clears it.
290 postEvent_(Capability *cap, EventTypeNum tag, StgThreadID thread, StgWord64 other)
294 debugTrace(DEBUG_eventlog,"postEvent: start");
296 eb = &eventsBuf[cap->no];
298 if (!hasRoomForEvent(eb, tag)) {
299 // Flush event buffer to make room for new event.
300 printAndClearEventBuf(eb);
303 postEventTypeNum(eb, tag);
304 postTimestamp(eb, stat_getElapsedTime() * (1000000000LL/TICKS_PER_SECOND));
305 postCapNo(eb, cap->no);
308 case EVENT_CREATE_THREAD: // (cap, thread)
309 case EVENT_RUN_THREAD: // (cap, thread)
310 case EVENT_THREAD_RUNNABLE: // (cap, thread)
311 case EVENT_CREATE_SPARK: // (cap, thread)
312 case EVENT_RUN_SPARK: // (cap, thread)
314 postThreadID(eb,thread);
318 case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
320 postThreadID(eb,other /* spark_thread */);
324 case EVENT_MIGRATE_THREAD: // (cap, thread, new_cap)
325 case EVENT_STEAL_SPARK: // (cap, thread, victim_cap)
326 case EVENT_THREAD_WAKEUP: // (cap, thread, other_cap)
328 postThreadID(eb,thread);
329 postCapNo(eb,other /* new_cap | victim_cap | other_cap */);
333 case EVENT_STOP_THREAD: // (cap, thread, status)
335 postThreadID(eb,thread);
336 postWord16(eb,other /* status */);
340 case EVENT_SHUTDOWN: // (cap)
341 case EVENT_REQUEST_SEQ_GC: // (cap)
342 case EVENT_REQUEST_PAR_GC: // (cap)
343 case EVENT_GC_START: // (cap)
344 case EVENT_GC_END: // (cap)
350 barf("postEvent: unknown event tag %d", tag);
353 debugTrace(DEBUG_eventlog,"postEvent: finish");
356 static void printAndClearEventBuf (EventsBuf *eventsBuf)
358 StgWord64 numBytes = 0, written = 0;
360 if (eventsBuf->begin != NULL && eventsBuf->pos != eventsBuf->begin)
362 numBytes = eventsBuf->pos - eventsBuf->begin;
364 debugTrace(DEBUG_eventlog,
365 "printAndEventLog: numbytes %" FMT_Word64
366 " bytes to fwrite()",
369 written = fwrite(eventsBuf->begin, 1, numBytes, event_log_file);
370 if (written != numBytes) {
372 "printAndClearEventLog: fwrite() failed, written=%" FMT_Word64
373 " doesn't match numBytes=%" FMT_Word64, written, numBytes);
377 debugTrace(DEBUG_eventlog,
378 "printAndClearEventLog: fwrite(): %" FMT_Word64
379 " bytes written", written);
381 resetEventsBuf(eventsBuf);
387 printAndClearEventLog(Capability *cap)
389 debugTrace(DEBUG_eventlog,"printAndClearEventLog: start");
391 printAndClearEventBuf(&eventsBuf[cap->no]);
393 debugTrace(DEBUG_eventlog,"printAndClearEventLog: finish");
396 /* -----------------------------------------------------------------------------
397 Actual event generation below here
398 -------------------------------------------------------------------------- */
400 void initEventsBuf(EventsBuf* eb, StgWord64 size)
402 eb->begin = eb->pos = stgMallocBytes(size, "initEventsBuf");
406 void resetEventsBuf(EventsBuf* eb)
411 // N.B.: Assuming buffer contains enough space for the header begin marker.
412 void beginHeader(EventsBuf *eb)
414 postInt32(eb, EVENT_HEADER_BEGIN);
417 // N.B.: Assuming buffer contains enough space for the header end marker.
418 void endHeader(EventsBuf *eb)
420 postInt32(eb, EVENT_HEADER_END);
423 void beginData(EventsBuf *eb)
425 postInt32(eb, EVENT_DATA_BEGIN);
428 void endData(EventsBuf *eb)
430 postEventTypeNum(eb, EVENT_DATA_END);
433 void beginEventTypes(EventsBuf *eb)
435 postInt32(eb, EVENT_HET_BEGIN);
438 void endEventTypes(EventsBuf *eb)
440 postInt32(eb, EVENT_HET_END);
443 StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum)
447 size += sizeof(EventTypeNum) + sizeof(EventTimestamp) + eventTypes[eNum].size;
449 if (eb->pos + size > eb->begin + eb->size) {
450 return 0; // Not enough space.
452 return 1; // Buf has enough space for the event.
456 static void postEventType(EventsBuf *eb, EventType *et)
461 postInt32(eb, EVENT_ET_BEGIN);
462 postEventTypeNum(eb, et->etNum);
463 postWord16(eb, (StgWord16)et->size);
464 desclen = strlen(et->desc);
465 postWord32(eb, desclen);
466 for (d = 0; d < desclen; ++d) {
467 postInt8(eb, (StgInt8)et->desc[d]);
469 postWord32(eb, 0); // no extensions yet
470 postInt32(eb, EVENT_ET_END);
473 #endif /* EVENTLOG */