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
use crate::{entropy::EntropyPool, C};
use std::{default::Default, hash::Hasher, marker::PhantomData, mem::MaybeUninit, os::raw::c_void};

/// xxh3 64 bit c library bindings
///
/// ::default() and ::new() are equivalent; they construct the unseeded
/// streaming variant…
#[derive(Clone)]
pub struct XXH3_64<'a> {
    state: C::XXH3_state_t,
    entropy_lifetime: PhantomData<&'a [u8]>,
}

impl Default for XXH3_64<'_> {
    #[inline]
    fn default() -> Self {
        Self::new()
    }
}

impl XXH3_64<'_> {
    /// One-shot hashing
    #[inline]
    pub fn hash(bytes: &[u8]) -> u64 {
        unsafe { C::XXH3_64bits(bytes.as_ptr() as *const c_void, bytes.len() as u64) }
    }

    /// One-shot hashing with custom entropy buffer.
    ///
    /// This corresponds to XXH3_64bits_withSecret. You probably want
    /// to use hash_with_entropy instead unless you really need to supply
    /// custom size entropy buffers, in which case this is the function
    /// to use.
    ///
    /// # Safety
    ///
    /// This function is marked unsafe just to encourage using the EntropyPool
    /// abstraction which makes it hard to produce particularly unsafe entropy
    /// pools.
    ///
    /// The entropy pool must be at least 136 bytes.
    #[inline]
    pub unsafe fn hash_with_entropy_buffer(entropy: &[u8], bytes: &[u8]) -> u64 {
        assert!(entropy.len() >= (C::XXH3_SECRET_SIZE_MIN) as usize);
        C::XXH3_64bits_withSecret(
            bytes.as_ptr() as *const c_void,
            bytes.len() as u64,
            entropy.as_ptr() as *const c_void,
            entropy.len() as u64,
        )
    }

    /// One-shot hashing with custom entropy buffer.
    ///
    /// This corresponds to XXH3_64bits_withSecret.
    #[inline]
    pub fn hash_with_entropy(entropy: &EntropyPool, bytes: &[u8]) -> u64 {
        unsafe { Self::hash_with_entropy_buffer(&entropy.entropy, bytes) }
    }

    /// One-shot hashing with seed
    #[inline]
    pub fn hash_with_seed(seed: u64, bytes: &[u8]) -> u64 {
        unsafe {
            C::XXH3_64bits_withSeed(bytes.as_ptr() as *const c_void, bytes.len() as u64, seed)
        }
    }

    /// Streaming hashing
    #[inline]
    pub fn new() -> XXH3_64<'static> {
        unsafe {
            let mut r = MaybeUninit::<C::XXH3_state_t>::uninit();
            C::XXH3_64bits_reset(r.as_mut_ptr() as *mut C::XXH3_state_t);
            XXH3_64 {
                state: r.assume_init(),
                entropy_lifetime: PhantomData,
            }
        }
    }

    /// Streaming hashing with custom entropy buffer.
    ///
    /// This corresponds to XXH3_64bits_reset_withSecret.
    ///
    /// This function is marked unsafe to discourage it's use; use with_entropy
    /// instead which copies the entropy (thus causing far fewer lifetime problems)
    /// and uses the safer EntropyPool abstraction.
    ///
    /// # Safety
    ///
    /// Use this function if you really want to avoid the entropy copy
    /// or if you really need to use a custom size entropy pool.
    ///
    /// The entropy pool must be at least 136 bytes.
    #[inline]
    pub unsafe fn with_entropy_buffer(entropy: &[u8]) -> XXH3_64 {
        assert!(entropy.len() >= (C::XXH3_SECRET_SIZE_MIN) as usize);
        let mut r = MaybeUninit::<C::XXH3_state_t>::uninit();
        C::XXH3_64bits_reset_withSecret(
            r.as_mut_ptr() as *mut C::XXH3_state_t,
            entropy.as_ptr() as *const c_void,
            entropy.len() as u64,
        );
        XXH3_64 {
            state: r.assume_init(),
            entropy_lifetime: PhantomData,
        }
    }

    /// Streaming hashing with custom entropy buffer.
    ///
    /// This corresponds to XXH3_64bits_reset_withSecret.
    #[inline]
    pub fn with_entropy(entropy: &EntropyPool) -> XXH3_64<'static> {
        unsafe {
            let mut r = MaybeUninit::<C::XXH3_state_t>::uninit();
            C::XXHRS_64bits_reset_withSecretCopy(
                r.as_mut_ptr() as *mut C::XXH3_state_t,
                entropy.entropy.as_ptr() as *const c_void,
            );
            XXH3_64 {
                state: r.assume_init(),
                entropy_lifetime: PhantomData,
            }
        }
    }

    /// Streaming hashing with custom seed.
    #[inline]
    pub fn with_seed(seed: u64) -> XXH3_64<'static> {
        unsafe {
            let mut r = MaybeUninit::<C::XXH3_state_t>::uninit();
            C::XXH3_64bits_reset_withSeed(r.as_mut_ptr() as *mut C::XXH3_state_t, seed);
            XXH3_64 {
                state: r.assume_init(),
                entropy_lifetime: PhantomData,
            }
        }
    }
}

impl Hasher for XXH3_64<'_> {
    #[inline]
    fn write(&mut self, bytes: &[u8]) {
        unsafe {
            C::XXH3_64bits_update(
                &mut self.state,
                bytes.as_ptr() as *const c_void,
                bytes.len() as u64,
            );
        }
    }

    #[inline]
    fn finish(&self) -> u64 {
        unsafe { C::XXH3_64bits_digest(&self.state) }
    }
}

/// xxh3 64 bit c library bindings
///
/// Streaming mode is used just like the `Hasher` trait, but does
/// not implement the trait because this returns u128, hasher requires u64
///
/// ::default() and ::new() are equivalent; they construct the unseeded
/// streaming variant…
#[derive(Clone)]
pub struct XXH3_128<'a> {
    state: C::XXH3_state_t,
    entropy_lifetime: PhantomData<&'a [u8]>,
}

impl Default for XXH3_128<'_> {
    #[inline]
    fn default() -> Self {
        Self::new()
    }
}

#[inline]
fn xxh128_to_u128(val: C::XXH128_hash_t) -> u128 {
    (val.low64 as u128) | (val.high64 as u128) << 64
}

impl XXH3_128<'_> {
    /// One-shot hashing
    #[inline]
    pub fn hash(bytes: &[u8]) -> u128 {
        let r = unsafe { C::XXH3_128bits(bytes.as_ptr() as *const c_void, bytes.len() as u64) };
        xxh128_to_u128(r)
    }

    /// One-shot hashing with custom entropy buffer.
    ///
    /// This corresponds to XXH3_64bits_withSecret. You probably want
    /// to use hash_with_entropy instead unless you really need to supply
    /// custom size entropy buffers, in which case this is the function
    /// to use.
    ///
    /// # Safety
    ///
    /// This function is marked unsafe just to encourage using the EntropyPool
    /// abstraction which makes it hard to produce particularly unsafe entropy
    /// pools.
    ///
    /// The entropy pool must be at least 136 bytes.
    #[inline]
    pub unsafe fn hash_with_entropy_buffer(entropy: &[u8], bytes: &[u8]) -> u128 {
        assert!(entropy.len() >= (C::XXH3_SECRET_SIZE_MIN) as usize);
        let r = C::XXH3_128bits_withSecret(
            bytes.as_ptr() as *const c_void,
            bytes.len() as u64,
            entropy.as_ptr() as *const c_void,
            entropy.len() as u64,
        );
        xxh128_to_u128(r)
    }

    /// One-shot hashing with custom entropy buffer.
    ///
    /// This corresponds to XXH3_64bits_withSecret.
    #[inline]
    pub fn hash_with_entropy(entropy: &EntropyPool, bytes: &[u8]) -> u128 {
        unsafe { Self::hash_with_entropy_buffer(&entropy.entropy, bytes) }
    }

    /// One-shot hashing with seed
    #[inline]
    pub fn hash_with_seed(seed: u64, bytes: &[u8]) -> u128 {
        let r = unsafe {
            C::XXH3_128bits_withSeed(bytes.as_ptr() as *const c_void, bytes.len() as u64, seed)
        };
        xxh128_to_u128(r)
    }

    /// Streaming hashing
    #[inline]
    pub fn new() -> XXH3_128<'static> {
        unsafe {
            let mut r = MaybeUninit::<C::XXH3_state_t>::uninit();
            C::XXH3_128bits_reset(r.as_mut_ptr() as *mut C::XXH3_state_t);
            XXH3_128 {
                state: r.assume_init(),
                entropy_lifetime: PhantomData,
            }
        }
    }

    /// Streaming hashing with custom entropy buffer.
    ///
    /// This corresponds to XXH3_64bits_reset_withSecret.
    ///
    /// This function is marked unsafe to discourage it's use; use with_entropy
    /// instead which copies the entropy (thus causing far fewer lifetime problems)
    /// and uses the safer EntropyPool abstraction.
    ///
    /// # Safety
    ///
    /// Use this function if you really want to avoid the entropy copy
    /// or if you really need to use a custom size entropy pool.
    ///
    /// The entropy pool must be at least 136 bytes.
    #[inline]
    pub unsafe fn with_entropy_buffer(entropy: &[u8]) -> XXH3_128 {
        assert!(entropy.len() >= (C::XXH3_SECRET_SIZE_MIN) as usize);
        let mut r = MaybeUninit::<C::XXH3_state_t>::uninit();
        C::XXH3_128bits_reset_withSecret(
            r.as_mut_ptr() as *mut C::XXH3_state_t,
            entropy.as_ptr() as *const c_void,
            entropy.len() as u64,
        );
        XXH3_128 {
            state: r.assume_init(),
            entropy_lifetime: PhantomData,
        }
    }

    /// Streaming hashing with custom entropy buffer.
    ///
    /// This corresponds to XXH3_64bits_reset_withSecret.
    #[inline]
    pub fn with_entropy(entropy: &EntropyPool) -> XXH3_128<'static> {
        unsafe {
            let mut r = MaybeUninit::<C::XXH3_state_t>::uninit();
            C::XXHRS_128bits_reset_withSecretCopy(
                r.as_mut_ptr() as *mut C::XXH3_state_t,
                entropy.entropy.as_ptr() as *const c_void,
            );
            XXH3_128 {
                state: r.assume_init(),
                entropy_lifetime: PhantomData,
            }
        }
    }

    /// Streaming hashing with custom seed.
    #[inline]
    pub fn with_seed(seed: u64) -> XXH3_128<'static> {
        unsafe {
            let mut r = MaybeUninit::<C::XXH3_state_t>::uninit();
            C::XXH3_128bits_reset_withSeed(r.as_mut_ptr() as *mut C::XXH3_state_t, seed);
            XXH3_128 {
                state: r.assume_init(),
                entropy_lifetime: PhantomData,
            }
        }
    }

    #[inline]
    pub fn write(&mut self, bytes: &[u8]) {
        unsafe {
            C::XXH3_128bits_update(
                &mut self.state,
                bytes.as_ptr() as *const c_void,
                bytes.len() as u64,
            );
        }
    }

    #[inline]
    pub fn finish(&self) -> u128 {
        let r = unsafe { C::XXH3_128bits_digest(&self.state) };
        xxh128_to_u128(r)
    }
}