add API to pass application annotation time to tracing framework
[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     //interact with application 
81     virtual void appWork(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     // the current memory usage as a double
92     virtual void memoryUsage(double currentMemUsage) {}
93
94     // creation of message(s)
95     virtual void creation(envelope *, int epIdx, int num=1) {}
96     //epIdx is extracted from the envelope, num is always 1
97     virtual void creation(char *) {}
98     virtual void creationMulticast(envelope *, int epIdx, int num=1,
99                                      int *pelist=NULL) {}
100     virtual void creationDone(int num=1) {}
101     // ???
102     virtual void messageRecv(char *env, int pe) {}
103     virtual void beginSDAGBlock(
104       int event,   // event type defined in trace-common.h
105       int msgType, // message type
106       int ep,      // Charm++ entry point (will correspond to sts file) 
107       int srcPe,   // Which PE originated the call
108       int ml,      // message size
109       CmiObjId* idx)    // index
110     { }
111     virtual void endSDAGBlock(void) {}
112     // **************************************************************
113     // begin/end execution of a Charm++ entry point
114     // NOTE: begin/endPack and begin/endUnpack can be called in between
115     //       a beginExecute and its corresponding endExecute.
116     virtual void beginExecute(envelope *) {}
117     virtual void beginExecute(char *) {}
118     virtual void beginExecute(CmiObjId *tid) {}
119     virtual void beginExecute(
120       int event,   // event type defined in trace-common.h
121       int msgType, // message type
122       int ep,      // Charm++ entry point (will correspond to sts file) 
123       int srcPe,   // Which PE originated the call
124       int ml,      // message size
125       CmiObjId* idx)    // index
126     { }
127     virtual void changeLastEntryTimestamp(double ts) {}
128     virtual void endExecute(void) {}
129     virtual void endExecute(char *) {}
130     // begin/end idle time for this pe
131     virtual void beginIdle(double curWallTime) {}
132     virtual void endIdle(double curWallTime) {}
133     // begin/end the process of packing a message (to send)
134     virtual void beginPack(void) {}
135     virtual void endPack(void) {}
136     // begin/end the process of unpacking a message (can occur before calling
137     // a entry point or during an entry point when 
138     virtual void beginUnpack(void) {}
139     virtual void endUnpack(void) {}
140     // ???
141     virtual void enqueue(envelope *) {}
142     virtual void dequeue(envelope *) {}
143     // begin/end of execution
144     virtual void beginComputation(void) {}
145     virtual void endComputation(void) {}
146     // demarkation of a phase boundary
147     virtual void endPhase() {}
148     // clear all data collected for entry points
149     virtual void traceClearEps() {}
150     // enable CCS operations if supported on the trace module
151     virtual void traceEnableCCS() {}
152     // write the summary sts file for this trace
153     virtual void traceWriteSts() {}
154     // do any clean-up necessary for tracing
155     virtual void traceClose() {}
156     // flush log buffer immediately
157     virtual void traceFlushLog() {}
158
159     //for tracing function calls
160     virtual void regFunc(const char *name, int &idx, int idxSpecifiedByUser=0){}
161     virtual void beginFunc(char *name,char *file,int line){}
162     virtual void beginFunc(int idx,char *file,int line){}
163     virtual void endFunc(char *name){}    
164     virtual void endFunc(int idx){}
165
166     /* Memory tracing */
167     virtual void malloc(void *where, int size, void **stack, int stackSize){}
168     virtual void free(void *where, int size){}
169
170     /* for implementing thread listeners */
171     virtual void traceAddThreadListeners(CthThread tid, envelope *e) {}
172
173     virtual ~Trace() {} /* for whining compilers */
174 };
175
176 #define ALLDO(x) for (int i=0; i<length(); i++) if (traces[i]->traceOnPE()) traces[i]->x
177 #define ALLREVERSEDO(x) for (int i=length()-1; i>=0; i--) if (traces[i]->traceOnPE()) traces[i]->x
178
179 /// Array of Traces modules,  every event raised will go through every Trace module.
180 class TraceArray {
181 private:
182   CkVec<Trace *>  traces;
183   int n;
184   int cancel_beginIdle, cancel_endIdle;
185 public:
186     TraceArray(): n(0) {}
187     inline void addTrace(Trace *tr) { traces.push_back(tr); n++;}
188     inline void setTraceOnPE(int flag) { for (int i=0; i<length(); i++) traces[i]->setTraceOnPE(flag); }
189     // to allow traceCLose() to be called multiple times, remove trace module
190     // from the array in each individual trace, and clean up (clearTrace)
191     // after the loop.
192     inline void removeTrace(Trace *tr) {    // remove a Trace from TraceArray
193         int i;
194         for (i=0; i<n; i++) if (tr == traces[i]) break;
195         CmiAssert(i<n);
196         traces[i] = NULL;
197     }
198     inline void clearTrace() {    // remove holes in TraceArray
199         int len = traces.length();
200         int removed = 0;
201         for (int i=0; i<len; i++) {
202           if (traces[i-removed] == NULL) { traces.remove(i-removed); removed++; }
203         }
204         n -= removed;
205     }
206     inline int length() const { return n; }
207
208     inline void userEvent(int e) { ALLDO(userEvent(e));}
209     inline void userBracketEvent(int e,double bt, double et) {ALLDO(userBracketEvent(e,bt,et));}
210     inline void appWork(int e,double bt, double et) {ALLDO(appWork(e,bt,et));}
211     
212         inline void userSuppliedData(int d) { ALLDO(userSuppliedData(d));}
213
214         inline void userSuppliedNote(char *note) { ALLDO(userSuppliedNote(note));}
215         inline void userSuppliedBracketedNote(char *note, int eventID, double bt, double et) {ALLDO(userSuppliedBracketedNote(note, eventID, bt, et));}
216
217
218         inline void memoryUsage(double memUsage) { ALLDO(memoryUsage(memUsage));}
219
220
221     /* Creation needs to access _entryTable, so moved into trace-common.C */
222     void creation(envelope *env, int ep, int num=1);
223     inline void creation(char *msg){
224         /* The check for whether the ep got traced is moved into each elem's
225          * creation call as the ep could not be extracted here
226          */
227         ALLDO(creation(msg));
228     }
229     void creationMulticast(envelope *env, int ep, int num=1, int *pelist=NULL);
230     
231     inline void creationDone(int num=1) { ALLDO(creationDone(num)); }
232     inline void beginSDAGBlock(int event,int msgType,int ep,int srcPe, int mlen,CmiObjId *idx=NULL) {ALLDO(beginSDAGBlock(event, msgType, ep, srcPe, mlen,idx));}
233     inline void endSDAGBlock(void) {ALLREVERSEDO(endExecute());}
234     inline void beginExecute(envelope *env) {ALLDO(beginExecute(env));}
235     inline void beginExecute(char *msg) {ALLDO(beginExecute(msg));}
236     inline void beginExecute(CmiObjId *tid) {ALLDO(beginExecute(tid));}
237     inline void beginExecute(int event,int msgType,int ep,int srcPe, int mlen,CmiObjId *idx=NULL) {ALLDO(beginExecute(event, msgType, ep, srcPe, mlen,idx));}
238     inline void endExecute(void) {ALLREVERSEDO(endExecute());}
239     inline void endExecute(char *msg) {ALLREVERSEDO(endExecute(msg));}
240     inline void changeLastEntryTimestamp(double ts) {ALLDO(changeLastEntryTimestamp(ts));}
241     inline void messageRecv(char *env, int pe) {ALLDO(messageRecv(env, pe));}
242     inline void beginPack(void) {ALLDO(beginPack());}
243     inline void endPack(void) {ALLDO(endPack());}
244     inline void beginUnpack(void) {ALLDO(beginUnpack());}
245     inline void endUnpack(void) {ALLDO(endUnpack());}
246     inline void enqueue(envelope *e) {ALLDO(enqueue(e));}
247     inline void dequeue(envelope *e) {ALLDO(dequeue(e));}
248     inline void beginComputation(void) {ALLDO(beginComputation());}
249     inline void endComputation(void) {ALLDO(endComputation());}
250     inline int traceRegisterUserEvent(const char*x, int evt) {
251           int eno = 0;
252           for (int i=0; i<length(); i++) {
253             if (traces[i]->traceOnPE() == 0) {
254               continue;
255             }
256             int e = traces[i]->traceRegisterUserEvent(x, evt);
257             if (e) eno = e;
258           }
259           return eno;
260     }  
261     inline void traceClearEps() {ALLDO(traceClearEps());}
262     inline void traceEnableCCS() {ALLDO(traceEnableCCS());}
263     inline void traceWriteSts() {ALLDO(traceWriteSts());}
264     inline void traceClose() {ALLDO(traceClose()); clearTrace();}
265     inline void traceFlushLog() {ALLDO(traceFlushLog());}
266     
267     // Tracing module registers *itself* for begin/end idle callbacks:
268     inline void beginIdle(double curWallTime) {ALLDO(beginIdle(curWallTime));}
269     inline void endIdle(double curWallTime) {ALLDO(endIdle(curWallTime));}
270     void traceBegin();    
271     void traceEnd();
272
273     // for tracing comm thread only
274     void traceBeginOnCommThread();
275     void traceEndOnCommThread();
276     void traceCommSetMsgID(char *msg)  { ALLDO(traceCommSetMsgID(msg)); }
277     void traceGetMsgID(char *msg, int *pe, int *event) { ALLDO(traceGetMsgID(msg, pe, event)); }
278     void traceSetMsgID(char *msg, int pe, int event) { ALLDO(traceSetMsgID(msg, pe, event)); }
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_BIGSIM_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_APPWORK(x,bt,et) _TRACE_ONLY(CkpvAccess(_traces)->appWork(x,bt,et))
321 #define _TRACE_CREATION_1(env) _TRACE_ONLY(CkpvAccess(_traces)->creation(env,env->getEpIdx()))
322 #define _TRACE_CREATION_DETAILED(env,ep) _TRACE_ONLY(CkpvAccess(_traces)->creation(env,ep))
323 #define _TRACE_CREATION_N(env, num) _TRACE_ONLY(CkpvAccess(_traces)->creation(env, env->getEpIdx(), num))
324 #define _TRACE_CREATION_MULTICAST(env, num, pelist) _TRACE_ONLY(CkpvAccess(_traces)->creationMulticast(env, env->getEpIdx(), num, pelist))
325 #define _TRACE_CREATION_DONE(num) _TRACE_ONLY(CkpvAccess(_traces)->creationDone(num))
326 #define _TRACE_BEGIN_SDAG(env) _TRACE_ONLY(CkpvAccess(_traces)->beginSDAGBlock(env))
327 #define _TRACE_END_SDAG(env) _TRACE_ONLY(CkpvAccess(_traces)->endSDAGBlock(env))
328 #define _TRACE_BEGIN_EXECUTE(env) _TRACE_ONLY(CkpvAccess(_traces)->beginExecute(env))
329 #define _TRACE_BEGIN_EXECUTE_DETAILED(evt,typ,ep,src,mlen,idx) _TRACE_ONLY(CkpvAccess(_traces)->beginExecute(evt,typ,ep,src,mlen,idx))
330 #define _TRACE_END_EXECUTE() _TRACE_ONLY(CkpvAccess(_traces)->endExecute())
331 #define _TRACE_MESSAGE_RECV(env, pe) _TRACE_ONLY(CkpvAccess(_traces)->messageRecv(env, pe))
332 #define _TRACE_BEGIN_PACK() _TRACE_ONLY(CkpvAccess(_traces)->beginPack())
333 #define _TRACE_END_PACK() _TRACE_ONLY(CkpvAccess(_traces)->endPack())
334 #define _TRACE_BEGIN_UNPACK() _TRACE_ONLY(CkpvAccess(_traces)->beginUnpack())
335 #define _TRACE_END_UNPACK() _TRACE_ONLY(CkpvAccess(_traces)->endUnpack())
336 #define _TRACE_BEGIN_COMPUTATION() _TRACE_ALWAYS(CkpvAccess(_traces)->beginComputation())
337 #define _TRACE_END_COMPUTATION() _TRACE_ALWAYS(CkpvAccess(_traces)->endComputation())
338 #define _TRACE_ENQUEUE(env) _TRACE_ONLY(CkpvAccess(_traces)->enqueue(env))
339 #define _TRACE_DEQUEUE(env) _TRACE_ONLY(CkpvAccess(_traces)->dequeue(env))
340
341 #define _TRACE_END_PHASE() _TRACE_ONLY(CkpvAccess(_traces)->endPhase())
342
343 /* Memory tracing */
344 #define _TRACE_MALLOC(where, size, stack, stackSize) _TRACE_ONLY(CkpvAccess(_traces)->malloc(where,size,stack,stackSize))
345 #define _TRACE_FREE(where, size) _TRACE_ONLY(CkpvAccess(_traces)->free(where, size))
346
347 #include "trace-bluegene.h"
348
349 #endif
350
351
352 /*@}*/