Use Add, Sub, Mul traits instead of unsafe

This commit is contained in:
Giles Cope 2022-04-10 18:13:48 +01:00
parent 82e9d9ebac
commit 515906a669
No known key found for this signature in database
GPG Key ID: 631F6352D4A949EF
2 changed files with 51 additions and 41 deletions

View File

@ -5,6 +5,7 @@
use crate::ascii; use crate::ascii;
use crate::intrinsics; use crate::intrinsics;
use crate::mem; use crate::mem;
use crate::ops::{Add, Mul, Sub};
use crate::str::FromStr; use crate::str::FromStr;
// Used because the `?` operator is not allowed in a const context. // Used because the `?` operator is not allowed in a const context.
@ -969,14 +970,14 @@ pub enum FpCategory {
} }
#[doc(hidden)] #[doc(hidden)]
trait FromStrRadixHelper: PartialOrd + Copy + Default { trait FromStrRadixHelper:
PartialOrd + Copy + Default + Add<Output = Self> + Sub<Output = Self> + Mul<Output = Self>
{
const MIN: Self; const MIN: Self;
fn from_u32(u: u32) -> Self;
fn checked_mul(&self, other: u32) -> Option<Self>; fn checked_mul(&self, other: u32) -> Option<Self>;
fn checked_sub(&self, other: u32) -> Option<Self>; fn checked_sub(&self, other: u32) -> Option<Self>;
fn checked_add(&self, other: u32) -> Option<Self>; fn checked_add(&self, other: u32) -> Option<Self>;
unsafe fn unchecked_mul(self, other: u32) -> Self;
unsafe fn unchecked_sub(self, other: u32) -> Self;
unsafe fn unchecked_add(self, other: u32) -> Self;
} }
macro_rules! from_str_radix_int_impl { macro_rules! from_str_radix_int_impl {
@ -996,6 +997,8 @@ macro_rules! impl_helper_for {
($($t:ty)*) => ($(impl FromStrRadixHelper for $t { ($($t:ty)*) => ($(impl FromStrRadixHelper for $t {
const MIN: Self = Self::MIN; const MIN: Self = Self::MIN;
#[inline] #[inline]
fn from_u32(u: u32) -> Self { u as Self }
#[inline]
fn checked_mul(&self, other: u32) -> Option<Self> { fn checked_mul(&self, other: u32) -> Option<Self> {
Self::checked_mul(*self, other as Self) Self::checked_mul(*self, other as Self)
} }
@ -1007,27 +1010,6 @@ macro_rules! impl_helper_for {
fn checked_add(&self, other: u32) -> Option<Self> { fn checked_add(&self, other: u32) -> Option<Self> {
Self::checked_add(*self, other as Self) Self::checked_add(*self, other as Self)
} }
#[inline]
unsafe fn unchecked_mul(self, other: u32) -> Self {
// SAFETY: Conditions of `Self::unchecked_mul` must be upheld by the caller.
unsafe {
Self::unchecked_mul(self, other as Self)
}
}
#[inline]
unsafe fn unchecked_sub(self, other: u32) -> Self {
// SAFETY: Conditions of `Self::unchecked_sub` must be upheld by the caller.
unsafe {
Self::unchecked_sub(self, other as Self)
}
}
#[inline]
unsafe fn unchecked_add(self, other: u32) -> Self {
// SAFETY: Conditions of `Self::unchecked_add` must be upheld by the caller.
unsafe {
Self::unchecked_add(self, other as Self)
}
}
})*) })*)
} }
impl_helper_for! { i8 i16 i32 i64 i128 isize u8 u16 u32 u64 u128 usize } impl_helper_for! { i8 i16 i32 i64 i128 isize u8 u16 u32 u64 u128 usize }
@ -1077,7 +1059,7 @@ fn from_str_radix<T: FromStrRadixHelper>(src: &str, radix: u32) -> Result<T, Par
let mut result = T::default(); let mut result = T::default();
if can_not_overflow::<T>(radix, is_signed_ty, digits) { if can_not_overflow::<T>(radix, is_signed_ty, digits) {
// SAFETY: If the len of the str is short compared to the range of the type // If the len of the str is short compared to the range of the type
// we are parsing into, then we can be certain that an overflow will not occur. // we are parsing into, then we can be certain that an overflow will not occur.
// This bound is when `radix.pow(digits.len()) - 1 <= T::MAX` but the condition // This bound is when `radix.pow(digits.len()) - 1 <= T::MAX` but the condition
// above is a faster (conservative) approximation of this. // above is a faster (conservative) approximation of this.
@ -1085,22 +1067,20 @@ fn from_str_radix<T: FromStrRadixHelper>(src: &str, radix: u32) -> Result<T, Par
// Consider radix 16 as it has the highest information density per digit and will thus overflow the earliest: // Consider radix 16 as it has the highest information density per digit and will thus overflow the earliest:
// `u8::MAX` is `ff` - any str of len 2 is guaranteed to not overflow. // `u8::MAX` is `ff` - any str of len 2 is guaranteed to not overflow.
// `i8::MAX` is `7f` - only a str of len 1 is guaranteed to not overflow. // `i8::MAX` is `7f` - only a str of len 1 is guaranteed to not overflow.
unsafe { macro_rules! run_unchecked_loop {
macro_rules! run_unchecked_loop { ($unchecked_additive_op:expr) => {
($unchecked_additive_op:ident) => { for &c in digits {
for &c in digits { result = result * T::from_u32(radix);
result = result.unchecked_mul(radix); let x = (c as char).to_digit(radix).ok_or(PIE { kind: InvalidDigit })?;
let x = (c as char).to_digit(radix).ok_or(PIE { kind: InvalidDigit })?; result = $unchecked_additive_op(result, T::from_u32(x));
result = T::$unchecked_additive_op(result, x); }
}
};
}
if is_positive {
run_unchecked_loop!(unchecked_add)
} else {
run_unchecked_loop!(unchecked_sub)
}; };
} }
if is_positive {
run_unchecked_loop!(<T as core::ops::Add>::add)
} else {
run_unchecked_loop!(<T as core::ops::Sub>::sub)
};
} else { } else {
macro_rules! run_checked_loop { macro_rules! run_checked_loop {
($checked_additive_op:ident, $overflow_err:expr) => { ($checked_additive_op:ident, $overflow_err:expr) => {

View File

@ -122,6 +122,28 @@ fn test_int_from_str_overflow() {
#[test] #[test]
fn test_can_not_overflow() { fn test_can_not_overflow() {
fn can_overflow<T>(radix: u32, input: &str) -> bool
where
T: Default
+ core::ops::Sub<Output = T>
+ std::convert::From<bool>
+ std::cmp::PartialOrd
+ Copy,
{
let one = true.into();
let zero = <T>::default();
!can_not_overflow::<T>(radix, zero - one < zero, input.as_bytes())
}
// Positive tests:
assert!(!can_overflow::<i8>(16, "F"));
assert!(!can_overflow::<u8>(16, "FF"));
assert!(!can_overflow::<i8>(10, "9"));
assert!(!can_overflow::<u8>(10, "99"));
// Negative tests:
// Not currently in std lib (issue: #27728) // Not currently in std lib (issue: #27728)
fn format_radix<T>(mut x: T, radix: T) -> String fn format_radix<T>(mut x: T, radix: T) -> String
where where
@ -157,12 +179,20 @@ fn test_can_not_overflow() {
// Calcutate the string length for the smallest overflowing number: // Calcutate the string length for the smallest overflowing number:
let max_len_string = format_radix(num, base as u128); let max_len_string = format_radix(num, base as u128);
// Ensure that that string length is deemed to potentially overflow: // Ensure that that string length is deemed to potentially overflow:
assert_eq!(can_not_overflow::<$t>(base, <$t>::default() > <$t>::MIN, max_len_string.as_bytes()), false); assert!(can_overflow::<$t>(base, &max_len_string));
} }
)*) )*)
} }
check! { i8 i16 i32 i64 i128 isize usize u8 u16 u32 u64 } check! { i8 i16 i32 i64 i128 isize usize u8 u16 u32 u64 }
// Check u128 separately:
for base in 2..=36 {
let num = u128::MAX as u128;
let max_len_string = format_radix(num, base as u128);
// base 16 fits perfectly for u128 and won't overflow:
assert_eq!(can_overflow::<u128>(base, &max_len_string), base != 16);
}
} }
#[test] #[test]