Merge pull request #578 from OpenVicProject/add/elapsed-time-callbacks

Add elapsed time callbacks to GameManager

Author: Spartan322

src/headless/main.cpp

@@ -146,9 +146,12 @@ static bool run_headless(fs::path const& root, memory::vector<memory::string>& m
 	Dataloader::path_vector_t roots = { root };
 	Dataloader::path_vector_t replace_paths = {};
 
-	GameManager game_manager { []() {
-		Logger::info("State updated");
-	} };
+	GameManager game_manager {
+		[] {
+			Logger::info("State updated");
+		},
+		nullptr, nullptr
+	};
 
 	Logger::info("Commit hash: ", GameManager::get_commit_hash());
 

src/openvic-simulation/GameManager.cpp

@@ -1,17 +1,45 @@
 #include "GameManager.hpp"
 
+#include <chrono>
+
+#include <cstddef>
 #include <string_view>
 
 #include "openvic-simulation/dataloader/Dataloader.hpp"
 #include "openvic-simulation/utility/Logger.hpp"
 
 using namespace OpenVic;
 
+static std::chrono::time_point elapsed_time_begin = std::chrono::high_resolution_clock::now();
+
+GameManager::elapsed_time_getter_func_t GameManager::get_elapsed_usec_time_callback = []() -> uint64_t {
+	std::chrono::time_point current = std::chrono::high_resolution_clock::now();
+	return std::chrono::duration_cast<std::chrono::microseconds>(current - elapsed_time_begin).count();
+};
+
+GameManager::elapsed_time_getter_func_t GameManager::get_elapsed_msec_time_callback = []() -> uint64_t {
+	std::chrono::time_point current = std::chrono::high_resolution_clock::now();
+	return std::chrono::duration_cast<std::chrono::milliseconds>(current - elapsed_time_begin).count();
+};
+
 GameManager::GameManager(
-	InstanceManager::gamestate_updated_func_t new_gamestate_updated_callback
+	InstanceManager::gamestate_updated_func_t new_gamestate_updated_callback,
+	elapsed_time_getter_func_t new_get_elapsed_usec_callback,
+	elapsed_time_getter_func_t new_get_elapsed_msec_callback
 ) : gamestate_updated_callback {
 		new_gamestate_updated_callback ? std::move(new_gamestate_updated_callback) : []() {}
-	}, definitions_loaded { false }, mod_descriptors_loaded { false } {}
+	}, definitions_loaded { false }, mod_descriptors_loaded { false } {
+	if (new_get_elapsed_usec_callback) {
+		get_elapsed_usec_time_callback = { std::move(new_get_elapsed_usec_callback) };
+	}
+	if (new_get_elapsed_msec_callback) {
+		get_elapsed_msec_time_callback = { std::move(new_get_elapsed_msec_callback) };
+	}
+
+	if (bool(new_get_elapsed_usec_callback) != bool(new_get_elapsed_msec_callback)) {
+		Logger::warning("Only one of the elapsed time callbacks was set.");
+	}
+}
 
 GameManager::~GameManager() {
 	if (instance_manager) {
@@ -223,3 +251,11 @@ bool GameManager::update_clock() {
 
 	return instance_manager->update_clock();
 }
+
+uint64_t GameManager::get_elapsed_microseconds() {
+	return get_elapsed_usec_time_callback();
+}
+
+uint64_t GameManager::get_elapsed_milliseconds() {
+	return get_elapsed_msec_time_callback();
+}

src/openvic-simulation/GameManager.hpp

@@ -11,9 +11,16 @@
 #include "openvic-simulation/gen/commit_info.gen.hpp"
 #include "openvic-simulation/utility/ForwardableSpan.hpp"
 
+#include <function2/function2.hpp>
+
 namespace OpenVic {
 	struct GameManager {
+		using elapsed_time_getter_func_t = fu2::function_base<true, true, fu2::capacity_none, false, false, uint64_t() const>;
+
 	private:
+		static elapsed_time_getter_func_t get_elapsed_usec_time_callback;
+		static elapsed_time_getter_func_t get_elapsed_msec_time_callback;
+
 		GameRulesManager PROPERTY(game_rules_manager);
 		Dataloader PROPERTY(dataloader);
 		DefinitionManager PROPERTY(definition_manager);
@@ -26,7 +33,9 @@ namespace OpenVic {
 
 	public:
 		GameManager(
-			InstanceManager::gamestate_updated_func_t new_gamestate_updated_callback
+			InstanceManager::gamestate_updated_func_t new_gamestate_updated_callback,
+			elapsed_time_getter_func_t new_get_elapsed_usec_callback,
+			elapsed_time_getter_func_t new_get_elapsed_msec_callback
 		);
 		~GameManager();
 
@@ -71,5 +80,8 @@ namespace OpenVic {
 		static constexpr uint64_t get_commit_timestamp() {
 			return SIM_COMMIT_TIMESTAMP;
 		}
+
+		static uint64_t get_elapsed_microseconds();
+		static uint64_t get_elapsed_milliseconds();
 	};
 }

tests/benchmarks/src/dataloading/Dataloading.cpp

@@ -11,7 +11,7 @@ TEST_CASE("Dataloading benchmark", "[benchmarks][benchmark-dataloading]") {
 	Dataloader::path_vector_t roots { root };
 
 	ankerl::nanobench::Bench().epochs(10).run("Dataloading", [&] {
-		OpenVic::GameManager game_manager { []() {} };
+		OpenVic::GameManager game_manager { []() {}, nullptr, nullptr };
 
 		game_manager.set_base_path(roots);
 		game_manager.load_definitions(