X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=rts%2FTrace.h;h=1544971077c5f86545cfcf8a94b51d01e24f025e;hp=f422b5f8a55fc96e939286bfba377fc80f5424e4;hb=b2524b3960999fffdb3767900f58825903f6560f;hpb=5407ad8e0a5c08ac5193c1a9ede2a12570baee0b diff --git a/rts/Trace.h b/rts/Trace.h index f422b5f..1544971 100644 --- a/rts/Trace.h +++ b/rts/Trace.h @@ -2,7 +2,7 @@ * * (c) The GHC Team, 2008-2009 * - * Support for fast binary event logging. + * Support for fast binary event logging and user-space dtrace probes. * * ---------------------------------------------------------------------------*/ @@ -12,7 +12,11 @@ #include "rts/EventLogFormat.h" #include "Capability.h" -BEGIN_RTS_PRIVATE +#if defined(DTRACE) +#include "RtsProbes.h" +#endif /* defined(DTRACE) */ + +#include "BeginPrivate.h" // ----------------------------------------------------------------------------- // EventLog API @@ -23,9 +27,17 @@ BEGIN_RTS_PRIVATE void initTracing (void); void endTracing (void); void freeTracing (void); +void resetTracing (void); #endif /* TRACING */ +typedef StgWord32 CapsetID; +typedef StgWord16 CapsetType; +enum CapsetType { CapsetTypeCustom = CAPSET_TYPE_CUSTOM, + CapsetTypeOsProcess = CAPSET_TYPE_OSPROCESS, + CapsetTypeClockdomain = CAPSET_TYPE_CLOCKDOMAIN }; +#define CAPSET_OSPROCESS_DEFAULT 0 + // ----------------------------------------------------------------------------- // Message classes // ----------------------------------------------------------------------------- @@ -73,11 +85,27 @@ void traceEnd (void); */ #define traceSchedEvent(cap, tag, tso, other) \ if (RTS_UNLIKELY(TRACE_sched)) { \ - traceSchedEvent_(cap, tag, tso, other); \ + traceSchedEvent_(cap, tag, tso, other, 0); \ + } + +#define traceSchedEvent2(cap, tag, tso, info1, info2) \ + if (RTS_UNLIKELY(TRACE_sched)) { \ + traceSchedEvent_(cap, tag, tso, info1, info2); \ } void traceSchedEvent_ (Capability *cap, EventTypeNum tag, - StgTSO *tso, StgWord64 other); + StgTSO *tso, StgWord info1, StgWord info2); + + +/* + * Record a nullary event + */ +#define traceEvent(cap, tag) \ + if (RTS_UNLIKELY(TRACE_sched)) { \ + traceEvent_(cap, tag); \ + } + +void traceEvent_ (Capability *cap, EventTypeNum tag); // variadic macros are C99, and supported by gcc. However, the // ##__VA_ARGS syntax is a gcc extension, which allows the variable @@ -120,6 +148,15 @@ void traceUserMsg(Capability *cap, char *msg); #define debugTrace(class, str, ...) /* nothing */ #endif +#ifdef DEBUG +#define debugTraceCap(class, cap, msg, ...) \ + if (RTS_UNLIKELY(class)) { \ + traceCap_(cap, msg, ##__VA_ARGS__); \ + } +#else +#define debugTraceCap(class, cap, str, ...) /* nothing */ +#endif + /* * Emit a message/event describing the state of a thread */ @@ -130,16 +167,318 @@ void traceUserMsg(Capability *cap, char *msg); void traceThreadStatus_ (StgTSO *tso); +void traceEventStartup_ (int n_caps); + +/* + * Events for describing capability sets in the eventlog + * + * Note: unlike other events, these are not conditional on TRACE_sched or + * similar because they are not "real" events themselves but provide + * information and context for other "real" events. Other events depend on + * the capset info events so for simplicity, rather than working out if + * they're necessary we always emit them. They should be very low volume. + */ +void traceCapsetModify_ (EventTypeNum tag, + CapsetID capset, + StgWord32 other); + +void traceOSProcessInfo_ (void); + #else /* !TRACING */ #define traceSchedEvent(cap, tag, tso, other) /* nothing */ +#define traceSchedEvent2(cap, tag, tso, other, info) /* nothing */ +#define traceEvent(cap, tag) /* nothing */ #define traceCap(class, cap, msg, ...) /* nothing */ #define trace(class, msg, ...) /* nothing */ #define debugTrace(class, str, ...) /* nothing */ +#define debugTraceCap(class, cap, str, ...) /* nothing */ #define traceThreadStatus(class, tso) /* nothing */ +#define traceEventStartup_(n_caps) /* nothing */ +#define traceCapsetModify_(tag, capset, other) /* nothing */ +#define traceOSProcessInfo_() /* nothing */ #endif /* TRACING */ -END_RTS_PRIVATE +// 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); + +#endif /* !defined(DEBUG) && !defined(TRACING) && defined(DTRACE) */ + +// ----------------------------------------------------------------------------- +// Aliases for static dtrace probes if dtrace is available +// ----------------------------------------------------------------------------- + +#if defined(DTRACE) + +#define dtraceCreateThread(cap, tid) \ + HASKELLEVENT_CREATE_THREAD(cap, tid) +#define dtraceRunThread(cap, tid) \ + HASKELLEVENT_RUN_THREAD(cap, tid) +#define dtraceStopThread(cap, tid, status, info) \ + HASKELLEVENT_STOP_THREAD(cap, tid, status, info) +#define dtraceThreadRunnable(cap, tid) \ + HASKELLEVENT_THREAD_RUNNABLE(cap, tid) +#define dtraceMigrateThread(cap, tid, new_cap) \ + HASKELLEVENT_MIGRATE_THREAD(cap, tid, new_cap) +#define dtraceRunSpark(cap, tid) \ + HASKELLEVENT_RUN_SPARK(cap, tid) +#define dtraceStealSpark(cap, tid, victim_cap) \ + HASKELLEVENT_STEAL_SPARK(cap, tid, victim_cap) +#define dtraceShutdown(cap) \ + HASKELLEVENT_SHUTDOWN(cap) +#define dtraceThreadWakeup(cap, tid, other_cap) \ + HASKELLEVENT_THREAD_WAKEUP(cap, tid, other_cap) +#define dtraceGcStart(cap) \ + HASKELLEVENT_GC_START(cap) +#define dtraceGcEnd(cap) \ + HASKELLEVENT_GC_END(cap) +#define dtraceRequestSeqGc(cap) \ + HASKELLEVENT_REQUEST_SEQ_GC(cap) +#define dtraceRequestParGc(cap) \ + HASKELLEVENT_REQUEST_PAR_GC(cap) +#define dtraceCreateSparkThread(cap, spark_tid) \ + HASKELLEVENT_CREATE_SPARK_THREAD(cap, spark_tid) +#define dtraceStartup(num_caps) \ + HASKELLEVENT_STARTUP(num_caps) +#define dtraceUserMsg(cap, msg) \ + HASKELLEVENT_USER_MSG(cap, msg) +#define dtraceGcIdle(cap) \ + HASKELLEVENT_GC_IDLE(cap) +#define dtraceGcWork(cap) \ + HASKELLEVENT_GC_WORK(cap) +#define dtraceGcDone(cap) \ + HASKELLEVENT_GC_DONE(cap) +#define dtraceCapsetCreate(capset, capset_type) \ + HASKELLEVENT_CAPSET_CREATE(capset, capset_type) +#define dtraceCapsetDelete(capset) \ + HASKELLEVENT_CAPSET_DELETE(capset) +#define dtraceCapsetAssignCap(capset, capno) \ + HASKELLEVENT_CAPSET_ASSIGN_CAP(capset, capno) +#define dtraceCapsetRemoveCap(capset, capno) \ + HASKELLEVENT_CAPSET_REMOVE_CAP(capset, capno) + +#else /* !defined(DTRACE) */ + +#define dtraceCreateThread(cap, tid) /* nothing */ +#define dtraceRunThread(cap, tid) /* nothing */ +#define dtraceStopThread(cap, tid, status, info) /* nothing */ +#define dtraceThreadRunnable(cap, tid) /* nothing */ +#define dtraceMigrateThread(cap, tid, new_cap) /* nothing */ +#define dtraceRunSpark(cap, tid) /* nothing */ +#define dtraceStealSpark(cap, tid, victim_cap) /* nothing */ +#define dtraceShutdown(cap) /* nothing */ +#define dtraceThreadWakeup(cap, tid, other_cap) /* nothing */ +#define dtraceGcStart(cap) /* nothing */ +#define dtraceGcEnd(cap) /* nothing */ +#define dtraceRequestSeqGc(cap) /* nothing */ +#define dtraceRequestParGc(cap) /* nothing */ +#define dtraceCreateSparkThread(cap, spark_tid) /* nothing */ +#define dtraceStartup(num_caps) /* nothing */ +#define dtraceUserMsg(cap, msg) /* nothing */ +#define dtraceGcIdle(cap) /* nothing */ +#define dtraceGcWork(cap) /* nothing */ +#define dtraceGcDone(cap) /* nothing */ +#define dtraceCapsetCreate(capset, capset_type) /* nothing */ +#define dtraceCapsetDelete(capset) /* nothing */ +#define dtraceCapsetAssignCap(capset, capno) /* nothing */ +#define dtraceCapsetRemoveCap(capset, capno) /* nothing */ + +#endif + +// ----------------------------------------------------------------------------- +// Trace probes dispatching to various tracing frameworks +// +// In order to avoid accumulating multiple calls to tracing calls at trace +// points, we define inline probe functions that contain the various +// invocations. +// +// Dtrace - dtrace probes are unconditionally added as probe activation is +// handled by the dtrace component of the kernel, and inactive probes are +// very cheap — usually, one no-op. Consequently, dtrace can be used with +// all flavours of the RTS. In addition, we still support logging events to +// a file, even in the presence of dtrace. This is, eg, useful when tracing +// on a server, but browsing trace information with ThreadScope on a local +// client. +// +// ----------------------------------------------------------------------------- + +INLINE_HEADER void traceEventCreateThread(Capability *cap STG_UNUSED, + StgTSO *tso STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_CREATE_THREAD, tso, tso->stackobj->stack_size); + dtraceCreateThread((EventCapNo)cap->no, (EventThreadID)tso->id); +} + +INLINE_HEADER void traceEventRunThread(Capability *cap STG_UNUSED, + StgTSO *tso STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_RUN_THREAD, tso, tso->what_next); + dtraceRunThread((EventCapNo)cap->no, (EventThreadID)tso->id); +} + +INLINE_HEADER void traceEventStopThread(Capability *cap STG_UNUSED, + StgTSO *tso STG_UNUSED, + StgThreadReturnCode status STG_UNUSED, + StgWord32 info STG_UNUSED) +{ + traceSchedEvent2(cap, EVENT_STOP_THREAD, tso, status, info); + dtraceStopThread((EventCapNo)cap->no, (EventThreadID)tso->id, + (EventThreadStatus)status, (EventThreadID)info); +} + +// needs to be EXTERN_INLINE as it is used in another EXTERN_INLINE function +EXTERN_INLINE void traceEventThreadRunnable(Capability *cap STG_UNUSED, + StgTSO *tso STG_UNUSED); + +EXTERN_INLINE void traceEventThreadRunnable(Capability *cap STG_UNUSED, + StgTSO *tso STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_THREAD_RUNNABLE, tso, 0); + dtraceThreadRunnable((EventCapNo)cap->no, (EventThreadID)tso->id); +} + +INLINE_HEADER void traceEventMigrateThread(Capability *cap STG_UNUSED, + StgTSO *tso STG_UNUSED, + nat new_cap STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_MIGRATE_THREAD, tso, new_cap); + dtraceMigrateThread((EventCapNo)cap->no, (EventThreadID)tso->id, + (EventCapNo)new_cap); +} + +INLINE_HEADER void traceEventRunSpark(Capability *cap STG_UNUSED, + StgTSO *tso STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_RUN_SPARK, tso, 0); + dtraceRunSpark((EventCapNo)cap->no, (EventThreadID)tso->id); +} + +INLINE_HEADER void traceEventStealSpark(Capability *cap STG_UNUSED, + StgTSO *tso STG_UNUSED, + nat victim_cap STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_STEAL_SPARK, tso, victim_cap); + dtraceStealSpark((EventCapNo)cap->no, (EventThreadID)tso->id, + (EventCapNo)victim_cap); +} + +INLINE_HEADER void traceEventShutdown(Capability *cap STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_SHUTDOWN, 0, 0); + dtraceShutdown((EventCapNo)cap->no); +} + +INLINE_HEADER void traceEventThreadWakeup(Capability *cap STG_UNUSED, + StgTSO *tso STG_UNUSED, + nat other_cap STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_THREAD_WAKEUP, tso, other_cap); + dtraceThreadWakeup((EventCapNo)cap->no, (EventThreadID)tso->id, + (EventCapNo)other_cap); +} + +INLINE_HEADER void traceEventGcStart(Capability *cap STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_GC_START, 0, 0); + dtraceGcStart((EventCapNo)cap->no); +} + +INLINE_HEADER void traceEventGcEnd(Capability *cap STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_GC_END, 0, 0); + dtraceGcEnd((EventCapNo)cap->no); +} + +INLINE_HEADER void traceEventRequestSeqGc(Capability *cap STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_REQUEST_SEQ_GC, 0, 0); + dtraceRequestSeqGc((EventCapNo)cap->no); +} + +INLINE_HEADER void traceEventRequestParGc(Capability *cap STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_REQUEST_PAR_GC, 0, 0); + dtraceRequestParGc((EventCapNo)cap->no); +} + +INLINE_HEADER void traceEventCreateSparkThread(Capability *cap STG_UNUSED, + StgThreadID spark_tid STG_UNUSED) +{ + traceSchedEvent(cap, EVENT_CREATE_SPARK_THREAD, 0, spark_tid); + dtraceCreateSparkThread((EventCapNo)cap->no, (EventThreadID)spark_tid); +} + +INLINE_HEADER void traceEventStartup(void) +{ + int n_caps; +#ifdef THREADED_RTS + // XXX n_capabilities hasn't been initislised yet + n_caps = RtsFlags.ParFlags.nNodes; +#else + n_caps = 1; +#endif + + traceEventStartup_(n_caps); + dtraceStartup(n_caps); +} + +INLINE_HEADER void traceEventGcIdle(Capability *cap STG_UNUSED) +{ + traceEvent(cap, EVENT_GC_IDLE); + dtraceGcIdle((EventCapNo)cap->no); +} + +INLINE_HEADER void traceEventGcWork(Capability *cap STG_UNUSED) +{ + traceEvent(cap, EVENT_GC_WORK); + dtraceGcWork((EventCapNo)cap->no); +} + +INLINE_HEADER void traceEventGcDone(Capability *cap STG_UNUSED) +{ + traceEvent(cap, EVENT_GC_DONE); + dtraceGcDone((EventCapNo)cap->no); +} + +INLINE_HEADER void traceCapsetCreate(CapsetID capset STG_UNUSED, + CapsetType capset_type STG_UNUSED) +{ + traceCapsetModify_(EVENT_CAPSET_CREATE, capset, capset_type); + dtraceCapsetCreate(capset, capset_type); +} + +INLINE_HEADER void traceCapsetDelete(CapsetID capset STG_UNUSED) +{ + traceCapsetModify_(EVENT_CAPSET_DELETE, capset, 0); + dtraceCapsetDelete(capset); +} + +INLINE_HEADER void traceCapsetAssignCap(CapsetID capset STG_UNUSED, + nat capno STG_UNUSED) +{ + traceCapsetModify_(EVENT_CAPSET_ASSIGN_CAP, capset, capno); + dtraceCapsetAssignCap(capset, capno); +} + +INLINE_HEADER void traceCapsetRemoveCap(CapsetID capset STG_UNUSED, + nat capno STG_UNUSED) +{ + traceCapsetModify_(EVENT_CAPSET_REMOVE_CAP, capset, capno); + dtraceCapsetRemoveCap(capset, capno); +} + +INLINE_HEADER void traceOSProcessInfo(void) +{ + traceOSProcessInfo_(); + /* Note: no DTrace equivalent because all this OS process info + * is available to DTrace directly */ +} + +#include "EndPrivate.h" #endif /* TRACE_H */