metrohash.h

// metrohash.h
//
// The MIT License (MIT)
//
// Copyright (c) 2015 J. Andrew Rogers
// Copyright (c) 2015 cPanel Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//

#ifndef METROHASH_METROHASH_H
#define METROHASH_METROHASH_H

#include <stdint.h>
#include <string.h>
// TODO: msvc compat

// MetroHash 64-bit hash functions
void metrohash64_1(const uint8_t * key, uint64_t len, uint64_t seed, uint8_t * out);
void metrohash64_2(const uint8_t * key, uint64_t len, uint64_t seed, uint8_t * out);

// MetroHash 64-bit hash functions using HW CRC instruction
void metrohash64crc_1(const uint8_t * key, uint64_t len, uint64_t seed, uint8_t * out);
void metrohash64crc_2(const uint8_t * key, uint64_t len, uint64_t seed, uint8_t * out);

// MetroHash 128-bit hash functions
void metrohash128_1(const uint8_t * key, uint64_t len, uint64_t seed, uint8_t * out);
void metrohash128_2(const uint8_t * key, uint64_t len, uint64_t seed, uint8_t * out);

// MetroHash 128-bit hash functions using HW CRC instruction
void metrohash128crc_1(const uint8_t * key, uint64_t len, uint64_t seed, uint8_t * out);
void metrohash128crc_2(const uint8_t * key, uint64_t len, uint64_t seed, uint8_t * out);


/* rotate right idiom recognized by compiler*/
inline static uint64_t rotate_right(uint64_t v, unsigned k)
{
    return (v >> k) | (v << (64 - k));
}

// unaligned reads, fast and safe on Nehalem and later microarchitectures
inline static uint64_t read_u64(const void * const ptr)
{
    return static_cast<uint64_t>(*reinterpret_cast<const uint64_t*>(ptr));
}

inline static uint64_t read_u32(const void * const ptr)
{
    return static_cast<uint64_t>(*reinterpret_cast<const uint32_t*>(ptr));
}

inline static uint64_t read_u16(const void * const ptr)
{
    return static_cast<uint64_t>(*reinterpret_cast<const uint16_t*>(ptr));
}

inline static uint64_t read_u8 (const void * const ptr)
{
    return static_cast<uint64_t>(*reinterpret_cast<const uint8_t *>(ptr));
}


#endif // #ifndef METROHASH_METROHASH_H