/*
 * 
 * $Log: PCmetric.h,v $
 * Revision 1.2  1994/02/24 04:36:49  markc
 * Added an upcall to dyninstRPC.I to allow paradynd's to report information at
 * startup.  Added a data member to the class that igen generates.
 * Make depend differences due to new header files that igen produces.
 * Added support to allow asynchronous starts of paradynd's.  The dataManager has
 * an advertised port that new paradynd's can connect to.
 * Changed header files to reflect changes in igen.
 *
 * Revision 1.1  1994/02/02  00:38:17  hollings
 * First version of the Performance Consultant using threads.
 *
 * Revision 1.8  1993/09/03  19:02:42  hollings
 * added findMetric, removed 4th arg to value.
 *
 * Revision 1.7  1993/08/30  18:36:29  hollings
 * added getCollectionCost to collectMode
 * added samplesSinceEnable to datum.
 *
 * Revision 1.6  1993/08/05  19:00:28  hollings
 * added getUnits and new includes.
 *
 * Revision 1.5  1993/05/07  20:19:17  hollings
 * Upgrade to use dyninst interface.
 *
 * Revision 1.4  1992/12/14  19:58:27  hollings
 * added true enable/disable.
 *
 * Revision 1.3  1992/10/23  20:13:37  hollings
 * Working version right after prelim.
 *
 * Revision 1.2  1992/08/24  15:12:20  hollings
 * first cut at automated refinement.
 *
 * Revision 1.1  1992/08/03  20:45:54  hollings
 * Initial revision
 *
 *
 */

#ifndef METRIC_H
#define METRIC_H

#include "util/h/hist.h"
#include "dataManager.CLNT.h"
#include "PCwhere.h"
#include "PCwhen.h"

extern dataManagerUser *dataMgr;

typedef enum { 
    getCollectionCost, 
    enableCollection, 
    disableCollection,
} collectMode;


// How do we compine multipe metrics of this type
enum aggregation { Sum, Min, Max, Avg };

// do we normalize by the windowWidth
enum calcType { CalcSum, CalcNormalize };

enum warningLevel { wNever, wOnce, wAlways };

extern warningLevel noDataWarning;
extern timeStamp currentTime;

class datum {
    public:
	void newSample(timeStamp start, timeStamp end, sampleValue value);

	datum();
	focus   	*f;
	resourceList	*resList;		// maps to inst level data.

	// data for previous enables.
	sampleValue   	sample;			// total of previous enables.
	timeStamp	totalUsed;		// total time enable previous.

	timeStamp	enableTime;		// this time enabled.
	timeStamp	lastUsed;		// this time enabled.
	int		samplesSinceEnable;	// this time enabled.

	timeStamp	time;
	Boolean		used;
	Boolean		enabled;
	int		refCount;
	metricInstance	*mi;			// when enabled.

	Histogram	*hist;
};

class performanceConsultant;
//
// The name of some performance data.
//
class PCmetric {
	friend void printMetric(char *, focus*, timeStamp, timeStamp);
	friend void PCmetricFunc(performanceStream *ps, metric *met);
	friend void printStats();
	friend void globalCost();
    public:
	// Constructor - default is Sum to aggregate.
	void print();

	char *getName() { return(name); }
	char *getUnits() { 
	    metricInfo *info;

	    info = dataMgr->getMetricInfo(met);
	    return(info->units); 
	}
	datum *findDatum(focus *f) { return(samples.find(f->getName())); }
	void addDatum(datum *d) { 
	    samples.add(d, (void *) d->f->getName()); 
	}

	Boolean changeCollection(collectMode);		// currentFocus
	Boolean changeCollection(focus*, collectMode);	// explicit focus.
	Boolean changeCollection(focusList, collectMode);// explicit focus.
	PCmetric(char *, aggregation, calcType);
	PCmetric(char *);

	// Get back values.
	sampleValue value();			// for current global state.
	sampleValue value(focus*);		// for a single focus object.
	sampleValue value(focusList);		// apply default aggregation.
	sampleValue value(timeStamp,timeStamp);	// for current global state.

	// is this enabled?
	Boolean enabled(focus*);		// for a single focus object.

	// for a single focus object.
	sampleValue value(focus*,timeStamp,timeStamp);

	// apply default aggregation.
	sampleValue value(focusList,timeStamp,timeStamp);	


	// explicit calls to aggregation.
	sampleValue avg(focusList, timeStamp, timeStamp);
	sampleValue min(focusList, timeStamp, timeStamp);
	sampleValue max(focusList, timeStamp, timeStamp);
	sampleValue sum(focusList, timeStamp, timeStamp);

	//
	sampleValue avg(focusList fl) { 
	     return avg(fl, currentInterval->start, currentTime); 
	}
	sampleValue min(focusList fl) { 
	    return avg(fl, currentInterval->start, currentTime); 
	}
	sampleValue max(focusList fl) { 
	    return avg(fl, currentInterval->start, currentTime); 
	}
	sampleValue sum(focusList fl) { 
	    return avg(fl, currentInterval->start, currentTime); 
	}
    private:
	char *name;
	metric	*met;		// handle to inst.
	List<datum*> samples;
	aggregation aggregationOperator;
	calcType calc;
};

extern PCmetric *findMetric(char *name);

//
// list of PCmetric.
//
typedef HTable<PCmetric*> PCmetricList;

typedef HTable<datum*> datumList;

extern datumList miToDatumMap;
extern void aggregateHist();

// list each PCmetric 

extern PCmetric CPUtime;
extern PCmetric SyncTime;
extern PCmetric SyncOps;
extern PCmetric lockHoldingTime;
extern PCmetric IOwait;
extern PCmetric IOops;
extern PCmetric IOBytes;
extern PCmetric seekWait;
extern PCmetric elapsedTime;
extern PCmetric activeProcesses;

// EDCU based PCmetrics.
extern PCmetric systemTime;
extern PCmetric runningProcesses;
extern PCmetric runableProcesses;
extern PCmetric systemCallRate;
extern PCmetric contextSwitchRate;
extern PCmetric interuptRate;
extern PCmetric trapRate;
extern PCmetric procedureCalls;
extern PCmetric packetsIn;
extern PCmetric packetsOut;
extern PCmetric pageFaults;
extern PCmetric pageReclaims;
extern PCmetric dirtyPageReclaims;
extern PCmetric zeroPageCreates;
extern PCmetric codePageIns;
extern PCmetric dataPageIns;
extern PCmetric pageOuts;
extern PCmetric swapIn;
extern PCmetric swapOut;
extern PCmetric vmDeficit;
extern PCmetric vmFree;
extern PCmetric vmDirty;
extern PCmetric activeVM;

// 
extern PCmetricList allMetrics;

#endif