xxhash 0.1.1 → 0.2.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+lib/xxhash/xxhash.so

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+### 0.2.0 (September 4, 2013)
+  * xxHash updated to [r32](https://code.google.com/p/xxhash/source/detail?r=32)
+  * add `XXhash.xxh32_stream` method (by [@maltoe](https://github.com/maltoe))
+
+### 0.1.1 (June 4, 2013)
+  * remove .bundle from gem
+
+### 0.1.0 (May 16, 2013)
+  * xxHash updated to [r29](https://code.google.com/p/xxhash/source/detail?r=29)

data/README.md

@@ -17,6 +17,14 @@ seed = 12345
 XXhash.xxh32(text, seed) # => 3834992036
 ```
 
+You can use it with `IO` objects too:
+
+```ruby
+XXhash.xxh32_stream(StringIO.new('test'), 123) # => 2758658570
+```
+
+Note that you can also pass a chunk size as third param (it's 32 bytes by default)
+
 ### Supported Ruby versions
 
 - MRI 1.9.3
@@ -26,7 +34,7 @@ Note: It doesn't work on JRuby as it uses C extension.
 
 ### Versioning
 
-Version 0.1.0 is equal to [r29](https://code.google.com/p/xxhash/source/detail?r=29)
+Version 0.2.0 is equal to [r32](https://code.google.com/p/xxhash/source/detail?r32)
 
 ## Contributing
 
@@ -38,5 +46,5 @@ Version 0.1.0 is equal to [r29](https://code.google.com/p/xxhash/source/detail?r
 
 ### Copyright
 
-Copyright (c) 2012 Vasiliy Ermolovich. See LICENSE.txt for
+Copyright (c) 2013 Vasiliy Ermolovich. See LICENSE.txt for
 further details.

data/ext/xxhash/libxxhash.c

@@ -31,13 +31,20 @@ You can contact the author at :
 */
 
 
-
 //**************************************
 // Tuning parameters
 //**************************************
+// Unaligned memory access is automatically enabled for "common" CPU, such as x86.
+// For others CPU, the compiler will be more cautious, and insert extra code to ensure aligned access is respected.
+// If you know your target CPU supports unaligned memory access, you want to force this option manually to improve performance.
+// You can also enable this parameter if you know your input data will always be aligned (boundaries of 4, for U32).
+#if defined(__ARM_FEATURE_UNALIGNED) || defined(__i386) || defined(_M_IX86) || defined(__x86_64__) || defined(_M_X64)
+#  define XXH_USE_UNALIGNED_ACCESS 1
+#endif
+
 // XXH_ACCEPT_NULL_INPUT_POINTER :
-// If the input pointer is a null pointer, xxHash default behavior is to crash, since it is a bad input.
-// If this option is enabled, xxHash output for null input pointers will be the same as a null-length input.
+// If the input pointer is a null pointer, xxHash default behavior is to trigger a memory access error, since it is a bad pointer.
+// When this option is enabled, xxHash output for null input pointers will be the same as a null-length input.
 // This option has a very small performance cost (only measurable on small inputs).
 // By default, this option is disabled. To enable it, uncomment below define :
 //#define XXH_ACCEPT_NULL_INPUT_POINTER 1
@@ -45,49 +52,44 @@ You can contact the author at :
 // XXH_FORCE_NATIVE_FORMAT :
 // By default, xxHash library provides endian-independant Hash values, based on little-endian convention.
 // Results are therefore identical for little-endian and big-endian CPU.
-// This comes at a  performance cost for big-endian CPU, since some swapping is required to emulate little-endian format.
-// Should endian-independance be of no importance to your application, you may uncomment the #define below
+// This comes at a performance cost for big-endian CPU, since some swapping is required to emulate little-endian format.
+// Should endian-independance be of no importance for your application, you may set the #define below to 1.
 // It will improve speed for Big-endian CPU.
 // This option has no impact on Little_Endian CPU.
-//#define XXH_FORCE_NATIVE_FORMAT 1
-
+#define XXH_FORCE_NATIVE_FORMAT 0
 
 
 //**************************************
-// Includes
+// Compiler Specific Options
 //**************************************
-#include <stdlib.h>    // for malloc(), free()
-#include <string.h>    // for memcpy()
-#include "libxxhash.h"
+// Disable some Visual warning messages
+#ifdef _MSC_VER  // Visual Studio
+#  pragma warning(disable : 4127)      // disable: C4127: conditional expression is constant
+#endif
 
+#ifdef _MSC_VER    // Visual Studio
+#  define forceinline static __forceinline
+#else
+#  ifdef __GNUC__
+#    define forceinline static inline __attribute__((always_inline))
+#  else
+#    define forceinline static inline
+#  endif
+#endif
 
 
 //**************************************
-// CPU Feature Detection
+// Includes & Memory related functions
 //**************************************
-// Little Endian or Big Endian ?
-// You can overwrite the #define below if you know your architecture endianess
-#if defined(XXH_FORCE_NATIVE_FORMAT) && (XXH_FORCE_NATIVE_FORMAT==1)
-// Force native format. The result will be endian dependant.
-#  define XXH_BIG_ENDIAN 0
-#elif defined (__GLIBC__)
-#  include <endian.h>
-#  if (__BYTE_ORDER == __BIG_ENDIAN)
-#     define XXH_BIG_ENDIAN 1
-#  endif
-#elif (defined(__BIG_ENDIAN__) || defined(__BIG_ENDIAN) || defined(_BIG_ENDIAN)) && !(defined(__LITTLE_ENDIAN__) || defined(__LITTLE_ENDIAN) || defined(_LITTLE_ENDIAN))
-#  define XXH_BIG_ENDIAN 1
-#elif defined(__sparc) || defined(__sparc__) \
-    || defined(__ppc__) || defined(_POWER) || defined(__powerpc__) || defined(_ARCH_PPC) || defined(__PPC__) || defined(__PPC) || defined(PPC) || defined(__powerpc__) || defined(__powerpc) || defined(powerpc) \
-    || defined(__hpux)  || defined(__hppa) \
-    || defined(_MIPSEB) || defined(__s390__)
-#  define XXH_BIG_ENDIAN 1
-#endif
-
-#if !defined(XXH_BIG_ENDIAN)
-// Little Endian assumed. PDP Endian and other very rare endian format are unsupported.
-#  define XXH_BIG_ENDIAN 0
-#endif
+#include "libxxhash.h"
+// Modify the local functions below should you wish to use some other memory related routines
+// for malloc(), free()
+#include <stdlib.h>
+forceinline void* XXH_malloc(size_t s) { return malloc(s); }
+forceinline void  XXH_free  (void* p)  { free(p); }
+// for memcpy()
+#include <string.h>
+forceinline void* XXH_memcpy(void* dest, const void* src, size_t size) { return memcpy(dest,src,size); }
 
 
 //**************************************
@@ -101,21 +103,43 @@ You can contact the author at :
   typedef  int32_t S32;
   typedef uint64_t U64;
 #else
-  typedef unsigned char       BYTE;
-  typedef unsigned short      U16;
-  typedef unsigned int        U32;
-  typedef   signed int        S32;
-  typedef unsigned long long  U64;
+  typedef unsigned char      BYTE;
+  typedef unsigned short     U16;
+  typedef unsigned int       U32;
+  typedef   signed int       S32;
+  typedef unsigned long long U64;
 #endif
 
+#if defined(__GNUC__)  && !defined(XXH_USE_UNALIGNED_ACCESS)
+#  define _PACKED __attribute__ ((packed))
+#else
+#  define _PACKED
+#endif
 
-//**************************************
-// Compiler-specific Options & Functions
-//**************************************
+#if !defined(XXH_USE_UNALIGNED_ACCESS) && !defined(__GNUC__)
+#  ifdef __IBMC__
+#    pragma pack(1)
+#  else
+#    pragma pack(push, 1)
+#  endif
+#endif
+
+typedef struct _U32_S { U32 v; } _PACKED U32_S;
+
+#if !defined(XXH_USE_UNALIGNED_ACCESS) && !defined(__GNUC__)
+#  pragma pack(pop)
+#endif
+
+#define A32(x) (((U32_S *)(x))->v)
+
+
+//***************************************
+// Compiler-specific Functions and Macros
+//***************************************
 #define GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__)
 
-// Note : under GCC, it may sometimes be faster to enable the (2nd) macro definition, instead of using win32 intrinsic
-#if defined(_WIN32)
+// Note : although _rotl exists for minGW (GCC under windows), performance seems poor
+#if defined(_MSC_VER)
 #  define XXH_rotl32(x,r) _rotl(x,r)
 #else
 #  define XXH_rotl32(x,r) ((x << r) | (x >> (32 - r)))
@@ -145,31 +169,48 @@ static inline U32 XXH_swap32 (U32 x) {
 
 
 //**************************************
-// Macros
+// Architecture Macros
 //**************************************
-#define XXH_LE32(p)  (XXH_BIG_ENDIAN ? XXH_swap32(*(U32*)(p)) : *(U32*)(p))
+typedef enum { XXH_bigEndian=0, XXH_littleEndian=1 } XXH_endianess;
+#ifndef XXH_CPU_LITTLE_ENDIAN   // It is possible to define XXH_CPU_LITTLE_ENDIAN externally, for example using a compiler switch
+    static const int one = 1;
+#   define XXH_CPU_LITTLE_ENDIAN   (*(char*)(&one))
+#endif
 
 
+//**************************************
+// Macros
+//**************************************
+#define XXH_STATIC_ASSERT(c)   { enum { XXH_static_assert = 1/(!!(c)) }; }    // use only *after* variable declarations
+
 
 //****************************
-// Simple Hash Functions
+// Memory reads
 //****************************
+typedef enum { XXH_aligned, XXH_unaligned } XXH_alignment;
 
-U32 XXH32(const void* input, int len, U32 seed)
+forceinline U32 XXH_readLE32_align(const U32* ptr, XXH_endianess endian, XXH_alignment align)
 {
-#if 0
-    // Simple version, good for code maintenance, but unfortunately slow for small inputs
-    void* state = XXH32_init(seed);
-    XXH32_update(state, input, len);
-    return XXH32_digest(state);
-#else
+    if (align==XXH_unaligned)
+        return endian==XXH_littleEndian ? A32(ptr) : XXH_swap32(A32(ptr));
+    else
+        return endian==XXH_littleEndian ? *ptr : XXH_swap32(*ptr);
+}
+
+forceinline U32 XXH_readLE32(const U32* ptr, XXH_endianess endian) { return XXH_readLE32_align(ptr, endian, XXH_unaligned); }
+
 
+//****************************
+// Simple Hash Functions
+//****************************
+forceinline U32 XXH32_endian_align(const void* input, int len, U32 seed, XXH_endianess endian, XXH_alignment align)
+{
     const BYTE* p = (const BYTE*)input;
     const BYTE* const bEnd = p + len;
     U32 h32;
 
 #ifdef XXH_ACCEPT_NULL_INPUT_POINTER
-    if (p==NULL) { len=0; p=(const BYTE*)16; }
+    if (p==NULL) { len=0; p=(const BYTE*)(size_t)16; }
 #endif
 
     if (len>=16)
@@ -182,10 +223,10 @@ U32 XXH32(const void* input, int len, U32 seed)
 
         do
         {
-            v1 += XXH_LE32(p) * PRIME32_2; v1 = XXH_rotl32(v1, 13); v1 *= PRIME32_1; p+=4;
-            v2 += XXH_LE32(p) * PRIME32_2; v2 = XXH_rotl32(v2, 13); v2 *= PRIME32_1; p+=4;
-            v3 += XXH_LE32(p) * PRIME32_2; v3 = XXH_rotl32(v3, 13); v3 *= PRIME32_1; p+=4;
-            v4 += XXH_LE32(p) * PRIME32_2; v4 = XXH_rotl32(v4, 13); v4 *= PRIME32_1; p+=4;
+            v1 += XXH_readLE32_align((const U32*)p, endian, align) * PRIME32_2; v1 = XXH_rotl32(v1, 13); v1 *= PRIME32_1; p+=4;
+            v2 += XXH_readLE32_align((const U32*)p, endian, align) * PRIME32_2; v2 = XXH_rotl32(v2, 13); v2 *= PRIME32_1; p+=4;
+            v3 += XXH_readLE32_align((const U32*)p, endian, align) * PRIME32_2; v3 = XXH_rotl32(v3, 13); v3 *= PRIME32_1; p+=4;
+            v4 += XXH_readLE32_align((const U32*)p, endian, align) * PRIME32_2; v4 = XXH_rotl32(v4, 13); v4 *= PRIME32_1; p+=4;
         } while (p<=limit);
 
         h32 = XXH_rotl32(v1, 1) + XXH_rotl32(v2, 7) + XXH_rotl32(v3, 12) + XXH_rotl32(v4, 18);
@@ -199,8 +240,8 @@ U32 XXH32(const void* input, int len, U32 seed)
 
     while (p<=bEnd-4)
     {
-        h32 += XXH_LE32(p) * PRIME32_3;
-        h32 = XXH_rotl32(h32, 17) * PRIME32_4 ;
+        h32 += XXH_readLE32_align((const U32*)p, endian, align) * PRIME32_3;
+        h32  = XXH_rotl32(h32, 17) * PRIME32_4 ;
         p+=4;
     }
 
@@ -218,7 +259,33 @@ U32 XXH32(const void* input, int len, U32 seed)
     h32 ^= h32 >> 16;
 
     return h32;
+}
+
+
+U32 XXH32(const void* input, int len, U32 seed)
+{
+#if 0
+    // Simple version, good for code maintenance, but unfortunately slow for small inputs
+    void* state = XXH32_init(seed);
+    XXH32_update(state, input, len);
+    return XXH32_digest(state);
+#else
+    XXH_endianess endian_detected = (XXH_endianess)XXH_CPU_LITTLE_ENDIAN;
 
+#  if !defined(XXH_USE_UNALIGNED_ACCESS)
+    if ((((size_t)input) & 3))   // Input is aligned, let's leverage the speed advantage
+    {
+        if ((endian_detected==XXH_littleEndian) || XXH_FORCE_NATIVE_FORMAT)
+            return XXH32_endian_align(input, len, seed, XXH_littleEndian, XXH_aligned);
+        else
+            return XXH32_endian_align(input, len, seed, XXH_bigEndian, XXH_aligned);
+    }
+#  endif
+
+    if ((endian_detected==XXH_littleEndian) || XXH_FORCE_NATIVE_FORMAT)
+        return XXH32_endian_align(input, len, seed, XXH_littleEndian, XXH_unaligned);
+    else
+        return XXH32_endian_align(input, len, seed, XXH_bigEndian, XXH_unaligned);
 #endif
 }
 
@@ -229,21 +296,25 @@ U32 XXH32(const void* input, int len, U32 seed)
 
 struct XXH_state32_t
 {
+    U64 total_len;
     U32 seed;
     U32 v1;
     U32 v2;
     U32 v3;
     U32 v4;
-    U64 total_len;
-    char memory[16];
     int memsize;
+    char memory[16];
 };
 
 
-int XXH32_sizeofState() { return sizeof(struct XXH_state32_t); }
+int XXH32_sizeofState()
+{
+    XXH_STATIC_ASSERT(XXH32_SIZEOFSTATE >= sizeof(struct XXH_state32_t));   // A compilation error here means XXH32_SIZEOFSTATE is not large enough
+    return sizeof(struct XXH_state32_t);
+}
 
 
-XXH_errorcode XXH32_resetState(void* state_in, unsigned int seed)
+XXH_errorcode XXH32_resetState(void* state_in, U32 seed)
 {
     struct XXH_state32_t * state = (struct XXH_state32_t *) state_in;
     state->seed = seed;
@@ -253,19 +324,19 @@ XXH_errorcode XXH32_resetState(void* state_in, unsigned int seed)
     state->v4 = seed - PRIME32_1;
     state->total_len = 0;
     state->memsize = 0;
-    return OK;
+    return XXH_OK;
 }
 
 
 void* XXH32_init (U32 seed)
 {
-    struct XXH_state32_t * state = (struct XXH_state32_t *) malloc (sizeof(struct XXH_state32_t));
+    void* state = XXH_malloc (sizeof(struct XXH_state32_t));
     XXH32_resetState(state, seed);
-    return (void*)state;
+    return state;
 }
 
 
-XXH_errorcode XXH32_update (void* state_in, const void* input, int len)
+forceinline XXH_errorcode XXH32_update_endian (void* state_in, const void* input, int len, XXH_endianess endian)
 {
     struct XXH_state32_t * state = (struct XXH_state32_t *) state_in;
     const BYTE* p = (const BYTE*)input;
@@ -279,20 +350,20 @@ XXH_errorcode XXH32_update (void* state_in, const void* input, int len)
 
     if (state->memsize + len < 16)   // fill in tmp buffer
     {
-        memcpy(state->memory + state->memsize, input, len);
+        XXH_memcpy(state->memory + state->memsize, input, len);
         state->memsize +=  len;
-        return OK;
+        return XXH_OK;
     }
 
     if (state->memsize)   // some data left from previous update
     {
-        memcpy(state->memory + state->memsize, input, 16-state->memsize);
+        XXH_memcpy(state->memory + state->memsize, input, 16-state->memsize);
         {
             const U32* p32 = (const U32*)state->memory;
-            state->v1 += XXH_LE32(p32) * PRIME32_2; state->v1 = XXH_rotl32(state->v1, 13); state->v1 *= PRIME32_1; p32++;
-            state->v2 += XXH_LE32(p32) * PRIME32_2; state->v2 = XXH_rotl32(state->v2, 13); state->v2 *= PRIME32_1; p32++;
-            state->v3 += XXH_LE32(p32) * PRIME32_2; state->v3 = XXH_rotl32(state->v3, 13); state->v3 *= PRIME32_1; p32++;
-            state->v4 += XXH_LE32(p32) * PRIME32_2; state->v4 = XXH_rotl32(state->v4, 13); state->v4 *= PRIME32_1; p32++;
+            state->v1 += XXH_readLE32(p32, endian) * PRIME32_2; state->v1 = XXH_rotl32(state->v1, 13); state->v1 *= PRIME32_1; p32++;
+            state->v2 += XXH_readLE32(p32, endian) * PRIME32_2; state->v2 = XXH_rotl32(state->v2, 13); state->v2 *= PRIME32_1; p32++;
+            state->v3 += XXH_readLE32(p32, endian) * PRIME32_2; state->v3 = XXH_rotl32(state->v3, 13); state->v3 *= PRIME32_1; p32++;
+            state->v4 += XXH_readLE32(p32, endian) * PRIME32_2; state->v4 = XXH_rotl32(state->v4, 13); state->v4 *= PRIME32_1; p32++;
         }
         p += 16-state->memsize;
         state->memsize = 0;
@@ -308,10 +379,10 @@ XXH_errorcode XXH32_update (void* state_in, const void* input, int len)
 
         do
         {
-            v1 += XXH_LE32(p) * PRIME32_2; v1 = XXH_rotl32(v1, 13); v1 *= PRIME32_1; p+=4;
-            v2 += XXH_LE32(p) * PRIME32_2; v2 = XXH_rotl32(v2, 13); v2 *= PRIME32_1; p+=4;
-            v3 += XXH_LE32(p) * PRIME32_2; v3 = XXH_rotl32(v3, 13); v3 *= PRIME32_1; p+=4;
-            v4 += XXH_LE32(p) * PRIME32_2; v4 = XXH_rotl32(v4, 13); v4 *= PRIME32_1; p+=4;
+            v1 += XXH_readLE32((const U32*)p, endian) * PRIME32_2; v1 = XXH_rotl32(v1, 13); v1 *= PRIME32_1; p+=4;
+            v2 += XXH_readLE32((const U32*)p, endian) * PRIME32_2; v2 = XXH_rotl32(v2, 13); v2 *= PRIME32_1; p+=4;
+            v3 += XXH_readLE32((const U32*)p, endian) * PRIME32_2; v3 = XXH_rotl32(v3, 13); v3 *= PRIME32_1; p+=4;
+            v4 += XXH_readLE32((const U32*)p, endian) * PRIME32_2; v4 = XXH_rotl32(v4, 13); v4 *= PRIME32_1; p+=4;
         } while (p<=limit);
 
         state->v1 = v1;
@@ -322,22 +393,32 @@ XXH_errorcode XXH32_update (void* state_in, const void* input, int len)
 
     if (p < bEnd)
     {
-        memcpy(state->memory, p, bEnd-p);
+        XXH_memcpy(state->memory, p, bEnd-p);
         state->memsize = (int)(bEnd-p);
     }
 
-    return OK;
+    return XXH_OK;
 }
 
+XXH_errorcode XXH32_update (void* state_in, const void* input, int len)
+{
+    XXH_endianess endian_detected = (XXH_endianess)XXH_CPU_LITTLE_ENDIAN;
 
-U32 XXH32_intermediateDigest (void* state_in)
+    if ((endian_detected==XXH_littleEndian) || XXH_FORCE_NATIVE_FORMAT)
+        return XXH32_update_endian(state_in, input, len, XXH_littleEndian);
+    else
+        return XXH32_update_endian(state_in, input, len, XXH_bigEndian);
+}
+
+
+
+forceinline U32 XXH32_intermediateDigest_endian (void* state_in, XXH_endianess endian)
 {
     struct XXH_state32_t * state = (struct XXH_state32_t *) state_in;
-    BYTE * p   = (BYTE*)state->memory;
+    const BYTE * p = (const BYTE*)state->memory;
     BYTE* bEnd = (BYTE*)state->memory + state->memsize;
     U32 h32;
 
-
     if (state->total_len >= 16)
     {
         h32 = XXH_rotl32(state->v1, 1) + XXH_rotl32(state->v2, 7) + XXH_rotl32(state->v3, 12) + XXH_rotl32(state->v4, 18);
@@ -351,8 +432,8 @@ U32 XXH32_intermediateDigest (void* state_in)
 
     while (p<=bEnd-4)
     {
-        h32 += XXH_LE32(p) * PRIME32_3;
-        h32 = XXH_rotl32(h32, 17) * PRIME32_4;
+        h32 += XXH_readLE32((const U32*)p, endian) * PRIME32_3;
+        h32  = XXH_rotl32(h32, 17) * PRIME32_4;
         p+=4;
     }
 
@@ -373,11 +454,22 @@ U32 XXH32_intermediateDigest (void* state_in)
 }
 
 
+U32 XXH32_intermediateDigest (void* state_in)
+{
+    XXH_endianess endian_detected = (XXH_endianess)XXH_CPU_LITTLE_ENDIAN;
+
+    if ((endian_detected==XXH_littleEndian) || XXH_FORCE_NATIVE_FORMAT)
+        return XXH32_intermediateDigest_endian(state_in, XXH_littleEndian);
+    else
+        return XXH32_intermediateDigest_endian(state_in, XXH_bigEndian);
+}
+
+
 U32 XXH32_digest (void* state_in)
 {
     U32 h32 = XXH32_intermediateDigest(state_in);
 
-    free(state_in);
+    XXH_free(state_in);
 
     return h32;
 }

data/ext/xxhash/libxxhash.h

@@ -27,8 +27,8 @@
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-  You can contact the author at :
-  - xxHash source repository : http://code.google.com/p/xxhash/
+   You can contact the author at :
+   - xxHash source repository : http://code.google.com/p/xxhash/
 */
 
 /* Notice extracted from xxHash homepage :
@@ -67,7 +67,7 @@ extern "C" {
 //****************************
 // Type
 //****************************
-typedef enum { OK=0, XXH_ERROR } XXH_errorcode;
+typedef enum { XXH_OK=0, XXH_ERROR } XXH_errorcode;
 
 
 
@@ -79,13 +79,13 @@ unsigned int XXH32 (const void* input, int len, unsigned int seed);
 
 /*
 XXH32() :
-  Calculate the 32-bits hash of sequence of length "len" stored at memory address "input".
+    Calculate the 32-bits hash of sequence of length "len" stored at memory address "input".
     The memory between input & input+len must be valid (allocated and read-accessible).
-  "seed" can be used to alter the result predictably.
-  This function successfully passes all SMHasher tests.
-  Speed on Core 2 Duo @ 3 GHz (single thread, SMHasher benchmark) : 5.4 GB/s
-  Note that "len" is type "int", which means it is limited to 2^31-1.
-  If your data is larger, use the advanced functions below.
+    "seed" can be used to alter the result predictably.
+    This function successfully passes all SMHasher tests.
+    Speed on Core 2 Duo @ 3 GHz (single thread, SMHasher benchmark) : 5.4 GB/s
+    Note that "len" is type "int", which means it is limited to 2^31-1.
+    If your data is larger, use the advanced functions below.
 */
 
 
@@ -122,14 +122,19 @@ Memory will be freed by XXH32_digest().
 
 
 int           XXH32_sizeofState();
-XXH_errorcode XXH32_resetState(void* state_in, unsigned int seed);
+XXH_errorcode XXH32_resetState(void* state, unsigned int seed);
+
+#define       XXH32_SIZEOFSTATE 48
+typedef struct { long long ll[(XXH32_SIZEOFSTATE+(sizeof(long long)-1))/sizeof(long long)]; } XXH32_stateSpace_t;
 /*
-These functions are the basic elements of XXH32_init();
-The objective is to allow user application to make its own allocation.
+These functions allow user application to make its own allocation for state.
+
+XXH32_sizeofState() is used to know how much space must be allocated for the xxHash 32-bits state.
+Note that the state must be aligned to access 'long long' fields. Memory must be allocated and referenced by a pointer.
+This pointer must then be provided as 'state' into XXH32_resetState(), which initializes the state.
 
-XXH32_sizeofState() is used to know how much space must be allocated by the application.
-This space must be referenced by a void* pointer.
-This pointer must be provided as 'state_in' into XXH32_resetState(), which initializes the state.
+For static allocation purposes (such as allocation on stack, or freestanding systems without malloc()),
+use the structure XXH32_stateSpace_t, which will ensure that memory space is large enough and correctly aligned to access 'long long' fields.
 */
 
 
@@ -138,7 +143,7 @@ unsigned int XXH32_intermediateDigest (void* state);
 This function does the same as XXH32_digest(), generating a 32-bit hash,
 but preserve memory context.
 This way, it becomes possible to generate intermediate hashes, and then continue feeding data with XXH32_update().
-To free memory context, use XXH32_digest().
+To free memory context, use XXH32_digest(), or free().
 */
 
 

data/ext/xxhash/xxhash.cc

@@ -10,10 +10,47 @@ extern "C" VALUE xxhash_xxh32(VALUE mod, VALUE input, VALUE seed)
   return ULL2NUM(XXH32(StringValuePtr(input), RSTRING_LEN(input), NUM2ULL(seed)));
 }
 
+extern "C" void xxhash_streaming_hash_free(void* state)
+{
+  // Digest frees the memory.
+  (void) XXH32_digest(state);
+}
+
+extern "C" VALUE xxhash_streaming_hash_new(VALUE klass, VALUE seed)
+{
+  void* state = XXH32_init(NUM2ULL(seed));
+  return Data_Wrap_Struct(klass, 0, xxhash_streaming_hash_free, state);
+}
+
+extern "C" VALUE xxhash_streaming_hash_update(VALUE self, VALUE data)
+{
+  void* state;
+  Data_Get_Struct(self, void, state);
+
+  XXH32_update(state, StringValuePtr(data), RSTRING_LEN(data));
+  return Qnil;
+}
+
+extern "C" VALUE xxhash_streaming_hash_digest(VALUE self)
+{
+  void* state;
+  Data_Get_Struct(self, void, state);
+
+  // Do not free memory now.
+  return ULL2NUM(XXH32_intermediateDigest(state));
+}
+
 extern "C" void Init_xxhash()
 {
   VALUE mXXhash = rb_define_module("XXhash");
   VALUE mInternal = rb_define_module_under(mXXhash, "Internal");
 
   rb_define_singleton_method(mInternal, "xxh32", (ruby_method*) &xxhash_xxh32, 2);
+
+  VALUE cStreamingHash = rb_define_class_under(mInternal, "StreamingHash", rb_cObject);
+
+  rb_define_singleton_method(cStreamingHash, "new", (ruby_method*) &xxhash_streaming_hash_new, 1);
+  rb_define_method(cStreamingHash, "update", (ruby_method*) &xxhash_streaming_hash_update, 1);
+  rb_define_method(cStreamingHash, "digest", (ruby_method*) &xxhash_streaming_hash_digest, 0);
+  rb_define_method(cStreamingHash, "intermediate_digest", (ruby_method*) &xxhash_streaming_hash_digest, 0);
 }

data/lib/xxhash.rb

@@ -5,4 +5,16 @@ module XXhash
   def self.xxh32(input, seed)
     Internal.xxh32(input, seed)
   end
+
+  def self.xxh32_stream(io, seed, chunk_size = 32)
+    raise ArgumentError, 'first argument should be IO' if !io.is_a?(IO) && !io.is_a?(StringIO)
+
+    hash = Internal::StreamingHash.new(seed)
+
+    while chunk = io.read(chunk_size)
+      hash.update(chunk)
+    end
+
+    hash.digest
+  end
 end

data/lib/xxhash/version.rb

@@ -1,3 +1,3 @@
 module XXhash
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/xxhash_test.rb

@@ -1,7 +1,26 @@
 require 'test_helper'
+require 'stringio'
 
 describe XXhash do
   it 'returns hash' do
     assert_equal 2758658570, XXhash.xxh32('test', 123)
   end
+
+  describe 'StreamingHash' do
+    it 'rises ArgumentError if forst argument is not IO object' do
+      assert_raises(ArgumentError) do
+        XXhash.xxh32_stream('test', 123)
+      end
+    end
+
+    it 'returns the hash for streamed strings' do
+      assert_equal 2758658570, XXhash.xxh32_stream(StringIO.new('test'), 123)
+    end
+
+    it 'returns the hash for streamed files' do
+      h1 = XXhash.xxh32(File.read(__FILE__), 123)
+      h2 = XXhash.xxh32_stream(File.open(__FILE__), 123)
+      assert_equal h1, h2
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xxhash
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-04 00:00:00.000000000 Z
+date: 2013-09-04 00:00:00.000000000 Z
 dependencies: []
 description: Ruby wrapper for xxHash lib
 email:
@@ -21,7 +21,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -49,7 +49,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2669924421598786933
+      hash: -3728750430932162062
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2669924421598786933
+      hash: -3728750430932162062
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/CHANGELOG

@@ -1,5 +0,0 @@
-### 0.1.1 (June 4, 2013)
-  * remove .bundle from gem
-
-### 0.1.0 (May 16, 2013)
-  * xxHash updated to [r29](https://code.google.com/p/xxhash/source/detail?r=28)