OpenTTD Source: src/newgrf_profiling.cpp Source File

OpenTTD Source 15.0-beta1

newgrf_profiling.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10#include "newgrf_profiling.h"
11#include "fileio_func.h"
12#include "string_func.h"
13#include "console_func.h"
14#include "spritecache.h"
15#include "3rdparty/fmt/chrono.h"
16#include "timer/timer.h"
17#include "timer/timer_game_tick.h"
18
19#include <chrono>
20
21
22std::vector<NewGRFProfiler> _newgrf_profilers;
23
24
30NewGRFProfiler::NewGRFProfiler(const GRFFile *grffile) : grffile{ grffile }, active{ false }, cur_call{}
31{
32}
33
37NewGRFProfiler::~NewGRFProfiler()
38{
39}
40
45 void NewGRFProfiler::BeginResolve(const ResolverObject &resolver)
46{
47 using namespace std::chrono;
48 this->cur_call.root_sprite = resolver.root_spritegroup->nfo_line;
49 this->cur_call.subs = 0;
50 this->cur_call.time = (uint32_t)time_point_cast<microseconds>(high_resolution_clock::now()).time_since_epoch().count();
51 this->cur_call.tick = TimerGameTick::counter;
52 this->cur_call.cb = resolver.callback;
53 this->cur_call.feat = resolver.GetFeature();
54 this->cur_call.item = resolver.GetDebugID();
55}
56
60 void NewGRFProfiler::EndResolve(const SpriteGroup *result)
61{
62 using namespace std::chrono;
63 this->cur_call.time = (uint32_t)time_point_cast<microseconds>(high_resolution_clock::now()).time_since_epoch().count() - this->cur_call.time;
64
65 if (result == nullptr) {
66 this->cur_call.result = 0;
67 } else if (result->type == SGT_CALLBACK) {
68 this->cur_call.result = static_cast<const CallbackResultSpriteGroup *>(result)->result;
69 } else if (result->type == SGT_RESULT) {
70 this->cur_call.result = GetSpriteLocalID(static_cast<const ResultSpriteGroup *>(result)->sprite);
71 } else {
72 this->cur_call.result = result->nfo_line;
73 }
74
75 this->calls.push_back(this->cur_call);
76}
77
81 void NewGRFProfiler::RecursiveResolve()
82{
83 this->cur_call.subs += 1;
84}
85
86void NewGRFProfiler::Start()
87{
88 this->Abort();
89 this->active = true;
90 this->start_tick = TimerGameTick::counter;
91}
92
93uint32_t NewGRFProfiler::Finish()
94{
95 if (!this->active) return 0;
96
97 if (this->calls.empty()) {
98 IConsolePrint(CC_DEBUG, "Finished profile of NewGRF [{:08X}], no events collected, not writing a file.", BSWAP32(this->grffile->grfid));
99
100 this->Abort();
101 return 0;
102 }
103
104 std::string filename = this->GetOutputFilename();
105 IConsolePrint(CC_DEBUG, "Finished profile of NewGRF [{:08X}], writing {} events to '{}'.", BSWAP32(this->grffile->grfid), this->calls.size(), filename);
106
107 uint32_t total_microseconds = 0;
108
109 auto f = FioFOpenFile(filename, "wt", Subdirectory::NO_DIRECTORY);
110
111 if (!f.has_value()) {
112 IConsolePrint(CC_ERROR, "Failed to open '{}' for writing.", filename);
113 } else {
114 fmt::print(*f, "Tick,Sprite,Feature,Item,CallbackID,Microseconds,Depth,Result\n");
115 for (const Call &c : this->calls) {
116 fmt::print(*f, "{},{},{:#X},{},{:#X},{},{},{}\n", c.tick, c.root_sprite, c.feat, c.item, (uint)c.cb, c.time, c.subs, c.result);
117 total_microseconds += c.time;
118 }
119 }
120
121 this->Abort();
122 return total_microseconds;
123}
124
125void NewGRFProfiler::Abort()
126{
127 this->active = false;
128 this->calls.clear();
129}
130
135std::string NewGRFProfiler::GetOutputFilename() const
136{
137 return fmt::format("{}grfprofile-{:%Y%m%d-%H%M}-{:08X}.csv", FiosGetScreenshotDir(), fmt::localtime(time(nullptr)), BSWAP32(this->grffile->grfid));
138}
139
140/* static */ uint32_t NewGRFProfiler::FinishAll()
141{
142 NewGRFProfiler::AbortTimer();
143
144 uint64_t max_ticks = 0;
145 uint32_t total_microseconds = 0;
146 for (NewGRFProfiler &pr : _newgrf_profilers) {
147 if (pr.active) {
148 total_microseconds += pr.Finish();
149 max_ticks = std::max(max_ticks, TimerGameTick::counter - pr.start_tick);
150 }
151 }
152
153 if (total_microseconds > 0 && max_ticks > 0) {
154 IConsolePrint(CC_DEBUG, "Total NewGRF callback processing: {} microseconds over {} ticks.", total_microseconds, max_ticks);
155 }
156
157 return total_microseconds;
158}
159
163 static TimeoutTimer<TimerGameTick> _profiling_finish_timeout({ TimerGameTick::Priority::NONE, 0 }, []()
164{
165 NewGRFProfiler::FinishAll();
166});
167
171/* static */ void NewGRFProfiler::StartTimer(uint64_t ticks)
172{
173 _profiling_finish_timeout.Reset({ TimerGameTick::Priority::NONE, static_cast<uint>(ticks) });
174}
175
179/* static */ void NewGRFProfiler::AbortTimer()
180{
181 _profiling_finish_timeout.Abort();
182}
BSWAP32
static uint32_t BSWAP32(uint32_t x)
Perform a 32 bits endianness bitswap on x.
Definition bitmath_func.hpp:364
TimeoutTimer
A timeout timer will fire once after the interval.
Definition timer.h:116
TimeoutTimer::Reset
void Reset()
Reset the timer, so it will fire again after the timeout.
Definition timer.h:140
TimerGameTick::counter
static TickCounter counter
Monotonic counter, in ticks, since start of game.
Definition timer_game_tick.h:60
TimerGameTick::NONE
@ NONE
These timers can be executed in any order; the order is not relevant.
Definition timer_game_tick.h:28
IConsolePrint
void IConsolePrint(TextColour colour_code, const std::string &string)
Handle the printing of text entered into the console or redirected there by any other means.
Definition console.cpp:89
console_func.h
Console functions used outside of the console code.
CC_DEBUG
static const TextColour CC_DEBUG
Colour for debug output.
Definition console_type.h:28
CC_ERROR
static const TextColour CC_ERROR
Colour for error lines.
Definition console_type.h:24
FioFOpenFile
std::optional< FileHandle > FioFOpenFile(const std::string &filename, const char *mode, Subdirectory subdir, size_t *filesize)
Opens a OpenTTD file somewhere in a personal or global directory.
Definition fileio.cpp:242
fileio_func.h
Functions for Standard In/Out file operations.
FiosGetScreenshotDir
const char * FiosGetScreenshotDir()
Get the directory for screenshots.
Definition fios.cpp:602
NO_DIRECTORY
@ NO_DIRECTORY
A path without any base directory.
Definition fileio_type.h:133
_profiling_finish_timeout
static TimeoutTimer< TimerGameTick > _profiling_finish_timeout({ TimerGameTick::Priority::NONE, 0 }, []() { NewGRFProfiler::FinishAll();})
Check whether profiling is active and should be finished.
newgrf_profiling.h
Profiling of NewGRF action 2 handling.
GetSpriteLocalID
uint32_t GetSpriteLocalID(SpriteID sprite)
Get the GRF-local sprite id of a given sprite.
Definition spritecache.cpp:181
spritecache.h
Functions to cache sprites in memory.
string_func.h
Functions related to low-level strings.
CallbackResultSpriteGroup
Definition newgrf_spritegroup.h:210
GRFFile
Dynamic data of a loaded NewGRF.
Definition newgrf.h:108
NewGRFProfiler::Call::feat
GrfSpecFeature feat
GRF feature being resolved for.
Definition newgrf_profiling.h:49
NewGRFProfiler::Call::time
uint32_t time
Time taken for resolution (microseconds)
Definition newgrf_profiling.h:46
NewGRFProfiler::Call::subs
uint32_t subs
Sub-calls to other sprite groups.
Definition newgrf_profiling.h:45
NewGRFProfiler::Call::tick
uint64_t tick
Game tick.
Definition newgrf_profiling.h:47
NewGRFProfiler::Call::root_sprite
uint32_t root_sprite
Pseudo-sprite index in GRF file.
Definition newgrf_profiling.h:42
NewGRFProfiler::Call::cb
CallbackID cb
Callback ID.
Definition newgrf_profiling.h:48
NewGRFProfiler::Call::item
uint32_t item
Local ID of item being resolved for.
Definition newgrf_profiling.h:43
NewGRFProfiler::Call::result
uint32_t result
Result of callback.
Definition newgrf_profiling.h:44
NewGRFProfiler
Callback profiler for NewGRF development.
Definition newgrf_profiling.h:23
NewGRFProfiler::EndResolve
void EndResolve(const SpriteGroup *result)
Capture the completion of a sprite group resolution.
Definition newgrf_profiling.cpp:60
NewGRFProfiler::RecursiveResolve
void RecursiveResolve()
Capture a recursive sprite group resolution.
Definition newgrf_profiling.cpp:81
NewGRFProfiler::StartTimer
static void StartTimer(uint64_t ticks)
Start the timeout timer that will finish all profiling sessions.
Definition newgrf_profiling.cpp:171
NewGRFProfiler::~NewGRFProfiler
~NewGRFProfiler()
Complete profiling session and write data to file.
Definition newgrf_profiling.cpp:37
NewGRFProfiler::cur_call
Call cur_call
Data for current call in progress.
Definition newgrf_profiling.h:55
NewGRFProfiler::active
bool active
Is this profiler collecting data.
Definition newgrf_profiling.h:53
NewGRFProfiler::grffile
const GRFFile * grffile
Which GRF is being profiled.
Definition newgrf_profiling.h:52
NewGRFProfiler::start_tick
uint64_t start_tick
Tick number this profiler was started on.
Definition newgrf_profiling.h:54
NewGRFProfiler::AbortTimer
static void AbortTimer()
Abort the timeout timer, so the timer callback is never called.
Definition newgrf_profiling.cpp:179
NewGRFProfiler::BeginResolve
void BeginResolve(const ResolverObject &resolver)
Capture the start of a sprite group resolution.
Definition newgrf_profiling.cpp:45
NewGRFProfiler::NewGRFProfiler
NewGRFProfiler(const GRFFile *grffile)
Create profiler object and begin profiling session.
Definition newgrf_profiling.cpp:30
NewGRFProfiler::calls
std::vector< Call > calls
All calls collected so far.
Definition newgrf_profiling.h:56
NewGRFProfiler::GetOutputFilename
std::string GetOutputFilename() const
Get name of the file that will be written.
Definition newgrf_profiling.cpp:135
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition newgrf_spritegroup.h:296
ResolverObject::GetDebugID
virtual uint32_t GetDebugID() const
Get an identifier for the item being resolved.
Definition newgrf_spritegroup.h:394
ResolverObject::callback
CallbackID callback
Callback being resolved.
Definition newgrf_spritegroup.h:314
ResolverObject::GetFeature
virtual GrfSpecFeature GetFeature() const
Get the feature number being resolved for.
Definition newgrf_spritegroup.h:388
ResolverObject::root_spritegroup
const SpriteGroup * root_spritegroup
Root SpriteGroup to use for resolving.
Definition newgrf_spritegroup.h:325
ResultSpriteGroup
Definition newgrf_spritegroup.h:224
SpriteGroup
Definition newgrf_spritegroup.h:57
timer.h
Definition of Interval and OneShot timers.
timer_game_tick.h
Definition of the tick-based game-timer.