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
use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use metrohash::MetroHash128;
use std::{
    hash::Hasher,
    io,
    io::{Read, Write},
    mem::size_of,
};

type Word = u32;
const WORD_BITS: u32 = 32;
const WORD_LEN_BITS: usize = 5;
const WORD_MASK: u32 = 0x55555555;

#[derive(Debug, PartialEq, Eq)]
pub struct DuplicatesSketch {
    probes: u32,
    words: Vec<Word>,
}

impl DuplicatesSketch {
    pub fn new(probes: u32, size: usize) -> DuplicatesSketch {
        assert!(probes > 0);

        let size = size / size_of::<Word>();
        let size = if size.is_power_of_two() {
            size.next_power_of_two()
        } else {
            size
        };

        DuplicatesSketch {
            probes,
            words: vec![0; size],
        }
    }

    pub fn is_compatible(&self, other: &DuplicatesSketch) -> bool {
        self.probes == other.probes && self.words.len() == other.words.len()
    }

    pub fn merge(&mut self, other: &DuplicatesSketch) {
        assert!(self.is_compatible(other));
        for (a, b) in self.words.iter_mut().zip(other.words.iter()) {
            *a |= *b | (*a & WORD_MASK).wrapping_add(*b & WORD_MASK);
        }
    }

    #[inline]
    pub fn insert(&mut self, buf: &[u8]) {
        for (word_ix, bit_ix) in self.probe_iter(buf) {
            let word = &mut self.words[word_ix];
            *word |= (*word & 1 << bit_ix).wrapping_add(1 << bit_ix);
        }
    }

    #[inline]
    pub fn has_duplicate(&self, buf: &[u8]) -> bool {
        self.probe_iter(buf)
            .all(|(word_ix, bit_ix)| self.words[word_ix] >> bit_ix & 0b11 > 1)
    }

    #[inline]
    fn probe_iter(&self, buf: &[u8]) -> impl Iterator<Item = (usize, u32)> {
        let mut hasher = MetroHash128::new();
        hasher.write(buf);
        let (hash_a, hash_b) = hasher.finish128();

        let mut hash = hash_a;
        let len = self.words.len();
        (0..self.probes).map(move |i| {
            hash = hash.wrapping_add((i as u64).wrapping_mul(hash_b));

            (
                (hash >> (WORD_LEN_BITS - 1)) as usize & (len - 1),
                (hash & (WORD_BITS / 2 - 1) as u64) as u32 * 2,
            )
        })
    }

    pub fn serialize(&self, mut file: impl Write) -> io::Result<()> {
        file.write_u32::<LittleEndian>(self.probes)?;
        file.write_u64::<LittleEndian>(self.words.len() as u64)?;

        for &word in &self.words {
            file.write_u32::<LittleEndian>(word)?;
        }

        Ok(())
    }

    pub fn deserialize(mut file: impl Read) -> io::Result<Option<DuplicatesSketch>> {
        let probes = match file.read_u32::<LittleEndian>() {
            Err(error) if error.kind() == io::ErrorKind::UnexpectedEof => return Ok(None),
            probes => probes?,
        };

        let mut words = vec![0; file.read_u64::<LittleEndian>()? as usize];
        file.read_u32_into::<LittleEndian>(&mut words)?;

        Ok(Some(DuplicatesSketch { probes, words }))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use proptest::{collection::vec, prelude::*};
    use std::{collections::HashMap, io::Cursor};

    const STRING: &[u8] = b"asdf";

    #[test]
    fn no_dup() {
        let mut sketch = DuplicatesSketch::new(16, 4096);
        sketch.insert(STRING);
        assert!(!sketch.has_duplicate(STRING));
    }

    #[test]
    fn dup() {
        let mut sketch = DuplicatesSketch::new(16, 4096);
        sketch.insert(STRING);
        sketch.insert(STRING);
        assert!(sketch.has_duplicate(STRING));
    }

    #[test]
    fn trip() {
        let mut sketch = DuplicatesSketch::new(16, 4096);
        sketch.insert(STRING);
        sketch.insert(STRING);
        sketch.insert(STRING);
        assert!(sketch.has_duplicate(STRING));
    }

    #[test]
    fn quad() {
        let mut sketch = DuplicatesSketch::new(16, 4096);
        sketch.insert(STRING);
        sketch.insert(STRING);
        sketch.insert(STRING);
        sketch.insert(STRING);
        assert!(sketch.has_duplicate(STRING));
    }

    fn check(sketch: &DuplicatesSketch, bufs: &Vec<Vec<u8>>) -> Result<(), TestCaseError> {
        let mut counts = HashMap::new();
        for buf in bufs {
            *counts.entry(buf.clone()).or_insert(0) += 1;
        }

        for buf in bufs {
            prop_assert!(*counts.get(buf).unwrap() < 2 || sketch.has_duplicate(&buf));
        }

        Ok(())
    }

    prop_compose! {
        /// Generate vecs of vecs of bytes, but make it likely for there to be duplicated buffers
        fn duplicated_bufs()
                          (len in 1..100usize)
                          (bufs in vec(vec(0..=255u8, 0..100usize), len),
                           indices in vec(0..len, 0..100usize))
                          -> Vec<Vec<u8>>
        {
            indices
                .into_iter()
                .map(|i| bufs[i].clone())
                .collect()
        }
    }

    prop_compose! {
        /// Generate multiple vecs of byte buffers, but make it likely for there to be duplicated
        /// buffers across different outer vecs
        fn duplicated_multibufs()
                               (len in 1..100usize)
                               (bufs in vec(vec(0..=255u8, 0..100usize), len),
                                indices in vec(vec(0..len, 0..100usize), 0..100usize))
                               -> Vec<Vec<Vec<u8>>>
        {
            indices
                .into_iter()
                .map(|indices| indices
                    .into_iter()
                    .map(|i| bufs[i].clone())
                    .collect())
                .collect()
        }
    }

    proptest! {
        #[test]
        fn insert(bufs in duplicated_bufs()) {
            let mut sketch = DuplicatesSketch::new(4, 1024);
            bufs.iter().for_each(|buf| sketch.insert(buf));
            check(&sketch, &bufs)?;
        }

        #[test]
        fn merge(bufs in duplicated_multibufs()) {
            let mut sketch = DuplicatesSketch::new(4, 1024);

            for bufs in &bufs {
                let mut sub_sketch = DuplicatesSketch::new(4, 1024);
                bufs.iter().for_each(|buf| sub_sketch.insert(buf));
                sketch.merge(&sub_sketch);
            }

            let merged_bufs = bufs
                .iter()
                .flat_map(|bufs| bufs.iter().cloned())
                .collect();

            check(&sketch, &merged_bufs)?;
        }

        #[test]
        fn serialize(bufs in duplicated_bufs()) {
            let mut sketch_a = DuplicatesSketch::new(4, 1024);
            bufs.iter().for_each(|buf| sketch_a.insert(buf));

            let mut buf = Vec::new();
            sketch_a.serialize(Cursor::new(&mut buf))?;
            let sketch_b = DuplicatesSketch::deserialize(Cursor::new(buf))?.unwrap();

            prop_assert_eq!(sketch_a, sketch_b);
        }
    }
}