1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 2008-2009
5 * Support for fast binary event logging.
7 * ---------------------------------------------------------------------------*/
9 #include "PosixSource.h"
15 #include "Capability.h"
22 #ifdef HAVE_SYS_TYPES_H
23 #include <sys/types.h>
29 // PID of the process that writes to event_log_filename (#4512)
30 static pid_t event_log_pid = -1;
32 static char *event_log_filename = NULL;
34 // File for logging events
35 FILE *event_log_file = NULL;
37 #define EVENT_LOG_SIZE 2 * (1024 * 1024) // 2MB
39 static int flushCount;
41 // Struct for record keeping of buffer to store event types and events.
42 typedef struct _EventsBuf {
47 EventCapNo capno; // which capability this buffer belongs to, or -1
50 EventsBuf *capEventBuf; // one EventsBuf for each Capability
52 EventsBuf eventBuf; // an EventsBuf not associated with any Capability
54 Mutex eventBufMutex; // protected by this mutex
58 [EVENT_CREATE_THREAD] = "Create thread",
59 [EVENT_RUN_THREAD] = "Run thread",
60 [EVENT_STOP_THREAD] = "Stop thread",
61 [EVENT_THREAD_RUNNABLE] = "Thread runnable",
62 [EVENT_MIGRATE_THREAD] = "Migrate thread",
63 [EVENT_RUN_SPARK] = "Run spark",
64 [EVENT_STEAL_SPARK] = "Steal spark",
65 [EVENT_SHUTDOWN] = "Shutdown",
66 [EVENT_THREAD_WAKEUP] = "Wakeup thread",
67 [EVENT_GC_START] = "Starting GC",
68 [EVENT_GC_END] = "Finished GC",
69 [EVENT_REQUEST_SEQ_GC] = "Request sequential GC",
70 [EVENT_REQUEST_PAR_GC] = "Request parallel GC",
71 [EVENT_CREATE_SPARK_THREAD] = "Create spark thread",
72 [EVENT_LOG_MSG] = "Log message",
73 [EVENT_USER_MSG] = "User message",
74 [EVENT_STARTUP] = "Startup",
75 [EVENT_GC_IDLE] = "GC idle",
76 [EVENT_GC_WORK] = "GC working",
77 [EVENT_GC_DONE] = "GC done",
78 [EVENT_BLOCK_MARKER] = "Block marker"
83 typedef struct _EventType {
84 EventTypeNum etNum; // Event Type number.
85 nat size; // size of the payload in bytes
86 char *desc; // Description
89 EventType eventTypes[NUM_EVENT_TAGS];
91 static void initEventsBuf(EventsBuf* eb, StgWord64 size, EventCapNo capno);
92 static void resetEventsBuf(EventsBuf* eb);
93 static void printAndClearEventBuf (EventsBuf *eventsBuf);
95 static void postEventType(EventsBuf *eb, EventType *et);
97 static void postLogMsg(EventsBuf *eb, EventTypeNum type, char *msg, va_list ap);
99 static void postBlockMarker(EventsBuf *eb);
100 static void closeBlockMarker(EventsBuf *ebuf);
102 static StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum);
103 static StgBool hasRoomForVariableEvent(EventsBuf *eb, nat payload_bytes);
105 static inline void postWord8(EventsBuf *eb, StgWord8 i)
110 static inline void postWord16(EventsBuf *eb, StgWord16 i)
112 postWord8(eb, (StgWord8)(i >> 8));
113 postWord8(eb, (StgWord8)i);
116 static inline void postWord32(EventsBuf *eb, StgWord32 i)
118 postWord16(eb, (StgWord16)(i >> 16));
119 postWord16(eb, (StgWord16)i);
122 static inline void postWord64(EventsBuf *eb, StgWord64 i)
124 postWord32(eb, (StgWord32)(i >> 32));
125 postWord32(eb, (StgWord32)i);
128 static inline void postBuf(EventsBuf *eb, StgWord8 *buf, nat size)
130 memcpy(eb->pos, buf, size);
134 static inline StgWord64 time_ns(void)
135 { return stat_getElapsedTime() * (1000000000LL/TICKS_PER_SECOND); }
137 static inline void postEventTypeNum(EventsBuf *eb, EventTypeNum etNum)
138 { postWord16(eb, etNum); }
140 static inline void postTimestamp(EventsBuf *eb)
141 { postWord64(eb, time_ns()); }
143 static inline void postThreadID(EventsBuf *eb, EventThreadID id)
144 { postWord32(eb,id); }
146 static inline void postCapNo(EventsBuf *eb, EventCapNo no)
147 { postWord16(eb,no); }
149 static inline void postPayloadSize(EventsBuf *eb, EventPayloadSize size)
150 { postWord16(eb,size); }
152 static inline void postEventHeader(EventsBuf *eb, EventTypeNum type)
154 postEventTypeNum(eb, type);
158 static inline void postInt8(EventsBuf *eb, StgInt8 i)
159 { postWord8(eb, (StgWord8)i); }
161 static inline void postInt16(EventsBuf *eb, StgInt16 i)
162 { postWord16(eb, (StgWord16)i); }
164 static inline void postInt32(EventsBuf *eb, StgInt32 i)
165 { postWord32(eb, (StgWord32)i); }
167 static inline void postInt64(EventsBuf *eb, StgInt64 i)
168 { postWord64(eb, (StgWord64)i); }
172 initEventLogging(void)
177 event_log_filename = stgMallocBytes(strlen(prog_name) + 10,
180 if (sizeof(EventDesc) / sizeof(char*) != NUM_EVENT_TAGS) {
181 barf("EventDesc array has the wrong number of elements");
184 if (event_log_pid == -1) { // #4512
186 sprintf(event_log_filename, "%s.eventlog", prog_name);
187 event_log_pid = getpid();
189 // Forked process, eventlog already started by the parent
191 event_log_pid = getpid();
192 sprintf(event_log_filename, "%s.%d.eventlog", prog_name, event_log_pid);
195 /* Open event log file for writing. */
196 if ((event_log_file = fopen(event_log_filename, "wb")) == NULL) {
197 sysErrorBelch("initEventLogging: can't open %s", event_log_filename);
198 stg_exit(EXIT_FAILURE);
202 * Allocate buffer(s) to store events.
203 * Create buffer large enough for the header begin marker, all event
204 * types, and header end marker to prevent checking if buffer has room
205 * for each of these steps, and remove the need to flush the buffer to
206 * disk during initialization.
208 * Use a single buffer to store the header with event types, then flush
209 * the buffer so all buffers are empty for writing events.
212 // XXX n_capabilities hasn't been initislised yet
213 n_caps = RtsFlags.ParFlags.nNodes;
217 capEventBuf = stgMallocBytes(n_caps * sizeof(EventsBuf),"initEventLogging");
219 for (c = 0; c < n_caps; ++c) {
220 // Init buffer for events.
221 initEventsBuf(&capEventBuf[c], EVENT_LOG_SIZE, c);
223 initEventsBuf(&eventBuf, EVENT_LOG_SIZE, (EventCapNo)(-1));
225 // Write in buffer: the header begin marker.
226 postInt32(&eventBuf, EVENT_HEADER_BEGIN);
228 // Mark beginning of event types in the header.
229 postInt32(&eventBuf, EVENT_HET_BEGIN);
230 for (t = 0; t < NUM_EVENT_TAGS; ++t) {
232 eventTypes[t].etNum = t;
233 eventTypes[t].desc = EventDesc[t];
236 case EVENT_CREATE_THREAD: // (cap, thread)
237 case EVENT_RUN_THREAD: // (cap, thread)
238 case EVENT_THREAD_RUNNABLE: // (cap, thread)
239 case EVENT_RUN_SPARK: // (cap, thread)
240 case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
241 eventTypes[t].size = sizeof(EventThreadID);
244 case EVENT_MIGRATE_THREAD: // (cap, thread, new_cap)
245 case EVENT_STEAL_SPARK: // (cap, thread, victim_cap)
246 case EVENT_THREAD_WAKEUP: // (cap, thread, other_cap)
248 sizeof(EventThreadID) + sizeof(EventCapNo);
251 case EVENT_STOP_THREAD: // (cap, thread, status)
253 sizeof(EventThreadID) + sizeof(StgWord16);
256 case EVENT_STARTUP: // (cap count)
257 eventTypes[t].size = sizeof(EventCapNo);
260 case EVENT_SHUTDOWN: // (cap)
261 case EVENT_REQUEST_SEQ_GC: // (cap)
262 case EVENT_REQUEST_PAR_GC: // (cap)
263 case EVENT_GC_START: // (cap)
264 case EVENT_GC_END: // (cap)
268 eventTypes[t].size = 0;
271 case EVENT_LOG_MSG: // (msg)
272 case EVENT_USER_MSG: // (msg)
273 eventTypes[t].size = 0xffff;
276 case EVENT_BLOCK_MARKER:
277 eventTypes[t].size = sizeof(StgWord32) + sizeof(EventTimestamp) +
282 continue; /* ignore deprecated events */
285 // Write in buffer: the start event type.
286 postEventType(&eventBuf, &eventTypes[t]);
289 // Mark end of event types in the header.
290 postInt32(&eventBuf, EVENT_HET_END);
292 // Write in buffer: the header end marker.
293 postInt32(&eventBuf, EVENT_HEADER_END);
295 // Prepare event buffer for events (data).
296 postInt32(&eventBuf, EVENT_DATA_BEGIN);
298 // Post a STARTUP event with the number of capabilities
299 postEventHeader(&eventBuf, EVENT_STARTUP);
300 postCapNo(&eventBuf, n_caps);
302 // Flush capEventBuf with header.
304 * Flush header and data begin marker to the file, thus preparing the
305 * file to have events written to it.
307 printAndClearEventBuf(&eventBuf);
309 for (c = 0; c < n_caps; ++c) {
310 postBlockMarker(&capEventBuf[c]);
314 initMutex(&eventBufMutex);
319 endEventLogging(void)
323 // Flush all events remaining in the buffers.
324 for (c = 0; c < n_capabilities; ++c) {
325 printAndClearEventBuf(&capEventBuf[c]);
327 printAndClearEventBuf(&eventBuf);
328 resetEventsBuf(&eventBuf); // we don't want the block marker
330 // Mark end of events (data).
331 postEventTypeNum(&eventBuf, EVENT_DATA_END);
333 // Flush the end of data marker.
334 printAndClearEventBuf(&eventBuf);
336 if (event_log_file != NULL) {
337 fclose(event_log_file);
342 freeEventLogging(void)
346 // Free events buffer.
347 for (c = 0; c < n_capabilities; ++c) {
348 if (capEventBuf[c].begin != NULL)
349 stgFree(capEventBuf[c].begin);
351 if (capEventBuf != NULL) {
352 stgFree(capEventBuf);
354 if (event_log_filename != NULL) {
355 stgFree(event_log_filename);
362 if (event_log_file != NULL) {
363 fflush(event_log_file);
368 abortEventLogging(void)
371 if (event_log_file != NULL) {
372 fclose(event_log_file);
376 * Post an event message to the capability's eventlog buffer.
377 * If the buffer is full, prints out the buffer and clears it.
380 postSchedEvent (Capability *cap,
387 eb = &capEventBuf[cap->no];
389 if (!hasRoomForEvent(eb, tag)) {
390 // Flush event buffer to make room for new event.
391 printAndClearEventBuf(eb);
394 postEventHeader(eb, tag);
397 case EVENT_CREATE_THREAD: // (cap, thread)
398 case EVENT_RUN_THREAD: // (cap, thread)
399 case EVENT_THREAD_RUNNABLE: // (cap, thread)
400 case EVENT_RUN_SPARK: // (cap, thread)
402 postThreadID(eb,thread);
406 case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
408 postThreadID(eb,other /* spark_thread */);
412 case EVENT_MIGRATE_THREAD: // (cap, thread, new_cap)
413 case EVENT_STEAL_SPARK: // (cap, thread, victim_cap)
414 case EVENT_THREAD_WAKEUP: // (cap, thread, other_cap)
416 postThreadID(eb,thread);
417 postCapNo(eb,other /* new_cap | victim_cap | other_cap */);
421 case EVENT_STOP_THREAD: // (cap, thread, status)
423 postThreadID(eb,thread);
424 postWord16(eb,other /* status */);
428 case EVENT_SHUTDOWN: // (cap)
429 case EVENT_REQUEST_SEQ_GC: // (cap)
430 case EVENT_REQUEST_PAR_GC: // (cap)
431 case EVENT_GC_START: // (cap)
432 case EVENT_GC_END: // (cap)
438 barf("postEvent: unknown event tag %d", tag);
443 postEvent (Capability *cap, EventTypeNum tag)
447 eb = &capEventBuf[cap->no];
449 if (!hasRoomForEvent(eb, tag)) {
450 // Flush event buffer to make room for new event.
451 printAndClearEventBuf(eb);
454 postEventHeader(eb, tag);
459 void postLogMsg(EventsBuf *eb, EventTypeNum type, char *msg, va_list ap)
464 size = vsnprintf(buf,BUF,msg,ap);
470 if (!hasRoomForVariableEvent(eb, size)) {
471 // Flush event buffer to make room for new event.
472 printAndClearEventBuf(eb);
475 postEventHeader(eb, type);
476 postPayloadSize(eb, size);
477 postBuf(eb,(StgWord8*)buf,size);
480 void postMsg(char *msg, va_list ap)
482 ACQUIRE_LOCK(&eventBufMutex);
483 postLogMsg(&eventBuf, EVENT_LOG_MSG, msg, ap);
484 RELEASE_LOCK(&eventBufMutex);
487 void postCapMsg(Capability *cap, char *msg, va_list ap)
489 postLogMsg(&capEventBuf[cap->no], EVENT_LOG_MSG, msg, ap);
492 void postUserMsg(Capability *cap, char *msg, va_list ap)
494 postLogMsg(&capEventBuf[cap->no], EVENT_USER_MSG, msg, ap);
497 void closeBlockMarker (EventsBuf *ebuf)
503 // (type:16, time:64, size:32, end_time:64)
505 save_pos = ebuf->pos;
506 ebuf->pos = ebuf->marker + sizeof(EventTypeNum) +
507 sizeof(EventTimestamp);
508 postWord32(ebuf, save_pos - ebuf->marker);
510 ebuf->pos = save_pos;
516 void postBlockMarker (EventsBuf *eb)
518 if (!hasRoomForEvent(eb, EVENT_BLOCK_MARKER)) {
519 printAndClearEventBuf(eb);
522 closeBlockMarker(eb);
524 eb->marker = eb->pos;
525 postEventHeader(eb, EVENT_BLOCK_MARKER);
526 postWord32(eb,0); // these get filled in later by closeBlockMarker();
528 postCapNo(eb, eb->capno);
531 void printAndClearEventBuf (EventsBuf *ebuf)
533 StgWord64 numBytes = 0, written = 0;
535 closeBlockMarker(ebuf);
537 if (ebuf->begin != NULL && ebuf->pos != ebuf->begin)
539 numBytes = ebuf->pos - ebuf->begin;
541 written = fwrite(ebuf->begin, 1, numBytes, event_log_file);
542 if (written != numBytes) {
544 "printAndClearEventLog: fwrite() failed, written=%" FMT_Word64
545 " doesn't match numBytes=%" FMT_Word64, written, numBytes);
549 resetEventsBuf(ebuf);
552 postBlockMarker(ebuf);
556 void initEventsBuf(EventsBuf* eb, StgWord64 size, EventCapNo capno)
558 eb->begin = eb->pos = stgMallocBytes(size, "initEventsBuf");
564 void resetEventsBuf(EventsBuf* eb)
570 StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum)
574 size = sizeof(EventTypeNum) + sizeof(EventTimestamp) + eventTypes[eNum].size;
576 if (eb->pos + size > eb->begin + eb->size) {
577 return 0; // Not enough space.
579 return 1; // Buf has enough space for the event.
583 StgBool hasRoomForVariableEvent(EventsBuf *eb, nat payload_bytes)
587 size = sizeof(EventTypeNum) + sizeof(EventTimestamp) +
588 sizeof(EventPayloadSize) + payload_bytes;
590 if (eb->pos + size > eb->begin + eb->size) {
591 return 0; // Not enough space.
593 return 1; // Buf has enough space for the event.
597 void postEventType(EventsBuf *eb, EventType *et)
602 postInt32(eb, EVENT_ET_BEGIN);
603 postEventTypeNum(eb, et->etNum);
604 postWord16(eb, (StgWord16)et->size);
605 desclen = strlen(et->desc);
606 postWord32(eb, desclen);
607 for (d = 0; d < desclen; ++d) {
608 postInt8(eb, (StgInt8)et->desc[d]);
610 postWord32(eb, 0); // no extensions yet
611 postInt32(eb, EVENT_ET_END);