fixed compilation error: numStats_ is private and is not accessible.
[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 "ck.h"
20 #include "trace-common.h"
21 #include "conv-mach.h"
22 #ifdef CMK_ORIGIN2000
23 #include <sys/hwperftypes.h>
24 #endif
25
26 #define MAX_ENTRIES 500
27
28 //! track statistics for all entry points
29 class StatTable {
30   public:
31     StatTable(char** args, int argc);
32     ~StatTable();
33     //! one entry is called for 'time' seconds, value is counter reading 
34     void setEp(int epidx, int stat, long long value, double time);
35     //! write three lines for each stat:
36     //!   1. number of calls for each entry
37     //!   2. average count for each entry
38     //!   3. total time in us spent for each entry
39     void write(FILE* fp);
40     void clear();
41     inline int numStats() { return numStats_; }
42
43   private:
44     //! struct to maintain statistics
45     struct Statistics {
46       char*  name;                  // name of stat being tracked
47       UInt   count[MAX_ENTRIES];    // total number times called
48       double average[MAX_ENTRIES];  // track average of value
49       double totTime[MAX_ENTRIES];  // total time associated with this counter
50
51       Statistics(): name(NULL) { }
52     };
53
54     Statistics* stats_;             // track stats for each entry point
55     int         numStats_;          // size of statistics being tracked
56     // bool        error_;             // will be set to true if error writing info
57 };
58
59 // counter log pool
60 class CountLogPool {
61   public:
62     CountLogPool(char* pgm, char** args, int argc);
63     ~CountLogPool();
64     void write(void) ;
65     void writeSts(void);
66     void setEp(int epidx, long long count1, long long count2, double time);
67     void clearEps() { stats_.clear(); }
68
69   private:
70     FILE*     fp_;
71     StatTable stats_;
72 };
73
74 //! For each processor, TraceCounter calculates mean, stdev, etc of 
75 //! CPU performance counters for each entry point.
76 class TraceCounter : public Trace {
77   public:
78     TraceCounter();
79     ~TraceCounter();
80     void userEvent(int e) { }
81     void creation(envelope *e, int num=1) { }
82     void beginExecute(envelope *e);
83     void beginExecute(int event, int msgType, int ep, int srcPe, int mlen=0);
84     void endExecute(void);
85     void beginIdle(void) { }
86     void endIdle(void) { }
87     void beginPack(void);
88     void endPack(void);
89     void beginUnpack(void);
90     void endUnpack(void);
91     void beginCharmInit(void) { }
92     void endCharmInit(void) { }
93     void enqueue(envelope *e) { }
94     void dequeue(envelope *e) { }
95     void beginComputation(void);
96     void endComputation(void) { }
97
98     void traceInit(char **argv);
99     int traceRegisterUserEvent(const char*) { return 0; }
100     void traceClearEps();
101     void traceWriteSts();
102     void traceClose();
103     void traceBegin() { }
104     void traceEnd() { }
105
106     //! CounterArg is a linked list of strings that allows
107     //! processing of command line args
108     struct CounterArg {
109       int         code;
110       char*       arg;
111       char*       desc;
112       CounterArg* next;
113
114       CounterArg(): code(-1), arg(NULL), desc(NULL), next(NULL) { }
115       CounterArg(int c, char* a, char* d):
116         code(c), arg(a), desc(d), next(NULL) { }
117       void setValues(int _code, char* _arg, char* _desc) {
118         code = _code;  arg = _arg;  desc = _desc;
119       }
120     };
121
122   private:
123     int         execEP_;       // id currently executing entry point
124     double      startEP_;      // start time of currently executing ep
125     double      startPack_;    // start time of pack operation
126     double      startUnpack_;  // start time of unpack operation
127     CounterArg* firstArg_;     // pointer to start of linked list of args
128     CounterArg* lastArg_;      // pointer to end of linked list of args
129     int         argStrSize_;   // size of maximum arg string (formatted output)
130
131     int         counter1_;     // 1st counter to track
132     int         counter2_;     // 2nd counter to track
133
134     #ifdef CMK_ORIGIN2000
135     enum Status { IDLE, WORKING };
136     Status      status_;       // to prevent errors
137     int         genStart_;     // track value of start_counters
138     int         fileDesc_;     // file descriptor for accessing hw counters
139     hwperf_profevctrarg_t evctrArgs_;  // tells what type of counter to profile
140     hwperf_cntr_t         cnts_;       // reads the counters values
141     // starts hw profiling for these counters
142     // returns -1 if error, generation number if no error
143     int startCounter(int counter1, int counter2);
144     // gets hw profile values for these counters
145     // returns -1 if error, generation number if no error
146     int readCounters
147     (
148       int        counter1,
149       long long* value1,
150       int        counter2,
151       long long* value2
152     );
153     #endif // CMK_ORIGIN2000
154
155     //! add the argument parameters to the linked list of args choices
156     void registerArg(CounterArg* arg);
157     //! see if the arg (str or code) matches any in the linked list of choices
158     //! and sets arg->code to the SGI code
159     //! return true if arg matches, false otherwise
160     bool matchArg(CounterArg* arg);
161     //! print out all arguments in the linked-list of choices
162     void printHelp();
163 };
164
165 #endif  // __trace_counter_h__
166
167 /*@}*/
168
169