mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2026-09-05 08:44:14 +02:00
rust: num: add shr and shl methods to Bounded
Shifting a `Bounded` left or right changes the number of bits required to represent the value. Add methods that perform the shift and return a `Bounded` with the appropriately adjusted bit width. These methods are particularly useful for bitfield extraction. Suggested-by: Alice Ryhl <aliceryhl@google.com> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Reviewed-by: Gary Guo <gary@garyguo.net> Reviewed-by: Daniel Almeida <daniel.almeida@collabora.com> Tested-by: Dirk Behme <dirk.behme@de.bosch.com> Acked-by: Miguel Ojeda <ojeda@kernel.org> Acked-by: Yury Norov <ynorov@nvidia.com> Signed-off-by: Alexandre Courbot <acourbot@nvidia.com> Link: https://patch.msgid.link/20260314-register-v9-2-86805b2f7e9d@nvidia.com Signed-off-by: Danilo Krummrich <dakr@kernel.org>
This commit is contained in:
committed by
Danilo Krummrich
parent
3cc319d5f4
commit
c59a2d14cd
@@ -473,6 +473,48 @@ where
|
||||
// `N` bits, and with the same signedness.
|
||||
unsafe { Bounded::__new(value) }
|
||||
}
|
||||
|
||||
/// Right-shifts `self` by `SHIFT` and returns the result as a `Bounded<_, RES>`, where `RES >=
|
||||
/// N - SHIFT`.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use kernel::num::Bounded;
|
||||
///
|
||||
/// let v = Bounded::<u32, 16>::new::<0xff00>();
|
||||
/// let v_shifted: Bounded::<u32, 8> = v.shr::<8, _>();
|
||||
///
|
||||
/// assert_eq!(v_shifted.get(), 0xff);
|
||||
/// ```
|
||||
pub fn shr<const SHIFT: u32, const RES: u32>(self) -> Bounded<T, RES> {
|
||||
const { assert!(RES + SHIFT >= N) }
|
||||
|
||||
// SAFETY: We shift the value right by `SHIFT`, reducing the number of bits needed to
|
||||
// represent the shifted value by as much, and just asserted that `RES >= N - SHIFT`.
|
||||
unsafe { Bounded::__new(self.0 >> SHIFT) }
|
||||
}
|
||||
|
||||
/// Left-shifts `self` by `SHIFT` and returns the result as a `Bounded<_, RES>`, where `RES >=
|
||||
/// N + SHIFT`.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use kernel::num::Bounded;
|
||||
///
|
||||
/// let v = Bounded::<u32, 8>::new::<0xff>();
|
||||
/// let v_shifted: Bounded::<u32, 16> = v.shl::<8, _>();
|
||||
///
|
||||
/// assert_eq!(v_shifted.get(), 0xff00);
|
||||
/// ```
|
||||
pub fn shl<const SHIFT: u32, const RES: u32>(self) -> Bounded<T, RES> {
|
||||
const { assert!(RES >= N + SHIFT) }
|
||||
|
||||
// SAFETY: We shift the value left by `SHIFT`, augmenting the number of bits needed to
|
||||
// represent the shifted value by as much, and just asserted that `RES >= N + SHIFT`.
|
||||
unsafe { Bounded::__new(self.0 << SHIFT) }
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, const N: u32> Deref for Bounded<T, N>
|
||||
|
||||
Reference in New Issue
Block a user