      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

    // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! An implementation of SipHash 2-4.

    use prelude::v1::*;

    use ptr;
    use super::Hasher;

    /// An implementation of SipHash 2-4.
    ///
    /// See: http://131002.net/siphash/
    ///
    /// This is currently the default hashing function used by standard library
    /// (eg. `collections::HashMap` uses it by default).
    ///
    /// SipHash is a general-purpose hashing function: it runs at a good
    /// speed (competitive with Spooky and City) and permits strong _keyed_
    /// hashing. This lets you key your hashtables from a strong RNG, such as
    /// [`rand::os::OsRng`](https://doc.rust-lang.org/rand/rand/os/struct.OsRng.html).
    ///
    /// Although the SipHash algorithm is considered to be generally strong,
    /// it is not intended for cryptographic purposes. As such, all
    /// cryptographic uses of this implementation are _strongly discouraged_.
    #[derive(Debug)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub struct SipHasher {
        k0: u64,
        k1: u64,
        length: usize, // how many bytes we've processed
        // v0, v2 and v1, v3 show up in pairs in the algorithm,
        // and simd implementations of SipHash will use vectors
        // of v02 and v13. By placing them in this order in the struct,
        // the compiler can pick up on just a few simd optimizations by itself.
        v0: u64, // hash state
        v2: u64,
        v1: u64,
        v3: u64,
        tail: u64, // unprocessed bytes le
        ntail: usize, // how many bytes in tail are valid
    }

    // sadly, these macro definitions can't appear later,
    // because they're needed in the following defs;
    // this design could be improved.

    macro_rules! u8to64_le {
        ($buf:expr, $i:expr) =>
        ($buf[0+$i] as u64 |
         ($buf[1+$i] as u64) << 8 |
         ($buf[2+$i] as u64) << 16 |
         ($buf[3+$i] as u64) << 24 |
         ($buf[4+$i] as u64) << 32 |
         ($buf[5+$i] as u64) << 40 |
         ($buf[6+$i] as u64) << 48 |
         ($buf[7+$i] as u64) << 56);
        ($buf:expr, $i:expr, $len:expr) =>
        ({
            let mut t = 0;
            let mut out = 0;
            while t < $len {
                out |= ($buf[t+$i] as u64) << t*8;
                t += 1;
            }
            out
        });
    }

    /// Load a full u64 word from a byte stream, in LE order. Use
    /// `copy_nonoverlapping` to let the compiler generate the most efficient way
    /// to load u64 from a possibly unaligned address.
    ///
    /// Unsafe because: unchecked indexing at i..i+8
    #[inline]
    unsafe fn load_u64_le(buf: &[u8], i: usize) -> u64 {
        debug_assert!(i + 8 <= buf.len());
        let mut data = 0u64;
        ptr::copy_nonoverlapping(buf.get_unchecked(i), &mut data as *mut _ as *mut u8, 8);
        data.to_le()
    }

    macro_rules! rotl {
        ($x:expr, $b:expr) =>
        (($x << $b) | ($x >> (64_i32.wrapping_sub($b))))
    }

    macro_rules! compress {
        ($v0:expr, $v1:expr, $v2:expr, $v3:expr) =>
        ({
            $v0 = $v0.wrapping_add($v1); $v1 = rotl!($v1, 13); $v1 ^= $v0;
            $v0 = rotl!($v0, 32);
            $v2 = $v2.wrapping_add($v3); $v3 = rotl!($v3, 16); $v3 ^= $v2;
            $v0 = $v0.wrapping_add($v3); $v3 = rotl!($v3, 21); $v3 ^= $v0;
            $v2 = $v2.wrapping_add($v1); $v1 = rotl!($v1, 17); $v1 ^= $v2;
            $v2 = rotl!($v2, 32);
        })
    }

    impl SipHasher {
        /// Creates a new `SipHasher` with the two initial keys set to 0.
        #[inline]
        #[stable(feature = "rust1", since = "1.0.0")]
        pub fn new() -> SipHasher {
            SipHasher::new_with_keys(0, 0)
        }

        /// Creates a `SipHasher` that is keyed off the provided keys.
        #[inline]
        #[stable(feature = "rust1", since = "1.0.0")]
        pub fn new_with_keys(key0: u64, key1: u64) -> SipHasher {
            let mut state = SipHasher {
                k0: key0,
                k1: key1,
                length: 0,
                v0: 0,
                v1: 0,
                v2: 0,
                v3: 0,
                tail: 0,
                ntail: 0,
            };
            state.reset();
            state
        }

        #[inline]
        fn reset(&mut self) {
            self.length = 0;
            self.v0 = self.k0 ^ 0x736f6d6570736575;
            self.v1 = self.k1 ^ 0x646f72616e646f6d;
            self.v2 = self.k0 ^ 0x6c7967656e657261;
            self.v3 = self.k1 ^ 0x7465646279746573;
            self.ntail = 0;
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl Hasher for SipHasher {
        #[inline]
        fn write(&mut self, msg: &[u8]) {
            let length = msg.len();
            self.length += length;

            let mut needed = 0;

            if self.ntail != 0 {
                needed = 8 - self.ntail;
                if length < needed {
                    self.tail |= u8to64_le!(msg, 0, length) << 8 * self.ntail;
                    self.ntail += length;
                    return
                }

                let m = self.tail | u8to64_le!(msg, 0, needed) << 8 * self.ntail;

                self.v3 ^= m;
                compress!(self.v0, self.v1, self.v2, self.v3);
                compress!(self.v0, self.v1, self.v2, self.v3);
                self.v0 ^= m;

                self.ntail = 0;
            }

            // Buffered tail is now flushed, process new input.
            let len = length - needed;
            let left = len & 0x7;

            let mut i = needed;
            while i < len - left {
                let mi = unsafe { load_u64_le(msg, i) };

                self.v3 ^= mi;
                compress!(self.v0, self.v1, self.v2, self.v3);
                compress!(self.v0, self.v1, self.v2, self.v3);
                self.v0 ^= mi;

                i += 8;
            }

            self.tail = u8to64_le!(msg, i, left);
            self.ntail = left;
        }

        #[inline]
        fn finish(&self) -> u64 {
            let mut v0 = self.v0;
            let mut v1 = self.v1;
            let mut v2 = self.v2;
            let mut v3 = self.v3;

            let b: u64 = ((self.length as u64 & 0xff) << 56) | self.tail;

            v3 ^= b;
            compress!(v0, v1, v2, v3);
            compress!(v0, v1, v2, v3);
            v0 ^= b;

            v2 ^= 0xff;
            compress!(v0, v1, v2, v3);
            compress!(v0, v1, v2, v3);
            compress!(v0, v1, v2, v3);
            compress!(v0, v1, v2, v3);

            v0 ^ v1 ^ v2 ^ v3
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl Clone for SipHasher {
        #[inline]
        fn clone(&self) -> SipHasher {
            SipHasher {
                k0: self.k0,
                k1: self.k1,
                length: self.length,
                v0: self.v0,
                v1: self.v1,
                v2: self.v2,
                v3: self.v3,
                tail: self.tail,
                ntail: self.ntail,
            }
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl Default for SipHasher {
        fn default() -> SipHasher {
            SipHasher::new()
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)