Feature: NewGRF callback profiling (#7868)
Adds a console command newgrf_profile to collect some profiling data about NewGRF action 2 callbacks and produce a CSV file.pull/132/head
Niels Martin Hansen
4 years ago
committed by
GitHub
parent
f88ac83408
commit
c8779fb311
@ -0,0 +1,162 @@
|
||||
/*
|
||||
* This file is part of OpenTTD.
|
||||
* 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.
|
||||
* 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.
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
/** @file newgrf_profiling.cpp Profiling of NewGRF action 2 handling. */
|
||||
|
||||
#include "newgrf_profiling.h"
|
||||
#include "date_func.h"
|
||||
#include "fileio_func.h"
|
||||
#include "string_func.h"
|
||||
#include "console_func.h"
|
||||
#include "spritecache.h"
|
||||
|
||||
#include <chrono>
|
||||
#include <time.h>
|
||||
|
||||
|
||||
std::vector<NewGRFProfiler> _newgrf_profilers;
|
||||
Date _newgrf_profile_end_date;
|
||||
|
||||
|
||||
/**
|
||||
* Create profiler object and begin profiling session.
|
||||
* @param grffile The GRF file to collect profiling data on
|
||||
* @param end_date Game date to end profiling on
|
||||
*/
|
||||
NewGRFProfiler::NewGRFProfiler(const GRFFile *grffile) : grffile{ grffile }, active{ false }, cur_call{}
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Complete profiling session and write data to file
|
||||
*/
|
||||
NewGRFProfiler::~NewGRFProfiler()
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Capture the start of a sprite group resolution.
|
||||
* @param resolver Data about sprite group being resolved
|
||||
*/
|
||||
void NewGRFProfiler::BeginResolve(const ResolverObject &resolver)
|
||||
{
|
||||
using namespace std::chrono;
|
||||
this->cur_call.root_sprite = resolver.root_spritegroup->nfo_line;
|
||||
this->cur_call.subs = 0;
|
||||
this->cur_call.time = (uint32)time_point_cast<microseconds>(high_resolution_clock::now()).time_since_epoch().count();
|
||||
this->cur_call.tick = _tick_counter;
|
||||
this->cur_call.cb = resolver.callback;
|
||||
this->cur_call.feat = resolver.GetFeature();
|
||||
this->cur_call.item = resolver.GetDebugID();
|
||||
}
|
||||
|
||||
/**
|
||||
* Capture the completion of a sprite group resolution.
|
||||
*/
|
||||
void NewGRFProfiler::EndResolve(const SpriteGroup *result)
|
||||
{
|
||||
using namespace std::chrono;
|
||||
this->cur_call.time = (uint32)time_point_cast<microseconds>(high_resolution_clock::now()).time_since_epoch().count() - this->cur_call.time;
|
||||
|
||||
if (result == nullptr) {
|
||||
this->cur_call.result = 0;
|
||||
} else if (result->type == SGT_CALLBACK) {
|
||||
this->cur_call.result = static_cast<const CallbackResultSpriteGroup *>(result)->result;
|
||||
} else if (result->type == SGT_RESULT) {
|
||||
this->cur_call.result = GetSpriteLocalID(static_cast<const ResultSpriteGroup *>(result)->sprite);
|
||||
} else {
|
||||
this->cur_call.result = result->nfo_line;
|
||||
}
|
||||
|
||||
this->calls.push_back(this->cur_call);
|
||||
}
|
||||
|
||||
/**
|
||||
* Capture a recursive sprite group resolution.
|
||||
*/
|
||||
void NewGRFProfiler::RecursiveResolve()
|
||||
{
|
||||
this->cur_call.subs += 1;
|
||||
}
|
||||
|
||||
void NewGRFProfiler::Start()
|
||||
{
|
||||
this->Abort();
|
||||
this->active = true;
|
||||
this->start_tick = _tick_counter;
|
||||
}
|
||||
|
||||
uint32 NewGRFProfiler::Finish()
|
||||
{
|
||||
if (!this->active) return 0;
|
||||
|
||||
if (this->calls.empty()) {
|
||||
IConsolePrintF(CC_DEBUG, "Finished profile of NewGRF [%08X], no events collected, not writing a file", BSWAP32(this->grffile->grfid));
|
||||
return 0;
|
||||
}
|
||||
|
||||
std::string filename = this->GetOutputFilename();
|
||||
IConsolePrintF(CC_DEBUG, "Finished profile of NewGRF [%08X], writing %u events to %s", BSWAP32(this->grffile->grfid), (uint)this->calls.size(), filename.c_str());
|
||||
|
||||
FILE *f = FioFOpenFile(filename.c_str(), "wt", Subdirectory::NO_DIRECTORY);
|
||||
FileCloser fcloser(f);
|
||||
|
||||
uint32 total_microseconds = 0;
|
||||
|
||||
fputs("Tick,Sprite,Feature,Item,CallbackID,Microseconds,Depth,Result\n", f);
|
||||
for (const Call &c : this->calls) {
|
||||
fprintf(f, "%u,%u,0x%X,%d,0x%X,%u,%u,%u\n", c.tick, c.root_sprite, c.feat, c.item, (uint)c.cb, c.time, c.subs, c.result);
|
||||
total_microseconds += c.time;
|
||||
}
|
||||
|
||||
this->Abort();
|
||||
|
||||
return total_microseconds;
|
||||
}
|
||||
|
||||
void NewGRFProfiler::Abort()
|
||||
{
|
||||
this->active = false;
|
||||
this->calls.clear();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get name of the file that will be written.
|
||||
* @return File name of profiling output file.
|
||||
*/
|
||||
std::string NewGRFProfiler::GetOutputFilename() const
|
||||
{
|
||||
time_t write_time = time(nullptr);
|
||||
|
||||
char timestamp[16] = {};
|
||||
strftime(timestamp, lengthof(timestamp), "%Y%m%d-%H%M", localtime(&write_time));
|
||||
|
||||
char filepath[MAX_PATH] = {};
|
||||
seprintf(filepath, lastof(filepath), "%sgrfprofile-%s-%08X.csv", FiosGetScreenshotDir(), timestamp, BSWAP32(this->grffile->grfid));
|
||||
|
||||
return std::string(filepath);
|
||||
}
|
||||
|
||||
uint32 NewGRFProfiler::FinishAll()
|
||||
{
|
||||
int max_ticks = 0;
|
||||
uint32 total_microseconds = 0;
|
||||
for (NewGRFProfiler &pr : _newgrf_profilers) {
|
||||
if (pr.active) {
|
||||
total_microseconds += pr.Finish();
|
||||
max_ticks = max(max_ticks, _tick_counter - pr.start_tick);
|
||||
}
|
||||
}
|
||||
|
||||
if (total_microseconds > 0 && max_ticks > 0) {
|
||||
IConsolePrintF(CC_DEBUG, "Total NewGRF callback processing: %u microseconds over %d ticks", total_microseconds, max_ticks);
|
||||
}
|
||||
|
||||
_newgrf_profile_end_date = MAX_DAY;
|
||||
|
||||
return total_microseconds;
|
||||
}
|
||||
@ -0,0 +1,63 @@
|
||||
/*
|
||||
* This file is part of OpenTTD.
|
||||
* 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.
|
||||
* 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.
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
/** @file newgrf_profiling.h Profiling of NewGRF action 2 handling. */
|
||||
|
||||
#ifndef NEWGRF_PROFILING_H
|
||||
#define NEWGRF_PROFILING_H
|
||||
|
||||
#include "stdafx.h"
|
||||
#include "date_type.h"
|
||||
#include "newgrf.h"
|
||||
#include "newgrf_callbacks.h"
|
||||
#include "newgrf_spritegroup.h"
|
||||
|
||||
#include <vector>
|
||||
#include <string>
|
||||
#include <memory>
|
||||
|
||||
/**
|
||||
* Callback profiler for NewGRF development
|
||||
*/
|
||||
struct NewGRFProfiler {
|
||||
NewGRFProfiler(const GRFFile *grffile);
|
||||
~NewGRFProfiler();
|
||||
|
||||
void BeginResolve(const ResolverObject &resolver);
|
||||
void EndResolve(const SpriteGroup *result);
|
||||
void RecursiveResolve();
|
||||
|
||||
void Start();
|
||||
uint32 Finish();
|
||||
void Abort();
|
||||
std::string GetOutputFilename() const;
|
||||
|
||||
static uint32 FinishAll();
|
||||
|
||||
/** Measurement of a single sprite group resolution */
|
||||
struct Call {
|
||||
uint32 root_sprite; ///< Pseudo-sprite index in GRF file
|
||||
uint32 item; ///< Local ID of item being resolved for
|
||||
uint32 result; ///< Result of callback
|
||||
uint32 subs; ///< Sub-calls to other sprite groups
|
||||
uint32 time; ///< Time taken for resolution (microseconds)
|
||||
uint16 tick; ///< Game tick
|
||||
CallbackID cb; ///< Callback ID
|
||||
GrfSpecFeature feat; ///< GRF feature being resolved for
|
||||
};
|
||||
|
||||
const GRFFile *grffile; ///< Which GRF is being profiled
|
||||
bool active; ///< Is this profiler collecting data
|
||||
uint16 start_tick; ///< Tick number this profiler was started on
|
||||
Call cur_call; ///< Data for current call in progress
|
||||
std::vector<Call> calls; ///< All calls collected so far
|
||||
};
|
||||
|
||||
extern std::vector<NewGRFProfiler> _newgrf_profilers;
|
||||
extern Date _newgrf_profile_end_date;
|
||||
|
||||
#endif /* NEWGRF_PROFILING_H */
|
||||
Loading…
Reference in New Issue