1 /* 2 xxHash - Extremely Fast Hash algorithm 3 Header File 4 Copyright (C) 2012-2016, Yann Collet. 5 6 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php) 7 8 Redistribution and use in source and binary forms, with or without 9 modification, are permitted provided that the following conditions are 10 met: 11 12 * Redistributions of source code must retain the above copyright 13 notice, this list of conditions and the following disclaimer. 14 * Redistributions in binary form must reproduce the above 15 copyright notice, this list of conditions and the following disclaimer 16 in the documentation and/or other materials provided with the 17 distribution. 18 19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31 You can contact the author at : 32 - xxHash source repository : https://github.com/Cyan4973/xxHash 33 */ 34 35 /* Notice extracted from xxHash homepage : 36 37 xxHash is an extremely fast Hash algorithm, running at RAM speed limits. 38 It also successfully passes all tests from the SMHasher suite. 39 40 Comparison (single thread, Windows Seven 32 bits, using SMHasher on a Core 2 Duo @3GHz) 41 42 Name Speed Q.Score Author 43 xxHash 5.4 GB/s 10 44 CrapWow 3.2 GB/s 2 Andrew 45 MumurHash 3a 2.7 GB/s 10 Austin Appleby 46 SpookyHash 2.0 GB/s 10 Bob Jenkins 47 SBox 1.4 GB/s 9 Bret Mulvey 48 Lookup3 1.2 GB/s 9 Bob Jenkins 49 SuperFastHash 1.2 GB/s 1 Paul Hsieh 50 CityHash64 1.05 GB/s 10 Pike & Alakuijala 51 FNV 0.55 GB/s 5 Fowler, Noll, Vo 52 CRC32 0.43 GB/s 9 53 MD5-32 0.33 GB/s 10 Ronald L. Rivest 54 SHA1-32 0.28 GB/s 10 55 56 Q.Score is a measure of quality of the hash function. 57 It depends on successfully passing SMHasher test set. 58 10 is a perfect score. 59 60 A 64-bits version, named XXH64, is available since r35. 61 It offers much better speed, but for 64-bits applications only. 62 Name Speed on 64 bits Speed on 32 bits 63 XXH64 13.8 GB/s 1.9 GB/s 64 XXH32 6.8 GB/s 6.0 GB/s 65 */ 66 67 #ifndef XXHASH_H_5627135585666179 68 #define XXHASH_H_5627135585666179 1 69 70 #if defined (__cplusplus) 71 extern "C" { 72 #endif 73 74 75 /* **************************** 76 * Definitions 77 ******************************/ 78 #if !defined(_KERNEL) 79 #include <stddef.h> /* size_t */ 80 #endif 81 typedef enum { XXH_OK=0, XXH_ERROR } XXH_errorcode; 82 83 84 /* **************************** 85 * API modifier 86 ******************************/ 87 /*!XXH_PRIVATE_API 88 * Transforms all publics symbols within `xxhash.c` into private ones. 89 * Methodology : 90 * instead of : #include "xxhash.h" 91 * do : 92 * #define XXH_PRIVATE_API 93 * #include "xxhash.c" // note the .c , instead of .h 94 * also : don't compile and link xxhash.c separately 95 */ 96 #ifdef XXH_PRIVATE_API 97 # if defined(__GNUC__) 98 # define XXH_PUBLIC_API static __attribute__((unused)) 99 # elif defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */) 100 # define XXH_PUBLIC_API static inline 101 # elif defined(_MSC_VER) 102 # define XXH_PUBLIC_API static __inline 103 # else 104 # define XXH_PUBLIC_API static /* this version may generate warnings for unused static functions; disable the relevant warning */ 105 # endif 106 #else 107 # define XXH_PUBLIC_API /* do nothing */ 108 #endif 109 110 /*!XXH_NAMESPACE, aka Namespace Emulation : 111 112 If you want to include _and expose_ xxHash functions from within your own library, 113 but also want to avoid symbol collisions with another library which also includes xxHash, 114 115 you can use XXH_NAMESPACE, to automatically prefix any public symbol from `xxhash.c` 116 with the value of XXH_NAMESPACE (so avoid to keep it NULL and avoid numeric values). 117 118 Note that no change is required within the calling program as long as it also includes `xxhash.h` : 119 regular symbol name will be automatically translated by this header. 120 */ 121 #ifdef XXH_NAMESPACE 122 # define XXH_CAT(A,B) A##B 123 # define XXH_NAME2(A,B) XXH_CAT(A,B) 124 # define XXH32 XXH_NAME2(XXH_NAMESPACE, XXH32) 125 # define XXH64 XXH_NAME2(XXH_NAMESPACE, XXH64) 126 # define XXH_versionNumber XXH_NAME2(XXH_NAMESPACE, XXH_versionNumber) 127 # define XXH32_createState XXH_NAME2(XXH_NAMESPACE, XXH32_createState) 128 # define XXH64_createState XXH_NAME2(XXH_NAMESPACE, XXH64_createState) 129 # define XXH32_freeState XXH_NAME2(XXH_NAMESPACE, XXH32_freeState) 130 # define XXH64_freeState XXH_NAME2(XXH_NAMESPACE, XXH64_freeState) 131 # define XXH32_reset XXH_NAME2(XXH_NAMESPACE, XXH32_reset) 132 # define XXH64_reset XXH_NAME2(XXH_NAMESPACE, XXH64_reset) 133 # define XXH32_update XXH_NAME2(XXH_NAMESPACE, XXH32_update) 134 # define XXH64_update XXH_NAME2(XXH_NAMESPACE, XXH64_update) 135 # define XXH32_digest XXH_NAME2(XXH_NAMESPACE, XXH32_digest) 136 # define XXH64_digest XXH_NAME2(XXH_NAMESPACE, XXH64_digest) 137 #endif 138 139 140 /* ************************************* 141 * Version 142 ***************************************/ 143 #define XXH_VERSION_MAJOR 0 144 #define XXH_VERSION_MINOR 6 145 #define XXH_VERSION_RELEASE 0 146 #define XXH_VERSION_NUMBER (XXH_VERSION_MAJOR *100*100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE) 147 XXH_PUBLIC_API unsigned XXH_versionNumber (void); 148 149 150 /* **************************** 151 * Simple Hash Functions 152 ******************************/ 153 typedef unsigned int XXH32_hash_t; 154 typedef unsigned long long XXH64_hash_t; 155 156 XXH_PUBLIC_API XXH32_hash_t XXH32 (const void* input, size_t length, unsigned int seed); 157 XXH_PUBLIC_API XXH64_hash_t XXH64 (const void* input, size_t length, unsigned long long seed); 158 159 /*! 160 XXH32() : 161 Calculate the 32-bits hash of sequence "length" bytes stored at memory address "input". 162 The memory between input & input+length must be valid (allocated and read-accessible). 163 "seed" can be used to alter the result predictably. 164 Speed on Core 2 Duo @ 3 GHz (single thread, SMHasher benchmark) : 5.4 GB/s 165 XXH64() : 166 Calculate the 64-bits hash of sequence of length "len" stored at memory address "input". 167 "seed" can be used to alter the result predictably. 168 This function runs faster on 64-bits systems, but slower on 32-bits systems (see benchmark). 169 */ 170 171 172 /* **************************** 173 * Streaming Hash Functions 174 ******************************/ 175 typedef struct XXH32_state_s XXH32_state_t; /* incomplete type */ 176 typedef struct XXH64_state_s XXH64_state_t; /* incomplete type */ 177 178 /*! Dynamic allocation of states 179 Compatible with dynamic libraries */ 180 181 XXH_PUBLIC_API XXH32_state_t* XXH32_createState(void); 182 XXH_PUBLIC_API XXH_errorcode XXH32_freeState(XXH32_state_t* statePtr); 183 184 XXH_PUBLIC_API XXH64_state_t* XXH64_createState(void); 185 XXH_PUBLIC_API XXH_errorcode XXH64_freeState(XXH64_state_t* statePtr); 186 187 188 /* hash streaming */ 189 190 XXH_PUBLIC_API XXH_errorcode XXH32_reset (XXH32_state_t* statePtr, unsigned int seed); 191 XXH_PUBLIC_API XXH_errorcode XXH32_update (XXH32_state_t* statePtr, const void* input, size_t length); 192 XXH_PUBLIC_API XXH32_hash_t XXH32_digest (const XXH32_state_t* statePtr); 193 194 XXH_PUBLIC_API XXH_errorcode XXH64_reset (XXH64_state_t* statePtr, unsigned long long seed); 195 XXH_PUBLIC_API XXH_errorcode XXH64_update (XXH64_state_t* statePtr, const void* input, size_t length); 196 XXH_PUBLIC_API XXH64_hash_t XXH64_digest (const XXH64_state_t* statePtr); 197 198 /*! 199 These functions generate the xxHash of an input provided in multiple segments, 200 as opposed to provided as a single block. 201 202 XXH state must first be allocated, using either static or dynamic method provided above. 203 204 Start a new hash by initializing state with a seed, using XXHnn_reset(). 205 206 Then, feed the hash state by calling XXHnn_update() as many times as necessary. 207 Obviously, input must be valid, hence allocated and read accessible. 208 The function returns an error code, with 0 meaning OK, and any other value meaning there is an error. 209 210 Finally, a hash value can be produced anytime, by using XXHnn_digest(). 211 This function returns the nn-bits hash as an int or long long. 212 213 It's still possible to continue inserting input into the hash state after a digest, 214 and later on generate some new hashes, by calling again XXHnn_digest(). 215 216 When done, free XXH state space if it was allocated dynamically. 217 */ 218 219 220 /* ************************** 221 * Canonical representation 222 ****************************/ 223 typedef struct { unsigned char digest[4]; } XXH32_canonical_t; 224 typedef struct { unsigned char digest[8]; } XXH64_canonical_t; 225 226 XXH_PUBLIC_API void XXH32_canonicalFromHash(XXH32_canonical_t* dst, XXH32_hash_t hash); 227 XXH_PUBLIC_API void XXH64_canonicalFromHash(XXH64_canonical_t* dst, XXH64_hash_t hash); 228 229 XXH_PUBLIC_API XXH32_hash_t XXH32_hashFromCanonical(const XXH32_canonical_t* src); 230 XXH_PUBLIC_API XXH64_hash_t XXH64_hashFromCanonical(const XXH64_canonical_t* src); 231 232 /*! Default result type for XXH functions are primitive unsigned 32 and 64 bits. 233 * The canonical representation uses human-readable write convention, aka big-endian (large digits first). 234 * These functions allow transformation of hash result into and from its canonical format. 235 * This way, hash values can be written into a file / memory, and remain comparable on different systems and programs. 236 */ 237 238 239 #ifdef XXH_STATIC_LINKING_ONLY 240 241 /* This part contains definition which shall only be used with static linking. 242 The prototypes / types defined here are not guaranteed to remain stable. 243 They could change in a future version, becoming incompatible with a different version of the library */ 244 245 struct XXH32_state_s { 246 unsigned long long total_len; 247 unsigned seed; 248 unsigned v1; 249 unsigned v2; 250 unsigned v3; 251 unsigned v4; 252 unsigned mem32[4]; /* buffer defined as U32 for alignment */ 253 unsigned memsize; 254 }; /* typedef'd to XXH32_state_t */ 255 256 struct XXH64_state_s { 257 unsigned long long total_len; 258 unsigned long long seed; 259 unsigned long long v1; 260 unsigned long long v2; 261 unsigned long long v3; 262 unsigned long long v4; 263 unsigned long long mem64[4]; /* buffer defined as U64 for alignment */ 264 unsigned memsize; 265 }; /* typedef'd to XXH64_state_t */ 266 267 268 #endif 269 270 271 #if defined (__cplusplus) 272 } 273 #endif 274 275 #endif /* XXHASH_H_5627135585666179 */ 276