llmetricperformancetester.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:5k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file LLMetricPerformanceTester.h 
  3.  * @brief LLMetricPerformanceTester class definition
  4.  *
  5.  * $LicenseInfo:firstyear=2004&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2004-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LL_METRICPERFORMANCETESTER_H 
  33. #define LL_METRICPERFORMANCETESTER_H 
  34. class LLMetricPerformanceTester 
  35. {
  36. public:
  37. //
  38.     //name passed to the constructor is a unique string for each tester.
  39.     //an error is reported if the name is already used by some other tester.
  40.     //
  41. LLMetricPerformanceTester(std::string name, BOOL use_default_performance_analysis) ;
  42. virtual ~LLMetricPerformanceTester();
  43. //
  44.     //return the name of the tester
  45.     //
  46. std::string getName() const { return mName ;}
  47. //
  48.     //return the number of the test metrics in this tester
  49.     //
  50. S32 getNumOfMetricStrings() const { return mMetricStrings.size() ;}
  51. //
  52.     //return the metric string at the index
  53.     //
  54. const std::string& getMetricString(U32 index) const ;
  55. //
  56.     //this function to compare the test results.
  57.     //by default, it compares the test results against the baseline one by one, item by item, 
  58.     //in the increasing order of the LLSD label counter, starting from the first one.
  59. //you can define your own way to analyze performance by passing FALSE to "use_default_performance_analysis",
  60.     //and implement two abstract virtual functions below: loadTestSession(...) and compareTestSessions(...).
  61.     //
  62. void analyzePerformance(std::ofstream* os, LLSD* base, LLSD* current) ;
  63. protected:
  64. //
  65.     //insert metric strings used in the tester.
  66.     //
  67. void addMetricString(std::string str) ;
  68. //
  69.     //increase LLSD label by 1
  70.     //
  71. void incLabel() ;
  72. //
  73.     //the function to write a set of test results to the log LLSD.
  74.     //
  75. void outputTestResults() ;
  76. //
  77.     //compare the test results.
  78.     //you can write your own to overwrite the default one.
  79.     //
  80. virtual void compareTestResults(std::ofstream* os, std::string metric_string, S32 v_base, S32 v_current) ;
  81. virtual void compareTestResults(std::ofstream* os, std::string metric_string, F32 v_base, F32 v_current) ;
  82. //
  83. //for performance analysis use 
  84. //it defines an interface for the two abstract virtual functions loadTestSession(...) and compareTestSessions(...).
  85.     //please make your own test session class derived from it.
  86. //
  87. class LLTestSession
  88. {
  89. public:
  90. virtual ~LLTestSession() ;
  91. };
  92. //
  93.     //load a test session for log LLSD
  94.     //you need to implement it only when you define your own way to analyze performance.
  95.     //otherwise leave it empty.
  96.     //
  97. virtual LLMetricPerformanceTester::LLTestSession* loadTestSession(LLSD* log) = 0 ;
  98. //
  99.     //compare the base session and the target session
  100.     //you need to implement it only when you define your own way to analyze performance.
  101.     //otherwise leave it empty.
  102.     //
  103. virtual void compareTestSessions(std::ofstream* os) = 0 ;
  104. //
  105.     //the function to write a set of test results to the log LLSD.
  106.     //you have to write you own version of this function.
  107. //
  108. virtual void outputTestRecord(LLSD* sd) = 0 ;
  109. private:
  110. void preOutputTestResults(LLSD* sd) ;
  111. void postOutputTestResults(LLSD* sd) ;
  112. void prePerformanceAnalysis() ;
  113. protected:
  114. //
  115.     //the unique name string of the tester
  116.     //
  117. std::string mName ;
  118. //
  119.     //the current label counter for the log LLSD
  120.     //
  121. std::string mCurLabel ;
  122. S32 mCount ;
  123. BOOL mUseDefaultPerformanceAnalysis ;
  124. LLTestSession* mBaseSessionp ;
  125. LLTestSession* mCurrentSessionp ;
  126. //metrics strings
  127. std::vector< std::string > mMetricStrings ;
  128. //static members
  129. private:
  130. static void addTester(LLMetricPerformanceTester* tester) ;
  131. public:
  132. typedef std::map< std::string, LLMetricPerformanceTester* > name_tester_map_t;
  133. static name_tester_map_t sTesterMap ;
  134. static LLMetricPerformanceTester* getTester(std::string label) ;
  135. static BOOL hasMetricPerformanceTesters() {return !sTesterMap.empty() ;}
  136. static void initClass() ;
  137. static void cleanClass() ;
  138. };
  139. #endif