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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
#![allow(clippy::integer_arithmetic)]
use {
serde::{
de::{Error as _, SeqAccess, Visitor},
ser::SerializeTuple,
Deserializer, Serializer,
},
std::{fmt, marker::PhantomData},
};
pub trait VarInt: Sized {
fn visit_seq<'de, A>(seq: A) -> Result<Self, A::Error>
where
A: SeqAccess<'de>;
fn serialize<S>(self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer;
}
struct VarIntVisitor<T> {
phantom: PhantomData<T>,
}
impl<'de, T> Visitor<'de> for VarIntVisitor<T>
where
T: VarInt,
{
type Value = T;
fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
formatter.write_str("a VarInt")
}
fn visit_seq<A>(self, seq: A) -> Result<Self::Value, A::Error>
where
A: SeqAccess<'de>,
{
T::visit_seq(seq)
}
}
pub fn serialize<S, T>(value: &T, serializer: S) -> Result<S::Ok, S::Error>
where
T: Copy + VarInt,
S: Serializer,
{
(*value).serialize(serializer)
}
pub fn deserialize<'de, D, T>(deserializer: D) -> Result<T, D::Error>
where
D: Deserializer<'de>,
T: VarInt,
{
deserializer.deserialize_tuple(
(std::mem::size_of::<T>() * 8 + 6) / 7,
VarIntVisitor {
phantom: PhantomData::default(),
},
)
}
macro_rules! impl_var_int {
($type:ty) => {
impl VarInt for $type {
fn visit_seq<'de, A>(mut seq: A) -> Result<Self, A::Error>
where
A: SeqAccess<'de>,
{
let mut out = 0;
let mut shift = 0u32;
while shift < <$type>::BITS {
let byte = match seq.next_element::<u8>()? {
None => return Err(A::Error::custom("Invalid Sequence")),
Some(byte) => byte,
};
out |= ((byte & 0x7F) as Self) << shift;
if byte & 0x80 == 0 {
if (out >> shift) as u8 != byte {
return Err(A::Error::custom("Last Byte Truncated"));
}
if byte == 0u8 && (shift != 0 || out != 0) {
return Err(A::Error::custom("Invalid Trailing Zeros"));
}
return Ok(out);
}
shift += 7;
}
Err(A::Error::custom("Left Shift Overflows"))
}
fn serialize<S>(mut self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
let bits = <$type>::BITS - self.leading_zeros();
let num_bytes = ((bits + 6) / 7).max(1) as usize;
let mut seq = serializer.serialize_tuple(num_bytes)?;
while self >= 0x80 {
let byte = ((self & 0x7F) | 0x80) as u8;
seq.serialize_element(&byte)?;
self >>= 7;
}
seq.serialize_element(&(self as u8))?;
seq.end()
}
}
};
}
impl_var_int!(u32);
impl_var_int!(u64);
#[cfg(test)]
mod tests {
use rand::Rng;
#[derive(Debug, Eq, PartialEq, Serialize, Deserialize)]
struct Dummy {
#[serde(with = "super")]
a: u32,
b: u64,
#[serde(with = "super")]
c: u64,
d: u32,
}
#[test]
fn test_serde_varint() {
assert_eq!((std::mem::size_of::<u32>() * 8 + 6) / 7, 5);
assert_eq!((std::mem::size_of::<u64>() * 8 + 6) / 7, 10);
let dummy = Dummy {
a: 698,
b: 370,
c: 146,
d: 796,
};
let bytes = bincode::serialize(&dummy).unwrap();
assert_eq!(bytes.len(), 16);
let other: Dummy = bincode::deserialize(&bytes).unwrap();
assert_eq!(other, dummy);
}
#[test]
fn test_serde_varint_zero() {
let dummy = Dummy {
a: 0,
b: 0,
c: 0,
d: 0,
};
let bytes = bincode::serialize(&dummy).unwrap();
assert_eq!(bytes.len(), 14);
let other: Dummy = bincode::deserialize(&bytes).unwrap();
assert_eq!(other, dummy);
}
#[test]
fn test_serde_varint_max() {
let dummy = Dummy {
a: u32::MAX,
b: u64::MAX,
c: u64::MAX,
d: u32::MAX,
};
let bytes = bincode::serialize(&dummy).unwrap();
assert_eq!(bytes.len(), 27);
let other: Dummy = bincode::deserialize(&bytes).unwrap();
assert_eq!(other, dummy);
}
#[test]
fn test_serde_varint_rand() {
let mut rng = rand::thread_rng();
for _ in 0..100_000 {
let dummy = Dummy {
a: rng.gen::<u32>() >> rng.gen_range(0, u32::BITS),
b: rng.gen::<u64>() >> rng.gen_range(0, u64::BITS),
c: rng.gen::<u64>() >> rng.gen_range(0, u64::BITS),
d: rng.gen::<u32>() >> rng.gen_range(0, u32::BITS),
};
let bytes = bincode::serialize(&dummy).unwrap();
let other: Dummy = bincode::deserialize(&bytes).unwrap();
assert_eq!(other, dummy);
}
}
#[test]
fn test_serde_varint_trailing_zeros() {
let buffer = [0x93, 0xc2, 0xa9, 0x8d, 0x0];
let out = bincode::deserialize::<Dummy>(&buffer);
assert!(out.is_err());
assert_eq!(
format!("{:?}", out),
r#"Err(Custom("Invalid Trailing Zeros"))"#
);
let buffer = [0x80, 0x0];
let out = bincode::deserialize::<Dummy>(&buffer);
assert!(out.is_err());
assert_eq!(
format!("{:?}", out),
r#"Err(Custom("Invalid Trailing Zeros"))"#
);
}
#[test]
fn test_serde_varint_last_byte_truncated() {
let buffer = [0xe4, 0xd7, 0x88, 0xf6, 0x6f, 0xd4, 0xb9, 0x59];
let out = bincode::deserialize::<Dummy>(&buffer);
assert!(out.is_err());
assert_eq!(
format!("{:?}", out),
r#"Err(Custom("Last Byte Truncated"))"#
);
}
#[test]
fn test_serde_varint_shift_overflow() {
let buffer = [0x84, 0xdf, 0x96, 0xfa, 0xef];
let out = bincode::deserialize::<Dummy>(&buffer);
assert!(out.is_err());
assert_eq!(
format!("{:?}", out),
r#"Err(Custom("Left Shift Overflows"))"#
);
}
#[test]
fn test_serde_varint_short_buffer() {
let buffer = [0x84, 0xdf, 0x96, 0xfa];
let out = bincode::deserialize::<Dummy>(&buffer);
assert!(out.is_err());
assert_eq!(format!("{:?}", out), r#"Err(Io(Kind(UnexpectedEof)))"#);
}
#[test]
fn test_serde_varint_fuzz() {
let mut rng = rand::thread_rng();
let mut buffer = [0u8; 36];
let mut num_errors = 0;
for _ in 0..200_000 {
rng.fill(&mut buffer[..]);
match bincode::deserialize::<Dummy>(&buffer) {
Err(_) => {
num_errors += 1;
}
Ok(dummy) => {
let bytes = bincode::serialize(&dummy).unwrap();
assert_eq!(bytes, &buffer[..bytes.len()]);
}
}
}
assert!(num_errors > 2_000);
}
}