removed cvs log lines;
[dyninst.git] / paradynd / src / internalMetrics.h
1 /*
2  * Copyright (c) 1996 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 #ifndef INTERNAL_MET_HDR
43 #define INTERNAL_MET_HDR
44
45 // $Id: internalMetrics.h,v 1.19 2001/08/23 14:44:13 schendel Exp $
46
47 #include "metric.h"
48 #include "im_preds.h"
49 #include "dyninstRPC.xdr.h" // T_dyninstRPC
50
51 typedef pdSample (*sampleValueFunc)(const metricDefinitionNode *);
52
53 typedef enum {UnNormalized, Normalized, Sampled} daemon_MetUnitsType;
54
55 //
56 // Metrics that are internal to a paradyn daemon.
57 //
58
59 class internalMetric {
60  public:
61   // the costMetrics and the normal metrics don't need this choice in
62   // policy since they have it hardcoded right now to use zero as the
63   // initial actual value
64   enum initActualValuePolicy_t { zero_ForInitActualValue, 
65                                  firstSample_ForInitActualValue };
66  private:
67   string name_;
68   aggregateOp agg_;
69   string units_;
70   im_pred_struct pred;
71   bool developermode_;
72   daemon_MetUnitsType unitstype_;
73   metricStyle style_;
74   sampleValueFunc func; // a func taking in no params and returning float
75   initActualValuePolicy_t initActualValuePolicy;
76
77  public:
78   class eachInstance {
79    private:
80      // If func!=NULL, then it is used to indirectly obtain the value of
81      // the internal metric (getValue()).  Otherwise, the vrble "value" is used.
82      internalMetric *parent;
83      sampleValueFunc func; // a func taking in no params and returning float
84      timeStamp lastSampleTime;
85      pdSample cumulativeValue;
86      metricDefinitionNode *node;
87
88    public:
89      eachInstance() {} // needed by Vector class.
90      eachInstance(internalMetric *_parent,
91                   sampleValueFunc f, metricDefinitionNode *n);
92     ~eachInstance() {}
93      
94      bool matchMetricDefinitionNode(const metricDefinitionNode *match_me) const
95      {
96         return (node == match_me);
97      }
98
99      pdSample calcValue() const {
100        assert(func);
101        return func(node);
102      }
103      initActualValuePolicy_t getInitActualValuePolicy() {
104        return parent->getInitActualValuePolicy();
105      }
106      int getMId() const {
107         assert(node);
108         return node->getMId();
109      }
110      void setStartTime(timeStamp t) {
111        lastSampleTime = t;
112      }
113      void updateValue(timeStamp timeOfSample, pdSample valueToForward);
114   };
115
116  private:
117   // enabled instances of this internal metric are here:
118   vector<eachInstance> instances;
119
120  public:
121   internalMetric(const string &n, aggregateOp a, const string &units,
122                  sampleValueFunc f, im_pred_struct& im_preds,
123                  bool developermode, daemon_MetUnitsType unitstype,
124                  initActualValuePolicy_t initActualValuePolicy);
125
126   static bool isInternalMetric(const string &metName) {
127      for (unsigned lcv=0; lcv < allInternalMetrics.size(); lcv++)
128         if (allInternalMetrics[lcv]->name_ == metName)
129            return true;
130      return false;
131   }
132
133   unsigned num_enabled_instances() const {
134      return instances.size();
135   }
136   eachInstance &getEnabledInstance(unsigned index) {
137      return instances[index];
138   }
139   const eachInstance &getEnabledInstance(unsigned index) const {
140      return instances[index];
141   }
142   void setStyle(metricStyle st) {
143     style_ = st;
144   }
145   initActualValuePolicy_t getInitActualValuePolicy() {
146     return initActualValuePolicy;
147   }
148   // returns the index of the newly enabled instance
149   unsigned enableNewInstance(metricDefinitionNode *n) {
150      eachInstance newGuy(this, func, n);
151      instances += newGuy;
152      return instances.size()-1;
153   }
154   void disableInstance(unsigned index);
155   bool disableByMetricDefinitionNode(metricDefinitionNode *diss_me);
156   
157   int getMId(unsigned index) const {
158      // returns the mid from the metricDefinitionNode.  Used in metric.C
159      return instances[index].getMId();
160   }
161
162   metricStyle style() const;
163   const string &name() const;
164   aggregateOp aggregate() const;
165   bool isDeveloperMode() const;
166
167   T_dyninstRPC::metricInfo getInfo();
168
169   bool legalToInst(const vector< vector<string> >& focus) const;
170
171   static vector<internalMetric*> allInternalMetrics; // should be private!
172   static internalMetric *newInternalMetric(const string &n, aggregateOp a,
173              const string &units, sampleValueFunc f, im_pred_struct& preds,
174              bool developerMode, daemon_MetUnitsType unitstype,
175              initActualValuePolicy_t iavPolicy);
176 };
177
178 #endif