benchmark silo added
[c11concurrency-benchmarks.git] / silo / third-party / lz4 / xxhash.h
diff --git a/silo/third-party/lz4/xxhash.h b/silo/third-party/lz4/xxhash.h
new file mode 100644 (file)
index 0000000..8cb06d3
--- /dev/null
@@ -0,0 +1,164 @@
+/*\r
+   xxHash - Fast Hash algorithm\r
+   Header File\r
+   Copyright (C) 2012-2013, Yann Collet.\r
+   BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)\r
+\r
+   Redistribution and use in source and binary forms, with or without\r
+   modification, are permitted provided that the following conditions are\r
+   met:\r
+  \r
+       * Redistributions of source code must retain the above copyright\r
+   notice, this list of conditions and the following disclaimer.\r
+       * Redistributions in binary form must reproduce the above\r
+   copyright notice, this list of conditions and the following disclaimer\r
+   in the documentation and/or other materials provided with the\r
+   distribution.\r
+  \r
+   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\r
+   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\r
+   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\r
+   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\r
+   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\r
+   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
+   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\r
+   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\r
+   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
+   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\r
+   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
+\r
+   You can contact the author at :\r
+   - xxHash source repository : http://code.google.com/p/xxhash/\r
+*/\r
+\r
+/* Notice extracted from xxHash homepage :\r
+\r
+xxHash is an extremely fast Hash algorithm, running at RAM speed limits.\r
+It also successfully passes all tests from the SMHasher suite.\r
+\r
+Comparison (single thread, Windows Seven 32 bits, using SMHasher on a Core 2 Duo @3GHz)\r
+\r
+Name            Speed       Q.Score   Author\r
+xxHash          5.4 GB/s     10\r
+CrapWow         3.2 GB/s      2       Andrew\r
+MumurHash 3a    2.7 GB/s     10       Austin Appleby\r
+SpookyHash      2.0 GB/s     10       Bob Jenkins\r
+SBox            1.4 GB/s      9       Bret Mulvey\r
+Lookup3         1.2 GB/s      9       Bob Jenkins\r
+SuperFastHash   1.2 GB/s      1       Paul Hsieh\r
+CityHash64      1.05 GB/s    10       Pike & Alakuijala\r
+FNV             0.55 GB/s     5       Fowler, Noll, Vo\r
+CRC32           0.43 GB/s     9\r
+MD5-32          0.33 GB/s    10       Ronald L. Rivest\r
+SHA1-32         0.28 GB/s    10\r
+\r
+Q.Score is a measure of quality of the hash function. \r
+It depends on successfully passing SMHasher test set. \r
+10 is a perfect score.\r
+*/\r
+\r
+#pragma once\r
+\r
+#if defined (__cplusplus)\r
+extern "C" {\r
+#endif\r
+\r
+\r
+//****************************\r
+// Type\r
+//****************************\r
+typedef enum { XXH_OK=0, XXH_ERROR } XXH_errorcode;\r
+\r
+\r
+\r
+//****************************\r
+// Simple Hash Functions\r
+//****************************\r
+\r
+unsigned int XXH32 (const void* input, int len, unsigned int seed);\r
+\r
+/*\r
+XXH32() :\r
+    Calculate the 32-bits hash of sequence of length "len" stored at memory address "input".\r
+    The memory between input & input+len must be valid (allocated and read-accessible).\r
+    "seed" can be used to alter the result predictably.\r
+    This function successfully passes all SMHasher tests.\r
+    Speed on Core 2 Duo @ 3 GHz (single thread, SMHasher benchmark) : 5.4 GB/s\r
+    Note that "len" is type "int", which means it is limited to 2^31-1.\r
+    If your data is larger, use the advanced functions below.\r
+*/\r
+\r
+\r
+\r
+//****************************\r
+// Advanced Hash Functions\r
+//****************************\r
+\r
+void*         XXH32_init   (unsigned int seed);\r
+XXH_errorcode XXH32_update (void* state, const void* input, int len);\r
+unsigned int  XXH32_digest (void* state);\r
+\r
+/*\r
+These functions calculate the xxhash of an input provided in several small packets,\r
+as opposed to an input provided as a single block.\r
+\r
+It must be started with :\r
+void* XXH32_init()\r
+The function returns a pointer which holds the state of calculation.\r
+\r
+This pointer must be provided as "void* state" parameter for XXH32_update().\r
+XXH32_update() can be called as many times as necessary.\r
+The user must provide a valid (allocated) input.\r
+The function returns an error code, with 0 meaning OK, and any other value meaning there is an error.\r
+Note that "len" is type "int", which means it is limited to 2^31-1. \r
+If your data is larger, it is recommended to chunk your data into blocks \r
+of size for example 2^30 (1GB) to avoid any "int" overflow issue.\r
+\r
+Finally, you can end the calculation anytime, by using XXH32_digest().\r
+This function returns the final 32-bits hash.\r
+You must provide the same "void* state" parameter created by XXH32_init().\r
+Memory will be freed by XXH32_digest().\r
+*/\r
+\r
+\r
+int           XXH32_sizeofState();\r
+XXH_errorcode XXH32_resetState(void* state, unsigned int seed);\r
+\r
+#define       XXH32_SIZEOFSTATE 48\r
+typedef struct { long long ll[(XXH32_SIZEOFSTATE+(sizeof(long long)-1))/sizeof(long long)]; } XXH32_stateSpace_t;\r
+/*\r
+These functions allow user application to make its own allocation for state.\r
+\r
+XXH32_sizeofState() is used to know how much space must be allocated for the xxHash 32-bits state.\r
+Note that the state must be aligned to access 'long long' fields. Memory must be allocated and referenced by a pointer.\r
+This pointer must then be provided as 'state' into XXH32_resetState(), which initializes the state.\r
+\r
+For static allocation purposes (such as allocation on stack, or freestanding systems without malloc()),\r
+use the structure XXH32_stateSpace_t, which will ensure that memory space is large enough and correctly aligned to access 'long long' fields.\r
+*/\r
+\r
+\r
+unsigned int XXH32_intermediateDigest (void* state);\r
+/*\r
+This function does the same as XXH32_digest(), generating a 32-bit hash,\r
+but preserve memory context.\r
+This way, it becomes possible to generate intermediate hashes, and then continue feeding data with XXH32_update().\r
+To free memory context, use XXH32_digest(), or free().\r
+*/\r
+\r
+\r
+\r
+//****************************\r
+// Deprecated function names\r
+//****************************\r
+// The following translations are provided to ease code transition\r
+// You are encouraged to no longer this function names\r
+#define XXH32_feed   XXH32_update\r
+#define XXH32_result XXH32_digest\r
+#define XXH32_getIntermediateResult XXH32_intermediateDigest\r
+\r
+\r
+\r
+#if defined (__cplusplus)\r
+}\r
+#endif\r