EventLog.c 12 KB
Newer Older
Simon Marlow's avatar
Simon Marlow committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
/* -----------------------------------------------------------------------------
 *
 * (c) The GHC Team, 2008-2009
 *
 * Support for fast binary event logging.
 *
 * ---------------------------------------------------------------------------*/

#ifdef EVENTLOG

#include "Rts.h"
#include "EventLog.h"
#include "Capability.h"
#include "Trace.h"
#include "RtsUtils.h"
#include "Stats.h"
#include <string.h> 
#include <stdio.h>

static char *event_log_filename = NULL;

// File for logging events
FILE *event_log_file = NULL;

#define EVENT_LOG_SIZE 2 * (1024 * 1024) // 2MB

static int flushCount;

// Struct for record keeping of buffer to store event types and events.
typedef struct _EventsBuf {
  StgInt8 *begin;
  StgInt8 *pos;
  StgWord64 size;
} EventsBuf;

EventsBuf *eventsBuf;

char *EventDesc[] = {
  "Create thread",
  "Run thread",
  "Stop thread",
  "Thread runnable",
  "Migrate thread",
  "Run spark",
  "Steal spark",
  "Shutdown",
  "Wakeup thread",
  "Starting GC",
49
  "Finished GC",
50 51
  "Request sequential GC",
  "Request parallel GC",
52
  "Create spark"
Simon Marlow's avatar
Simon Marlow committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
};

// Event type. 

typedef struct _EventType {
  EventTypeNum etNum;  // Event Type number.
  nat   size;     // size of the payload in bytes
  char *desc;     // Description
} EventType;

EventType eventTypes[NUM_EVENT_TAGS];

static void printAndClearEventBuf (EventsBuf *eventsBuf);
static void initEventsBuf(EventsBuf* eb, StgWord64 size);
static void resetEventsBuf(EventsBuf* eb);

static void beginHeader(EventsBuf *eb);
static void endHeader(EventsBuf *eb);

static void beginData(EventsBuf *eb);
static void endData(EventsBuf *eb);

static void beginEventTypes(EventsBuf *eb);
static void endEventTypes(EventsBuf *eb);

static void postEventType(EventsBuf *eb, EventType *et);

static StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum);

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
static inline void postWord8(EventsBuf *eb, StgWord8 i)
{
    *(eb->pos++) = i; 
}

static inline void postWord16(EventsBuf *eb, StgWord16 i)
{
    postWord8(eb, (StgWord8)(i >> 8));
    postWord8(eb, (StgWord8)i);
}

static inline void postWord32(EventsBuf *eb, StgWord32 i)
{
    postWord16(eb, (StgWord16)(i >> 16));
    postWord16(eb, (StgWord16)i);
}

static inline void postWord64(EventsBuf *eb, StgWord64 i)
{
    postWord32(eb, (StgWord32)(i >> 32));
    postWord32(eb, (StgWord32)i);
}

static inline void postEventTypeNum(EventsBuf *eb, EventTypeNum etNum)
{ postWord16(eb, etNum); }

static inline void postEventTypeID(EventsBuf *eb, StgWord16 etID)
{ postWord16(eb, etID); }

static inline void postTimestamp(EventsBuf *eb, Timestamp t)
{ postWord64(eb,t); }

114 115 116 117 118 119
static inline void postThreadID(EventsBuf *eb, ThreadID id)
{ postWord32(eb,id); }

static inline void postCapNo(EventsBuf *eb, CapNo no)
{ postWord16(eb,no); }

120 121 122 123 124 125 126 127 128 129 130 131
static inline void postInt8(EventsBuf *eb, StgInt8 i)
{ postWord8(eb, (StgWord8)i); }

static inline void postInt16(EventsBuf *eb, StgInt16 i)
{ postWord16(eb, (StgWord16)i); }

static inline void postInt32(EventsBuf *eb, StgInt32 i)
{ postWord32(eb, (StgWord32)i); }

static inline void postInt64(EventsBuf *eb, StgInt64 i)
{ postWord64(eb, (StgWord64)i); }

Simon Marlow's avatar
Simon Marlow committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

void
initEventLogging(void)
{
    StgWord8 t, c;

    debugTrace(DEBUG_eventlog, "intiEventLog: start");

    event_log_filename = stgMallocBytes(strlen(prog_name) + 9, 
                                        "initEventLogging");

    if (sizeof(EventDesc) / sizeof(char*) != NUM_EVENT_TAGS) {
        barf("EventDesc array has the wrong number of elements");
    }
  
    sprintf(event_log_filename, "%s.eventlog", prog_name);
    
    /* Open event log file for writing. */
    if ((event_log_file = fopen(event_log_filename, "wb")) == NULL) {
        sysErrorBelch("initEventLoggin: can't open %s", event_log_filename);
        stg_exit(EXIT_FAILURE);    
    }

    /* 
     * Allocate buffer(s) to store events.
     * Create buffer large enough for the header begin marker, all event
     * types, and header end marker to prevent checking if buffer has room
     * for each of these steps, and remove the need to flush the buffer to
     * disk during initialization.
     *
     * Use a single buffer to store the header with event types, then flush 
     * the buffer so all buffers are empty for writing events.
     */
    eventsBuf = stgMallocBytes(n_capabilities * sizeof(EventsBuf),"initEventLogging");

    for (c = 0; c < n_capabilities; ++c) {
        // Init buffer for events.
        initEventsBuf(&eventsBuf[c], EVENT_LOG_SIZE);
    }

    // Write in buffer: the header begin marker.
    beginHeader(&eventsBuf[0]);

    // Mark beginning of event types in the header.
    beginEventTypes(&eventsBuf[0]);
    for (t = 0; t < NUM_EVENT_TAGS; ++t) {

        eventTypes[t].etNum = t;
        eventTypes[t].desc = EventDesc[t];

        switch (t) {
        case EVENT_CREATE_THREAD:   // (cap, thread)
        case EVENT_RUN_THREAD:      // (cap, thread)
        case EVENT_THREAD_RUNNABLE: // (cap, thread)
186
        case EVENT_CREATE_SPARK:    // (cap, thread)
Simon Marlow's avatar
Simon Marlow committed
187
        case EVENT_RUN_SPARK:       // (cap, thread)
188
            eventTypes[t].size = sizeof(CapNo) + sizeof(ThreadID);
Simon Marlow's avatar
Simon Marlow committed
189 190 191 192 193 194
            break;

        case EVENT_MIGRATE_THREAD:  // (cap, thread, new_cap)
        case EVENT_STEAL_SPARK:     // (cap, thread, victim_cap)
        case EVENT_THREAD_WAKEUP:   // (cap, thread, other_cap)
            eventTypes[t].size =
195
                sizeof(CapNo) + sizeof(ThreadID) + sizeof(CapNo);
Simon Marlow's avatar
Simon Marlow committed
196 197 198 199
            break;

        case EVENT_STOP_THREAD:     // (cap, thread, status)
            eventTypes[t].size =
200
                sizeof(CapNo) + sizeof(ThreadID) + sizeof(StgWord16);
Simon Marlow's avatar
Simon Marlow committed
201 202 203 204 205 206 207
            break;

        case EVENT_SHUTDOWN:        // (cap)
        case EVENT_REQUEST_SEQ_GC:  // (cap)
        case EVENT_REQUEST_PAR_GC:  // (cap)
        case EVENT_GC_START:        // (cap)
        case EVENT_GC_END:          // (cap)
208
            eventTypes[t].size = sizeof(CapNo);
Simon Marlow's avatar
Simon Marlow committed
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
            break;
        }

        // Write in buffer: the start event type.
        postEventType(&eventsBuf[0], &eventTypes[t]);
    }

    // Mark end of event types in the header.
    endEventTypes(&eventsBuf[0]);
    
    // Write in buffer: the header end marker.
    endHeader(&eventsBuf[0]);
    
    // Prepare event buffer for events (data).
    beginData(&eventsBuf[0]);
    
    // Flush eventsBuf with header.
    /*
     * Flush header and data begin marker to the file, thus preparing the
     * file to have events written to it.
     */
    printAndClearEventBuf(&eventsBuf[0]);

    debugTrace(DEBUG_eventlog, "initEventLog: finish"); 
}

void
endEventLogging(void)
{
    nat c;

    debugTrace(DEBUG_eventlog,"endEventLog: start");
    
    // Flush all events remaining in the buffers.
    for (c = 0; c < n_capabilities; ++c) {
        printAndClearEventBuf(&eventsBuf[c]);
    }

    // Mark end of events (data).
    endData(&eventsBuf[0]);

    // Flush the end of data marker.
    printAndClearEventBuf(&eventsBuf[0]);

    if (event_log_file != NULL) {
        fclose(event_log_file);
    }
    
    debugTrace(DEBUG_eventlog,"endEventLog: finish");
}

void 
freeEventLogging(void)
{
    StgWord8 c;

    debugTrace(DEBUG_eventlog,"freeEventLog: start"); 
    
    // Free events buffer.
    for (c = 0; c < n_capabilities; ++c) {
        if (eventsBuf[c].begin != NULL) 
            stgFree(eventsBuf[c].begin);
    }
    if (eventsBuf != NULL)  {
        stgFree(eventsBuf);
    }
    if (event_log_filename != NULL) {
        stgFree(event_log_filename);
    }
    
    debugTrace(DEBUG_eventlog,"freeEventLog: finish"); 
}

/*
 * Post an event message to the capability's eventlog buffer.
 * If the buffer is full, prints out the buffer and clears it.
 */
void
287
postEvent_(Capability *cap, EventTypeNum tag, StgThreadID thread, StgWord64 other)
Simon Marlow's avatar
Simon Marlow committed
288 289 290 291 292 293 294 295 296 297 298 299 300 301
{
    EventsBuf *eb;

    debugTrace(DEBUG_eventlog,"postEvent: start");
    
    eb = &eventsBuf[cap->no];

    if (!hasRoomForEvent(eb, tag)) {
        // Flush event buffer to make room for new event.
        printAndClearEventBuf(eb);
    }
    
    postEventTypeNum(eb, tag);
    postTimestamp(eb, stat_getElapsedTime() * (1000000000LL/TICKS_PER_SECOND));
302
    postCapNo(eb, cap->no);
Simon Marlow's avatar
Simon Marlow committed
303 304 305 306 307

    switch (tag) {
    case EVENT_CREATE_THREAD:   // (cap, thread)
    case EVENT_RUN_THREAD:      // (cap, thread)
    case EVENT_THREAD_RUNNABLE: // (cap, thread)
308
    case EVENT_CREATE_SPARK:    // (cap, thread)
Simon Marlow's avatar
Simon Marlow committed
309 310
    case EVENT_RUN_SPARK:       // (cap, thread)
    {
311
        postThreadID(eb,thread);
Simon Marlow's avatar
Simon Marlow committed
312 313 314 315 316 317 318
        break;
    }

    case EVENT_MIGRATE_THREAD:  // (cap, thread, new_cap)
    case EVENT_STEAL_SPARK:     // (cap, thread, victim_cap)
    case EVENT_THREAD_WAKEUP:   // (cap, thread, other_cap)
    {
319 320
        postThreadID(eb,thread);
        postCapNo(eb,other /* new_cap | victim_cap | other_cap */);
Simon Marlow's avatar
Simon Marlow committed
321 322 323 324 325
        break;
    }

    case EVENT_STOP_THREAD:     // (cap, thread, status)
    {
326 327
        postThreadID(eb,thread);
        postWord16(eb,other /* status */);
Simon Marlow's avatar
Simon Marlow committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
        break;
    }

    case EVENT_SHUTDOWN:        // (cap)
    case EVENT_REQUEST_SEQ_GC:  // (cap)
    case EVENT_REQUEST_PAR_GC:  // (cap)
    case EVENT_GC_START:        // (cap)
    case EVENT_GC_END:          // (cap)
    {
        break;
    }

    default:
        barf("postEvent: unknown event tag %d", tag);
    }

    debugTrace(DEBUG_eventlog,"postEvent: finish");
}

static void printAndClearEventBuf (EventsBuf *eventsBuf)
{
    StgWord64 numBytes = 0, written = 0;

    if (eventsBuf->begin != NULL && eventsBuf->pos != eventsBuf->begin)
    {
        numBytes = eventsBuf->pos - eventsBuf->begin;
        
        debugTrace(DEBUG_eventlog, 
                   "printAndEventLog: numbytes %" FMT_Word64
                   " bytes to fwrite()",
                   numBytes);
        
        written = fwrite(eventsBuf->begin, 1, numBytes, event_log_file);
        if (written != numBytes) {
            debugBelch(
                "printAndClearEventLog: fwrite() failed, written=%" FMT_Word64
                " doesn't match numBytes=%" FMT_Word64, written, numBytes);
            return;
        }
        
        debugTrace(DEBUG_eventlog,
                   "printAndClearEventLog: fwrite(): %" FMT_Word64 
                   " bytes written", written);
        
        resetEventsBuf(eventsBuf);
        flushCount++;
    }
}

void
printAndClearEventLog(Capability *cap)
{
    debugTrace(DEBUG_eventlog,"printAndClearEventLog: start");
    
    printAndClearEventBuf(&eventsBuf[cap->no]);
    
    debugTrace(DEBUG_eventlog,"printAndClearEventLog: finish");
}

/* -----------------------------------------------------------------------------
   Actual event generation below here
   -------------------------------------------------------------------------- */

void initEventsBuf(EventsBuf* eb, StgWord64 size)
{
    eb->begin = eb->pos = malloc(size);
    eb->size = size;
}

void resetEventsBuf(EventsBuf* eb)
{
    eb->pos = eb->begin;
}

// N.B.: Assuming buffer contains enough space for the header begin marker.
void beginHeader(EventsBuf *eb)
{
    postInt32(eb, EVENT_HEADER_BEGIN);
}

// N.B.: Assuming buffer contains enough space for the header end marker.
void endHeader(EventsBuf *eb)
{
    postInt32(eb, EVENT_HEADER_END);
}

void beginData(EventsBuf *eb)
{
    postInt32(eb, EVENT_DATA_BEGIN);
}

void endData(EventsBuf *eb)
{
    postEventTypeNum(eb, EVENT_DATA_END);
}

void beginEventTypes(EventsBuf *eb)
{
    postInt32(eb, EVENT_HET_BEGIN);
}

void endEventTypes(EventsBuf *eb)
{
    postInt32(eb, EVENT_HET_END);
}

StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum)
{
  nat size = 0;

  size += sizeof(EventTypeNum) + sizeof(Timestamp) + eventTypes[eNum].size;

  if (eb->pos + size > eb->begin + eb->size) {
      return 0; // Not enough space.
  } else  {
      return 1; // Buf has enough space for the event.
  }
}

static void postEventType(EventsBuf *eb, EventType *et)
{
    StgWord8 d;
    nat desclen;

    postInt32(eb, EVENT_ET_BEGIN);
    postEventTypeNum(eb, et->etNum);
    postWord16(eb, (StgWord16)et->size);
    desclen = strlen(et->desc);
    postWord32(eb, desclen);
    for (d = 0; d < desclen; ++d) {
        postInt8(eb, (StgInt8)et->desc[d]);
    }
    postWord32(eb, 0); // no extensions yet
    postInt32(eb, EVENT_ET_END);
}

#endif /* EVENTLOG */