Merge #280

280: Release 0.4.4 r=cuviper a=cuviper Co-authored-by: Samuel Moelius <[email protected]> Co-authored-by: Josh Stone <[email protected]>
rust-num · Aug 22, 2023 · 7ed1af6 · 7ed1af6
2 parents 2cea7f4 + 4e6a01f
commit 7ed1af6
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 5 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -8,7 +8,7 @@ categories = [ "algorithms", "data-structures", "science" ]
 license = "MIT OR Apache-2.0"
 name = "num-bigint"
 repository = "https://github.com/rust-num/num-bigint"
-version = "0.4.3"
+version = "0.4.4"
 readme = "README.md"
 build = "build.rs"
 exclude = ["/bors.toml", "/ci/*", "/.github/*"]

diff --git a/RELEASES.md b/RELEASES.md
@@ -1,3 +1,21 @@
+# Release 0.4.4 (2023-08-22)
+
+- [Implemented `From<bool>` for `BigInt` and `BigUint`.][239]
+- [Implemented `num_traits::Euclid` and `CheckedEuclid` for `BigInt` and `BigUint`.][245]
+- [Implemented ties-to-even for `BigInt` and `BigUint::to_f32` and `to_f64`.][271]
+- [Implemented `num_traits::FromBytes` and `ToBytes` for `BigInt` and `BigUint`.][276]
+- Limited pre-allocation from serde size hints against potential OOM.
+- Miscellaneous other code cleanups and maintenance tasks.
+
+**Contributors**: @AaronKutch, @archseer, @cuviper, @dramforever, @icecream17,
+@icedrocket, @janmarthedal, @jaybosamiya, @OliveIsAWord, @PatrickNorton,
+@smoelius, @waywardmonkeys
+
+[239]: https://github.com/rust-num/num-bigint/pull/239
+[245]: https://github.com/rust-num/num-bigint/pull/245
+[271]: https://github.com/rust-num/num-bigint/pull/271
+[276]: https://github.com/rust-num/num-bigint/pull/276
+
 # Release 0.4.3 (2021-11-02)
 
 - [GHSA-v935-pqmr-g8v9]: [Fix unexpected panics in multiplication.][228]

diff --git a/ci/big_serde/Cargo.toml b/ci/big_serde/Cargo.toml
@@ -6,6 +6,7 @@ edition = "2018"
 
 [dependencies]
 num-traits = "0.2.11"
+serde = "1.0"
 serde_test = "1.0"
 
 [dependencies.num-bigint]

diff --git a/ci/big_serde/src/lib.rs b/ci/big_serde/src/lib.rs
@@ -12,7 +12,9 @@
 
 use num_bigint::{BigInt, BigUint};
 use num_traits::{One, Zero};
-use serde_test::{assert_tokens, Token};
+use serde::{de::DeserializeOwned, Serialize};
+use serde_test::{assert_de_tokens, assert_ser_tokens, assert_tokens, Token};
+use std::{fmt::Debug, panic::catch_unwind};
 
 #[test]
 fn biguint_zero() {
@@ -128,3 +130,34 @@ fn big_digits() {
         assert_tokens(&-n, &tokens);
     }
 }
+
+#[test]
+fn bad_size_hint_int() {
+    bad_size_hint::<BigInt>(&[Token::Tuple { len: 2 }, Token::I8(1)], &[Token::TupleEnd]);
+}
+
+#[test]
+fn bad_size_hint_uint() {
+    bad_size_hint::<BigUint>(&[], &[]);
+}
+
+fn bad_size_hint<T: Debug + DeserializeOwned + One + PartialEq + Serialize>(
+    prefix: &[Token],
+    suffix: &[Token],
+) {
+    let mut tokens = [
+        prefix,
+        &[Token::Seq { len: Some(1) }, Token::U32(1), Token::SeqEnd],
+        suffix,
+    ]
+    .concat();
+
+    assert_tokens(&T::one(), &tokens);
+
+    tokens[prefix.len()] = Token::Seq {
+        len: Some(usize::max_value()),
+    };
+
+    catch_unwind(|| assert_ser_tokens(&T::one(), &tokens)).unwrap_err();
+    assert_de_tokens(&T::one(), &tokens);
+}
diff --git a/src/biguint/serde.rs b/src/biguint/serde.rs
@@ -2,10 +2,21 @@ use super::{biguint_from_vec, BigUint};
 
 use crate::std_alloc::Vec;
 
-use core::fmt;
+use core::{cmp, fmt, mem};
 use serde::de::{SeqAccess, Visitor};
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 
+// `cautious` is based on the function of the same name in `serde`, but specialized to `u32`:
+// https://github.com/dtolnay/serde/blob/399ef081ecc36d2f165ff1f6debdcbf6a1dc7efb/serde/src/private/size_hint.rs#L11-L22
+fn cautious(hint: Option<usize>) -> usize {
+    const MAX_PREALLOC_BYTES: usize = 1024 * 1024;
+
+    cmp::min(
+        hint.unwrap_or(0),
+        MAX_PREALLOC_BYTES / mem::size_of::<u32>(),
+    )
+}
+
 impl Serialize for BigUint {
     #[cfg(not(u64_digit))]
     fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@@ -70,7 +81,7 @@ impl<'de> Visitor<'de> for U32Visitor {
     where
         S: SeqAccess<'de>,
     {
-        let len = seq.size_hint().unwrap_or(0);
+        let len = cautious(seq.size_hint());
         let mut data = Vec::with_capacity(len);
 
         while let Some(value) = seq.next_element::<u32>()? {
@@ -88,7 +99,7 @@ impl<'de> Visitor<'de> for U32Visitor {
         use crate::big_digit::BigDigit;
         use num_integer::Integer;
 
-        let u32_len = seq.size_hint().unwrap_or(0);
+        let u32_len = cautious(seq.size_hint());
         let len = Integer::div_ceil(&u32_len, &2);
         let mut data = Vec::with_capacity(len);