OpenTTD Source: src/newgrf_profiling.h Source File

OpenTTD Source 15.0-beta1

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"
14#include "timer/timer_game_calendar.h"
15#include "newgrf.h"
16#include "newgrf_callbacks.h"
17#include "newgrf_spritegroup.h"
18
19
23 struct NewGRFProfiler {
24 NewGRFProfiler(const GRFFile *grffile);
25 ~NewGRFProfiler();
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;
48 CallbackID cb;
49 GrfSpecFeature feat;
50 };
51
52 const GRFFile *grffile;
53 bool active;
54 uint64_t start_tick;
55 Call cur_call;
56 std::vector<Call> calls;
57};
58
59extern std::vector<NewGRFProfiler> _newgrf_profilers;
60
61#endif /* NEWGRF_PROFILING_H */
newgrf.h
Base for the NewGRF implementation.
GrfSpecFeature
GrfSpecFeature
Definition newgrf.h:67
newgrf_callbacks.h
Callbacks that NewGRFs could implement.
CallbackID
CallbackID
List of implemented NewGRF callbacks.
Definition newgrf_callbacks.h:20
newgrf_spritegroup.h
Action 2 handling.
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
GRFFile
Dynamic data of a loaded NewGRF.
Definition newgrf.h:108
NewGRFProfiler::Call
Measurement of a single sprite group resolution.
Definition newgrf_profiling.h:41
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::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
SpriteGroup
Definition newgrf_spritegroup.h:57
timer_game_calendar.h
Definition of the game-calendar-timer.