Coverage Report

Created: 2025-03-06 06:58

/src/gmp/mpz/powm.c
Line
Count
Source (jump to first uncovered line)
1
/* mpz_powm(res,base,exp,mod) -- Set R to (U^E) mod M.
2
3
   Contributed to the GNU project by Torbjorn Granlund.
4
5
Copyright 1991, 1993, 1994, 1996, 1997, 2000-2002, 2005, 2008, 2009,
6
2011, 2012, 2015, 2019 Free Software Foundation, Inc.
7
8
This file is part of the GNU MP Library.
9
10
The GNU MP Library is free software; you can redistribute it and/or modify
11
it under the terms of either:
12
13
  * the GNU Lesser General Public License as published by the Free
14
    Software Foundation; either version 3 of the License, or (at your
15
    option) any later version.
16
17
or
18
19
  * the GNU General Public License as published by the Free Software
20
    Foundation; either version 2 of the License, or (at your option) any
21
    later version.
22
23
or both in parallel, as here.
24
25
The GNU MP Library is distributed in the hope that it will be useful, but
26
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
27
or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
28
for more details.
29
30
You should have received copies of the GNU General Public License and the
31
GNU Lesser General Public License along with the GNU MP Library.  If not,
32
see https://www.gnu.org/licenses/.  */
33
34
35
#include "gmp-impl.h"
36
#include "longlong.h"
37
38
39
/* TODO
40
41
 * Improve handling of buffers.  It is pretty ugly now.
42
43
 * For even moduli, we compute a binvert of its odd part both here and in
44
   mpn_powm.  How can we avoid this recomputation?
45
*/
46
47
/*
48
  b ^ e mod m   res
49
  0   0     0    ?
50
  0   e     0    ?
51
  0   0     m    ?
52
  0   e     m    0
53
  b   0     0    ?
54
  b   e     0    ?
55
  b   0     m    1 mod m
56
  b   e     m    b^e mod m
57
*/
58
59
#define HANDLE_NEGATIVE_EXPONENT 1
60
61
void
62
mpz_powm (mpz_ptr r, mpz_srcptr b, mpz_srcptr e, mpz_srcptr m)
63
0
{
64
0
  mp_size_t n, nodd, ncnt;
65
0
  int cnt;
66
0
  mp_ptr rp, tp;
67
0
  mp_srcptr bp, ep, mp;
68
0
  mp_size_t rn, bn, es, en, itch;
69
0
  mpz_t new_b;      /* note: value lives long via 'b' */
70
0
  TMP_DECL;
71
72
0
  n = ABSIZ(m);
73
0
  if (UNLIKELY (n == 0))
74
0
    DIVIDE_BY_ZERO;
75
76
0
  mp = PTR(m);
77
78
0
  TMP_MARK;
79
80
0
  es = SIZ(e);
81
0
  if (UNLIKELY (es <= 0))
82
0
    {
83
0
      if (es == 0)
84
0
  {
85
    /* b^0 mod m,  b is anything and m is non-zero.
86
       Result is 1 mod m, i.e., 1 or 0 depending on if m = 1.  */
87
0
    SIZ(r) = n != 1 || mp[0] != 1;
88
0
    MPZ_NEWALLOC (r, 1)[0] = 1;
89
0
    TMP_FREE; /* we haven't really allocated anything here */
90
0
    return;
91
0
  }
92
0
#if HANDLE_NEGATIVE_EXPONENT
93
0
      MPZ_TMP_INIT (new_b, n + 1);
94
95
0
      if (UNLIKELY (! mpz_invert (new_b, b, m)))
96
0
  DIVIDE_BY_ZERO;
97
0
      b = new_b;
98
0
      es = -es;
99
#else
100
      DIVIDE_BY_ZERO;
101
#endif
102
0
    }
103
0
  en = es;
104
105
0
  bn = ABSIZ(b);
106
107
0
  if (UNLIKELY (bn == 0))
108
0
    {
109
0
      SIZ(r) = 0;
110
0
      TMP_FREE;
111
0
      return;
112
0
    }
113
114
0
  ep = PTR(e);
115
116
  /* Handle (b^1 mod m) early, since mpn_pow* do not handle that case.  */
117
0
  if (UNLIKELY (en == 1 && ep[0] == 1))
118
0
    {
119
0
      rp = TMP_ALLOC_LIMBS (n);
120
0
      bp = PTR(b);
121
0
      if (bn >= n)
122
0
  {
123
0
    mp_ptr qp = TMP_ALLOC_LIMBS (bn - n + 1);
124
0
    mpn_tdiv_qr (qp, rp, 0L, bp, bn, mp, n);
125
0
    rn = n;
126
0
    MPN_NORMALIZE (rp, rn);
127
128
0
    if (rn != 0 && SIZ(b) < 0)
129
0
      {
130
0
        mpn_sub (rp, mp, n, rp, rn);
131
0
        rn = n;
132
0
        MPN_NORMALIZE_NOT_ZERO (rp, rn);
133
0
      }
134
0
  }
135
0
      else
136
0
  {
137
0
    if (SIZ(b) < 0)
138
0
      {
139
0
        mpn_sub (rp, mp, n, bp, bn);
140
0
        rn = n;
141
0
        MPN_NORMALIZE_NOT_ZERO (rp, rn);
142
0
      }
143
0
    else
144
0
      {
145
0
        MPN_COPY (rp, bp, bn);
146
0
        rn = bn;
147
0
      }
148
0
  }
149
0
      goto ret;
150
0
    }
151
152
  /* Remove low zero limbs from M.  This loop will terminate for correctly
153
     represented mpz numbers.  */
154
0
  ncnt = 0;
155
0
  while (UNLIKELY (mp[0] == 0))
156
0
    {
157
0
      mp++;
158
0
      ncnt++;
159
0
    }
160
0
  nodd = n - ncnt;
161
0
  cnt = 0;
162
0
  if (mp[0] % 2 == 0)
163
0
    {
164
0
      mp_ptr newmp = TMP_ALLOC_LIMBS (nodd);
165
0
      count_trailing_zeros (cnt, mp[0]);
166
0
      mpn_rshift (newmp, mp, nodd, cnt);
167
0
      nodd -= newmp[nodd - 1] == 0;
168
0
      mp = newmp;
169
0
      ncnt++;
170
0
    }
171
172
0
  if (ncnt != 0)
173
0
    {
174
      /* We will call both mpn_powm and mpn_powlo.  */
175
      /* rp needs n, mpn_powlo needs 4n, the 2 mpn_binvert might need more */
176
0
      mp_size_t n_largest_binvert = MAX (ncnt, nodd);
177
0
      mp_size_t itch_binvert = mpn_binvert_itch (n_largest_binvert);
178
0
      itch = 3 * n + MAX (itch_binvert, 2 * n);
179
0
    }
180
0
  else
181
0
    {
182
      /* We will call just mpn_powm.  */
183
0
      mp_size_t itch_binvert = mpn_binvert_itch (nodd);
184
0
      itch = n + MAX (itch_binvert, 2 * n);
185
0
    }
186
0
  tp = TMP_ALLOC_LIMBS (itch);
187
188
0
  rp = tp;  tp += n;
189
190
0
  bp = PTR(b);
191
0
  mpn_powm (rp, bp, bn, ep, en, mp, nodd, tp);
192
193
0
  rn = n;
194
195
0
  if (ncnt != 0)
196
0
    {
197
0
      mp_ptr r2, xp, yp, odd_inv_2exp;
198
0
      unsigned long t;
199
0
      int bcnt;
200
201
0
      if (bn < ncnt)
202
0
  {
203
0
    mp_ptr newbp = TMP_ALLOC_LIMBS (ncnt);
204
0
    MPN_COPY (newbp, bp, bn);
205
0
    MPN_ZERO (newbp + bn, ncnt - bn);
206
0
    bp = newbp;
207
0
  }
208
209
0
      r2 = tp;
210
211
0
      if (bp[0] % 2 == 0)
212
0
  {
213
0
    if (en > 1)
214
0
      {
215
0
        MPN_ZERO (r2, ncnt);
216
0
        goto zero;
217
0
      }
218
219
0
    ASSERT (en == 1);
220
0
    t = (ncnt - (cnt != 0)) * GMP_NUMB_BITS + cnt;
221
222
    /* Count number of low zero bits in B, up to 3.  */
223
0
    bcnt = (0x1213 >> ((bp[0] & 7) << 1)) & 0x3;
224
    /* Note that ep[0] * bcnt might overflow, but that just results
225
       in a missed optimization.  */
226
0
    if (ep[0] * bcnt >= t)
227
0
      {
228
0
        MPN_ZERO (r2, ncnt);
229
0
        goto zero;
230
0
      }
231
0
  }
232
233
0
      mpn_powlo (r2, bp, ep, en, ncnt, tp + ncnt);
234
235
0
    zero:
236
0
      if (nodd < ncnt)
237
0
  {
238
0
    mp_ptr newmp = TMP_ALLOC_LIMBS (ncnt);
239
0
    MPN_COPY (newmp, mp, nodd);
240
0
    MPN_ZERO (newmp + nodd, ncnt - nodd);
241
0
    mp = newmp;
242
0
  }
243
244
0
      odd_inv_2exp = tp + n;
245
0
      mpn_binvert (odd_inv_2exp, mp, ncnt, tp + 2 * n);
246
247
0
      mpn_sub (r2, r2, ncnt, rp, nodd > ncnt ? ncnt : nodd);
248
249
0
      xp = tp + 2 * n;
250
0
      mpn_mullo_n (xp, odd_inv_2exp, r2, ncnt);
251
252
0
      if (cnt != 0)
253
0
  xp[ncnt - 1] &= (CNST_LIMB(1) << cnt) - 1;
254
255
0
      yp = tp;
256
0
      if (ncnt > nodd)
257
0
  mpn_mul (yp, xp, ncnt, mp, nodd);
258
0
      else
259
0
  mpn_mul (yp, mp, nodd, xp, ncnt);
260
261
0
      mpn_add (rp, yp, n, rp, nodd);
262
263
0
      ASSERT (nodd + ncnt >= n);
264
0
      ASSERT (nodd + ncnt <= n + 1);
265
0
    }
266
267
0
  MPN_NORMALIZE (rp, rn);
268
269
0
  if ((ep[0] & 1) && SIZ(b) < 0 && rn != 0)
270
0
    {
271
0
      mpn_sub (rp, PTR(m), n, rp, rn);
272
0
      rn = n;
273
0
      MPN_NORMALIZE (rp, rn);
274
0
    }
275
276
0
 ret:
277
0
  MPZ_NEWALLOC (r, rn);
278
0
  SIZ(r) = rn;
279
0
  MPN_COPY (PTR(r), rp, rn);
280
281
0
  TMP_FREE;
282
0
}