Fix crash on removing added sibling in _ready

[Haydoggo]

If a Node that was added to the tree via add_sibling() was removed/reparented in its _ready() function, it would cause a crash.

Example:

extends Node

class MyNode extends Node:
	var new_parent = Engine.get_main_loop().current_scene
	func _ready() -> void:
		reparent(new_parent)

func _ready() -> void:
	await get_parent().ready
	for i in 3:
		add_sibling(MyNode.new())

[YuriSizov]

Could you provide a reproduction project?

[AThousandShips]

Better yet a formal bug report to track this in case this doesn't solve it

[Haydoggo]

Could you provide a reproduction project?

Updated description with reproduction example

[AThousandShips]

Awaiting parent ready signal seems like a huge no-no here to me

Also why is reparent allowed to be called in _ready that seems unsafe, I'd say that should be fixed just like add_child isn't permitted

Edit: realized that won't necessarily catch this as it's not blocked at this point

[Haydoggo]

I though the purpose of the _ready function is that it's run when it is safe to add children, that's also why I wait for the parent to emit its own ready signal before starting.

[AThousandShips]

It's not safe, it's explicitly saying that you can't add children to parent if you try it:

Parent node is busy setting up children, add_child() failed. Consider using add_child.call_deferred(child) instead.

You should do this in a separate function, or do the deferred call to keep this safe

Does this happen if you call reparent deferred instead?

[YuriSizov]

While we should prevent the crash, this example looks confusing. What's the real life need for this kind of logic?

• Have a node in a scene;
• When its parent becomes ready, add 3 siblings;
• But not really, because as siblings become ready, we move them elsewhere.

I don't understand the intent here, and as mentioned ready is not the best time to add children to a node. We should probably add a check to add_sibling, similar to the one we have in add_child.

As for the crash, we likely need to catch its condition with an ERR_* macro and prevent further execution.

[Haydoggo]

What's the real life need for this kind of logic?

I orignally came across this bug when making a building game. The logic was as follows:

1. Place some part, and add it to the world with add_sibling.

2. In the part's _ready function, it checks if it is touching another part, and if it is, it reparents itself so that it shares its parent with the touching part.

As for the crash, we likely need to catch its condition with an ERR_* macro and prevent further execution.

My rationale for not throwing an error here was that replacing add_sibling with get_parent().add_child in script dodges this error all together, and think it would be strange for those two options to not have the same behaviour here.

That being said, add_sibling does have slightly different behaviour to get_parent().add_child in that the node may end up with a different index depending on which one is used, so maybe we should different error handling behaviour?

What do you think @YuriSizov @AThousandShips ?
Btw I appreciate all the feedback so far, I'm just happy to help out and learn to do so better :)

[YuriSizov]

get_parent().add_child shouldn't work either, it should be blocked the same way. If this doesn't happen, there are either other differences or a bug.

I think for now we can go with #78847 and then re-evaluate if there are still problems that cause crashes for your example. Then we can either update this PR to address them, or close it as superseded if #78847 ends up fixing all of it.

[Sauermann]

As far as I understand #78834 (comment), the bug will not be completely fixed by #78847, which solves a related problem.

As mentioned above, it should be investigated, if a data.blocked++-data.blocked---section helps fixing this bug without introducing any problems.

[Haydoggo]

get_parent().add_child shouldn't work either, it should be blocked the same way. If this doesn't happen, there are either other differences or a bug.

I think the example I used in the description has caused some confusion, especially in my use of running the example in the _ready function and using await get_parent().ready. These may be bad practice but do not affect the issue at hand. Here's a simpler MRP that avoids these problems:

extends Button

class MyNode extends Node:
	func _ready() -> void:
		get_parent().remove_child(self)

func _pressed() -> void:
	add_sibling(MyNode.new())

As mentioned above, it should be investigated, if a data.blocked++-data.blocked---section helps fixing this bug without introducing any problems.

The only way to address this with data.blocked is to ensure that a parent is always blocked when adding a child.
I tried this by adding a blocking clause around _add_child_nocheck in Node::add_child, and it does fix this bug, but I'm not sure how to ensure this doesn't break anything.

Node::add_child has a check in it to make sure it's not blocked when it's called, so I assume there's some problem with blocking it right after that check?

[KoBeWi]

Can't reproduce the crash in 4.3.

[akien-mga]

Can't reproduce the crash in 4.3.

I can reproduce a crash with the script in the OP on 4.3-rc2 and latest master (9221294):

ERROR: Index p_index = 1 is out of bounds (count = 1).
   at: remove_at (./core/templates/local_vector.h:75)
ERROR: Index p_index = 2 is out of bounds (count = 1).
   at: remove_at (./core/templates/local_vector.h:75)
ERROR: FATAL: Index p_index = 2 is out of bounds (count = 2).
   at: operator[] (./core/templates/local_vector.h:177)

================================================================
handle_crash: Program crashed with signal 4
Engine version: Godot Engine v4.3.rc.custom_build (92212946532450494683929b82c450e95851a0bf)
Dumping the backtrace. Please include this when reporting the bug to the project developer.
[1] /lib64/libc.so.6(+0x40d00) [0x7f4dbc85dd00] (??:0)
[2] LocalVector<Node*, unsigned int, false, false>::operator[](unsigned int) (/home/akien/Godot/godot/./core/templates/local_vector.h:177 (discriminator 2))
[3] Node::_move_child(Node*, int, bool) (/home/akien/Godot/godot/./scene/main/node.cpp:508 (discriminator 1))
[4] Node::add_sibling(Node*, bool) (/home/akien/Godot/godot/./scene/main/node.cpp:1596)
[5] void call_with_variant_args_helper<__UnexistingClass, Node*, bool, 0ul, 1ul>(__UnexistingClass*, void (__UnexistingClass::*)(Node*, bool), Variant const**, Callable::CallError&, IndexSequence<0ul, 1ul>) (/home/akien/Godot/godot/./core/variant/binder_common.h:309)
[6] void call_with_variant_args_dv<__UnexistingClass, Node*, bool>(__UnexistingClass*, void (__UnexistingClass::*)(Node*, bool), Variant const**, int, Callable::CallError&, Vector<Variant> const&) (/home/akien/Godot/godot/./core/variant/binder_common.h:452)
[7] MethodBindT<Node*, bool>::call(Object*, Variant const**, int, Callable::CallError&) const (/home/akien/Godot/godot/./core/object/method_bind.h:345 (discriminator 1))
[8] GDScriptFunction::call(GDScriptInstance*, Variant const**, int, Callable::CallError&, GDScriptFunction::CallState*) (/home/akien/Godot/godot/./modules/gdscript/gdscript_vm.cpp:1876 (discriminator 1))
[9] GDScriptFunctionState::resume(Variant const&) (/home/akien/Godot/godot/./modules/gdscript/gdscript_function.cpp:216)
[10] GDScriptFunctionState::_signal_callback(Variant const**, int, Callable::CallError&) (/home/akien/Godot/godot/./modules/gdscript/gdscript_function.cpp:167)
[11] MethodBindVarArgTR<GDScriptFunctionState, Variant>::call(Object*, Variant const**, int, Callable::CallError&) const (/home/akien/Godot/godot/./core/object/method_bind.h:272)
[12] Object::callp(StringName const&, Variant const**, int, Callable::CallError&) (/home/akien/Godot/godot/./core/object/object.cpp:808 (discriminator 1))
[13] Callable::callp(Variant const**, int, Variant&, Callable::CallError&) const (/home/akien/Godot/godot/./core/variant/callable.cpp:69 (discriminator 1))
[14] CallableCustomBind::call(Variant const**, int, Variant&, Callable::CallError&) const (/home/akien/Godot/godot/./core/variant/callable_bind.cpp:153)
[15] Callable::callp(Variant const**, int, Variant&, Callable::CallError&) const (/home/akien/Godot/godot/./core/variant/callable.cpp:57)
[16] Object::emit_signalp(StringName const&, Variant const**, int) (/home/akien/Godot/godot/./core/object/object.cpp:1188)
[17] Node::emit_signalp(StringName const&, Variant const**, int) (/home/akien/Godot/godot/./scene/main/node.cpp:3895)
[18] Error Object::emit_signal<>(StringName const&) (/home/akien/Godot/godot/./core/object/object.h:936)
[19] Node::_propagate_ready() (/home/akien/Godot/godot/./scene/main/node.cpp:275)
[20] Node::_set_tree(SceneTree*) (/home/akien/Godot/godot/./scene/main/node.cpp:3174)
[21] SceneTree::initialize() (/home/akien/Godot/godot/./scene/main/scene_tree.cpp:449)
[22] OS_LinuxBSD::run() (/home/akien/Godot/godot/platform/linuxbsd/os_linuxbsd.cpp:958)
[23] /home/akien/Godot/godot/bin/godot.linuxbsd.editor.dev.x86_64(main+0x14b) [0x5c30c31] (/home/akien/Godot/godot/platform/linuxbsd/godot_linuxbsd.cpp:85)
[24] /lib64/libc.so.6(+0x2a088) [0x7f4dbc847088] (??:0)
[25] /lib64/libc.so.6(__libc_start_main+0x8b) [0x7f4dbc84714b] (??:0)
[26] /home/akien/Godot/godot/bin/godot.linuxbsd.editor.dev.x86_64(_start+0x25) [0x5c30a25] (??:?)
-- END OF BACKTRACE --
================================================================

[KoBeWi]

Looks like the crash does not happen if the node is a child of scene root, only when it's nested.

[KoBeWi]

Place some part, and add it to the world with add_sibling.

Why are you adding the part with add_sibling() instead of get_parent().add_child()? The crash happened, because add_sibling() changes node index. Unless you care about the specific index, you should use add_child() and add_sibling() should result in an error.