forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

prevent memory leak when dropping ParallelSystemContainer (#2176)

Browse Source 
`ParallelSystemContainer`'s `system` pointer was extracted from box, but it was never deallocated. This change adds missing drop implementation that cleans up that memory.
This commit is contained in:
Paweł Grabarz 2021-05-17 20:01:25 +00:00
parent 1d652941ea
commit 3cf10e2ef2
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
crates/bevy_ecs/src/schedule/system_container.rs
View File

@ -7,7 +7,7 @@ use crate::{
}, },
system::{ExclusiveSystem, System}, system::{ExclusiveSystem, System},
}; };
use std::{borrow::Cow, ptr::NonNull}; use std::{borrow::Cow, cell::UnsafeCell};
/// System metadata like its name, labels, order requirements and component access. /// System metadata like its name, labels, order requirements and component access.
pub trait SystemContainer: GraphNode<Label = BoxedSystemLabel> { pub trait SystemContainer: GraphNode<Label = BoxedSystemLabel> {
@ -106,7 +106,7 @@ impl SystemContainer for ExclusiveSystemContainer {
} }
pub struct ParallelSystemContainer { pub struct ParallelSystemContainer {
system: NonNull<dyn System<In = (), Out = ()>>, system: Box<UnsafeCell<dyn System<In = (), Out = ()>>>,
pub(crate) run_criteria_index: Option<usize>, pub(crate) run_criteria_index: Option<usize>,
pub(crate) run_criteria_label: Option<BoxedRunCriteriaLabel>, pub(crate) run_criteria_label: Option<BoxedRunCriteriaLabel>,
pub(crate) should_run: bool, pub(crate) should_run: bool,
@ -123,7 +123,8 @@ unsafe impl Sync for ParallelSystemContainer {}
impl ParallelSystemContainer { impl ParallelSystemContainer {
pub(crate) fn from_descriptor(descriptor: ParallelSystemDescriptor) -> Self { pub(crate) fn from_descriptor(descriptor: ParallelSystemDescriptor) -> Self {
ParallelSystemContainer { ParallelSystemContainer {
system: unsafe { NonNull::new_unchecked(Box::into_raw(descriptor.system)) }, // SAFE: it is fine to wrap inner value with UnsafeCell, as it is repr(transparent)
system: unsafe { Box::from_raw(Box::into_raw(descriptor.system) as *mut _) },
should_run: false, should_run: false,
run_criteria_index: None, run_criteria_index: None,
run_criteria_label: None, run_criteria_label: None,
@ -140,20 +141,19 @@ impl ParallelSystemContainer {
} }
pub fn system(&self) -> &dyn System<In = (), Out = ()> { pub fn system(&self) -> &dyn System<In = (), Out = ()> {
// SAFE: statically enforced shared access. // SAFE: statically enforced shared access
unsafe { self.system.as_ref() } unsafe { self.system.get().as_ref().unwrap() }
} }
pub fn system_mut(&mut self) -> &mut dyn System<In = (), Out = ()> { pub fn system_mut(&mut self) -> &mut dyn System<In = (), Out = ()> {
// SAFE: statically enforced exclusive access. self.system.get_mut()
unsafe { self.system.as_mut() }
} }
/// # Safety /// # Safety
/// Ensure no other borrows exist along with this one. /// Ensure no other borrows exist along with this one.
#[allow(clippy::mut_from_ref)] #[allow(clippy::mut_from_ref)]
pub unsafe fn system_mut_unsafe(&self) -> &mut dyn System<In = (), Out = ()> { pub unsafe fn system_mut_unsafe(&self) -> &mut dyn System<In = (), Out = ()> {
&mut *self.system.as_ptr() self.system.get().as_mut().unwrap()
} }
pub fn should_run(&self) -> bool { pub fn should_run(&self) -> bool {