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.

1 files changed, 63 insertions, 0 deletions

diff --git a/src/newgrf_profiling.h b/src/newgrf_profiling.h
new file mode 100644
index 000000000..e5b2813f5
--- /dev/null
+++ b/src/newgrf_profiling.h
@@ -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 */