Changes necessary for hot reload to work

Author: dsnopek

gdextension/gdextension_interface.h

@@ -258,13 +258,15 @@ typedef const GDExtensionPropertyInfo *(*GDExtensionClassGetPropertyList)(GDExte
 typedef void (*GDExtensionClassFreePropertyList)(GDExtensionClassInstancePtr p_instance, const GDExtensionPropertyInfo *p_list);
 typedef GDExtensionBool (*GDExtensionClassPropertyCanRevert)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name);
 typedef GDExtensionBool (*GDExtensionClassPropertyGetRevert)(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
+typedef GDExtensionBool (*GDExtensionClassValidateProperty)(GDExtensionClassInstancePtr p_instance, GDExtensionPropertyInfo *p_property);
 typedef void (*GDExtensionClassNotification)(GDExtensionClassInstancePtr p_instance, int32_t p_what); // Deprecated. Use GDExtensionClassNotification2 instead.
 typedef void (*GDExtensionClassNotification2)(GDExtensionClassInstancePtr p_instance, int32_t p_what, GDExtensionBool p_reversed);
 typedef void (*GDExtensionClassToString)(GDExtensionClassInstancePtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr p_out);
 typedef void (*GDExtensionClassReference)(GDExtensionClassInstancePtr p_instance);
 typedef void (*GDExtensionClassUnreference)(GDExtensionClassInstancePtr p_instance);
 typedef void (*GDExtensionClassCallVirtual)(GDExtensionClassInstancePtr p_instance, const GDExtensionConstTypePtr *p_args, GDExtensionTypePtr r_ret);
 typedef GDExtensionObjectPtr (*GDExtensionClassCreateInstance)(void *p_userdata);
+typedef GDExtensionClassInstancePtr (*GDExtensionClassRecreateInstance)(void *p_userdata, GDExtensionObjectPtr p_object);
 typedef void (*GDExtensionClassFreeInstance)(void *p_userdata, GDExtensionClassInstancePtr p_instance);
 typedef GDExtensionClassCallVirtual (*GDExtensionClassGetVirtual)(void *p_userdata, GDExtensionConstStringNamePtr p_name);
 
@@ -298,12 +300,14 @@ typedef struct {
 GDExtensionClassFreePropertyList free_property_list_func;
 GDExtensionClassPropertyCanRevert property_can_revert_func;
 GDExtensionClassPropertyGetRevert property_get_revert_func;
+GDExtensionClassValidateProperty validate_property_func;
 GDExtensionClassNotification2 notification_func;
 GDExtensionClassToString to_string_func;
 GDExtensionClassReference reference_func;
 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;
 GDExtensionClassGetVirtual get_virtual_func; // Queries a virtual function by name and returns a callback to invoke the requested virtual function.
 GDExtensionClassGetRID get_rid_func;
 void *class_userdata; // Per-class user data, later accessible in instance bindings.
@@ -374,6 +378,7 @@ typedef GDExtensionBool (*GDExtensionScriptInstanceGet)(GDExtensionScriptInstanc
 typedef const GDExtensionPropertyInfo *(*GDExtensionScriptInstanceGetPropertyList)(GDExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count);
 typedef void (*GDExtensionScriptInstanceFreePropertyList)(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionPropertyInfo *p_list);
 typedef GDExtensionVariantType (*GDExtensionScriptInstanceGetPropertyType)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionBool *r_is_valid);
+typedef GDExtensionBool (*GDExtensionScriptInstanceValidateProperty)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionPropertyInfo *p_property);
 
 typedef GDExtensionBool (*GDExtensionScriptInstancePropertyCanRevert)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name);
 typedef GDExtensionBool (*GDExtensionScriptInstancePropertyGetRevert)(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
@@ -460,6 +465,7 @@ typedef struct {
 GDExtensionScriptInstanceGetMethodList get_method_list_func;
 GDExtensionScriptInstanceFreeMethodList free_method_list_func;
 GDExtensionScriptInstanceGetPropertyType get_property_type_func;
+GDExtensionScriptInstanceValidateProperty validate_property_func;
 
 GDExtensionScriptInstanceHasMethod has_method_func;
 

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;
 
@@ -104,6 +113,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
@@ -187,6 +207,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()) { \

include/godot_cpp/core/class_db.hpp

@@ -192,6 +192,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, // GDExtensionClassGetRID get_rid;
 (void *)&T::get_class_static(), // void *class_userdata;

src/classes/wrapped.cpp

@@ -49,6 +49,23 @@ 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;
+}
+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()));
 }
 

src/core/class_db.cpp

@@ -354,6 +354,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());
 }
 }
 

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):

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'"])