OpenTTD Source  20241108-master-g80f628063a
newgrf_profiling.h
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 #ifndef NEWGRF_PROFILING_H
11 #define NEWGRF_PROFILING_H
12 
13 #include "stdafx.h"
15 #include "newgrf.h"
16 #include "newgrf_callbacks.h"
17 #include "newgrf_spritegroup.h"
18 
19 
26 
27  void BeginResolve(const ResolverObject &resolver);
28  void EndResolve(const SpriteGroup *result);
29  void RecursiveResolve();
30 
31  void Start();
32  uint32_t Finish();
33  void Abort();
34  std::string GetOutputFilename() const;
35 
36  static void StartTimer(uint64_t ticks);
37  static void AbortTimer();
38  static uint32_t FinishAll();
39 
41  struct Call {
42  uint32_t root_sprite;
43  uint32_t item;
44  uint32_t result;
45  uint32_t subs;
46  uint32_t time;
47  uint64_t tick;
50  };
51 
52  const GRFFile *grffile;
53  bool active;
54  uint64_t start_tick;
56  std::vector<Call> calls;
57 };
58 
59 extern std::vector<NewGRFProfiler> _newgrf_profilers;
60 
61 #endif /* NEWGRF_PROFILING_H */
Base for the NewGRF implementation.
GrfSpecFeature
Definition: newgrf.h:67
Callbacks that NewGRFs could implement.
CallbackID
List of implemented NewGRF callbacks.
Action 2 handling.
Definition of base types and functions in a cross-platform compatible way.
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:108
Measurement of a single sprite group resolution.
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.
Definition of the game-calendar-timer.