feat: ecsact codegen plugin for optimization

Author: zaucy

ecsact/entt/detail/registry_info.hh

@@ -13,6 +13,7 @@
 #include "ecsact/entt/system_view.hh"
 #include "ecsact/entt/event_markers.hh"
 #include "ecsact/entt/entity.hh"
+#include "ecsact/entt/execution.hh"
 #include "ecsact/entt/detail/internal_markers.hh"
 
 #include "meta_util.hh"
@@ -32,6 +33,7 @@ struct registry_info {
 		using ecsact::entt::component_removed;
 		using ecsact::entt::detail::beforechange_storage;
 		using ecsact::entt::detail::mp_for_each_available_component;
+		using ecsact::entt::detail::mp_for_each_available_system_like;
 		using ecsact::entt::detail::temp_storage;
 
 		mp_for_each_available_component<package>([&]<typename C>(C) {
@@ -44,6 +46,10 @@ struct registry_info {
 				registry.storage<beforechange_storage<C>>();
 			}
 		});
+
+		mp_for_each_available_system_like<package>([&]<typename S>(S) {
+			::ecsact::entt::prepare_system_like<S>(registry);
+		});
 	}
 
 	template<typename C>

ecsact/entt/execution.hh

@@ -0,0 +1,48 @@
+#pragma once
+
+#include <vector>
+#include <unordered_map>
+#include "ecsact/runtime/common.h"
+#include "entt/entity/registry.hpp"
+
+namespace ecsact::entt {
+
+/**
+ * Executes system implementation for @tp System.
+ *
+ * NOTE: Template specializations are made available via the codegen plugin
+ *       `ecsact_rt_entt_codegen`.
+ */
+template<typename System>
+auto execute_system(::entt::registry&) -> void;
+
+/**
+ * Executes action implementation for @tp Action for every action in @p
+ * action_range.
+ *
+ * NOTE: Template specializations are made available via the codegen plugin
+ *       `ecsact_rt_entt_codegen`.
+ */
+template<typename Action>
+auto execute_actions(::entt::registry&, auto&& action_range) -> void;
+
+/**
+ * Executes all systems/actions
+ *
+ * NOTE: Implementation is generated by the `ecsact_rt_entt_codegen` plugin
+ */
+auto execute_systems(
+	::entt::registry& registry,
+	int32_t           execution_count,
+	std::unordered_map<ecsact_action_id, std::vector<const void*>> actions
+) -> void;
+
+/**
+ * Allocates EnTT groups and storage if necessary for the system or action.
+ * NOTE: Template specializations are made available via the codegen plugin
+ *       `ecsact_rt_entt_codegen`.
+ */
+template<typename SystemLike>
+auto prepare_system_like(::entt::registry&) -> void;
+
+} // namespace ecsact::entt

ecsact/entt/runtime.hh

@@ -1298,6 +1298,16 @@ public:
 		}
 		return true;
 	}
+
+	auto get_system_execution_impl(ecsact_system_like_id sys_like_id)
+		-> ecsact_system_execution_impl {
+		auto itr = _sys_impl_fns.find(sys_like_id);
+		if(itr != _sys_impl_fns.end()) {
+			return itr->second;
+		}
+
+		return nullptr;
+	}
 #endif
 
 	ecsact_execute_systems_error execute_systems(

rt_entt_codegen/BUILD.bazel

@@ -0,0 +1,17 @@
+load("//bazel:copts.bzl", "copts")
+load("@ecsact_runtime//:codegen_plugin.bzl", "cc_ecsact_codegen_plugin")
+
+package(default_visibility = ["//visibility:public"])
+
+cc_ecsact_codegen_plugin(
+    name = "ecsact_rt_entt_codegen",
+    srcs = glob(["*.cc", "*.hh"]),
+    copts = copts,
+    output_extension = "rt_entt.hh",
+    deps = ["@ecsact_lang_cpp//:support"],
+)
+
+alias(
+    name = "rt_entt_codegen",
+    actual = ":ecsact_rt_entt_codegen",
+)

rt_entt_codegen/ecsact_entt_details.cc

@@ -0,0 +1,87 @@
+#include "ecsact_entt_details.hh"
+
+#include <cassert>
+#include "ecsact/codegen_plugin.h"
+#include "ecsact/codegen_plugin.hh"
+#include "ecsact/lang-support/lang-cc.hh"
+#include "ecsact/runtime/meta.hh"
+
+static auto collect_top_level_systems( //
+	ecsact_package_id    pkg_id,
+	ecsact_entt_details& details
+) -> void {
+	auto deps = ecsact::meta::get_dependencies(pkg_id);
+	for(auto dep : deps) {
+		auto tl_sys_ids = ecsact::meta::get_top_level_systems(dep);
+		details.top_execution_order.insert(
+			details.top_execution_order.end(),
+			tl_sys_ids.begin(),
+			tl_sys_ids.end()
+		);
+	}
+
+	auto main_tl_sys_ids = ecsact::meta::get_top_level_systems(pkg_id);
+	details.top_execution_order.insert(
+		details.top_execution_order.end(),
+		main_tl_sys_ids.begin(),
+		main_tl_sys_ids.end()
+	);
+}
+
+auto ecsact_entt_system_details::from_system_like( //
+	ecsact_system_like_id sys_like_id
+) -> ecsact_entt_system_details {
+	auto details = ecsact_entt_system_details{};
+	auto caps = ecsact::meta::system_capabilities(sys_like_id);
+
+	for(auto&& [comp_id, cap] : caps) {
+		switch(cap) {
+			case ECSACT_SYS_CAP_INCLUDE:
+				details.tag_comps.insert(comp_id);
+			case ECSACT_SYS_CAP_READONLY:
+			case ECSACT_SYS_CAP_WRITEONLY:
+			case ECSACT_SYS_CAP_READWRITE:
+			case ECSACT_SYS_CAP_OPTIONAL:
+			case ECSACT_SYS_CAP_OPTIONAL_READONLY:
+			case ECSACT_SYS_CAP_OPTIONAL_WRITEONLY:
+			case ECSACT_SYS_CAP_OPTIONAL_READWRITE:
+			case ECSACT_SYS_CAP_REMOVES:
+				details.get_comps.insert(comp_id);
+				break;
+			case ECSACT_SYS_CAP_EXCLUDE:
+			case ECSACT_SYS_CAP_ADDS:
+				details.exclude_comps.insert(comp_id);
+				break;
+		}
+	}
+
+	for(auto&& [comp_id, _] : caps) {
+		// Santity check to make sure we've not missing any system comp IDs
+		assert(
+			details.get_comps.contains(comp_id) ||
+			details.exclude_comps.contains(comp_id)
+		);
+	}
+
+	return details;
+}
+
+auto ecsact_entt_details::from_package( //
+	ecsact_package_id pkg_id
+) -> ecsact_entt_details {
+	auto details = ecsact_entt_details{};
+
+	collect_top_level_systems(pkg_id, details);
+
+	for(auto sys_id : details.top_execution_order) {
+	}
+
+	for(auto sys_id : details.top_execution_order) {
+		assert(
+			details.view_systems.contains(sys_id) ||
+			details.group_systems.contains(sys_id)
+		);
+	}
+
+	return details;
+}

rt_entt_codegen/ecsact_entt_details.hh

@@ -0,0 +1,38 @@
+#pragma once
+
+#include <vector>
+#include <unordered_set>
+#include <unordered_map>
+#include <ecsact/runtime/common.h>
+
+struct ecsact_entt_system_details {
+	/** Components/transients included in EnTT view/group */
+	std::unordered_set<ecsact_component_like_id> get_comps;
+
+	/** Components/transients excluded in EnTT view/group */
+	std::unordered_set<ecsact_component_like_id> exclude_comps;
+
+	/** Included in EnTT view/group, but is a tag component */
+	std::unordered_set<ecsact_component_like_id> tag_comps;
+
+	static auto from_system_like( //
+		ecsact_system_like_id sys_like_id
+	) -> ecsact_entt_system_details;
+};
+
+/**
+ * Details about an the main Ecsact package in relation to EnTT runtime. Package
+ * dependencies are flattened.
+ */
+struct ecsact_entt_details {
+	// Systems/actions we've decided will use an EnTT group
+	std::unordered_set<ecsact_system_like_id> group_systems;
+
+	// Systems/actions we've decided will use an Entt view
+	std::unordered_set<ecsact_system_like_id> view_systems;
+
+	// Top level sysetms/actions in execution order
+	std::vector<ecsact_system_like_id> top_execution_order;
+
+	static auto from_package(ecsact_package_id pkg_id) -> ecsact_entt_details;
+};

rt_entt_codegen/rt_entt_codegen.cc

@@ -0,0 +1,53 @@
+#include <string>
+#include <filesystem>
+#include "ecsact/runtime/meta.hh"
+#include "ecsact/codegen_plugin.h"
+#include "ecsact/codegen_plugin.hh"
+#include "ecsact/lang-support/lang-cc.hh"
+
+#include "ecsact_entt_details.hh"
+
+namespace fs = std::filesystem;
+
+constexpr auto GENERATED_FILE_DISCLAIMER = R"(
+// GENERATED FILE - DO NOT EDIT
+)";
+
+constexpr auto MAIN_PACKAGE_ONLY_DISCLAIMER = R"(
+// Purposely empty. ecsact_rt_entt_codegen is only for the 'main' package
+)";
+
+void ecsact_codegen_plugin(
+	ecsact_package_id         package_id,
+	ecsact_codegen_write_fn_t write_fn
+) {
+	using ecsact::cc_lang_support::c_identifier;
+	using ecsact::cc_lang_support::cpp_identifier;
+	using ecsact::meta::get_all_system_like_ids;
+	ecsact::codegen_plugin_context ctx{package_id, write_fn};
+
+	ctx.write(GENERATED_FILE_DISCLAIMER);
+
+	if(ecsact_meta_main_package() != package_id) {
+		ctx.write(MAIN_PACKAGE_ONLY_DISCLAIMER);
+		return;
+	}
+
+	auto details = ecsact_entt_details::from_package(package_id);
+
+	auto cpp_header_path = ecsact::meta::package_file_path(package_id);
+	cpp_header_path.replace_extension(
+		cpp_header_path.extension().string() + ".hh"
+	);
+
+	auto cpp_meta_header_path = ecsact::meta::package_file_path(package_id);
+	cpp_meta_header_path.replace_extension(
+		cpp_meta_header_path.extension().string() + ".hh"
+	);
+
+	ctx.write("#include \"ecsact/entt/runtime.hh\"\n");
+	ctx.write("\n");
+	ctx.write("#include \"", cpp_header_path.filename().string(), "\"\n");
+	ctx.write("#include \"", cpp_meta_header_path.filename().string(), "\"\n");
+	ctx.write("\n");
+}

runtime/index.bzl

@@ -18,6 +18,7 @@ def ecsact_entt_runtime(name, srcs = [], deps = [], system_impls = [], tags = []
             "@ecsact_lang_cpp//cpp_systems_header_codegen",
             "@ecsact_lang_cpp//systems_header_codegen",
             "@ecsact_lang_cpp//cpp_meta_header_codegen",
+            "@ecsact_rt_entt//rt_entt_codegen",
         ],
         **kwargs
     )