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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#include <algorithm>
#include <climits>
#include <cstring>
#include "System/TimeProfiler.h"
#include "System/GlobalRNG.h"
#include "System/Log/ILog.h"
#include "System/Threading/SpringThreading.h"
#ifdef THREADPOOL
#include "System/Threading/ThreadPool.h"
#endif
static spring::mutex profileMutex;
static spring::unordered_map<int, std::string> hashToName;
static spring::unordered_map<int, int> refCounters;
static CGlobalUnsyncedRNG profileColorRNG;
static unsigned HashString(const char* s, size_t n)
{
unsigned hash = 0;
for (size_t i = 0; (i < n || n == std::string::npos); ++i) {
if (s[i] == 0)
break;
hash += s[i];
hash ^= (hash << 7) | (hash >> (sizeof(hash) * CHAR_BIT - 7));
}
return hash;
}
#if 0
// unused
static unsigned HashString(const std::string& s) {
return (HashString(s.c_str(), s.size()));
}
BasicTimer::BasicTimer(const std::string& timerName)
: nameHash(HashString(timerName))
, startTime(spring_gettime())
, name(timerName)
{
const auto iter = hashToName.find(nameHash);
if (iter == hashToName.end()) {
hashToName.insert(std::pair<int, std::string>(nameHash, timerName)).first;
} else {
#ifdef DEBUG
if (iter->second != timerName) {
LOG_L(L_ERROR, "Timer hash collision: %s <=> %s", timerName.c_str(), iter->second.c_str());
assert(false);
}
#endif
}
}
#endif
BasicTimer::BasicTimer(const char* timerName)
: nameHash(HashString(timerName, std::string::npos))
, startTime(spring_gettime())
, name(timerName)
{
const auto iter = hashToName.find(nameHash);
if (iter == hashToName.end()) {
hashToName.insert(std::pair<int, std::string>(nameHash, timerName)).first;
} else {
#ifdef DEBUG
if (iter->second != timerName) {
LOG_L(L_ERROR, "Timer hash collision: %s <=> %s", timerName, iter->second.c_str());
assert(false);
}
#endif
}
}
spring_time BasicTimer::GetDuration() const
{
return spring_difftime(spring_gettime(), startTime);
}
#if 0
// unused
ScopedTimer::ScopedTimer(const std::string& name, bool _autoShowGraph, bool _specialTimer)
: BasicTimer(name)
, autoShowGraph(_autoShowGraph)
, specialTimer(_specialTimer)
{
auto iter = refCounters.find(nameHash);
if (iter == refCounters.end())
iter = refCounters.insert(std::pair<int, int>(nameHash, 0)).first;
++(iter->second);
}
#endif
ScopedTimer::ScopedTimer(const char* timerName, bool _autoShowGraph, bool _specialTimer)
: BasicTimer(timerName)
// Game::SendClientProcUsage depends on "Sim" and "Draw" percentages, BenchMark on "Lua"
// note that address-comparison is intended here, timer names are (and must be) literals
, autoShowGraph(_autoShowGraph)
, specialTimer(_specialTimer)
{
auto iter = refCounters.find(nameHash);
if (iter == refCounters.end())
iter = refCounters.insert(std::pair<int, int>(nameHash, 0)).first;
++(iter->second);
}
ScopedTimer::~ScopedTimer()
{
// no avoiding a second lookup since iterators can be invalidated with unordered_map
auto iter = refCounters.find(nameHash);
assert(iter != refCounters.end());
assert(iter->second > 0);
if (--(iter->second) == 0) {
profiler.AddTime(GetName(), startTime, GetDuration(), autoShowGraph, specialTimer, false);
}
}
ScopedOnceTimer::ScopedOnceTimer(const char* timerName)
: startTime(spring_gettime())
, name(timerName)
{
}
ScopedOnceTimer::ScopedOnceTimer(const std::string& timerName)
: startTime(spring_gettime())
, name(timerName)
{
}
ScopedOnceTimer::~ScopedOnceTimer()
{
LOG("[%s][%s] %ims", __func__, name.c_str(), int(GetDuration().toMilliSecsi()));
}
spring_time ScopedOnceTimer::GetDuration() const
{
return spring_difftime(spring_gettime(), startTime);
}
#if 0
// unused
ScopedMtTimer::ScopedMtTimer(const std::string& timerName, bool _autoShowGraph)
// can not call BasicTimer's other ctor, accesses global map
// collisions for MT timers do not need to be checked anyway
: BasicTimer(spring_gettime())
, autoShowGraph(_autoShowGraph)
{
name = timerName;
}
#endif
ScopedMtTimer::ScopedMtTimer(const char* timerName, bool _autoShowGraph)
: BasicTimer(spring_gettime())
, autoShowGraph(_autoShowGraph)
{
name = timerName;
}
ScopedMtTimer::~ScopedMtTimer()
{
profiler.AddTime(GetName(), startTime, GetDuration(), autoShowGraph, false, true);
}
//////////////////////////////////////////////////////////////////////
// Construction/Destruction
//////////////////////////////////////////////////////////////////////
CTimeProfiler::CTimeProfiler()
{
ResetState();
}
CTimeProfiler::~CTimeProfiler()
{
#if 0
// should not be needed, destructor runs after main returns and all threads are gone
std::unique_lock<spring::mutex> ulk(profileMutex, std::defer_lock);
while (!ulk.try_lock()) {}
#endif
}
CTimeProfiler& CTimeProfiler::GetInstance()
{
static CTimeProfiler tp;
return tp;
}
void CTimeProfiler::ResetState() {
// grab lock; ThreadPool workers might already be running SCOPED_MT_TIMER
std::unique_lock<spring::mutex> ulk(profileMutex, std::defer_lock);
while (!ulk.try_lock()) {}
profile.clear();
sortedProfile.clear();
#ifdef THREADPOOL
threadProfile.clear();
threadProfile.resize(ThreadPool::GetMaxThreads());
#endif
profileColorRNG.Seed(spring_tomsecs(lastBigUpdate = spring_gettime()));
currentPosition = 0;
resortProfiles = 0;
enabled = false;
}
void CTimeProfiler::ToggleLock(bool lock)
{
if (lock) {
profileMutex.lock();
} else {
profileMutex.unlock();
}
}
void CTimeProfiler::Update()
{
if (!enabled) {
UpdateRaw();
ResortProfilesRaw();
RefreshProfilesRaw();
return;
}
// FIXME: non-locking threadsafe
std::unique_lock<spring::mutex> ulk(profileMutex, std::defer_lock);
while (!ulk.try_lock()) {}
UpdateRaw();
ResortProfilesRaw();
RefreshProfilesRaw();
}
void CTimeProfiler::UpdateRaw()
{
currentPosition += 1;
currentPosition &= (TimeRecord::numFrames - 1);
for (auto& pi: profile) {
pi.second.frames[currentPosition] = spring_notime;
}
const spring_time curTime = spring_gettime();
const float timeDiff = spring_diffmsecs(curTime, lastBigUpdate);
if (timeDiff > 500.0f) {
// update percentages and peaks twice every second
for (auto& pi: profile) {
auto& p = pi.second;
p.percent = spring_tomsecs(p.current) / timeDiff;
p.current = spring_notime;
p.newLagPeak = false;
p.newPeak = false;
if (p.percent > p.peak) {
p.peak = p.percent;
p.newPeak = true;
}
}
lastBigUpdate = curTime;
}
if (curTime.toSecsi() % 6 == 0) {
for (auto& pi: profile) {
(pi.second).maxLag *= 0.5f;
}
}
}
void CTimeProfiler::ResortProfilesRaw()
{
if (resortProfiles > 0) {
resortProfiles = 0;
sortedProfile.clear();
sortedProfile.reserve(profile.size());
typedef std::pair<std::string, TimeRecord> TimeRecordPair;
typedef std::function<bool(const TimeRecordPair&, const TimeRecordPair&)> ProfileSortFunc;
const ProfileSortFunc sortFunc = [](const TimeRecordPair& a, const TimeRecordPair& b) { return (a.first < b.first); };
// either caller already has lock, or we are disabled and thread-safe
for (auto it = profile.begin(); it != profile.end(); ++it) {
sortedProfile.emplace_back(it->first, it->second);
}
std::sort(sortedProfile.begin(), sortedProfile.end(), sortFunc);
}
}
void CTimeProfiler::RefreshProfiles()
{
// ProfileDrawer calls this, and is only enabled when we are
assert(enabled);
// lock so nothing modifies *unsorted* profiles during the refresh
std::unique_lock<spring::mutex> ulk(profileMutex, std::defer_lock);
while (!ulk.try_lock()) {}
RefreshProfilesRaw();
}
void CTimeProfiler::RefreshProfilesRaw()
{
// either called from ProfileDrawer or from Update; the latter
// makes the "/debuginfo profiling" command work when disabled
for (auto it = sortedProfile.begin(); it != sortedProfile.end(); ++it) {
TimeRecord& rec = it->second;
const bool showGraph = rec.showGraph;
rec = profile[it->first];
rec.showGraph = showGraph;
}
}
float CTimeProfiler::GetPercent(const char* name) const
{
// if disabled, only special timers can pass AddTime
// all of those are non-threaded, so no need to lock
if (!enabled)
return (GetPercentRaw(name));
std::unique_lock<spring::mutex> ulk(profileMutex, std::defer_lock);
while (!ulk.try_lock()) {}
return (GetPercentRaw(name));
}
void CTimeProfiler::AddTime(
const std::string& name,
const spring_time startTime,
const spring_time deltaTime,
const bool showGraph,
const bool specialTimer,
const bool threadTimer
) {
const spring_time t0 = spring_now();
if (!enabled) {
if (!specialTimer)
return;
assert(!threadTimer);
AddTimeRaw(name, startTime, deltaTime, showGraph, threadTimer);
AddTimeRaw("Misc::Profiler::AddTime", t0, spring_now() - t0, false, false);
return;
}
// acquire lock at the start; one inserting thread could
// cause a profile rehash and invalidate <pi> for another
std::unique_lock<spring::mutex> ulk(profileMutex, std::defer_lock);
while (!ulk.try_lock()) {}
AddTimeRaw(name, startTime, deltaTime, showGraph, threadTimer);
AddTimeRaw("Misc::Profiler::AddTime", t0, spring_now() - t0, false, false);
}
void CTimeProfiler::AddTimeRaw(
const std::string& name,
const spring_time startTime,
const spring_time deltaTime,
const bool showGraph,
const bool threadTimer
) {
#ifdef THREADPOOL
if (threadTimer)
threadProfile[ThreadPool::GetThreadNum()].emplace_back(startTime, spring_gettime());
#endif
auto pi = profile.find(name);
auto& p = (pi != profile.end())? pi->second: profile[name];
// these are 0 if just created, works for both paths
p.total += deltaTime;
p.current += deltaTime;
p.newLagPeak = (p.maxLag > 0.0f && deltaTime.toMilliSecsf() > p.maxLag);
p.maxLag = std::max(p.maxLag, deltaTime.toMilliSecsf());
if (pi != profile.end()) {
// profile already exists
p.frames[currentPosition] += deltaTime;
} else {
// new profile, new color
p.color.x = profileColorRNG.NextFloat();
p.color.y = profileColorRNG.NextFloat();
p.color.z = profileColorRNG.NextFloat();
p.showGraph = showGraph;
resortProfiles += 1;
}
}
void CTimeProfiler::PrintProfilingInfo() const
{
if (sortedProfile.empty())
return;
LOG("%35s|%18s|%s", "Part", "Total Time", "Time of the last 0.5s");
for (auto pi = sortedProfile.begin(); pi != sortedProfile.end(); ++pi) {
const std::string& name = pi->first;
const TimeRecord& tr = pi->second;
LOG("%35s %16.2fms %5.2f%%", name.c_str(), tr.total.toMilliSecsf(), tr.percent * 100);
}
}
|