1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 2008-2009
5 * Support for fast binary event logging.
7 * ---------------------------------------------------------------------------*/
13 #include "Capability.h"
20 static char *event_log_filename = NULL;
22 // File for logging events
23 FILE *event_log_file = NULL;
25 #define EVENT_LOG_SIZE 2 * (1024 * 1024) // 2MB
27 static int flushCount;
29 // Struct for record keeping of buffer to store event types and events.
30 typedef struct _EventsBuf {
50 "Request sequential GC",
51 "Request parallel GC",
58 typedef struct _EventType {
59 EventTypeNum etNum; // Event Type number.
60 nat size; // size of the payload in bytes
61 char *desc; // Description
64 EventType eventTypes[NUM_EVENT_TAGS];
66 static void printAndClearEventBuf (EventsBuf *eventsBuf);
67 static void initEventsBuf(EventsBuf* eb, StgWord64 size);
68 static void resetEventsBuf(EventsBuf* eb);
70 static void beginHeader(EventsBuf *eb);
71 static void endHeader(EventsBuf *eb);
73 static void beginData(EventsBuf *eb);
74 static void endData(EventsBuf *eb);
76 static void beginEventTypes(EventsBuf *eb);
77 static void endEventTypes(EventsBuf *eb);
79 static void postEventType(EventsBuf *eb, EventType *et);
81 static StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum);
83 static inline void postWord8(EventsBuf *eb, StgWord8 i)
88 static inline void postWord16(EventsBuf *eb, StgWord16 i)
90 postWord8(eb, (StgWord8)(i >> 8));
91 postWord8(eb, (StgWord8)i);
94 static inline void postWord32(EventsBuf *eb, StgWord32 i)
96 postWord16(eb, (StgWord16)(i >> 16));
97 postWord16(eb, (StgWord16)i);
100 static inline void postWord64(EventsBuf *eb, StgWord64 i)
102 postWord32(eb, (StgWord32)(i >> 32));
103 postWord32(eb, (StgWord32)i);
106 static inline void postEventTypeNum(EventsBuf *eb, EventTypeNum etNum)
107 { postWord16(eb, etNum); }
109 static inline void postTimestamp(EventsBuf *eb, Timestamp t)
110 { postWord64(eb,t); }
112 static inline void postThreadID(EventsBuf *eb, ThreadID id)
113 { postWord32(eb,id); }
115 static inline void postCapNo(EventsBuf *eb, CapNo no)
116 { postWord16(eb,no); }
118 static inline void postInt8(EventsBuf *eb, StgInt8 i)
119 { postWord8(eb, (StgWord8)i); }
121 static inline void postInt16(EventsBuf *eb, StgInt16 i)
122 { postWord16(eb, (StgWord16)i); }
124 static inline void postInt32(EventsBuf *eb, StgInt32 i)
125 { postWord32(eb, (StgWord32)i); }
127 static inline void postInt64(EventsBuf *eb, StgInt64 i)
128 { postWord64(eb, (StgWord64)i); }
132 initEventLogging(void)
136 debugTrace(DEBUG_eventlog, "intiEventLog: start");
138 event_log_filename = stgMallocBytes(strlen(prog_name) + 9,
141 if (sizeof(EventDesc) / sizeof(char*) != NUM_EVENT_TAGS) {
142 barf("EventDesc array has the wrong number of elements");
145 sprintf(event_log_filename, "%s.eventlog", prog_name);
147 /* Open event log file for writing. */
148 if ((event_log_file = fopen(event_log_filename, "wb")) == NULL) {
149 sysErrorBelch("initEventLoggin: can't open %s", event_log_filename);
150 stg_exit(EXIT_FAILURE);
154 * Allocate buffer(s) to store events.
155 * Create buffer large enough for the header begin marker, all event
156 * types, and header end marker to prevent checking if buffer has room
157 * for each of these steps, and remove the need to flush the buffer to
158 * disk during initialization.
160 * Use a single buffer to store the header with event types, then flush
161 * the buffer so all buffers are empty for writing events.
163 eventsBuf = stgMallocBytes(n_capabilities * sizeof(EventsBuf),"initEventLogging");
165 for (c = 0; c < n_capabilities; ++c) {
166 // Init buffer for events.
167 initEventsBuf(&eventsBuf[c], EVENT_LOG_SIZE);
170 // Write in buffer: the header begin marker.
171 beginHeader(&eventsBuf[0]);
173 // Mark beginning of event types in the header.
174 beginEventTypes(&eventsBuf[0]);
175 for (t = 0; t < NUM_EVENT_TAGS; ++t) {
177 eventTypes[t].etNum = t;
178 eventTypes[t].desc = EventDesc[t];
181 case EVENT_CREATE_THREAD: // (cap, thread)
182 case EVENT_RUN_THREAD: // (cap, thread)
183 case EVENT_THREAD_RUNNABLE: // (cap, thread)
184 case EVENT_CREATE_SPARK: // (cap, thread)
185 case EVENT_RUN_SPARK: // (cap, thread)
186 eventTypes[t].size = sizeof(CapNo) + sizeof(ThreadID);
189 case EVENT_SPARK_TO_THREAD: // (cap, thread, spark_thread)
191 sizeof(CapNo) + sizeof(ThreadID) + sizeof(ThreadID);
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(CapNo) + sizeof(ThreadID) + sizeof(CapNo);
201 case EVENT_STOP_THREAD: // (cap, thread, status)
203 sizeof(CapNo) + sizeof(ThreadID) + 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(CapNo);
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_SPARK_TO_THREAD: // (cap, thread, spark_thread)
320 postThreadID(eb,thread);
321 postThreadID(eb,other /* spark_thread */);
325 case EVENT_MIGRATE_THREAD: // (cap, thread, new_cap)
326 case EVENT_STEAL_SPARK: // (cap, thread, victim_cap)
327 case EVENT_THREAD_WAKEUP: // (cap, thread, other_cap)
329 postThreadID(eb,thread);
330 postCapNo(eb,other /* new_cap | victim_cap | other_cap */);
334 case EVENT_STOP_THREAD: // (cap, thread, status)
336 postThreadID(eb,thread);
337 postWord16(eb,other /* status */);
341 case EVENT_SHUTDOWN: // (cap)
342 case EVENT_REQUEST_SEQ_GC: // (cap)
343 case EVENT_REQUEST_PAR_GC: // (cap)
344 case EVENT_GC_START: // (cap)
345 case EVENT_GC_END: // (cap)
351 barf("postEvent: unknown event tag %d", tag);
354 debugTrace(DEBUG_eventlog,"postEvent: finish");
357 static void printAndClearEventBuf (EventsBuf *eventsBuf)
359 StgWord64 numBytes = 0, written = 0;
361 if (eventsBuf->begin != NULL && eventsBuf->pos != eventsBuf->begin)
363 numBytes = eventsBuf->pos - eventsBuf->begin;
365 debugTrace(DEBUG_eventlog,
366 "printAndEventLog: numbytes %" FMT_Word64
367 " bytes to fwrite()",
370 written = fwrite(eventsBuf->begin, 1, numBytes, event_log_file);
371 if (written != numBytes) {
373 "printAndClearEventLog: fwrite() failed, written=%" FMT_Word64
374 " doesn't match numBytes=%" FMT_Word64, written, numBytes);
378 debugTrace(DEBUG_eventlog,
379 "printAndClearEventLog: fwrite(): %" FMT_Word64
380 " bytes written", written);
382 resetEventsBuf(eventsBuf);
388 printAndClearEventLog(Capability *cap)
390 debugTrace(DEBUG_eventlog,"printAndClearEventLog: start");
392 printAndClearEventBuf(&eventsBuf[cap->no]);
394 debugTrace(DEBUG_eventlog,"printAndClearEventLog: finish");
397 /* -----------------------------------------------------------------------------
398 Actual event generation below here
399 -------------------------------------------------------------------------- */
401 void initEventsBuf(EventsBuf* eb, StgWord64 size)
403 eb->begin = eb->pos = malloc(size);
407 void resetEventsBuf(EventsBuf* eb)
412 // N.B.: Assuming buffer contains enough space for the header begin marker.
413 void beginHeader(EventsBuf *eb)
415 postInt32(eb, EVENT_HEADER_BEGIN);
418 // N.B.: Assuming buffer contains enough space for the header end marker.
419 void endHeader(EventsBuf *eb)
421 postInt32(eb, EVENT_HEADER_END);
424 void beginData(EventsBuf *eb)
426 postInt32(eb, EVENT_DATA_BEGIN);
429 void endData(EventsBuf *eb)
431 postEventTypeNum(eb, EVENT_DATA_END);
434 void beginEventTypes(EventsBuf *eb)
436 postInt32(eb, EVENT_HET_BEGIN);
439 void endEventTypes(EventsBuf *eb)
441 postInt32(eb, EVENT_HET_END);
444 StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum)
448 size += sizeof(EventTypeNum) + sizeof(Timestamp) + eventTypes[eNum].size;
450 if (eb->pos + size > eb->begin + eb->size) {
451 return 0; // Not enough space.
453 return 1; // Buf has enough space for the event.
457 static void postEventType(EventsBuf *eb, EventType *et)
462 postInt32(eb, EVENT_ET_BEGIN);
463 postEventTypeNum(eb, et->etNum);
464 postWord16(eb, (StgWord16)et->size);
465 desclen = strlen(et->desc);
466 postWord32(eb, desclen);
467 for (d = 0; d < desclen; ++d) {
468 postInt8(eb, (StgInt8)et->desc[d]);
470 postWord32(eb, 0); // no extensions yet
471 postInt32(eb, EVENT_ET_END);
474 #endif /* EVENTLOG */