Working version, connect to SGI calls
[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 // #define CMK_ORIGIN2000
14 #ifdef CMK_ORIGIN2000
15
16 #ifndef __trace_counter_h__
17 #define __trace_counter_h__
18
19 #include <stdio.h>
20 #include <errno.h>
21 #include "trace.h"
22 #include "ck.h"
23 #include "trace-common.h"
24
25 #define MAX_ENTRIES 500
26
27 //! track statistics for all entry points
28 class StatTable {
29   public:
30     StatTable(char** args, int argc);
31     ~StatTable();
32     //! one entry is called for 'time' seconds, value is counter reading 
33     void setEp(int epidx, int stat, UInt value, double time);
34     //! write three lines for each stat:
35     //!   1. number of calls for each entry
36     //!   2. average count for each entry
37     //!   3. total time in us spent for each entry
38     void write(FILE* fp);
39     void clear();
40
41   private:
42     //! struct to maintain statistics
43     struct Statistics {
44       char*  name;                  // name of stat being tracked
45       UInt   count[MAX_ENTRIES];    // total number times called
46       double average[MAX_ENTRIES];  // track average of value
47       double totTime[MAX_ENTRIES];  // total time associated with this counter
48
49       Statistics(): name(NULL) { }
50       ~Statistics() { if (name != NULL) { delete [] name; } }
51     };
52
53     Statistics* stats_;             // track stats for each entry point
54     int         numStats_;          // size of statistics being tracked
55 };
56
57 // counter log pool
58 class CountLogPool {
59   public:
60     CountLogPool(char* pgm, char** args, int argc);
61     ~CountLogPool();
62     void write(void) ;
63     void writeSts(void);
64     void setEp(int epidx, int count1, int count2, double time);
65     void clearEps() { stats_.clear(); }
66
67   private:
68     FILE*     fp_;
69     StatTable stats_;
70 };
71
72 //! For each processor, TraceCounter calculates mean, stdev, etc of 
73 //! CPU performance counters for each entry point.
74 class TraceCounter : public Trace {
75   public:
76     TraceCounter();
77     void userEvent(int e) { }
78     void creation(envelope *e, int num=1) { }
79     void beginExecute(envelope *e);
80     void beginExecute(int event, int msgType, int ep, int srcPe, int mlen=0);
81     void endExecute(void);
82     void beginIdle(void) { }
83     void endIdle(void) { }
84     void beginPack(void);
85     void endPack(void);
86     void beginUnpack(void);
87     void endUnpack(void);
88     void beginCharmInit(void) { }
89     void endCharmInit(void) { }
90     void enqueue(envelope *e) { }
91     void dequeue(envelope *e) { }
92     void beginComputation(void);
93     void endComputation(void) { }
94
95     void traceInit(char **argv);
96     int traceRegisterUserEvent(const char*) { return 0; }
97     void traceClearEps();
98     void traceWriteSts();
99     void traceClose();
100     void traceBegin() { }
101     void traceEnd() { }
102  
103     //! CounterArg is a linked list of strings that allows 
104     //! processing of command line args 
105     struct CounterArg {
106       int         code;
107       char*       arg;
108       char*       desc;
109       CounterArg* next;
110
111       CounterArg(int c, char* a, char* d): 
112         code(c), arg(a), desc(d), next(NULL) { }
113     };
114
115   private:
116     int         execEP_;       // id currently executing entry point
117     double      startEP_;      // start time of currently executing ep
118     double      startPack_;    // start time of pack operation
119     double      startUnpack_;  // start time of unpack operation
120     CounterArg* firstArg_;     // pointer to start of linked list of args
121     CounterArg* lastArg_;      // pointer to end of linked list of args
122     int         argStrSize_;   // size of maximum arg string (formatted output)
123
124     //! add the argument parameters to the linked list of args choices
125     void registerArg(CounterArg* arg);
126     //! see if the arg (str or code) matches any in the linked list of choices
127     //! and sets arg->code to the SGI code
128     //! return true if arg matches, false otherwise
129     bool matchArg(CounterArg* arg);
130     //! print out all arguments in the linked-list of choices
131     void printHelp();
132 };
133
134 #endif  // __trace_counter_h__
135
136 #endif // CMK_ORIGIN2000
137
138 /*@}*/