Trace.c 22 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
    // -Dg turns on gc tracing too
    TRACE_gc =
        RtsFlags.TraceFlags.gc ||
100 101
        RtsFlags.DebugFlags.gc ||
        RtsFlags.DebugFlags.scheduler;
102 103 104
    if (TRACE_gc && RtsFlags.GcFlags.giveStats == NO_GC_STATS) {
        RtsFlags.GcFlags.giveStats = COLLECT_GC_STATS;
    }
105

106 107 108 109 110 111
    TRACE_spark_sampled =
        RtsFlags.TraceFlags.sparks_sampled;

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

114 115 116
    TRACE_user =
        RtsFlags.TraceFlags.user;

117
    eventlog_enabled = RtsFlags.TraceFlags.tracing == TRACE_EVENTLOG;
118

119
    /* Note: we can have any of the TRACE_* flags turned on even when
120 121 122
       eventlog_enabled is off. In the DEBUG way we may be tracing to stderr.
     */

123 124 125
    if (eventlog_enabled) {
        initEventLogging();
    }
126 127 128 129
}

void endTracing (void)
{
130 131 132
    if (eventlog_enabled) {
        endEventLogging();
    }
133 134 135 136
}

void freeTracing (void)
{
137 138 139
    if (eventlog_enabled) {
        freeEventLogging();
    }
Simon Marlow's avatar
Simon Marlow committed
140 141
}

142 143 144 145 146 147 148 149
void resetTracing (void)
{
    if (eventlog_enabled) {
        abortEventLogging(); // abort eventlog inherited from parent
        initEventLogging(); // child starts its own eventlog
    }
}

150 151 152 153 154 155 156
void tracingAddCapapilities (nat from, nat to)
{
    if (eventlog_enabled) {
        moreCapEventBufs(from,to);
    }
}

157 158 159 160 161
/* ---------------------------------------------------------------------------
   Emitting trace messages/events
 --------------------------------------------------------------------------- */

#ifdef DEBUG
Simon Marlow's avatar
Simon Marlow committed
162 163 164 165 166
static void tracePreface (void)
{
#ifdef THREADED_RTS
    debugBelch("%12lx: ", (unsigned long)osThreadId());
#endif
167
    if (RtsFlags.TraceFlags.timestamp) {
168
        debugBelch("%9" FMT_Word64 ": ", stat_getElapsedTime());
Simon Marlow's avatar
Simon Marlow committed
169 170
    }
}
171 172 173 174 175 176 177 178 179
#endif

#ifdef DEBUG
static char *thread_stop_reasons[] = {
    [HeapOverflow] = "heap overflow",
    [StackOverflow] = "stack overflow",
    [ThreadYielding] = "yielding",
    [ThreadBlocked] = "blocked",
    [ThreadFinished] = "finished",
180 181
    [THREAD_SUSPENDED_FOREIGN_CALL] = "suspended while making a foreign call",
    [6 + BlockedOnMVar]         = "blocked on an MVar",
182
    [6 + BlockedOnMVarRead]     = "blocked on an atomic MVar read",
183 184 185 186 187 188 189 190 191 192
    [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"
193 194
};
#endif
Simon Marlow's avatar
Simon Marlow committed
195

196
#ifdef DEBUG
197 198
static void traceSchedEvent_stderr (Capability *cap, EventTypeNum tag,
                                    StgTSO *tso,
199 200
                                    StgWord info1 STG_UNUSED,
                                    StgWord info2 STG_UNUSED)
Simon Marlow's avatar
Simon Marlow committed
201
{
202 203 204 205 206
    ACQUIRE_LOCK(&trace_utx);

    tracePreface();
    switch (tag) {
    case EVENT_CREATE_THREAD:   // (cap, thread)
207
        debugBelch("cap %d: created thread %" FMT_Word "\n",
208
                   cap->no, (W_)tso->id);
209 210
        break;
    case EVENT_RUN_THREAD:      //  (cap, thread)
211
        debugBelch("cap %d: running thread %" FMT_Word " (%s)\n",
212
                   cap->no, (W_)tso->id, what_next_strs[tso->what_next]);
213 214
        break;
    case EVENT_THREAD_RUNNABLE: // (cap, thread)
215
        debugBelch("cap %d: thread %" FMT_Word " appended to run queue\n",
216
                   cap->no, (W_)tso->id);
217 218
        break;
    case EVENT_MIGRATE_THREAD:  // (cap, thread, new_cap)
219
        debugBelch("cap %d: thread %" FMT_Word " migrating to cap %d\n",
220
                   cap->no, (W_)tso->id, (int)info1);
221
        break;
222
    case EVENT_THREAD_WAKEUP:   // (cap, thread, info1_cap)
223
        debugBelch("cap %d: waking up thread %" FMT_Word " on cap %d\n",
224
                   cap->no, (W_)tso->id, (int)info1);
225
        break;
226

227
    case EVENT_STOP_THREAD:     // (cap, thread, status)
228
        if (info1 == 6 + BlockedOnBlackHole) {
Ian Lynagh's avatar
Ian Lynagh committed
229
            debugBelch("cap %d: thread %" FMT_Word " stopped (blocked on black hole owned by thread %lu)\n",
230
                       cap->no, (W_)tso->id, (long)info2);
231
        } else {
Ian Lynagh's avatar
Ian Lynagh committed
232
            debugBelch("cap %d: thread %" FMT_Word " stopped (%s)\n",
233
                       cap->no, (W_)tso->id, thread_stop_reasons[info1]);
234
        }
235 236
        break;
    default:
237
        debugBelch("cap %d: thread %" FMT_Word ": event %d\n\n",
238
                   cap->no, (W_)tso->id, tag);
239 240 241 242 243 244
        break;
    }

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

246
void traceSchedEvent_ (Capability *cap, EventTypeNum tag,
247
                       StgTSO *tso, StgWord info1, StgWord info2)
248 249
{
#ifdef DEBUG
250
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
251
        traceSchedEvent_stderr(cap, tag, tso, info1, info2);
252 253 254
    } else
#endif
    {
255
        postSchedEvent(cap,tag,tso ? tso->id : 0, info1, info2);
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
#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;
287 288 289
      case EVENT_GC_GLOBAL_SYNC:  // (cap)
          debugBelch("cap %d: all caps stopped for GC\n", cap->no);
          break;
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
      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);
    }
}

312 313 314 315 316 317 318 319 320 321 322 323 324
void traceGcEventAtT_ (Capability *cap, StgWord64 ts, EventTypeNum tag)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        traceGcEvent_stderr(cap, tag);
    } else
#endif
    {
        /* assuming nullary events and explicitly inserting a timestamp */
        postEventAtTimestamp(cap, ts, tag);
    }
}

325 326 327
void traceHeapEvent_ (Capability   *cap,
                      EventTypeNum  tag,
                      CapsetID      heap_capset,
328
                      W_          info1)
329
{
330 331 332 333 334 335 336 337
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        /* no stderr equivalent for these ones */
    } else
#endif
    {
        postHeapEvent(cap, tag, heap_capset, info1);
    }
338 339 340 341
}

void traceEventHeapInfo_ (CapsetID    heap_capset,
                          nat         gens,
342 343 344 345
                          W_        maxHeapSize,
                          W_        allocAreaSize,
                          W_        mblockSize,
                          W_        blockSize)
346
{
347 348 349 350 351 352 353 354 355 356
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        /* no stderr equivalent for these ones */
    } else
#endif
    {
        postEventHeapInfo(heap_capset, gens,
                          maxHeapSize, allocAreaSize,
                          mblockSize, blockSize);
    }
357 358 359 360 361
}

void traceEventGcStats_  (Capability *cap,
                          CapsetID    heap_capset,
                          nat         gen,
362 363 364
                          W_        copied,
                          W_        slop,
                          W_        fragmentation,
365
                          nat         par_n_threads,
366 367
                          W_        par_max_copied,
                          W_        par_tot_copied)
368
{
369 370 371 372 373 374 375 376 377 378
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        /* no stderr equivalent for these ones */
    } else
#endif
    {
        postEventGcStats(cap, heap_capset, gen,
                         copied, slop, fragmentation,
                         par_n_threads, par_max_copied, par_tot_copied);
    }
379 380
}

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
void traceCapEvent (Capability   *cap,
                    EventTypeNum  tag)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        ACQUIRE_LOCK(&trace_utx);

        tracePreface();
        switch (tag) {
        case EVENT_CAP_CREATE:   // (cap)
            debugBelch("cap %d: initialised\n", cap->no);
            break;
        case EVENT_CAP_DELETE:   // (cap)
            debugBelch("cap %d: shutting down\n", cap->no);
            break;
        case EVENT_CAP_ENABLE:   // (cap)
            debugBelch("cap %d: enabling capability\n", cap->no);
            break;
        case EVENT_CAP_DISABLE:  // (cap)
            debugBelch("cap %d: disabling capability\n", cap->no);
            break;
        }
        RELEASE_LOCK(&trace_utx);
    } else
#endif
    {
        if (eventlog_enabled) {
            postCapEvent(tag, (EventCapNo)cap->no);
        }
    }
}

void traceCapsetEvent (EventTypeNum tag,
                       CapsetID     capset,
                       StgWord      info)
416 417
{
#ifdef DEBUG
418 419 420 421
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR && TRACE_sched)
        // When events go to stderr, it is annoying to see the capset
        // events every time, so we only emit them with -Ds.
    {
422 423 424 425 426
        ACQUIRE_LOCK(&trace_utx);

        tracePreface();
        switch (tag) {
        case EVENT_CAPSET_CREATE:   // (capset, capset_type)
Ian Lynagh's avatar
Ian Lynagh committed
427
            debugBelch("created capset %" FMT_Word " of type %d\n", (W_)capset, (int)info);
428 429
            break;
        case EVENT_CAPSET_DELETE:   // (capset)
Ian Lynagh's avatar
Ian Lynagh committed
430
            debugBelch("deleted capset %" FMT_Word "\n", (W_)capset);
431 432
            break;
        case EVENT_CAPSET_ASSIGN_CAP:  // (capset, capno)
Ian Lynagh's avatar
Ian Lynagh committed
433
            debugBelch("assigned cap %" FMT_Word " to capset %" FMT_Word "\n",
434
                       (W_)info, (W_)capset);
435 436
            break;
        case EVENT_CAPSET_REMOVE_CAP:  // (capset, capno)
Ian Lynagh's avatar
Ian Lynagh committed
437
            debugBelch("removed cap %" FMT_Word " from capset %" FMT_Word "\n",
438
                       (W_)info, (W_)capset);
439 440 441 442 443 444 445
            break;
        }
        RELEASE_LOCK(&trace_utx);
    } else
#endif
    {
        if (eventlog_enabled) {
446
            postCapsetEvent(tag, capset, info);
447 448 449 450
        }
    }
}

451 452 453 454 455 456
void traceWallClockTime_(void) {
    if (eventlog_enabled) {
        postWallClockTime(CAPSET_CLOCKDOMAIN_DEFAULT);
    }
}

457 458
void traceOSProcessInfo_(void) {
    if (eventlog_enabled) {
459 460 461
        postCapsetEvent(EVENT_OSPROCESS_PID,
                        CAPSET_OSPROCESS_DEFAULT,
                        getpid());
462 463 464 465 466 467

#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.
 */
468 469 470
        postCapsetEvent(EVENT_OSPROCESS_PPID,
                        CAPSET_OSPROCESS_DEFAULT,
                        getppid());
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
#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);
        }
    }
}

501
#ifdef DEBUG
502
static void traceSparkEvent_stderr (Capability *cap, EventTypeNum tag,
503 504 505 506 507 508 509 510
                                    StgWord info1)
{
    ACQUIRE_LOCK(&trace_utx);

    tracePreface();
    switch (tag) {

    case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
511
        debugBelch("cap %d: creating spark thread %lu\n",
512 513 514 515 516 517 518
                   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)
519
        debugBelch("cap %d: discarded dud spark\n",
520 521 522
                   cap->no);
        break;
    case EVENT_SPARK_OVERFLOW:      // (cap)
523
        debugBelch("cap %d: discarded overflowed spark\n",
524 525 526
                   cap->no);
        break;
    case EVENT_SPARK_RUN:           // (cap)
527
        debugBelch("cap %d: running a spark\n",
528 529 530
                   cap->no);
        break;
    case EVENT_SPARK_STEAL:         // (cap, victim_cap)
531
        debugBelch("cap %d: stealing a spark from cap %d\n",
532 533 534
                   cap->no, (int)info1);
        break;
    case EVENT_SPARK_FIZZLE:        // (cap)
535
        debugBelch("cap %d: fizzled spark removed from pool\n",
536 537 538
                   cap->no);
        break;
    case EVENT_SPARK_GC:            // (cap)
539
        debugBelch("cap %d: GCd spark removed from pool\n",
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
                   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
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
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);
    }
}

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
void traceTaskCreate_ (Task       *task,
                       Capability *cap)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        /* We currently don't do debug tracing of tasks but we must
           test for TRACE_STDERR because of the !eventlog_enabled case. */
    } else
#endif
    {
        EventTaskId         taskid = serialisableTaskId(task);
        EventKernelThreadId tid    = kernelThreadId();
        postTaskCreateEvent(taskid, cap->no, tid);
    }
}

void traceTaskMigrate_ (Task       *task,
                        Capability *cap,
                        Capability *new_cap)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        /* We currently don't do debug tracing of tasks but we must
           test for TRACE_STDERR because of the !eventlog_enabled case. */
    } else
#endif
    {
        EventTaskId taskid = serialisableTaskId(task);
        postTaskMigrateEvent(taskid, cap->no, new_cap->no);
    }
}

void traceTaskDelete_ (Task *task)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        /* We currently don't do debug tracing of tasks but we must
           test for TRACE_STDERR because of the !eventlog_enabled case. */
    } else
#endif
    {
        EventTaskId taskid = serialisableTaskId(task);
        postTaskDeleteEvent(taskid);
    }
}

624 625 626
#ifdef DEBUG
static void traceCap_stderr(Capability *cap, char *msg, va_list ap)
{
Simon Marlow's avatar
Simon Marlow committed
627 628
    ACQUIRE_LOCK(&trace_utx);

629
    tracePreface();
630
    debugBelch("cap %d: ", cap->no);
631 632 633 634 635 636 637
    vdebugBelch(msg,ap);
    debugBelch("\n");

    RELEASE_LOCK(&trace_utx);
}
#endif

638
void traceCap_(Capability *cap, char *msg, ...)
639
{
640 641
    va_list ap;
    va_start(ap,msg);
642

643
#ifdef DEBUG
644
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
645 646 647 648 649
        traceCap_stderr(cap, msg, ap);
    } else
#endif
    {
        postCapMsg(cap, msg, ap);
Simon Marlow's avatar
Simon Marlow committed
650
    }
651 652

    va_end(ap);
653 654 655 656 657 658 659 660 661 662
}

#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
663 664

    RELEASE_LOCK(&trace_utx);
665 666
}
#endif
Simon Marlow's avatar
Simon Marlow committed
667

668
void trace_(char *msg, ...)
669
{
670 671 672
    va_list ap;
    va_start(ap,msg);

673
#ifdef DEBUG
674
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
675 676 677 678 679 680
        trace_stderr(msg, ap);
    } else
#endif
    {
        postMsg(msg, ap);
    }
681 682

    va_end(ap);
Simon Marlow's avatar
Simon Marlow committed
683 684
}

685
static void traceFormatUserMsg(Capability *cap, char *msg, ...)
686
{
687 688 689
    va_list ap;
    va_start(ap,msg);

690 691 692 693
    /* 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
     */
694
#ifdef DEBUG
695
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR && TRACE_user) {
696
        traceCap_stderr(cap, msg, ap);
697 698 699
    } else
#endif
    {
700
        if (eventlog_enabled && TRACE_user) {
701
            postUserMsg(cap, msg, ap);
702 703
        }
    }
704
    dtraceUserMsg(cap->no, msg);
705 706
}

707 708 709 710 711
void traceUserMsg(Capability *cap, char *msg)
{
    traceFormatUserMsg(cap, "%s", msg);
}

712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
void traceUserMarker(Capability *cap, char *markername)
{
    /* Note: traceUserMarker is special since it has no wrapper (it's called
       from cmm code), so we check eventlog_enabled and TRACE_user here.
     */
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR && TRACE_user) {
        ACQUIRE_LOCK(&trace_utx);
        tracePreface();
        debugBelch("cap %d: User marker: %s\n", cap->no, markername);
        RELEASE_LOCK(&trace_utx);
    } else
#endif
    {
        if (eventlog_enabled && TRACE_user) {
            postUserMarker(cap, markername);
        }
    }
    dtraceUserMarker(cap->no, markername);
}


734 735 736 737 738 739 740 741
void traceThreadLabel_(Capability *cap,
                       StgTSO     *tso,
                       char       *label)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        ACQUIRE_LOCK(&trace_utx);
        tracePreface();
Ian Lynagh's avatar
Ian Lynagh committed
742
        debugBelch("cap %d: thread %" FMT_Word " has label %s\n",
743
                   cap->no, (W_)tso->id, label);
744 745 746 747 748 749 750 751
        RELEASE_LOCK(&trace_utx);
    } else
#endif
    {
        postThreadLabel(cap, tso->id, label);
    }
}

752 753 754
void traceThreadStatus_ (StgTSO *tso USED_IF_DEBUG)
{
#ifdef DEBUG
755
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
756 757 758 759 760 761 762 763
        printThreadStatus(tso);
    } else
#endif
    {
        /* nothing - no event for this one yet */
    }
}

764 765 766 767 768 769
void traceEventStartup_(int nocaps)
{
    if (eventlog_enabled) {
        postEventStartup(nocaps);
    }
}
770 771

#ifdef DEBUG
Simon Marlow's avatar
Simon Marlow committed
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
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);
}
788
#endif /* DEBUG */
Simon Marlow's avatar
Simon Marlow committed
789

790
#endif /* TRACING */
791 792 793 794 795 796 797 798 799 800 801

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

802 803 804 805 806
void dtraceUserMarkerWrapper(Capability *cap, char *msg)
{
    dtraceUserMarker(cap->no, msg);
}

807
#endif /* !defined(DEBUG) && !defined(TRACING) && defined(DTRACE) */
808 809 810 811 812 813 814 815

// Local Variables:
// mode: C
// fill-column: 80
// indent-tabs-mode: nil
// c-basic-offset: 4
// buffer-file-coding-system: utf-8-unix
// End: