Move ind\7fclude to .C and update to let DEBUG work
[charm.git] / src / ck-perf / trace-counter.h
1 /*****************************************************************************
2  * $Source$
3  * $Author$
4  * $Date$
5  * $Revision$
6  *****************************************************************************/
7
8 /**
9  * \addtogroup CkPerf
10 */
11 /*@{*/
12
13 #ifndef __trace_counter_h__
14 #define __trace_counter_h__
15
16 #include <stdio.h>
17 #include <errno.h>
18 #include "trace.h"
19 #include "trace-common.h"
20 #include "conv-mach.h"
21
22 #define MAX_ENTRIES 500
23
24 //! track statistics for all entry points
25 class StatTable {
26   public:
27     StatTable();
28     ~StatTable();
29     void init(char** name, char** desc, int argc);
30     //! one entry is called for 'time' seconds, value is counter reading 
31     void setEp(int epidx, int stat, long long value, double time);
32     //! write three lines for each stat:
33     //!   1. number of calls for each entry
34     //!   2. average count for each entry
35     //!   3. total time in us spent for each entry
36     void write(FILE* fp);
37     void clear();
38     int numStats() { return numStats_; }
39
40   private:
41     //! struct to maintain statistics
42     struct Statistics {
43       char*  name;                    // name of stat being tracked
44       char*  desc;                    // description of stat being tracked
45       unsigned int numCalled[MAX_ENTRIES];  // total number times called
46       double avgCount[MAX_ENTRIES];   // track average of value
47       double totTime[MAX_ENTRIES];    // total time associated with counter
48
49       Statistics(): name(NULL) { }
50     };
51
52     Statistics* stats_;             // track stats for each entry point
53     int         numStats_;          // size of statistics being tracked
54 };
55
56 //! counter log pool this implements functions for TraceCounter but
57 //! that needed to be performed on a node-level
58 class CountLogPool {
59   public:
60     CountLogPool();
61     ~CountLogPool();
62     void write(int phase=-1) ;
63     void writeSts(int phase=-1);
64     FILE* openFile(int phase=-1);
65     void setEp(int epidx, long long count1, long long count2, double time);
66     void clearEps() { stats_.clear(); }
67     void init(char** name, char** desc, int argc) { 
68       stats_.init(name, desc, argc);
69     }
70
71   private:
72     StatTable stats_;       // store stats per counter
73     int       lastPhase_;   // keep track of last phase for closing behavior
74 };
75
76 //! For each processor, TraceCounter calculates mean, stdev, etc of 
77 //! CPU performance counters for each entry point.
78 class TraceCounter : public Trace {
79   public:
80     TraceCounter();
81     ~TraceCounter();
82     //! process command line arguments!
83     void traceInit(char **argv);
84     //! turn trace on/off, note that charm will automatically call traceBegin()
85     //! at the beginning of every run unless the command line option "+traceoff"
86     //! is specified
87     void traceBegin();
88     void traceEnd();
89     //! registers user event trace module returns int identifier 
90     int traceRegisterUserEvent(const char* userEvent) { 
91       // CmiPrintf("%d/%d traceRegisterUserEvent(%s)\n", 
92       // CkMyPe(), CkNumPes(), userEvent);
93       return 0;
94     }
95     //! a user event has just occured
96     void userEvent(int e) { 
97       // CmiPrintf("%d/%d userEvent %d\n", CkMyPe(), CkNumPes(), e); 
98     }
99     //! creation of message(s)
100     void creation(envelope *e, int num=1) { }
101     //! ???
102     void messageRecv(char *env, int pe) { }
103     //! begin/end execution of a Charm++ entry point
104     //! NOTE: begin/endPack and begin/endUnpack can be called in between
105     //!       a beginExecute and its corresponding endExecute.
106     void beginExecute(envelope *e);
107     void beginExecute(
108       int event,   //! event type defined in trace-common.h
109       int msgType, //! message type
110       int ep,      //! Charm++ entry point (will correspond to sts file) 
111       int srcPe,   //! Which PE originated the call
112       int ml=0);   //! message size
113     void endExecute(void);
114     //! begin/end idle time for this pe
115     void beginIdle(void) { if (traceOn_) { startIdle_ = TraceTimer(); } }
116     void endIdle(void) { 
117       if (traceOn_) { idleTime_ += TraceTimer()-startIdle_; }
118     }
119     //! begin/end the process of packing a message (to send)
120     void beginPack(void);
121     void endPack(void);
122     //! begin/end the process of unpacking a message (can occur before calling
123     //! a entry point or during an entry point when 
124     void beginUnpack(void);
125     void endUnpack(void);
126     //! ???
127     void enqueue(envelope *e) { }
128     void dequeue(envelope *e) { }
129     //! begin/end of execution
130     void beginComputation(void);
131     void endComputation(void) { }
132     //! clear all data collected for entry points
133     void traceClearEps();
134     //! write the summary sts file for this trace
135     void traceWriteSts();
136     //! do any clean-up necessary for tracing
137     void traceClose();
138
139     //! CounterArg is a linked list of strings that allows
140     //! processing of command line args
141     struct CounterArg {
142       int         code;
143       char*       arg;
144       char*       desc;
145       CounterArg* next;
146
147       CounterArg(): code(-1), arg(NULL), desc(NULL), next(NULL) { }
148       CounterArg(int c, char* a, char* d):
149         code(c), arg(a), desc(d), next(NULL) { }
150       void setValues(int _code, char* _arg, char* _desc) {
151         code = _code;  arg = _arg;  desc = _desc;
152       }
153     };
154
155   private:
156     enum TC_Status { IDLE, WORKING };
157     
158     // command line processing
159     CounterArg* firstArg_;      // pointer to start of linked list of args
160     CounterArg* lastArg_;       // pointer to end of linked list of args
161     int         argStrSize_;    // size of max arg string (formatted output)
162     CounterArg* commandLine_;   // list of command line args
163     int         commandLineSz_; // size of commande line args array
164     CounterArg* counter1_;      // point to current counter, circle linked list
165     CounterArg* counter2_;      // point to current counter, circle linked list
166     int         counter1Sz_;    // size of cycle
167     int         counter2Sz_;    // size of cycle
168     
169     // result of different command line opts
170     bool        overview_;      // if true, just measure between phases
171     bool        switchRandom_;  // if true, switch counters randomly
172     bool        switchByPhase_; // if true, switch counters only at phases
173
174     // store between start/stop of counter read
175     int         execEP_;        // id currently executing entry point
176     double      startEP_;       // start time of currently executing ep
177     double      startIdle_;     // start time of currently executing idle
178     int         genStart_;      // track value of start_counters
179
180     // store state
181     double      idleTime_;      // total idle time
182     int         phase_;         // current phase
183     bool        traceOn_;       // true if trace is turned on
184     TC_Status   status_;        // to prevent errors
185     bool        dirty_;         // true if endExecute called 
186
187     //! start/stop the overall counting ov eps (don't write to logCount, 
188     //! just print to screen
189     void beginOverview();
190     void endOverview();
191     //! switch counters by whatever switching strategy 
192     void switchCounters();
193     //! add the argument parameters to the linked list of args choices
194     void registerArg(CounterArg* arg);
195     //! see if the arg (str or code) matches any in the linked list of choices
196     //! and sets arg->code to the SGI code
197     //! return true if arg matches, false otherwise
198     bool matchArg(CounterArg* arg);
199     //! print out usage argument
200     void usage();
201     //! print out all arguments in the linked-list of choices
202     void printHelp();
203 };
204
205 #endif  // __trace_counter_h__
206
207 /*@}*/
208
209