EventLog.c 16.2 KB
Newer Older
Simon Marlow's avatar
Simon Marlow committed
1 2 3 4 5 6 7 8
/* -----------------------------------------------------------------------------
 *
 * (c) The GHC Team, 2008-2009
 *
 * Support for fast binary event logging.
 *
 * ---------------------------------------------------------------------------*/

Simon Marlow's avatar
Simon Marlow committed
9
#include "PosixSource.h"
Simon Marlow's avatar
Simon Marlow committed
10
#include "Rts.h"
Simon Marlow's avatar
Simon Marlow committed
11

12 13 14
#ifdef TRACING

#include "Trace.h"
Simon Marlow's avatar
Simon Marlow committed
15 16 17
#include "Capability.h"
#include "RtsUtils.h"
#include "Stats.h"
18
#include "EventLog.h"
Simon Marlow's avatar
Simon Marlow committed
19

20
#include <string.h>
Simon Marlow's avatar
Simon Marlow committed
21
#include <stdio.h>
22 23 24 25 26 27 28 29 30
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

// PID of the process that writes to event_log_filename (#4512)
static pid_t event_log_pid = -1;
Simon Marlow's avatar
Simon Marlow committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44

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;
Simon Marlow's avatar
Simon Marlow committed
45
  StgInt8 *marker;
Simon Marlow's avatar
Simon Marlow committed
46
  StgWord64 size;
47
  EventCapNo capno; // which capability this buffer belongs to, or -1
Simon Marlow's avatar
Simon Marlow committed
48 49
} EventsBuf;

50 51 52 53 54 55
EventsBuf *capEventBuf; // one EventsBuf for each Capability

EventsBuf eventBuf; // an EventsBuf not associated with any Capability
#ifdef THREADED_RTS
Mutex eventBufMutex; // protected by this mutex
#endif
Simon Marlow's avatar
Simon Marlow committed
56 57

char *EventDesc[] = {
58 59 60 61 62 63 64 65 66 67 68 69 70
  [EVENT_CREATE_THREAD]       = "Create thread",
  [EVENT_RUN_THREAD]          = "Run thread",
  [EVENT_STOP_THREAD]         = "Stop thread",
  [EVENT_THREAD_RUNNABLE]     = "Thread runnable",
  [EVENT_MIGRATE_THREAD]      = "Migrate thread",
  [EVENT_RUN_SPARK]           = "Run spark",
  [EVENT_STEAL_SPARK]         = "Steal spark",
  [EVENT_SHUTDOWN]            = "Shutdown",
  [EVENT_THREAD_WAKEUP]       = "Wakeup thread",
  [EVENT_GC_START]            = "Starting GC",
  [EVENT_GC_END]              = "Finished GC",
  [EVENT_REQUEST_SEQ_GC]      = "Request sequential GC",
  [EVENT_REQUEST_PAR_GC]      = "Request parallel GC",
71 72
  [EVENT_CREATE_SPARK_THREAD] = "Create spark thread",
  [EVENT_LOG_MSG]             = "Log message",
73
  [EVENT_USER_MSG]            = "User message",
Simon Marlow's avatar
Simon Marlow committed
74
  [EVENT_STARTUP]             = "Startup",
75 76 77
  [EVENT_GC_IDLE]             = "GC idle",
  [EVENT_GC_WORK]             = "GC working",
  [EVENT_GC_DONE]             = "GC done",
78
  [EVENT_BLOCK_MARKER]        = "Block marker"
Simon Marlow's avatar
Simon Marlow committed
79 80 81 82 83 84 85 86 87 88 89 90
};

// 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];

91
static void initEventsBuf(EventsBuf* eb, StgWord64 size, EventCapNo capno);
Simon Marlow's avatar
Simon Marlow committed
92
static void resetEventsBuf(EventsBuf* eb);
Simon Marlow's avatar
Simon Marlow committed
93
static void printAndClearEventBuf (EventsBuf *eventsBuf);
Simon Marlow's avatar
Simon Marlow committed
94 95 96

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

97
static void postLogMsg(EventsBuf *eb, EventTypeNum type, char *msg, va_list ap);
98

Simon Marlow's avatar
Simon Marlow committed
99 100 101
static void postBlockMarker(EventsBuf *eb);
static void closeBlockMarker(EventsBuf *ebuf);

Simon Marlow's avatar
Simon Marlow committed
102
static StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum);
103
static StgBool hasRoomForVariableEvent(EventsBuf *eb, nat payload_bytes);
Simon Marlow's avatar
Simon Marlow committed
104

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
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);
}

128 129 130 131 132 133
static inline void postBuf(EventsBuf *eb, StgWord8 *buf, nat size)
{
    memcpy(eb->pos, buf, size);
    eb->pos += size;
}

Simon Marlow's avatar
Simon Marlow committed
134 135 136
static inline StgWord64 time_ns(void)
{ return stat_getElapsedTime() * (1000000000LL/TICKS_PER_SECOND); }

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

Simon Marlow's avatar
Simon Marlow committed
140 141
static inline void postTimestamp(EventsBuf *eb)
{ postWord64(eb, time_ns()); }
142

143
static inline void postThreadID(EventsBuf *eb, EventThreadID id)
144 145
{ postWord32(eb,id); }

146
static inline void postCapNo(EventsBuf *eb, EventCapNo no)
147 148
{ postWord16(eb,no); }

149 150 151
static inline void postPayloadSize(EventsBuf *eb, EventPayloadSize size)
{ postWord16(eb,size); }

Simon Marlow's avatar
Simon Marlow committed
152 153 154 155 156 157
static inline void postEventHeader(EventsBuf *eb, EventTypeNum type)
{
    postEventTypeNum(eb, type);
    postTimestamp(eb);
}    

158 159 160 161 162 163 164 165 166 167 168 169
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
170 171 172 173 174

void
initEventLogging(void)
{
    StgWord8 t, c;
175
    nat n_caps;
Simon Marlow's avatar
Simon Marlow committed
176

177 178 179
    event_log_filename = stgMallocBytes(strlen(prog_name)
                                        + 10 /* .%d */
                                        + 10 /* .eventlog */,
Simon Marlow's avatar
Simon Marlow committed
180 181 182 183 184
                                        "initEventLogging");

    if (sizeof(EventDesc) / sizeof(char*) != NUM_EVENT_TAGS) {
        barf("EventDesc array has the wrong number of elements");
    }
185 186 187 188 189 190 191 192 193 194 195 196

    if (event_log_pid == -1) { // #4512
        // Single process
        sprintf(event_log_filename, "%s.eventlog", prog_name);
        event_log_pid = getpid();
    } else {
        // Forked process, eventlog already started by the parent
        // before fork
        event_log_pid = getpid();
        sprintf(event_log_filename, "%s.%d.eventlog", prog_name, event_log_pid);
    }

Simon Marlow's avatar
Simon Marlow committed
197 198
    /* Open event log file for writing. */
    if ((event_log_file = fopen(event_log_filename, "wb")) == NULL) {
Simon Marlow's avatar
Simon Marlow committed
199
        sysErrorBelch("initEventLogging: can't open %s", event_log_filename);
Simon Marlow's avatar
Simon Marlow committed
200 201 202 203 204 205 206 207 208 209 210 211 212
        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.
     */
213 214 215 216 217 218 219 220 221
#ifdef THREADED_RTS
    // XXX n_capabilities hasn't been initislised yet
    n_caps = RtsFlags.ParFlags.nNodes;
#else
    n_caps = 1;
#endif
    capEventBuf = stgMallocBytes(n_caps * sizeof(EventsBuf),"initEventLogging");

    for (c = 0; c < n_caps; ++c) {
Simon Marlow's avatar
Simon Marlow committed
222
        // Init buffer for events.
223
        initEventsBuf(&capEventBuf[c], EVENT_LOG_SIZE, c);
Simon Marlow's avatar
Simon Marlow committed
224
    }
225
    initEventsBuf(&eventBuf, EVENT_LOG_SIZE, (EventCapNo)(-1));
Simon Marlow's avatar
Simon Marlow committed
226 227

    // Write in buffer: the header begin marker.
Simon Marlow's avatar
Simon Marlow committed
228
    postInt32(&eventBuf, EVENT_HEADER_BEGIN);
Simon Marlow's avatar
Simon Marlow committed
229 230

    // Mark beginning of event types in the header.
Simon Marlow's avatar
Simon Marlow committed
231
    postInt32(&eventBuf, EVENT_HET_BEGIN);
Simon Marlow's avatar
Simon Marlow committed
232 233 234 235 236 237 238 239 240 241
    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)
        case EVENT_RUN_SPARK:       // (cap, thread)
242
        case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
243
            eventTypes[t].size = sizeof(EventThreadID);
244 245
            break;

Simon Marlow's avatar
Simon Marlow committed
246 247 248 249
        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 =
250
                sizeof(EventThreadID) + sizeof(EventCapNo);
Simon Marlow's avatar
Simon Marlow committed
251 252 253 254
            break;

        case EVENT_STOP_THREAD:     // (cap, thread, status)
            eventTypes[t].size =
255
                sizeof(EventThreadID) + sizeof(StgWord16) + sizeof(EventThreadID);
Simon Marlow's avatar
Simon Marlow committed
256 257
            break;

258 259 260 261
        case EVENT_STARTUP:         // (cap count)
            eventTypes[t].size = sizeof(EventCapNo);
            break;

Simon Marlow's avatar
Simon Marlow committed
262 263 264 265 266
        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)
267 268 269
        case EVENT_GC_IDLE:
        case EVENT_GC_WORK:
        case EVENT_GC_DONE:
270
            eventTypes[t].size = 0;
Simon Marlow's avatar
Simon Marlow committed
271
            break;
272 273

        case EVENT_LOG_MSG:          // (msg)
274
        case EVENT_USER_MSG:         // (msg)
275 276 277
            eventTypes[t].size = 0xffff;
            break;

Simon Marlow's avatar
Simon Marlow committed
278
        case EVENT_BLOCK_MARKER:
279 280
            eventTypes[t].size = sizeof(StgWord32) + sizeof(EventTimestamp) + 
                sizeof(EventCapNo);
Simon Marlow's avatar
Simon Marlow committed
281 282
            break;

283 284
        default:
            continue; /* ignore deprecated events */
Simon Marlow's avatar
Simon Marlow committed
285 286 287
        }

        // Write in buffer: the start event type.
288
        postEventType(&eventBuf, &eventTypes[t]);
Simon Marlow's avatar
Simon Marlow committed
289 290 291
    }

    // Mark end of event types in the header.
Simon Marlow's avatar
Simon Marlow committed
292
    postInt32(&eventBuf, EVENT_HET_END);
Simon Marlow's avatar
Simon Marlow committed
293 294
    
    // Write in buffer: the header end marker.
Simon Marlow's avatar
Simon Marlow committed
295
    postInt32(&eventBuf, EVENT_HEADER_END);
Simon Marlow's avatar
Simon Marlow committed
296 297
    
    // Prepare event buffer for events (data).
Simon Marlow's avatar
Simon Marlow committed
298
    postInt32(&eventBuf, EVENT_DATA_BEGIN);
Simon Marlow's avatar
Simon Marlow committed
299
    
300 301 302 303
    // Post a STARTUP event with the number of capabilities
    postEventHeader(&eventBuf, EVENT_STARTUP);
    postCapNo(&eventBuf, n_caps);

304
    // Flush capEventBuf with header.
Simon Marlow's avatar
Simon Marlow committed
305 306 307 308
    /*
     * Flush header and data begin marker to the file, thus preparing the
     * file to have events written to it.
     */
309
    printAndClearEventBuf(&eventBuf);
Simon Marlow's avatar
Simon Marlow committed
310 311 312 313

    for (c = 0; c < n_caps; ++c) {
        postBlockMarker(&capEventBuf[c]);
    }
314 315 316 317

#ifdef THREADED_RTS
    initMutex(&eventBufMutex);
#endif
Simon Marlow's avatar
Simon Marlow committed
318 319 320 321 322 323 324 325 326
}

void
endEventLogging(void)
{
    nat c;

    // Flush all events remaining in the buffers.
    for (c = 0; c < n_capabilities; ++c) {
327
        printAndClearEventBuf(&capEventBuf[c]);
Simon Marlow's avatar
Simon Marlow committed
328
    }
329
    printAndClearEventBuf(&eventBuf);
330
    resetEventsBuf(&eventBuf); // we don't want the block marker
Simon Marlow's avatar
Simon Marlow committed
331 332

    // Mark end of events (data).
Simon Marlow's avatar
Simon Marlow committed
333
    postEventTypeNum(&eventBuf, EVENT_DATA_END);
Simon Marlow's avatar
Simon Marlow committed
334 335

    // Flush the end of data marker.
336
    printAndClearEventBuf(&eventBuf);
Simon Marlow's avatar
Simon Marlow committed
337 338 339 340 341 342 343 344 345 346 347 348 349

    if (event_log_file != NULL) {
        fclose(event_log_file);
    }
}

void 
freeEventLogging(void)
{
    StgWord8 c;
    
    // Free events buffer.
    for (c = 0; c < n_capabilities; ++c) {
350 351
        if (capEventBuf[c].begin != NULL) 
            stgFree(capEventBuf[c].begin);
Simon Marlow's avatar
Simon Marlow committed
352
    }
353 354
    if (capEventBuf != NULL)  {
        stgFree(capEventBuf);
Simon Marlow's avatar
Simon Marlow committed
355 356 357 358 359 360
    }
    if (event_log_filename != NULL) {
        stgFree(event_log_filename);
    }
}

361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
void 
flushEventLog(void)
{
    if (event_log_file != NULL) {
        fflush(event_log_file);
    }
}

void 
abortEventLogging(void)
{
    freeEventLogging();
    if (event_log_file != NULL) {
        fclose(event_log_file);
    }
}
Simon Marlow's avatar
Simon Marlow committed
377 378 379 380 381
/*
 * Post an event message to the capability's eventlog buffer.
 * If the buffer is full, prints out the buffer and clears it.
 */
void
382 383 384
postSchedEvent (Capability *cap, 
                EventTypeNum tag, 
                StgThreadID thread, 
385 386
                StgWord info1,
                StgWord info2)
Simon Marlow's avatar
Simon Marlow committed
387 388 389
{
    EventsBuf *eb;

390
    eb = &capEventBuf[cap->no];
Simon Marlow's avatar
Simon Marlow committed
391 392 393 394 395 396

    if (!hasRoomForEvent(eb, tag)) {
        // Flush event buffer to make room for new event.
        printAndClearEventBuf(eb);
    }
    
Simon Marlow's avatar
Simon Marlow committed
397
    postEventHeader(eb, tag);
Simon Marlow's avatar
Simon Marlow committed
398 399 400 401 402 403 404

    switch (tag) {
    case EVENT_CREATE_THREAD:   // (cap, thread)
    case EVENT_RUN_THREAD:      // (cap, thread)
    case EVENT_THREAD_RUNNABLE: // (cap, thread)
    case EVENT_RUN_SPARK:       // (cap, thread)
    {
405
        postThreadID(eb,thread);
Simon Marlow's avatar
Simon Marlow committed
406 407 408
        break;
    }

409
    case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
410
    {
411
        postThreadID(eb,info1 /* spark_thread */);
412 413 414
        break;
    }

Simon Marlow's avatar
Simon Marlow committed
415 416 417 418
    case EVENT_MIGRATE_THREAD:  // (cap, thread, new_cap)
    case EVENT_STEAL_SPARK:     // (cap, thread, victim_cap)
    case EVENT_THREAD_WAKEUP:   // (cap, thread, other_cap)
    {
419
        postThreadID(eb,thread);
420
        postCapNo(eb,info1 /* new_cap | victim_cap | other_cap */);
Simon Marlow's avatar
Simon Marlow committed
421
        break;
422
   }
Simon Marlow's avatar
Simon Marlow committed
423 424 425

    case EVENT_STOP_THREAD:     // (cap, thread, status)
    {
426
        postThreadID(eb,thread);
427 428
        postWord16(eb,info1 /* status */);
        postThreadID(eb,info2 /* blocked on thread */);
Simon Marlow's avatar
Simon Marlow committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
        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);
    }
444 445
}

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
void
postEvent (Capability *cap, EventTypeNum tag)
{
    EventsBuf *eb;

    eb = &capEventBuf[cap->no];

    if (!hasRoomForEvent(eb, tag)) {
        // Flush event buffer to make room for new event.
        printAndClearEventBuf(eb);
    }

    postEventHeader(eb, tag);
}

461 462
#define BUF 512

463
void postLogMsg(EventsBuf *eb, EventTypeNum type, char *msg, va_list ap)
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
{
    char buf[BUF];
    nat size;

    size = vsnprintf(buf,BUF,msg,ap);
    if (size > BUF) {
        buf[BUF-1] = '\0';
        size = BUF;
    }

    if (!hasRoomForVariableEvent(eb, size)) {
        // Flush event buffer to make room for new event.
        printAndClearEventBuf(eb);
    }

479
    postEventHeader(eb, type);
480 481
    postPayloadSize(eb, size);
    postBuf(eb,(StgWord8*)buf,size);
482
}
483

484 485 486
void postMsg(char *msg, va_list ap)
{
    ACQUIRE_LOCK(&eventBufMutex);
487
    postLogMsg(&eventBuf, EVENT_LOG_MSG, msg, ap);
488 489 490 491 492
    RELEASE_LOCK(&eventBufMutex);
}

void postCapMsg(Capability *cap, char *msg, va_list ap)
{
493
    postLogMsg(&capEventBuf[cap->no], EVENT_LOG_MSG, msg, ap);
Simon Marlow's avatar
Simon Marlow committed
494 495
}

496
void postUserMsg(Capability *cap, char *msg, va_list ap)
497
{
498
    postLogMsg(&capEventBuf[cap->no], EVENT_USER_MSG, msg, ap);
499 500
}    

Simon Marlow's avatar
Simon Marlow committed
501 502
void closeBlockMarker (EventsBuf *ebuf)
{
503 504
    StgInt8* save_pos;

Simon Marlow's avatar
Simon Marlow committed
505 506 507
    if (ebuf->marker)
    {
        // (type:16, time:64, size:32, end_time:64)
508 509 510 511 512 513 514

        save_pos = ebuf->pos;
        ebuf->pos = ebuf->marker + sizeof(EventTypeNum) +
                    sizeof(EventTimestamp);
        postWord32(ebuf, save_pos - ebuf->marker);
        postTimestamp(ebuf);
        ebuf->pos = save_pos;
Simon Marlow's avatar
Simon Marlow committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
        ebuf->marker = NULL;
    }
}


void postBlockMarker (EventsBuf *eb)
{
    if (!hasRoomForEvent(eb, EVENT_BLOCK_MARKER)) {
        printAndClearEventBuf(eb);
    }

    closeBlockMarker(eb);

    eb->marker = eb->pos;
    postEventHeader(eb, EVENT_BLOCK_MARKER);
    postWord32(eb,0); // these get filled in later by closeBlockMarker();
    postWord64(eb,0);
532
    postCapNo(eb, eb->capno);
Simon Marlow's avatar
Simon Marlow committed
533 534 535
}

void printAndClearEventBuf (EventsBuf *ebuf)
Simon Marlow's avatar
Simon Marlow committed
536 537 538
{
    StgWord64 numBytes = 0, written = 0;

Simon Marlow's avatar
Simon Marlow committed
539 540
    closeBlockMarker(ebuf);

541
    if (ebuf->begin != NULL && ebuf->pos != ebuf->begin)
Simon Marlow's avatar
Simon Marlow committed
542
    {
543
        numBytes = ebuf->pos - ebuf->begin;
Simon Marlow's avatar
Simon Marlow committed
544
        
545
        written = fwrite(ebuf->begin, 1, numBytes, event_log_file);
Simon Marlow's avatar
Simon Marlow committed
546 547 548 549 550 551 552
        if (written != numBytes) {
            debugBelch(
                "printAndClearEventLog: fwrite() failed, written=%" FMT_Word64
                " doesn't match numBytes=%" FMT_Word64, written, numBytes);
            return;
        }
        
553
        resetEventsBuf(ebuf);
Simon Marlow's avatar
Simon Marlow committed
554 555
        flushCount++;

Simon Marlow's avatar
Simon Marlow committed
556 557
        postBlockMarker(ebuf);
    }
Simon Marlow's avatar
Simon Marlow committed
558 559
}

560
void initEventsBuf(EventsBuf* eb, StgWord64 size, EventCapNo capno)
Simon Marlow's avatar
Simon Marlow committed
561
{
562
    eb->begin = eb->pos = stgMallocBytes(size, "initEventsBuf");
Simon Marlow's avatar
Simon Marlow committed
563
    eb->size = size;
Simon Marlow's avatar
Simon Marlow committed
564
    eb->marker = NULL;
565
    eb->capno = capno;
Simon Marlow's avatar
Simon Marlow committed
566 567 568 569 570
}

void resetEventsBuf(EventsBuf* eb)
{
    eb->pos = eb->begin;
571
    eb->marker = NULL;
Simon Marlow's avatar
Simon Marlow committed
572 573 574 575
}

StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum)
{
576
  nat size;
Simon Marlow's avatar
Simon Marlow committed
577

578
  size = sizeof(EventTypeNum) + sizeof(EventTimestamp) + eventTypes[eNum].size;
Simon Marlow's avatar
Simon Marlow committed
579 580 581 582 583 584 585 586

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

587 588 589 590 591 592 593 594 595 596 597 598 599 600
StgBool hasRoomForVariableEvent(EventsBuf *eb, nat payload_bytes)
{
  nat size;

  size = sizeof(EventTypeNum) + sizeof(EventTimestamp) +
      sizeof(EventPayloadSize) + payload_bytes;

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

Simon Marlow's avatar
Simon Marlow committed
601
void postEventType(EventsBuf *eb, EventType *et)
Simon Marlow's avatar
Simon Marlow committed
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
{
    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);
}

618
#endif /* TRACING */