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