Skip to content

Commit a3c3f72

Browse files
committed
Fix mod_inv termination for the last iteration
On usize=u64 platforms, the 4th iteration would overflow the `mod_gate` back to 0. Similarly for usize=u32 platforms, the 3rd iteration would overflow much the same way. I tested various approaches to resolving this, including approaches with `saturating_mul` and `widening_mul` to a double usize. Turns out LLVM likes `mul_with_overflow` the best. In fact now, that LLVM can see the iteration count is limited, it will happily unroll the loop into a nice linear sequence. You will also notice that the code around the loop got simplified somewhat. Now that LLVM is handling the loop nicely, there isn’t any more reasons to manually unroll the first iteration out of the loop (though looking at the code today I’m not sure all that complexity was necessary in the first place). Fixes #103361
1 parent 5c8bff7 commit a3c3f72

File tree

2 files changed

+40
-26
lines changed

2 files changed

+40
-26
lines changed

library/core/src/ptr/mod.rs

+28-26
Original file line numberDiff line numberDiff line change
@@ -1571,8 +1571,8 @@ pub(crate) unsafe fn align_offset<T: Sized>(p: *const T, a: usize) -> usize {
15711571
// FIXME(#75598): Direct use of these intrinsics improves codegen significantly at opt-level <=
15721572
// 1, where the method versions of these operations are not inlined.
15731573
use intrinsics::{
1574-
cttz_nonzero, exact_div, unchecked_rem, unchecked_shl, unchecked_shr, unchecked_sub,
1575-
wrapping_add, wrapping_mul, wrapping_sub,
1574+
cttz_nonzero, exact_div, mul_with_overflow, unchecked_rem, unchecked_shl, unchecked_shr,
1575+
unchecked_sub, wrapping_add, wrapping_mul, wrapping_sub,
15761576
};
15771577

15781578
/// Calculate multiplicative modular inverse of `x` modulo `m`.
@@ -1592,36 +1592,38 @@ pub(crate) unsafe fn align_offset<T: Sized>(p: *const T, a: usize) -> usize {
15921592
const INV_TABLE_MOD_16: [u8; 8] = [1, 11, 13, 7, 9, 3, 5, 15];
15931593
/// Modulo for which the `INV_TABLE_MOD_16` is intended.
15941594
const INV_TABLE_MOD: usize = 16;
1595-
/// INV_TABLE_MOD²
1596-
const INV_TABLE_MOD_SQUARED: usize = INV_TABLE_MOD * INV_TABLE_MOD;
15971595

1598-
let table_inverse = INV_TABLE_MOD_16[(x & (INV_TABLE_MOD - 1)) >> 1] as usize;
15991596
// SAFETY: `m` is required to be a power-of-two, hence non-zero.
16001597
let m_minus_one = unsafe { unchecked_sub(m, 1) };
1601-
if m <= INV_TABLE_MOD {
1602-
table_inverse & m_minus_one
1603-
} else {
1604-
// We iterate "up" using the following formula:
1605-
//
1606-
// $$ xy ≡ 1 (mod 2ⁿ) → xy (2 - xy) ≡ 1 (mod 2²ⁿ) $$
1598+
let mut inverse = INV_TABLE_MOD_16[(x & (INV_TABLE_MOD - 1)) >> 1] as usize;
1599+
let mut mod_gate = INV_TABLE_MOD;
1600+
// We iterate "up" using the following formula:
1601+
//
1602+
// $$ xy ≡ 1 (mod 2ⁿ) → xy (2 - xy) ≡ 1 (mod 2²ⁿ) $$
1603+
//
1604+
// This application needs to be applied at least until `2²ⁿ ≥ m`, at which point we can
1605+
// finally reduce the computation to our desired `m` by taking `inverse mod m`.
1606+
//
1607+
// This computation is `O(log log m)`, which is to say, that on 64-bit machines this loop
1608+
// will always finish in at most 4 iterations.
1609+
loop {
1610+
// y = y * (2 - xy) mod n
16071611
//
1608-
// until 2²ⁿ ≥ m. Then we can reduce to our desired `m` by taking the result `mod m`.
1609-
let mut inverse = table_inverse;
1610-
let mut going_mod = INV_TABLE_MOD_SQUARED;
1611-
loop {
1612-
// y = y * (2 - xy) mod n
1613-
//
1614-
// Note, that we use wrapping operations here intentionally – the original formula
1615-
// uses e.g., subtraction `mod n`. It is entirely fine to do them `mod
1616-
// usize::MAX` instead, because we take the result `mod n` at the end
1617-
// anyway.
1618-
inverse = wrapping_mul(inverse, wrapping_sub(2usize, wrapping_mul(x, inverse)));
1619-
if going_mod >= m {
1620-
return inverse & m_minus_one;
1621-
}
1622-
going_mod = wrapping_mul(going_mod, going_mod);
1612+
// Note, that we use wrapping operations here intentionally – the original formula
1613+
// uses e.g., subtraction `mod n`. It is entirely fine to do them `mod
1614+
// usize::MAX` instead, because we take the result `mod n` at the end
1615+
// anyway.
1616+
if mod_gate >= m {
1617+
break;
1618+
}
1619+
inverse = wrapping_mul(inverse, wrapping_sub(2usize, wrapping_mul(x, inverse)));
1620+
let (new_gate, overflow) = mul_with_overflow(mod_gate, mod_gate);
1621+
if overflow {
1622+
break;
16231623
}
1624+
mod_gate = new_gate;
16241625
}
1626+
inverse & m_minus_one
16251627
}
16261628

16271629
let addr = p.addr();

library/core/tests/ptr.rs

+12
Original file line numberDiff line numberDiff line change
@@ -455,6 +455,18 @@ fn align_offset_various_strides() {
455455
assert!(!x);
456456
}
457457

458+
#[test]
459+
fn align_offset_issue_103361() {
460+
#[cfg(target_pointer_width = "64")]
461+
const SIZE: usize = 1 << 47;
462+
#[cfg(target_pointer_width = "32")]
463+
const SIZE: usize = 1 << 30;
464+
#[cfg(target_pointer_width = "16")]
465+
const SIZE: usize = 1 << 13;
466+
struct HugeSize([u8; SIZE - 1]);
467+
let _ = (SIZE as *const HugeSize).align_offset(SIZE);
468+
}
469+
458470
#[test]
459471
fn offset_from() {
460472
let mut a = [0; 5];

0 commit comments

Comments
 (0)