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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
#[derive(Debug, Default, Clone)]
pub struct Xor8 {
	Seed: u64,
	BlockLength: u32,
	Fingerprints: Vec<u8> 
}

/*
impl Default for Xor8 {
    fn default () -> Xor8 {
        Xor8{Seed: 0, BlockLength: 0, Fingerprints: Vec::new()}
    }
}
*/

#[derive(Clone, Debug)]
pub struct xorset {
	xormask: u64,
	count: u32
}

#[derive(Debug)]
pub struct hashes {
	h:  u64,
	h0: u32,
	h1: u32,
	h2: u32
}

#[derive(Copy, Clone, Debug)]
pub struct keyindex {
	hash: u64,
	index: u32 
}

pub fn murmur64(mut h: u64) -> u64 {
	h ^= h >> 33;
	h = h.wrapping_mul(0xff51afd7ed558ccd);
	h ^= h >> 33;
	h = h.wrapping_mul(0xc4ceb9fe1a85ec53);
	h ^= h >> 33;
	h
}

pub fn splitmix64(mut seed: u64) -> u64 {
    let mut z = seed.wrapping_add(0x9e3779b97f4a7c15); 
    z = (z ^ (z >> 30)).wrapping_mul(0xbf58476d1ce4e5b9); 
    z = (z ^ (z >> 27)).wrapping_mul(0x94d049bb133111eb);  
    z ^ (z >> 31)
}

pub fn mixsplit(key: u64, seed: u64) -> u64 {
    murmur64(key.wrapping_add(seed)) 
}

pub fn rotl64(n: u64, c: i64) -> u64 {
    (n << (c & 63)) | (n >> ((-c) & 63))
}

// http://lemire.me/blog/2016/06/27/a-fast-alternative-to-the-modulo-reduction/
pub fn reduce(hash: u32, n: u32) -> u32 {
        ((hash as u64).wrapping_mul(n as u64) >> 32) as u32
}

pub fn fingerprint(hash: u64) -> u64 {
	hash ^ (hash >> 32)
}

#[derive(Debug, Default, Clone)]
pub struct XorFilter {
    pub filter: Xor8
}

impl XorFilter {
    
    // TODO
    // type so this works
    // beyond just Xor8
    pub fn new() -> XorFilter { 
        
               XorFilter { 
                    filter: Xor8{Seed: 0, BlockLength: 0, Fingerprints: Vec::new()}
               }
               
    }

    pub fn geth0h1h2(&mut self, k: u64) -> hashes {
        let mut hash = mixsplit(k, self.filter.Seed);
        let mut r0 = hash as u32;
        let mut r1 = rotl64(hash, 21) as u32;
        let mut r2 = rotl64(hash, 42) as u32;
        
        let answer = hashes {
            h: hash,
            h0: reduce(r0, self.filter.BlockLength),
            h1: reduce(r1, self.filter.BlockLength),
            h2: reduce(r2, self.filter.BlockLength),
        };
        
        answer
    }
    
    pub fn geth0(&mut self, hash: u64) -> u32 {
        let r0 = hash as u32;
        reduce(r0, self.filter.BlockLength) 
    }
    
    pub fn geth1(&mut self, hash: u64) -> u32 {
        let r1 = rotl64(hash, 21) as u32;
        reduce(r1, self.filter.BlockLength)
    }
    
    pub fn geth2(&mut self, hash: u64) -> u32 {
        let r2 = rotl64(hash, 42) as u32;
        reduce(r2, self.filter.BlockLength)
    }
    
    pub fn populate(&mut self, keys: &Vec<u64>) { //-> Xor8 {
        let size = keys.len();
        let mut capacity = 32 + ((1.23*(size as f64)).ceil() as u32); //u32);
        capacity = capacity / 3 * 3; // round it down to a multiple of 3
        self.filter.BlockLength = capacity / 3; 
     
        self.filter.Fingerprints = vec![0; capacity as usize]; 
        let mut rngcounter: u64 = 1;
        self.filter.Seed = splitmix64(rngcounter);
        
        // unsure if defaulting values to zero will hurt performance
        // may need to change implementation in the future
        
        let mut Q0: Vec<keyindex> = vec![keyindex {hash: 0, index: 0}; self.filter.BlockLength as usize]; 
        let mut Q1: Vec<keyindex> = vec![keyindex {hash: 0, index: 0}; self.filter.BlockLength as usize]; 
        let mut Q2: Vec<keyindex> = vec![keyindex {hash: 0, index: 0}; self.filter.BlockLength as usize]; 
        
        let mut stack: Vec<keyindex> = vec![keyindex {hash: 0, index: 0}; size]; 
        let mut sets0: Vec<xorset> = vec![xorset {xormask:0, count:0}; self.filter.BlockLength as usize]; 
        let mut sets1: Vec<xorset> = vec![xorset {xormask:0, count:0}; self.filter.BlockLength as usize]; 
        let mut sets2: Vec<xorset> = vec![xorset {xormask:0, count:0}; self.filter.BlockLength as usize]; 
        
        while true {
            for i in 0..size {
                
                let key = keys[i];
                let hs = self.geth0h1h2(key);
                sets0[hs.h0 as usize].xormask ^= hs.h;
                sets0[hs.h0 as usize].count = sets0[hs.h0 as usize].count + 1;
                sets1[hs.h1 as usize].xormask ^= hs.h;
                sets1[hs.h1 as usize].count = sets1[hs.h1 as usize].count + 1;
                sets2[hs.h2 as usize].xormask ^= hs.h;
                sets2[hs.h2 as usize].count = sets2[hs.h2 as usize].count + 1;
                
	    }
                
            
            let mut Q0size = 0;
            let mut Q1size = 0;
            let mut Q2size = 0;
           
            for i in 0u32..self.filter.BlockLength {
                if sets0[i as usize].count == 1 {
                            Q0[Q0size].index = i;
                            Q0[Q0size].hash = sets0[i as usize].xormask;
                            Q0size = Q0size + 1;
                        }
            }
            
            for i in 0u32..self.filter.BlockLength {
			if sets1[i as usize].count == 1 {
				Q1[Q1size].index = i;
				Q1[Q1size].hash = sets1[i as usize].xormask;
				Q1size = Q1size + 1;
			}
		}
		
            for i in 0u32..self.filter.BlockLength {
			if sets2[i as usize].count == 1 {
				Q2[Q2size].index = i;
				Q2[Q2size].hash = sets2[i as usize].xormask;
				Q2size = Q2size + 1;
			}
		}
                
            let mut stacksize = 0;
               
            while Q0size+Q1size+Q2size > 0 {
                while Q0size > 0 {
                    Q0size = Q0size - 1;
                    let mut keyindexvar = Q0[Q0size];
                    let index = keyindexvar.index;
                    if sets0[index as usize].count == 0 {
                        continue
                    }
               
                    let hash = keyindexvar.hash;
                    let h1 = self.geth1(hash);
                    let h2 = self.geth2(hash);
                    stack[stacksize] = keyindexvar;
                    stacksize = stacksize + 1;
                    sets1[h1 as usize].xormask ^= hash;
                        
                    sets1[h1 as usize].count = sets1[h1 as usize].count.wrapping_sub(1); 
                    if sets1[h1 as usize].count == 1 {
                                    Q1[Q1size].index = h1;
                                    Q1[Q1size].hash = sets1[h1 as usize].xormask;
                                    Q1size = Q1size + 1;
                    }
                        
                    sets2[h2 as usize].xormask ^= hash;
                    sets2[h2 as usize].count = sets2[h2 as usize].count.wrapping_sub(1); 
                    if sets2[h2 as usize].count == 1 {
                                    Q2[Q2size].index = h2;
                                    Q2[Q2size].hash = sets2[h2 as usize].xormask;
                                    Q2size = Q2size + 1;
                            }
		    }
                     
                while Q1size > 0 {
                             
                    Q1size = Q1size - 1;
                    let mut keyindexvar  = Q1[Q1size];
                    let index = keyindexvar.index;

                    if sets1[index as usize].count == 0 {
                                    continue
                    }
                        
                    let hash = keyindexvar.hash;
                    let h0 = self.geth0(hash);
                    let h2 = self.geth2(hash);
                    keyindexvar.index += self.filter.BlockLength;
                    stack[stacksize] = keyindexvar;
                    stacksize = stacksize + 1;
                    sets0[h0 as usize].xormask ^= hash;
                    sets0[h0 as usize].count = sets0[h0 as usize].count.wrapping_sub(1);
                    if sets0[h0 as usize].count == 1 {
                                Q0[Q0size].index = h0;
                                Q0[Q0size].hash = sets0[h0 as usize].xormask;
                                Q0size = Q0size + 1;
		    }
                        
                    sets2[h2 as usize].xormask ^= hash;
                    sets2[h2 as usize].count = sets2[h2 as usize].count - 1;
                    
                    if sets2[h2 as usize].count == 1 {
                            Q2[Q2size].index = h2;
                            Q2[Q2size].hash = sets2[h2 as usize].xormask;
                            Q2size = Q2size + 1;
                    }
                }
                
                while Q2size > 0 {
                        Q2size = Q2size - 1;
                        let mut keyindexvar  = Q2[Q2size];
                        let index = keyindexvar.index;
                        if sets2[index as usize].count == 0 {
			    continue
			}
                        
                        let hash = keyindexvar.hash;
                        let h0 = self.geth0(hash);
                        let h1 = self.geth1(hash);
                        keyindexvar.index += (2*self.filter.BlockLength);
                        stack[stacksize] = keyindexvar;
                        stacksize = stacksize + 1;
                        
                        sets0[h0 as usize].xormask ^= hash; // need to bring this back 
                        sets0[h0 as usize].count = sets0[h0 as usize].count.wrapping_sub(1);
                        if sets0[h0 as usize].count == 1 {
					Q0[Q0size].index = h0;
					Q0[Q0size].hash = sets0[h0 as usize].xormask;
					Q0size = Q0size + 1;
			}
                        sets1[h1 as usize].xormask ^= hash;
                        sets1[h1 as usize].count = sets1[h1 as usize].count.wrapping_sub(1);
                        if sets1[h1 as usize].count == 1 {
                            Q1[Q1size].index = h1;
                            Q1[Q1size].hash = sets1[h1 as usize].xormask;
                            Q1size = Q1size + 1
                             }
                        
                        
                        }
                        
                    }
                       
                    if stacksize == size {
                        break;    
                    }
                    
                    for i in 0..sets0.len() {
                        sets0[i as usize] = xorset{xormask:0, count:0};
                    }
                    
                    for i in 0..sets1.len() {
			sets1[i as usize] = xorset{xormask: 0, count:0};
		    }
                    
                    for i in 0..sets2.len() {
			sets2[i as usize] = xorset{xormask: 0, count:0};
		    }
                    
                    self.filter.Seed = splitmix64(rngcounter);
                    
                }
                
        let mut stacksize = size;
        while stacksize > 0 {
            stacksize = stacksize - 1;
            let ki = stack[stacksize];
            let mut val = fingerprint(ki.hash) as u8;
            if ki.index < self.filter.BlockLength {
                val ^= self.filter.Fingerprints[(self.clone().geth1(ki.hash)+self.filter.BlockLength) as usize] ^ self.filter.Fingerprints[(self.clone().geth2(ki.hash)+2*self.filter.BlockLength) as usize]
            } else if ki.index < 2*self.filter.BlockLength {
                val ^= self.filter.Fingerprints[self.clone().geth0(ki.hash) as usize] ^ self.filter.Fingerprints[(self.clone().geth2(ki.hash)+2*self.filter.BlockLength) as usize]
            } else {
			val ^= self.filter.Fingerprints[self.clone().geth0(ki.hash) as usize] ^ self.filter.Fingerprints[(self.clone().geth1(ki.hash)+self.filter.BlockLength) as usize]
	    }
            self.filter.Fingerprints[ki.index as usize] = val;
        }
    }
    
    pub fn contains(&self, key: u64) -> bool {
        let mut hash = mixsplit(key, self.filter.Seed);
        let f = fingerprint(hash) as u8;
        let mut r0 = hash as u32;
        let mut r1 = rotl64(hash, 21) as u32;
        let mut r2 = rotl64(hash, 42) as u32; 
        let mut h0 = reduce(r0, self.filter.BlockLength);
        let mut h1 = reduce(r1, self.filter.BlockLength) + self.filter.BlockLength;
        let mut h2 = reduce(r2, self.filter.BlockLength) + 2*self.filter.BlockLength;
        
        f == (self.filter.Fingerprints[h0 as usize] ^ self.filter.Fingerprints[h1 as usize] ^
		self.filter.Fingerprints[h2 as usize])
        
    }
}