Skip to content

Commit

Permalink
Add a precondition check for Layout::from_size_align_unchecked
Browse files Browse the repository at this point in the history
  • Loading branch information
saethlin committed Aug 19, 2024
1 parent 9704e2d commit bef7be0
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 7 deletions.
32 changes: 27 additions & 5 deletions core/src/alloc/layout.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

use crate::error::Error;
use crate::ptr::{Alignment, NonNull};
use crate::{cmp, fmt, mem};
use crate::{assert_unsafe_precondition, cmp, fmt, mem};

// While this function is used in one place and its implementation
// could be inlined, the previous attempts to do so made rustc
Expand Down Expand Up @@ -66,12 +66,25 @@ impl Layout {
#[inline]
#[rustc_allow_const_fn_unstable(ptr_alignment_type)]
pub const fn from_size_align(size: usize, align: usize) -> Result<Self, LayoutError> {
if !align.is_power_of_two() {
return Err(LayoutError);
if Layout::is_size_align_valid(size, align) {
// SAFETY: Layout::is_size_align_valid checks the preconditions for this call.
let layout = unsafe { Layout::from_size_align_unchecked(size, align) };
Ok(layout)
} else {
Err(LayoutError)
}
}

// SAFETY: just checked that align is a power of two.
Layout::from_size_alignment(size, unsafe { Alignment::new_unchecked(align) })
const fn is_size_align_valid(size: usize, align: usize) -> bool {
if !align.is_power_of_two() {
return false;
}
// SAFETY: Precondition checked directly above.
let align = unsafe { Alignment::new_unchecked(align) };
if size > Self::max_size_for_align(align) {
return false;
}
true
}

#[inline(always)]
Expand Down Expand Up @@ -116,6 +129,15 @@ impl Layout {
#[inline]
#[rustc_allow_const_fn_unstable(ptr_alignment_type)]
pub const unsafe fn from_size_align_unchecked(size: usize, align: usize) -> Self {
assert_unsafe_precondition!(
check_library_ub,
"Layout::from_size_align_unchecked requires that align is a power of 2 \
and the rounded-up allocation size does not exceed isize::MAX",
(
size: usize = size,
align: usize = align,
) => Layout::is_size_align_valid(size, align)
);
// SAFETY: the caller is required to uphold the preconditions.
unsafe { Layout { size, align: Alignment::new_unchecked(align) } }
}
Expand Down
2 changes: 0 additions & 2 deletions core/src/result.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1481,7 +1481,6 @@ impl<T, E> Result<T, E> {
#[track_caller]
#[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
pub unsafe fn unwrap_unchecked(self) -> T {
debug_assert!(self.is_ok());
match self {
Ok(t) => t,
// SAFETY: the safety contract must be upheld by the caller.
Expand Down Expand Up @@ -1513,7 +1512,6 @@ impl<T, E> Result<T, E> {
#[track_caller]
#[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
pub unsafe fn unwrap_err_unchecked(self) -> E {
debug_assert!(self.is_err());
match self {
// SAFETY: the safety contract must be upheld by the caller.
Ok(_) => unsafe { hint::unreachable_unchecked() },
Expand Down

0 comments on commit bef7be0

Please sign in to comment.