16511306696

Committed 25 Jul 2025 01:07AM UTC coverage: 90.698% (+0.005%) from 90.693%

Build # 16511306696

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #5017 from randombit/jack/mp-cleanup

Clean up low level mp interfaces

Run Details

99956 of 110208 relevant lines covered (90.7%)

12233642.11 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.23

/src/lib/math/bigint/big_ops2.cpp

/*
* (C) 1999-2007,2018 Jack Lloyd
*     2016 Matthias Gierlings
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#include <botan/bigint.h>

#include <botan/internal/bit_ops.h>
#include <botan/internal/mp_core.h>
#include <algorithm>

namespace Botan {

BigInt& BigInt::add(const word y[], size_t y_words, Sign y_sign) {
   const size_t x_sw = sig_words();

   grow_to(std::max(x_sw, y_words) + 1);

   if(sign() == y_sign) {
      word carry = bigint_add2(mutable_data(), size() - 1, y, y_words);
      mutable_data()[size() - 1] += carry;
   } else {
      const int32_t relative_size = bigint_cmp(_data(), x_sw, y, y_words);

      if(relative_size >= 0) {
         // *this >= y
         bigint_sub2(mutable_data(), x_sw, y, y_words);
      } else {
         // *this < y: compute *this = y - *this
         bigint_sub2_rev(mutable_data(), y, y_words);
      }

      if(relative_size < 0) {
         set_sign(y_sign);
      } else if(relative_size == 0) {
         set_sign(Positive);
      }
   }

   return (*this);
}

BigInt& BigInt::mod_add(const BigInt& s, const BigInt& mod, secure_vector<word>& ws) {
   if(this->is_negative() || s.is_negative() || mod.is_negative()) {
      throw Invalid_Argument("BigInt::mod_add expects all arguments are positive");
   }

   BOTAN_DEBUG_ASSERT(*this < mod);
   BOTAN_DEBUG_ASSERT(s < mod);

   /*
   t + s or t + s - p == t - (p - s)

   So first compute ws = p - s

   Then compute t + s and t - ws

   If t - ws does not borrow, then that is the correct valued
   */

   const size_t mod_sw = mod.sig_words();
   BOTAN_ARG_CHECK(mod_sw > 0, "BigInt::mod_add modulus must be positive");

   this->grow_to(mod_sw);
   s.grow_to(mod_sw);

   // First mod_sw for p - s, 2*mod_sw for bigint_addsub workspace
   if(ws.size() < 3 * mod_sw) {
      ws.resize(3 * mod_sw);
   }

   // NOLINTBEGIN(readability-container-data-pointer)

   word borrow = bigint_sub3(&ws[0], mod._data(), mod_sw, s._data(), mod_sw);
   BOTAN_DEBUG_ASSERT(borrow == 0);
   BOTAN_UNUSED(borrow);

   // Compute t - ws
   borrow = bigint_sub3(&ws[mod_sw], this->_data(), mod_sw, &ws[0], mod_sw);

   // Compute t + s
   bigint_add3(&ws[mod_sw * 2], this->_data(), mod_sw, s._data(), mod_sw);

   CT::conditional_copy_mem(borrow, &ws[0], &ws[mod_sw * 2], &ws[mod_sw], mod_sw);
   set_words(&ws[0], mod_sw);

   // NOLINTEND(readability-container-data-pointer)

   return (*this);
}

BigInt& BigInt::mod_sub(const BigInt& s, const BigInt& mod, secure_vector<word>& ws) {
   if(this->is_negative() || s.is_negative() || mod.is_negative()) {
      throw Invalid_Argument("BigInt::mod_sub expects all arguments are positive");
   }

   // We are assuming in this function that *this and s are no more than mod_sw words long
   BOTAN_DEBUG_ASSERT(*this < mod);
   BOTAN_DEBUG_ASSERT(s < mod);

   const size_t mod_sw = mod.sig_words();

   this->grow_to(mod_sw);
   s.grow_to(mod_sw);

   if(ws.size() < mod_sw) {
      ws.resize(mod_sw);
   }

   const word borrow = bigint_sub3(ws.data(), mutable_data(), mod_sw, s._data(), mod_sw);

   // Conditionally add back the modulus
   bigint_cnd_add(borrow, ws.data(), mod._data(), mod_sw);

   copy_mem(mutable_data(), ws.data(), mod_sw);

   return (*this);
}

BigInt& BigInt::mod_mul(uint8_t y, const BigInt& mod, secure_vector<word>& ws) {
   BOTAN_ARG_CHECK(this->is_negative() == false, "*this must be positive");
   BOTAN_ARG_CHECK(y < 16, "y too large");

   BOTAN_DEBUG_ASSERT(*this < mod);

   *this *= static_cast<word>(y);
   this->reduce_below(mod, ws);
   return (*this);
}

BigInt& BigInt::rev_sub(const word y[], size_t y_sw, secure_vector<word>& ws) {
   BOTAN_UNUSED(ws);
   BigInt y_bn;
   y_bn.m_data.set_words(y, y_sw);
   *this = y_bn - *this;
   return (*this);
}

/*
* Multiplication Operator
*/
BigInt& BigInt::operator*=(const BigInt& y) {
   secure_vector<word> ws;
   return this->mul(y, ws);
}

BigInt& BigInt::mul(const BigInt& y, secure_vector<word>& ws) {
   const size_t x_sw = sig_words();
   const size_t y_sw = y.sig_words();
   set_sign((sign() == y.sign()) ? Positive : Negative);

   if(x_sw == 0 || y_sw == 0) {
      clear();
      set_sign(Positive);
   } else if(x_sw == 1 && y_sw > 0) {
      grow_to(y_sw + 1);
      bigint_linmul3(mutable_data(), y._data(), y_sw, word_at(0));
   } else {
      const size_t new_size = x_sw + y_sw + 1;
      if(ws.size() < new_size) {
         ws.resize(new_size);
      }
      secure_vector<word> z_reg(new_size);

      bigint_mul(z_reg.data(), z_reg.size(), _data(), size(), x_sw, y._data(), y.size(), y_sw, ws.data(), ws.size());

      this->swap_reg(z_reg);
   }

   return (*this);
}

BigInt& BigInt::square(secure_vector<word>& ws) {
   const size_t sw = sig_words();

   secure_vector<word> z(2 * sw);
   ws.resize(z.size());

   bigint_sqr(z.data(), z.size(), _data(), size(), sw, ws.data(), ws.size());

   swap_reg(z);
   set_sign(BigInt::Positive);

   return (*this);
}

BigInt& BigInt::operator*=(word y) {
   if(y == 0) {
      clear();
      set_sign(Positive);
   }

   const word carry = bigint_linmul2(mutable_data(), size(), y);
   set_word_at(size(), carry);

   return (*this);
}

/*
* Division Operator
*/
BigInt& BigInt::operator/=(const BigInt& y) {
   if(y.sig_words() == 1 && is_power_of_2(y.word_at(0))) {
      (*this) >>= (y.bits() - 1);
   } else {
      (*this) = (*this) / y;
   }
   return (*this);
}

/*
* Modulo Operator
*/
BigInt& BigInt::operator%=(const BigInt& mod) {
   return (*this = (*this) % mod);
}

/*
* Modulo Operator
*/
word BigInt::operator%=(word mod) {
   if(mod == 0) {
      throw Invalid_Argument("BigInt::operator%= divide by zero");
   }

   word remainder = 0;

   if(is_power_of_2(mod)) {
      remainder = (word_at(0) & (mod - 1));
   } else {
      const size_t sw = sig_words();
      for(size_t i = sw; i > 0; --i) {
         remainder = bigint_modop_vartime(remainder, word_at(i - 1), mod);
      }
   }

   if(remainder != 0 && sign() == BigInt::Negative) {
      remainder = mod - remainder;
   }

   m_data.set_to_zero();
   m_data.set_word_at(0, remainder);
   set_sign(BigInt::Positive);
   return remainder;
}

/*
* Left Shift Operator
*/
BigInt& BigInt::operator<<=(size_t shift) {
   const size_t sw = sig_words();
   const size_t new_size = sw + (shift + WordInfo<word>::bits - 1) / WordInfo<word>::bits;

   m_data.grow_to(new_size);

   bigint_shl1(m_data.mutable_data(), new_size, sw, shift);

   return (*this);
}

/*
* Right Shift Operator
*/
BigInt& BigInt::operator>>=(size_t shift) {
   bigint_shr1(m_data.mutable_data(), m_data.size(), shift);

   if(is_negative() && is_zero()) {
      set_sign(Positive);
   }

   return (*this);
}

}  // namespace Botan

1	/*
2	* (C) 1999-2007,2018 Jack Lloyd
3	* 2016 Matthias Gierlings
4	*
5	* Botan is released under the Simplified BSD License (see license.txt)
6	*/
7
8	#include <botan/bigint.h>
9
10	#include <botan/internal/bit_ops.h>
11	#include <botan/internal/mp_core.h>
12	#include <algorithm>
13
14	namespace Botan {
15
16	BigInt& BigInt::add(const word y[], size_t y_words, Sign y_sign) {	5,592,449✔
17	const size_t x_sw = sig_words();	5,592,449✔
18
19	grow_to(std::max(x_sw, y_words) + 1);	5,662,545✔
20
21	if(sign() == y_sign) {	5,592,449✔
22	word carry = bigint_add2(mutable_data(), size() - 1, y, y_words);	2,008,319✔
23	mutable_data()[size() - 1] += carry;	2,008,319✔
24	} else {
25	const int32_t relative_size = bigint_cmp(_data(), x_sw, y, y_words);	3,584,130✔
26
27	if(relative_size >= 0) {	3,584,130✔
28	// *this >= y
29	bigint_sub2(mutable_data(), x_sw, y, y_words);	3,527,079✔
30	} else {
31	// this < y: compute this = y - *this
32	bigint_sub2_rev(mutable_data(), y, y_words);	57,051✔
33	}
34
35	if(relative_size < 0) {	3,584,130✔
36	set_sign(y_sign);	57,051✔
37	} else if(relative_size == 0) {	3,527,079✔
38	set_sign(Positive);	53,117✔
39	}
40	}
41
42	return (*this);	5,592,449✔
43	}
44
45	BigInt& BigInt::mod_add(const BigInt& s, const BigInt& mod, secure_vector<word>& ws) {	970,066✔
46	if(this->is_negative() \|\| s.is_negative() \|\| mod.is_negative()) {	970,066✔
47	throw Invalid_Argument("BigInt::mod_add expects all arguments are positive");	×
48	}
49
50	BOTAN_DEBUG_ASSERT(*this < mod);	970,066✔
51	BOTAN_DEBUG_ASSERT(s < mod);	970,066✔
52
53	/*
54	t + s or t + s - p == t - (p - s)
55
56	So first compute ws = p - s
57
58	Then compute t + s and t - ws
59
60	If t - ws does not borrow, then that is the correct valued
61	*/
62
63	const size_t mod_sw = mod.sig_words();	970,066✔
64	BOTAN_ARG_CHECK(mod_sw > 0, "BigInt::mod_add modulus must be positive");	970,066✔
65
66	this->grow_to(mod_sw);	970,066✔
67	s.grow_to(mod_sw);	970,066✔
68
69	// First mod_sw for p - s, 2*mod_sw for bigint_addsub workspace
70	if(ws.size() < 3 * mod_sw) {	970,066✔
71	ws.resize(3 * mod_sw);	615,876✔
72	}
73
74	// NOLINTBEGIN(readability-container-data-pointer)
75
76	word borrow = bigint_sub3(&ws[0], mod._data(), mod_sw, s._data(), mod_sw);	970,066✔
77	BOTAN_DEBUG_ASSERT(borrow == 0);	970,066✔
78	BOTAN_UNUSED(borrow);	970,066✔
79
80	// Compute t - ws
81	borrow = bigint_sub3(&ws[mod_sw], this->_data(), mod_sw, &ws[0], mod_sw);	970,066✔
82
83	// Compute t + s
84	bigint_add3(&ws[mod_sw * 2], this->_data(), mod_sw, s._data(), mod_sw);	970,066✔
85
86	CT::conditional_copy_mem(borrow, &ws[0], &ws[mod_sw * 2], &ws[mod_sw], mod_sw);	970,066✔
87	set_words(&ws[0], mod_sw);	970,066✔
88
89	// NOLINTEND(readability-container-data-pointer)
90
91	return (*this);	970,066✔
92	}
93
94	BigInt& BigInt::mod_sub(const BigInt& s, const BigInt& mod, secure_vector<word>& ws) {	15,711,534✔
95	if(this->is_negative() \|\| s.is_negative() \|\| mod.is_negative()) {	15,711,534✔
96	throw Invalid_Argument("BigInt::mod_sub expects all arguments are positive");	×
97	}
98
99	// We are assuming in this function that *this and s are no more than mod_sw words long
100	BOTAN_DEBUG_ASSERT(*this < mod);	15,711,534✔
101	BOTAN_DEBUG_ASSERT(s < mod);	15,711,534✔
102
103	const size_t mod_sw = mod.sig_words();	15,711,534✔
104
105	this->grow_to(mod_sw);	15,711,534✔
106	s.grow_to(mod_sw);	15,711,534✔
107
108	if(ws.size() < mod_sw) {	15,711,534✔
109	ws.resize(mod_sw);	×
110	}
111
112	const word borrow = bigint_sub3(ws.data(), mutable_data(), mod_sw, s._data(), mod_sw);	15,711,534✔
113
114	// Conditionally add back the modulus
115	bigint_cnd_add(borrow, ws.data(), mod._data(), mod_sw);	15,711,534✔
116
117	copy_mem(mutable_data(), ws.data(), mod_sw);	15,711,534✔
118
119	return (*this);	15,711,534✔
120	}
121
122	BigInt& BigInt::mod_mul(uint8_t y, const BigInt& mod, secure_vector<word>& ws) {	6,908,180✔
123	BOTAN_ARG_CHECK(this->is_negative() == false, "*this must be positive");	6,908,180✔
124	BOTAN_ARG_CHECK(y < 16, "y too large");	6,908,180✔
125
126	BOTAN_DEBUG_ASSERT(*this < mod);	6,908,180✔
127
128	this = static_cast<word>(y);	6,908,180✔
129	this->reduce_below(mod, ws);	6,908,180✔
130	return (*this);	6,908,180✔
131	}
132
133	BigInt& BigInt::rev_sub(const word y[], size_t y_sw, secure_vector<word>& ws) {	×
134	BOTAN_UNUSED(ws);	×
135	BigInt y_bn;	×
136	y_bn.m_data.set_words(y, y_sw);	×
137	this = y_bn - this;	×
138	return (*this);	×
139	}	×
140
141	/*
142	* Multiplication Operator
143	*/
144	BigInt& BigInt::operator*=(const BigInt& y) {	527✔
145	secure_vector<word> ws;	527✔
146	return this->mul(y, ws);	527✔
147	}	527✔
148
149	BigInt& BigInt::mul(const BigInt& y, secure_vector<word>& ws) {	10,029✔
150	const size_t x_sw = sig_words();	10,029✔
151	const size_t y_sw = y.sig_words();	10,029✔
152	set_sign((sign() == y.sign()) ? Positive : Negative);	10,099✔
153
154	if(x_sw == 0 \|\| y_sw == 0) {	10,029✔
155	clear();	33✔
156	set_sign(Positive);	33✔
157	} else if(x_sw == 1 && y_sw > 0) {	9,996✔
158	grow_to(y_sw + 1);	329✔
159	bigint_linmul3(mutable_data(), y._data(), y_sw, word_at(0));	658✔
160	} else {
161	const size_t new_size = x_sw + y_sw + 1;	9,667✔
162	if(ws.size() < new_size) {	9,667✔
163	ws.resize(new_size);	9,667✔
164	}
165	secure_vector<word> z_reg(new_size);	9,667✔
166
167	bigint_mul(z_reg.data(), z_reg.size(), _data(), size(), x_sw, y._data(), y.size(), y_sw, ws.data(), ws.size());	9,667✔
168
169	this->swap_reg(z_reg);	9,667✔
170	}	9,667✔
171
172	return (*this);	10,029✔
173	}
174
175	BigInt& BigInt::square(secure_vector<word>& ws) {	10,523✔
176	const size_t sw = sig_words();	10,523✔
177
178	secure_vector<word> z(2 * sw);	10,523✔
179	ws.resize(z.size());	10,523✔
180
181	bigint_sqr(z.data(), z.size(), _data(), size(), sw, ws.data(), ws.size());	10,523✔
182
183	swap_reg(z);	10,523✔
184	set_sign(BigInt::Positive);	10,523✔
185
186	return (*this);	10,523✔
187	}	10,523✔
188
189	BigInt& BigInt::operator*=(word y) {	7,287,308✔
190	if(y == 0) {	7,287,308✔
191	clear();	×
192	set_sign(Positive);	×
193	}
194
195	const word carry = bigint_linmul2(mutable_data(), size(), y);	7,287,308✔
196	set_word_at(size(), carry);	7,287,308✔
197
198	return (*this);	7,287,308✔
199	}
200
201	/*
202	* Division Operator
203	*/
204	BigInt& BigInt::operator/=(const BigInt& y) {	929✔
205	if(y.sig_words() == 1 && is_power_of_2(y.word_at(0))) {	1,620✔
206	(*this) >>= (y.bits() - 1);	85✔
207	} else {
208	(this) = (this) / y;	844✔
209	}
210	return (*this);	929✔
211	}
212
213	/*
214	* Modulo Operator
215	*/
216	BigInt& BigInt::operator%=(const BigInt& mod) {	325,051✔
217	return (this = (this) % mod);	325,051✔
218	}
219
220	/*
221	* Modulo Operator
222	*/
223	word BigInt::operator%=(word mod) {	33✔
224	if(mod == 0) {	33✔
225	throw Invalid_Argument("BigInt::operator%= divide by zero");	×
226	}
227
228	word remainder = 0;	33✔
229
230	if(is_power_of_2(mod)) {	33✔
231	remainder = (word_at(0) & (mod - 1));	10✔
232	} else {
233	const size_t sw = sig_words();	28✔
234	for(size_t i = sw; i > 0; --i) {	79✔
235	remainder = bigint_modop_vartime(remainder, word_at(i - 1), mod);	102✔
236	}
237	}
238
239	if(remainder != 0 && sign() == BigInt::Negative) {	33✔
240	remainder = mod - remainder;	12✔
241	}
242
243	m_data.set_to_zero();	33✔
244	m_data.set_word_at(0, remainder);	33✔
245	set_sign(BigInt::Positive);	33✔
246	return remainder;	33✔
247	}
248
249	/*
250	* Left Shift Operator
251	*/
252	BigInt& BigInt::operator<<=(size_t shift) {	12,142,064✔
253	const size_t sw = sig_words();	12,142,064✔
254	const size_t new_size = sw + (shift + WordInfo<word>::bits - 1) / WordInfo<word>::bits;	12,142,064✔
255
256	m_data.grow_to(new_size);	12,142,064✔
257
258	bigint_shl1(m_data.mutable_data(), new_size, sw, shift);	12,142,064✔
259
260	return (*this);	12,142,064✔
261	}
262
263	/*
264	* Right Shift Operator
265	*/
266	BigInt& BigInt::operator>>=(size_t shift) {	7,554,295✔
267	bigint_shr1(m_data.mutable_data(), m_data.size(), shift);	7,554,295✔
268
269	if(is_negative() && is_zero()) {	7,645,780✔
270	set_sign(Positive);	8✔
271	}
272
273	return (*this);	7,554,295✔
274	}
275
276	} // namespace Botan

randombit / botan / 16511306696

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous