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