Trace.c 12.7 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;
Simon Marlow's avatar
Simon Marlow committed
50 51 52 53 54

#ifdef THREADED_RTS
static Mutex trace_utx;
#endif

55 56
static rtsBool eventlog_enabled;

57 58 59
/* ---------------------------------------------------------------------------
   Starting up / shuttting down the tracing facilities
 --------------------------------------------------------------------------- */
Simon Marlow's avatar
Simon Marlow committed
60 61 62 63 64 65 66

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

67 68
#ifdef DEBUG
#define DEBUG_FLAG(name, class) \
69
    class = RtsFlags.DebugFlags.name ? 1 : 0;
70

Simon Marlow's avatar
Simon Marlow committed
71
    DEBUG_FLAG(scheduler,    DEBUG_sched);
72

Simon Marlow's avatar
Simon Marlow committed
73 74 75 76 77 78 79 80 81 82 83
    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);
84
    DEBUG_FLAG(hpc,          DEBUG_hpc);
85 86 87
    DEBUG_FLAG(sparks,       DEBUG_sparks);
#endif

88 89 90 91 92
    // -Ds turns on scheduler tracing too
    TRACE_sched =
        RtsFlags.TraceFlags.scheduler ||
        RtsFlags.DebugFlags.scheduler;

93
    eventlog_enabled = RtsFlags.TraceFlags.tracing == TRACE_EVENTLOG;
94 95 96 97

    if (eventlog_enabled) {
        initEventLogging();
    }
98 99 100 101
}

void endTracing (void)
{
102 103 104
    if (eventlog_enabled) {
        endEventLogging();
    }
105 106 107 108
}

void freeTracing (void)
{
109 110 111
    if (eventlog_enabled) {
        freeEventLogging();
    }
Simon Marlow's avatar
Simon Marlow committed
112 113
}

114 115 116 117 118 119 120 121
void resetTracing (void)
{
    if (eventlog_enabled) {
        abortEventLogging(); // abort eventlog inherited from parent
        initEventLogging(); // child starts its own eventlog
    }
}

122 123 124 125 126
/* ---------------------------------------------------------------------------
   Emitting trace messages/events
 --------------------------------------------------------------------------- */

#ifdef DEBUG
Simon Marlow's avatar
Simon Marlow committed
127 128 129 130 131
static void tracePreface (void)
{
#ifdef THREADED_RTS
    debugBelch("%12lx: ", (unsigned long)osThreadId());
#endif
132
    if (RtsFlags.TraceFlags.timestamp) {
Simon Marlow's avatar
Simon Marlow committed
133 134 135
	debugBelch("%9" FMT_Word64 ": ", stat_getElapsedTime());
    }
}
136 137 138 139 140 141 142 143 144
#endif

#ifdef DEBUG
static char *thread_stop_reasons[] = {
    [HeapOverflow] = "heap overflow",
    [StackOverflow] = "stack overflow",
    [ThreadYielding] = "yielding",
    [ThreadBlocked] = "blocked",
    [ThreadFinished] = "finished",
145 146 147 148 149 150 151 152 153 154 155 156
    [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"
157 158
};
#endif
Simon Marlow's avatar
Simon Marlow committed
159

160 161 162
#ifdef DEBUG
static void traceSchedEvent_stderr (Capability *cap, EventTypeNum tag, 
                                    StgTSO *tso, 
163 164
                                    StgWord info1 STG_UNUSED,
                                    StgWord info2 STG_UNUSED)
Simon Marlow's avatar
Simon Marlow committed
165
{
166 167 168 169 170
    ACQUIRE_LOCK(&trace_utx);

    tracePreface();
    switch (tag) {
    case EVENT_CREATE_THREAD:   // (cap, thread)
171 172
        debugBelch("cap %d: created thread %lu\n", 
                   cap->no, (lnat)tso->id);
173 174
        break;
    case EVENT_RUN_THREAD:      //  (cap, thread)
175 176
        debugBelch("cap %d: running thread %lu (%s)\n", 
                   cap->no, (lnat)tso->id, what_next_strs[tso->what_next]);
177 178
        break;
    case EVENT_THREAD_RUNNABLE: // (cap, thread)
179 180
        debugBelch("cap %d: thread %lu appended to run queue\n", 
                   cap->no, (lnat)tso->id);
181 182
        break;
    case EVENT_RUN_SPARK:       // (cap, thread)
183 184
        debugBelch("cap %d: thread %lu running a spark\n", 
                   cap->no, (lnat)tso->id);
185 186
        break;
    case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
187
        debugBelch("cap %d: creating spark thread %lu\n", 
188
                   cap->no, (long)info1);
189 190
        break;
    case EVENT_MIGRATE_THREAD:  // (cap, thread, new_cap)
191
        debugBelch("cap %d: thread %lu migrating to cap %d\n", 
192
                   cap->no, (lnat)tso->id, (int)info1);
193 194
        break;
    case EVENT_STEAL_SPARK:     // (cap, thread, victim_cap)
195
        debugBelch("cap %d: thread %lu stealing a spark from cap %d\n", 
196
                   cap->no, (lnat)tso->id, (int)info1);
197
        break;
198
    case EVENT_THREAD_WAKEUP:   // (cap, thread, info1_cap)
199
        debugBelch("cap %d: waking up thread %lu on cap %d\n", 
200
                   cap->no, (lnat)tso->id, (int)info1);
201 202 203
        break;
        
    case EVENT_STOP_THREAD:     // (cap, thread, status)
204 205 206 207 208 209 210
        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]);
        }
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
        break;
    case EVENT_SHUTDOWN:        // (cap)
        debugBelch("cap %d: shutting down\n", cap->no);
        break;
    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;
227 228 229 230 231 232 233 234 235
    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;
236
    default:
237
        debugBelch("cap %d: thread %lu: event %d\n\n", 
238
                   cap->no, (lnat)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 287 288 289 290 291
void traceCapsetModify_ (EventTypeNum tag,
                         CapsetID capset,
                         StgWord32 other)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
        ACQUIRE_LOCK(&trace_utx);

        tracePreface();
        switch (tag) {
        case EVENT_CAPSET_CREATE:   // (capset, capset_type)
            debugBelch("created capset %d of type %d\n", capset, other);
            break;
        case EVENT_CAPSET_DELETE:   // (capset)
            debugBelch("deleted capset %d\n", capset);
            break;
        case EVENT_CAPSET_ASSIGN_CAP:  // (capset, capno)
            debugBelch("assigned cap %d to capset %d\n", other, capset);
            break;
        case EVENT_CAPSET_REMOVE_CAP:  // (capset, capno)
            debugBelch("removed cap %d from capset %d\n", other, capset);
            break;
        }
        RELEASE_LOCK(&trace_utx);
    } else
#endif
    {
        if (eventlog_enabled) {
            postCapsetModifyEvent(tag, capset, other);
        }
    }
}

292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
void traceOSProcessInfo_(void) {
    if (eventlog_enabled) {
        postCapsetModifyEvent(EVENT_OSPROCESS_PID,
                              CAPSET_OSPROCESS_DEFAULT,
                              getpid());

#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.
 */
        postCapsetModifyEvent(EVENT_OSPROCESS_PPID,
                              CAPSET_OSPROCESS_DEFAULT,
                              getppid());
#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);
        }
    }
}

336 337 338 339
void traceEvent_ (Capability *cap, EventTypeNum tag)
{
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
340
        traceSchedEvent_stderr(cap, tag, 0, 0, 0);
341 342 343 344 345 346 347
    } else
#endif
    {
        postEvent(cap,tag);
    }
}

348 349 350
#ifdef DEBUG
static void traceCap_stderr(Capability *cap, char *msg, va_list ap)
{
Simon Marlow's avatar
Simon Marlow committed
351 352
    ACQUIRE_LOCK(&trace_utx);

353
    tracePreface();
354
    debugBelch("cap %d: ", cap->no);
355 356 357 358 359 360 361
    vdebugBelch(msg,ap);
    debugBelch("\n");

    RELEASE_LOCK(&trace_utx);
}
#endif

362
void traceCap_(Capability *cap, char *msg, ...)
363
{
364 365 366
    va_list ap;
    va_start(ap,msg);
    
367
#ifdef DEBUG
368
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
369 370 371 372 373
        traceCap_stderr(cap, msg, ap);
    } else
#endif
    {
        postCapMsg(cap, msg, ap);
Simon Marlow's avatar
Simon Marlow committed
374
    }
375 376

    va_end(ap);
377 378 379 380 381 382 383 384 385 386
}

#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
387 388

    RELEASE_LOCK(&trace_utx);
389 390
}
#endif
Simon Marlow's avatar
Simon Marlow committed
391

392
void trace_(char *msg, ...)
393
{
394 395 396
    va_list ap;
    va_start(ap,msg);

397
#ifdef DEBUG
398
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
399 400 401 402 403 404
        trace_stderr(msg, ap);
    } else
#endif
    {
        postMsg(msg, ap);
    }
405 406

    va_end(ap);
Simon Marlow's avatar
Simon Marlow committed
407 408
}

409
static void traceFormatUserMsg(Capability *cap, char *msg, ...)
410
{
411 412 413
    va_list ap;
    va_start(ap,msg);

414 415
#ifdef DEBUG
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
416
        traceCap_stderr(cap, msg, ap);
417 418 419 420
    } else
#endif
    {
        if (eventlog_enabled) {
421
            postUserMsg(cap, msg, ap);
422 423
        }
    }
424
    dtraceUserMsg(cap->no, msg);
425 426
}

427 428 429 430 431
void traceUserMsg(Capability *cap, char *msg)
{
    traceFormatUserMsg(cap, "%s", msg);
}

432 433 434
void traceThreadStatus_ (StgTSO *tso USED_IF_DEBUG)
{
#ifdef DEBUG
435
    if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
436 437 438 439 440 441 442 443
        printThreadStatus(tso);
    } else
#endif
    {
        /* nothing - no event for this one yet */
    }
}

444 445 446 447 448 449
void traceEventStartup_(int nocaps)
{
    if (eventlog_enabled) {
        postEventStartup(nocaps);
    }
}
450 451

#ifdef DEBUG
Simon Marlow's avatar
Simon Marlow committed
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
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);
}
468
#endif /* DEBUG */
Simon Marlow's avatar
Simon Marlow committed
469

470
#endif /* TRACING */
471 472 473 474 475 476 477 478 479 480 481 482

// 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) */