modules: update documentation examples so they compile under ccanlint.
[ccan] / ccan / hash / hash.c
1 /*
2 -------------------------------------------------------------------------------
3 lookup3.c, by Bob Jenkins, May 2006, Public Domain.
4
5 These are functions for producing 32-bit hashes for hash table lookup.
6 hash_word(), hashlittle(), hashlittle2(), hashbig(), mix(), and final() 
7 are externally useful functions.  Routines to test the hash are included 
8 if SELF_TEST is defined.  You can use this free for any purpose.  It's in
9 the public domain.  It has no warranty.
10
11 You probably want to use hashlittle().  hashlittle() and hashbig()
12 hash byte arrays.  hashlittle() is is faster than hashbig() on
13 little-endian machines.  Intel and AMD are little-endian machines.
14 On second thought, you probably want hashlittle2(), which is identical to
15 hashlittle() except it returns two 32-bit hashes for the price of one.  
16 You could implement hashbig2() if you wanted but I haven't bothered here.
17
18 If you want to find a hash of, say, exactly 7 integers, do
19   a = i1;  b = i2;  c = i3;
20   mix(a,b,c);
21   a += i4; b += i5; c += i6;
22   mix(a,b,c);
23   a += i7;
24   final(a,b,c);
25 then use c as the hash value.  If you have a variable length array of
26 4-byte integers to hash, use hash_word().  If you have a byte array (like
27 a character string), use hashlittle().  If you have several byte arrays, or
28 a mix of things, see the comments above hashlittle().  
29
30 Why is this so big?  I read 12 bytes at a time into 3 4-byte integers, 
31 then mix those integers.  This is fast (you can do a lot more thorough
32 mixing with 12*3 instructions on 3 integers than you can with 3 instructions
33 on 1 byte), but shoehorning those bytes into integers efficiently is messy.
34 -------------------------------------------------------------------------------
35 */
36 //#define SELF_TEST 1
37
38 #if 0
39 #include <stdio.h>      /* defines printf for tests */
40 #include <time.h>       /* defines time_t for timings in the test */
41 #include <stdint.h>     /* defines uint32_t etc */
42 #include <sys/param.h>  /* attempt to define endianness */
43 #endif
44
45 #include "hash.h"
46 #ifdef linux
47 # include <endian.h>    /* attempt to define endianness */
48 #endif
49
50 /*
51  * My best guess at if you are big-endian or little-endian.  This may
52  * need adjustment.
53  */
54 #if (defined(__BYTE_ORDER) && defined(__LITTLE_ENDIAN) && \
55      __BYTE_ORDER == __LITTLE_ENDIAN) || \
56     (defined(i386) || defined(__i386__) || defined(__i486__) || \
57      defined(__i586__) || defined(__i686__) || defined(vax) || defined(MIPSEL))
58 # define HASH_LITTLE_ENDIAN 1
59 # define HASH_BIG_ENDIAN 0
60 #elif (defined(__BYTE_ORDER) && defined(__BIG_ENDIAN) && \
61        __BYTE_ORDER == __BIG_ENDIAN) || \
62       (defined(sparc) || defined(POWERPC) || defined(mc68000) || defined(sel))
63 # define HASH_LITTLE_ENDIAN 0
64 # define HASH_BIG_ENDIAN 1
65 #else
66 # error Unknown endian
67 #endif
68
69 #define hashsize(n) ((uint32_t)1<<(n))
70 #define hashmask(n) (hashsize(n)-1)
71 #define rot(x,k) (((x)<<(k)) | ((x)>>(32-(k))))
72
73 /*
74 -------------------------------------------------------------------------------
75 mix -- mix 3 32-bit values reversibly.
76
77 This is reversible, so any information in (a,b,c) before mix() is
78 still in (a,b,c) after mix().
79
80 If four pairs of (a,b,c) inputs are run through mix(), or through
81 mix() in reverse, there are at least 32 bits of the output that
82 are sometimes the same for one pair and different for another pair.
83 This was tested for:
84 * pairs that differed by one bit, by two bits, in any combination
85   of top bits of (a,b,c), or in any combination of bottom bits of
86   (a,b,c).
87 * "differ" is defined as +, -, ^, or ~^.  For + and -, I transformed
88   the output delta to a Gray code (a^(a>>1)) so a string of 1's (as
89   is commonly produced by subtraction) look like a single 1-bit
90   difference.
91 * the base values were pseudorandom, all zero but one bit set, or 
92   all zero plus a counter that starts at zero.
93
94 Some k values for my "a-=c; a^=rot(c,k); c+=b;" arrangement that
95 satisfy this are
96     4  6  8 16 19  4
97     9 15  3 18 27 15
98    14  9  3  7 17  3
99 Well, "9 15 3 18 27 15" didn't quite get 32 bits diffing
100 for "differ" defined as + with a one-bit base and a two-bit delta.  I
101 used http://burtleburtle.net/bob/hash/avalanche.html to choose 
102 the operations, constants, and arrangements of the variables.
103
104 This does not achieve avalanche.  There are input bits of (a,b,c)
105 that fail to affect some output bits of (a,b,c), especially of a.  The
106 most thoroughly mixed value is c, but it doesn't really even achieve
107 avalanche in c.
108
109 This allows some parallelism.  Read-after-writes are good at doubling
110 the number of bits affected, so the goal of mixing pulls in the opposite
111 direction as the goal of parallelism.  I did what I could.  Rotates
112 seem to cost as much as shifts on every machine I could lay my hands
113 on, and rotates are much kinder to the top and bottom bits, so I used
114 rotates.
115 -------------------------------------------------------------------------------
116 */
117 #define mix(a,b,c) \
118 { \
119   a -= c;  a ^= rot(c, 4);  c += b; \
120   b -= a;  b ^= rot(a, 6);  a += c; \
121   c -= b;  c ^= rot(b, 8);  b += a; \
122   a -= c;  a ^= rot(c,16);  c += b; \
123   b -= a;  b ^= rot(a,19);  a += c; \
124   c -= b;  c ^= rot(b, 4);  b += a; \
125 }
126
127 /*
128 -------------------------------------------------------------------------------
129 final -- final mixing of 3 32-bit values (a,b,c) into c
130
131 Pairs of (a,b,c) values differing in only a few bits will usually
132 produce values of c that look totally different.  This was tested for
133 * pairs that differed by one bit, by two bits, in any combination
134   of top bits of (a,b,c), or in any combination of bottom bits of
135   (a,b,c).
136 * "differ" is defined as +, -, ^, or ~^.  For + and -, I transformed
137   the output delta to a Gray code (a^(a>>1)) so a string of 1's (as
138   is commonly produced by subtraction) look like a single 1-bit
139   difference.
140 * the base values were pseudorandom, all zero but one bit set, or 
141   all zero plus a counter that starts at zero.
142
143 These constants passed:
144  14 11 25 16 4 14 24
145  12 14 25 16 4 14 24
146 and these came close:
147   4  8 15 26 3 22 24
148  10  8 15 26 3 22 24
149  11  8 15 26 3 22 24
150 -------------------------------------------------------------------------------
151 */
152 #define final(a,b,c) \
153 { \
154   c ^= b; c -= rot(b,14); \
155   a ^= c; a -= rot(c,11); \
156   b ^= a; b -= rot(a,25); \
157   c ^= b; c -= rot(b,16); \
158   a ^= c; a -= rot(c,4);  \
159   b ^= a; b -= rot(a,14); \
160   c ^= b; c -= rot(b,24); \
161 }
162
163 /*
164 --------------------------------------------------------------------
165  This works on all machines.  To be useful, it requires
166  -- that the key be an array of uint32_t's, and
167  -- that the length be the number of uint32_t's in the key
168
169  The function hash_word() is identical to hashlittle() on little-endian
170  machines, and identical to hashbig() on big-endian machines,
171  except that the length has to be measured in uint32_ts rather than in
172  bytes.  hashlittle() is more complicated than hash_word() only because
173  hashlittle() has to dance around fitting the key bytes into registers.
174 --------------------------------------------------------------------
175 */
176 uint32_t hash_u32(
177 const uint32_t *k,                   /* the key, an array of uint32_t values */
178 size_t          length,               /* the length of the key, in uint32_ts */
179 uint32_t        initval)         /* the previous hash, or an arbitrary value */
180 {
181   uint32_t a,b,c;
182
183   /* Set up the internal state */
184   a = b = c = 0xdeadbeef + (((uint32_t)length)<<2) + initval;
185
186   /*------------------------------------------------- handle most of the key */
187   while (length > 3)
188   {
189     a += k[0];
190     b += k[1];
191     c += k[2];
192     mix(a,b,c);
193     length -= 3;
194     k += 3;
195   }
196
197   /*------------------------------------------- handle the last 3 uint32_t's */
198   switch(length)                     /* all the case statements fall through */
199   { 
200   case 3 : c+=k[2];
201   case 2 : b+=k[1];
202   case 1 : a+=k[0];
203     final(a,b,c);
204   case 0:     /* case 0: nothing left to add */
205     break;
206   }
207   /*------------------------------------------------------ report the result */
208   return c;
209 }
210
211 /*
212 -------------------------------------------------------------------------------
213 hashlittle() -- hash a variable-length key into a 32-bit value
214   k       : the key (the unaligned variable-length array of bytes)
215   length  : the length of the key, counting by bytes
216   val2    : IN: can be any 4-byte value OUT: second 32 bit hash.
217 Returns a 32-bit value.  Every bit of the key affects every bit of
218 the return value.  Two keys differing by one or two bits will have
219 totally different hash values.  Note that the return value is better
220 mixed than val2, so use that first.
221
222 The best hash table sizes are powers of 2.  There is no need to do
223 mod a prime (mod is sooo slow!).  If you need less than 32 bits,
224 use a bitmask.  For example, if you need only 10 bits, do
225   h = (h & hashmask(10));
226 In which case, the hash table should have hashsize(10) elements.
227
228 If you are hashing n strings (uint8_t **)k, do it like this:
229   for (i=0, h=0; i<n; ++i) h = hashlittle( k[i], len[i], h);
230
231 By Bob Jenkins, 2006.  bob_jenkins@burtleburtle.net.  You may use this
232 code any way you wish, private, educational, or commercial.  It's free.
233
234 Use for hash table lookup, or anything where one collision in 2^^32 is
235 acceptable.  Do NOT use for cryptographic purposes.
236 -------------------------------------------------------------------------------
237 */
238
239 static uint32_t hashlittle( const void *key, size_t length, uint32_t *val2 )
240 {
241   uint32_t a,b,c;                                          /* internal state */
242   union { const void *ptr; size_t i; } u;     /* needed for Mac Powerbook G4 */
243
244   /* Set up the internal state */
245   a = b = c = 0xdeadbeef + ((uint32_t)length) + *val2;
246
247   u.ptr = key;
248   if (HASH_LITTLE_ENDIAN && ((u.i & 0x3) == 0)) {
249     const uint32_t *k = (const uint32_t *)key;         /* read 32-bit chunks */
250 #ifdef VALGRIND
251     const uint8_t  *k8;
252 #endif
253
254     /*------ all but last block: aligned reads and affect 32 bits of (a,b,c) */
255     while (length > 12)
256     {
257       a += k[0];
258       b += k[1];
259       c += k[2];
260       mix(a,b,c);
261       length -= 12;
262       k += 3;
263     }
264
265     /*----------------------------- handle the last (probably partial) block */
266     /* 
267      * "k[2]&0xffffff" actually reads beyond the end of the string, but
268      * then masks off the part it's not allowed to read.  Because the
269      * string is aligned, the masked-off tail is in the same word as the
270      * rest of the string.  Every machine with memory protection I've seen
271      * does it on word boundaries, so is OK with this.  But VALGRIND will
272      * still catch it and complain.  The masking trick does make the hash
273      * noticably faster for short strings (like English words).
274      */
275 #ifndef VALGRIND
276
277     switch(length)
278     {
279     case 12: c+=k[2]; b+=k[1]; a+=k[0]; break;
280     case 11: c+=k[2]&0xffffff; b+=k[1]; a+=k[0]; break;
281     case 10: c+=k[2]&0xffff; b+=k[1]; a+=k[0]; break;
282     case 9 : c+=k[2]&0xff; b+=k[1]; a+=k[0]; break;
283     case 8 : b+=k[1]; a+=k[0]; break;
284     case 7 : b+=k[1]&0xffffff; a+=k[0]; break;
285     case 6 : b+=k[1]&0xffff; a+=k[0]; break;
286     case 5 : b+=k[1]&0xff; a+=k[0]; break;
287     case 4 : a+=k[0]; break;
288     case 3 : a+=k[0]&0xffffff; break;
289     case 2 : a+=k[0]&0xffff; break;
290     case 1 : a+=k[0]&0xff; break;
291     case 0 : return c;              /* zero length strings require no mixing */
292     }
293
294 #else /* make valgrind happy */
295
296     k8 = (const uint8_t *)k;
297     switch(length)
298     {
299     case 12: c+=k[2]; b+=k[1]; a+=k[0]; break;
300     case 11: c+=((uint32_t)k8[10])<<16;  /* fall through */
301     case 10: c+=((uint32_t)k8[9])<<8;    /* fall through */
302     case 9 : c+=k8[8];                   /* fall through */
303     case 8 : b+=k[1]; a+=k[0]; break;
304     case 7 : b+=((uint32_t)k8[6])<<16;   /* fall through */
305     case 6 : b+=((uint32_t)k8[5])<<8;    /* fall through */
306     case 5 : b+=k8[4];                   /* fall through */
307     case 4 : a+=k[0]; break;
308     case 3 : a+=((uint32_t)k8[2])<<16;   /* fall through */
309     case 2 : a+=((uint32_t)k8[1])<<8;    /* fall through */
310     case 1 : a+=k8[0]; break;
311     case 0 : return c;
312     }
313
314 #endif /* !valgrind */
315
316   } else if (HASH_LITTLE_ENDIAN && ((u.i & 0x1) == 0)) {
317     const uint16_t *k = (const uint16_t *)key;         /* read 16-bit chunks */
318     const uint8_t  *k8;
319
320     /*--------------- all but last block: aligned reads and different mixing */
321     while (length > 12)
322     {
323       a += k[0] + (((uint32_t)k[1])<<16);
324       b += k[2] + (((uint32_t)k[3])<<16);
325       c += k[4] + (((uint32_t)k[5])<<16);
326       mix(a,b,c);
327       length -= 12;
328       k += 6;
329     }
330
331     /*----------------------------- handle the last (probably partial) block */
332     k8 = (const uint8_t *)k;
333     switch(length)
334     {
335     case 12: c+=k[4]+(((uint32_t)k[5])<<16);
336              b+=k[2]+(((uint32_t)k[3])<<16);
337              a+=k[0]+(((uint32_t)k[1])<<16);
338              break;
339     case 11: c+=((uint32_t)k8[10])<<16;     /* fall through */
340     case 10: c+=k[4];
341              b+=k[2]+(((uint32_t)k[3])<<16);
342              a+=k[0]+(((uint32_t)k[1])<<16);
343              break;
344     case 9 : c+=k8[8];                      /* fall through */
345     case 8 : b+=k[2]+(((uint32_t)k[3])<<16);
346              a+=k[0]+(((uint32_t)k[1])<<16);
347              break;
348     case 7 : b+=((uint32_t)k8[6])<<16;      /* fall through */
349     case 6 : b+=k[2];
350              a+=k[0]+(((uint32_t)k[1])<<16);
351              break;
352     case 5 : b+=k8[4];                      /* fall through */
353     case 4 : a+=k[0]+(((uint32_t)k[1])<<16);
354              break;
355     case 3 : a+=((uint32_t)k8[2])<<16;      /* fall through */
356     case 2 : a+=k[0];
357              break;
358     case 1 : a+=k8[0];
359              break;
360     case 0 : return c;                     /* zero length requires no mixing */
361     }
362
363   } else {                        /* need to read the key one byte at a time */
364     const uint8_t *k = (const uint8_t *)key;
365
366     /*--------------- all but the last block: affect some 32 bits of (a,b,c) */
367     while (length > 12)
368     {
369       a += k[0];
370       a += ((uint32_t)k[1])<<8;
371       a += ((uint32_t)k[2])<<16;
372       a += ((uint32_t)k[3])<<24;
373       b += k[4];
374       b += ((uint32_t)k[5])<<8;
375       b += ((uint32_t)k[6])<<16;
376       b += ((uint32_t)k[7])<<24;
377       c += k[8];
378       c += ((uint32_t)k[9])<<8;
379       c += ((uint32_t)k[10])<<16;
380       c += ((uint32_t)k[11])<<24;
381       mix(a,b,c);
382       length -= 12;
383       k += 12;
384     }
385
386     /*-------------------------------- last block: affect all 32 bits of (c) */
387     switch(length)                   /* all the case statements fall through */
388     {
389     case 12: c+=((uint32_t)k[11])<<24;
390     case 11: c+=((uint32_t)k[10])<<16;
391     case 10: c+=((uint32_t)k[9])<<8;
392     case 9 : c+=k[8];
393     case 8 : b+=((uint32_t)k[7])<<24;
394     case 7 : b+=((uint32_t)k[6])<<16;
395     case 6 : b+=((uint32_t)k[5])<<8;
396     case 5 : b+=k[4];
397     case 4 : a+=((uint32_t)k[3])<<24;
398     case 3 : a+=((uint32_t)k[2])<<16;
399     case 2 : a+=((uint32_t)k[1])<<8;
400     case 1 : a+=k[0];
401              break;
402     case 0 : return c;
403     }
404   }
405
406   final(a,b,c);
407   *val2 = b;
408   return c;
409 }
410
411 /*
412  * hashbig():
413  * This is the same as hash_word() on big-endian machines.  It is different
414  * from hashlittle() on all machines.  hashbig() takes advantage of
415  * big-endian byte ordering. 
416  */
417 static uint32_t hashbig( const void *key, size_t length, uint32_t *val2)
418 {
419   uint32_t a,b,c;
420   union { const void *ptr; size_t i; } u; /* to cast key to (size_t) happily */
421
422   /* Set up the internal state */
423   a = b = c = 0xdeadbeef + ((uint32_t)length) + *val2;
424
425   u.ptr = key;
426   if (HASH_BIG_ENDIAN && ((u.i & 0x3) == 0)) {
427     const uint32_t *k = (const uint32_t *)key;         /* read 32-bit chunks */
428 #ifdef VALGRIND
429     const uint8_t  *k8;
430 #endif
431
432     /*------ all but last block: aligned reads and affect 32 bits of (a,b,c) */
433     while (length > 12)
434     {
435       a += k[0];
436       b += k[1];
437       c += k[2];
438       mix(a,b,c);
439       length -= 12;
440       k += 3;
441     }
442
443     /*----------------------------- handle the last (probably partial) block */
444     /* 
445      * "k[2]<<8" actually reads beyond the end of the string, but
446      * then shifts out the part it's not allowed to read.  Because the
447      * string is aligned, the illegal read is in the same word as the
448      * rest of the string.  Every machine with memory protection I've seen
449      * does it on word boundaries, so is OK with this.  But VALGRIND will
450      * still catch it and complain.  The masking trick does make the hash
451      * noticably faster for short strings (like English words).
452      */
453 #ifndef VALGRIND
454
455     switch(length)
456     {
457     case 12: c+=k[2]; b+=k[1]; a+=k[0]; break;
458     case 11: c+=k[2]&0xffffff00; b+=k[1]; a+=k[0]; break;
459     case 10: c+=k[2]&0xffff0000; b+=k[1]; a+=k[0]; break;
460     case 9 : c+=k[2]&0xff000000; b+=k[1]; a+=k[0]; break;
461     case 8 : b+=k[1]; a+=k[0]; break;
462     case 7 : b+=k[1]&0xffffff00; a+=k[0]; break;
463     case 6 : b+=k[1]&0xffff0000; a+=k[0]; break;
464     case 5 : b+=k[1]&0xff000000; a+=k[0]; break;
465     case 4 : a+=k[0]; break;
466     case 3 : a+=k[0]&0xffffff00; break;
467     case 2 : a+=k[0]&0xffff0000; break;
468     case 1 : a+=k[0]&0xff000000; break;
469     case 0 : return c;              /* zero length strings require no mixing */
470     }
471
472 #else  /* make valgrind happy */
473
474     k8 = (const uint8_t *)k;
475     switch(length)                   /* all the case statements fall through */
476     {
477     case 12: c+=k[2]; b+=k[1]; a+=k[0]; break;
478     case 11: c+=((uint32_t)k8[10])<<8;  /* fall through */
479     case 10: c+=((uint32_t)k8[9])<<16;  /* fall through */
480     case 9 : c+=((uint32_t)k8[8])<<24;  /* fall through */
481     case 8 : b+=k[1]; a+=k[0]; break;
482     case 7 : b+=((uint32_t)k8[6])<<8;   /* fall through */
483     case 6 : b+=((uint32_t)k8[5])<<16;  /* fall through */
484     case 5 : b+=((uint32_t)k8[4])<<24;  /* fall through */
485     case 4 : a+=k[0]; break;
486     case 3 : a+=((uint32_t)k8[2])<<8;   /* fall through */
487     case 2 : a+=((uint32_t)k8[1])<<16;  /* fall through */
488     case 1 : a+=((uint32_t)k8[0])<<24; break;
489     case 0 : return c;
490     }
491
492 #endif /* !VALGRIND */
493
494   } else {                        /* need to read the key one byte at a time */
495     const uint8_t *k = (const uint8_t *)key;
496
497     /*--------------- all but the last block: affect some 32 bits of (a,b,c) */
498     while (length > 12)
499     {
500       a += ((uint32_t)k[0])<<24;
501       a += ((uint32_t)k[1])<<16;
502       a += ((uint32_t)k[2])<<8;
503       a += ((uint32_t)k[3]);
504       b += ((uint32_t)k[4])<<24;
505       b += ((uint32_t)k[5])<<16;
506       b += ((uint32_t)k[6])<<8;
507       b += ((uint32_t)k[7]);
508       c += ((uint32_t)k[8])<<24;
509       c += ((uint32_t)k[9])<<16;
510       c += ((uint32_t)k[10])<<8;
511       c += ((uint32_t)k[11]);
512       mix(a,b,c);
513       length -= 12;
514       k += 12;
515     }
516
517     /*-------------------------------- last block: affect all 32 bits of (c) */
518     switch(length)                   /* all the case statements fall through */
519     {
520     case 12: c+=k[11];
521     case 11: c+=((uint32_t)k[10])<<8;
522     case 10: c+=((uint32_t)k[9])<<16;
523     case 9 : c+=((uint32_t)k[8])<<24;
524     case 8 : b+=k[7];
525     case 7 : b+=((uint32_t)k[6])<<8;
526     case 6 : b+=((uint32_t)k[5])<<16;
527     case 5 : b+=((uint32_t)k[4])<<24;
528     case 4 : a+=k[3];
529     case 3 : a+=((uint32_t)k[2])<<8;
530     case 2 : a+=((uint32_t)k[1])<<16;
531     case 1 : a+=((uint32_t)k[0])<<24;
532              break;
533     case 0 : return c;
534     }
535   }
536
537   final(a,b,c);
538   *val2 = b;
539   return c;
540 }
541
542 /* I basically use hashlittle here, but use native endian within each
543  * element.  This delivers least-surprise: hash such as "int arr[] = {
544  * 1, 2 }; hash_stable(arr, 2, 0);" will be the same on big and little
545  * endian machines, even though a bytewise hash wouldn't be. */
546 uint64_t hash64_stable_64(const void *key, size_t n, uint64_t base)
547 {
548         const uint64_t *k = key;
549         uint32_t a,b,c;
550
551         /* Set up the internal state */
552         a = b = c = 0xdeadbeef + ((uint32_t)n*8) + (base >> 32) + base;
553
554         while (n > 3) {
555                 a += (uint32_t)k[0];
556                 b += (uint32_t)(k[0] >> 32);
557                 c += (uint32_t)k[1];
558                 mix(a,b,c);
559                 a += (uint32_t)(k[1] >> 32);
560                 b += (uint32_t)k[2];
561                 c += (uint32_t)(k[2] >> 32);
562                 mix(a,b,c);
563                 n -= 3;
564                 k += 3;
565         }
566         switch (n) {
567         case 2:
568                 a += (uint32_t)k[0];
569                 b += (uint32_t)(k[0] >> 32);
570                 c += (uint32_t)k[1];
571                 mix(a,b,c);
572                 a += (uint32_t)(k[1] >> 32);
573                 break;
574         case 1:
575                 a += (uint32_t)k[0];
576                 b += (uint32_t)(k[0] >> 32);
577                 break;
578         case 0:
579                 return c;
580         }
581         final(a,b,c);
582         return ((uint64_t)b << 32) | c;
583 }
584
585 uint64_t hash64_stable_32(const void *key, size_t n, uint64_t base)
586 {
587         const uint32_t *k = key;
588         uint32_t a,b,c;
589
590         /* Set up the internal state */
591         a = b = c = 0xdeadbeef + ((uint32_t)n*4) + (base >> 32) + base;
592
593         while (n > 3) {
594                 a += k[0];
595                 b += k[1];
596                 c += k[2];
597                 mix(a,b,c);
598
599                 n -= 3;
600                 k += 3;
601         }
602         switch (n) {
603         case 2:
604                 b += (uint32_t)k[1];
605         case 1:
606                 a += (uint32_t)k[0];
607                 break;
608         case 0:
609                 return c;
610         }
611         final(a,b,c);
612         return ((uint64_t)b << 32) | c;
613 }
614
615 uint64_t hash64_stable_16(const void *key, size_t n, uint64_t base)
616 {
617         const uint16_t *k = key;
618         uint32_t a,b,c;
619
620         /* Set up the internal state */
621         a = b = c = 0xdeadbeef + ((uint32_t)n*2) + (base >> 32) + base;
622
623         while (n > 6) {
624                 a += (uint32_t)k[0] + ((uint32_t)k[1] << 16);
625                 b += (uint32_t)k[2] + ((uint32_t)k[3] << 16);
626                 c += (uint32_t)k[4] + ((uint32_t)k[5] << 16);
627                 mix(a,b,c);
628
629                 n -= 6;
630                 k += 6;
631         }
632
633         switch (n) {
634         case 5:
635                 c += (uint32_t)k[4];
636         case 4:
637                 b += ((uint32_t)k[3] << 16);
638         case 3:
639                 b += (uint32_t)k[2];
640         case 2:
641                 a += ((uint32_t)k[1] << 16);
642         case 1:
643                 a += (uint32_t)k[0];
644                 break;
645         case 0:
646                 return c;
647         }
648         final(a,b,c);
649         return ((uint64_t)b << 32) | c;
650 }
651
652 uint64_t hash64_stable_8(const void *key, size_t n, uint64_t base)
653 {
654         uint32_t b32 = base + (base >> 32);
655         uint32_t lower = hashlittle(key, n, &b32);
656
657         return ((uint64_t)b32 << 32) | lower;   
658 }
659
660 uint32_t hash_any(const void *key, size_t length, uint32_t base)
661 {
662         if (HASH_BIG_ENDIAN)
663                 return hashbig(key, length, &base);
664         else
665                 return hashlittle(key, length, &base);
666 }
667
668 uint32_t hash_stable_64(const void *key, size_t n, uint32_t base)
669 {
670         return hash64_stable_64(key, n, base);
671 }
672
673 uint32_t hash_stable_32(const void *key, size_t n, uint32_t base)
674 {
675         return hash64_stable_32(key, n, base);
676 }
677
678 uint32_t hash_stable_16(const void *key, size_t n, uint32_t base)
679 {
680         return hash64_stable_16(key, n, base);
681 }
682
683 uint32_t hash_stable_8(const void *key, size_t n, uint32_t base)
684 {
685         return hashlittle(key, n, &base);
686 }
687
688 /* Jenkins' lookup8 is a 64 bit hash, but he says it's obsolete.  Use
689  * the plain one and recombine into 64 bits. */
690 uint64_t hash64_any(const void *key, size_t length, uint64_t base)
691 {
692         uint32_t b32 = base + (base >> 32);
693         uint32_t lower;
694
695         if (HASH_BIG_ENDIAN)
696                 lower = hashbig(key, length, &b32);
697         else
698                 lower = hashlittle(key, length, &b32);
699
700         return ((uint64_t)b32 << 32) | lower;
701 }
702
703 #ifdef SELF_TEST
704
705 /* used for timings */
706 void driver1()
707 {
708   uint8_t buf[256];
709   uint32_t i;
710   uint32_t h=0;
711   time_t a,z;
712
713   time(&a);
714   for (i=0; i<256; ++i) buf[i] = 'x';
715   for (i=0; i<1; ++i) 
716   {
717     h = hashlittle(&buf[0],1,h);
718   }
719   time(&z);
720   if (z-a > 0) printf("time %d %.8x\n", z-a, h);
721 }
722
723 /* check that every input bit changes every output bit half the time */
724 #define HASHSTATE 1
725 #define HASHLEN   1
726 #define MAXPAIR 60
727 #define MAXLEN  70
728 void driver2()
729 {
730   uint8_t qa[MAXLEN+1], qb[MAXLEN+2], *a = &qa[0], *b = &qb[1];
731   uint32_t c[HASHSTATE], d[HASHSTATE], i=0, j=0, k, l, m=0, z;
732   uint32_t e[HASHSTATE],f[HASHSTATE],g[HASHSTATE],h[HASHSTATE];
733   uint32_t x[HASHSTATE],y[HASHSTATE];
734   uint32_t hlen;
735
736   printf("No more than %d trials should ever be needed \n",MAXPAIR/2);
737   for (hlen=0; hlen < MAXLEN; ++hlen)
738   {
739     z=0;
740     for (i=0; i<hlen; ++i)  /*----------------------- for each input byte, */
741     {
742       for (j=0; j<8; ++j)   /*------------------------ for each input bit, */
743       {
744         for (m=1; m<8; ++m) /*------------ for serveral possible initvals, */
745         {
746           for (l=0; l<HASHSTATE; ++l)
747             e[l]=f[l]=g[l]=h[l]=x[l]=y[l]=~((uint32_t)0);
748
749           /*---- check that every output bit is affected by that input bit */
750           for (k=0; k<MAXPAIR; k+=2)
751           { 
752             uint32_t finished=1;
753             /* keys have one bit different */
754             for (l=0; l<hlen+1; ++l) {a[l] = b[l] = (uint8_t)0;}
755             /* have a and b be two keys differing in only one bit */
756             a[i] ^= (k<<j);
757             a[i] ^= (k>>(8-j));
758              c[0] = hashlittle(a, hlen, m);
759             b[i] ^= ((k+1)<<j);
760             b[i] ^= ((k+1)>>(8-j));
761              d[0] = hashlittle(b, hlen, m);
762             /* check every bit is 1, 0, set, and not set at least once */
763             for (l=0; l<HASHSTATE; ++l)
764             {
765               e[l] &= (c[l]^d[l]);
766               f[l] &= ~(c[l]^d[l]);
767               g[l] &= c[l];
768               h[l] &= ~c[l];
769               x[l] &= d[l];
770               y[l] &= ~d[l];
771               if (e[l]|f[l]|g[l]|h[l]|x[l]|y[l]) finished=0;
772             }
773             if (finished) break;
774           }
775           if (k>z) z=k;
776           if (k==MAXPAIR) 
777           {
778              printf("Some bit didn't change: ");
779              printf("%.8x %.8x %.8x %.8x %.8x %.8x  ",
780                     e[0],f[0],g[0],h[0],x[0],y[0]);
781              printf("i %d j %d m %d len %d\n", i, j, m, hlen);
782           }
783           if (z==MAXPAIR) goto done;
784         }
785       }
786     }
787    done:
788     if (z < MAXPAIR)
789     {
790       printf("Mix success  %2d bytes  %2d initvals  ",i,m);
791       printf("required  %d  trials\n", z/2);
792     }
793   }
794   printf("\n");
795 }
796
797 /* Check for reading beyond the end of the buffer and alignment problems */
798 void driver3()
799 {
800   uint8_t buf[MAXLEN+20], *b;
801   uint32_t len;
802   uint8_t q[] = "This is the time for all good men to come to the aid of their country...";
803   uint32_t h;
804   uint8_t qq[] = "xThis is the time for all good men to come to the aid of their country...";
805   uint32_t i;
806   uint8_t qqq[] = "xxThis is the time for all good men to come to the aid of their country...";
807   uint32_t j;
808   uint8_t qqqq[] = "xxxThis is the time for all good men to come to the aid of their country...";
809   uint32_t ref,x,y;
810   uint8_t *p;
811
812   printf("Endianness.  These lines should all be the same (for values filled in):\n");
813   printf("%.8x                            %.8x                            %.8x\n",
814          hash_word((const uint32_t *)q, (sizeof(q)-1)/4, 13),
815          hash_word((const uint32_t *)q, (sizeof(q)-5)/4, 13),
816          hash_word((const uint32_t *)q, (sizeof(q)-9)/4, 13));
817   p = q;
818   printf("%.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x\n",
819          hashlittle(p, sizeof(q)-1, 13), hashlittle(p, sizeof(q)-2, 13),
820          hashlittle(p, sizeof(q)-3, 13), hashlittle(p, sizeof(q)-4, 13),
821          hashlittle(p, sizeof(q)-5, 13), hashlittle(p, sizeof(q)-6, 13),
822          hashlittle(p, sizeof(q)-7, 13), hashlittle(p, sizeof(q)-8, 13),
823          hashlittle(p, sizeof(q)-9, 13), hashlittle(p, sizeof(q)-10, 13),
824          hashlittle(p, sizeof(q)-11, 13), hashlittle(p, sizeof(q)-12, 13));
825   p = &qq[1];
826   printf("%.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x\n",
827          hashlittle(p, sizeof(q)-1, 13), hashlittle(p, sizeof(q)-2, 13),
828          hashlittle(p, sizeof(q)-3, 13), hashlittle(p, sizeof(q)-4, 13),
829          hashlittle(p, sizeof(q)-5, 13), hashlittle(p, sizeof(q)-6, 13),
830          hashlittle(p, sizeof(q)-7, 13), hashlittle(p, sizeof(q)-8, 13),
831          hashlittle(p, sizeof(q)-9, 13), hashlittle(p, sizeof(q)-10, 13),
832          hashlittle(p, sizeof(q)-11, 13), hashlittle(p, sizeof(q)-12, 13));
833   p = &qqq[2];
834   printf("%.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x\n",
835          hashlittle(p, sizeof(q)-1, 13), hashlittle(p, sizeof(q)-2, 13),
836          hashlittle(p, sizeof(q)-3, 13), hashlittle(p, sizeof(q)-4, 13),
837          hashlittle(p, sizeof(q)-5, 13), hashlittle(p, sizeof(q)-6, 13),
838          hashlittle(p, sizeof(q)-7, 13), hashlittle(p, sizeof(q)-8, 13),
839          hashlittle(p, sizeof(q)-9, 13), hashlittle(p, sizeof(q)-10, 13),
840          hashlittle(p, sizeof(q)-11, 13), hashlittle(p, sizeof(q)-12, 13));
841   p = &qqqq[3];
842   printf("%.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x %.8x\n",
843          hashlittle(p, sizeof(q)-1, 13), hashlittle(p, sizeof(q)-2, 13),
844          hashlittle(p, sizeof(q)-3, 13), hashlittle(p, sizeof(q)-4, 13),
845          hashlittle(p, sizeof(q)-5, 13), hashlittle(p, sizeof(q)-6, 13),
846          hashlittle(p, sizeof(q)-7, 13), hashlittle(p, sizeof(q)-8, 13),
847          hashlittle(p, sizeof(q)-9, 13), hashlittle(p, sizeof(q)-10, 13),
848          hashlittle(p, sizeof(q)-11, 13), hashlittle(p, sizeof(q)-12, 13));
849   printf("\n");
850
851   /* check that hashlittle2 and hashlittle produce the same results */
852   i=47; j=0;
853   hashlittle2(q, sizeof(q), &i, &j);
854   if (hashlittle(q, sizeof(q), 47) != i)
855     printf("hashlittle2 and hashlittle mismatch\n");
856
857   /* check that hash_word2 and hash_word produce the same results */
858   len = 0xdeadbeef;
859   i=47, j=0;
860   hash_word2(&len, 1, &i, &j);
861   if (hash_word(&len, 1, 47) != i)
862     printf("hash_word2 and hash_word mismatch %x %x\n", 
863            i, hash_word(&len, 1, 47));
864
865   /* check hashlittle doesn't read before or after the ends of the string */
866   for (h=0, b=buf+1; h<8; ++h, ++b)
867   {
868     for (i=0; i<MAXLEN; ++i)
869     {
870       len = i;
871       for (j=0; j<i; ++j) *(b+j)=0;
872
873       /* these should all be equal */
874       ref = hashlittle(b, len, (uint32_t)1);
875       *(b+i)=(uint8_t)~0;
876       *(b-1)=(uint8_t)~0;
877       x = hashlittle(b, len, (uint32_t)1);
878       y = hashlittle(b, len, (uint32_t)1);
879       if ((ref != x) || (ref != y)) 
880       {
881         printf("alignment error: %.8x %.8x %.8x %d %d\n",ref,x,y,
882                h, i);
883       }
884     }
885   }
886 }
887
888 /* check for problems with nulls */
889  void driver4()
890 {
891   uint8_t buf[1];
892   uint32_t h,i,state[HASHSTATE];
893
894
895   buf[0] = ~0;
896   for (i=0; i<HASHSTATE; ++i) state[i] = 1;
897   printf("These should all be different\n");
898   for (i=0, h=0; i<8; ++i)
899   {
900     h = hashlittle(buf, 0, h);
901     printf("%2ld  0-byte strings, hash is  %.8x\n", i, h);
902   }
903 }
904
905
906 int main()
907 {
908   driver1();   /* test that the key is hashed: used for timings */
909   driver2();   /* test that whole key is hashed thoroughly */
910   driver3();   /* test that nothing but the key is hashed */
911   driver4();   /* test hashing multiple buffers (all buffers are null) */
912   return 1;
913 }
914
915 #endif  /* SELF_TEST */