]> git.lizzy.rs Git - rust.git/blob - src/libcollections/hash/sip.rs
DSTify free functions in std::hash
[rust.git] / src / libcollections / hash / sip.rs
1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
4 //
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
10 //
11 // ignore-lexer-test FIXME #15883
12
13 //! An implementation of SipHash 2-4.
14 //!
15 //! See: http://131002.net/siphash/
16 //!
17 //! Consider this as a main "general-purpose" hash for all hashtables: it
18 //! runs at good speed (competitive with spooky and city) and permits
19 //! strong _keyed_ hashing. Key your hashtables from a strong RNG,
20 //! such as `rand::Rng`.
21 //!
22 //! Although the SipHash algorithm is considered to be cryptographically
23 //! strong, this implementation has not been reviewed for such purposes.
24 //! As such, all cryptographic uses of this implementation are strongly
25 //! discouraged.
26
27 use core::prelude::*;
28
29 use core::default::Default;
30
31 use super::{Hash, Hasher, Writer};
32
33 /// `SipState` computes a SipHash 2-4 hash over a stream of bytes.
34 pub struct SipState {
35     k0: u64,
36     k1: u64,
37     length: uint, // how many bytes we've processed
38     v0: u64,      // hash state
39     v1: u64,
40     v2: u64,
41     v3: u64,
42     tail: u64, // unprocessed bytes le
43     ntail: uint,  // how many bytes in tail are valid
44 }
45
46 // sadly, these macro definitions can't appear later,
47 // because they're needed in the following defs;
48 // this design could be improved.
49
50 macro_rules! u8to64_le (
51     ($buf:expr, $i:expr) =>
52     ($buf[0+$i] as u64 |
53      $buf[1+$i] as u64 << 8 |
54      $buf[2+$i] as u64 << 16 |
55      $buf[3+$i] as u64 << 24 |
56      $buf[4+$i] as u64 << 32 |
57      $buf[5+$i] as u64 << 40 |
58      $buf[6+$i] as u64 << 48 |
59      $buf[7+$i] as u64 << 56);
60     ($buf:expr, $i:expr, $len:expr) =>
61     ({
62         let mut t = 0;
63         let mut out = 0u64;
64         while t < $len {
65             out |= $buf[t+$i] as u64 << t*8;
66             t += 1;
67         }
68         out
69     });
70 )
71
72 macro_rules! rotl (
73     ($x:expr, $b:expr) =>
74     (($x << $b) | ($x >> (64 - $b)))
75 )
76
77 macro_rules! compress (
78     ($v0:expr, $v1:expr, $v2:expr, $v3:expr) =>
79     ({
80         $v0 += $v1; $v1 = rotl!($v1, 13); $v1 ^= $v0;
81         $v0 = rotl!($v0, 32);
82         $v2 += $v3; $v3 = rotl!($v3, 16); $v3 ^= $v2;
83         $v0 += $v3; $v3 = rotl!($v3, 21); $v3 ^= $v0;
84         $v2 += $v1; $v1 = rotl!($v1, 17); $v1 ^= $v2;
85         $v2 = rotl!($v2, 32);
86     })
87 )
88
89 impl SipState {
90     /// Creates a `SipState` that is keyed off the provided keys.
91     #[inline]
92     pub fn new() -> SipState {
93         SipState::new_with_keys(0, 0)
94     }
95
96     /// Creates a `SipState` that is keyed off the provided keys.
97     #[inline]
98     pub fn new_with_keys(key0: u64, key1: u64) -> SipState {
99         let mut state = SipState {
100             k0: key0,
101             k1: key1,
102             length: 0,
103             v0: 0,
104             v1: 0,
105             v2: 0,
106             v3: 0,
107             tail: 0,
108             ntail: 0,
109         };
110         state.reset();
111         state
112     }
113
114     /// Resets the state to its initial state.
115     #[inline]
116     pub fn reset(&mut self) {
117         self.length = 0;
118         self.v0 = self.k0 ^ 0x736f6d6570736575;
119         self.v1 = self.k1 ^ 0x646f72616e646f6d;
120         self.v2 = self.k0 ^ 0x6c7967656e657261;
121         self.v3 = self.k1 ^ 0x7465646279746573;
122         self.ntail = 0;
123     }
124
125     /// Returns the computed hash.
126     #[inline]
127     pub fn result(&self) -> u64 {
128         let mut v0 = self.v0;
129         let mut v1 = self.v1;
130         let mut v2 = self.v2;
131         let mut v3 = self.v3;
132
133         let b: u64 = ((self.length as u64 & 0xff) << 56) | self.tail;
134
135         v3 ^= b;
136         compress!(v0, v1, v2, v3);
137         compress!(v0, v1, v2, v3);
138         v0 ^= b;
139
140         v2 ^= 0xff;
141         compress!(v0, v1, v2, v3);
142         compress!(v0, v1, v2, v3);
143         compress!(v0, v1, v2, v3);
144         compress!(v0, v1, v2, v3);
145
146         v0 ^ v1 ^ v2 ^ v3
147     }
148 }
149
150 impl Writer for SipState {
151     #[inline]
152     fn write(&mut self, msg: &[u8]) {
153         let length = msg.len();
154         self.length += length;
155
156         let mut needed = 0u;
157
158         if self.ntail != 0 {
159             needed = 8 - self.ntail;
160             if length < needed {
161                 self.tail |= u8to64_le!(msg, 0, length) << 8*self.ntail;
162                 self.ntail += length;
163                 return
164             }
165
166             let m = self.tail | u8to64_le!(msg, 0, needed) << 8*self.ntail;
167
168             self.v3 ^= m;
169             compress!(self.v0, self.v1, self.v2, self.v3);
170             compress!(self.v0, self.v1, self.v2, self.v3);
171             self.v0 ^= m;
172
173             self.ntail = 0;
174         }
175
176         // Buffered tail is now flushed, process new input.
177         let len = length - needed;
178         let end = len & (!0x7);
179         let left = len & 0x7;
180
181         let mut i = needed;
182         while i < end {
183             let mi = u8to64_le!(msg, i);
184
185             self.v3 ^= mi;
186             compress!(self.v0, self.v1, self.v2, self.v3);
187             compress!(self.v0, self.v1, self.v2, self.v3);
188             self.v0 ^= mi;
189
190             i += 8;
191         }
192
193         self.tail = u8to64_le!(msg, i, left);
194         self.ntail = left;
195     }
196 }
197
198 impl Clone for SipState {
199     #[inline]
200     fn clone(&self) -> SipState {
201         *self
202     }
203 }
204
205 impl Default for SipState {
206     #[inline]
207     fn default() -> SipState {
208         SipState::new()
209     }
210 }
211
212 /// `SipHasher` computes the SipHash algorithm from a stream of bytes.
213 #[deriving(Clone)]
214 pub struct SipHasher {
215     k0: u64,
216     k1: u64,
217 }
218
219 impl SipHasher {
220     /// Creates a `Sip`.
221     #[inline]
222     pub fn new() -> SipHasher {
223         SipHasher::new_with_keys(0, 0)
224     }
225
226     /// Creates a `Sip` that is keyed off the provided keys.
227     #[inline]
228     pub fn new_with_keys(key0: u64, key1: u64) -> SipHasher {
229         SipHasher {
230             k0: key0,
231             k1: key1,
232         }
233     }
234 }
235
236 impl Hasher<SipState> for SipHasher {
237     #[inline]
238     fn hash<Sized? T: Hash<SipState>>(&self, value: &T) -> u64 {
239         let mut state = SipState::new_with_keys(self.k0, self.k1);
240         value.hash(&mut state);
241         state.result()
242     }
243 }
244
245 impl Default for SipHasher {
246     #[inline]
247     fn default() -> SipHasher {
248         SipHasher::new()
249     }
250 }
251
252 /// Hashes a value using the SipHash algorithm.
253 #[inline]
254 pub fn hash<Sized? T: Hash<SipState>>(value: &T) -> u64 {
255     let mut state = SipState::new();
256     value.hash(&mut state);
257     state.result()
258 }
259
260 /// Hashes a value with the SipHash algorithm with the provided keys.
261 #[inline]
262 pub fn hash_with_keys<Sized? T: Hash<SipState>>(k0: u64, k1: u64, value: &T) -> u64 {
263     let mut state = SipState::new_with_keys(k0, k1);
264     value.hash(&mut state);
265     state.result()
266 }
267
268 #[cfg(test)]
269 mod tests {
270     use test::Bencher;
271     use std::prelude::*;
272     use std::fmt;
273
274     use str::Str;
275     use string::String;
276     use slice::{AsSlice, SlicePrelude};
277     use vec::Vec;
278
279     use super::super::{Hash, Writer};
280     use super::{SipState, hash, hash_with_keys};
281
282     // Hash just the bytes of the slice, without length prefix
283     struct Bytes<'a>(&'a [u8]);
284
285     impl<'a, S: Writer> Hash<S> for Bytes<'a> {
286         #[allow(unused_must_use)]
287         fn hash(&self, state: &mut S) {
288             let Bytes(v) = *self;
289             state.write(v);
290         }
291     }
292
293     #[test]
294     #[allow(unused_must_use)]
295     fn test_siphash() {
296         let vecs : [[u8, ..8], ..64] = [
297             [ 0x31, 0x0e, 0x0e, 0xdd, 0x47, 0xdb, 0x6f, 0x72, ],
298             [ 0xfd, 0x67, 0xdc, 0x93, 0xc5, 0x39, 0xf8, 0x74, ],
299             [ 0x5a, 0x4f, 0xa9, 0xd9, 0x09, 0x80, 0x6c, 0x0d, ],
300             [ 0x2d, 0x7e, 0xfb, 0xd7, 0x96, 0x66, 0x67, 0x85, ],
301             [ 0xb7, 0x87, 0x71, 0x27, 0xe0, 0x94, 0x27, 0xcf, ],
302             [ 0x8d, 0xa6, 0x99, 0xcd, 0x64, 0x55, 0x76, 0x18, ],
303             [ 0xce, 0xe3, 0xfe, 0x58, 0x6e, 0x46, 0xc9, 0xcb, ],
304             [ 0x37, 0xd1, 0x01, 0x8b, 0xf5, 0x00, 0x02, 0xab, ],
305             [ 0x62, 0x24, 0x93, 0x9a, 0x79, 0xf5, 0xf5, 0x93, ],
306             [ 0xb0, 0xe4, 0xa9, 0x0b, 0xdf, 0x82, 0x00, 0x9e, ],
307             [ 0xf3, 0xb9, 0xdd, 0x94, 0xc5, 0xbb, 0x5d, 0x7a, ],
308             [ 0xa7, 0xad, 0x6b, 0x22, 0x46, 0x2f, 0xb3, 0xf4, ],
309             [ 0xfb, 0xe5, 0x0e, 0x86, 0xbc, 0x8f, 0x1e, 0x75, ],
310             [ 0x90, 0x3d, 0x84, 0xc0, 0x27, 0x56, 0xea, 0x14, ],
311             [ 0xee, 0xf2, 0x7a, 0x8e, 0x90, 0xca, 0x23, 0xf7, ],
312             [ 0xe5, 0x45, 0xbe, 0x49, 0x61, 0xca, 0x29, 0xa1, ],
313             [ 0xdb, 0x9b, 0xc2, 0x57, 0x7f, 0xcc, 0x2a, 0x3f, ],
314             [ 0x94, 0x47, 0xbe, 0x2c, 0xf5, 0xe9, 0x9a, 0x69, ],
315             [ 0x9c, 0xd3, 0x8d, 0x96, 0xf0, 0xb3, 0xc1, 0x4b, ],
316             [ 0xbd, 0x61, 0x79, 0xa7, 0x1d, 0xc9, 0x6d, 0xbb, ],
317             [ 0x98, 0xee, 0xa2, 0x1a, 0xf2, 0x5c, 0xd6, 0xbe, ],
318             [ 0xc7, 0x67, 0x3b, 0x2e, 0xb0, 0xcb, 0xf2, 0xd0, ],
319             [ 0x88, 0x3e, 0xa3, 0xe3, 0x95, 0x67, 0x53, 0x93, ],
320             [ 0xc8, 0xce, 0x5c, 0xcd, 0x8c, 0x03, 0x0c, 0xa8, ],
321             [ 0x94, 0xaf, 0x49, 0xf6, 0xc6, 0x50, 0xad, 0xb8, ],
322             [ 0xea, 0xb8, 0x85, 0x8a, 0xde, 0x92, 0xe1, 0xbc, ],
323             [ 0xf3, 0x15, 0xbb, 0x5b, 0xb8, 0x35, 0xd8, 0x17, ],
324             [ 0xad, 0xcf, 0x6b, 0x07, 0x63, 0x61, 0x2e, 0x2f, ],
325             [ 0xa5, 0xc9, 0x1d, 0xa7, 0xac, 0xaa, 0x4d, 0xde, ],
326             [ 0x71, 0x65, 0x95, 0x87, 0x66, 0x50, 0xa2, 0xa6, ],
327             [ 0x28, 0xef, 0x49, 0x5c, 0x53, 0xa3, 0x87, 0xad, ],
328             [ 0x42, 0xc3, 0x41, 0xd8, 0xfa, 0x92, 0xd8, 0x32, ],
329             [ 0xce, 0x7c, 0xf2, 0x72, 0x2f, 0x51, 0x27, 0x71, ],
330             [ 0xe3, 0x78, 0x59, 0xf9, 0x46, 0x23, 0xf3, 0xa7, ],
331             [ 0x38, 0x12, 0x05, 0xbb, 0x1a, 0xb0, 0xe0, 0x12, ],
332             [ 0xae, 0x97, 0xa1, 0x0f, 0xd4, 0x34, 0xe0, 0x15, ],
333             [ 0xb4, 0xa3, 0x15, 0x08, 0xbe, 0xff, 0x4d, 0x31, ],
334             [ 0x81, 0x39, 0x62, 0x29, 0xf0, 0x90, 0x79, 0x02, ],
335             [ 0x4d, 0x0c, 0xf4, 0x9e, 0xe5, 0xd4, 0xdc, 0xca, ],
336             [ 0x5c, 0x73, 0x33, 0x6a, 0x76, 0xd8, 0xbf, 0x9a, ],
337             [ 0xd0, 0xa7, 0x04, 0x53, 0x6b, 0xa9, 0x3e, 0x0e, ],
338             [ 0x92, 0x59, 0x58, 0xfc, 0xd6, 0x42, 0x0c, 0xad, ],
339             [ 0xa9, 0x15, 0xc2, 0x9b, 0xc8, 0x06, 0x73, 0x18, ],
340             [ 0x95, 0x2b, 0x79, 0xf3, 0xbc, 0x0a, 0xa6, 0xd4, ],
341             [ 0xf2, 0x1d, 0xf2, 0xe4, 0x1d, 0x45, 0x35, 0xf9, ],
342             [ 0x87, 0x57, 0x75, 0x19, 0x04, 0x8f, 0x53, 0xa9, ],
343             [ 0x10, 0xa5, 0x6c, 0xf5, 0xdf, 0xcd, 0x9a, 0xdb, ],
344             [ 0xeb, 0x75, 0x09, 0x5c, 0xcd, 0x98, 0x6c, 0xd0, ],
345             [ 0x51, 0xa9, 0xcb, 0x9e, 0xcb, 0xa3, 0x12, 0xe6, ],
346             [ 0x96, 0xaf, 0xad, 0xfc, 0x2c, 0xe6, 0x66, 0xc7, ],
347             [ 0x72, 0xfe, 0x52, 0x97, 0x5a, 0x43, 0x64, 0xee, ],
348             [ 0x5a, 0x16, 0x45, 0xb2, 0x76, 0xd5, 0x92, 0xa1, ],
349             [ 0xb2, 0x74, 0xcb, 0x8e, 0xbf, 0x87, 0x87, 0x0a, ],
350             [ 0x6f, 0x9b, 0xb4, 0x20, 0x3d, 0xe7, 0xb3, 0x81, ],
351             [ 0xea, 0xec, 0xb2, 0xa3, 0x0b, 0x22, 0xa8, 0x7f, ],
352             [ 0x99, 0x24, 0xa4, 0x3c, 0xc1, 0x31, 0x57, 0x24, ],
353             [ 0xbd, 0x83, 0x8d, 0x3a, 0xaf, 0xbf, 0x8d, 0xb7, ],
354             [ 0x0b, 0x1a, 0x2a, 0x32, 0x65, 0xd5, 0x1a, 0xea, ],
355             [ 0x13, 0x50, 0x79, 0xa3, 0x23, 0x1c, 0xe6, 0x60, ],
356             [ 0x93, 0x2b, 0x28, 0x46, 0xe4, 0xd7, 0x06, 0x66, ],
357             [ 0xe1, 0x91, 0x5f, 0x5c, 0xb1, 0xec, 0xa4, 0x6c, ],
358             [ 0xf3, 0x25, 0x96, 0x5c, 0xa1, 0x6d, 0x62, 0x9f, ],
359             [ 0x57, 0x5f, 0xf2, 0x8e, 0x60, 0x38, 0x1b, 0xe5, ],
360             [ 0x72, 0x45, 0x06, 0xeb, 0x4c, 0x32, 0x8a, 0x95, ]
361         ];
362
363         let k0 = 0x_07_06_05_04_03_02_01_00_u64;
364         let k1 = 0x_0f_0e_0d_0c_0b_0a_09_08_u64;
365         let mut buf = Vec::new();
366         let mut t = 0;
367         let mut state_inc = SipState::new_with_keys(k0, k1);
368         let mut state_full = SipState::new_with_keys(k0, k1);
369
370         fn to_hex_str(r: &[u8, ..8]) -> String {
371             let mut s = String::new();
372             for b in r.iter() {
373                 s.push_str(format!("{}", fmt::radix(*b, 16)).as_slice());
374             }
375             s
376         }
377
378         fn result_bytes(h: u64) -> Vec<u8> {
379             vec![(h >> 0) as u8,
380               (h >> 8) as u8,
381               (h >> 16) as u8,
382               (h >> 24) as u8,
383               (h >> 32) as u8,
384               (h >> 40) as u8,
385               (h >> 48) as u8,
386               (h >> 56) as u8,
387             ]
388         }
389
390         fn result_str(h: u64) -> String {
391             let r = result_bytes(h);
392             let mut s = String::new();
393             for b in r.iter() {
394                 s.push_str(format!("{}", fmt::radix(*b, 16)).as_slice());
395             }
396             s
397         }
398
399         while t < 64 {
400             debug!("siphash test {}: {}", t, buf);
401             let vec = u8to64_le!(vecs[t], 0);
402             let out = hash_with_keys(k0, k1, &Bytes(buf.as_slice()));
403             debug!("got {}, expected {}", out, vec);
404             assert_eq!(vec, out);
405
406             state_full.reset();
407             state_full.write(buf.as_slice());
408             let f = result_str(state_full.result());
409             let i = result_str(state_inc.result());
410             let v = to_hex_str(&vecs[t]);
411             debug!("{}: ({}) => inc={} full={}", t, v, i, f);
412
413             assert_eq!(f, i);
414             assert_eq!(f, v);
415
416             buf.push(t as u8);
417             state_inc.write(&[t as u8]);
418
419             t += 1;
420         }
421     }
422
423     #[test] #[cfg(target_arch = "arm")]
424     fn test_hash_uint() {
425         let val = 0xdeadbeef_deadbeef_u64;
426         assert!(hash(&(val as u64)) != hash(&(val as uint)));
427         assert_eq!(hash(&(val as u32)), hash(&(val as uint)));
428     }
429     #[test] #[cfg(target_arch = "x86_64")]
430     fn test_hash_uint() {
431         let val = 0xdeadbeef_deadbeef_u64;
432         assert_eq!(hash(&(val as u64)), hash(&(val as uint)));
433         assert!(hash(&(val as u32)) != hash(&(val as uint)));
434     }
435     #[test] #[cfg(target_arch = "x86")]
436     fn test_hash_uint() {
437         let val = 0xdeadbeef_deadbeef_u64;
438         assert!(hash(&(val as u64)) != hash(&(val as uint)));
439         assert_eq!(hash(&(val as u32)), hash(&(val as uint)));
440     }
441
442     #[test]
443     fn test_hash_idempotent() {
444         let val64 = 0xdeadbeef_deadbeef_u64;
445         assert_eq!(hash(&val64), hash(&val64));
446         let val32 = 0xdeadbeef_u32;
447         assert_eq!(hash(&val32), hash(&val32));
448     }
449
450     #[test]
451     fn test_hash_no_bytes_dropped_64() {
452         let val = 0xdeadbeef_deadbeef_u64;
453
454         assert!(hash(&val) != hash(&zero_byte(val, 0)));
455         assert!(hash(&val) != hash(&zero_byte(val, 1)));
456         assert!(hash(&val) != hash(&zero_byte(val, 2)));
457         assert!(hash(&val) != hash(&zero_byte(val, 3)));
458         assert!(hash(&val) != hash(&zero_byte(val, 4)));
459         assert!(hash(&val) != hash(&zero_byte(val, 5)));
460         assert!(hash(&val) != hash(&zero_byte(val, 6)));
461         assert!(hash(&val) != hash(&zero_byte(val, 7)));
462
463         fn zero_byte(val: u64, byte: uint) -> u64 {
464             assert!(byte < 8);
465             val & !(0xff << (byte * 8))
466         }
467     }
468
469     #[test]
470     fn test_hash_no_bytes_dropped_32() {
471         let val = 0xdeadbeef_u32;
472
473         assert!(hash(&val) != hash(&zero_byte(val, 0)));
474         assert!(hash(&val) != hash(&zero_byte(val, 1)));
475         assert!(hash(&val) != hash(&zero_byte(val, 2)));
476         assert!(hash(&val) != hash(&zero_byte(val, 3)));
477
478         fn zero_byte(val: u32, byte: uint) -> u32 {
479             assert!(byte < 4);
480             val & !(0xff << (byte * 8))
481         }
482     }
483
484     #[test]
485     fn test_hash_no_concat_alias() {
486         let s = ("aa", "bb");
487         let t = ("aabb", "");
488         let u = ("a", "abb");
489
490         assert!(s != t && t != u);
491         assert!(hash(&s) != hash(&t) && hash(&s) != hash(&u));
492
493         let v: (&[u8], &[u8], &[u8]) = (&[1u8], &[0u8, 0], &[0u8]);
494         let w: (&[u8], &[u8], &[u8]) = (&[1u8, 0, 0, 0], &[], &[]);
495
496         assert!(v != w);
497         assert!(hash(&v) != hash(&w));
498     }
499
500     #[bench]
501     fn bench_str_under_8_bytes(b: &mut Bencher) {
502         let s = "foo";
503         b.iter(|| {
504             assert_eq!(hash(&s), 16262950014981195938);
505         })
506     }
507
508     #[bench]
509     fn bench_str_of_8_bytes(b: &mut Bencher) {
510         let s = "foobar78";
511         b.iter(|| {
512             assert_eq!(hash(&s), 4898293253460910787);
513         })
514     }
515
516     #[bench]
517     fn bench_str_over_8_bytes(b: &mut Bencher) {
518         let s = "foobarbaz0";
519         b.iter(|| {
520             assert_eq!(hash(&s), 10581415515220175264);
521         })
522     }
523
524     #[bench]
525     fn bench_long_str(b: &mut Bencher) {
526         let s = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor \
527 incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud \
528 exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute \
529 irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla \
530 pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui \
531 officia deserunt mollit anim id est laborum.";
532         b.iter(|| {
533             assert_eq!(hash(&s), 17717065544121360093);
534         })
535     }
536
537     #[bench]
538     fn bench_u64(b: &mut Bencher) {
539         let u = 16262950014981195938u64;
540         b.iter(|| {
541             assert_eq!(hash(&u), 5254097107239593357);
542         })
543     }
544 }