Skip to content

Commit

Permalink
get rid of the internal unlikely macro
Browse files Browse the repository at this point in the history
  • Loading branch information
RalfJung committed Oct 25, 2024
1 parent d2ff6a2 commit 6daffe4
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 33 deletions.
10 changes: 8 additions & 2 deletions core/src/intrinsics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -986,7 +986,10 @@ pub const unsafe fn assume(b: bool) {
/// any safety invariants.
///
/// This intrinsic does not have a stable counterpart.
#[cfg_attr(bootstrap, rustc_const_unstable(feature = "const_likely", issue = "none"))]
#[cfg_attr(
bootstrap,
rustc_const_stable(feature = "const_likely", since = "CURRENT_RUSTC_VERSION")
)]
#[cfg_attr(not(bootstrap), rustc_const_stable_indirect)]
#[unstable(feature = "core_intrinsics", issue = "none")]
#[rustc_intrinsic]
Expand All @@ -1007,7 +1010,10 @@ pub const fn likely(b: bool) -> bool {
/// any safety invariants.
///
/// This intrinsic does not have a stable counterpart.
#[cfg_attr(bootstrap, rustc_const_unstable(feature = "const_likely", issue = "none"))]
#[cfg_attr(
bootstrap,
rustc_const_stable(feature = "const_likely", since = "CURRENT_RUSTC_VERSION")
)]
#[cfg_attr(not(bootstrap), rustc_const_stable_indirect)]
#[unstable(feature = "core_intrinsics", issue = "none")]
#[rustc_intrinsic]
Expand Down
30 changes: 15 additions & 15 deletions core/src/num/int_macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ macro_rules! int_impl {
#[inline]
pub const fn checked_add(self, rhs: Self) -> Option<Self> {
let (a, b) = self.overflowing_add(rhs);
if unlikely!(b) { None } else { Some(a) }
if intrinsics::unlikely(b) { None } else { Some(a) }
}

/// Strict integer addition. Computes `self + rhs`, panicking
Expand Down Expand Up @@ -545,7 +545,7 @@ macro_rules! int_impl {
#[inline]
pub const fn checked_add_unsigned(self, rhs: $UnsignedT) -> Option<Self> {
let (a, b) = self.overflowing_add_unsigned(rhs);
if unlikely!(b) { None } else { Some(a) }
if intrinsics::unlikely(b) { None } else { Some(a) }
}

/// Strict addition with an unsigned integer. Computes `self + rhs`,
Expand Down Expand Up @@ -601,7 +601,7 @@ macro_rules! int_impl {
#[inline]
pub const fn checked_sub(self, rhs: Self) -> Option<Self> {
let (a, b) = self.overflowing_sub(rhs);
if unlikely!(b) { None } else { Some(a) }
if intrinsics::unlikely(b) { None } else { Some(a) }
}

/// Strict integer subtraction. Computes `self - rhs`, panicking if
Expand Down Expand Up @@ -697,7 +697,7 @@ macro_rules! int_impl {
#[inline]
pub const fn checked_sub_unsigned(self, rhs: $UnsignedT) -> Option<Self> {
let (a, b) = self.overflowing_sub_unsigned(rhs);
if unlikely!(b) { None } else { Some(a) }
if intrinsics::unlikely(b) { None } else { Some(a) }
}

/// Strict subtraction with an unsigned integer. Computes `self - rhs`,
Expand Down Expand Up @@ -753,7 +753,7 @@ macro_rules! int_impl {
#[inline]
pub const fn checked_mul(self, rhs: Self) -> Option<Self> {
let (a, b) = self.overflowing_mul(rhs);
if unlikely!(b) { None } else { Some(a) }
if intrinsics::unlikely(b) { None } else { Some(a) }
}

/// Strict integer multiplication. Computes `self * rhs`, panicking if
Expand Down Expand Up @@ -849,7 +849,7 @@ macro_rules! int_impl {
without modifying the original"]
#[inline]
pub const fn checked_div(self, rhs: Self) -> Option<Self> {
if unlikely!(rhs == 0 || ((self == Self::MIN) && (rhs == -1))) {
if intrinsics::unlikely(rhs == 0 || ((self == Self::MIN) && (rhs == -1))) {
None
} else {
// SAFETY: div by zero and by INT_MIN have been checked above
Expand Down Expand Up @@ -924,7 +924,7 @@ macro_rules! int_impl {
#[inline]
pub const fn checked_div_euclid(self, rhs: Self) -> Option<Self> {
// Using `&` helps LLVM see that it is the same check made in division.
if unlikely!(rhs == 0 || ((self == Self::MIN) & (rhs == -1))) {
if intrinsics::unlikely(rhs == 0 || ((self == Self::MIN) & (rhs == -1))) {
None
} else {
Some(self.div_euclid(rhs))
Expand Down Expand Up @@ -997,7 +997,7 @@ macro_rules! int_impl {
without modifying the original"]
#[inline]
pub const fn checked_rem(self, rhs: Self) -> Option<Self> {
if unlikely!(rhs == 0 || ((self == Self::MIN) && (rhs == -1))) {
if intrinsics::unlikely(rhs == 0 || ((self == Self::MIN) && (rhs == -1))) {
None
} else {
// SAFETY: div by zero and by INT_MIN have been checked above
Expand Down Expand Up @@ -1071,7 +1071,7 @@ macro_rules! int_impl {
#[inline]
pub const fn checked_rem_euclid(self, rhs: Self) -> Option<Self> {
// Using `&` helps LLVM see that it is the same check made in division.
if unlikely!(rhs == 0 || ((self == Self::MIN) & (rhs == -1))) {
if intrinsics::unlikely(rhs == 0 || ((self == Self::MIN) & (rhs == -1))) {
None
} else {
Some(self.rem_euclid(rhs))
Expand Down Expand Up @@ -1142,7 +1142,7 @@ macro_rules! int_impl {
#[inline]
pub const fn checked_neg(self) -> Option<Self> {
let (a, b) = self.overflowing_neg();
if unlikely!(b) { None } else { Some(a) }
if intrinsics::unlikely(b) { None } else { Some(a) }
}

/// Unchecked negation. Computes `-self`, assuming overflow cannot occur.
Expand Down Expand Up @@ -2564,7 +2564,7 @@ macro_rules! int_impl {
without modifying the original"]
pub const fn overflowing_div(self, rhs: Self) -> (Self, bool) {
// Using `&` helps LLVM see that it is the same check made in division.
if unlikely!((self == Self::MIN) & (rhs == -1)) {
if intrinsics::unlikely((self == Self::MIN) & (rhs == -1)) {
(self, true)
} else {
(self / rhs, false)
Expand Down Expand Up @@ -2595,7 +2595,7 @@ macro_rules! int_impl {
without modifying the original"]
pub const fn overflowing_div_euclid(self, rhs: Self) -> (Self, bool) {
// Using `&` helps LLVM see that it is the same check made in division.
if unlikely!((self == Self::MIN) & (rhs == -1)) {
if intrinsics::unlikely((self == Self::MIN) & (rhs == -1)) {
(self, true)
} else {
(self.div_euclid(rhs), false)
Expand Down Expand Up @@ -2625,7 +2625,7 @@ macro_rules! int_impl {
#[must_use = "this returns the result of the operation, \
without modifying the original"]
pub const fn overflowing_rem(self, rhs: Self) -> (Self, bool) {
if unlikely!(rhs == -1) {
if intrinsics::unlikely(rhs == -1) {
(0, self == Self::MIN)
} else {
(self % rhs, false)
Expand Down Expand Up @@ -2657,7 +2657,7 @@ macro_rules! int_impl {
#[inline]
#[track_caller]
pub const fn overflowing_rem_euclid(self, rhs: Self) -> (Self, bool) {
if unlikely!(rhs == -1) {
if intrinsics::unlikely(rhs == -1) {
(0, self == Self::MIN)
} else {
(self.rem_euclid(rhs), false)
Expand Down Expand Up @@ -2686,7 +2686,7 @@ macro_rules! int_impl {
without modifying the original"]
#[allow(unused_attributes)]
pub const fn overflowing_neg(self) -> (Self, bool) {
if unlikely!(self == Self::MIN) {
if intrinsics::unlikely(self == Self::MIN) {
(Self::MIN, true)
} else {
(-self, false)
Expand Down
7 changes: 0 additions & 7 deletions core/src/num/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,6 @@ macro_rules! try_opt {
};
}

#[cfg_attr(bootstrap, allow_internal_unstable(const_likely))]
macro_rules! unlikely {
($e: expr) => {
intrinsics::unlikely($e)
};
}

// Use this when the generated code should differ between signed and unsigned types.
macro_rules! sign_dependent_expr {
(signed ? if signed { $signed_case:expr } if unsigned { $unsigned_case:expr } ) => {
Expand Down
16 changes: 8 additions & 8 deletions core/src/num/uint_macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ macro_rules! uint_impl {
// Per <https://github.com/rust-lang/rust/pull/124114#issuecomment-2066173305>,
// LLVM is happy to re-form the intrinsic later if useful.

if unlikely!(intrinsics::add_with_overflow(self, rhs).1) {
if intrinsics::unlikely(intrinsics::add_with_overflow(self, rhs).1) {
None
} else {
// SAFETY: Just checked it doesn't overflow
Expand Down Expand Up @@ -593,7 +593,7 @@ macro_rules! uint_impl {
#[inline]
pub const fn checked_add_signed(self, rhs: $SignedT) -> Option<Self> {
let (a, b) = self.overflowing_add_signed(rhs);
if unlikely!(b) { None } else { Some(a) }
if intrinsics::unlikely(b) { None } else { Some(a) }
}

/// Strict addition with a signed integer. Computes `self + rhs`,
Expand Down Expand Up @@ -845,7 +845,7 @@ macro_rules! uint_impl {
#[inline]
pub const fn checked_mul(self, rhs: Self) -> Option<Self> {
let (a, b) = self.overflowing_mul(rhs);
if unlikely!(b) { None } else { Some(a) }
if intrinsics::unlikely(b) { None } else { Some(a) }
}

/// Strict integer multiplication. Computes `self * rhs`, panicking if
Expand Down Expand Up @@ -940,7 +940,7 @@ macro_rules! uint_impl {
without modifying the original"]
#[inline]
pub const fn checked_div(self, rhs: Self) -> Option<Self> {
if unlikely!(rhs == 0) {
if intrinsics::unlikely(rhs == 0) {
None
} else {
// SAFETY: div by zero has been checked above and unsigned types have no other
Expand Down Expand Up @@ -1001,7 +1001,7 @@ macro_rules! uint_impl {
without modifying the original"]
#[inline]
pub const fn checked_div_euclid(self, rhs: Self) -> Option<Self> {
if unlikely!(rhs == 0) {
if intrinsics::unlikely(rhs == 0) {
None
} else {
Some(self.div_euclid(rhs))
Expand Down Expand Up @@ -1061,7 +1061,7 @@ macro_rules! uint_impl {
without modifying the original"]
#[inline]
pub const fn checked_rem(self, rhs: Self) -> Option<Self> {
if unlikely!(rhs == 0) {
if intrinsics::unlikely(rhs == 0) {
None
} else {
// SAFETY: div by zero has been checked above and unsigned types have no other
Expand Down Expand Up @@ -1123,7 +1123,7 @@ macro_rules! uint_impl {
without modifying the original"]
#[inline]
pub const fn checked_rem_euclid(self, rhs: Self) -> Option<Self> {
if unlikely!(rhs == 0) {
if intrinsics::unlikely(rhs == 0) {
None
} else {
Some(self.rem_euclid(rhs))
Expand Down Expand Up @@ -1362,7 +1362,7 @@ macro_rules! uint_impl {
#[inline]
pub const fn checked_neg(self) -> Option<Self> {
let (a, b) = self.overflowing_neg();
if unlikely!(b) { None } else { Some(a) }
if intrinsics::unlikely(b) { None } else { Some(a) }
}

/// Strict negation. Computes `-self`, panicking unless `self ==
Expand Down
1 change: 0 additions & 1 deletion core/tests/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
// tidy-alphabetical-start
#![cfg_attr(bootstrap, feature(const_likely))]
#![cfg_attr(bootstrap, feature(strict_provenance))]
#![cfg_attr(not(bootstrap), feature(strict_provenance_lints))]
#![cfg_attr(target_has_atomic = "128", feature(integer_atomics))]
Expand Down

0 comments on commit 6daffe4

Please sign in to comment.