summaryrefslogtreecommitdiff
path: root/indra/newview/llmetricperformancetester.h
blob: ab5ccaeb8e7906a41d59a3f3dcbbd8bc7928902d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/** 
 * @file LLMetricPerformanceTester.h 
 * @brief LLMetricPerformanceTester class definition
 *
 * $LicenseInfo:firstyear=2004&license=viewergpl$
 * 
 * Copyright (c) 2004-2009, Linden Research, Inc.
 * 
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
 * 
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at
 * http://secondlifegrid.net/programs/open_source/licensing/flossexception
 * 
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 * 
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 * $/LicenseInfo$
 */

#ifndef LL_METRICPERFORMANCETESTER_H 
#define LL_METRICPERFORMANCETESTER_H 

class LLMetricPerformanceTester 
{
public:
	//
    //name passed to the constructor is a unique string for each tester.
    //an error is reported if the name is already used by some other tester.
    //
	LLMetricPerformanceTester(std::string name, BOOL use_default_performance_analysis) ;
	virtual ~LLMetricPerformanceTester();

	//
    //return the name of the tester
    //
	std::string getName() const { return mName ;}
	//
    //return the number of the test metrics in this tester
    //
	S32 getNumOfMetricStrings() const { return mMetricStrings.size() ;}
	//
    //return the metric string at the index
    //
	const std::string& getMetricString(U32 index) const ;

	//
    //this function to compare the test results.
    //by default, it compares the test results against the baseline one by one, item by item, 
    //in the increasing order of the LLSD label counter, starting from the first one.
	//you can define your own way to analyze performance by passing FALSE to "use_default_performance_analysis",
    //and implement two abstract virtual functions below: loadTestSession(...) and compareTestSessions(...).
    //
	void analyzePerformance(std::ofstream* os, LLSD* base, LLSD* current) ;

protected:
	//
    //insert metric strings used in the tester.
    //
	void addMetricString(std::string str) ;

	//
    //increase LLSD label by 1
    //
	void incLabel() ;
	
	//
    //the function to write a set of test results to the log LLSD.
    //
	void outputTestResults() ;

	//
    //compare the test results.
    //you can write your own to overwrite the default one.
    //
	virtual void compareTestResults(std::ofstream* os, std::string metric_string, S32 v_base, S32 v_current) ;
	virtual void compareTestResults(std::ofstream* os, std::string metric_string, F32 v_base, F32 v_current) ;

	//
	//for performance analysis use 
	//it defines an interface for the two abstract virtual functions loadTestSession(...) and compareTestSessions(...).
    //please make your own test session class derived from it.
	//
	class LLTestSession
	{
	public:
		virtual ~LLTestSession() ;
	};

	//
    //load a test session for log LLSD
    //you need to implement it only when you define your own way to analyze performance.
    //otherwise leave it empty.
    //
	virtual LLMetricPerformanceTester::LLTestSession* loadTestSession(LLSD* log) = 0 ;
	//
    //compare the base session and the target session
    //you need to implement it only when you define your own way to analyze performance.
    //otherwise leave it empty.
    //
	virtual void compareTestSessions(std::ofstream* os) = 0 ;
	//
    //the function to write a set of test results to the log LLSD.
    //you have to write you own version of this function.	
	//
	virtual void outputTestRecord(LLSD* sd) = 0 ;

private:
	void preOutputTestResults(LLSD* sd) ;
	void postOutputTestResults(LLSD* sd) ;
	void prePerformanceAnalysis() ;

protected:
	//
    //the unique name string of the tester
    //
	std::string mName ;
	//
    //the current label counter for the log LLSD
    //
	std::string mCurLabel ;
	S32 mCount ;
	
	BOOL mUseDefaultPerformanceAnalysis ;
	LLTestSession* mBaseSessionp ;
	LLTestSession* mCurrentSessionp ;

	//metrics strings
	std::vector< std::string > mMetricStrings ;

//static members
private:
	static void addTester(LLMetricPerformanceTester* tester) ;

public:	
	typedef std::map< std::string, LLMetricPerformanceTester* > name_tester_map_t;	
	static name_tester_map_t sTesterMap ;

	static LLMetricPerformanceTester* getTester(std::string label) ;
	static BOOL hasMetricPerformanceTesters() {return !sTesterMap.empty() ;}

	static void initClass() ;
	static void cleanClass() ;
};

#endif