Merge pull request #1200 from dsnopek/hot-reload

Changes necessary for hot reload to work
godotengine · Sep 26, 2023 · bf2f9e2 · bf2f9e2
2 parents c44c3d5 + df84965
commit bf2f9e2
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 0 deletions.
diff --git a/gdextension/gdextension_interface.h b/gdextension/gdextension_interface.h
@@ -267,6 +267,7 @@ typedef void (*GDExtensionClassUnreference)(GDExtensionClassInstancePtr p_instan
 typedef void (*GDExtensionClassCallVirtual)(GDExtensionClassInstancePtr p_instance, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_ret);
 typedef GDExtensionObjectPtr (*GDExtensionClassCreateInstance)(void *p_class_userdata);
 typedef void (*GDExtensionClassFreeInstance)(void *p_class_userdata, GDExtensionClassInstancePtr p_instance);
+typedef GDExtensionClassInstancePtr (*GDExtensionClassRecreateInstance)(void *p_class_userdata, GDExtensionObjectPtr p_object);
 typedef GDExtensionClassCallVirtual (*GDExtensionClassGetVirtual)(void *p_class_userdata, GDExtensionConstStringNamePtr p_name);
 typedef void *(*GDExtensionClassGetVirtualCallData)(void *p_class_userdata, GDExtensionConstStringNamePtr p_name);
 typedef void (*GDExtensionClassCallVirtualWithData)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, void *p_virtual_call_userdata, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_ret);
@@ -308,6 +309,7 @@ typedef struct {
 	GDExtensionClassUnreference unreference_func;
 	GDExtensionClassCreateInstance create_instance_func; // (Default) constructor; mandatory. If the class is not instantiable, consider making it virtual or abstract.
 	GDExtensionClassFreeInstance free_instance_func; // Destructor; mandatory.
+	GDExtensionClassRecreateInstance recreate_instance_func;
 	// Queries a virtual function by name and returns a callback to invoke the requested virtual function.
 	GDExtensionClassGetVirtual get_virtual_func;
 	// Paired with `call_virtual_with_data_func`, this is an alternative to `get_virtual_func` for extensions that

diff --git a/include/godot_cpp/classes/wrapped.hpp b/include/godot_cpp/classes/wrapped.hpp
@@ -51,6 +51,15 @@ class Wrapped {
 	friend void postinitialize_handler(Wrapped *);
 
 protected:
+#ifdef HOT_RELOAD_ENABLED
+	struct RecreateInstance {
+		GDExtensionClassInstancePtr wrapper;
+		GDExtensionObjectPtr owner;
+		RecreateInstance *next;
+	};
+	inline static RecreateInstance *recreate_instance = nullptr;
+#endif
+
 	virtual const StringName *_get_extension_class_name() const; // This is needed to retrieve the class name before the godot object has its _extension and _extension_instance members assigned.
 	virtual const GDExtensionInstanceBindingCallbacks *_get_bindings_callbacks() const = 0;
 
@@ -106,6 +115,17 @@ void free_c_property_list(GDExtensionPropertyInfo *plist);
 
 } // namespace godot
 
+#ifdef HOT_RELOAD_ENABLED
+#define _GDCLASS_RECREATE(m_class, m_inherits)                                                   \
+	m_class *new_instance = (m_class *)memalloc(sizeof(m_class));                                \
+	Wrapped::RecreateInstance recreate_data = { new_instance, obj, Wrapped::recreate_instance }; \
+	Wrapped::recreate_instance = &recreate_data;                                                 \
+	memnew_placement(new_instance, m_class);                                                     \
+	return new_instance;
+#else
+#define _GDCLASS_RECREATE(m_class, m_inherits) return nullptr;
+#endif
+
 // Use this on top of your own classes.
 // Note: the trail of `***` is to keep sane diffs in PRs, because clang-format otherwise moves every `\` which makes
 // every line of the macro different
@@ -193,6 +213,10 @@ public:
 		return new_object->_owner;                                                                                                                                                     \
 	}                                                                                                                                                                                  \
                                                                                                                                                                                        \
+	static GDExtensionClassInstancePtr recreate(void *data, GDExtensionObjectPtr obj) {                                                                                                \
+		_GDCLASS_RECREATE(m_class, m_inherits);                                                                                                                                        \
+	}                                                                                                                                                                                  \
+                                                                                                                                                                                       \
 	static void notification_bind(GDExtensionClassInstancePtr p_instance, int32_t p_what, GDExtensionBool p_reversed) {                                                                \
 		if (p_instance && m_class::_get_notification()) {                                                                                                                              \
 			if (m_class::_get_notification() != m_inherits::_get_notification()) {                                                                                                     \

diff --git a/include/godot_cpp/core/class_db.hpp b/include/godot_cpp/core/class_db.hpp
@@ -201,6 +201,7 @@ void ClassDB::_register_class(bool p_virtual, bool p_exposed) {
 		nullptr, // GDExtensionClassUnreference unreference_func;
 		T::create, // GDExtensionClassCreateInstance create_instance_func; /* this one is mandatory */
 		T::free, // GDExtensionClassFreeInstance free_instance_func; /* this one is mandatory */
+		T::recreate, // GDExtensionClassRecreateInstance recreate_instance_func;
 		&ClassDB::get_virtual_func, // GDExtensionClassGetVirtual get_virtual_func;
 		nullptr, // GDExtensionClassGetVirtualCallData get_virtual_call_data_func;
 		nullptr, // GDExtensionClassCallVirtualWithData call_virtual_func;

diff --git a/src/classes/wrapped.cpp b/src/classes/wrapped.cpp
@@ -49,6 +49,25 @@ void Wrapped::_postinitialize() {
 }
 
 Wrapped::Wrapped(const StringName p_godot_class) {
+#ifdef HOT_RELOAD_ENABLED
+	if (unlikely(Wrapped::recreate_instance)) {
+		RecreateInstance *recreate_data = Wrapped::recreate_instance;
+		RecreateInstance *previous = nullptr;
+		while (recreate_data) {
+			if (recreate_data->wrapper == this) {
+				_owner = recreate_data->owner;
+				if (previous) {
+					previous->next = recreate_data->next;
+				} else {
+					Wrapped::recreate_instance = recreate_data->next;
+				}
+				return;
+			}
+			previous = recreate_data;
+			recreate_data = recreate_data->next;
+		}
+	}
+#endif
 	_owner = godot::internal::gdextension_interface_classdb_construct_object(reinterpret_cast<GDExtensionConstStringNamePtr>(p_godot_class._native_ptr()));
 }
 

diff --git a/src/core/class_db.cpp b/src/core/class_db.cpp
@@ -365,6 +365,9 @@ void ClassDB::deinitialize(GDExtensionInitializationLevel p_level) {
 		for (auto method : cl.method_map) {
 			memdelete(method.second);
 		}
+
+		classes.erase(*i);
+		class_register_order.erase((i + 1).base());
 	}
 }
 

diff --git a/tools/godotcpp.py b/tools/godotcpp.py
@@ -175,6 +175,14 @@ def options(opts, env):
         )
     )
 
+    opts.Add(
+        BoolVariable(
+            key="use_hot_reload",
+            help="Enable the extra accounting required to support hot reload.",
+            default=(env.get("target", "template_debug") != "template_release"),
+        )
+    )
+
     # Add platform options
     for pl in platforms:
         tool = Tool(pl, toolpath=["tools"])
@@ -231,6 +239,9 @@ def generate(env):
 
     print("Building for architecture " + env["arch"] + " on platform " + env["platform"])
 
+    if env["use_hot_reload"]:
+        env.Append(CPPDEFINES=["HOT_RELOAD_ENABLED"])
+
     tool = Tool(env["platform"], toolpath=["tools"])
 
     if tool is None or not tool.exists(env):

diff --git a/tools/linux.py b/tools/linux.py
@@ -14,6 +14,9 @@ def generate(env):
     if env["use_llvm"]:
         clang.generate(env)
         clangxx.generate(env)
+    elif env["use_hot_reload"]:
+        # Required for extensions to truly unload.
+        env.Append(CXXFLAGS=["-fno-gnu-unique"])
 
     env.Append(CCFLAGS=["-fPIC", "-Wwrite-strings"])
     env.Append(LINKFLAGS=["-Wl,-R,'$$ORIGIN'"])