1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team 2006-2009
5 * Debug and performance tracing
7 * ---------------------------------------------------------------------------*/
19 #include "eventlog/EventLog.h"
24 // debugging flags, set with +RTS -D<something>
30 int DEBUG_block_alloc;
47 static Mutex trace_utx;
50 static rtsBool eventlog_enabled;
52 /* ---------------------------------------------------------------------------
53 Starting up / shuttting down the tracing facilities
54 --------------------------------------------------------------------------- */
56 void initTracing (void)
59 initMutex(&trace_utx);
63 #define DEBUG_FLAG(name, class) \
64 class = RtsFlags.DebugFlags.name ? 1 : 0;
66 DEBUG_FLAG(scheduler, DEBUG_sched);
68 DEBUG_FLAG(interpreter, DEBUG_interp);
69 DEBUG_FLAG(weak, DEBUG_weak);
70 DEBUG_FLAG(gccafs, DEBUG_gccafs);
71 DEBUG_FLAG(gc, DEBUG_gc);
72 DEBUG_FLAG(block_alloc, DEBUG_block_alloc);
73 DEBUG_FLAG(sanity, DEBUG_sanity);
74 DEBUG_FLAG(stable, DEBUG_stable);
75 DEBUG_FLAG(stm, DEBUG_stm);
76 DEBUG_FLAG(prof, DEBUG_prof);
77 DEBUG_FLAG(linker, DEBUG_linker);
78 DEBUG_FLAG(squeeze, DEBUG_squeeze);
79 DEBUG_FLAG(hpc, DEBUG_hpc);
80 DEBUG_FLAG(sparks, DEBUG_sparks);
83 // -Ds turns on scheduler tracing too
85 RtsFlags.TraceFlags.scheduler ||
86 RtsFlags.DebugFlags.scheduler;
88 eventlog_enabled = RtsFlags.TraceFlags.tracing == TRACE_EVENTLOG;
90 if (eventlog_enabled) {
95 void endTracing (void)
97 if (eventlog_enabled) {
102 void freeTracing (void)
104 if (eventlog_enabled) {
109 void resetTracing (void)
111 if (eventlog_enabled) {
112 abortEventLogging(); // abort eventlog inherited from parent
113 initEventLogging(); // child starts its own eventlog
117 /* ---------------------------------------------------------------------------
118 Emitting trace messages/events
119 --------------------------------------------------------------------------- */
122 static void tracePreface (void)
125 debugBelch("%12lx: ", (unsigned long)osThreadId());
127 if (RtsFlags.TraceFlags.timestamp) {
128 debugBelch("%9" FMT_Word64 ": ", stat_getElapsedTime());
134 static char *thread_stop_reasons[] = {
135 [HeapOverflow] = "heap overflow",
136 [StackOverflow] = "stack overflow",
137 [ThreadYielding] = "yielding",
138 [ThreadBlocked] = "blocked",
139 [ThreadFinished] = "finished",
140 [THREAD_SUSPENDED_FOREIGN_CALL] = "suspended while making a foreign call",
141 [6 + BlockedOnMVar] = "blocked on an MVar",
142 [6 + BlockedOnBlackHole] = "blocked on a black hole",
143 [6 + BlockedOnRead] = "blocked on a read operation",
144 [6 + BlockedOnWrite] = "blocked on a write operation",
145 [6 + BlockedOnDelay] = "blocked on a delay operation",
146 [6 + BlockedOnSTM] = "blocked on STM",
147 [6 + BlockedOnDoProc] = "blocked on asyncDoProc",
148 [6 + BlockedOnCCall] = "blocked on a foreign call",
149 [6 + BlockedOnCCall_Interruptible] = "blocked on a foreign call (interruptible)",
150 [6 + BlockedOnMsgThrowTo] = "blocked on throwTo",
151 [6 + ThreadMigrating] = "migrating"
156 static void traceSchedEvent_stderr (Capability *cap, EventTypeNum tag,
158 StgWord info1 STG_UNUSED,
159 StgWord info2 STG_UNUSED)
161 ACQUIRE_LOCK(&trace_utx);
165 case EVENT_CREATE_THREAD: // (cap, thread)
166 debugBelch("cap %d: created thread %lu\n",
167 cap->no, (lnat)tso->id);
169 case EVENT_RUN_THREAD: // (cap, thread)
170 debugBelch("cap %d: running thread %lu (%s)\n",
171 cap->no, (lnat)tso->id, what_next_strs[tso->what_next]);
173 case EVENT_THREAD_RUNNABLE: // (cap, thread)
174 debugBelch("cap %d: thread %lu appended to run queue\n",
175 cap->no, (lnat)tso->id);
177 case EVENT_RUN_SPARK: // (cap, thread)
178 debugBelch("cap %d: thread %lu running a spark\n",
179 cap->no, (lnat)tso->id);
181 case EVENT_CREATE_SPARK_THREAD: // (cap, spark_thread)
182 debugBelch("cap %d: creating spark thread %lu\n",
183 cap->no, (long)info1);
185 case EVENT_MIGRATE_THREAD: // (cap, thread, new_cap)
186 debugBelch("cap %d: thread %lu migrating to cap %d\n",
187 cap->no, (lnat)tso->id, (int)info1);
189 case EVENT_STEAL_SPARK: // (cap, thread, victim_cap)
190 debugBelch("cap %d: thread %lu stealing a spark from cap %d\n",
191 cap->no, (lnat)tso->id, (int)info1);
193 case EVENT_THREAD_WAKEUP: // (cap, thread, info1_cap)
194 debugBelch("cap %d: waking up thread %lu on cap %d\n",
195 cap->no, (lnat)tso->id, (int)info1);
198 case EVENT_STOP_THREAD: // (cap, thread, status)
199 if (info1 == 6 + BlockedOnBlackHole) {
200 debugBelch("cap %d: thread %lu stopped (blocked on black hole owned by thread %lu)\n",
201 cap->no, (lnat)tso->id, (long)info2);
203 debugBelch("cap %d: thread %lu stopped (%s)\n",
204 cap->no, (lnat)tso->id, thread_stop_reasons[info1]);
207 case EVENT_SHUTDOWN: // (cap)
208 debugBelch("cap %d: shutting down\n", cap->no);
210 case EVENT_REQUEST_SEQ_GC: // (cap)
211 debugBelch("cap %d: requesting sequential GC\n", cap->no);
213 case EVENT_REQUEST_PAR_GC: // (cap)
214 debugBelch("cap %d: requesting parallel GC\n", cap->no);
216 case EVENT_GC_START: // (cap)
217 debugBelch("cap %d: starting GC\n", cap->no);
219 case EVENT_GC_END: // (cap)
220 debugBelch("cap %d: finished GC\n", cap->no);
222 case EVENT_GC_IDLE: // (cap)
223 debugBelch("cap %d: GC idle\n", cap->no);
225 case EVENT_GC_WORK: // (cap)
226 debugBelch("cap %d: GC working\n", cap->no);
228 case EVENT_GC_DONE: // (cap)
229 debugBelch("cap %d: GC done\n", cap->no);
232 debugBelch("cap %d: thread %lu: event %d\n\n",
233 cap->no, (lnat)tso->id, tag);
237 RELEASE_LOCK(&trace_utx);
241 void traceSchedEvent_ (Capability *cap, EventTypeNum tag,
242 StgTSO *tso, StgWord info1, StgWord info2)
245 if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
246 traceSchedEvent_stderr(cap, tag, tso, info1, info2);
250 postSchedEvent(cap,tag,tso ? tso->id : 0, info1, info2);
254 void traceEvent_ (Capability *cap, EventTypeNum tag)
257 if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
258 traceSchedEvent_stderr(cap, tag, 0, 0, 0);
267 static void traceCap_stderr(Capability *cap, char *msg, va_list ap)
269 ACQUIRE_LOCK(&trace_utx);
272 debugBelch("cap %d: ", cap->no);
276 RELEASE_LOCK(&trace_utx);
280 void traceCap_(Capability *cap, char *msg, ...)
286 if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
287 traceCap_stderr(cap, msg, ap);
291 postCapMsg(cap, msg, ap);
298 static void trace_stderr(char *msg, va_list ap)
300 ACQUIRE_LOCK(&trace_utx);
306 RELEASE_LOCK(&trace_utx);
310 void trace_(char *msg, ...)
316 if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
317 trace_stderr(msg, ap);
327 static void traceFormatUserMsg(Capability *cap, char *msg, ...)
333 if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
334 traceCap_stderr(cap, msg, ap);
338 if (eventlog_enabled) {
339 postUserMsg(cap, msg, ap);
342 dtraceUserMsg(cap->no, msg);
345 void traceUserMsg(Capability *cap, char *msg)
347 traceFormatUserMsg(cap, "%s", msg);
350 void traceThreadStatus_ (StgTSO *tso USED_IF_DEBUG)
353 if (RtsFlags.TraceFlags.tracing == TRACE_STDERR) {
354 printThreadStatus(tso);
358 /* nothing - no event for this one yet */
364 void traceBegin (const char *str, ...)
369 ACQUIRE_LOCK(&trace_utx);
378 RELEASE_LOCK(&trace_utx);
384 // If DTRACE is enabled, but neither DEBUG nor TRACING, we need a C land
385 // wrapper for the user-msg probe (as we can't expand that in PrimOps.cmm)
387 #if !defined(DEBUG) && !defined(TRACING) && defined(DTRACE)
389 void dtraceUserMsgWrapper(Capability *cap, char *msg)
391 dtraceUserMsg(cap->no, msg);
394 #endif /* !defined(DEBUG) && !defined(TRACING) && defined(DTRACE) */