Skip to content
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

Jump to bottom

[Merged by Bors] - Fix unsoundnes in insert remove and despawn #7805

Closed
wants to merge 4 commits into from
Closed

[Merged by Bors] - Fix unsoundnes in insert remove and despawn #7805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
613561f
update archetype and table row in remove op
BoxyUwU Feb 24, 2023
9bba468
update archetype and table row in insert op
BoxyUwU Feb 24, 2023
9e76c86
link PR from tests
BoxyUwU Feb 24, 2023
884b4d4
update archetype and table row in despawn op
BoxyUwU Feb 24, 2023
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
31 changes: 29 additions & 2 deletions crates/bevy_ecs/src/bundle.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,16 @@ impl<'a, 'b> BundleInserter<'a, 'b> {
InsertBundleResult::NewArchetypeSameTable { new_archetype } => {
let result = self.archetype.swap_remove(location.archetype_row);
if let Some(swapped_entity) = result.swapped_entity {
self.entities.set(swapped_entity.index(), location);
let swapped_location = self.entities.get(swapped_entity).unwrap();
self.entities.set(
swapped_entity.index(),
EntityLocation {
archetype_id: swapped_location.archetype_id,
archetype_row: location.archetype_row,
table_id: swapped_location.table_id,
table_row: swapped_location.table_row,
},
);
}
let new_location = new_archetype.allocate(entity, result.table_row);
self.entities.set(entity.index(), new_location);
Expand Down Expand Up @@ -583,7 +592,16 @@ impl<'a, 'b> BundleInserter<'a, 'b> {
} => {
let result = self.archetype.swap_remove(location.archetype_row);
if let Some(swapped_entity) = result.swapped_entity {
self.entities.set(swapped_entity.index(), location);
let swapped_location = self.entities.get(swapped_entity).unwrap();
self.entities.set(
swapped_entity.index(),
EntityLocation {
archetype_id: swapped_location.archetype_id,
archetype_row: location.archetype_row,
table_id: swapped_location.table_id,
table_row: swapped_location.table_row,
},
);
}
// PERF: store "non bundle" components in edge, then just move those to avoid
// redundant copies
Expand All @@ -608,6 +626,15 @@ impl<'a, 'b> BundleInserter<'a, 'b> {
.add(swapped_location.archetype_id.index())
};

self.entities.set(
swapped_entity.index(),
EntityLocation {
archetype_id: swapped_location.archetype_id,
archetype_row: swapped_location.archetype_row,
table_id: swapped_location.table_id,
table_row: result.table_row,
},
);
swapped_archetype
.set_entity_table_row(swapped_location.archetype_row, result.table_row);
}
Expand Down
204 changes: 201 additions & 3 deletions crates/bevy_ecs/src/world/entity_ref.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,8 +369,19 @@ impl<'w> EntityMut<'w> {
) {
let old_archetype = &mut archetypes[old_archetype_id];
let remove_result = old_archetype.swap_remove(old_location.archetype_row);
// if an entity was moved into this entity's archetype row, update its archetype row
if let Some(swapped_entity) = remove_result.swapped_entity {
entities.set(swapped_entity.index(), old_location);
let swapped_location = entities.get(swapped_entity).unwrap();

entities.set(
swapped_entity.index(),
EntityLocation {
archetype_id: swapped_location.archetype_id,
archetype_row: old_location.archetype_row,
table_id: swapped_location.table_id,
table_row: swapped_location.table_row,
Comment on lines +379 to +382
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
archetype_id: swapped_location.archetype_id,
archetype_row: old_location.archetype_row,
table_id: swapped_location.table_id,
table_row: swapped_location.table_row,
archetype_row: old_location.archetype_row,
..swapped_location

Alternatively, we should consider exposing a pub(crate) get_mut from Entities or just mutate swapped_location with the archetype row.

Copy link
Member Author

Choose a reason for hiding this comment

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

I specifically chose to construct a whole new struct here so that if we change the fields we'll get a compile error rather than it continuing to compile

Copy link
Member

Choose a reason for hiding this comment

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

That makes sense to me. Not sure if the compiler will optimize that down though. Probably worth investigating separately.

Not sure if this is worth leaving a comment so others don't try to make that change.

},
);
}
let old_table_row = remove_result.table_row;
let old_table_id = old_archetype.table_id();
Expand All @@ -393,9 +404,19 @@ impl<'w> EntityMut<'w> {
// SAFETY: move_result.new_row is a valid position in new_archetype's table
let new_location = new_archetype.allocate(entity, move_result.new_row);

// if an entity was moved into this entity's table spot, update its table row
// if an entity was moved into this entity's table row, update its table row
if let Some(swapped_entity) = move_result.swapped_entity {
let swapped_location = entities.get(swapped_entity).unwrap();

entities.set(
swapped_entity.index(),
EntityLocation {
archetype_id: swapped_location.archetype_id,
archetype_row: swapped_location.archetype_row,
table_id: swapped_location.table_id,
table_row: old_location.table_row,
Comment on lines +414 to +417
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
archetype_id: swapped_location.archetype_id,
archetype_row: swapped_location.archetype_row,
table_id: swapped_location.table_id,
table_row: old_location.table_row,
table_row: old_location.table_row,
..swapped_location

Alternatively just mutate the table_row on swapped_location.

},
);
archetypes[swapped_location.archetype_id]
.set_entity_table_row(swapped_location.archetype_row, old_table_row);
}
Expand Down Expand Up @@ -489,10 +510,19 @@ impl<'w> EntityMut<'w> {
}
let remove_result = archetype.swap_remove(location.archetype_row);
if let Some(swapped_entity) = remove_result.swapped_entity {
let swapped_location = world.entities.get(swapped_entity).unwrap();
// SAFETY: swapped_entity is valid and the swapped entity's components are
// moved to the new location immediately after.
unsafe {
world.entities.set(swapped_entity.index(), location);
world.entities.set(
swapped_entity.index(),
EntityLocation {
archetype_id: swapped_location.archetype_id,
archetype_row: location.archetype_row,
table_id: swapped_location.table_id,
table_row: swapped_location.table_row,
},
);
}
}
table_row = remove_result.table_row;
Expand All @@ -509,6 +539,19 @@ impl<'w> EntityMut<'w> {

if let Some(moved_entity) = moved_entity {
let moved_location = world.entities.get(moved_entity).unwrap();
// SAFETY: `moved_entity` is valid and the provided `EntityLocation` accurately reflects
// the current location of the entity and its component data.
unsafe {
world.entities.set(
moved_entity.index(),
EntityLocation {
archetype_id: moved_location.archetype_id,
archetype_row: moved_location.archetype_row,
table_id: moved_location.table_id,
table_row,
},
);
}
world.archetypes[moved_location.archetype_id]
.set_entity_table_row(moved_location.archetype_row, table_row);
}
Expand Down Expand Up @@ -905,4 +948,159 @@ mod tests {
// Ensure that the location has been properly updated.
assert!(entity.location() != old_location);
}

// regression test for https://github.com/bevyengine/bevy/pull/7805
#[test]
BoxyUwU marked this conversation as resolved.
Show resolved Hide resolved
fn removing_sparse_updates_archetype_row() {
#[derive(Component, PartialEq, Debug)]
struct Dense(u8);

#[derive(Component)]
#[component(storage = "SparseSet")]
struct Sparse;

let mut world = World::new();
let e1 = world.spawn((Dense(0), Sparse)).id();
let e2 = world.spawn((Dense(1), Sparse)).id();

world.entity_mut(e1).remove::<Sparse>();
assert_eq!(world.entity(e2).get::<Dense>().unwrap(), &Dense(1));
}

// regression test for https://github.com/bevyengine/bevy/pull/7805
#[test]
BoxyUwU marked this conversation as resolved.
Show resolved Hide resolved
fn removing_dense_updates_table_row() {
#[derive(Component, PartialEq, Debug)]
struct Dense(u8);

#[derive(Component)]
#[component(storage = "SparseSet")]
struct Sparse;

let mut world = World::new();
let e1 = world.spawn((Dense(0), Sparse)).id();
let e2 = world.spawn((Dense(1), Sparse)).id();

world.entity_mut(e1).remove::<Dense>();
assert_eq!(world.entity(e2).get::<Dense>().unwrap(), &Dense(1));
}

// regression test for https://github.com/bevyengine/bevy/pull/7805
#[test]
fn inserting_sparse_updates_archetype_row() {
#[derive(Component, PartialEq, Debug)]
struct Dense(u8);

#[derive(Component)]
#[component(storage = "SparseSet")]
struct Sparse;

let mut world = World::new();
let e1 = world.spawn(Dense(0)).id();
let e2 = world.spawn(Dense(1)).id();

world.entity_mut(e1).insert(Sparse);
assert_eq!(world.entity(e2).get::<Dense>().unwrap(), &Dense(1));
}

// regression test for https://github.com/bevyengine/bevy/pull/7805
#[test]
fn inserting_dense_updates_archetype_row() {
#[derive(Component, PartialEq, Debug)]
struct Dense(u8);

#[derive(Component)]
struct Dense2;

#[derive(Component)]
#[component(storage = "SparseSet")]
struct Sparse;

let mut world = World::new();
let e1 = world.spawn(Dense(0)).id();
let e2 = world.spawn(Dense(1)).id();

world.entity_mut(e1).insert(Sparse).remove::<Sparse>();

// archetype with [e2, e1]
// table with [e1, e2]

world.entity_mut(e2).insert(Dense2);

assert_eq!(world.entity(e1).get::<Dense>().unwrap(), &Dense(0));
}

#[test]
fn inserting_dense_updates_table_row() {
#[derive(Component, PartialEq, Debug)]
struct Dense(u8);

#[derive(Component)]
struct Dense2;

#[derive(Component)]
#[component(storage = "SparseSet")]
struct Sparse;

let mut world = World::new();
let e1 = world.spawn(Dense(0)).id();
let e2 = world.spawn(Dense(1)).id();

world.entity_mut(e1).insert(Sparse).remove::<Sparse>();

// archetype with [e2, e1]
// table with [e1, e2]

world.entity_mut(e1).insert(Dense2);

assert_eq!(world.entity(e2).get::<Dense>().unwrap(), &Dense(1));
}

// regression test for https://github.com/bevyengine/bevy/pull/7805
#[test]
fn despawning_entity_updates_archetype_row() {
#[derive(Component, PartialEq, Debug)]
struct Dense(u8);

#[derive(Component)]
#[component(storage = "SparseSet")]
struct Sparse;

let mut world = World::new();
let e1 = world.spawn(Dense(0)).id();
let e2 = world.spawn(Dense(1)).id();

world.entity_mut(e1).insert(Sparse).remove::<Sparse>();

// archetype with [e2, e1]
// table with [e1, e2]

world.entity_mut(e2).despawn();

assert_eq!(world.entity(e1).get::<Dense>().unwrap(), &Dense(0));
}

// regression test for https://github.com/bevyengine/bevy/pull/7805
#[test]
fn despawning_entity_updates_table_row() {
#[derive(Component, PartialEq, Debug)]
struct Dense(u8);

#[derive(Component)]
#[component(storage = "SparseSet")]
struct Sparse;

let mut world = World::new();
let e1 = world.spawn(Dense(0)).id();
let e2 = world.spawn(Dense(1)).id();

world.entity_mut(e1).insert(Sparse).remove::<Sparse>();

// archetype with [e2, e1]
// table with [e1, e2]

world.entity_mut(e1).despawn();

assert_eq!(world.entity(e2).get::<Dense>().unwrap(), &Dense(1));
}
}