Coverage Report

Created: 2026-09-01 07:45

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/rust/registry/src/index.crates.io-1949cf8c6b5b557f/num-bigint-0.4.8/src/biguint/monty.rs
Line
Count
Source
1
use alloc::vec::Vec;
2
use core::mem;
3
use core::ops::Shl;
4
5
use crate::big_digit::{self, BigDigit, BigDigits, DoubleBigDigit};
6
use crate::biguint::BigUint;
7
8
struct MontyReducer {
9
    n0inv: BigDigit,
10
}
11
12
// k0 = -m**-1 mod 2**BITS. Algorithm from: Dumas, J.G. "On Newton–Raphson
13
// Iteration for Multiplicative Inverses Modulo Prime Powers".
14
0
fn inv_mod_alt(b: BigDigit) -> BigDigit {
15
0
    assert_ne!(b & 1, 0);
16
17
0
    let mut k0 = BigDigit::wrapping_sub(2, b);
18
0
    let mut t = b - 1;
19
0
    let mut i = 1;
20
0
    while i < big_digit::BITS {
21
0
        t = t.wrapping_mul(t);
22
0
        k0 = k0.wrapping_mul(t + 1);
23
0
24
0
        i <<= 1;
25
0
    }
26
0
    debug_assert_eq!(k0.wrapping_mul(b), 1);
27
0
    k0.wrapping_neg()
28
0
}
29
30
impl MontyReducer {
31
0
    fn new(n: &BigUint) -> Self {
32
0
        let n0inv = inv_mod_alt(n.data[0]);
33
0
        MontyReducer { n0inv }
34
0
    }
35
}
36
37
/// Computes z mod m = x * y * 2 ** (-n*_W) mod m
38
/// assuming k = -1/m mod 2**_W
39
/// See Gueron, "Efficient Software Implementations of Modular Exponentiation".
40
/// <https://eprint.iacr.org/2011/239.pdf>
41
/// In the terminology of that paper, this is an "Almost Montgomery Multiplication":
42
/// x and y are required to satisfy 0 <= z < 2**(n*_W) and then the result
43
/// z is guaranteed to satisfy 0 <= z < 2**(n*_W), but it may not be < m.
44
#[allow(clippy::many_single_char_names)]
45
0
fn montgomery(x: &BigUint, y: &BigUint, m: &BigUint, k: BigDigit, n: usize) -> BigUint {
46
    // This code assumes x, y, m are all the same length, n.
47
    // (required by addMulVVW and the for loop).
48
    // It also assumes that x, y are already reduced mod m,
49
    // or else the result will not be properly reduced.
50
0
    assert!(
51
0
        x.data.len() == n && y.data.len() == n && m.data.len() == n,
52
0
        "{:?} {:?} {:?} {}",
53
        x,
54
        y,
55
        m,
56
        n
57
    );
58
59
0
    let (x, y, m) = (&*x.data, &*y.data, &*m.data);
60
61
0
    let mut z = vec![0; n * 2];
62
63
0
    let mut c: BigDigit = 0;
64
0
    for i in 0..n {
65
0
        let z = &mut z[i..];
66
0
        let c2 = add_mul_vvw(&mut z[..n], x, y[i]);
67
0
        let t = z[0].wrapping_mul(k);
68
0
        let c3 = add_mul_vvw(&mut z[..n], m, t);
69
0
        let cx = c.wrapping_add(c2);
70
0
        let cy = cx.wrapping_add(c3);
71
0
        z[n] = cy;
72
0
        if cx < c2 || cy < c3 {
73
0
            c = 1;
74
0
        } else {
75
0
            c = 0;
76
0
        }
77
    }
78
79
0
    let data = if c == 0 {
80
0
        BigDigits::from_slice(&z[n..])
81
    } else {
82
0
        let (first, second) = z.split_at_mut(n);
83
0
        sub_vv(first, second, m);
84
0
        BigDigits::from_slice(first)
85
    };
86
0
    BigUint { data }
87
0
}
88
89
#[inline(always)]
90
0
fn add_mul_vvw(z: &mut [BigDigit], x: &[BigDigit], y: BigDigit) -> BigDigit {
91
0
    let mut c = 0;
92
0
    for (zi, xi) in z.iter_mut().zip(x.iter()) {
93
0
        let (z1, z0) = mul_add_www(*xi, y, *zi);
94
0
        let (c_, zi_) = add_ww(z0, c, 0);
95
0
        *zi = zi_;
96
0
        c = c_ + z1;
97
0
    }
98
99
0
    c
100
0
}
101
102
/// The resulting carry c is either 0 or 1.
103
#[inline(always)]
104
0
fn sub_vv(z: &mut [BigDigit], x: &[BigDigit], y: &[BigDigit]) -> BigDigit {
105
0
    let mut c = 0;
106
0
    for (i, (xi, yi)) in x.iter().zip(y.iter()).enumerate().take(z.len()) {
107
0
        let zi = xi.wrapping_sub(*yi).wrapping_sub(c);
108
0
        z[i] = zi;
109
        // see "Hacker's Delight", section 2-12 (overflow detection)
110
0
        c = ((yi & !xi) | ((yi | !xi) & zi)) >> (big_digit::BITS - 1)
111
    }
112
113
0
    c
114
0
}
115
116
/// z1<<_W + z0 = x+y+c, with c == 0 or 1
117
#[inline(always)]
118
0
fn add_ww(x: BigDigit, y: BigDigit, c: BigDigit) -> (BigDigit, BigDigit) {
119
0
    let yc = y.wrapping_add(c);
120
0
    let z0 = x.wrapping_add(yc);
121
0
    let z1 = if z0 < x || yc < y { 1 } else { 0 };
122
123
0
    (z1, z0)
124
0
}
125
126
/// z1 << _W + z0 = x * y + c
127
#[inline(always)]
128
0
fn mul_add_www(x: BigDigit, y: BigDigit, c: BigDigit) -> (BigDigit, BigDigit) {
129
0
    let z = x as DoubleBigDigit * y as DoubleBigDigit + c as DoubleBigDigit;
130
0
    ((z >> big_digit::BITS) as BigDigit, z as BigDigit)
131
0
}
132
133
/// Calculates x ** y mod m using a fixed, 4-bit window.
134
#[allow(clippy::many_single_char_names)]
135
0
pub(super) fn monty_modpow(x: &BigUint, y: &BigUint, m: &BigUint) -> BigUint {
136
0
    assert!(m.data[0] & 1 == 1);
137
0
    let mr = MontyReducer::new(m);
138
0
    let num_words = m.data.len();
139
140
0
    let mut x = x.clone();
141
142
    // We want the lengths of x and m to be equal.
143
    // It is OK if x >= m as long as len(x) == len(m).
144
0
    if x.data.len() > num_words {
145
0
        x %= m;
146
0
        // Note: now len(x) <= numWords, not guaranteed ==.
147
0
    }
148
0
    if x.data.len() < num_words {
149
0
        x.data.resize(num_words, 0);
150
0
    }
151
152
    // rr = 2**(2*_W*len(m)) mod m
153
0
    let mut rr = BigUint::ONE;
154
0
    rr = (rr.shl(2 * num_words as u64 * u64::from(big_digit::BITS))) % m;
155
0
    if rr.data.len() < num_words {
156
0
        rr.data.resize(num_words, 0);
157
0
    }
158
    // one = 1, with equal length to that of m
159
0
    let mut one = BigUint::ONE;
160
0
    one.data.resize(num_words, 0);
161
162
0
    let n = 4;
163
    // powers[i] contains x^i
164
0
    let mut powers = Vec::with_capacity(1 << n);
165
0
    powers.push(montgomery(&one, &rr, m, mr.n0inv, num_words));
166
0
    powers.push(montgomery(&x, &rr, m, mr.n0inv, num_words));
167
0
    for i in 2..1 << n {
168
0
        let r = montgomery(&powers[i - 1], &powers[1], m, mr.n0inv, num_words);
169
0
        powers.push(r);
170
0
    }
171
172
    // initialize z = 1 (Montgomery 1)
173
0
    let mut z = powers[0].clone();
174
0
    z.data.resize(num_words, 0);
175
0
    let mut zz = BigUint::ZERO;
176
0
    zz.data.resize(num_words, 0);
177
178
    // same windowed exponent, but with Montgomery multiplications
179
0
    let y = &*y.data;
180
0
    for i in (0..y.len()).rev() {
181
0
        let mut yi = y[i];
182
0
        let mut j = 0;
183
0
        while j < big_digit::BITS {
184
0
            if i != y.len() - 1 || j != 0 {
185
0
                zz = montgomery(&z, &z, m, mr.n0inv, num_words);
186
0
                z = montgomery(&zz, &zz, m, mr.n0inv, num_words);
187
0
                zz = montgomery(&z, &z, m, mr.n0inv, num_words);
188
0
                z = montgomery(&zz, &zz, m, mr.n0inv, num_words);
189
0
            }
190
0
            zz = montgomery(
191
0
                &z,
192
0
                &powers[(yi >> (big_digit::BITS - n)) as usize],
193
0
                m,
194
0
                mr.n0inv,
195
0
                num_words,
196
            );
197
0
            mem::swap(&mut z, &mut zz);
198
0
            yi <<= n;
199
0
            j += n;
200
        }
201
    }
202
203
    // convert to regular number
204
0
    zz = montgomery(&z, &one, m, mr.n0inv, num_words);
205
206
0
    zz.data.normalize();
207
    // One last reduction, just in case.
208
    // See golang.org/issue/13907.
209
0
    if zz >= *m {
210
        // Common case is m has high bit set; in that case,
211
        // since zz is the same length as m, there can be just
212
        // one multiple of m to remove. Just subtract.
213
        // We think that the subtract should be sufficient in general,
214
        // so do that unconditionally, but double-check,
215
        // in case our beliefs are wrong.
216
        // The div is not expected to be reached.
217
0
        zz -= m;
218
0
        if zz >= *m {
219
0
            zz %= m;
220
0
        }
221
0
    }
222
223
0
    zz.data.normalize();
224
0
    zz
225
0
}