Skip to content

Optimize BundleInserter::insert compile time #20647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
atlv24 wants to merge 7 commits into
base: main
Choose a base branch
from
+123 −66
Open

Optimize BundleInserter::insert compile time #20647

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
47bb752
pull out duplicate invocation
atlv24 Aug 18, 2025
111dd16
factor out before and after insert
atlv24 Aug 19, 2025
b45f8d5
revert world mut change
atlv24 Aug 19, 2025
9de3f38
fix ci
atlv24 Aug 21, 2025
1cd93ef
docs
atlv24 Aug 21, 2025
0983957
Merge branch 'main' into ad/optimize_insert
atlv24 Aug 21, 2025
eefb69a
conditional inline always
atlv24 Aug 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 123 additions & 66 deletions crates/bevy_ecs/src/bundle/insert.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use crate::{
observer::Observers,
query::DebugCheckedUnwrap as _,
relationship::RelationshipHookMode,
storage::{Storages, Table},
storage::{SparseSets, Storages, Table, TableRow},
world::{unsafe_world_cell::UnsafeWorldCell, World},
};

Expand Down Expand Up @@ -140,30 +140,36 @@ impl<'w> BundleInserter<'w> {
inserter
}

/// # Safety
/// `entity` must currently exist in the source archetype for this inserter. `location`
/// must be `entity`'s location in the archetype. `T` must match this [`BundleInfo`]'s type
#[inline]
pub(crate) unsafe fn insert<T: DynamicBundle>(
&mut self,
// A non-generic prelude to insert used to minimize duplicated monomorphized code.
// In combination with after_insert, this can reduce compile time of bevy by 10%.
// We inline in release to avoid a minor perf loss.
#[cfg_attr(not(debug_assertions), inline(always))]
unsafe fn before_insert<'a>(
entity: Entity,
location: EntityLocation,
bundle: T,
insert_mode: InsertMode,
caller: MaybeLocation,
relationship_hook_mode: RelationshipHookMode,
) -> (EntityLocation, T::Effect) {
let bundle_info = self.bundle_info.as_ref();
let archetype_after_insert = self.archetype_after_insert.as_ref();
let archetype = self.archetype.as_ref();

mut table: NonNull<Table>,
mut archetype: NonNull<Archetype>,
archetype_after_insert: &ArchetypeAfterBundleInsert,
world: &'a UnsafeWorldCell<'w>,
archetype_move_type: &'a mut ArchetypeMoveType,
) -> (
&'a Archetype,
EntityLocation,
&'a mut SparseSets,
&'a mut Table,
TableRow,
) {
// SAFETY: All components in the bundle are guaranteed to exist in the World
// as they must be initialized before creating the BundleInfo.
unsafe {
// SAFETY: Mutable references do not alias and will be dropped after this block
let mut deferred_world = self.world.into_deferred();
let mut deferred_world = world.into_deferred();

if insert_mode == InsertMode::Replace {
let archetype = archetype.as_ref();
if archetype.has_replace_observer() {
deferred_world.trigger_observers(
REPLACE,
Expand All @@ -182,49 +188,42 @@ impl<'w> BundleInserter<'w> {
}
}

let table = self.table.as_mut();
let table = table.as_mut();

// SAFETY: Archetype gets borrowed when running the on_replace observers above,
// so this reference can only be promoted from shared to &mut down here, after they have been ran
let archetype = self.archetype.as_mut();
let archetype = archetype.as_mut();

let (new_archetype, new_location, after_effect) = match &mut self.archetype_move_type {
match archetype_move_type {
ArchetypeMoveType::SameArchetype => {
// SAFETY: Mutable references do not alias and will be dropped after this block
let sparse_sets = {
let world = self.world.world_mut();
let world = world.world_mut();
&mut world.storages.sparse_sets
};

let after_effect = bundle_info.write_components(
table,
(
&*archetype,
location,
sparse_sets,
archetype_after_insert,
archetype_after_insert.required_components.iter(),
entity,
table,
location.table_row,
self.change_tick,
bundle,
insert_mode,
caller,
);

(archetype, location, after_effect)
)
}
ArchetypeMoveType::NewArchetypeSameTable { new_archetype } => {
let new_archetype = new_archetype.as_mut();

// SAFETY: Mutable references do not alias and will be dropped after this block
let (sparse_sets, entities) = {
let world = self.world.world_mut();
let world = world.world_mut();
(&mut world.storages.sparse_sets, &mut world.entities)
};

let result = archetype.swap_remove(location.archetype_row);
if let Some(swapped_entity) = result.swapped_entity {
let swapped_location =
// SAFETY: If the swap was successful, swapped_entity must be valid.
unsafe { entities.get(swapped_entity).debug_checked_unwrap() };
// SAFETY: If the swap was successful, swapped_entity must be valid.
unsafe { entities.get(swapped_entity).debug_checked_unwrap() };
entities.set(
swapped_entity.index(),
Some(EntityLocation {
Expand All @@ -237,20 +236,14 @@ impl<'w> BundleInserter<'w> {
}
let new_location = new_archetype.allocate(entity, result.table_row);
entities.set(entity.index(), Some(new_location));
let after_effect = bundle_info.write_components(
table,

(
&*new_archetype,
new_location,
sparse_sets,
archetype_after_insert,
archetype_after_insert.required_components.iter(),
entity,
table,
result.table_row,
self.change_tick,
bundle,
insert_mode,
caller,
);

(new_archetype, new_location, after_effect)
)
}
ArchetypeMoveType::NewArchetypeNewTable {
new_archetype,
Expand All @@ -261,7 +254,7 @@ impl<'w> BundleInserter<'w> {

// SAFETY: Mutable references do not alias and will be dropped after this block
let (archetypes_ptr, sparse_sets, entities) = {
let world = self.world.world_mut();
let world = world.world_mut();
let archetype_ptr: *mut Archetype = world.archetypes.archetypes.as_mut_ptr();
(
archetype_ptr,
Expand All @@ -272,8 +265,8 @@ impl<'w> BundleInserter<'w> {
let result = archetype.swap_remove(location.archetype_row);
if let Some(swapped_entity) = result.swapped_entity {
let swapped_location =
// SAFETY: If the swap was successful, swapped_entity must be valid.
unsafe { entities.get(swapped_entity).debug_checked_unwrap() };
// SAFETY: If the swap was successful, swapped_entity must be valid.
unsafe { entities.get(swapped_entity).debug_checked_unwrap() };
entities.set(
swapped_entity.index(),
Some(EntityLocation {
Expand All @@ -293,8 +286,8 @@ impl<'w> BundleInserter<'w> {
// If an entity was moved into this entity's table spot, update its table row.
if let Some(swapped_entity) = move_result.swapped_entity {
let swapped_location =
// SAFETY: If the swap was successful, swapped_entity must be valid.
unsafe { entities.get(swapped_entity).debug_checked_unwrap() };
// SAFETY: If the swap was successful, swapped_entity must be valid.
unsafe { entities.get(swapped_entity).debug_checked_unwrap() };

entities.set(
swapped_entity.index(),
Expand All @@ -319,27 +312,93 @@ impl<'w> BundleInserter<'w> {
}
}

let after_effect = bundle_info.write_components(
new_table,
(
&*new_archetype,
new_location,
sparse_sets,
archetype_after_insert,
archetype_after_insert.required_components.iter(),
entity,
new_table,
move_result.new_row,
self.change_tick,
bundle,
insert_mode,
caller,
);

(new_archetype, new_location, after_effect)
)
}
}
}

/// # Safety
/// `entity` must currently exist in the source archetype for this inserter. `location`
/// must be `entity`'s location in the archetype. `T` must match this [`BundleInfo`]'s type
#[inline]
pub(crate) unsafe fn insert<T: DynamicBundle>(
&mut self,
entity: Entity,
location: EntityLocation,
bundle: T,
insert_mode: InsertMode,
caller: MaybeLocation,
relationship_hook_mode: RelationshipHookMode,
) -> (EntityLocation, T::Effect) {
let archetype_after_insert = self.archetype_after_insert.as_ref();

let (new_archetype, new_location, after_effect) = {
// Non-generic prelude extracted to improve compile time by minimizing monomorphized code.
let (new_archetype, new_location, sparse_sets, table, table_row) = Self::before_insert(
entity,
location,
insert_mode,
caller,
relationship_hook_mode,
self.table,
self.archetype,
archetype_after_insert,
&self.world,
&mut self.archetype_move_type,
);

let after_effect = self.bundle_info.as_ref().write_components(
table,
sparse_sets,
archetype_after_insert,
archetype_after_insert.required_components.iter(),
entity,
table_row,
self.change_tick,
bundle,
insert_mode,
caller,
);

(new_archetype, new_location, after_effect)
};

let new_archetype = &*new_archetype;
// SAFETY: We have no outstanding mutable references to world as they were dropped
let mut deferred_world = unsafe { self.world.into_deferred() };
let deferred_world = unsafe { self.world.into_deferred() };
Copy link
Contributor

@hymm hymm Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sparse_sets and table aren't dropped yet here. You probably need to put the above code into a block

Copy link
Contributor

@hymm hymm Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be ok? The borrow checker might be smart enough to know that they aren't used after.

Copy link
Contributor Author

@atlv24 atlv24 Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, its fine, but im gonna make it explicit anyways


// Non-generic postlude extracted to improve compile time by minimizing monomorphized code.
Self::after_insert(
entity,
insert_mode,
caller,
relationship_hook_mode,
archetype_after_insert,
new_archetype,
deferred_world,
);

(new_location, after_effect)
}

// A non-generic postlude to insert used to minimize duplicated monomorphized code.
// In combination with before_insert, this can reduce compile time of bevy by 10%.
// We inline in release to avoid a minor perf loss.
#[cfg_attr(not(debug_assertions), inline(always))]
fn after_insert(
entity: Entity,
insert_mode: InsertMode,
caller: MaybeLocation,
relationship_hook_mode: RelationshipHookMode,
archetype_after_insert: &ArchetypeAfterBundleInsert,
new_archetype: &Archetype,
mut deferred_world: crate::world::DeferredWorld<'_>,
) {
// SAFETY: All components in the bundle are guaranteed to exist in the World
// as they must be initialized before creating the BundleInfo.
unsafe {
Expand Down Expand Up @@ -397,8 +456,6 @@ impl<'w> BundleInserter<'w> {
}
}
}

(new_location, after_effect)
}

#[inline]
Expand Down
Loading