Coverage Report

Created: 2026-11-12 07:00

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/gmp/mpn/toom22_mul.c
Line
Count
Source
1
/* mpn_toom22_mul -- Multiply {ap,an} and {bp,bn} where an >= bn.  Or more
2
   accurately, bn <= an < 2bn.
3
4
   Contributed to the GNU project by Torbjorn Granlund.
5
6
   THE FUNCTION IN THIS FILE IS INTERNAL WITH A MUTABLE INTERFACE.  IT IS ONLY
7
   SAFE TO REACH IT THROUGH DOCUMENTED INTERFACES.  IN FACT, IT IS ALMOST
8
   GUARANTEED THAT IT WILL CHANGE OR DISAPPEAR IN A FUTURE GNU MP RELEASE.
9
10
Copyright 2006-2010, 2012, 2014, 2018, 2020 Free Software Foundation, Inc.
11
12
This file is part of the GNU MP Library.
13
14
The GNU MP Library is free software; you can redistribute it and/or modify
15
it under the terms of either:
16
17
  * the GNU Lesser General Public License as published by the Free
18
    Software Foundation; either version 3 of the License, or (at your
19
    option) any later version.
20
21
or
22
23
  * the GNU General Public License as published by the Free Software
24
    Foundation; either version 2 of the License, or (at your option) any
25
    later version.
26
27
or both in parallel, as here.
28
29
The GNU MP Library is distributed in the hope that it will be useful, but
30
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
31
or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
32
for more details.
33
34
You should have received copies of the GNU General Public License and the
35
GNU Lesser General Public License along with the GNU MP Library.  If not,
36
see https://www.gnu.org/licenses/.  */
37
38
39
#include "gmp-impl.h"
40
41
/* Evaluate in: -1, 0, +inf
42
43
  <-s--><--n-->
44
   ____ ______
45
  |_a1_|___a0_|
46
   |b1_|___b0_|
47
   <-t-><--n-->
48
49
  v0  =  a0     * b0       #   A(0)*B(0)
50
  vm1 = (a0- a1)*(b0- b1)  #  A(-1)*B(-1)
51
  vinf=      a1 *     b1   # A(inf)*B(inf)
52
*/
53
54
#if TUNE_PROGRAM_BUILD || WANT_FAT_BINARY
55
#define MAYBE_mul_toom22   1
56
#else
57
#define MAYBE_mul_toom22            \
58
240M
  (MUL_TOOM33_THRESHOLD >= 2 * MUL_TOOM22_THRESHOLD)
59
#endif
60
61
#define TOOM22_MUL_N_REC(p, a, b, n, ws)        \
62
120M
  do {                 \
63
120M
    if (! MAYBE_mul_toom22            \
64
120M
  || BELOW_THRESHOLD (n, MUL_TOOM22_THRESHOLD))     \
65
120M
      mpn_mul_basecase (p, a, n, b, n);         \
66
120M
    else                \
67
120M
      mpn_toom22_mul (p, a, n, b, n, ws);       \
68
120M
  } while (0)
69
70
/* Normally, this calls mul_basecase or toom22_mul.  But when when the fraction
71
   MUL_TOOM33_THRESHOLD / MUL_TOOM22_THRESHOLD is large, an initially small
72
   relative unbalance will become a larger and larger relative unbalance with
73
   each recursion (the difference s-t will be invariant over recursive calls).
74
   Therefore, we need to call toom32_mul.  FIXME: Suppress depending on
75
   MUL_TOOM33_THRESHOLD / MUL_TOOM22_THRESHOLD and on MUL_TOOM22_THRESHOLD.  */
76
#define TOOM22_MUL_REC(p, a, an, b, bn, ws)       \
77
6.56k
  do {                 \
78
6.56k
    if (! MAYBE_mul_toom22            \
79
6.56k
  || BELOW_THRESHOLD (bn, MUL_TOOM22_THRESHOLD))      \
80
6.56k
      mpn_mul_basecase (p, a, an, b, bn);       \
81
6.56k
    else if (4 * an < 5 * bn)           \
82
562
      mpn_toom22_mul (p, a, an, b, bn, ws);       \
83
562
    else                \
84
562
      mpn_toom32_mul (p, a, an, b, bn, ws);       \
85
6.56k
  } while (0)
86
87
void
88
mpn_toom22_mul (mp_ptr pp,
89
    mp_srcptr ap, mp_size_t an,
90
    mp_srcptr bp, mp_size_t bn,
91
    mp_ptr scratch)
92
40.0M
{
93
40.0M
  const int __gmpn_cpuvec_initialized = 1;
94
40.0M
  mp_size_t n, s, t;
95
40.0M
  int vm1_neg;
96
40.0M
  mp_limb_t cy, cy2;
97
40.0M
  mp_ptr asm1;
98
40.0M
  mp_ptr bsm1;
99
100
95.3M
#define a0  ap
101
65.6M
#define a1  (ap + n)
102
82.1M
#define b0  bp
103
67.1M
#define b1  (bp + n)
104
105
40.0M
  s = an >> 1;
106
40.0M
  n = an - s;
107
40.0M
  t = bn - n;
108
109
40.0M
  ASSERT (an >= bn);
110
111
40.0M
  ASSERT (0 < s && s <= n && (n - s) == (an & 1));
112
40.0M
  ASSERT (0 < t && t <= s);
113
114
40.0M
  asm1 = pp;
115
40.0M
  bsm1 = pp + n;
116
117
40.0M
  vm1_neg = 0;
118
119
  /* Compute asm1.  */
120
40.0M
  if ((an & 1) == 0) /* s == n */
121
25.0M
    {
122
25.0M
      if (mpn_cmp (a0, a1, n) < 0)
123
10.3M
  {
124
10.3M
    mpn_sub_n (asm1, a1, a0, n);
125
10.3M
    vm1_neg = 1;
126
10.3M
  }
127
14.6M
      else
128
14.6M
  {
129
14.6M
    mpn_sub_n (asm1, a0, a1, n);
130
14.6M
  }
131
25.0M
    }
132
14.9M
  else /* n - s == 1 */
133
14.9M
    {
134
14.9M
      if (a0[s] == 0 && mpn_cmp (a0, a1, s) < 0)
135
227k
  {
136
227k
    mpn_sub_n (asm1, a1, a0, s);
137
227k
    asm1[s] = 0;
138
227k
    vm1_neg = 1;
139
227k
  }
140
14.7M
      else
141
14.7M
  {
142
14.7M
    asm1[s] = a0[s] - mpn_sub_n (asm1, a0, a1, s);
143
14.7M
  }
144
14.9M
    }
145
146
  /* Compute bsm1.  */
147
40.0M
  if (t == n)
148
25.0M
    {
149
25.0M
      if (mpn_cmp (b0, b1, n) < 0)
150
11.9M
  {
151
11.9M
    mpn_sub_n (bsm1, b1, b0, n);
152
11.9M
    vm1_neg ^= 1;
153
11.9M
  }
154
13.1M
      else
155
13.1M
  {
156
13.1M
    mpn_sub_n (bsm1, b0, b1, n);
157
13.1M
  }
158
25.0M
    }
159
14.9M
  else
160
14.9M
    {
161
14.9M
      if (mpn_zero_p (b0 + t, n - t) && mpn_cmp (b0, b1, t) < 0)
162
1.15M
  {
163
1.15M
    mpn_sub_n (bsm1, b1, b0, t);
164
1.15M
    MPN_ZERO (bsm1 + t, n - t);
165
1.15M
    vm1_neg ^= 1;
166
1.15M
  }
167
13.8M
      else
168
13.8M
  {
169
13.8M
    mpn_sub (bsm1, b0, n, b1, t);
170
13.8M
  }
171
14.9M
    }
172
173
80.0M
#define v0  pp        /* 2n */
174
80.0M
#define vinf  (pp + 2 * n)      /* s+t */
175
40.0M
#define vm1 scratch        /* 2n */
176
40.0M
#define scratch_out scratch + 2 * n
177
178
  /* vm1, 2n limbs */
179
40.0M
  TOOM22_MUL_N_REC (vm1, asm1, bsm1, n, scratch_out);
180
181
40.0M
  if (s > t)  TOOM22_MUL_REC (vinf, a1, s, b1, t, scratch_out);
182
40.0M
  else        TOOM22_MUL_N_REC (vinf, a1, b1, s, scratch_out);
183
184
  /* v0, 2n limbs */
185
40.0M
  TOOM22_MUL_N_REC (v0, ap, bp, n, scratch_out);
186
187
  /* H(v0) + L(vinf) */
188
40.0M
  cy = mpn_add_n (pp + 2 * n, v0 + n, vinf, n);
189
190
  /* L(v0) + (H(v0) + L(vinf)) */
191
40.0M
  cy2 = cy + mpn_add_n (pp + n, pp + 2 * n, v0, n);
192
193
  /* (H(v0) + L(vinf)) + H(vinf) */
194
40.0M
  cy += mpn_add (pp + 2 * n, pp + 2 * n, n, vinf + n, s + t - n);
195
196
40.0M
  if (vm1_neg)
197
11.9M
    cy += mpn_add_n (pp + n, pp + n, vm1, 2 * n);
198
28.0M
  else {
199
28.0M
    cy -= mpn_sub_n (pp + n, pp + n, vm1, 2 * n);
200
28.0M
    if (UNLIKELY (cy + 1 == 0)) { /* cy is negative */
201
      /* The total contribution of v0+vinf-vm1 can not be negative. */
202
#if WANT_ASSERT
203
      /* The borrow in cy stops the propagation of the carry cy2, */
204
      ASSERT (cy2 == 1);
205
      cy += mpn_add_1 (pp + 2 * n, pp + 2 * n, n, cy2);
206
      ASSERT (cy == 0);
207
#else
208
      /* we simply fill the area with zeros. */
209
3.01k
      MPN_FILL (pp + 2 * n, n, 0);
210
      /* ASSERT (s + t == n || mpn_zero_p (pp + 3 * n, s + t - n)); */
211
3.01k
#endif
212
3.01k
      return;
213
3.01k
    }
214
28.0M
  }
215
216
40.0M
  ASSERT (cy  <= 2);
217
40.0M
  ASSERT (cy2 <= 2);
218
219
40.0M
  MPN_INCR_U (pp + 2 * n, s + t, cy2);
220
  /* if s+t==n, cy is zero, but we should not access pp[3*n] at all. */
221
40.0M
  MPN_INCR_U (pp + 3 * n, s + t - n, cy);
222
40.0M
}