OpenTTD Source  20241121-master-g67a0fccfad
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 
22 std::vector<NewGRFProfiler> _newgrf_profilers;
23 
24 
30 NewGRFProfiler::NewGRFProfiler(const GRFFile *grffile) : grffile{ grffile }, active{ false }, cur_call{}
31 {
32 }
33 
38 {
39 }
40 
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();
52  this->cur_call.cb = resolver.callback;
53  this->cur_call.feat = resolver.GetFeature();
54  this->cur_call.item = resolver.GetDebugID();
55 }
56 
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 
82 {
83  this->cur_call.subs += 1;
84 }
85 
86 void NewGRFProfiler::Start()
87 {
88  this->Abort();
89  this->active = true;
91 }
92 
93 uint32_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 
125 void NewGRFProfiler::Abort()
126 {
127  this->active = false;
128  this->calls.clear();
129 }
130 
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 {
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 {
182 }
static uint32_t BSWAP32(uint32_t x)
Perform a 32 bits endianness bitswap on x.
A timeout timer will fire once after the interval.
Definition: timer.h:116
static TickCounter counter
Monotonic counter, in ticks, since start of game.
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 functions used outside of the console code.
static const TextColour CC_DEBUG
Colour for debug output.
Definition: console_type.h:28
static const TextColour CC_ERROR
Colour for error lines.
Definition: console_type.h:24
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
Functions for Standard In/Out file operations.
const char * FiosGetScreenshotDir()
Get the directory for screenshots.
Definition: fios.cpp:602
@ NO_DIRECTORY
A path without any base directory.
Definition: fileio_type.h:133
static TimeoutTimer< TimerGameTick > _profiling_finish_timeout({ TimerGameTick::Priority::NONE, 0 }, []() { NewGRFProfiler::FinishAll();})
Check whether profiling is active and should be finished.
Profiling of NewGRF action 2 handling.
uint32_t GetSpriteLocalID(SpriteID sprite)
Get the GRF-local sprite id of a given sprite.
Functions to cache sprites in memory.
Functions related to low-level strings.
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:108
GrfSpecFeature feat
GRF feature being resolved for.
uint32_t time
Time taken for resolution (microseconds)
uint32_t subs
Sub-calls to other sprite groups.
uint64_t tick
Game tick.
uint32_t root_sprite
Pseudo-sprite index in GRF file.
CallbackID cb
Callback ID.
uint32_t item
Local ID of item being resolved for.
uint32_t result
Result of callback.
Callback profiler for NewGRF development.
void EndResolve(const SpriteGroup *result)
Capture the completion of a sprite group resolution.
void RecursiveResolve()
Capture a recursive sprite group resolution.
static void StartTimer(uint64_t ticks)
Start the timeout timer that will finish all profiling sessions.
~NewGRFProfiler()
Complete profiling session and write data to file.
Call cur_call
Data for current call in progress.
bool active
Is this profiler collecting data.
const GRFFile * grffile
Which GRF is being profiled.
uint64_t start_tick
Tick number this profiler was started on.
static void AbortTimer()
Abort the timeout timer, so the timer callback is never called.
void BeginResolve(const ResolverObject &resolver)
Capture the start of a sprite group resolution.
NewGRFProfiler(const GRFFile *grffile)
Create profiler object and begin profiling session.
std::vector< Call > calls
All calls collected so far.
std::string GetOutputFilename() const
Get name of the file that will be written.
Interface for SpriteGroup-s to access the gamestate.
virtual uint32_t GetDebugID() const
Get an identifier for the item being resolved.
CallbackID callback
Callback being resolved.
virtual GrfSpecFeature GetFeature() const
Get the feature number being resolved for.
const SpriteGroup * root_spritegroup
Root SpriteGroup to use for resolving.
Definition of Interval and OneShot timers.
Definition of the tick-based game-timer.