Skip to content

Commit 68e555b

Browse files
committed
core: Remove panics from some Layout methods
`Layout` is often used at the core of allocation APIs and is as a result pretty sensitive to codegen in various circumstances. I was profiling `-C opt-level=z` with a wasm project recently and noticed that the `unwrap()` wasn't removed inside of `Layout`, causing the program to be much larger than it otherwise would be. If inlining were more aggressive LLVM would have figured out that the panic could be eliminated, but in general the methods here can't panic in the first place! As a result this commit makes the following tweaks: * Removes `unwrap()` and replaces it with `unsafe` in `Layout::new` and `Layout::for_value`. For posterity though a debug assertion was left behind. * Removes an `unwrap()` in favor of `?` in the `repeat` method. The comment indicating that the function call couldn't panic wasn't quite right in that if `alloc_size` becomes too large and if `align` is high enough it could indeed cause a panic. This'll hopefully mean that panics never get introduced into code in the first place, ensuring that `opt-level=z` is closer to `opt-level=s` in this regard.
1 parent 99d4886 commit 68e555b

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

src/libcore/alloc.rs

+14-8
Original file line numberDiff line numberDiff line change
@@ -145,15 +145,26 @@ impl Layout {
145145
/// Constructs a `Layout` suitable for holding a value of type `T`.
146146
pub fn new<T>() -> Self {
147147
let (size, align) = size_align::<T>();
148-
Layout::from_size_align(size, align).unwrap()
148+
// Note that the align is guaranteed by rustc to be a power of two and
149+
// the size+align combo is guaranteed to fit in our address space. As a
150+
// result use the unchecked constructor here to avoid inserting code
151+
// that panics if it isn't optimized well enough.
152+
debug_assert!(Layout::from_size_align(size, align).is_ok());
153+
unsafe {
154+
Layout::from_size_align_unchecked(size, align)
155+
}
149156
}
150157

151158
/// Produces layout describing a record that could be used to
152159
/// allocate backing structure for `T` (which could be a trait
153160
/// or other unsized type like a slice).
154161
pub fn for_value<T: ?Sized>(t: &T) -> Self {
155162
let (size, align) = (mem::size_of_val(t), mem::align_of_val(t));
156-
Layout::from_size_align(size, align).unwrap()
163+
// See rationale in `new` for why this us using an unsafe variant below
164+
debug_assert!(Layout::from_size_align(size, align).is_ok());
165+
unsafe {
166+
Layout::from_size_align_unchecked(size, align)
167+
}
157168
}
158169

159170
/// Creates a layout describing the record that can hold a value
@@ -234,12 +245,7 @@ impl Layout {
234245
.ok_or(LayoutErr { private: () })?;
235246
let alloc_size = padded_size.checked_mul(n)
236247
.ok_or(LayoutErr { private: () })?;
237-
238-
// We can assume that `self.align` is a power-of-two.
239-
// Furthermore, `alloc_size` has already been rounded up
240-
// to a multiple of `self.align`; therefore, the call to
241-
// `Layout::from_size_align` below should never panic.
242-
Ok((Layout::from_size_align(alloc_size, self.align).unwrap(), padded_size))
248+
Ok((Layout::from_size_align(alloc_size, self.align)?, padded_size))
243249
}
244250

245251
/// Creates a layout describing the record for `self` followed by

0 commit comments

Comments
 (0)