EventLog.c 34 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
  [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_THREAD_WAKEUP]       = "Wakeup thread",
64
  [EVENT_THREAD_LABEL]        = "Thread label",
65 66 67 68
  [EVENT_CAP_CREATE]          = "Create capability",
  [EVENT_CAP_DELETE]          = "Delete capability",
  [EVENT_CAP_DISABLE]         = "Disable capability",
  [EVENT_CAP_ENABLE]          = "Enable capability",
69 70 71 72
  [EVENT_GC_START]            = "Starting GC",
  [EVENT_GC_END]              = "Finished GC",
  [EVENT_REQUEST_SEQ_GC]      = "Request sequential GC",
  [EVENT_REQUEST_PAR_GC]      = "Request parallel GC",
73
  [EVENT_GC_GLOBAL_SYNC]      = "Synchronise stop-the-world GC",
74 75 76 77 78
  [EVENT_GC_STATS_GHC]        = "GC statistics",
  [EVENT_HEAP_INFO_GHC]       = "Heap static parameters",
  [EVENT_HEAP_ALLOCATED]      = "Total heap mem ever allocated",
  [EVENT_HEAP_SIZE]           = "Current heap size",
  [EVENT_HEAP_LIVE]           = "Current heap live data",
79 80
  [EVENT_CREATE_SPARK_THREAD] = "Create spark thread",
  [EVENT_LOG_MSG]             = "Log message",
81
  [EVENT_USER_MSG]            = "User message",
82
  [EVENT_USER_MARKER]         = "User marker",
83 84 85
  [EVENT_GC_IDLE]             = "GC idle",
  [EVENT_GC_WORK]             = "GC working",
  [EVENT_GC_DONE]             = "GC done",
86 87 88 89
  [EVENT_BLOCK_MARKER]        = "Block marker",
  [EVENT_CAPSET_CREATE]       = "Create capability set",
  [EVENT_CAPSET_DELETE]       = "Delete capability set",
  [EVENT_CAPSET_ASSIGN_CAP]   = "Add capability to capability set",
90 91 92 93 94
  [EVENT_CAPSET_REMOVE_CAP]   = "Remove capability from capability set",
  [EVENT_RTS_IDENTIFIER]      = "RTS name and version",
  [EVENT_PROGRAM_ARGS]        = "Program arguments",
  [EVENT_PROGRAM_ENV]         = "Program environment variables",
  [EVENT_OSPROCESS_PID]       = "Process ID",
Duncan Coutts's avatar
Duncan Coutts committed
95
  [EVENT_OSPROCESS_PPID]      = "Parent process ID",
96
  [EVENT_WALL_CLOCK_TIME]     = "Wall clock time",
97 98 99 100 101 102 103 104
  [EVENT_SPARK_COUNTERS]      = "Spark counters",
  [EVENT_SPARK_CREATE]        = "Spark create",
  [EVENT_SPARK_DUD]           = "Spark dud",
  [EVENT_SPARK_OVERFLOW]      = "Spark overflow",
  [EVENT_SPARK_RUN]           = "Spark run",
  [EVENT_SPARK_STEAL]         = "Spark steal",
  [EVENT_SPARK_FIZZLE]        = "Spark fizzle",
  [EVENT_SPARK_GC]            = "Spark GC",
105 106 107
  [EVENT_TASK_CREATE]         = "Task create",
  [EVENT_TASK_MIGRATE]        = "Task migrate",
  [EVENT_TASK_DELETE]         = "Task delete",
108
  [EVENT_HACK_BUG_T9003]      = "Empty event for bug #9003",
Simon Marlow's avatar
Simon Marlow committed
109 110
};

111
// Event type.
Simon Marlow's avatar
Simon Marlow committed
112 113 114 115 116 117 118

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

119
EventType eventTypes[NUM_GHC_EVENT_TAGS];
Simon Marlow's avatar
Simon Marlow committed
120

121
static void initEventsBuf(EventsBuf* eb, StgWord64 size, EventCapNo capno);
Simon Marlow's avatar
Simon Marlow committed
122
static void resetEventsBuf(EventsBuf* eb);
Simon Marlow's avatar
Simon Marlow committed
123
static void printAndClearEventBuf (EventsBuf *eventsBuf);
Simon Marlow's avatar
Simon Marlow committed
124 125 126

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

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

Simon Marlow's avatar
Simon Marlow committed
129 130 131
static void postBlockMarker(EventsBuf *eb);
static void closeBlockMarker(EventsBuf *ebuf);

Simon Marlow's avatar
Simon Marlow committed
132
static StgBool hasRoomForEvent(EventsBuf *eb, EventTypeNum eNum);
133
static StgBool hasRoomForVariableEvent(EventsBuf *eb, nat payload_bytes);
Simon Marlow's avatar
Simon Marlow committed
134

135 136 137
static void ensureRoomForEvent(EventsBuf *eb, EventTypeNum tag);
static int ensureRoomForVariableEvent(EventsBuf *eb, StgWord16 size);

138 139
static inline void postWord8(EventsBuf *eb, StgWord8 i)
{
140
    *(eb->pos++) = i;
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
}

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);
}

161 162 163 164 165 166
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
167
static inline StgWord64 time_ns(void)
Simon Marlow's avatar
Simon Marlow committed
168
{ return TimeToNS(stat_getElapsedTime()); }
Simon Marlow's avatar
Simon Marlow committed
169

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

Simon Marlow's avatar
Simon Marlow committed
173 174
static inline void postTimestamp(EventsBuf *eb)
{ postWord64(eb, time_ns()); }
175

176
static inline void postThreadID(EventsBuf *eb, EventThreadID id)
177 178
{ postWord32(eb,id); }

179
static inline void postCapNo(EventsBuf *eb, EventCapNo no)
180 181
{ postWord16(eb,no); }

182 183 184 185 186 187
static inline void postCapsetID(EventsBuf *eb, EventCapsetID id)
{ postWord32(eb,id); }

static inline void postCapsetType(EventsBuf *eb, EventCapsetType type)
{ postWord16(eb,type); }

188 189 190 191 192 193 194 195 196
static inline void postOSProcessId(EventsBuf *eb, pid_t pid)
{ postWord32(eb, pid); }

static inline void postKernelThreadId(EventsBuf *eb, EventKernelThreadId tid)
{ postWord64(eb, tid); }

static inline void postTaskId(EventsBuf *eb, EventTaskId tUniq)
{ postWord64(eb, tUniq); }

197 198 199
static inline void postPayloadSize(EventsBuf *eb, EventPayloadSize size)
{ postWord16(eb,size); }

Simon Marlow's avatar
Simon Marlow committed
200 201 202 203
static inline void postEventHeader(EventsBuf *eb, EventTypeNum type)
{
    postEventTypeNum(eb, type);
    postTimestamp(eb);
204
}
Simon Marlow's avatar
Simon Marlow committed
205

206 207 208 209 210 211
static inline void postInt8(EventsBuf *eb, StgInt8 i)
{ postWord8(eb, (StgWord8)i); }

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

Simon Marlow's avatar
Simon Marlow committed
212 213 214 215 216

void
initEventLogging(void)
{
    StgWord8 t, c;
217
    nat n_caps;
218 219 220 221 222 223 224 225 226 227 228 229 230 231
    char *prog;

    prog = stgMallocBytes(strlen(prog_name) + 1, "initEventLogging");
    strcpy(prog, prog_name);
#ifdef mingw32_HOST_OS
    // on Windows, drop the .exe suffix if there is one
    {
        char *suff;
        suff = strrchr(prog,'.');
        if (suff != NULL && !strcmp(suff,".exe")) {
            *suff = '\0';
        }
    }
#endif
Simon Marlow's avatar
Simon Marlow committed
232

233
    event_log_filename = stgMallocBytes(strlen(prog)
234 235
                                        + 10 /* .%d */
                                        + 10 /* .eventlog */,
Simon Marlow's avatar
Simon Marlow committed
236 237
                                        "initEventLogging");

238
    if (sizeof(EventDesc) / sizeof(char*) != NUM_GHC_EVENT_TAGS) {
Simon Marlow's avatar
Simon Marlow committed
239 240
        barf("EventDesc array has the wrong number of elements");
    }
241 242 243

    if (event_log_pid == -1) { // #4512
        // Single process
244
        sprintf(event_log_filename, "%s.eventlog", prog);
245 246 247 248 249
        event_log_pid = getpid();
    } else {
        // Forked process, eventlog already started by the parent
        // before fork
        event_log_pid = getpid();
Ian Lynagh's avatar
Ian Lynagh committed
250 251 252
        // We don't have a FMT* symbol for pid_t, so we go via Word64
        // to be sure of not losing range. It would be nicer to have a
        // FMT* symbol or similar, though.
253 254
        sprintf(event_log_filename, "%s.%" FMT_Word64 ".eventlog",
                prog, (StgWord64)event_log_pid);
255
    }
256
    stgFree(prog);
257

Simon Marlow's avatar
Simon Marlow committed
258 259
    /* Open event log file for writing. */
    if ((event_log_file = fopen(event_log_filename, "wb")) == NULL) {
Simon Marlow's avatar
Simon Marlow committed
260
        sysErrorBelch("initEventLogging: can't open %s", event_log_filename);
261
        stg_exit(EXIT_FAILURE);
Simon Marlow's avatar
Simon Marlow committed
262 263
    }

264
    /*
Simon Marlow's avatar
Simon Marlow committed
265 266 267 268 269 270
     * 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.
     *
271
     * Use a single buffer to store the header with event types, then flush
Simon Marlow's avatar
Simon Marlow committed
272 273
     * the buffer so all buffers are empty for writing events.
     */
274 275 276 277 278 279
#ifdef THREADED_RTS
    // XXX n_capabilities hasn't been initislised yet
    n_caps = RtsFlags.ParFlags.nNodes;
#else
    n_caps = 1;
#endif
280
    moreCapEventBufs(0,n_caps);
281

282
    initEventsBuf(&eventBuf, EVENT_LOG_SIZE, (EventCapNo)(-1));
Simon Marlow's avatar
Simon Marlow committed
283 284

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

    // Mark beginning of event types in the header.
Simon Marlow's avatar
Simon Marlow committed
288
    postInt32(&eventBuf, EVENT_HET_BEGIN);
289
    for (t = 0; t < NUM_GHC_EVENT_TAGS; ++t) {
Simon Marlow's avatar
Simon Marlow committed
290 291 292 293 294 295 296 297

        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)
298
        case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
299
            eventTypes[t].size = sizeof(EventThreadID);
300 301
            break;

Simon Marlow's avatar
Simon Marlow committed
302 303 304
        case EVENT_MIGRATE_THREAD:  // (cap, thread, new_cap)
        case EVENT_THREAD_WAKEUP:   // (cap, thread, other_cap)
            eventTypes[t].size =
305
                sizeof(EventThreadID) + sizeof(EventCapNo);
Simon Marlow's avatar
Simon Marlow committed
306 307 308
            break;

        case EVENT_STOP_THREAD:     // (cap, thread, status)
309 310 311
            eventTypes[t].size = sizeof(EventThreadID)
                               + sizeof(StgWord16)
                               + sizeof(EventThreadID);
Simon Marlow's avatar
Simon Marlow committed
312 313
            break;

314 315 316 317
        case EVENT_CAP_CREATE:      // (cap)
        case EVENT_CAP_DELETE:      // (cap)
        case EVENT_CAP_ENABLE:      // (cap)
        case EVENT_CAP_DISABLE:     // (cap)
318 319 320
            eventTypes[t].size = sizeof(EventCapNo);
            break;

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
        case EVENT_CAPSET_CREATE:   // (capset, capset_type)
            eventTypes[t].size =
                sizeof(EventCapsetID) + sizeof(EventCapsetType);
            break;

        case EVENT_CAPSET_DELETE:   // (capset)
            eventTypes[t].size = sizeof(EventCapsetID);
            break;

        case EVENT_CAPSET_ASSIGN_CAP:  // (capset, cap)
        case EVENT_CAPSET_REMOVE_CAP:
            eventTypes[t].size =
                sizeof(EventCapsetID) + sizeof(EventCapNo);
            break;

336 337 338 339 340 341
        case EVENT_OSPROCESS_PID:   // (cap, pid)
        case EVENT_OSPROCESS_PPID:
            eventTypes[t].size =
                sizeof(EventCapsetID) + sizeof(StgWord32);
            break;

342 343 344 345 346
        case EVENT_WALL_CLOCK_TIME: // (capset, unix_epoch_seconds, nanoseconds)
            eventTypes[t].size =
                sizeof(EventCapsetID) + sizeof(StgWord64) + sizeof(StgWord32);
            break;

347 348 349 350 351
        case EVENT_SPARK_STEAL:     // (cap, victim_cap)
            eventTypes[t].size =
                sizeof(EventCapNo);
            break;

Simon Marlow's avatar
Simon Marlow committed
352 353 354 355
        case EVENT_REQUEST_SEQ_GC:  // (cap)
        case EVENT_REQUEST_PAR_GC:  // (cap)
        case EVENT_GC_START:        // (cap)
        case EVENT_GC_END:          // (cap)
356 357 358
        case EVENT_GC_IDLE:
        case EVENT_GC_WORK:
        case EVENT_GC_DONE:
359
        case EVENT_GC_GLOBAL_SYNC:  // (cap)
360 361 362 363 364 365
        case EVENT_SPARK_CREATE:    // (cap)
        case EVENT_SPARK_DUD:       // (cap)
        case EVENT_SPARK_OVERFLOW:  // (cap)
        case EVENT_SPARK_RUN:       // (cap)
        case EVENT_SPARK_FIZZLE:    // (cap)
        case EVENT_SPARK_GC:        // (cap)
366
            eventTypes[t].size = 0;
Simon Marlow's avatar
Simon Marlow committed
367
            break;
368 369

        case EVENT_LOG_MSG:          // (msg)
370
        case EVENT_USER_MSG:         // (msg)
371
        case EVENT_USER_MARKER:      // (markername)
372 373 374
        case EVENT_RTS_IDENTIFIER:   // (capset, str)
        case EVENT_PROGRAM_ARGS:     // (capset, strvec)
        case EVENT_PROGRAM_ENV:      // (capset, strvec)
375
        case EVENT_THREAD_LABEL:     // (thread, str)
376 377 378
            eventTypes[t].size = 0xffff;
            break;

Duncan Coutts's avatar
Duncan Coutts committed
379 380 381 382
        case EVENT_SPARK_COUNTERS:   // (cap, 7*counter)
            eventTypes[t].size = 7 * sizeof(StgWord64);
            break;

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
        case EVENT_HEAP_ALLOCATED:    // (heap_capset, alloc_bytes)
        case EVENT_HEAP_SIZE:         // (heap_capset, size_bytes)
        case EVENT_HEAP_LIVE:         // (heap_capset, live_bytes)
            eventTypes[t].size = sizeof(EventCapsetID) + sizeof(StgWord64);
            break;

        case EVENT_HEAP_INFO_GHC:     // (heap_capset, n_generations,
                                      //  max_heap_size, alloc_area_size,
                                      //  mblock_size, block_size)
            eventTypes[t].size = sizeof(EventCapsetID)
                               + sizeof(StgWord16)
                               + sizeof(StgWord64) * 4;
            break;

        case EVENT_GC_STATS_GHC:      // (heap_capset, generation,
                                      //  copied_bytes, slop_bytes, frag_bytes,
                                      //  par_n_threads,
                                      //  par_max_copied, par_tot_copied)
            eventTypes[t].size = sizeof(EventCapsetID)
                               + sizeof(StgWord16)
                               + sizeof(StgWord64) * 3
                               + sizeof(StgWord32)
                               + sizeof(StgWord64) * 2;
            break;

408
        case EVENT_TASK_CREATE:   // (taskId, cap, tid)
409 410 411
            eventTypes[t].size = sizeof(EventTaskId)
                               + sizeof(EventCapNo)
                               + sizeof(EventKernelThreadId);
412 413 414 415 416 417 418 419 420 421 422
            break;

        case EVENT_TASK_MIGRATE:   // (taskId, cap, new_cap)
            eventTypes[t].size =
                sizeof(EventTaskId) + sizeof(EventCapNo) + sizeof(EventCapNo);
            break;

        case EVENT_TASK_DELETE:   // (taskId)
            eventTypes[t].size = sizeof(EventTaskId);
            break;

Simon Marlow's avatar
Simon Marlow committed
423
        case EVENT_BLOCK_MARKER:
424
            eventTypes[t].size = sizeof(StgWord32) + sizeof(EventTimestamp) +
425
                sizeof(EventCapNo);
Simon Marlow's avatar
Simon Marlow committed
426 427
            break;

428 429 430 431
        case EVENT_HACK_BUG_T9003:
            eventTypes[t].size = 0;
            break;

432 433
        default:
            continue; /* ignore deprecated events */
Simon Marlow's avatar
Simon Marlow committed
434 435 436
        }

        // Write in buffer: the start event type.
437
        postEventType(&eventBuf, &eventTypes[t]);
Simon Marlow's avatar
Simon Marlow committed
438 439 440
    }

    // Mark end of event types in the header.
Simon Marlow's avatar
Simon Marlow committed
441
    postInt32(&eventBuf, EVENT_HET_END);
442

Simon Marlow's avatar
Simon Marlow committed
443
    // Write in buffer: the header end marker.
Simon Marlow's avatar
Simon Marlow committed
444
    postInt32(&eventBuf, EVENT_HEADER_END);
445

Simon Marlow's avatar
Simon Marlow committed
446
    // Prepare event buffer for events (data).
Simon Marlow's avatar
Simon Marlow committed
447
    postInt32(&eventBuf, EVENT_DATA_BEGIN);
448

449
    // Flush capEventBuf with header.
Simon Marlow's avatar
Simon Marlow committed
450 451 452 453
    /*
     * Flush header and data begin marker to the file, thus preparing the
     * file to have events written to it.
     */
454
    printAndClearEventBuf(&eventBuf);
Simon Marlow's avatar
Simon Marlow committed
455 456 457 458

    for (c = 0; c < n_caps; ++c) {
        postBlockMarker(&capEventBuf[c]);
    }
459 460 461 462

#ifdef THREADED_RTS
    initMutex(&eventBufMutex);
#endif
Simon Marlow's avatar
Simon Marlow committed
463 464 465 466 467 468 469 470 471
}

void
endEventLogging(void)
{
    nat c;

    // Flush all events remaining in the buffers.
    for (c = 0; c < n_capabilities; ++c) {
472
        printAndClearEventBuf(&capEventBuf[c]);
Simon Marlow's avatar
Simon Marlow committed
473
    }
474
    printAndClearEventBuf(&eventBuf);
475
    resetEventsBuf(&eventBuf); // we don't want the block marker
Simon Marlow's avatar
Simon Marlow committed
476 477

    // Mark end of events (data).
Simon Marlow's avatar
Simon Marlow committed
478
    postEventTypeNum(&eventBuf, EVENT_DATA_END);
Simon Marlow's avatar
Simon Marlow committed
479 480

    // Flush the end of data marker.
481
    printAndClearEventBuf(&eventBuf);
Simon Marlow's avatar
Simon Marlow committed
482 483 484 485 486 487

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

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
void
moreCapEventBufs (nat from, nat to)
{
    nat c;

    if (from > 0) {
        capEventBuf = stgReallocBytes(capEventBuf, to * sizeof(EventsBuf),
                                      "moreCapEventBufs");
    } else {
        capEventBuf = stgMallocBytes(to * sizeof(EventsBuf),
                                     "moreCapEventBufs");
    }

    for (c = from; c < to; ++c) {
        initEventsBuf(&capEventBuf[c], EVENT_LOG_SIZE, c);
    }
504 505 506 507 508 509 510 511 512

    // The from == 0 already covered in initEventLogging, so we are interested
    // only in case when we are increasing capabilities number
    if (from > 0) {
        for (c = from; c < to; ++c) {
           postBlockMarker(&capEventBuf[c]);
        }
    }

513 514 515 516
}


void
Simon Marlow's avatar
Simon Marlow committed
517 518 519
freeEventLogging(void)
{
    StgWord8 c;
520

Simon Marlow's avatar
Simon Marlow committed
521 522
    // Free events buffer.
    for (c = 0; c < n_capabilities; ++c) {
523
        if (capEventBuf[c].begin != NULL)
524
            stgFree(capEventBuf[c].begin);
Simon Marlow's avatar
Simon Marlow committed
525
    }
526 527
    if (capEventBuf != NULL)  {
        stgFree(capEventBuf);
Simon Marlow's avatar
Simon Marlow committed
528 529 530 531 532 533
    }
    if (event_log_filename != NULL) {
        stgFree(event_log_filename);
    }
}

534
void
535 536 537 538 539 540 541
flushEventLog(void)
{
    if (event_log_file != NULL) {
        fflush(event_log_file);
    }
}

542
void
543 544 545 546 547 548 549
abortEventLogging(void)
{
    freeEventLogging();
    if (event_log_file != NULL) {
        fclose(event_log_file);
    }
}
550

Simon Marlow's avatar
Simon Marlow committed
551 552 553 554 555
/*
 * Post an event message to the capability's eventlog buffer.
 * If the buffer is full, prints out the buffer and clears it.
 */
void
556 557 558
postSchedEvent (Capability *cap,
                EventTypeNum tag,
                StgThreadID thread,
559 560
                StgWord info1,
                StgWord info2)
Simon Marlow's avatar
Simon Marlow committed
561 562 563
{
    EventsBuf *eb;

564
    eb = &capEventBuf[cap->no];
565
    ensureRoomForEvent(eb, tag);
566

Simon Marlow's avatar
Simon Marlow committed
567
    postEventHeader(eb, tag);
Simon Marlow's avatar
Simon Marlow committed
568 569 570 571 572 573

    switch (tag) {
    case EVENT_CREATE_THREAD:   // (cap, thread)
    case EVENT_RUN_THREAD:      // (cap, thread)
    case EVENT_THREAD_RUNNABLE: // (cap, thread)
    {
574
        postThreadID(eb,thread);
Simon Marlow's avatar
Simon Marlow committed
575 576 577
        break;
    }

578
    case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
579
    {
580
        postThreadID(eb,info1 /* spark_thread */);
581 582 583
        break;
    }

Simon Marlow's avatar
Simon Marlow committed
584 585 586
    case EVENT_MIGRATE_THREAD:  // (cap, thread, new_cap)
    case EVENT_THREAD_WAKEUP:   // (cap, thread, other_cap)
    {
587
        postThreadID(eb,thread);
588
        postCapNo(eb,info1 /* new_cap | victim_cap | other_cap */);
Simon Marlow's avatar
Simon Marlow committed
589
        break;
590
   }
Simon Marlow's avatar
Simon Marlow committed
591 592 593

    case EVENT_STOP_THREAD:     // (cap, thread, status)
    {
594
        postThreadID(eb,thread);
595 596
        postWord16(eb,info1 /* status */);
        postThreadID(eb,info2 /* blocked on thread */);
Simon Marlow's avatar
Simon Marlow committed
597 598 599 600
        break;
    }

    default:
601
        barf("postSchedEvent: unknown event tag %d", tag);
Simon Marlow's avatar
Simon Marlow committed
602
    }
603 604
}

605 606 607 608 609 610 611 612
void
postSparkEvent (Capability *cap,
                EventTypeNum tag,
                StgWord info1)
{
    EventsBuf *eb;

    eb = &capEventBuf[cap->no];
613
    ensureRoomForEvent(eb, tag);
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644

    postEventHeader(eb, tag);

    switch (tag) {
    case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
    {
        postThreadID(eb,info1 /* spark_thread */);
        break;
    }

    case EVENT_SPARK_STEAL:         // (cap, victim_cap)
    {
        postCapNo(eb,info1 /* victim_cap */);
        break;
   }

    case EVENT_SPARK_CREATE:        // (cap)
    case EVENT_SPARK_DUD:           // (cap)
    case EVENT_SPARK_OVERFLOW:      // (cap)
    case EVENT_SPARK_RUN:           // (cap)
    case EVENT_SPARK_FIZZLE:        // (cap)
    case EVENT_SPARK_GC:            // (cap)
    {
        break;
    }

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

Duncan Coutts's avatar
Duncan Coutts committed
645
void
646
postSparkCountersEvent (Capability *cap,
Duncan Coutts's avatar
Duncan Coutts committed
647 648 649 650 651 652
                        SparkCounters counters,
                        StgWord remaining)
{
    EventsBuf *eb;

    eb = &capEventBuf[cap->no];
653
    ensureRoomForEvent(eb, EVENT_SPARK_COUNTERS);
654

Duncan Coutts's avatar
Duncan Coutts committed
655
    postEventHeader(eb, EVENT_SPARK_COUNTERS);
656
    /* EVENT_SPARK_COUNTERS (crt,dud,ovf,cnv,gcd,fiz,rem) */
Duncan Coutts's avatar
Duncan Coutts committed
657 658 659 660 661 662 663 664 665
    postWord64(eb,counters.created);
    postWord64(eb,counters.dud);
    postWord64(eb,counters.overflowed);
    postWord64(eb,counters.converted);
    postWord64(eb,counters.gcd);
    postWord64(eb,counters.fizzled);
    postWord64(eb,remaining);
}

666 667 668 669 670
void
postCapEvent (EventTypeNum  tag,
              EventCapNo    capno)
{
    ACQUIRE_LOCK(&eventBufMutex);
671
    ensureRoomForEvent(&eventBuf, tag);
672

673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
    postEventHeader(&eventBuf, tag);

    switch (tag) {
    case EVENT_CAP_CREATE:   // (cap)
    case EVENT_CAP_DELETE:   // (cap)
    case EVENT_CAP_ENABLE:   // (cap)
    case EVENT_CAP_DISABLE:  // (cap)
    {
        postCapNo(&eventBuf,capno);
        break;
    }

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

    RELEASE_LOCK(&eventBufMutex);
}

692 693 694
void postCapsetEvent (EventTypeNum tag,
                      EventCapsetID capset,
                      StgWord info)
695 696
{
    ACQUIRE_LOCK(&eventBufMutex);
697
    ensureRoomForEvent(&eventBuf, tag);
698 699 700 701 702 703 704

    postEventHeader(&eventBuf, tag);
    postCapsetID(&eventBuf, capset);

    switch (tag) {
    case EVENT_CAPSET_CREATE:   // (capset, capset_type)
    {
705
        postCapsetType(&eventBuf, info /* capset_type */);
706 707 708 709 710 711 712 713 714 715 716
        break;
    }

    case EVENT_CAPSET_DELETE:   // (capset)
    {
        break;
    }

    case EVENT_CAPSET_ASSIGN_CAP:  // (capset, capno)
    case EVENT_CAPSET_REMOVE_CAP:  // (capset, capno)
    {
717
        postCapNo(&eventBuf, info /* capno */);
718 719
        break;
    }
720 721 722
    case EVENT_OSPROCESS_PID:   // (capset, pid)
    case EVENT_OSPROCESS_PPID:  // (capset, parent_pid)
    {
723
        postOSProcessId(&eventBuf, info);
724 725
        break;
    }
726
    default:
727
        barf("postCapsetEvent: unknown event tag %d", tag);
728 729 730 731 732
    }

    RELEASE_LOCK(&eventBufMutex);
}

733 734 735 736 737
void postCapsetStrEvent (EventTypeNum tag,
                         EventCapsetID capset,
                         char *msg)
{
    int strsize = strlen(msg);
738
    int size = strsize + sizeof(EventCapsetID);
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796

    ACQUIRE_LOCK(&eventBufMutex);

    if (!hasRoomForVariableEvent(&eventBuf, size)){
        printAndClearEventBuf(&eventBuf);

        if (!hasRoomForVariableEvent(&eventBuf, size)){
            // Event size exceeds buffer size, bail out:
            RELEASE_LOCK(&eventBufMutex);
            return;
        }
    }

    postEventHeader(&eventBuf, tag);
    postPayloadSize(&eventBuf, size);
    postCapsetID(&eventBuf, capset);

    postBuf(&eventBuf, (StgWord8*) msg, strsize);

    RELEASE_LOCK(&eventBufMutex);
}

void postCapsetVecEvent (EventTypeNum tag,
                         EventCapsetID capset,
                         int argc,
                         char *argv[])
{
    int i, size = sizeof(EventCapsetID);

    for (i = 0; i < argc; i++) {
        // 1 + strlen to account for the trailing \0, used as separator
        size += 1 + strlen(argv[i]);
    }

    ACQUIRE_LOCK(&eventBufMutex);

    if (!hasRoomForVariableEvent(&eventBuf, size)){
        printAndClearEventBuf(&eventBuf);

        if(!hasRoomForVariableEvent(&eventBuf, size)){
            // Event size exceeds buffer size, bail out:
            RELEASE_LOCK(&eventBufMutex);
            return;
        }
    }

    postEventHeader(&eventBuf, tag);
    postPayloadSize(&eventBuf, size);
    postCapsetID(&eventBuf, capset);

    for( i = 0; i < argc; i++ ) {
        // again, 1 + to account for \0
        postBuf(&eventBuf, (StgWord8*) argv[i], 1 + strlen(argv[i]));
    }

    RELEASE_LOCK(&eventBufMutex);
}

797 798 799 800 801 802 803
void postWallClockTime (EventCapsetID capset)
{
    StgWord64 ts;
    StgWord64 sec;
    StgWord32 nsec;

    ACQUIRE_LOCK(&eventBufMutex);
804

805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
    /* The EVENT_WALL_CLOCK_TIME event is intended to allow programs
       reading the eventlog to match up the event timestamps with wall
       clock time. The normal event timestamps measure time since the
       start of the program. To align eventlogs from concurrent
       processes we need to be able to match up the timestamps. One way
       to do this is if we know how the timestamps and wall clock time
       match up (and of course if both processes have sufficiently
       synchronised clocks).

       So we want to make sure that the timestamp that we generate for
       this event matches up very closely with the wall clock time.
       Unfortunately we currently have to use two different APIs to get
       the elapsed time vs the wall clock time. So to minimise the
       difference we just call them very close together.
     */
820

821 822
    getUnixEpochTime(&sec, &nsec);  /* Get the wall clock time */
    ts = time_ns();                 /* Get the eventlog timestamp */
823
    ensureRoomForEvent(&eventBuf, EVENT_WALL_CLOCK_TIME);
824 825 826 827 828 829

    /* Normally we'd call postEventHeader(), but that generates its own
       timestamp, so we go one level lower so we can write out the
       timestamp we already generated above. */
    postEventTypeNum(&eventBuf, EVENT_WALL_CLOCK_TIME);
    postWord64(&eventBuf, ts);
830

831 832 833 834 835 836 837 838
    /* EVENT_WALL_CLOCK_TIME (capset, unix_epoch_seconds, nanoseconds) */
    postCapsetID(&eventBuf, capset);
    postWord64(&eventBuf, sec);
    postWord32(&eventBuf, nsec);

    RELEASE_LOCK(&eventBufMutex);
}

839 840 841 842 843 844
/*
 * Various GC and heap events
 */
void postHeapEvent (Capability    *cap,
                    EventTypeNum   tag,
                    EventCapsetID  heap_capset,
845
                    W_           info1)
846 847 848 849
{
    EventsBuf *eb;

    eb = &capEventBuf[cap->no];
850
    ensureRoomForEvent(eb, tag);
851

852 853 854 855 856 857 858 859
    postEventHeader(eb, tag);

    switch (tag) {
    case EVENT_HEAP_ALLOCATED:     // (heap_capset, alloc_bytes)
    case EVENT_HEAP_SIZE:          // (heap_capset, size_bytes)
    case EVENT_HEAP_LIVE:          // (heap_capset, live_bytes)
    {
        postCapsetID(eb, heap_capset);
860
        postWord64(eb, info1 /* alloc/size/live_bytes */);
861 862 863 864 865 866 867 868 869 870
        break;
    }

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

void postEventHeapInfo (EventCapsetID heap_capset,
                        nat           gens,
871 872 873 874
                        W_          maxHeapSize,
                        W_          allocAreaSize,
                        W_          mblockSize,
                        W_          blockSize)
875 876
{
    ACQUIRE_LOCK(&eventBufMutex);
877
    ensureRoomForEvent(&eventBuf, EVENT_HEAP_INFO_GHC);
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895

    postEventHeader(&eventBuf, EVENT_HEAP_INFO_GHC);
    /* EVENT_HEAP_INFO_GHC (heap_capset, n_generations,
                            max_heap_size, alloc_area_size,
                            mblock_size, block_size) */
    postCapsetID(&eventBuf, heap_capset);
    postWord16(&eventBuf, gens);
    postWord64(&eventBuf, maxHeapSize);
    postWord64(&eventBuf, allocAreaSize);
    postWord64(&eventBuf, mblockSize);
    postWord64(&eventBuf, blockSize);

    RELEASE_LOCK(&eventBufMutex);
}

void postEventGcStats  (Capability    *cap,
                        EventCapsetID  heap_capset,
                        nat            gen,
896 897 898
                        W_           copied,
                        W_           slop,
                        W_           fragmentation,
899
                        nat            par_n_threads,
900 901
                        W_           par_max_copied,
                        W_           par_tot_copied)
902 903 904 905
{
    EventsBuf *eb;

    eb = &capEventBuf[cap->no];
906
    ensureRoomForEvent(eb, EVENT_GC_STATS_GHC);
907

908 909 910 911 912 913 914 915 916 917 918 919 920 921
    postEventHeader(eb, EVENT_GC_STATS_GHC);
    /* EVENT_GC_STATS_GHC (heap_capset, generation,
                           copied_bytes, slop_bytes, frag_bytes,
                           par_n_threads, par_max_copied, par_tot_copied) */
    postCapsetID(eb, heap_capset);
    postWord16(eb, gen);
    postWord64(eb, copied);
    postWord64(eb, slop);
    postWord64(eb, fragmentation);
    postWord32(eb, par_n_threads);
    postWord64(eb, par_max_copied);
    postWord64(eb, par_tot_copied);
}

922 923 924 925 926
void postTaskCreateEvent (EventTaskId taskId,
                          EventCapNo capno,
                          EventKernelThreadId tid)
{
    ACQUIRE_LOCK(&eventBufMutex);
927
    ensureRoomForEvent(&eventBuf, EVENT_TASK_CREATE);
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942

    postEventHeader(&eventBuf, EVENT_TASK_CREATE);
    /* EVENT_TASK_CREATE (taskID, cap, tid) */
    postTaskId(&eventBuf, taskId);
    postCapNo(&eventBuf, capno);
    postKernelThreadId(&eventBuf, tid);

    RELEASE_LOCK(&eventBufMutex);
}

void postTaskMigrateEvent (EventTaskId taskId,
                           EventCapNo capno,
                           EventCapNo new_capno)
{
    ACQUIRE_LOCK(&eventBufMutex);
943
    ensureRoomForEvent(&eventBuf, EVENT_TASK_MIGRATE);
944 945 946 947 948 949 950 951 952 953 954 955 956

    postEventHeader(&eventBuf, EVENT_TASK_MIGRATE);
    /* EVENT_TASK_MIGRATE (taskID, cap, new_cap) */
    postTaskId(&eventBuf, taskId);
    postCapNo(&eventBuf, capno);
    postCapNo(&eventBuf, new_capno);

    RELEASE_LOCK(&eventBufMutex);
}

void postTaskDeleteEvent (EventTaskId taskId)
{
    ACQUIRE_LOCK(&eventBufMutex);
957
    ensureRoomForEvent(&eventBuf, EVENT_TASK_DELETE);
958 959 960 961 962 963 964 965

    postEventHeader(&eventBuf, EVENT_TASK_DELETE);
    /* EVENT_TASK_DELETE (taskID) */
    postTaskId(&eventBuf, taskId);

    RELEASE_LOCK(&eventBufMutex);
}

966 967 968 969 970 971
void
postEvent (Capability *cap, EventTypeNum tag)
{
    EventsBuf *eb;

    eb = &capEventBuf[cap->no];
972
    ensureRoomForEvent(eb, tag);
973 974 975
    postEventHeader(eb, tag);
}

976 977 978 979 980 981
void
postEventAtTimestamp (Capability *cap, EventTimestamp ts, EventTypeNum tag)
{
    EventsBuf *eb;

    eb = &capEventBuf[cap->no];
982
    ensureRoomForEvent(eb, tag);
983 984 985 986 987 988 989 990

    /* Normally we'd call postEventHeader(), but that generates its own
       timestamp, so we go one level lower so we can write out
       the timestamp we received as an argument. */
    postEventTypeNum(eb, tag);
    postWord64(eb, ts);
}

991 992
#define BUF 512

993
void postLogMsg(EventsBuf *eb, EventTypeNum type, char *msg, va_list ap)
994 995 996 997 998 999 1000 1001 1002 1003
{
    char buf[BUF];
    nat size;

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

1004
    ensureRoomForVariableEvent(eb, size);
1005

1006
    postEventHeader(eb, type);
1007 1008
    postPayloadSize(eb, size);
    postBuf(eb,(StgWord8*)buf,size);
1009
}
1010

1011 1012 1013
void postMsg(char *msg, va_list ap)
{
    ACQUIRE_LOCK(&eventBufMutex);
1014
    postLogMsg(&eventBuf, EVENT_LOG_MSG, msg, ap);
1015 1016 1017 1018 1019
    RELEASE_LOCK(&eventBufMutex);
}

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

1023
void postUserEvent(Capability *cap, EventTypeNum type, char *msg)
1024 1025
{
    EventsBuf *eb;
1026
    int size = strlen(msg);
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038

    eb = &capEventBuf[cap->no];

    if (!hasRoomForVariableEvent(eb, size)){
        printAndClearEventBuf(eb);

        if (!hasRoomForVariableEvent(eb, size)){
            // Event size exceeds buffer size, bail out:
            return;
        }
    }

1039
    postEventHeader(eb, type);
1040
    postPayloadSize(eb, size);
1041
    postBuf(eb, (StgWord8*) msg, size);
1042 1043
}

1044 1045 1046 1047 1048 1049
void postThreadLabel(Capability    *cap,
                     EventThreadID  id,
                     char          *label)
{
    EventsBuf *eb;
    int strsize = strlen(label);
1050
    int size = strsize + sizeof(EventThreadID);
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068

    eb = &capEventBuf[cap->no];

    if (!hasRoomForVariableEvent(eb, size)){
        printAndClearEventBuf(eb);

        if (!hasRoomForVariableEvent(eb, size)){
            // Event size exceeds buffer size, bail out:
            return;
        }
    }

    postEventHeader(eb, EVENT_THREAD_LABEL);
    postPayloadSize(eb, size);
    postThreadID(eb, id);
    postBuf(eb, (StgWord8*) label, strsize);
}

Simon Marlow's avatar
Simon Marlow committed
1069 1070
void closeBlockMarker (EventsBuf *ebuf)
{
1071 1072
    StgInt8* save_pos;

Simon Marlow's avatar
Simon Marlow committed
1073 1074 1075
    if (ebuf->marker)
    {
        // (type:16, time:64, size:32, end_time:64)
1076 1077 1078 1079 1080 1081 1082

        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
1083 1084 1085 1086 1087 1088 1089
        ebuf->marker = NULL;
    }
}


void postBlockMarker (EventsBuf *eb)
{
1090
    ensureRoomForEvent(eb, EVENT_BLOCK_MARKER);
Simon Marlow's avatar
Simon Marlow committed
1091 1092 1093 1094 1095 1096 1097

    closeBlockMarker(eb);

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

void printAndClearEventBuf (EventsBuf *ebuf)
Simon Marlow's avatar
Simon Marlow committed
1102 1103 1104
{
    StgWord64 numBytes = 0, written = 0;

Simon Marlow's avatar
Simon Marlow committed
1105 1106
    closeBlockMarker(ebuf);

1107
    if (ebuf->begin != NULL && ebuf->pos != ebuf->begin)
Simon Marlow's avatar
Simon Marlow committed
1108
    {
1109
        numBytes = ebuf->pos - ebuf->begin;
1110

1111
        written = fwrite(ebuf->begin, 1, numBytes, event_log_file);
Simon Marlow's avatar
Simon Marlow committed
1112 1113 1114 1115 1116 1117
        if (written != numBytes) {
            debugBelch(
                "printAndClearEventLog: fwrite() failed, written=%" FMT_Word64
                " doesn't match numBytes=%" FMT_Word64, written, numBytes);
            return;
        }
1118

1119
        resetEventsBuf(ebuf);
Simon Marlow's avatar
Simon Marlow committed
1120 1121
        flushCount++;

Simon Marlow's avatar
Simon Marlow committed
1122 1123
        postBlockMarker(ebuf);
    }
Simon Marlow's avatar
Simon Marlow committed
1124 1125
}

1126
void initEventsBuf(EventsBuf* eb, StgWord64 size, EventCapNo capno)
Simon Marlow's avatar
Simon Marlow committed
1127
{
1128
    eb->begin = eb->pos = stgMallocBytes(size, "initEventsBuf");
Simon Marlow's avatar
Simon Marlow committed
1129
    eb->size = size;
Simon Marlow's avatar
Simon Marlow committed
1130
    eb->marker = NULL;
1131
    eb->capno = capno;
Simon Marlow's avatar
Simon Marlow committed
1132 1133 1134 1135 1136
}

void resetEventsBuf(EventsBuf* eb)
{
    eb->pos = eb->begin;
1137
    eb->marker = NULL;
Simon Marlow's avatar
Simon Marlow committed
1138 1139 1140 1141
}

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

1144
  size = sizeof(EventTypeNum) + sizeof(EventTimestamp) + eventTypes[eNum].size;
Simon Marlow's avatar
Simon Marlow committed
1145 1146 1147 1148 1149 1150 1151 1152

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

1153 1154 1155 1156 1157 <