Fixed message tracing on comm thread (to trace those entry methods that need
[charm.git] / src / ck-perf / trace.h
1 /*****************************************************************************
2  * $Source$
3  * $Author$
4  * $Date$
5  * $Revision$
6  *****************************************************************************/
7
8 #ifndef _TRACE_H
9 #define _TRACE_H
10
11 /*
12  *   File: trace.h -- header file defines the super class of all trace modules
13  *         written by Gengbin Zheng, gzheng@uiuc.edu 
14  */ 
15
16 #if CMK_HAS_COUNTER_PAPI
17 #include <papi.h>
18 #endif
19
20 class envelope;
21
22 /**
23  \defgroup CkPerf  Charm++ Trace Module
24 */
25 /*@{*/
26
27 // An additional interface for summary data
28 extern "C" void traceClearEps();
29
30 // **CW** may not be necessary
31 extern "C" void traceEnableCCS();
32
33 extern double CmiTraceTimer();
34
35 extern int _dummyMsg, _dummyChare, _dummyEP;
36
37 /* CW Support for Thread Listener interface */
38 extern "C" void traceAddThreadListeners(CthThread tid, envelope *e);
39
40 // trace_in_charm means only do trace for Charm++ level, skip converse tracing
41 // Cpv traceOnPe controls if charm pe will generate trace logs (a default value)
42 // while traceOnPe flag in each trace module can also control independently if 
43 // tracing is wanted for each module
44 CkpvExtern(int, traceOnPe);
45
46 // A hack. We need to somehow tell the pup framework what size
47 // long_long is wrt PAPI.
48 #if CMK_HAS_COUNTER_PAPI
49 typedef long_long LONG_LONG_PAPI;
50 #else
51 typedef CMK_TYPEDEF_INT8 LONG_LONG_PAPI;
52 #endif
53
54 // Base class of all tracing strategies.
55 // 
56 class Trace {
57   protected:
58     int _traceOn;
59   
60   public:
61     Trace(): _traceOn(0) {}
62     virtual void setTraceOnPE(int flag) { _traceOn = flag; }
63     virtual inline int traceOnPE() { return _traceOn; }
64     // turn trace on/off, note that charm will automatically call traceBegin()
65     // at the beginning of every run unless the command line option "+traceoff"
66     // is specified
67     virtual void traceBegin() {}
68     virtual void traceEnd() {}
69 #if CMK_SMP_TRACE_COMMTHREAD            
70     virtual void traceBeginOnCommThread() {}   
71     virtual void traceEndOnCommThread() {}
72 #endif 
73                 
74     // registers user event trace module returns int identifier 
75     virtual int traceRegisterUserEvent(const char* eventName, int e) { 
76       return 0; 
77     }
78     // a user event has just occured
79     virtual void userEvent(int eventID) {}
80     // a pair of begin/end user event has just occured
81     virtual void userBracketEvent(int eventID, double bt, double et) {}
82
83         // a user supplied integer value(likely a timestep)
84         virtual void userSuppliedData(int e) {}
85
86         // a user supplied integer value(likely a timestep)
87         virtual void userSuppliedNote(char *note) {}
88
89         virtual void userSuppliedBracketedNote(char *note, int eventID, double bt, double et) {}
90
91
92         // the current memory usage as a double
93         virtual void memoryUsage(double currentMemUsage) {}
94         
95
96     // creation of message(s)
97     virtual void creation(envelope *, int epIdx, int num=1) {}
98     //epIdx is extracted from the envelope, num is always 1
99     virtual void creation(char *) {}
100     virtual void creationMulticast(envelope *, int epIdx, int num=1,
101                                      int *pelist=NULL) {}
102     virtual void creationDone(int num=1) {}
103     // ???
104     virtual void messageRecv(char *env, int pe) {}
105     virtual void beginSDAGBlock(
106       int event,   // event type defined in trace-common.h
107       int msgType, // message type
108       int ep,      // Charm++ entry point (will correspond to sts file) 
109       int srcPe,   // Which PE originated the call
110       int ml,      // message size
111       CmiObjId* idx)    // index
112     { }
113     virtual void endSDAGBlock(void) {}
114     // **************************************************************
115     // begin/end execution of a Charm++ entry point
116     // NOTE: begin/endPack and begin/endUnpack can be called in between
117     //       a beginExecute and its corresponding endExecute.
118     virtual void beginExecute(envelope *) {}
119     virtual void beginExecute(char *) {}
120     virtual void beginExecute(CmiObjId *tid) {}
121     virtual void beginExecute(
122       int event,   // event type defined in trace-common.h
123       int msgType, // message type
124       int ep,      // Charm++ entry point (will correspond to sts file) 
125       int srcPe,   // Which PE originated the call
126       int ml,      // message size
127       CmiObjId* idx)    // index
128     { }
129     virtual void changeLastEntryTimestamp(double ts) {}
130     virtual void endExecute(void) {}
131     virtual void endExecute(char *) {}
132     // begin/end idle time for this pe
133     virtual void beginIdle(double curWallTime) {}
134     virtual void endIdle(double curWallTime) {}
135     // begin/end the process of packing a message (to send)
136     virtual void beginPack(void) {}
137     virtual void endPack(void) {}
138     // begin/end the process of unpacking a message (can occur before calling
139     // a entry point or during an entry point when 
140     virtual void beginUnpack(void) {}
141     virtual void endUnpack(void) {}
142     // ???
143     virtual void enqueue(envelope *) {}
144     virtual void dequeue(envelope *) {}
145     // begin/end of execution
146     virtual void beginComputation(void) {}
147     virtual void endComputation(void) {}
148     // demarkation of a phase boundary
149     virtual void endPhase() {}
150     // clear all data collected for entry points
151     virtual void traceClearEps() {}
152     // enable CCS operations if supported on the trace module
153     virtual void traceEnableCCS() {}
154     // write the summary sts file for this trace
155     virtual void traceWriteSts() {}
156     // do any clean-up necessary for tracing
157     virtual void traceClose() {}
158     // flush log buffer immediately
159     virtual void traceFlushLog() {}
160
161     //for tracing function calls
162     virtual void regFunc(const char *name, int &idx, int idxSpecifiedByUser=0){}
163     virtual void beginFunc(char *name,char *file,int line){}
164     virtual void beginFunc(int idx,char *file,int line){}
165     virtual void endFunc(char *name){}    
166     virtual void endFunc(int idx){}
167
168     /* Memory tracing */
169     virtual void malloc(void *where, int size, void **stack, int stackSize){}
170     virtual void free(void *where, int size){}
171
172     /* for implementing thread listeners */
173     virtual void traceAddThreadListeners(CthThread tid, envelope *e) {}
174
175     virtual ~Trace() {} /* for whining compilers */
176 };
177
178 #define ALLDO(x) for (int i=0; i<length(); i++) if (traces[i]->traceOnPE()) traces[i]->x
179 #define ALLREVERSEDO(x) for (int i=length()-1; i>=0; i--) if (traces[i]->traceOnPE()) traces[i]->x
180
181 /// Array of Traces modules,  every event raised will go through every Trace module.
182 class TraceArray {
183 private:
184   CkVec<Trace *>  traces;
185   int n;
186   int cancel_beginIdle, cancel_endIdle;
187 public:
188     TraceArray(): n(0) {}
189     inline void addTrace(Trace *tr) { traces.push_back(tr); n++;}
190     inline void setTraceOnPE(int flag) { for (int i=0; i<length(); i++) traces[i]->setTraceOnPE(flag); }
191     // to allow traceCLose() to be called multiple times, remove trace module
192     // from the array in each individual trace, and clean up (clearTrace)
193     // after the loop.
194     inline void removeTrace(Trace *tr) {    // remove a Trace from TraceArray
195         int i;
196         for (i=0; i<n; i++) if (tr == traces[i]) break;
197         CmiAssert(i<n);
198         traces[i] = NULL;
199     }
200     inline void clearTrace() {    // remove holes in TraceArray
201         int len = traces.length();
202         int removed = 0;
203         for (int i=0; i<len; i++) {
204           if (traces[i-removed] == NULL) { traces.remove(i-removed); removed++; }
205         }
206         n -= removed;
207     }
208     inline int length() const { return n; }
209
210     inline void userEvent(int e) { ALLDO(userEvent(e));}
211     inline void userBracketEvent(int e,double bt, double et) {ALLDO(userBracketEvent(e,bt,et));}
212     
213         inline void userSuppliedData(int d) { ALLDO(userSuppliedData(d));}
214
215         inline void userSuppliedNote(char *note) { ALLDO(userSuppliedNote(note));}
216         inline void userSuppliedBracketedNote(char *note, int eventID, double bt, double et) {ALLDO(userSuppliedBracketedNote(note, eventID, bt, et));}
217
218
219         inline void memoryUsage(double memUsage) { ALLDO(memoryUsage(memUsage));}
220
221
222     /* Creation needs to access _entryTable, so moved into trace-common.C */
223     void creation(envelope *env, int ep, int num=1);
224     inline void creation(char *msg){
225         /* The check for whether the ep got traced is moved into each elem's
226          * creation call as the ep could not be extracted here
227          */
228         ALLDO(creation(msg));
229     }
230     void creationMulticast(envelope *env, int ep, int num=1, int *pelist=NULL);
231     
232     inline void creationDone(int num=1) { ALLDO(creationDone(num)); }
233     inline void beginSDAGBlock(int event,int msgType,int ep,int srcPe, int mlen,CmiObjId *idx=NULL) {ALLDO(beginSDAGBlock(event, msgType, ep, srcPe, mlen,idx));}
234     inline void endSDAGBlock(void) {ALLREVERSEDO(endExecute());}
235     inline void beginExecute(envelope *env) {ALLDO(beginExecute(env));}
236     inline void beginExecute(char *msg) {ALLDO(beginExecute(msg));}
237     inline void beginExecute(CmiObjId *tid) {ALLDO(beginExecute(tid));}
238     inline void beginExecute(int event,int msgType,int ep,int srcPe, int mlen,CmiObjId *idx=NULL) {ALLDO(beginExecute(event, msgType, ep, srcPe, mlen,idx));}
239     inline void endExecute(void) {ALLREVERSEDO(endExecute());}
240     inline void endExecute(char *msg) {ALLREVERSEDO(endExecute(msg));}
241     inline void changeLastEntryTimestamp(double ts) {ALLDO(changeLastEntryTimestamp(ts));}
242     inline void messageRecv(char *env, int pe) {ALLDO(messageRecv(env, pe));}
243     inline void beginPack(void) {ALLDO(beginPack());}
244     inline void endPack(void) {ALLDO(endPack());}
245     inline void beginUnpack(void) {ALLDO(beginUnpack());}
246     inline void endUnpack(void) {ALLDO(endUnpack());}
247     inline void enqueue(envelope *e) {ALLDO(enqueue(e));}
248     inline void dequeue(envelope *e) {ALLDO(dequeue(e));}
249     inline void beginComputation(void) {ALLDO(beginComputation());}
250     inline void endComputation(void) {ALLDO(endComputation());}
251     inline int traceRegisterUserEvent(const char*x, int evt) {
252           int eno = 0;
253           for (int i=0; i<length(); i++) {
254             if (traces[i]->traceOnPE() == 0) {
255               continue;
256             }
257             int e = traces[i]->traceRegisterUserEvent(x, evt);
258             if (e) eno = e;
259           }
260           return eno;
261     }  
262     inline void traceClearEps() {ALLDO(traceClearEps());}
263     inline void traceEnableCCS() {ALLDO(traceEnableCCS());}
264     inline void traceWriteSts() {ALLDO(traceWriteSts());}
265     inline void traceClose() {ALLDO(traceClose()); clearTrace();}
266     inline void traceFlushLog() {ALLDO(traceFlushLog());}
267     
268     // Tracing module registers *itself* for begin/end idle callbacks:
269     inline void beginIdle(double curWallTime) {ALLDO(beginIdle(curWallTime));}
270     inline void endIdle(double curWallTime) {ALLDO(endIdle(curWallTime));}
271     void traceBegin();    
272     void traceEnd();
273
274 #if CMK_SMP_TRACE_COMMTHREAD
275     void traceBeginOnCommThread();
276     void traceEndOnCommThread();
277 #endif
278         
279     /*Calls for tracing function begins and ends*/
280     inline void regFunc(const char *name, int &idx, int idxSpecifiedByUser=0){ ALLDO(regFunc(name, idx, idxSpecifiedByUser)); }
281     inline void beginFunc(char *name,char *file,int line){ ALLDO(beginFunc(name,file,line)); };
282     inline void beginFunc(int idx,char *file,int line){ ALLDO(beginFunc(idx,file,line)); };
283     inline void endFunc(char *name){ ALLDO(endFunc(name)); }
284     inline void endFunc(int idx){ ALLDO(endFunc(idx)); }
285
286     /* Phase Demarkation */
287     inline void endPhase() { ALLDO(endPhase()); }
288
289     /* Memory tracing */
290     inline void malloc(void *where, int size, void **stack, int stackSize){ ALLDO(malloc(where,size,stack,stackSize)); }
291     inline void free(void *where, int size){ ALLDO(free(where, size)); }
292
293     /* calls for thread listener registration for each trace module */
294     inline void traceAddThreadListeners(CthThread tid, envelope *e) {
295       ALLDO(traceAddThreadListeners(tid, e));
296     }
297 };
298
299 CkpvExtern(TraceArray*, _traces);
300
301 #if CMK_TRACE_ENABLED
302 #if CMK_BLUEGENE_CHARM
303 extern void    resetVTime();
304 #  define _TRACE_ONLY(code) do{ BgGetTime(); if(CpvAccess(traceOn) && CkpvAccess(_traces)->length()>0) { code; }  resetVTime(); } while(0)
305 #else
306 #  define _TRACE_ONLY(code) do{if(CpvAccess(traceOn) && CkpvAccess(_traces)->length()>0) { code; }} while(0)
307 #endif
308 #  define _TRACE_ALWAYS(code) do{ code; } while(0)
309 #else
310 #  define _TRACE_ONLY(code) /*empty*/
311 #  define _TRACE_ALWAYS(code) /*empty*/
312 #endif
313
314 extern "C" {
315 #include "conv-trace.h"
316 }
317
318 #define _TRACE_USER_EVENT(x) _TRACE_ONLY(CkpvAccess(_traces)->userEvent(x))
319 #define _TRACE_USER_EVENT_BRACKET(x,bt,et) _TRACE_ONLY(CkpvAccess(_traces)->userBracketEvent(x,bt,et))
320 #define _TRACE_CREATION_1(env) _TRACE_ONLY(CkpvAccess(_traces)->creation(env,env->getEpIdx()))
321 #define _TRACE_CREATION_DETAILED(env,ep) _TRACE_ONLY(CkpvAccess(_traces)->creation(env,ep))
322 #define _TRACE_CREATION_N(env, num) _TRACE_ONLY(CkpvAccess(_traces)->creation(env, env->getEpIdx(), num))
323 #define _TRACE_CREATION_MULTICAST(env, num, pelist) _TRACE_ONLY(CkpvAccess(_traces)->creationMulticast(env, env->getEpIdx(), num, pelist))
324 #define _TRACE_CREATION_DONE(num) _TRACE_ONLY(CkpvAccess(_traces)->creationDone(num))
325 #define _TRACE_BEGIN_SDAG(env) _TRACE_ONLY(CkpvAccess(_traces)->beginSDAGBlock(env))
326 #define _TRACE_END_SDAG(env) _TRACE_ONLY(CkpvAccess(_traces)->endSDAGBlock(env))
327 #define _TRACE_BEGIN_EXECUTE(env) _TRACE_ONLY(CkpvAccess(_traces)->beginExecute(env))
328 #define _TRACE_BEGIN_EXECUTE_DETAILED(evt,typ,ep,src,mlen,idx) _TRACE_ONLY(CkpvAccess(_traces)->beginExecute(evt,typ,ep,src,mlen,idx))
329 #define _TRACE_END_EXECUTE() _TRACE_ONLY(CkpvAccess(_traces)->endExecute())
330 #define _TRACE_MESSAGE_RECV(env, pe) _TRACE_ONLY(CkpvAccess(_traces)->messageRecv(env, pe))
331 #define _TRACE_BEGIN_PACK() _TRACE_ONLY(CkpvAccess(_traces)->beginPack())
332 #define _TRACE_END_PACK() _TRACE_ONLY(CkpvAccess(_traces)->endPack())
333 #define _TRACE_BEGIN_UNPACK() _TRACE_ONLY(CkpvAccess(_traces)->beginUnpack())
334 #define _TRACE_END_UNPACK() _TRACE_ONLY(CkpvAccess(_traces)->endUnpack())
335 #define _TRACE_BEGIN_COMPUTATION() _TRACE_ALWAYS(CkpvAccess(_traces)->beginComputation())
336 #define _TRACE_END_COMPUTATION() _TRACE_ALWAYS(CkpvAccess(_traces)->endComputation())
337 #define _TRACE_ENQUEUE(env) _TRACE_ONLY(CkpvAccess(_traces)->enqueue(env))
338 #define _TRACE_DEQUEUE(env) _TRACE_ONLY(CkpvAccess(_traces)->dequeue(env))
339
340 #define _TRACE_END_PHASE() _TRACE_ONLY(CkpvAccess(_traces)->endPhase())
341
342 /* Memory tracing */
343 #define _TRACE_MALLOC(where, size, stack, stackSize) _TRACE_ONLY(CkpvAccess(_traces)->malloc(where,size,stack,stackSize))
344 #define _TRACE_FREE(where, size) _TRACE_ONLY(CkpvAccess(_traces)->free(where, size))
345
346
347 #include "trace-bluegene.h"
348
349 #endif
350
351
352 /*@}*/