simplehash 0.1.3

A simple, fast Rust library implementing common non-cryptographic hash functions: FNV, MurmurHash3, CityHash, and Rendezvous hashing
Documentation
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
use std::hash::Hasher;

// Constants for MurmurHash3 32-bit
const C1_32: u32 = 0xcc9e2d51;
const C2_32: u32 = 0x1b873593;

// Constants for MurmurHash3 128-bit
const C1_128: u32 = 0x239b961b;
const C2_128: u32 = 0xab0e9789;
const C3_128: u32 = 0x38b34ae5;
const C4_128: u32 = 0xa1e38b93;

// Finalization mix - force all bits of a hash block to avalanche
#[inline(always)]
fn fmix32(mut h: u32) -> u32 {
    h ^= h >> 16;
    h = h.wrapping_mul(0x85ebca6b);
    h ^= h >> 13;
    h = h.wrapping_mul(0xc2b2ae35);
    h ^= h >> 16;
    h
}

// MurmurHash3 32-bit hasher
#[derive(Debug, Copy, Clone)]
pub struct MurmurHasher32 {
    state: u32,
    length: usize,
}

impl MurmurHasher32 {
    #[inline]
    pub fn new(seed: u32) -> Self {
        Self {
            state: seed,
            length: 0,
        }
    }

    #[inline]
    pub fn finish_u32(&self) -> u32 {
        let mut h1 = self.state;

        // Finalization
        h1 ^= self.length as u32;
        h1 = h1 ^ (h1 >> 16);
        h1 = h1.wrapping_mul(0x85ebca6b);
        h1 = h1 ^ (h1 >> 13);
        h1 = h1.wrapping_mul(0xc2b2ae35);
        h1 = h1 ^ (h1 >> 16);

        h1
    }
}

impl Default for MurmurHasher32 {
    #[inline]
    fn default() -> Self {
        Self::new(0)
    }
}

impl Default for MurmurHasher64 {
    #[inline]
    fn default() -> Self {
        Self::new(0)
    }
}

impl Hasher for MurmurHasher32 {
    #[inline(always)]
    fn finish(&self) -> u64 {
        self.finish_u32() as u64
    }

    #[inline(always)]
    fn write(&mut self, data: &[u8]) {
        let len = data.len();
        self.length += len;

        // Local state for better optimization
        let mut h1 = self.state;

        // Process 4-byte blocks
        let nblocks = len / 4;
        let blocks_end = nblocks * 4;

        for i in (0..blocks_end).step_by(4) {
            // Use endian-agnostic byte loading (same as original algorithm)
            let k1 = (data[i] as u32)
                | ((data[i + 1] as u32) << 8)
                | ((data[i + 2] as u32) << 16)
                | ((data[i + 3] as u32) << 24);

            let mut k = k1.wrapping_mul(C1_32);
            k = k.rotate_left(15);
            k = k.wrapping_mul(C2_32);

            h1 ^= k;
            h1 = h1.rotate_left(13);
            h1 = h1.wrapping_mul(5).wrapping_add(0xe6546b64);
        }

        // Process tail (remaining bytes)
        let mut k1: u32 = 0;
        let tail = &data[blocks_end..];

        match tail.len() {
            3 => {
                k1 ^= (tail[2] as u32) << 16;
                k1 ^= (tail[1] as u32) << 8;
                k1 ^= tail[0] as u32;
                k1 = k1.wrapping_mul(C1_32);
                k1 = k1.rotate_left(15);
                k1 = k1.wrapping_mul(C2_32);
                h1 ^= k1;
            }
            2 => {
                k1 ^= (tail[1] as u32) << 8;
                k1 ^= tail[0] as u32;
                k1 = k1.wrapping_mul(C1_32);
                k1 = k1.rotate_left(15);
                k1 = k1.wrapping_mul(C2_32);
                h1 ^= k1;
            }
            1 => {
                k1 ^= tail[0] as u32;
                k1 = k1.wrapping_mul(C1_32);
                k1 = k1.rotate_left(15);
                k1 = k1.wrapping_mul(C2_32);
                h1 ^= k1;
            }
            _ => {}
        }

        // Store state
        self.state = h1;
    }
}

// MurmurHash3 128-bit hasher
// Note: MurmurHash3 128-bit cannot implement the standard Hasher trait directly
// because it produces a 128-bit hash which cannot be fully represented by u64
// returned by the finish() method required by std::hash::Hasher
#[derive(Debug, Copy, Clone)]
pub struct MurmurHasher128 {
    h1: u32,
    h2: u32,
    h3: u32,
    h4: u32,
    length: usize,
}

// MurmurHash3 64-bit hasher
// This uses the 128-bit implementation but only returns the lower 64 bits
#[derive(Debug, Copy, Clone)]
pub struct MurmurHasher64 {
    inner: MurmurHasher128,
}

impl MurmurHasher64 {
    #[inline]
    pub fn new(seed: u32) -> Self {
        Self {
            inner: MurmurHasher128::new(seed),
        }
    }

    #[inline]
    pub fn finish_u64(&self) -> u64 {
        self.inner.finish_u64()
    }
}

impl Hasher for MurmurHasher64 {
    #[inline]
    fn write(&mut self, data: &[u8]) {
        self.inner.write(data);
    }

    #[inline]
    fn finish(&self) -> u64 {
        self.finish_u64()
    }
}

impl MurmurHasher128 {
    #[inline(always)]
    pub fn new(seed: u32) -> Self {
        Self {
            h1: seed,
            h2: seed,
            h3: seed,
            h4: seed,
            length: 0,
        }
    }

    #[inline(always)]
    pub fn finish_u128(&self) -> u128 {
        let mut h1 = self.h1;
        let mut h2 = self.h2;
        let mut h3 = self.h3;
        let mut h4 = self.h4;

        // Finalization
        h1 ^= self.length as u32;
        h2 ^= self.length as u32;
        h3 ^= self.length as u32;
        h4 ^= self.length as u32;

        // Mix the state values together
        h1 = h1.wrapping_add(h2).wrapping_add(h3).wrapping_add(h4);
        h2 = h2.wrapping_add(h1);
        h3 = h3.wrapping_add(h1);
        h4 = h4.wrapping_add(h1);

        // Apply the finalization mix to each part
        h1 = fmix32(h1);
        h2 = fmix32(h2);
        h3 = fmix32(h3);
        h4 = fmix32(h4);

        // Combine the four 32-bit values into one 128-bit value
        ((h4 as u128) << 96) | ((h3 as u128) << 64) | ((h2 as u128) << 32) | (h1 as u128)
    }

    #[inline]
    pub fn finish_u64(&self) -> u64 {
        // For 64-bit hash, just take the lower 64 bits of the 128-bit result
        self.finish_u128() as u64
    }

    #[inline(always)]
    pub fn write(&mut self, data: &[u8]) {
        let len = data.len();
        self.length += len;

        // Local state for better optimization
        let mut h1 = self.h1;
        let mut h2 = self.h2;
        let mut h3 = self.h3;
        let mut h4 = self.h4;

        // Process 16-byte blocks
        let nblocks = len / 16;
        let blocks_end = nblocks * 16;

        for i in (0..blocks_end).step_by(16) {
            // Use endian-agnostic byte loading (same as original algorithm)
            let k1 = (data[i] as u32)
                | ((data[i + 1] as u32) << 8)
                | ((data[i + 2] as u32) << 16)
                | ((data[i + 3] as u32) << 24);

            let k2 = (data[i + 4] as u32)
                | ((data[i + 5] as u32) << 8)
                | ((data[i + 6] as u32) << 16)
                | ((data[i + 7] as u32) << 24);

            let k3 = (data[i + 8] as u32)
                | ((data[i + 9] as u32) << 8)
                | ((data[i + 10] as u32) << 16)
                | ((data[i + 11] as u32) << 24);

            let k4 = (data[i + 12] as u32)
                | ((data[i + 13] as u32) << 8)
                | ((data[i + 14] as u32) << 16)
                | ((data[i + 15] as u32) << 24);

            // Process k1
            let mut k = k1.wrapping_mul(C1_128);
            k = k.rotate_left(15);
            k = k.wrapping_mul(C2_128);
            h1 ^= k;
            h1 = h1.rotate_left(19);
            h1 = h1.wrapping_add(h2);
            h1 = h1.wrapping_mul(5).wrapping_add(0x561ccd1b);

            // Process k2
            let mut k = k2.wrapping_mul(C2_128);
            k = k.rotate_left(16);
            k = k.wrapping_mul(C3_128);
            h2 ^= k;
            h2 = h2.rotate_left(17);
            h2 = h2.wrapping_add(h3);
            h2 = h2.wrapping_mul(5).wrapping_add(0x0bcaa747);

            // Process k3
            let mut k = k3.wrapping_mul(C3_128);
            k = k.rotate_left(17);
            k = k.wrapping_mul(C4_128);
            h3 ^= k;
            h3 = h3.rotate_left(15);
            h3 = h3.wrapping_add(h4);
            h3 = h3.wrapping_mul(5).wrapping_add(0x96cd1c35);

            // Process k4
            let mut k = k4.wrapping_mul(C4_128);
            k = k.rotate_left(18);
            k = k.wrapping_mul(C1_128);
            h4 ^= k;
            h4 = h4.rotate_left(13);
            h4 = h4.wrapping_add(h1);
            h4 = h4.wrapping_mul(5).wrapping_add(0x32ac3b17);
        }

        // Process tail bytes
        let tail = &data[blocks_end..];
        self.process_tail(tail, &mut h1, &mut h2, &mut h3, &mut h4);

        // Save state
        self.h1 = h1;
        self.h2 = h2;
        self.h3 = h3;
        self.h4 = h4;
    }

    // Helper function to process tail bytes
    #[inline(always)]
    fn process_tail(&self, tail: &[u8], h1: &mut u32, h2: &mut u32, h3: &mut u32, h4: &mut u32) {
        // Process the remaining bytes that didn't fit in a complete block
        if tail.is_empty() {
            return;
        }

        // Use a more efficient approach for tail processing
        match tail.len() {
            1..=4 => {
                let mut k1: u32 = 0;

                if !tail.is_empty() {
                    k1 ^= tail[0] as u32;
                }
                if tail.len() >= 2 {
                    k1 ^= (tail[1] as u32) << 8;
                }
                if tail.len() >= 3 {
                    k1 ^= (tail[2] as u32) << 16;
                }
                if tail.len() >= 4 {
                    k1 ^= (tail[3] as u32) << 24;
                }

                k1 = k1.wrapping_mul(C1_128);
                k1 = k1.rotate_left(15);
                k1 = k1.wrapping_mul(C2_128);
                *h1 ^= k1;
            }
            5..=8 => {
                let mut k1: u32 = 0;
                let mut k2: u32 = 0;

                // Process bytes for k1
                if !tail.is_empty() {
                    k1 ^= tail[0] as u32;
                }
                if tail.len() >= 2 {
                    k1 ^= (tail[1] as u32) << 8;
                }
                if tail.len() >= 3 {
                    k1 ^= (tail[2] as u32) << 16;
                }
                if tail.len() >= 4 {
                    k1 ^= (tail[3] as u32) << 24;
                }

                k1 = k1.wrapping_mul(C1_128);
                k1 = k1.rotate_left(15);
                k1 = k1.wrapping_mul(C2_128);
                *h1 ^= k1;

                // Process bytes for k2
                if tail.len() >= 5 {
                    k2 ^= tail[4] as u32;
                }
                if tail.len() >= 6 {
                    k2 ^= (tail[5] as u32) << 8;
                }
                if tail.len() >= 7 {
                    k2 ^= (tail[6] as u32) << 16;
                }
                if tail.len() >= 8 {
                    k2 ^= (tail[7] as u32) << 24;
                }

                k2 = k2.wrapping_mul(C2_128);
                k2 = k2.rotate_left(16);
                k2 = k2.wrapping_mul(C3_128);
                *h2 ^= k2;
            }
            9..=15 => {
                let mut k1: u32 = 0;
                let mut k2: u32 = 0;
                let mut k3: u32 = 0;
                let mut k4: u32 = 0;

                // Process bytes for k1
                if !tail.is_empty() {
                    k1 ^= tail[0] as u32;
                }
                if tail.len() >= 2 {
                    k1 ^= (tail[1] as u32) << 8;
                }
                if tail.len() >= 3 {
                    k1 ^= (tail[2] as u32) << 16;
                }
                if tail.len() >= 4 {
                    k1 ^= (tail[3] as u32) << 24;
                }

                k1 = k1.wrapping_mul(C1_128);
                k1 = k1.rotate_left(15);
                k1 = k1.wrapping_mul(C2_128);
                *h1 ^= k1;

                // Process bytes for k2
                if tail.len() >= 5 {
                    k2 ^= tail[4] as u32;
                }
                if tail.len() >= 6 {
                    k2 ^= (tail[5] as u32) << 8;
                }
                if tail.len() >= 7 {
                    k2 ^= (tail[6] as u32) << 16;
                }
                if tail.len() >= 8 {
                    k2 ^= (tail[7] as u32) << 24;
                }

                k2 = k2.wrapping_mul(C2_128);
                k2 = k2.rotate_left(16);
                k2 = k2.wrapping_mul(C3_128);
                *h2 ^= k2;

                // Process bytes for k3
                if tail.len() >= 9 {
                    k3 ^= tail[8] as u32;
                }
                if tail.len() >= 10 {
                    k3 ^= (tail[9] as u32) << 8;
                }
                if tail.len() >= 11 {
                    k3 ^= (tail[10] as u32) << 16;
                }
                if tail.len() >= 12 {
                    k3 ^= (tail[11] as u32) << 24;
                }

                k3 = k3.wrapping_mul(C3_128);
                k3 = k3.rotate_left(17);
                k3 = k3.wrapping_mul(C4_128);
                *h3 ^= k3;

                // Process bytes for k4
                if tail.len() >= 13 {
                    k4 ^= tail[12] as u32;
                }
                if tail.len() >= 14 {
                    k4 ^= (tail[13] as u32) << 8;
                }
                if tail.len() >= 15 {
                    k4 ^= (tail[14] as u32) << 16;
                }

                k4 = k4.wrapping_mul(C4_128);
                k4 = k4.rotate_left(18);
                k4 = k4.wrapping_mul(C1_128);
                *h4 ^= k4;
            }
            _ => unreachable!(), // tail.len() should be 0-15
        }
    }
}