1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
use crate::{
    arch::word::Word,
    buffer::Buffer,
    ibig::IBig,
    primitive::{split_dword, WORD_BITS_USIZE},
    repr::{Repr, TypedReprRef},
    ubig::UBig,
    Sign,
};
use alloc::{string::ToString, vec::Vec};
use core::fmt::{self, Formatter};
use serde::{
    de::{Deserialize, Deserializer, SeqAccess, Visitor},
    ser::{Serialize, SerializeSeq, SerializeTuple, Serializer},
};
use static_assertions::const_assert;

// We ensure that the max size of a word is 64-bit, if we are going to
// support 128 bit word, it's going to be a break change.
const_assert!(64 % WORD_BITS_USIZE == 0);
const WORDS_PER_U64: usize = 64 / WORD_BITS_USIZE;

// XXX: shall we directly serialize to bytes array (either little- or big-endian). This improves portability
//      but affects efficiency. We might also consider implement different serialization strategy using other
//      crates (like tkyv)? see https://github.com/djkoloski/rust_serialization_benchmark

impl<'a> Serialize for TypedReprRef<'a> {
    #[allow(clippy::useless_conversion)]
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match *self {
            TypedReprRef::RefSmall(0) => serializer.serialize_seq(Some(0))?.end(),
            TypedReprRef::RefSmall(dword) => {
                let (lo, hi) = split_dword(dword);
                if WORDS_PER_U64 == 1 && hi != 0 {
                    let mut seq = serializer.serialize_seq(Some(2))?;
                    seq.serialize_element(&lo)?;
                    seq.serialize_element(&hi)?;
                    seq.end()
                } else {
                    let mut chunk = u64::from(lo);
                    #[allow(arithmetic_overflow)]
                    if hi != 0 {
                        // this won't overflow because WORDS_PER_U64 > 1 if hi != 0
                        chunk |= u64::from(hi) << WORD_BITS_USIZE;
                    }
                    let mut seq = serializer.serialize_seq(Some(1))?;
                    seq.serialize_element(&chunk)?;
                    seq.end()
                }
            }
            TypedReprRef::RefLarge(words) => {
                let chunks = words.chunks(WORDS_PER_U64);
                let mut seq = serializer.serialize_seq(Some(chunks.len()))?;
                for chunk in chunks {
                    let mut word_u64: u64 = 0;
                    for (i, word) in chunk.iter().enumerate() {
                        word_u64 |= u64::from(*word) << (i * WORD_BITS_USIZE);
                    }
                    seq.serialize_element(&word_u64)?;
                }
                seq.end()
            }
        }
    }
}

impl Serialize for UBig {
    #[inline]
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            serializer.serialize_str(&self.to_string())
        } else {
            self.repr().serialize(serializer)
        }
    }
}

impl<'de> Deserialize<'de> for UBig {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        if deserializer.is_human_readable() {
            deserializer.deserialize_str(UBigVisitor)
        } else {
            deserializer.deserialize_seq(UBigVisitor)
        }
    }
}

/// Currently all the data in the big integer is serialized as u64 chunks
struct UBigVisitor;

impl<'de> Visitor<'de> for UBigVisitor {
    type Value = UBig;

    fn expecting(&self, f: &mut Formatter) -> fmt::Result {
        write!(f, "a string or a sequence of 64-bit words")
    }

    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
    where
        E: serde::de::Error,
    {
        match UBig::from_str_with_radix_prefix(v) {
            Ok((n, _)) => Ok(n),
            Err(e) => Err(serde::de::Error::custom(e)),
        }
    }

    fn visit_seq<A: SeqAccess<'de>>(self, mut seq: A) -> Result<UBig, A::Error> {
        match seq.size_hint() {
            Some(0) => {
                assert!(seq.next_element::<u64>()?.is_none());
                Ok(UBig::ZERO)
            }
            Some(1) => {
                let word_64: u64 = seq.next_element()?.unwrap();
                assert!(seq.next_element::<u64>()?.is_none());
                Ok(UBig::from(word_64))
            }
            Some(num_words_64) => {
                let mut buffer = Buffer::allocate(len_64_to_max_len(num_words_64));
                for _ in 0..num_words_64 {
                    let word_64: u64 = seq.next_element()?.unwrap();
                    push_word_64(&mut buffer, word_64);
                }
                assert!(seq.next_element::<u64>()?.is_none());
                Ok(UBig(Repr::from_buffer(buffer)))
            }
            None => {
                let mut words_64 = Vec::new();
                while let Some(word_64) = seq.next_element()? {
                    words_64.push(word_64);
                }
                let mut buffer = Buffer::allocate(len_64_to_max_len(words_64.len()));
                for word_64 in words_64 {
                    push_word_64(&mut buffer, word_64);
                }
                Ok(UBig(Repr::from_buffer(buffer)))
            }
        }
    }
}

fn push_word_64(buffer: &mut Buffer, word_64: u64) {
    for i in 0..WORDS_PER_U64 {
        buffer.push((word_64 >> (i * WORD_BITS_USIZE)) as Word);
    }
}

#[allow(clippy::absurd_extreme_comparisons)]
fn len_64_to_max_len(len_64: usize) -> usize {
    #[allow(clippy::redundant_closure)]
    len_64
        .checked_mul(WORDS_PER_U64)
        .expect("The number to be deserialized is too large")
}

impl Serialize for IBig {
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            serializer.serialize_str(&self.to_string())
        } else {
            let (sign, repr) = self.as_sign_repr();
            let mut tup = serializer.serialize_tuple(2)?;
            tup.serialize_element(&(sign == Sign::Negative))?;
            tup.serialize_element(&repr)?;
            tup.end()
        }
    }
}

impl<'de> Deserialize<'de> for IBig {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        if deserializer.is_human_readable() {
            let s: &str = Deserialize::deserialize(deserializer)?;
            match IBig::from_str_with_radix_prefix(s) {
                Ok((n, _)) => Ok(n),
                Err(e) => Err(serde::de::Error::custom(e)),
            }
        } else {
            let (sign, magnitude): (bool, UBig) = Deserialize::deserialize(deserializer)?;
            let sign = if sign { Sign::Negative } else { Sign::Positive };
            Ok(IBig(magnitude.0.with_sign(sign)))
        }
    }
}