EventLog.c 15.3 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

Simon Marlow's avatar
Simon Marlow committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
#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;
Simon Marlow's avatar
Simon Marlow committed
36
  StgInt8 *marker;
Simon Marlow's avatar
Simon Marlow committed
37
  StgWord64 size;
38
  EventCapNo capno; // which capability this buffer belongs to, or -1
Simon Marlow's avatar
Simon Marlow committed
39 40
} EventsBuf;

41 42 43 44 45 46
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
47 48

char *EventDesc[] = {
49 50 51 52 53 54 55 56 57 58 59 60 61
  [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",
62 63
  [EVENT_CREATE_SPARK_THREAD] = "Create spark thread",
  [EVENT_LOG_MSG]             = "Log message",
64
  [EVENT_USER_MSG]            = "User message",
Simon Marlow's avatar
Simon Marlow committed
65
  [EVENT_STARTUP]             = "Startup",
66 67 68
  [EVENT_GC_IDLE]             = "GC idle",
  [EVENT_GC_WORK]             = "GC working",
  [EVENT_GC_DONE]             = "GC done",
Simon Marlow's avatar
Simon Marlow committed
69
  [EVENT_BLOCK_MARKER]        = "Block marker"
Simon Marlow's avatar
Simon Marlow committed
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];

82
static void initEventsBuf(EventsBuf* eb, StgWord64 size, EventCapNo capno);
Simon Marlow's avatar
Simon Marlow committed
83
static void resetEventsBuf(EventsBuf* eb);
Simon Marlow's avatar
Simon Marlow committed
84
static void printAndClearEventBuf (EventsBuf *eventsBuf);
Simon Marlow's avatar
Simon Marlow committed
85 86 87

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

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

Simon Marlow's avatar
Simon Marlow committed
90 91 92
static void postBlockMarker(EventsBuf *eb);
static void closeBlockMarker(EventsBuf *ebuf);

Simon Marlow's avatar
Simon Marlow committed
93
static StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum);
94
static StgBool hasRoomForVariableEvent(EventsBuf *eb, nat payload_bytes);
Simon Marlow's avatar
Simon Marlow committed
95

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
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);
}

119 120 121 122 123 124
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
125 126 127
static inline StgWord64 time_ns(void)
{ return stat_getElapsedTime() * (1000000000LL/TICKS_PER_SECOND); }

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

Simon Marlow's avatar
Simon Marlow committed
131 132
static inline void postTimestamp(EventsBuf *eb)
{ postWord64(eb, time_ns()); }
133

134
static inline void postThreadID(EventsBuf *eb, EventThreadID id)
135 136
{ postWord32(eb,id); }

137
static inline void postCapNo(EventsBuf *eb, EventCapNo no)
138 139
{ postWord16(eb,no); }

140 141 142
static inline void postPayloadSize(EventsBuf *eb, EventPayloadSize size)
{ postWord16(eb,size); }

Simon Marlow's avatar
Simon Marlow committed
143 144 145 146 147 148
static inline void postEventHeader(EventsBuf *eb, EventTypeNum type)
{
    postEventTypeNum(eb, type);
    postTimestamp(eb);
}    

149 150 151 152 153 154 155 156 157 158 159 160
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
161 162 163 164 165

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

168
    event_log_filename = stgMallocBytes(strlen(prog_name) + 10,
Simon Marlow's avatar
Simon Marlow committed
169 170 171 172 173 174 175 176 177 178
                                        "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) {
Simon Marlow's avatar
Simon Marlow committed
179
        sysErrorBelch("initEventLogging: can't open %s", event_log_filename);
Simon Marlow's avatar
Simon Marlow committed
180 181 182 183 184 185 186 187 188 189 190 191 192
        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.
     */
193 194 195 196 197 198 199 200 201
#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
202
        // Init buffer for events.
203
        initEventsBuf(&capEventBuf[c], EVENT_LOG_SIZE, c);
Simon Marlow's avatar
Simon Marlow committed
204
    }
205
    initEventsBuf(&eventBuf, EVENT_LOG_SIZE, (EventCapNo)(-1));
Simon Marlow's avatar
Simon Marlow committed
206 207

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

    // Mark beginning of event types in the header.
Simon Marlow's avatar
Simon Marlow committed
211
    postInt32(&eventBuf, EVENT_HET_BEGIN);
Simon Marlow's avatar
Simon Marlow committed
212 213 214 215 216 217 218 219 220 221
    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)
222
        case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
223
            eventTypes[t].size = sizeof(EventThreadID);
224 225
            break;

Simon Marlow's avatar
Simon Marlow committed
226 227 228 229
        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 =
230
                sizeof(EventThreadID) + sizeof(EventCapNo);
Simon Marlow's avatar
Simon Marlow committed
231 232 233 234
            break;

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

238 239 240 241
        case EVENT_STARTUP:         // (cap count)
            eventTypes[t].size = sizeof(EventCapNo);
            break;

Simon Marlow's avatar
Simon Marlow committed
242 243 244 245 246
        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)
247 248 249
        case EVENT_GC_IDLE:
        case EVENT_GC_WORK:
        case EVENT_GC_DONE:
250
            eventTypes[t].size = 0;
Simon Marlow's avatar
Simon Marlow committed
251
            break;
252 253

        case EVENT_LOG_MSG:          // (msg)
254
        case EVENT_USER_MSG:         // (msg)
255 256 257
            eventTypes[t].size = 0xffff;
            break;

Simon Marlow's avatar
Simon Marlow committed
258
        case EVENT_BLOCK_MARKER:
259 260
            eventTypes[t].size = sizeof(StgWord32) + sizeof(EventTimestamp) + 
                sizeof(EventCapNo);
Simon Marlow's avatar
Simon Marlow committed
261 262
            break;

263 264
        default:
            continue; /* ignore deprecated events */
Simon Marlow's avatar
Simon Marlow committed
265 266 267
        }

        // Write in buffer: the start event type.
268
        postEventType(&eventBuf, &eventTypes[t]);
Simon Marlow's avatar
Simon Marlow committed
269 270 271
    }

    // Mark end of event types in the header.
Simon Marlow's avatar
Simon Marlow committed
272
    postInt32(&eventBuf, EVENT_HET_END);
Simon Marlow's avatar
Simon Marlow committed
273 274
    
    // Write in buffer: the header end marker.
Simon Marlow's avatar
Simon Marlow committed
275
    postInt32(&eventBuf, EVENT_HEADER_END);
Simon Marlow's avatar
Simon Marlow committed
276 277
    
    // Prepare event buffer for events (data).
Simon Marlow's avatar
Simon Marlow committed
278
    postInt32(&eventBuf, EVENT_DATA_BEGIN);
Simon Marlow's avatar
Simon Marlow committed
279
    
280 281 282 283
    // Post a STARTUP event with the number of capabilities
    postEventHeader(&eventBuf, EVENT_STARTUP);
    postCapNo(&eventBuf, n_caps);

284
    // Flush capEventBuf with header.
Simon Marlow's avatar
Simon Marlow committed
285 286 287 288
    /*
     * Flush header and data begin marker to the file, thus preparing the
     * file to have events written to it.
     */
289
    printAndClearEventBuf(&eventBuf);
Simon Marlow's avatar
Simon Marlow committed
290 291 292 293

    for (c = 0; c < n_caps; ++c) {
        postBlockMarker(&capEventBuf[c]);
    }
294 295 296 297

#ifdef THREADED_RTS
    initMutex(&eventBufMutex);
#endif
Simon Marlow's avatar
Simon Marlow committed
298 299 300 301 302 303 304 305 306
}

void
endEventLogging(void)
{
    nat c;

    // Flush all events remaining in the buffers.
    for (c = 0; c < n_capabilities; ++c) {
307
        printAndClearEventBuf(&capEventBuf[c]);
Simon Marlow's avatar
Simon Marlow committed
308
    }
309
    printAndClearEventBuf(&eventBuf);
310
    resetEventsBuf(&eventBuf); // we don't want the block marker
Simon Marlow's avatar
Simon Marlow committed
311 312

    // Mark end of events (data).
Simon Marlow's avatar
Simon Marlow committed
313
    postEventTypeNum(&eventBuf, EVENT_DATA_END);
Simon Marlow's avatar
Simon Marlow committed
314 315

    // Flush the end of data marker.
316
    printAndClearEventBuf(&eventBuf);
Simon Marlow's avatar
Simon Marlow committed
317 318 319 320 321 322 323 324 325 326 327 328 329

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

void 
freeEventLogging(void)
{
    StgWord8 c;
    
    // Free events buffer.
    for (c = 0; c < n_capabilities; ++c) {
330 331
        if (capEventBuf[c].begin != NULL) 
            stgFree(capEventBuf[c].begin);
Simon Marlow's avatar
Simon Marlow committed
332
    }
333 334
    if (capEventBuf != NULL)  {
        stgFree(capEventBuf);
Simon Marlow's avatar
Simon Marlow committed
335 336 337 338 339 340 341 342 343 344 345
    }
    if (event_log_filename != NULL) {
        stgFree(event_log_filename);
    }
}

/*
 * Post an event message to the capability's eventlog buffer.
 * If the buffer is full, prints out the buffer and clears it.
 */
void
346 347 348 349
postSchedEvent (Capability *cap, 
                EventTypeNum tag, 
                StgThreadID thread, 
                StgWord64 other)
Simon Marlow's avatar
Simon Marlow committed
350 351 352
{
    EventsBuf *eb;

353
    eb = &capEventBuf[cap->no];
Simon Marlow's avatar
Simon Marlow committed
354 355 356 357 358 359

    if (!hasRoomForEvent(eb, tag)) {
        // Flush event buffer to make room for new event.
        printAndClearEventBuf(eb);
    }
    
Simon Marlow's avatar
Simon Marlow committed
360
    postEventHeader(eb, tag);
Simon Marlow's avatar
Simon Marlow committed
361 362 363 364 365 366 367

    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)
    {
368
        postThreadID(eb,thread);
Simon Marlow's avatar
Simon Marlow committed
369 370 371
        break;
    }

372
    case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
373 374 375 376 377
    {
        postThreadID(eb,other /* spark_thread */);
        break;
    }

Simon Marlow's avatar
Simon Marlow committed
378 379 380 381
    case EVENT_MIGRATE_THREAD:  // (cap, thread, new_cap)
    case EVENT_STEAL_SPARK:     // (cap, thread, victim_cap)
    case EVENT_THREAD_WAKEUP:   // (cap, thread, other_cap)
    {
382 383
        postThreadID(eb,thread);
        postCapNo(eb,other /* new_cap | victim_cap | other_cap */);
Simon Marlow's avatar
Simon Marlow committed
384
        break;
385
   }
Simon Marlow's avatar
Simon Marlow committed
386 387 388

    case EVENT_STOP_THREAD:     // (cap, thread, status)
    {
389 390
        postThreadID(eb,thread);
        postWord16(eb,other /* status */);
Simon Marlow's avatar
Simon Marlow committed
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
        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);
    }
406 407
}

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
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);
}

423 424
#define BUF 512

425
void postLogMsg(EventsBuf *eb, EventTypeNum type, char *msg, va_list ap)
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
{
    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);
    }

441
    postEventHeader(eb, type);
442 443
    postPayloadSize(eb, size);
    postBuf(eb,(StgWord8*)buf,size);
444
}
445

446 447 448
void postMsg(char *msg, va_list ap)
{
    ACQUIRE_LOCK(&eventBufMutex);
449
    postLogMsg(&eventBuf, EVENT_LOG_MSG, msg, ap);
450 451 452 453 454
    RELEASE_LOCK(&eventBufMutex);
}

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

458
void postUserMsg(Capability *cap, char *msg, va_list ap)
459
{
460
    postLogMsg(&capEventBuf[cap->no], EVENT_USER_MSG, msg, ap);
461 462
}    

Simon Marlow's avatar
Simon Marlow committed
463 464
void closeBlockMarker (EventsBuf *ebuf)
{
465 466
    StgInt8* save_pos;

Simon Marlow's avatar
Simon Marlow committed
467 468 469
    if (ebuf->marker)
    {
        // (type:16, time:64, size:32, end_time:64)
470 471 472 473 474 475 476

        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
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
        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);
494
    postCapNo(eb, eb->capno);
Simon Marlow's avatar
Simon Marlow committed
495 496 497
}

void printAndClearEventBuf (EventsBuf *ebuf)
Simon Marlow's avatar
Simon Marlow committed
498 499 500
{
    StgWord64 numBytes = 0, written = 0;

Simon Marlow's avatar
Simon Marlow committed
501 502
    closeBlockMarker(ebuf);

503
    if (ebuf->begin != NULL && ebuf->pos != ebuf->begin)
Simon Marlow's avatar
Simon Marlow committed
504
    {
505
        numBytes = ebuf->pos - ebuf->begin;
Simon Marlow's avatar
Simon Marlow committed
506
        
507
        written = fwrite(ebuf->begin, 1, numBytes, event_log_file);
Simon Marlow's avatar
Simon Marlow committed
508 509 510 511 512 513 514
        if (written != numBytes) {
            debugBelch(
                "printAndClearEventLog: fwrite() failed, written=%" FMT_Word64
                " doesn't match numBytes=%" FMT_Word64, written, numBytes);
            return;
        }
        
515
        resetEventsBuf(ebuf);
Simon Marlow's avatar
Simon Marlow committed
516 517
        flushCount++;

Simon Marlow's avatar
Simon Marlow committed
518 519
        postBlockMarker(ebuf);
    }
Simon Marlow's avatar
Simon Marlow committed
520 521
}

522
void initEventsBuf(EventsBuf* eb, StgWord64 size, EventCapNo capno)
Simon Marlow's avatar
Simon Marlow committed
523
{
524
    eb->begin = eb->pos = stgMallocBytes(size, "initEventsBuf");
Simon Marlow's avatar
Simon Marlow committed
525
    eb->size = size;
Simon Marlow's avatar
Simon Marlow committed
526
    eb->marker = NULL;
527
    eb->capno = capno;
Simon Marlow's avatar
Simon Marlow committed
528 529 530 531 532
}

void resetEventsBuf(EventsBuf* eb)
{
    eb->pos = eb->begin;
533
    eb->marker = NULL;
Simon Marlow's avatar
Simon Marlow committed
534 535 536 537
}

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

540
  size = sizeof(EventTypeNum) + sizeof(EventTimestamp) + eventTypes[eNum].size;
Simon Marlow's avatar
Simon Marlow committed
541 542 543 544 545 546 547 548

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

549 550 551 552 553 554 555 556 557 558 559 560 561 562
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
563
void postEventType(EventsBuf *eb, EventType *et)
Simon Marlow's avatar
Simon Marlow committed
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
{
    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);
}

580
#endif /* TRACING */