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.

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

Introduce Storage::forget_elements() to fix memory leak in Matrix::generic_resize() #1416

Merged
merged 5 commits into from
Jun 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions src/base/array_storage.rs
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,12 @@ where
{
self.clone()
}

#[inline]
fn forget_elements(self) {
// No additional cleanup required.
std::mem::forget(self);
}
}

unsafe impl<T, const R: usize, const C: usize> RawStorageMut<T, Const<R>, Const<C>>
Expand Down
14 changes: 7 additions & 7 deletions src/base/default_allocator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use crate::base::array_storage::ArrayStorage;
use crate::base::dimension::Dim;
#[cfg(any(feature = "alloc", feature = "std"))]
use crate::base::dimension::{DimName, Dyn};
use crate::base::storage::{RawStorage, RawStorageMut};
use crate::base::storage::{RawStorage, RawStorageMut, Storage};
#[cfg(any(feature = "std", feature = "alloc"))]
use crate::base::vec_storage::VecStorage;
use crate::base::Scalar;
Expand Down Expand Up @@ -210,8 +210,8 @@ where

// Safety:
// - We don’t care about dropping elements because the caller is responsible for dropping things.
// - We forget `buf` so that we don’t drop the other elements.
std::mem::forget(buf);
// - We forget `buf` so that we don’t drop the other elements, but ensure the buffer itself is cleaned up.
buf.forget_elements();

res
}
Expand Down Expand Up @@ -241,8 +241,8 @@ where

// Safety:
// - We don’t care about dropping elements because the caller is responsible for dropping things.
// - We forget `buf` so that we don’t drop the other elements.
std::mem::forget(buf);
// - We forget `buf` so that we don’t drop the other elements, but ensure the buffer itself is cleaned up.
buf.forget_elements();

res
}
Expand Down Expand Up @@ -272,8 +272,8 @@ where

// Safety:
// - We don’t care about dropping elements because the caller is responsible for dropping things.
// - We forget `buf` so that we don’t drop the other elements.
std::mem::forget(buf);
// - We forget `buf` so that we don’t drop the other elements, but ensure the buffer itself is cleaned up.
buf.forget_elements();

res
}
Expand Down
5 changes: 5 additions & 0 deletions src/base/matrix_view.rs
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,11 @@ macro_rules! storage_impl(
let it = MatrixIter::new(self).cloned();
DefaultAllocator::allocate_from_iterator(nrows, ncols, it)
}

#[inline]
fn forget_elements(self) {
// No cleanup required.
}
}
)*}
);
Expand Down
3 changes: 3 additions & 0 deletions src/base/storage.rs
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,9 @@ pub unsafe trait Storage<T: Scalar, R: Dim, C: Dim = U1>: RawStorage<T, R, C> {
fn clone_owned(&self) -> Owned<T, R, C>
where
DefaultAllocator: Allocator<R, C>;

/// Drops the storage without calling the destructors on the contained elements.
fn forget_elements(self);
}

/// Trait implemented by matrix data storage that can provide a mutable access to its elements.
Expand Down
22 changes: 22 additions & 0 deletions src/base/vec_storage.rs
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,17 @@ where
{
self.clone()
}

#[inline]
fn forget_elements(mut self) {
// SAFETY: setting the length to zero is always sound, as it does not
// cause any memory to be deemed initialized. If the previous length was
// non-zero, it is equivalent to using mem::forget to leak each element.
// Then, when this function returns, self.data is dropped, freeing the
// allocated memory, but the elements are not dropped because they are
// now considered uninitialized.
unsafe { self.data.set_len(0) };
}
}

unsafe impl<T, R: DimName> RawStorage<T, R, Dyn> for VecStorage<T, R, Dyn> {
Expand Down Expand Up @@ -332,6 +343,17 @@ where
{
self.clone()
}

#[inline]
fn forget_elements(mut self) {
// SAFETY: setting the length to zero is always sound, as it does not
// cause any memory to be deemed initialized. If the previous length was
// non-zero, it is equivalent to using mem::forget to leak each element.
// Then, when this function returns, self.data is dropped, freeing the
// allocated memory, but the elements are not dropped because they are
// now considered uninitialized.
unsafe { self.data.set_len(0) };
}
}

/*
Expand Down
Loading