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
  74                      , const char* file
  75                      , int line);
  76
  77     /// record values
  78
  79     void Add (unsigned __int64 value);
  80
  81     /// modification
  82
  83     void Reset();
  84
  85     /// data access
  86
  87         const char* GetName() const {return name;}
  88         const char* GetFile() const {return file;}
  89         int GetLine() const {return line;}
  90
  91         size_t GetCount() const {return count;}
  92     unsigned __int64 GetSum() const {return sum;}
  93         unsigned __int64 GetMinValue() const {return minValue;}
  94     unsigned __int64 GetMaxValue() const {return maxValue;}
  95 };
  96
  97 /**
  98 * RAII class that encapsulates a single execution of a profiled
  99 * block / line. The result gets added to an existing profiling record.
 100 */
 101
 102 class CRecordProfileEvent
 103 {
 104 private:
 105
 106     CProfilingRecord* record;
 107
 108         /// the initial CPU counter value
 109
 110     unsigned __int64 start;
 111
 112 public:
 113
 114     /// construction: start clock
 115
 116     CRecordProfileEvent (CProfilingRecord* aRecord);
 117
 118         /// destruction: time interval to profiling record,
 119         /// if Stop() had not been called before
 120
 121         ~CRecordProfileEvent();
 122
 123         /// don't wait for destruction
 124
 125         void Stop();
 126 };
 127
 128 #ifndef _DEBUG
 129
 130 /// construction / destruction
 131
 132 inline CRecordProfileEvent::CRecordProfileEvent (CProfilingRecord* aRecord)
 133     : record (aRecord)
 134     , start (__rdtsc())
 135 {
 136 }
 137
 138 inline CRecordProfileEvent::~CRecordProfileEvent()
 139 {
 140         if (record)
 141                 record->Add (__rdtsc() - start);
 142 }
 143
 144 #endif
 145
 146 /// don't wait for destruction
 147
 148 inline void CRecordProfileEvent::Stop()
 149 {
 150         if (record)
 151         {
 152                 record->Add (__rdtsc() - start);
 153                 record = nullptr;
 154         }
 155 }
 156
 157 /**
 158 * Singleton class that acts as container for all profiling records.
 159 * You may reset its content as well as write it to disk.
 160 */
 161
 162 class CProfilingInfo
 163 {
 164 private:
 165
 166     typedef std::vector<CProfilingRecord*> TRecords;
 167     TRecords records;
 168
 169     /// construction / destruction
 170
 171     CProfilingInfo();
 172     ~CProfilingInfo(void);
 173     // prevent cloning
 174     CProfilingInfo(const CProfilingInfo&) = delete;
 175     CProfilingInfo& operator=(const CProfilingInfo&) = delete;
 176
 177         /// create report
 178
 179         std::string GetReport() const;
 180
 181 public:
 182
 183     /// access to default instance
 184
 185     static CProfilingInfo* GetInstance();
 186
 187     /// add a new record
 188
 189     CProfilingRecord* Create ( const char* name
 190                              , const char* file
 191                              , int line);
 192 };
 193
 194 /**
 195 * Profiling macros
 196 */
 197
 198 #define PROFILE_CONCAT3( a, b )  a##b
 199 #define PROFILE_CONCAT2( a, b )  PROFILE_CONCAT3( a, b )
 200 #define PROFILE_CONCAT( a, b )   PROFILE_CONCAT2( a, b )
 201
 202 /// measures the time from the point of usage to the end of the respective block
 203
 204 #define PROFILE_BLOCK\
 205     static CProfilingRecord* PROFILE_CONCAT(record,__LINE__) \
 206         = CProfilingInfo::GetInstance()->Create(__FUNCTION__,__FILE__,__LINE__);\
 207     CRecordProfileEvent PROFILE_CONCAT(profileSection,__LINE__) (PROFILE_CONCAT(record,__LINE__));
 208
 209 /// measures the time taken to execute the respective code line
 210
 211 #define PROFILE_LINE(line)\
 212     static CProfilingRecord* PROFILE_CONCAT(record,__LINE__) \
 213         = CProfilingInfo::GetInstance()->Create(__FUNCTION__,__FILE__,__LINE__);\
 214     CRecordProfileEvent PROFILE_CONCAT(profileSection,__LINE__) (PROFILE_CONCAT(record,__LINE__));\
 215     line;\
 216     PROFILE_CONCAT(profileSection,__LINE__).Stop();
 217