Trace.c 16.3 KB
Newer Older
Simon Marlow's avatar
Simon Marlow committed
1 2
/* -----------------------------------------------------------------------------
 *
Simon Marlow's avatar
Simon Marlow committed
3
 * (c) The GHC Team 2006-2009
Simon Marlow's avatar
Simon Marlow committed
4 5 6 7 8
 *
 * Debug and performance tracing
 *
 * ---------------------------------------------------------------------------*/

Simon Marlow's avatar
Simon Marlow committed
9
// external headers
Simon Marlow's avatar
Simon Marlow committed
10
#include "Rts.h"
11

Simon Marlow's avatar
Simon Marlow committed
12
// internal headers
Simon Marlow's avatar
Simon Marlow committed
13
#include "Trace.h"
14 15 16

#ifdef TRACING

Simon Marlow's avatar
Simon Marlow committed
17
#include "GetTime.h"
18
#include "GetEnv.h"
Simon Marlow's avatar
Simon Marlow committed
19
#include "Stats.h"
20 21 22
#include "eventlog/EventLog.h"
#include "Threads.h"
#include "Printer.h"
Simon Marlow's avatar
Simon Marlow committed
23

24 25 26 27
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

28
#ifdef DEBUG
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
// debugging flags, set with +RTS -D<something>
int DEBUG_sched;
int DEBUG_interp;
int DEBUG_weak;
int DEBUG_gccafs;
int DEBUG_gc;
int DEBUG_block_alloc;
int DEBUG_sanity;
int DEBUG_stable;
int DEBUG_stm;
int DEBUG_prof;
int DEBUG_gran;
int DEBUG_par;
int DEBUG_linker;
int DEBUG_squeeze;
int DEBUG_hpc;
int DEBUG_sparks;
46
#endif
47 48 49

// events
int TRACE_sched;
50
int TRACE_gc;
51 52
int TRACE_spark_sampled;
int TRACE_spark_full;
53
int TRACE_user;
Simon Marlow's avatar
Simon Marlow committed
54 55 56 57 58

#ifdef THREADED_RTS
static Mutex trace_utx;
#endif

59 60
static rtsBool eventlog_enabled;

61 62 63
/* ---------------------------------------------------------------------------
   Starting up / shuttting down the tracing facilities
 --------------------------------------------------------------------------- */
Simon Marlow's avatar
Simon Marlow committed
64 65 66 67 68 69 70

void initTracing (void)
{
#ifdef THREADED_RTS
    initMutex(&trace_utx);
#endif

71 72
#ifdef DEBUG
#define DEBUG_FLAG(name, class) \
73
    class = RtsFlags.DebugFlags.name ? 1 : 0;
74

Simon Marlow's avatar
Simon Marlow committed
75
    DEBUG_FLAG(scheduler,    DEBUG_sched);
76

Simon Marlow's avatar
Simon Marlow committed
77 78 79 80 81 82 83 84 85 86 87
    DEBUG_FLAG(interpreter,  DEBUG_interp);
    DEBUG_FLAG(weak,         DEBUG_weak);
    DEBUG_FLAG(gccafs,       DEBUG_gccafs);
    DEBUG_FLAG(gc,           DEBUG_gc);
    DEBUG_FLAG(block_alloc,  DEBUG_block_alloc);
    DEBUG_FLAG(sanity,       DEBUG_sanity);
    DEBUG_FLAG(stable,       DEBUG_stable);
    DEBUG_FLAG(stm,          DEBUG_stm);
    DEBUG_FLAG(prof,         DEBUG_prof);
    DEBUG_FLAG(linker,       DEBUG_linker);
    DEBUG_FLAG(squeeze,      DEBUG_squeeze);
88
    DEBUG_FLAG(hpc,          DEBUG_hpc);
89 90 91
    DEBUG_FLAG(sparks,       DEBUG_sparks);
#endif

92 93 94 95 96
    // -Ds turns on scheduler tracing too
    TRACE_sched =
        RtsFlags.TraceFlags.scheduler ||
        RtsFlags.DebugFlags.scheduler;

97 98 99 100 101
    // -Dg turns on gc tracing too
    TRACE_gc =
        RtsFlags.TraceFlags.gc ||
        RtsFlags.DebugFlags.gc;

102 103 104 105 106 107
    TRACE_spark_sampled =
        RtsFlags.TraceFlags.sparks_sampled;

    // -Dr turns on full spark tracing
    TRACE_spark_full =
        RtsFlags.TraceFlags.sparks_full ||
108 109
        RtsFlags.DebugFlags.sparks;

110 111 112
    TRACE_user =
        RtsFlags.TraceFlags.user;

113
    eventlog_enabled = RtsFlags.TraceFlags.tracing == TRACE_EVENTLOG;
114

115
    /* Note: we can have any of the TRACE_* flags turned on even when
116 117 118
       eventlog_enabled is off. In the DEBUG way we may be tracing to stderr.
     */

119 120 121
    if (eventlog_enabled) {
        initEventLogging();
    }
122 123 124 125
}

void endTracing (void)
{
126 127 128
    if (eventlog_enabled) {
        endEventLogging();
    }
129 130 131 132
}

void freeTracing (void)
{
133 134 135
    if (eventlog_enabled) {
        freeEventLogging();
    }
Simon Marlow's avatar
Simon Marlow committed
136 137
}

138 139 140 141 142 143 144 145
void resetTracing (void)
{
    if (eventlog_enabled) {
        abortEventLogging(); // abort eventlog inherited from parent
        initEventLogging(); // child starts its own eventlog
    }
}

146 147 148 149 150
/* ---------------------------------------------------------------------------
   Emitting trace messages/events
 --------------------------------------------------------------------------- */

#ifdef DEBUG
Simon Marlow's avatar
Simon Marlow committed
151 152 153 154 155
static void tracePreface (void)
{
#ifdef THREADED_RTS
    debugBelch("%12lx: ", (unsigned long)osThreadId());
#endif
156
    if (RtsFlags.TraceFlags.timestamp) {
Simon Marlow's avatar
Simon Marlow committed
157 158 159
	debugBelch("%9" FMT_Word64 ": ", stat_getElapsedTime());
    }
}
160 161 162 163 164 165 166 167 168
#endif

#ifdef DEBUG
static char *thread_stop_reasons[] = {
    [HeapOverflow] = "heap overflow",
    [StackOverflow] = "stack overflow",
    [ThreadYielding] = "yielding",
    [ThreadBlocked] = "blocked",
    [ThreadFinished] = "finished",
169 170 171 172 173 174 175 176 177 178 179 180
    [THREAD_SUSPENDED_FOREIGN_CALL] = "suspended while making a foreign call",
    [6 + BlockedOnMVar]         = "blocked on an MVar",
    [6 + BlockedOnBlackHole]    = "blocked on a black hole",
    [6 + BlockedOnRead]         = "blocked on a read operation",
    [6 + BlockedOnWrite]        = "blocked on a write operation",
    [6 + BlockedOnDelay]        = "blocked on a delay operation",
    [6 + BlockedOnSTM]          = "blocked on STM",
    [6 + BlockedOnDoProc]       = "blocked on asyncDoProc",
    [6 + BlockedOnCCall]        = "blocked on a foreign call",
    [6 + BlockedOnCCall_Interruptible] = "blocked on a foreign call (interruptible)",
    [6 + BlockedOnMsgThrowTo]   =  "blocked on throwTo",
    [6 + ThreadMigrating]       =  "migrating"
181 182
};
#endif
Simon Marlow's avatar
Simon Marlow committed
183

184 185 186
#ifdef DEBUG
static void traceSchedEvent_stderr (Capability *cap, EventTypeNum tag, 
                                    StgTSO *tso, 
187 188
                                    StgWord info1 STG_UNUSED,
                                    StgWord info2 STG_UNUSED)
Simon Marlow's avatar
Simon Marlow committed
189
{
190 191 192 193 194
    ACQUIRE_LOCK(&trace_utx);

    tracePreface();
    switch (tag) {
    case EVENT_CREATE_THREAD:   // (cap, thread)
195 196
        debugBelch("cap %d: created thread %lu\n", 
                   cap->no, (lnat)tso->id);
197 198
        break;
    case EVENT_RUN_THREAD:      //  (cap, thread)
199 200
        debugBelch("cap %d: running thread %lu (%s)\n", 
                   cap->no, (lnat)tso->id, what_next_strs[tso->what_next]);
201 202
        break;
    case EVENT_THREAD_RUNNABLE: // (cap, thread)
203 204
        debugBelch("cap %d: thread %lu appended to run queue\n", 
                   cap->no, (lnat)tso->id);
205 206
        break;
    case EVENT_MIGRATE_THREAD:  // (cap, thread, new_cap)
207
        debugBelch("cap %d: thread %lu migrating to cap %d\n", 
208
                   cap->no, (lnat)tso->id, (int)info1);
209
        break;
210
    case EVENT_THREAD_WAKEUP:   // (cap, thread, info1_cap)
211
        debugBelch("cap %d: waking up thread %lu on cap %d\n", 
212
                   cap->no, (lnat)tso->id, (int)info1);
213 214 215
        break;
        
    case EVENT_STOP_THREAD:     // (cap, thread, status)
216 217 218 219 220 221 222
        if (info1 == 6 + BlockedOnBlackHole) {
            debugBelch("cap %d: thread %lu stopped (blocked on black hole owned by thread %lu)\n",
                       cap->no, (lnat)tso->id, (long)info2);
        } else {
            debugBelch("cap %d: thread %lu stopped (%s)\n",
                       cap->no, (lnat)tso->id, thread_stop_reasons[info1]);
        }
223 224 225 226 227
        break;
    case EVENT_SHUTDOWN:        // (cap)
        debugBelch("cap %d: shutting down\n", cap->no);
        break;
    default:
228
        debugBelch("cap %d: thread %lu: event %d\n\n", 
229
                   cap->no, (lnat)tso->id, tag);
230 231 232 233 234 235
        break;
    }

    RELEASE_LOCK(&trace_utx);
}
#endif
Simon Marlow's avatar
Simon Marlow committed
236

237
void traceSchedEvent_ (Capability *cap, EventTypeNum tag, 
238
                       StgTSO *tso, StgWord info1, StgWord info2)
239 240
{
#ifdef DEBUG
241
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
242
        traceSchedEvent_stderr(cap, tag, tso, info1, info2);
243 244 245
    } else
#endif
    {
246
        postSchedEvent(cap,tag,tso ? tso->id : 0, info1, info2);
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 287 288 289 290 291 292 293 294 295 296 297 298 299
#ifdef DEBUG
static void traceGcEvent_stderr (Capability *cap, EventTypeNum tag)
{
    ACQUIRE_LOCK(&trace_utx);

    tracePreface();
    switch (tag) {
      case EVENT_REQUEST_SEQ_GC:  // (cap)
          debugBelch("cap %d: requesting sequential GC\n", cap->no);
          break;
      case EVENT_REQUEST_PAR_GC:  // (cap)
          debugBelch("cap %d: requesting parallel GC\n", cap->no);
          break;
      case EVENT_GC_START:        // (cap)
          debugBelch("cap %d: starting GC\n", cap->no);
          break;
      case EVENT_GC_END:          // (cap)
          debugBelch("cap %d: finished GC\n", cap->no);
          break;
      case EVENT_GC_IDLE:         // (cap)
          debugBelch("cap %d: GC idle\n", cap->no);
          break;
      case EVENT_GC_WORK:         // (cap)
          debugBelch("cap %d: GC working\n", cap->no);
          break;
      case EVENT_GC_DONE:         // (cap)
          debugBelch("cap %d: GC done\n", cap->no);
          break;
      default:
          barf("traceGcEvent: unknown event tag %d", tag);
          break;
    }

    RELEASE_LOCK(&trace_utx);
}
#endif

void traceGcEvent_ (Capability *cap, EventTypeNum tag)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        traceGcEvent_stderr(cap, tag);
    } else
#endif
    {
        /* currently all GC events are nullary events */
        postEvent(cap, tag);
    }
}

300 301 302
void traceCapsetEvent_ (EventTypeNum tag,
                        CapsetID capset,
                        StgWord info)
303 304 305 306 307 308 309 310
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        ACQUIRE_LOCK(&trace_utx);

        tracePreface();
        switch (tag) {
        case EVENT_CAPSET_CREATE:   // (capset, capset_type)
311
            debugBelch("created capset %lu of type %d\n", (lnat)capset, (int)info);
312 313
            break;
        case EVENT_CAPSET_DELETE:   // (capset)
314
            debugBelch("deleted capset %lu\n", (lnat)capset);
315 316
            break;
        case EVENT_CAPSET_ASSIGN_CAP:  // (capset, capno)
317
            debugBelch("assigned cap %lu to capset %lu\n",
318
                       (lnat)info, (lnat)capset);
319 320
            break;
        case EVENT_CAPSET_REMOVE_CAP:  // (capset, capno)
321
            debugBelch("removed cap %lu from capset %lu\n",
322
                       (lnat)info, (lnat)capset);
323 324 325 326 327 328 329
            break;
        }
        RELEASE_LOCK(&trace_utx);
    } else
#endif
    {
        if (eventlog_enabled) {
330
            postCapsetEvent(tag, capset, info);
331 332 333 334
        }
    }
}

335 336 337 338 339 340
void traceWallClockTime_(void) {
    if (eventlog_enabled) {
        postWallClockTime(CAPSET_CLOCKDOMAIN_DEFAULT);
    }
}

341 342
void traceOSProcessInfo_(void) {
    if (eventlog_enabled) {
343 344 345
        postCapsetEvent(EVENT_OSPROCESS_PID,
                        CAPSET_OSPROCESS_DEFAULT,
                        getpid());
346 347 348 349 350 351

#if !defined(cygwin32_HOST_OS) && !defined (mingw32_HOST_OS)
/* Windows has no strong concept of process heirarchy, so no getppid().
 * In any case, this trace event is mainly useful for tracing programs
 * that use 'forkProcess' which Windows doesn't support anyway.
 */
352 353 354
        postCapsetEvent(EVENT_OSPROCESS_PPID,
                        CAPSET_OSPROCESS_DEFAULT,
                        getppid());
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
#endif
        {
            char buf[256];
            snprintf(buf, sizeof(buf), "GHC-%s %s", ProjectVersion, RtsWay);
            postCapsetStrEvent(EVENT_RTS_IDENTIFIER,
                               CAPSET_OSPROCESS_DEFAULT,
                               buf);
        }
        {
            int argc = 0; char **argv;
            getFullProgArgv(&argc, &argv);
            if (argc != 0) {
                postCapsetVecEvent(EVENT_PROGRAM_ARGS,
                                   CAPSET_OSPROCESS_DEFAULT,
                                   argc, argv);
            }
        }
        {
            int envc = 0; char **envv;
            getProgEnvv(&envc, &envv);
            if (envc != 0) {
                postCapsetVecEvent(EVENT_PROGRAM_ENV,
                                   CAPSET_OSPROCESS_DEFAULT,
                                   envc, envv);
            }
            freeProgEnvv(envc, envv);
        }
    }
}

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
#ifdef DEBUG
static void traceSparkEvent_stderr (Capability *cap, EventTypeNum tag, 
                                    StgWord info1)
{
    ACQUIRE_LOCK(&trace_utx);

    tracePreface();
    switch (tag) {

    case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
        debugBelch("cap %d: creating spark thread %lu\n", 
                   cap->no, (long)info1);
        break;
    case EVENT_SPARK_CREATE:        // (cap)
        debugBelch("cap %d: added spark to pool\n",
                   cap->no);
        break;
    case EVENT_SPARK_DUD:           //  (cap)
        debugBelch("cap %d: discarded dud spark\n", 
                   cap->no);
        break;
    case EVENT_SPARK_OVERFLOW:      // (cap)
        debugBelch("cap %d: discarded overflowed spark\n", 
                   cap->no);
        break;
    case EVENT_SPARK_RUN:           // (cap)
        debugBelch("cap %d: running a spark\n", 
                   cap->no);
        break;
    case EVENT_SPARK_STEAL:         // (cap, victim_cap)
        debugBelch("cap %d: stealing a spark from cap %d\n", 
                   cap->no, (int)info1);
        break;
    case EVENT_SPARK_FIZZLE:        // (cap)
        debugBelch("cap %d: fizzled spark removed from pool\n", 
                   cap->no);
        break;
    case EVENT_SPARK_GC:            // (cap)
        debugBelch("cap %d: GCd spark removed from pool\n", 
                   cap->no);
        break;
    default:
        barf("traceSparkEvent: unknown event tag %d", tag);
        break;
    }

    RELEASE_LOCK(&trace_utx);
}
#endif

void traceSparkEvent_ (Capability *cap, EventTypeNum tag, StgWord info1)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        traceSparkEvent_stderr(cap, tag, info1);
    } else
#endif
    {
        postSparkEvent(cap,tag,info1);
    }
}

Duncan Coutts's avatar
Duncan Coutts committed
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
void traceSparkCounters_ (Capability *cap,
                          SparkCounters counters,
                          StgWord remaining)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        /* we currently don't do debug tracing of spark stats but we must
           test for TRACE_STDERR because of the !eventlog_enabled case. */
    } else
#endif
    {
        postSparkCountersEvent(cap, counters, remaining);
    }
}

462 463 464
#ifdef DEBUG
static void traceCap_stderr(Capability *cap, char *msg, va_list ap)
{
Simon Marlow's avatar
Simon Marlow committed
465 466
    ACQUIRE_LOCK(&trace_utx);

467
    tracePreface();
468
    debugBelch("cap %d: ", cap->no);
469 470 471 472 473 474 475
    vdebugBelch(msg,ap);
    debugBelch("\n");

    RELEASE_LOCK(&trace_utx);
}
#endif

476
void traceCap_(Capability *cap, char *msg, ...)
477
{
478 479 480
    va_list ap;
    va_start(ap,msg);
    
481
#ifdef DEBUG
482
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
483 484 485 486 487
        traceCap_stderr(cap, msg, ap);
    } else
#endif
    {
        postCapMsg(cap, msg, ap);
Simon Marlow's avatar
Simon Marlow committed
488
    }
489 490

    va_end(ap);
491 492 493 494 495 496 497 498 499 500
}

#ifdef DEBUG
static void trace_stderr(char *msg, va_list ap)
{
    ACQUIRE_LOCK(&trace_utx);

    tracePreface();
    vdebugBelch(msg,ap);
    debugBelch("\n");
Simon Marlow's avatar
Simon Marlow committed
501 502

    RELEASE_LOCK(&trace_utx);
503 504
}
#endif
Simon Marlow's avatar
Simon Marlow committed
505

506
void trace_(char *msg, ...)
507
{
508 509 510
    va_list ap;
    va_start(ap,msg);

511
#ifdef DEBUG
512
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
513 514 515 516 517 518
        trace_stderr(msg, ap);
    } else
#endif
    {
        postMsg(msg, ap);
    }
519 520

    va_end(ap);
Simon Marlow's avatar
Simon Marlow committed
521 522
}

523
static void traceFormatUserMsg(Capability *cap, char *msg, ...)
524
{
525 526 527
    va_list ap;
    va_start(ap,msg);

528 529 530 531
    /* Note: normally we don't check the TRACE_* flags here as they're checked
       by the wrappers in Trace.h. But traceUserMsg is special since it has no
       wrapper (it's called from cmm code), so we check TRACE_user here
     */
532
#ifdef DEBUG
533
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR && TRACE_user) {
534
        traceCap_stderr(cap, msg, ap);
535 536 537
    } else
#endif
    {
538
        if (eventlog_enabled && TRACE_user) {
539
            postUserMsg(cap, msg, ap);
540 541
        }
    }
542
    dtraceUserMsg(cap->no, msg);
543 544
}

545 546 547 548 549
void traceUserMsg(Capability *cap, char *msg)
{
    traceFormatUserMsg(cap, "%s", msg);
}

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
void traceThreadLabel_(Capability *cap,
                       StgTSO     *tso,
                       char       *label)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        ACQUIRE_LOCK(&trace_utx);
        tracePreface();
        debugBelch("cap %d: thread %lu has label %s\n",
                   cap->no, (lnat)tso->id, label);
        RELEASE_LOCK(&trace_utx);
    } else
#endif
    {
        postThreadLabel(cap, tso->id, label);
    }
}

568 569 570
void traceThreadStatus_ (StgTSO *tso USED_IF_DEBUG)
{
#ifdef DEBUG
571
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
572 573 574 575 576 577 578 579
        printThreadStatus(tso);
    } else
#endif
    {
        /* nothing - no event for this one yet */
    }
}

580 581 582 583 584 585
void traceEventStartup_(int nocaps)
{
    if (eventlog_enabled) {
        postEventStartup(nocaps);
    }
}
586 587

#ifdef DEBUG
Simon Marlow's avatar
Simon Marlow committed
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
void traceBegin (const char *str, ...)
{
    va_list ap;
    va_start(ap,str);

    ACQUIRE_LOCK(&trace_utx);

    tracePreface();
    vdebugBelch(str,ap);
}

void traceEnd (void)
{
    debugBelch("\n");
    RELEASE_LOCK(&trace_utx);
}
604
#endif /* DEBUG */
Simon Marlow's avatar
Simon Marlow committed
605

606
#endif /* TRACING */
607 608 609 610 611 612 613 614 615 616 617 618

// If DTRACE is enabled, but neither DEBUG nor TRACING, we need a C land
// wrapper for the user-msg probe (as we can't expand that in PrimOps.cmm)
//
#if !defined(DEBUG) && !defined(TRACING) && defined(DTRACE)

void dtraceUserMsgWrapper(Capability *cap, char *msg)
{
    dtraceUserMsg(cap->no, msg);
}

#endif /* !defined(DEBUG) && !defined(TRACING) && defined(DTRACE) */