library/core/src/hash/sip.rs

   1 //! An implementation of SipHash.
   2
   3 #![allow(deprecated)] // the types in this module are deprecated
   4
   5 use crate::cmp;
   6 use crate::marker::PhantomData;
   7 use crate::mem;
   8 use crate::ptr;
   9
  10 /// An implementation of SipHash 1-3.
  11 ///
  12 /// This is currently the default hashing function used by standard library
  13 /// (e.g., `collections::HashMap` uses it by default).
  14 ///
  15 /// See: <https://131002.net/siphash>
  16 #[unstable(feature = "hashmap_internals", issue = "none")]
  17 #[rustc_deprecated(
  18     since = "1.13.0",
  19     reason = "use `std::collections::hash_map::DefaultHasher` instead"
  20 )]
  21 #[derive(Debug, Clone, Default)]
  22 #[doc(hidden)]
  23 pub struct SipHasher13 {
  24     hasher: Hasher<Sip13Rounds>,
  25 }
  26
  27 /// An implementation of SipHash 2-4.
  28 ///
  29 /// See: <https://131002.net/siphash/>
  30 #[unstable(feature = "hashmap_internals", issue = "none")]
  31 #[rustc_deprecated(
  32     since = "1.13.0",
  33     reason = "use `std::collections::hash_map::DefaultHasher` instead"
  34 )]
  35 #[derive(Debug, Clone, Default)]
  36 struct SipHasher24 {
  37     hasher: Hasher<Sip24Rounds>,
  38 }
  39
  40 /// An implementation of SipHash 2-4.
  41 ///
  42 /// See: <https://131002.net/siphash/>
  43 ///
  44 /// SipHash is a general-purpose hashing function: it runs at a good
  45 /// speed (competitive with Spooky and City) and permits strong _keyed_
  46 /// hashing. This lets you key your hash tables from a strong RNG, such as
  47 /// [`rand::os::OsRng`](https://doc.rust-lang.org/rand/rand/os/struct.OsRng.html).
  48 ///
  49 /// Although the SipHash algorithm is considered to be generally strong,
  50 /// it is not intended for cryptographic purposes. As such, all
  51 /// cryptographic uses of this implementation are _strongly discouraged_.
  52 #[stable(feature = "rust1", since = "1.0.0")]
  53 #[rustc_deprecated(
  54     since = "1.13.0",
  55     reason = "use `std::collections::hash_map::DefaultHasher` instead"
  56 )]
  57 #[derive(Debug, Clone, Default)]
  58 pub struct SipHasher(SipHasher24);
  59
  60 #[derive(Debug)]
  61 struct Hasher<S: Sip> {
  62     k0: u64,
  63     k1: u64,
  64     length: usize, // how many bytes we've processed
  65     state: State,  // hash State
  66     tail: u64,     // unprocessed bytes le
  67     ntail: usize,  // how many bytes in tail are valid
  68     _marker: PhantomData<S>,
  69 }
  70
  71 #[derive(Debug, Clone, Copy)]
  72 #[repr(C)]
  73 struct State {
  74     // v0, v2 and v1, v3 show up in pairs in the algorithm,
  75     // and simd implementations of SipHash will use vectors
  76     // of v02 and v13. By placing them in this order in the struct,
  77     // the compiler can pick up on just a few simd optimizations by itself.
  78     v0: u64,
  79     v2: u64,
  80     v1: u64,
  81     v3: u64,
  82 }
  83
  84 macro_rules! compress {
  85     ($state:expr) => {{ compress!($state.v0, $state.v1, $state.v2, $state.v3) }};
  86     ($v0:expr, $v1:expr, $v2:expr, $v3:expr) => {{
  87         $v0 = $v0.wrapping_add($v1);
  88         $v1 = $v1.rotate_left(13);
  89         $v1 ^= $v0;
  90         $v0 = $v0.rotate_left(32);
  91         $v2 = $v2.wrapping_add($v3);
  92         $v3 = $v3.rotate_left(16);
  93         $v3 ^= $v2;
  94         $v0 = $v0.wrapping_add($v3);
  95         $v3 = $v3.rotate_left(21);
  96         $v3 ^= $v0;
  97         $v2 = $v2.wrapping_add($v1);
  98         $v1 = $v1.rotate_left(17);
  99         $v1 ^= $v2;
 100         $v2 = $v2.rotate_left(32);
 101     }};
 102 }
 103
 104 /// Loads an integer of the desired type from a byte stream, in LE order. Uses
 105 /// `copy_nonoverlapping` to let the compiler generate the most efficient way
 106 /// to load it from a possibly unaligned address.
 107 ///
 108 /// Unsafe because: unchecked indexing at i..i+size_of(int_ty)
 109 macro_rules! load_int_le {
 110     ($buf:expr, $i:expr, $int_ty:ident) => {{
 111         debug_assert!($i + mem::size_of::<$int_ty>() <= $buf.len());
 112         let mut data = 0 as $int_ty;
 113         ptr::copy_nonoverlapping(
 114             $buf.as_ptr().add($i),
 115             &mut data as *mut _ as *mut u8,
 116             mem::size_of::<$int_ty>(),
 117         );
 118         data.to_le()
 119     }};
 120 }
 121
 122 /// Loads a u64 using up to 7 bytes of a byte slice. It looks clumsy but the
 123 /// `copy_nonoverlapping` calls that occur (via `load_int_le!`) all have fixed
 124 /// sizes and avoid calling `memcpy`, which is good for speed.
 125 ///
 126 /// Unsafe because: unchecked indexing at start..start+len
 127 #[inline]
 128 unsafe fn u8to64_le(buf: &[u8], start: usize, len: usize) -> u64 {
 129     debug_assert!(len < 8);
 130     let mut i = 0; // current byte index (from LSB) in the output u64
 131     let mut out = 0;
 132     if i + 3 < len {
 133         // SAFETY: `i` cannot be greater than `len`, and the caller must guarantee
 134         // that the index start..start+len is in bounds.
 135         out = unsafe { load_int_le!(buf, start + i, u32) } as u64;
 136         i += 4;
 137     }
 138     if i + 1 < len {
 139         // SAFETY: same as above.
 140         out |= (unsafe { load_int_le!(buf, start + i, u16) } as u64) << (i * 8);
 141         i += 2
 142     }
 143     if i < len {
 144         // SAFETY: same as above.
 145         out |= (unsafe { *buf.get_unchecked(start + i) } as u64) << (i * 8);
 146         i += 1;
 147     }
 148     debug_assert_eq!(i, len);
 149     out
 150 }
 151
 152 impl SipHasher {
 153     /// Creates a new `SipHasher` with the two initial keys set to 0.
 154     #[inline]
 155     #[stable(feature = "rust1", since = "1.0.0")]
 156     #[rustc_deprecated(
 157         since = "1.13.0",
 158         reason = "use `std::collections::hash_map::DefaultHasher` instead"
 159     )]
 160     #[must_use]
 161     pub fn new() -> SipHasher {
 162         SipHasher::new_with_keys(0, 0)
 163     }
 164
 165     /// Creates a `SipHasher` that is keyed off the provided keys.
 166     #[inline]
 167     #[stable(feature = "rust1", since = "1.0.0")]
 168     #[rustc_deprecated(
 169         since = "1.13.0",
 170         reason = "use `std::collections::hash_map::DefaultHasher` instead"
 171     )]
 172     #[must_use]
 173     pub fn new_with_keys(key0: u64, key1: u64) -> SipHasher {
 174         SipHasher(SipHasher24 { hasher: Hasher::new_with_keys(key0, key1) })
 175     }
 176 }
 177
 178 impl SipHasher13 {
 179     /// Creates a new `SipHasher13` with the two initial keys set to 0.
 180     #[inline]
 181     #[unstable(feature = "hashmap_internals", issue = "none")]
 182     #[rustc_deprecated(
 183         since = "1.13.0",
 184         reason = "use `std::collections::hash_map::DefaultHasher` instead"
 185     )]
 186     pub fn new() -> SipHasher13 {
 187         SipHasher13::new_with_keys(0, 0)
 188     }
 189
 190     /// Creates a `SipHasher13` that is keyed off the provided keys.
 191     #[inline]
 192     #[unstable(feature = "hashmap_internals", issue = "none")]
 193     #[rustc_deprecated(
 194         since = "1.13.0",
 195         reason = "use `std::collections::hash_map::DefaultHasher` instead"
 196     )]
 197     pub fn new_with_keys(key0: u64, key1: u64) -> SipHasher13 {
 198         SipHasher13 { hasher: Hasher::new_with_keys(key0, key1) }
 199     }
 200 }
 201
 202 impl<S: Sip> Hasher<S> {
 203     #[inline]
 204     fn new_with_keys(key0: u64, key1: u64) -> Hasher<S> {
 205         let mut state = Hasher {
 206             k0: key0,
 207             k1: key1,
 208             length: 0,
 209             state: State { v0: 0, v1: 0, v2: 0, v3: 0 },
 210             tail: 0,
 211             ntail: 0,
 212             _marker: PhantomData,
 213         };
 214         state.reset();
 215         state
 216     }
 217
 218     #[inline]
 219     fn reset(&mut self) {
 220         self.length = 0;
 221         self.state.v0 = self.k0 ^ 0x736f6d6570736575;
 222         self.state.v1 = self.k1 ^ 0x646f72616e646f6d;
 223         self.state.v2 = self.k0 ^ 0x6c7967656e657261;
 224         self.state.v3 = self.k1 ^ 0x7465646279746573;
 225         self.ntail = 0;
 226     }
 227 }
 228
 229 #[stable(feature = "rust1", since = "1.0.0")]
 230 impl super::Hasher for SipHasher {
 231     #[inline]
 232     fn write(&mut self, msg: &[u8]) {
 233         self.0.hasher.write(msg)
 234     }
 235
 236     #[inline]
 237     fn finish(&self) -> u64 {
 238         self.0.hasher.finish()
 239     }
 240 }
 241
 242 #[unstable(feature = "hashmap_internals", issue = "none")]
 243 impl super::Hasher for SipHasher13 {
 244     #[inline]
 245     fn write(&mut self, msg: &[u8]) {
 246         self.hasher.write(msg)
 247     }
 248
 249     #[inline]
 250     fn finish(&self) -> u64 {
 251         self.hasher.finish()
 252     }
 253 }
 254
 255 impl<S: Sip> super::Hasher for Hasher<S> {
 256     // Note: no integer hashing methods (`write_u*`, `write_i*`) are defined
 257     // for this type. We could add them, copy the `short_write` implementation
 258     // in librustc_data_structures/sip128.rs, and add `write_u*`/`write_i*`
 259     // methods to `SipHasher`, `SipHasher13`, and `DefaultHasher`. This would
 260     // greatly speed up integer hashing by those hashers, at the cost of
 261     // slightly slowing down compile speeds on some benchmarks. See #69152 for
 262     // details.
 263     #[inline]
 264     fn write(&mut self, msg: &[u8]) {
 265         let length = msg.len();
 266         self.length += length;
 267
 268         let mut needed = 0;
 269
 270         if self.ntail != 0 {
 271             needed = 8 - self.ntail;
 272             // SAFETY: `cmp::min(length, needed)` is guaranteed to not be over `length`
 273             self.tail |= unsafe { u8to64_le(msg, 0, cmp::min(length, needed)) } << (8 * self.ntail);
 274             if length < needed {
 275                 self.ntail += length;
 276                 return;
 277             } else {
 278                 self.state.v3 ^= self.tail;
 279                 S::c_rounds(&mut self.state);
 280                 self.state.v0 ^= self.tail;
 281                 self.ntail = 0;
 282             }
 283         }
 284
 285         // Buffered tail is now flushed, process new input.
 286         let len = length - needed;
 287         let left = len & 0x7; // len % 8
 288
 289         let mut i = needed;
 290         while i < len - left {
 291             // SAFETY: because `len - left` is the biggest multiple of 8 under
 292             // `len`, and because `i` starts at `needed` where `len` is `length - needed`,
 293             // `i + 8` is guaranteed to be less than or equal to `length`.
 294             let mi = unsafe { load_int_le!(msg, i, u64) };
 295
 296             self.state.v3 ^= mi;
 297             S::c_rounds(&mut self.state);
 298             self.state.v0 ^= mi;
 299
 300             i += 8;
 301         }
 302
 303         // SAFETY: `i` is now `needed + len.div_euclid(8) * 8`,
 304         // so `i + left` = `needed + len` = `length`, which is by
 305         // definition equal to `msg.len()`.
 306         self.tail = unsafe { u8to64_le(msg, i, left) };
 307         self.ntail = left;
 308     }
 309
 310     #[inline]
 311     fn finish(&self) -> u64 {
 312         let mut state = self.state;
 313
 314         let b: u64 = ((self.length as u64 & 0xff) << 56) | self.tail;
 315
 316         state.v3 ^= b;
 317         S::c_rounds(&mut state);
 318         state.v0 ^= b;
 319
 320         state.v2 ^= 0xff;
 321         S::d_rounds(&mut state);
 322
 323         state.v0 ^ state.v1 ^ state.v2 ^ state.v3
 324     }
 325 }
 326
 327 impl<S: Sip> Clone for Hasher<S> {
 328     #[inline]
 329     fn clone(&self) -> Hasher<S> {
 330         Hasher {
 331             k0: self.k0,
 332             k1: self.k1,
 333             length: self.length,
 334             state: self.state,
 335             tail: self.tail,
 336             ntail: self.ntail,
 337             _marker: self._marker,
 338         }
 339     }
 340 }
 341
 342 impl<S: Sip> Default for Hasher<S> {
 343     /// Creates a `Hasher<S>` with the two initial keys set to 0.
 344     #[inline]
 345     fn default() -> Hasher<S> {
 346         Hasher::new_with_keys(0, 0)
 347     }
 348 }
 349
 350 #[doc(hidden)]
 351 trait Sip {
 352     fn c_rounds(_: &mut State);
 353     fn d_rounds(_: &mut State);
 354 }
 355
 356 #[derive(Debug, Clone, Default)]
 357 struct Sip13Rounds;
 358
 359 impl Sip for Sip13Rounds {
 360     #[inline]
 361     fn c_rounds(state: &mut State) {
 362         compress!(state);
 363     }
 364
 365     #[inline]
 366     fn d_rounds(state: &mut State) {
 367         compress!(state);
 368         compress!(state);
 369         compress!(state);
 370     }
 371 }
 372
 373 #[derive(Debug, Clone, Default)]
 374 struct Sip24Rounds;
 375
 376 impl Sip for Sip24Rounds {
 377     #[inline]
 378     fn c_rounds(state: &mut State) {
 379         compress!(state);
 380         compress!(state);
 381     }
 382
 383     #[inline]
 384     fn d_rounds(state: &mut State) {
 385         compress!(state);
 386         compress!(state);
 387         compress!(state);
 388         compress!(state);
 389     }
 390 }