src/Utils/ProfilingInfo.h

   1 #pragma once
   2
   3 // TortoiseGit - a Windows shell extension for easy version control
   4
   5 // Copyright (C) 2003-2008, 2015 - TortoiseSVN
   6
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License
   9 // as published by the Free Software Foundation; either version 2
  10 // of the License, or (at your option) any later version.
  11
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU General Public License for more details.
  16
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software Foundation,
  19 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20 //
  21
  22 //////////////////////////////////////////////////////////////////////
  23 // required includes
  24 //////////////////////////////////////////////////////////////////////
  25
  26 #ifndef _DEBUG
  27 #ifndef __INTRIN_H_
  28 #include <intrin.h>
  29 #endif
  30 #endif
  31
  32 #ifndef _PSAPI_H_
  33 #include <psapi.h>
  34 #endif
  35
  36 #ifndef _STRING_
  37 #include <string>
  38 #endif
  39
  40 #ifndef _VECTOR_
  41 #include <vector>
  42 #endif
  43
  44 #pragma comment (lib, "psapi.lib")
  45
  46 /**
  47 * Collects the profiling info for a given profiled block / line.
  48 * Records execution count, min, max and accumulated execution time
  49 * in CPU clock ticks.
  50 */
  51
  52 class CProfilingRecord
  53 {
  54 private:
  55
  56         /// identification
  57
  58         const char* name;
  59         const char* file;
  60         int line;
  61
  62         /// collected profiling info
  63
  64         size_t count;
  65         unsigned __int64 sum;
  66         unsigned __int64 minValue;
  67         unsigned __int64 maxValue;
  68
  69 public:
  70
  71         /// construction
  72
  73         CProfilingRecord ( const char* name, const char* file, int line);
  74
  75         /// record values
  76
  77         void Add (unsigned __int64 value);
  78
  79         /// modification
  80
  81         void Reset();
  82
  83         /// data access
  84
  85         const char* GetName() const {return name;}
  86         const char* GetFile() const {return file;}
  87         int GetLine() const {return line;}
  88
  89         size_t GetCount() const {return count;}
  90         unsigned __int64 GetSum() const {return sum;}
  91         unsigned __int64 GetMinValue() const {return minValue;}
  92         unsigned __int64 GetMaxValue() const {return maxValue;}
  93 };
  94
  95 /**
  96 * RAII class that encapsulates a single execution of a profiled
  97 * block / line. The result gets added to an existing profiling record.
  98 */
  99
 100 class CRecordProfileEvent
 101 {
 102 private:
 103
 104         CProfilingRecord* record;
 105
 106         /// the initial CPU counter value
 107
 108         unsigned __int64 start;
 109
 110 public:
 111
 112         /// construction: start clock
 113
 114         CRecordProfileEvent (CProfilingRecord* aRecord);
 115
 116         /// destruction: time interval to profiling record,
 117         /// if Stop() had not been called before
 118
 119         ~CRecordProfileEvent();
 120
 121         /// don't wait for destruction
 122
 123         void Stop();
 124 };
 125
 126 #ifndef _DEBUG
 127
 128 /// construction / destruction
 129
 130 inline CRecordProfileEvent::CRecordProfileEvent (CProfilingRecord* aRecord)
 131         : record (aRecord)
 132         , start (__rdtsc())
 133 {
 134 }
 135
 136 inline CRecordProfileEvent::~CRecordProfileEvent()
 137 {
 138         if (record)
 139                 record->Add (__rdtsc() - start);
 140 }
 141
 142 #endif
 143
 144 /// don't wait for destruction
 145
 146 inline void CRecordProfileEvent::Stop()
 147 {
 148         if (record)
 149         {
 150                 record->Add (__rdtsc() - start);
 151                 record = nullptr;
 152         }
 153 }
 154
 155 /**
 156 * Singleton class that acts as container for all profiling records.
 157 * You may reset its content as well as write it to disk.
 158 */
 159
 160 class CProfilingInfo
 161 {
 162 private:
 163
 164         typedef std::vector<CProfilingRecord*> TRecords;
 165         TRecords records;
 166
 167         /// construction / destruction
 168
 169         CProfilingInfo();
 170         ~CProfilingInfo(void);
 171         // prevent cloning
 172         CProfilingInfo(const CProfilingInfo&) = delete;
 173         CProfilingInfo& operator=(const CProfilingInfo&) = delete;
 174
 175         /// create report
 176
 177         std::string GetReport() const;
 178
 179 public:
 180
 181         /// access to default instance
 182
 183         static CProfilingInfo* GetInstance();
 184
 185         /// add a new record
 186
 187         CProfilingRecord* Create ( const char* name, const char* file, int line);
 188 };
 189
 190 /**
 191 * Profiling macros
 192 */
 193
 194 #define PROFILE_CONCAT3( a, b )  a##b
 195 #define PROFILE_CONCAT2( a, b )  PROFILE_CONCAT3( a, b )
 196 #define PROFILE_CONCAT( a, b )   PROFILE_CONCAT2( a, b )
 197
 198 /// measures the time from the point of usage to the end of the respective block
 199
 200 #define PROFILE_BLOCK\
 201         static CProfilingRecord* PROFILE_CONCAT(record,__LINE__) \
 202                 = CProfilingInfo::GetInstance()->Create(__FUNCTION__,__FILE__,__LINE__);\
 203         CRecordProfileEvent PROFILE_CONCAT(profileSection,__LINE__) (PROFILE_CONCAT(record,__LINE__));
 204
 205 /// measures the time taken to execute the respective code line
 206
 207 #define PROFILE_LINE(line)\
 208         static CProfilingRecord* PROFILE_CONCAT(record,__LINE__) \
 209                 = CProfilingInfo::GetInstance()->Create(__FUNCTION__,__FILE__,__LINE__);\
 210         CRecordProfileEvent PROFILE_CONCAT(profileSection,__LINE__) (PROFILE_CONCAT(record,__LINE__));\
 211         line;\
 212         PROFILE_CONCAT(profileSection,__LINE__).Stop();