1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2006 Bob Jenkins
11 * http://burtleburtle.net/bob/c/lookup3.c
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version 2
16 * of the License, or (at your option) any later version.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
21 ****************************************************************************/
23 lookup3.c, by Bob Jenkins, May 2006, Public Domain.
25 These are functions for producing 32-bit hashes for hash table lookup.
26 hashword(), hashlittle(), hashlittle2(), hashbig(), mix(), and final()
27 are externally useful functions. Routines to test the hash are included
28 if SELF_TEST is defined. You can use this free for any purpose. It's in
29 the public domain. It has no warranty.
31 You probably want to use hashlittle(). hashlittle() and hashbig()
32 hash byte arrays. hashlittle() is is faster than hashbig() on
33 little-endian machines. Intel and AMD are little-endian machines.
34 On second thought, you probably want hashlittle2(), which is identical to
35 hashlittle() except it returns two 32-bit hashes for the price of one.
36 You could implement hashbig2() if you wanted but I haven't bothered here.
38 If you want to find a hash of, say, exactly 7 integers, do
39 a = i1; b = i2; c = i3;
41 a += i4; b += i5; c += i6;
45 then use c as the hash value. If you have a variable length array of
46 4-byte integers to hash, use hashword(). If you have a byte array (like
47 a character string), use hashlittle(). If you have several byte arrays, or
48 a mix of things, see the comments above hashlittle().
50 Why is this so big? I read 12 bytes at a time into 3 4-byte integers,
51 then mix those integers. This is fast (you can do a lot more thorough
52 mixing with 12*3 instructions on 3 integers than you can with 3 instructions
53 on 1 byte), but shoehorning those bytes into integers efficiently is messy.
59 * My best guess at if you are big-endian or little-endian. This may
62 #if defined(ROCKBOX_LITTLE_ENDIAN)
63 # define HASH_LITTLE_ENDIAN 1
64 # define HASH_BIG_ENDIAN 0
65 #elif defined(ROCKBOX_BIG_ENDIAN)
66 # define HASH_LITTLE_ENDIAN 0
67 # define HASH_BIG_ENDIAN 1
69 # define HASH_LITTLE_ENDIAN 0
70 # define HASH_BIG_ENDIAN 0
73 #define hashsize(n) ((uint32_t)1<<(n))
74 #define hashmask(n) (hashsize(n)-1)
75 #define rot(x,k) (((x)<<(k)) | ((x)>>(32-(k))))
79 mix -- mix 3 32-bit values reversibly.
81 This is reversible, so any information in (a,b,c) before mix() is
82 still in (a,b,c) after mix().
84 If four pairs of (a,b,c) inputs are run through mix(), or through
85 mix() in reverse, there are at least 32 bits of the output that
86 are sometimes the same for one pair and different for another pair.
88 * pairs that differed by one bit, by two bits, in any combination
89 of top bits of (a,b,c), or in any combination of bottom bits of
91 * "differ" is defined as +, -, ^, or ~^. For + and -, I transformed
92 the output delta to a Gray code (a^(a>>1)) so a string of 1's (as
93 is commonly produced by subtraction) look like a single 1-bit
95 * the base values were pseudorandom, all zero but one bit set, or
96 all zero plus a counter that starts at zero.
98 Some k values for my "a-=c; a^=rot(c,k); c+=b;" arrangement that
103 Well, "9 15 3 18 27 15" didn't quite get 32 bits diffing
104 for "differ" defined as + with a one-bit base and a two-bit delta. I
105 used http://burtleburtle.net/bob/hash/avalanche.html to choose
106 the operations, constants, and arrangements of the variables.
108 This does not achieve avalanche. There are input bits of (a,b,c)
109 that fail to affect some output bits of (a,b,c), especially of a. The
110 most thoroughly mixed value is c, but it doesn't really even achieve
113 This allows some parallelism. Read-after-writes are good at doubling
114 the number of bits affected, so the goal of mixing pulls in the opposite
115 direction as the goal of parallelism. I did what I could. Rotates
116 seem to cost as much as shifts on every machine I could lay my hands
117 on, and rotates are much kinder to the top and bottom bits, so I used
122 a -= c; a ^= rot(c, 4); c += b; \
123 b -= a; b ^= rot(a, 6); a += c; \
124 c -= b; c ^= rot(b, 8); b += a; \
125 a -= c; a ^= rot(c,16); c += b; \
126 b -= a; b ^= rot(a,19); a += c; \
127 c -= b; c ^= rot(b, 4); b += a; \
131 final -- final mixing of 3 32-bit values (a,b,c) into c
133 Pairs of (a,b,c) values differing in only a few bits will usually
134 produce values of c that look totally different. This was tested for
135 * pairs that differed by one bit, by two bits, in any combination
136 of top bits of (a,b,c), or in any combination of bottom bits of
138 * "differ" is defined as +, -, ^, or ~^. For + and -, I transformed
139 the output delta to a Gray code (a^(a>>1)) so a string of 1's (as
140 is commonly produced by subtraction) look like a single 1-bit
142 * the base values were pseudorandom, all zero but one bit set, or
143 all zero plus a counter that starts at zero.
145 These constants passed:
148 and these came close:
153 #define final(a,b,c) \
155 c ^= b; c -= rot(b,14); \
156 a ^= c; a -= rot(c,11); \
157 b ^= a; b -= rot(a,25); \
158 c ^= b; c -= rot(b,16); \
159 a ^= c; a -= rot(c,4); \
160 b ^= a; b -= rot(a,14); \
161 c ^= b; c -= rot(b,24); \
165 k: pointer to the key, an array of uint32_t
166 length: number of elements in the key
167 initval: an initialization value
168 returns the 32-bit hash
170 uint32_t hashw(const uint32_t *k
, size_t length
, uint32_t initval
)
174 /* Set up the internal state */
175 a
= b
= c
= 0xdeadbeef + (((uint32_t)length
)<<2) + initval
;
177 /* handle most of the key */
188 /* handle the last 3 uint32_t's */
189 switch(length
) /* all the case statements fall through */
198 case 0: /* case 0: nothing left to add */
201 /* report the result */
207 hashw2() -- same as hashw(), but take two seeds and return two
208 32-bit values. pc and pb must both be nonnull, and *pc and *pb must
209 both be initialized with seeds. If you pass in (*pb)==0, the output
210 (*pc) will be the same as the return value from hashword().
211 k: pointer to the key, an array of uint32_t
212 length: number of elements in the key
213 pc, pb: pointers to primary and secondary initial values, also used to store
216 void hashw2 (const uint32_t *k
, size_t length
, uint32_t *pc
, uint32_t *pb
)
220 /* Set up the internal state */
221 a
= b
= c
= 0xdeadbeef + ((uint32_t)(length
<<2)) + *pc
;
224 /* handle most of the key */
235 /* handle the last 3 uint32_t's */
236 switch(length
) /* all the case statements fall through */
245 case 0: /* case 0: nothing left to add */
248 /* report the result */
254 hashs() -- hash a variable-length key into a 32-bit value
255 k: pointer to the key, an array of bytes
256 length: number of elements in the key
257 initval: an initialization value
258 returns the 32-bit hash
259 Returns a 32-bit value. Every bit of the key affects every bit of
260 the return value. Two keys differing by one or two bits will have
261 totally different hash values.
263 The best hash table sizes are powers of 2. There is no need to do
264 mod a prime (mod is sooo slow!). If you need less than 32 bits,
265 use a bitmask. For example, if you need only 10 bits, do
266 h = (h & hashmask(10));
267 In which case, the hash table should have hashsize(10) elements.
269 If you are hashing n strings (uint8_t **)k, do it like this:
270 for (i=0, h=0; i<n; ++i) h = hashlittle( k[i], len[i], h);
272 By Bob Jenkins, 2006. bob_jenkins@burtleburtle.net. You may use this
273 code any way you wish, private, educational, or commercial. It's free.
275 Use for hash table lookup, or anything where one collision in 2^^32 is
276 acceptable. Do NOT use for cryptographic purposes.
279 uint32_t hashs( const void *key
, size_t length
, uint32_t initval
)
281 uint32_t a
,b
,c
; /* internal state */
282 union { const void *ptr
; size_t i
; } u
;/* needed for Mac Powerbook G4 */
284 /* Set up the internal state */
285 a
= b
= c
= 0xdeadbeef + ((uint32_t)length
) + initval
;
288 #if HASH_LITTLE_ENDIAN
289 if ((u
.i
& 0x3) == 0) {
290 const uint32_t *k
= (const uint32_t *)key
; /* read 32-bit chunks */
292 /* all but last block: aligned reads and affect 32 bits of (a,b,c) */
303 /* handle the last (probably partial) block */
312 c
+= k
[2] & 0xffffff;
331 b
+= k
[1] & 0xffffff;
346 a
+= k
[0] & 0xffffff;
355 return c
; /* zero length strings require no mixing */
358 } else if ((u
.i
& 0x1) == 0) {
359 const uint16_t *k
= (const uint16_t *)key
; /* read 16-bit chunks */
362 /* all but last block: aligned reads and different mixing */
365 a
+= k
[0] + (((uint32_t)k
[1])<<16);
366 b
+= k
[2] + (((uint32_t)k
[3])<<16);
367 c
+= k
[4] + (((uint32_t)k
[5])<<16);
373 /* handle the last (probably partial) block */
374 k8
= (const uint8_t *)k
;
378 c
+= k
[4] + (((uint32_t)k
[5])<<16);
379 b
+= k
[2] + (((uint32_t)k
[3])<<16);
380 a
+= k
[0] + (((uint32_t)k
[1])<<16);
383 c
+= ((uint32_t)k8
[10])<<16; /* fall through */
386 b
+= k
[2] + (((uint32_t)k
[3])<<16);
387 a
+= k
[0] + (((uint32_t)k
[1])<<16);
390 c
+= k8
[8]; /* fall through */
392 b
+= k
[2] + (((uint32_t)k
[3])<<16);
393 a
+= k
[0] + (((uint32_t)k
[1])<<16);
396 b
+= ((uint32_t)k8
[6])<<16; /* fall through */
399 a
+= k
[0] + (((uint32_t)k
[1])<<16);
402 b
+= k8
[4]; /* fall through */
404 a
+= k
[0] + (((uint32_t)k
[1])<<16);
407 a
+= ((uint32_t)k8
[2])<<16; /* fall through */
415 return c
; /* zero length requires no mixing */
420 { /* need to read the key one byte at a time */
421 const uint8_t *k
= (const uint8_t *)key
;
423 /* all but the last block: affect some 32 bits of (a,b,c) */
427 a
+= ((uint32_t)k
[1])<<8;
428 a
+= ((uint32_t)k
[2])<<16;
429 a
+= ((uint32_t)k
[3])<<24;
431 b
+= ((uint32_t)k
[5])<<8;
432 b
+= ((uint32_t)k
[6])<<16;
433 b
+= ((uint32_t)k
[7])<<24;
435 c
+= ((uint32_t)k
[9])<<8;
436 c
+= ((uint32_t)k
[10])<<16;
437 c
+= ((uint32_t)k
[11])<<24;
443 /* last block: affect all 32 bits of (c) */
444 switch(length
) /* all the case statements fall through */
447 c
+= ((uint32_t)k
[11])<<24;
449 c
+= ((uint32_t)k
[10])<<16;
451 c
+= ((uint32_t)k
[9])<<8;
455 b
+= ((uint32_t)k
[7])<<24;
457 b
+= ((uint32_t)k
[6])<<16;
459 b
+= ((uint32_t)k
[5])<<8;
463 a
+= ((uint32_t)k
[3])<<24;
465 a
+= ((uint32_t)k
[2])<<16;
467 a
+= ((uint32_t)k
[1])<<8;
482 hashs2: return 2 32-bit hash values
483 k: pointer to the key, an array of bytes
484 length: number of elements in the key
485 pc, pb: pointers to primary and secondary initial values, also used to store
487 * This is identical to hashlittle(), except it returns two 32-bit hash
488 * values instead of just one. This is good enough for hash table
489 * lookup with 2^^64 buckets, or if you want a second hash if you're not
490 * happy with the first, or if you want a probably-unique 64-bit ID for
491 * the key. *pc is better mixed than *pb, so use *pc first. If you want
492 * a 64-bit value do something like "*pc + (((uint64_t)*pb)<<32)".
494 void hashs2(const void *key
, size_t length
, uint32_t *pc
, uint32_t *pb
)
496 uint32_t a
, b
, c
; /* internal state */
497 union { const void *ptr
; size_t i
; } u
; /* needed for Mac Powerbook G4 */
499 /* Set up the internal state */
500 a
= b
= c
= 0xdeadbeef + ((uint32_t)length
) + *pc
;
504 #if HASH_LITTLE_ENDIAN
505 if (((u
.i
& 0x3) == 0)) {
506 const uint32_t *k
= (const uint32_t *)key
; /* read 32-bit chunks */
508 /* all but last block: aligned reads and affect 32 bits of (a,b,c) */
519 /* handle the last (probably partial) block */
528 c
+= k
[2] & 0xffffff;
547 b
+= k
[1] & 0xffffff;
562 a
+= k
[0] & 0xffffff;
573 return; /* zero length strings require no mixing */
575 } else if (((u
.i
& 0x1) == 0)) {
576 const uint16_t *k
= (const uint16_t *)key
; /* read 16-bit chunks */
579 /* all but last block: aligned reads and different mixing */
582 a
+= k
[0] + (((uint32_t)k
[1])<<16);
583 b
+= k
[2] + (((uint32_t)k
[3])<<16);
584 c
+= k
[4] + (((uint32_t)k
[5])<<16);
590 /* handle the last (probably partial) block */
591 k8
= (const uint8_t *)k
;
595 c
+= k
[4] + (((uint32_t)k
[5])<<16);
596 b
+= k
[2] + (((uint32_t)k
[3])<<16);
597 a
+= k
[0] + (((uint32_t)k
[1])<<16);
600 c
+= ((uint32_t)k8
[10])<<16; /* fall through */
603 b
+= k
[2] + (((uint32_t)k
[3])<<16);
604 a
+= k
[0] + (((uint32_t)k
[1])<<16);
607 c
+= k8
[8]; /* fall through */
609 b
+= k
[2] + (((uint32_t)k
[3])<<16);
610 a
+= k
[0] + (((uint32_t)k
[1])<<16);
613 b
+= ((uint32_t)k8
[6])<<16; /* fall through */
616 a
+= k
[0] + (((uint32_t)k
[1])<<16);
619 b
+= k8
[4]; /* fall through */
621 a
+= k
[0] + (((uint32_t)k
[1])<<16);
624 a
+= ((uint32_t)k8
[2])<<16; /* fall through */
634 return; /* zero length strings require no mixing */
638 { /* need to read the key one byte at a time */
639 const uint8_t *k
= (const uint8_t *)key
;
641 /* all but the last block: affect some 32 bits of (a,b,c) */
645 a
+= ((uint32_t)k
[1])<<8;
646 a
+= ((uint32_t)k
[2])<<16;
647 a
+= ((uint32_t)k
[3])<<24;
649 b
+= ((uint32_t)k
[5])<<8;
650 b
+= ((uint32_t)k
[6])<<16;
651 b
+= ((uint32_t)k
[7])<<24;
653 c
+= ((uint32_t)k
[9])<<8;
654 c
+= ((uint32_t)k
[10])<<16;
655 c
+= ((uint32_t)k
[11])<<24;
661 /* last block: affect all 32 bits of (c) */
662 switch(length
) /* all the case statements fall through */
665 c
+= ((uint32_t)k
[11]) << 24;
667 c
+= ((uint32_t)k
[10]) << 16;
669 c
+= ((uint32_t)k
[9]) << 8;
673 b
+= ((uint32_t)k
[7]) << 24;
675 b
+= ((uint32_t)k
[6]) << 16;
677 b
+= ((uint32_t)k
[5]) << 8;
681 a
+= ((uint32_t)k
[3]) << 24;
683 a
+= ((uint32_t)k
[2]) << 16;
685 a
+= ((uint32_t)k
[1]) << 8;
692 return; /* zero length strings require no mixing */