xref: /minix3/minix/lib/libmagicrt/include/common/ut/uthash.h (revision b2ed49a5d83e311ee0fa9e5ff613639b1bf77aaf)
1*b2ed49a5SDavid van Moolenbroek /*
2*b2ed49a5SDavid van Moolenbroek Copyright (c) 2003-2013, Troy D. Hanson     http://troydhanson.github.com/uthash/
3*b2ed49a5SDavid van Moolenbroek All rights reserved.
4*b2ed49a5SDavid van Moolenbroek 
5*b2ed49a5SDavid van Moolenbroek Redistribution and use in source and binary forms, with or without
6*b2ed49a5SDavid van Moolenbroek modification, are permitted provided that the following conditions are met:
7*b2ed49a5SDavid van Moolenbroek 
8*b2ed49a5SDavid van Moolenbroek     * Redistributions of source code must retain the above copyright
9*b2ed49a5SDavid van Moolenbroek       notice, this list of conditions and the following disclaimer.
10*b2ed49a5SDavid van Moolenbroek 
11*b2ed49a5SDavid van Moolenbroek THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
12*b2ed49a5SDavid van Moolenbroek IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
13*b2ed49a5SDavid van Moolenbroek TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
14*b2ed49a5SDavid van Moolenbroek PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
15*b2ed49a5SDavid van Moolenbroek OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
16*b2ed49a5SDavid van Moolenbroek EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
17*b2ed49a5SDavid van Moolenbroek PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
18*b2ed49a5SDavid van Moolenbroek PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
19*b2ed49a5SDavid van Moolenbroek LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
20*b2ed49a5SDavid van Moolenbroek NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
21*b2ed49a5SDavid van Moolenbroek SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22*b2ed49a5SDavid van Moolenbroek */
23*b2ed49a5SDavid van Moolenbroek 
24*b2ed49a5SDavid van Moolenbroek #ifndef UTHASH_H
25*b2ed49a5SDavid van Moolenbroek #define UTHASH_H
26*b2ed49a5SDavid van Moolenbroek 
27*b2ed49a5SDavid van Moolenbroek #include <string.h>   /* memcmp,strlen */
28*b2ed49a5SDavid van Moolenbroek #include <stddef.h>   /* ptrdiff_t */
29*b2ed49a5SDavid van Moolenbroek #include <stdlib.h>   /* exit() */
30*b2ed49a5SDavid van Moolenbroek 
31*b2ed49a5SDavid van Moolenbroek /* These macros use decltype or the earlier __typeof GNU extension.
32*b2ed49a5SDavid van Moolenbroek    As decltype is only available in newer compilers (VS2010 or gcc 4.3+
33*b2ed49a5SDavid van Moolenbroek    when compiling c++ source) this code uses whatever method is needed
34*b2ed49a5SDavid van Moolenbroek    or, for VS2008 where neither is available, uses casting workarounds. */
35*b2ed49a5SDavid van Moolenbroek #ifdef _MSC_VER         /* MS compiler */
36*b2ed49a5SDavid van Moolenbroek #if _MSC_VER >= 1600 && defined(__cplusplus)  /* VS2010 or newer in C++ mode */
37*b2ed49a5SDavid van Moolenbroek #define DECLTYPE(x) (decltype(x))
38*b2ed49a5SDavid van Moolenbroek #else                   /* VS2008 or older (or VS2010 in C mode) */
39*b2ed49a5SDavid van Moolenbroek #define NO_DECLTYPE
40*b2ed49a5SDavid van Moolenbroek #define DECLTYPE(x)
41*b2ed49a5SDavid van Moolenbroek #endif
42*b2ed49a5SDavid van Moolenbroek #else                   /* GNU, Sun and other compilers */
43*b2ed49a5SDavid van Moolenbroek #define DECLTYPE(x) (__typeof(x))
44*b2ed49a5SDavid van Moolenbroek #endif
45*b2ed49a5SDavid van Moolenbroek 
46*b2ed49a5SDavid van Moolenbroek #ifdef NO_DECLTYPE
47*b2ed49a5SDavid van Moolenbroek #define DECLTYPE_ASSIGN(dst,src)                                                 \
48*b2ed49a5SDavid van Moolenbroek do {                                                                             \
49*b2ed49a5SDavid van Moolenbroek   char **_da_dst = (char**)(&(dst));                                             \
50*b2ed49a5SDavid van Moolenbroek   *_da_dst = (char*)(src);                                                       \
51*b2ed49a5SDavid van Moolenbroek } while(0)
52*b2ed49a5SDavid van Moolenbroek #else
53*b2ed49a5SDavid van Moolenbroek #define DECLTYPE_ASSIGN(dst,src)                                                 \
54*b2ed49a5SDavid van Moolenbroek do {                                                                             \
55*b2ed49a5SDavid van Moolenbroek   (dst) = DECLTYPE(dst)(src);                                                    \
56*b2ed49a5SDavid van Moolenbroek } while(0)
57*b2ed49a5SDavid van Moolenbroek #endif
58*b2ed49a5SDavid van Moolenbroek 
59*b2ed49a5SDavid van Moolenbroek /* a number of the hash function use uint32_t which isn't defined on win32 */
60*b2ed49a5SDavid van Moolenbroek #ifdef _MSC_VER
61*b2ed49a5SDavid van Moolenbroek typedef unsigned int uint32_t;
62*b2ed49a5SDavid van Moolenbroek typedef unsigned char uint8_t;
63*b2ed49a5SDavid van Moolenbroek #else
64*b2ed49a5SDavid van Moolenbroek #include <inttypes.h>   /* uint32_t */
65*b2ed49a5SDavid van Moolenbroek #endif
66*b2ed49a5SDavid van Moolenbroek 
67*b2ed49a5SDavid van Moolenbroek #define UTHASH_VERSION 1.9.8
68*b2ed49a5SDavid van Moolenbroek 
69*b2ed49a5SDavid van Moolenbroek #ifndef uthash_fatal
70*b2ed49a5SDavid van Moolenbroek #define uthash_fatal(msg) exit(-1)        /* fatal error (out of memory,etc) */
71*b2ed49a5SDavid van Moolenbroek #endif
72*b2ed49a5SDavid van Moolenbroek #ifndef uthash_malloc
73*b2ed49a5SDavid van Moolenbroek #define uthash_malloc(sz) malloc(sz)      /* malloc fcn                      */
74*b2ed49a5SDavid van Moolenbroek #endif
75*b2ed49a5SDavid van Moolenbroek #ifndef uthash_free
76*b2ed49a5SDavid van Moolenbroek #define uthash_free(ptr,sz) free(ptr)     /* free fcn                        */
77*b2ed49a5SDavid van Moolenbroek #endif
78*b2ed49a5SDavid van Moolenbroek 
79*b2ed49a5SDavid van Moolenbroek #ifndef uthash_noexpand_fyi
80*b2ed49a5SDavid van Moolenbroek #define uthash_noexpand_fyi(tbl)          /* can be defined to log noexpand  */
81*b2ed49a5SDavid van Moolenbroek #endif
82*b2ed49a5SDavid van Moolenbroek #ifndef uthash_expand_fyi
83*b2ed49a5SDavid van Moolenbroek #define uthash_expand_fyi(tbl)            /* can be defined to log expands   */
84*b2ed49a5SDavid van Moolenbroek #endif
85*b2ed49a5SDavid van Moolenbroek 
86*b2ed49a5SDavid van Moolenbroek /* initial number of buckets */
87*b2ed49a5SDavid van Moolenbroek #define HASH_INITIAL_NUM_BUCKETS 32      /* initial number of buckets        */
88*b2ed49a5SDavid van Moolenbroek #define HASH_INITIAL_NUM_BUCKETS_LOG2 5  /* lg2 of initial number of buckets */
89*b2ed49a5SDavid van Moolenbroek #define HASH_BKT_CAPACITY_THRESH 10      /* expand when bucket count reaches */
90*b2ed49a5SDavid van Moolenbroek 
91*b2ed49a5SDavid van Moolenbroek /* calculate the element whose hash handle address is hhe */
92*b2ed49a5SDavid van Moolenbroek #define ELMT_FROM_HH(tbl,hhp) ((void*)(((char*)(hhp)) - ((tbl)->hho)))
93*b2ed49a5SDavid van Moolenbroek 
94*b2ed49a5SDavid van Moolenbroek #define HASH_FIND(hh,head,keyptr,keylen,out)                                     \
95*b2ed49a5SDavid van Moolenbroek do {                                                                             \
96*b2ed49a5SDavid van Moolenbroek   unsigned _hf_bkt,_hf_hashv;                                                    \
97*b2ed49a5SDavid van Moolenbroek   out=NULL;                                                                      \
98*b2ed49a5SDavid van Moolenbroek   if (head) {                                                                    \
99*b2ed49a5SDavid van Moolenbroek      HASH_FCN(keyptr,keylen, (head)->hh.tbl->num_buckets, _hf_hashv, _hf_bkt);   \
100*b2ed49a5SDavid van Moolenbroek      if (HASH_BLOOM_TEST((head)->hh.tbl, _hf_hashv)) {                           \
101*b2ed49a5SDavid van Moolenbroek        HASH_FIND_IN_BKT((head)->hh.tbl, hh, (head)->hh.tbl->buckets[ _hf_bkt ],  \
102*b2ed49a5SDavid van Moolenbroek                         keyptr,keylen,out);                                      \
103*b2ed49a5SDavid van Moolenbroek      }                                                                           \
104*b2ed49a5SDavid van Moolenbroek   }                                                                              \
105*b2ed49a5SDavid van Moolenbroek } while (0)
106*b2ed49a5SDavid van Moolenbroek 
107*b2ed49a5SDavid van Moolenbroek #ifdef HASH_BLOOM
108*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_BITLEN (1ULL << HASH_BLOOM)
109*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_BYTELEN (HASH_BLOOM_BITLEN/8) + ((HASH_BLOOM_BITLEN%8) ? 1:0)
110*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_MAKE(tbl)                                                     \
111*b2ed49a5SDavid van Moolenbroek do {                                                                             \
112*b2ed49a5SDavid van Moolenbroek   (tbl)->bloom_nbits = HASH_BLOOM;                                               \
113*b2ed49a5SDavid van Moolenbroek   (tbl)->bloom_bv = (uint8_t*)uthash_malloc(HASH_BLOOM_BYTELEN);                 \
114*b2ed49a5SDavid van Moolenbroek   if (!((tbl)->bloom_bv))  { uthash_fatal( "out of memory"); }                   \
115*b2ed49a5SDavid van Moolenbroek   memset((tbl)->bloom_bv, 0, HASH_BLOOM_BYTELEN);                                \
116*b2ed49a5SDavid van Moolenbroek   (tbl)->bloom_sig = HASH_BLOOM_SIGNATURE;                                       \
117*b2ed49a5SDavid van Moolenbroek } while (0)
118*b2ed49a5SDavid van Moolenbroek 
119*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_FREE(tbl)                                                     \
120*b2ed49a5SDavid van Moolenbroek do {                                                                             \
121*b2ed49a5SDavid van Moolenbroek   uthash_free((tbl)->bloom_bv, HASH_BLOOM_BYTELEN);                              \
122*b2ed49a5SDavid van Moolenbroek } while (0)
123*b2ed49a5SDavid van Moolenbroek 
124*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_BITSET(bv,idx) (bv[(idx)/8] |= (1U << ((idx)%8)))
125*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_BITTEST(bv,idx) (bv[(idx)/8] & (1U << ((idx)%8)))
126*b2ed49a5SDavid van Moolenbroek 
127*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_ADD(tbl,hashv)                                                \
128*b2ed49a5SDavid van Moolenbroek   HASH_BLOOM_BITSET((tbl)->bloom_bv, (hashv & (uint32_t)((1ULL << (tbl)->bloom_nbits) - 1)))
129*b2ed49a5SDavid van Moolenbroek 
130*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_TEST(tbl,hashv)                                               \
131*b2ed49a5SDavid van Moolenbroek   HASH_BLOOM_BITTEST((tbl)->bloom_bv, (hashv & (uint32_t)((1ULL << (tbl)->bloom_nbits) - 1)))
132*b2ed49a5SDavid van Moolenbroek 
133*b2ed49a5SDavid van Moolenbroek #else
134*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_MAKE(tbl)
135*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_FREE(tbl)
136*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_ADD(tbl,hashv)
137*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_TEST(tbl,hashv) (1)
138*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_BYTELEN 0
139*b2ed49a5SDavid van Moolenbroek #endif
140*b2ed49a5SDavid van Moolenbroek 
141*b2ed49a5SDavid van Moolenbroek #define HASH_MAKE_TABLE(hh,head)                                                 \
142*b2ed49a5SDavid van Moolenbroek do {                                                                             \
143*b2ed49a5SDavid van Moolenbroek   (head)->hh.tbl = (UT_hash_table*)uthash_malloc(                                \
144*b2ed49a5SDavid van Moolenbroek                   sizeof(UT_hash_table));                                        \
145*b2ed49a5SDavid van Moolenbroek   if (!((head)->hh.tbl))  { uthash_fatal( "out of memory"); }                    \
146*b2ed49a5SDavid van Moolenbroek   memset((head)->hh.tbl, 0, sizeof(UT_hash_table));                              \
147*b2ed49a5SDavid van Moolenbroek   (head)->hh.tbl->tail = &((head)->hh);                                          \
148*b2ed49a5SDavid van Moolenbroek   (head)->hh.tbl->num_buckets = HASH_INITIAL_NUM_BUCKETS;                        \
149*b2ed49a5SDavid van Moolenbroek   (head)->hh.tbl->log2_num_buckets = HASH_INITIAL_NUM_BUCKETS_LOG2;              \
150*b2ed49a5SDavid van Moolenbroek   (head)->hh.tbl->hho = (char*)(&(head)->hh) - (char*)(head);                    \
151*b2ed49a5SDavid van Moolenbroek   (head)->hh.tbl->buckets = (UT_hash_bucket*)uthash_malloc(                      \
152*b2ed49a5SDavid van Moolenbroek           HASH_INITIAL_NUM_BUCKETS*sizeof(struct UT_hash_bucket));               \
153*b2ed49a5SDavid van Moolenbroek   if (! (head)->hh.tbl->buckets) { uthash_fatal( "out of memory"); }             \
154*b2ed49a5SDavid van Moolenbroek   memset((head)->hh.tbl->buckets, 0,                                             \
155*b2ed49a5SDavid van Moolenbroek           HASH_INITIAL_NUM_BUCKETS*sizeof(struct UT_hash_bucket));               \
156*b2ed49a5SDavid van Moolenbroek   HASH_BLOOM_MAKE((head)->hh.tbl);                                               \
157*b2ed49a5SDavid van Moolenbroek   (head)->hh.tbl->signature = HASH_SIGNATURE;                                    \
158*b2ed49a5SDavid van Moolenbroek } while(0)
159*b2ed49a5SDavid van Moolenbroek 
160*b2ed49a5SDavid van Moolenbroek #define HASH_ADD(hh,head,fieldname,keylen_in,add)                                \
161*b2ed49a5SDavid van Moolenbroek         HASH_ADD_KEYPTR(hh,head,&((add)->fieldname),keylen_in,add)
162*b2ed49a5SDavid van Moolenbroek 
163*b2ed49a5SDavid van Moolenbroek #define HASH_REPLACE(hh,head,fieldname,keylen_in,add,replaced)                   \
164*b2ed49a5SDavid van Moolenbroek do {                                                                             \
165*b2ed49a5SDavid van Moolenbroek   replaced=NULL;                                                                 \
166*b2ed49a5SDavid van Moolenbroek   HASH_FIND(hh,head,&((add)->fieldname),keylen_in,replaced);                     \
167*b2ed49a5SDavid van Moolenbroek   if (replaced!=NULL) {                                                          \
168*b2ed49a5SDavid van Moolenbroek      HASH_DELETE(hh,head,replaced);                                              \
169*b2ed49a5SDavid van Moolenbroek   };                                                                             \
170*b2ed49a5SDavid van Moolenbroek   HASH_ADD(hh,head,fieldname,keylen_in,add);                                     \
171*b2ed49a5SDavid van Moolenbroek } while(0)
172*b2ed49a5SDavid van Moolenbroek 
173*b2ed49a5SDavid van Moolenbroek #define HASH_ADD_KEYPTR(hh,head,keyptr,keylen_in,add)                            \
174*b2ed49a5SDavid van Moolenbroek do {                                                                             \
175*b2ed49a5SDavid van Moolenbroek  unsigned _ha_bkt;                                                               \
176*b2ed49a5SDavid van Moolenbroek  (add)->hh.next = NULL;                                                          \
177*b2ed49a5SDavid van Moolenbroek  (add)->hh.key = (char*)keyptr;                                                  \
178*b2ed49a5SDavid van Moolenbroek  (add)->hh.keylen = (unsigned)keylen_in;                                                   \
179*b2ed49a5SDavid van Moolenbroek  if (!(head)) {                                                                  \
180*b2ed49a5SDavid van Moolenbroek     head = (add);                                                                \
181*b2ed49a5SDavid van Moolenbroek     (head)->hh.prev = NULL;                                                      \
182*b2ed49a5SDavid van Moolenbroek     HASH_MAKE_TABLE(hh,head);                                                    \
183*b2ed49a5SDavid van Moolenbroek  } else {                                                                        \
184*b2ed49a5SDavid van Moolenbroek     (head)->hh.tbl->tail->next = (add);                                          \
185*b2ed49a5SDavid van Moolenbroek     (add)->hh.prev = ELMT_FROM_HH((head)->hh.tbl, (head)->hh.tbl->tail);         \
186*b2ed49a5SDavid van Moolenbroek     (head)->hh.tbl->tail = &((add)->hh);                                         \
187*b2ed49a5SDavid van Moolenbroek  }                                                                               \
188*b2ed49a5SDavid van Moolenbroek  (head)->hh.tbl->num_items++;                                                    \
189*b2ed49a5SDavid van Moolenbroek  (add)->hh.tbl = (head)->hh.tbl;                                                 \
190*b2ed49a5SDavid van Moolenbroek  HASH_FCN(keyptr,keylen_in, (head)->hh.tbl->num_buckets,                         \
191*b2ed49a5SDavid van Moolenbroek          (add)->hh.hashv, _ha_bkt);                                              \
192*b2ed49a5SDavid van Moolenbroek  HASH_ADD_TO_BKT((head)->hh.tbl->buckets[_ha_bkt],&(add)->hh);                   \
193*b2ed49a5SDavid van Moolenbroek  HASH_BLOOM_ADD((head)->hh.tbl,(add)->hh.hashv);                                 \
194*b2ed49a5SDavid van Moolenbroek  HASH_EMIT_KEY(hh,head,keyptr,keylen_in);                                        \
195*b2ed49a5SDavid van Moolenbroek  HASH_FSCK(hh,head);                                                             \
196*b2ed49a5SDavid van Moolenbroek } while(0)
197*b2ed49a5SDavid van Moolenbroek 
198*b2ed49a5SDavid van Moolenbroek #define HASH_TO_BKT( hashv, num_bkts, bkt )                                      \
199*b2ed49a5SDavid van Moolenbroek do {                                                                             \
200*b2ed49a5SDavid van Moolenbroek   bkt = ((hashv) & ((num_bkts) - 1));                                            \
201*b2ed49a5SDavid van Moolenbroek } while(0)
202*b2ed49a5SDavid van Moolenbroek 
203*b2ed49a5SDavid van Moolenbroek /* delete "delptr" from the hash table.
204*b2ed49a5SDavid van Moolenbroek  * "the usual" patch-up process for the app-order doubly-linked-list.
205*b2ed49a5SDavid van Moolenbroek  * The use of _hd_hh_del below deserves special explanation.
206*b2ed49a5SDavid van Moolenbroek  * These used to be expressed using (delptr) but that led to a bug
207*b2ed49a5SDavid van Moolenbroek  * if someone used the same symbol for the head and deletee, like
208*b2ed49a5SDavid van Moolenbroek  *  HASH_DELETE(hh,users,users);
209*b2ed49a5SDavid van Moolenbroek  * We want that to work, but by changing the head (users) below
210*b2ed49a5SDavid van Moolenbroek  * we were forfeiting our ability to further refer to the deletee (users)
211*b2ed49a5SDavid van Moolenbroek  * in the patch-up process. Solution: use scratch space to
212*b2ed49a5SDavid van Moolenbroek  * copy the deletee pointer, then the latter references are via that
213*b2ed49a5SDavid van Moolenbroek  * scratch pointer rather than through the repointed (users) symbol.
214*b2ed49a5SDavid van Moolenbroek  */
215*b2ed49a5SDavid van Moolenbroek #define HASH_DELETE(hh,head,delptr)                                              \
216*b2ed49a5SDavid van Moolenbroek do {                                                                             \
217*b2ed49a5SDavid van Moolenbroek     unsigned _hd_bkt;                                                            \
218*b2ed49a5SDavid van Moolenbroek     struct UT_hash_handle *_hd_hh_del;                                           \
219*b2ed49a5SDavid van Moolenbroek     if ( ((delptr)->hh.prev == NULL) && ((delptr)->hh.next == NULL) )  {         \
220*b2ed49a5SDavid van Moolenbroek         uthash_free((head)->hh.tbl->buckets,                                     \
221*b2ed49a5SDavid van Moolenbroek                     (head)->hh.tbl->num_buckets*sizeof(struct UT_hash_bucket) ); \
222*b2ed49a5SDavid van Moolenbroek         HASH_BLOOM_FREE((head)->hh.tbl);                                         \
223*b2ed49a5SDavid van Moolenbroek         uthash_free((head)->hh.tbl, sizeof(UT_hash_table));                      \
224*b2ed49a5SDavid van Moolenbroek         head = NULL;                                                             \
225*b2ed49a5SDavid van Moolenbroek     } else {                                                                     \
226*b2ed49a5SDavid van Moolenbroek         _hd_hh_del = &((delptr)->hh);                                            \
227*b2ed49a5SDavid van Moolenbroek         if ((delptr) == ELMT_FROM_HH((head)->hh.tbl,(head)->hh.tbl->tail)) {     \
228*b2ed49a5SDavid van Moolenbroek             (head)->hh.tbl->tail =                                               \
229*b2ed49a5SDavid van Moolenbroek                 (UT_hash_handle*)((ptrdiff_t)((delptr)->hh.prev) +               \
230*b2ed49a5SDavid van Moolenbroek                 (head)->hh.tbl->hho);                                            \
231*b2ed49a5SDavid van Moolenbroek         }                                                                        \
232*b2ed49a5SDavid van Moolenbroek         if ((delptr)->hh.prev) {                                                 \
233*b2ed49a5SDavid van Moolenbroek             ((UT_hash_handle*)((ptrdiff_t)((delptr)->hh.prev) +                  \
234*b2ed49a5SDavid van Moolenbroek                     (head)->hh.tbl->hho))->next = (delptr)->hh.next;             \
235*b2ed49a5SDavid van Moolenbroek         } else {                                                                 \
236*b2ed49a5SDavid van Moolenbroek             DECLTYPE_ASSIGN(head,(delptr)->hh.next);                             \
237*b2ed49a5SDavid van Moolenbroek         }                                                                        \
238*b2ed49a5SDavid van Moolenbroek         if (_hd_hh_del->next) {                                                  \
239*b2ed49a5SDavid van Moolenbroek             ((UT_hash_handle*)((ptrdiff_t)_hd_hh_del->next +                     \
240*b2ed49a5SDavid van Moolenbroek                     (head)->hh.tbl->hho))->prev =                                \
241*b2ed49a5SDavid van Moolenbroek                     _hd_hh_del->prev;                                            \
242*b2ed49a5SDavid van Moolenbroek         }                                                                        \
243*b2ed49a5SDavid van Moolenbroek         HASH_TO_BKT( _hd_hh_del->hashv, (head)->hh.tbl->num_buckets, _hd_bkt);   \
244*b2ed49a5SDavid van Moolenbroek         HASH_DEL_IN_BKT(hh,(head)->hh.tbl->buckets[_hd_bkt], _hd_hh_del);        \
245*b2ed49a5SDavid van Moolenbroek         (head)->hh.tbl->num_items--;                                             \
246*b2ed49a5SDavid van Moolenbroek     }                                                                            \
247*b2ed49a5SDavid van Moolenbroek     HASH_FSCK(hh,head);                                                          \
248*b2ed49a5SDavid van Moolenbroek } while (0)
249*b2ed49a5SDavid van Moolenbroek 
250*b2ed49a5SDavid van Moolenbroek 
251*b2ed49a5SDavid van Moolenbroek /* convenience forms of HASH_FIND/HASH_ADD/HASH_DEL */
252*b2ed49a5SDavid van Moolenbroek #define HASH_FIND_STR(head,findstr,out)                                          \
253*b2ed49a5SDavid van Moolenbroek     HASH_FIND(hh,head,findstr,strlen(findstr),out)
254*b2ed49a5SDavid van Moolenbroek #define HASH_ADD_STR(head,strfield,add)                                          \
255*b2ed49a5SDavid van Moolenbroek     HASH_ADD(hh,head,strfield,strlen(add->strfield),add)
256*b2ed49a5SDavid van Moolenbroek #define HASH_REPLACE_STR(head,strfield,add,replaced)                             \
257*b2ed49a5SDavid van Moolenbroek   HASH_REPLACE(hh,head,strfield,strlen(add->strfield),add,replaced)
258*b2ed49a5SDavid van Moolenbroek #define HASH_FIND_INT(head,findint,out)                                          \
259*b2ed49a5SDavid van Moolenbroek     HASH_FIND(hh,head,findint,sizeof(int),out)
260*b2ed49a5SDavid van Moolenbroek #define HASH_ADD_INT(head,intfield,add)                                          \
261*b2ed49a5SDavid van Moolenbroek     HASH_ADD(hh,head,intfield,sizeof(int),add)
262*b2ed49a5SDavid van Moolenbroek #define HASH_REPLACE_INT(head,intfield,add,replaced)                             \
263*b2ed49a5SDavid van Moolenbroek     HASH_REPLACE(hh,head,intfield,sizeof(int),add,replaced)
264*b2ed49a5SDavid van Moolenbroek #define HASH_FIND_PTR(head,findptr,out)                                          \
265*b2ed49a5SDavid van Moolenbroek     HASH_FIND(hh,head,findptr,sizeof(void *),out)
266*b2ed49a5SDavid van Moolenbroek #define HASH_ADD_PTR(head,ptrfield,add)                                          \
267*b2ed49a5SDavid van Moolenbroek     HASH_ADD(hh,head,ptrfield,sizeof(void *),add)
268*b2ed49a5SDavid van Moolenbroek #define HASH_REPLACE_PTR(head,ptrfield,add)                                      \
269*b2ed49a5SDavid van Moolenbroek     HASH_REPLACE(hh,head,ptrfield,sizeof(void *),add,replaced)
270*b2ed49a5SDavid van Moolenbroek #define HASH_DEL(head,delptr)                                                    \
271*b2ed49a5SDavid van Moolenbroek     HASH_DELETE(hh,head,delptr)
272*b2ed49a5SDavid van Moolenbroek 
273*b2ed49a5SDavid van Moolenbroek /* HASH_FSCK checks hash integrity on every add/delete when HASH_DEBUG is defined.
274*b2ed49a5SDavid van Moolenbroek  * This is for uthash developer only; it compiles away if HASH_DEBUG isn't defined.
275*b2ed49a5SDavid van Moolenbroek  */
276*b2ed49a5SDavid van Moolenbroek #ifdef HASH_DEBUG
277*b2ed49a5SDavid van Moolenbroek #define HASH_OOPS(...) do { fprintf(stderr,__VA_ARGS__); exit(-1); } while (0)
278*b2ed49a5SDavid van Moolenbroek #define HASH_FSCK(hh,head)                                                       \
279*b2ed49a5SDavid van Moolenbroek do {                                                                             \
280*b2ed49a5SDavid van Moolenbroek     unsigned _bkt_i;                                                             \
281*b2ed49a5SDavid van Moolenbroek     unsigned _count, _bkt_count;                                                 \
282*b2ed49a5SDavid van Moolenbroek     char *_prev;                                                                 \
283*b2ed49a5SDavid van Moolenbroek     struct UT_hash_handle *_thh;                                                 \
284*b2ed49a5SDavid van Moolenbroek     if (head) {                                                                  \
285*b2ed49a5SDavid van Moolenbroek         _count = 0;                                                              \
286*b2ed49a5SDavid van Moolenbroek         for( _bkt_i = 0; _bkt_i < (head)->hh.tbl->num_buckets; _bkt_i++) {       \
287*b2ed49a5SDavid van Moolenbroek             _bkt_count = 0;                                                      \
288*b2ed49a5SDavid van Moolenbroek             _thh = (head)->hh.tbl->buckets[_bkt_i].hh_head;                      \
289*b2ed49a5SDavid van Moolenbroek             _prev = NULL;                                                        \
290*b2ed49a5SDavid van Moolenbroek             while (_thh) {                                                       \
291*b2ed49a5SDavid van Moolenbroek                if (_prev != (char*)(_thh->hh_prev)) {                            \
292*b2ed49a5SDavid van Moolenbroek                    HASH_OOPS("invalid hh_prev %p, actual %p\n",                  \
293*b2ed49a5SDavid van Moolenbroek                     _thh->hh_prev, _prev );                                      \
294*b2ed49a5SDavid van Moolenbroek                }                                                                 \
295*b2ed49a5SDavid van Moolenbroek                _bkt_count++;                                                     \
296*b2ed49a5SDavid van Moolenbroek                _prev = (char*)(_thh);                                            \
297*b2ed49a5SDavid van Moolenbroek                _thh = _thh->hh_next;                                             \
298*b2ed49a5SDavid van Moolenbroek             }                                                                    \
299*b2ed49a5SDavid van Moolenbroek             _count += _bkt_count;                                                \
300*b2ed49a5SDavid van Moolenbroek             if ((head)->hh.tbl->buckets[_bkt_i].count !=  _bkt_count) {          \
301*b2ed49a5SDavid van Moolenbroek                HASH_OOPS("invalid bucket count %d, actual %d\n",                 \
302*b2ed49a5SDavid van Moolenbroek                 (head)->hh.tbl->buckets[_bkt_i].count, _bkt_count);              \
303*b2ed49a5SDavid van Moolenbroek             }                                                                    \
304*b2ed49a5SDavid van Moolenbroek         }                                                                        \
305*b2ed49a5SDavid van Moolenbroek         if (_count != (head)->hh.tbl->num_items) {                               \
306*b2ed49a5SDavid van Moolenbroek             HASH_OOPS("invalid hh item count %d, actual %d\n",                   \
307*b2ed49a5SDavid van Moolenbroek                 (head)->hh.tbl->num_items, _count );                             \
308*b2ed49a5SDavid van Moolenbroek         }                                                                        \
309*b2ed49a5SDavid van Moolenbroek         /* traverse hh in app order; check next/prev integrity, count */         \
310*b2ed49a5SDavid van Moolenbroek         _count = 0;                                                              \
311*b2ed49a5SDavid van Moolenbroek         _prev = NULL;                                                            \
312*b2ed49a5SDavid van Moolenbroek         _thh =  &(head)->hh;                                                     \
313*b2ed49a5SDavid van Moolenbroek         while (_thh) {                                                           \
314*b2ed49a5SDavid van Moolenbroek            _count++;                                                             \
315*b2ed49a5SDavid van Moolenbroek            if (_prev !=(char*)(_thh->prev)) {                                    \
316*b2ed49a5SDavid van Moolenbroek               HASH_OOPS("invalid prev %p, actual %p\n",                          \
317*b2ed49a5SDavid van Moolenbroek                     _thh->prev, _prev );                                         \
318*b2ed49a5SDavid van Moolenbroek            }                                                                     \
319*b2ed49a5SDavid van Moolenbroek            _prev = (char*)ELMT_FROM_HH((head)->hh.tbl, _thh);                    \
320*b2ed49a5SDavid van Moolenbroek            _thh = ( _thh->next ?  (UT_hash_handle*)((char*)(_thh->next) +        \
321*b2ed49a5SDavid van Moolenbroek                                   (head)->hh.tbl->hho) : NULL );                 \
322*b2ed49a5SDavid van Moolenbroek         }                                                                        \
323*b2ed49a5SDavid van Moolenbroek         if (_count != (head)->hh.tbl->num_items) {                               \
324*b2ed49a5SDavid van Moolenbroek             HASH_OOPS("invalid app item count %d, actual %d\n",                  \
325*b2ed49a5SDavid van Moolenbroek                 (head)->hh.tbl->num_items, _count );                             \
326*b2ed49a5SDavid van Moolenbroek         }                                                                        \
327*b2ed49a5SDavid van Moolenbroek     }                                                                            \
328*b2ed49a5SDavid van Moolenbroek } while (0)
329*b2ed49a5SDavid van Moolenbroek #else
330*b2ed49a5SDavid van Moolenbroek #define HASH_FSCK(hh,head)
331*b2ed49a5SDavid van Moolenbroek #endif
332*b2ed49a5SDavid van Moolenbroek 
333*b2ed49a5SDavid van Moolenbroek /* When compiled with -DHASH_EMIT_KEYS, length-prefixed keys are emitted to
334*b2ed49a5SDavid van Moolenbroek  * the descriptor to which this macro is defined for tuning the hash function.
335*b2ed49a5SDavid van Moolenbroek  * The app can #include <unistd.h> to get the prototype for write(2). */
336*b2ed49a5SDavid van Moolenbroek #ifdef HASH_EMIT_KEYS
337*b2ed49a5SDavid van Moolenbroek #define HASH_EMIT_KEY(hh,head,keyptr,fieldlen)                                   \
338*b2ed49a5SDavid van Moolenbroek do {                                                                             \
339*b2ed49a5SDavid van Moolenbroek     unsigned _klen = fieldlen;                                                   \
340*b2ed49a5SDavid van Moolenbroek     write(HASH_EMIT_KEYS, &_klen, sizeof(_klen));                                \
341*b2ed49a5SDavid van Moolenbroek     write(HASH_EMIT_KEYS, keyptr, fieldlen);                                     \
342*b2ed49a5SDavid van Moolenbroek } while (0)
343*b2ed49a5SDavid van Moolenbroek #else
344*b2ed49a5SDavid van Moolenbroek #define HASH_EMIT_KEY(hh,head,keyptr,fieldlen)
345*b2ed49a5SDavid van Moolenbroek #endif
346*b2ed49a5SDavid van Moolenbroek 
347*b2ed49a5SDavid van Moolenbroek /* default to Jenkin's hash unless overridden e.g. DHASH_FUNCTION=HASH_SAX */
348*b2ed49a5SDavid van Moolenbroek #ifdef HASH_FUNCTION
349*b2ed49a5SDavid van Moolenbroek #define HASH_FCN HASH_FUNCTION
350*b2ed49a5SDavid van Moolenbroek #else
351*b2ed49a5SDavid van Moolenbroek #define HASH_FCN HASH_JEN
352*b2ed49a5SDavid van Moolenbroek #endif
353*b2ed49a5SDavid van Moolenbroek 
354*b2ed49a5SDavid van Moolenbroek /* The Bernstein hash function, used in Perl prior to v5.6 */
355*b2ed49a5SDavid van Moolenbroek #define HASH_BER(key,keylen,num_bkts,hashv,bkt)                                  \
356*b2ed49a5SDavid van Moolenbroek do {                                                                             \
357*b2ed49a5SDavid van Moolenbroek   unsigned _hb_keylen=keylen;                                                    \
358*b2ed49a5SDavid van Moolenbroek   char *_hb_key=(char*)(key);                                                    \
359*b2ed49a5SDavid van Moolenbroek   (hashv) = 0;                                                                   \
360*b2ed49a5SDavid van Moolenbroek   while (_hb_keylen--)  { (hashv) = ((hashv) * 33) + *_hb_key++; }               \
361*b2ed49a5SDavid van Moolenbroek   bkt = (hashv) & (num_bkts-1);                                                  \
362*b2ed49a5SDavid van Moolenbroek } while (0)
363*b2ed49a5SDavid van Moolenbroek 
364*b2ed49a5SDavid van Moolenbroek 
365*b2ed49a5SDavid van Moolenbroek /* SAX/FNV/OAT/JEN hash functions are macro variants of those listed at
366*b2ed49a5SDavid van Moolenbroek  * http://eternallyconfuzzled.com/tuts/algorithms/jsw_tut_hashing.aspx */
367*b2ed49a5SDavid van Moolenbroek #define HASH_SAX(key,keylen,num_bkts,hashv,bkt)                                  \
368*b2ed49a5SDavid van Moolenbroek do {                                                                             \
369*b2ed49a5SDavid van Moolenbroek   unsigned _sx_i;                                                                \
370*b2ed49a5SDavid van Moolenbroek   char *_hs_key=(char*)(key);                                                    \
371*b2ed49a5SDavid van Moolenbroek   hashv = 0;                                                                     \
372*b2ed49a5SDavid van Moolenbroek   for(_sx_i=0; _sx_i < keylen; _sx_i++)                                          \
373*b2ed49a5SDavid van Moolenbroek       hashv ^= (hashv << 5) + (hashv >> 2) + _hs_key[_sx_i];                     \
374*b2ed49a5SDavid van Moolenbroek   bkt = hashv & (num_bkts-1);                                                    \
375*b2ed49a5SDavid van Moolenbroek } while (0)
376*b2ed49a5SDavid van Moolenbroek 
377*b2ed49a5SDavid van Moolenbroek #define HASH_FNV(key,keylen,num_bkts,hashv,bkt)                                  \
378*b2ed49a5SDavid van Moolenbroek do {                                                                             \
379*b2ed49a5SDavid van Moolenbroek   unsigned _fn_i;                                                                \
380*b2ed49a5SDavid van Moolenbroek   char *_hf_key=(char*)(key);                                                    \
381*b2ed49a5SDavid van Moolenbroek   hashv = 2166136261UL;                                                          \
382*b2ed49a5SDavid van Moolenbroek   for(_fn_i=0; _fn_i < keylen; _fn_i++)                                          \
383*b2ed49a5SDavid van Moolenbroek       hashv = (hashv * 16777619) ^ _hf_key[_fn_i];                               \
384*b2ed49a5SDavid van Moolenbroek   bkt = hashv & (num_bkts-1);                                                    \
385*b2ed49a5SDavid van Moolenbroek } while(0)
386*b2ed49a5SDavid van Moolenbroek 
387*b2ed49a5SDavid van Moolenbroek #define HASH_OAT(key,keylen,num_bkts,hashv,bkt)                                  \
388*b2ed49a5SDavid van Moolenbroek do {                                                                             \
389*b2ed49a5SDavid van Moolenbroek   unsigned _ho_i;                                                                \
390*b2ed49a5SDavid van Moolenbroek   char *_ho_key=(char*)(key);                                                    \
391*b2ed49a5SDavid van Moolenbroek   hashv = 0;                                                                     \
392*b2ed49a5SDavid van Moolenbroek   for(_ho_i=0; _ho_i < keylen; _ho_i++) {                                        \
393*b2ed49a5SDavid van Moolenbroek       hashv += _ho_key[_ho_i];                                                   \
394*b2ed49a5SDavid van Moolenbroek       hashv += (hashv << 10);                                                    \
395*b2ed49a5SDavid van Moolenbroek       hashv ^= (hashv >> 6);                                                     \
396*b2ed49a5SDavid van Moolenbroek   }                                                                              \
397*b2ed49a5SDavid van Moolenbroek   hashv += (hashv << 3);                                                         \
398*b2ed49a5SDavid van Moolenbroek   hashv ^= (hashv >> 11);                                                        \
399*b2ed49a5SDavid van Moolenbroek   hashv += (hashv << 15);                                                        \
400*b2ed49a5SDavid van Moolenbroek   bkt = hashv & (num_bkts-1);                                                    \
401*b2ed49a5SDavid van Moolenbroek } while(0)
402*b2ed49a5SDavid van Moolenbroek 
403*b2ed49a5SDavid van Moolenbroek #define HASH_JEN_MIX(a,b,c)                                                      \
404*b2ed49a5SDavid van Moolenbroek do {                                                                             \
405*b2ed49a5SDavid van Moolenbroek   a -= b; a -= c; a ^= ( c >> 13 );                                              \
406*b2ed49a5SDavid van Moolenbroek   b -= c; b -= a; b ^= ( a << 8 );                                               \
407*b2ed49a5SDavid van Moolenbroek   c -= a; c -= b; c ^= ( b >> 13 );                                              \
408*b2ed49a5SDavid van Moolenbroek   a -= b; a -= c; a ^= ( c >> 12 );                                              \
409*b2ed49a5SDavid van Moolenbroek   b -= c; b -= a; b ^= ( a << 16 );                                              \
410*b2ed49a5SDavid van Moolenbroek   c -= a; c -= b; c ^= ( b >> 5 );                                               \
411*b2ed49a5SDavid van Moolenbroek   a -= b; a -= c; a ^= ( c >> 3 );                                               \
412*b2ed49a5SDavid van Moolenbroek   b -= c; b -= a; b ^= ( a << 10 );                                              \
413*b2ed49a5SDavid van Moolenbroek   c -= a; c -= b; c ^= ( b >> 15 );                                              \
414*b2ed49a5SDavid van Moolenbroek } while (0)
415*b2ed49a5SDavid van Moolenbroek 
416*b2ed49a5SDavid van Moolenbroek #define HASH_JEN(key,keylen,num_bkts,hashv,bkt)                                  \
417*b2ed49a5SDavid van Moolenbroek do {                                                                             \
418*b2ed49a5SDavid van Moolenbroek   unsigned _hj_i,_hj_j,_hj_k;                                                    \
419*b2ed49a5SDavid van Moolenbroek   unsigned char *_hj_key=(unsigned char*)(key);                                  \
420*b2ed49a5SDavid van Moolenbroek   hashv = 0xfeedbeef;                                                            \
421*b2ed49a5SDavid van Moolenbroek   _hj_i = _hj_j = 0x9e3779b9;                                                    \
422*b2ed49a5SDavid van Moolenbroek   _hj_k = (unsigned)keylen;                                                      \
423*b2ed49a5SDavid van Moolenbroek   while (_hj_k >= 12) {                                                          \
424*b2ed49a5SDavid van Moolenbroek     _hj_i +=    (_hj_key[0] + ( (unsigned)_hj_key[1] << 8 )                      \
425*b2ed49a5SDavid van Moolenbroek         + ( (unsigned)_hj_key[2] << 16 )                                         \
426*b2ed49a5SDavid van Moolenbroek         + ( (unsigned)_hj_key[3] << 24 ) );                                      \
427*b2ed49a5SDavid van Moolenbroek     _hj_j +=    (_hj_key[4] + ( (unsigned)_hj_key[5] << 8 )                      \
428*b2ed49a5SDavid van Moolenbroek         + ( (unsigned)_hj_key[6] << 16 )                                         \
429*b2ed49a5SDavid van Moolenbroek         + ( (unsigned)_hj_key[7] << 24 ) );                                      \
430*b2ed49a5SDavid van Moolenbroek     hashv += (_hj_key[8] + ( (unsigned)_hj_key[9] << 8 )                         \
431*b2ed49a5SDavid van Moolenbroek         + ( (unsigned)_hj_key[10] << 16 )                                        \
432*b2ed49a5SDavid van Moolenbroek         + ( (unsigned)_hj_key[11] << 24 ) );                                     \
433*b2ed49a5SDavid van Moolenbroek                                                                                  \
434*b2ed49a5SDavid van Moolenbroek      HASH_JEN_MIX(_hj_i, _hj_j, hashv);                                          \
435*b2ed49a5SDavid van Moolenbroek                                                                                  \
436*b2ed49a5SDavid van Moolenbroek      _hj_key += 12;                                                              \
437*b2ed49a5SDavid van Moolenbroek      _hj_k -= 12;                                                                \
438*b2ed49a5SDavid van Moolenbroek   }                                                                              \
439*b2ed49a5SDavid van Moolenbroek   hashv += keylen;                                                               \
440*b2ed49a5SDavid van Moolenbroek   switch ( _hj_k ) {                                                             \
441*b2ed49a5SDavid van Moolenbroek      case 11: hashv += ( (unsigned)_hj_key[10] << 24 );                          \
442*b2ed49a5SDavid van Moolenbroek      case 10: hashv += ( (unsigned)_hj_key[9] << 16 );                           \
443*b2ed49a5SDavid van Moolenbroek      case 9:  hashv += ( (unsigned)_hj_key[8] << 8 );                            \
444*b2ed49a5SDavid van Moolenbroek      case 8:  _hj_j += ( (unsigned)_hj_key[7] << 24 );                           \
445*b2ed49a5SDavid van Moolenbroek      case 7:  _hj_j += ( (unsigned)_hj_key[6] << 16 );                           \
446*b2ed49a5SDavid van Moolenbroek      case 6:  _hj_j += ( (unsigned)_hj_key[5] << 8 );                            \
447*b2ed49a5SDavid van Moolenbroek      case 5:  _hj_j += _hj_key[4];                                               \
448*b2ed49a5SDavid van Moolenbroek      case 4:  _hj_i += ( (unsigned)_hj_key[3] << 24 );                           \
449*b2ed49a5SDavid van Moolenbroek      case 3:  _hj_i += ( (unsigned)_hj_key[2] << 16 );                           \
450*b2ed49a5SDavid van Moolenbroek      case 2:  _hj_i += ( (unsigned)_hj_key[1] << 8 );                            \
451*b2ed49a5SDavid van Moolenbroek      case 1:  _hj_i += _hj_key[0];                                               \
452*b2ed49a5SDavid van Moolenbroek   }                                                                              \
453*b2ed49a5SDavid van Moolenbroek   HASH_JEN_MIX(_hj_i, _hj_j, hashv);                                             \
454*b2ed49a5SDavid van Moolenbroek   bkt = hashv & (num_bkts-1);                                                    \
455*b2ed49a5SDavid van Moolenbroek } while(0)
456*b2ed49a5SDavid van Moolenbroek 
457*b2ed49a5SDavid van Moolenbroek /* The Paul Hsieh hash function */
458*b2ed49a5SDavid van Moolenbroek #undef get16bits
459*b2ed49a5SDavid van Moolenbroek #if (defined(__GNUC__) && defined(__i386__)) || defined(__WATCOMC__)             \
460*b2ed49a5SDavid van Moolenbroek   || defined(_MSC_VER) || defined (__BORLANDC__) || defined (__TURBOC__)
461*b2ed49a5SDavid van Moolenbroek #define get16bits(d) (*((const uint16_t *) (d)))
462*b2ed49a5SDavid van Moolenbroek #endif
463*b2ed49a5SDavid van Moolenbroek 
464*b2ed49a5SDavid van Moolenbroek #if !defined (get16bits)
465*b2ed49a5SDavid van Moolenbroek #define get16bits(d) ((((uint32_t)(((const uint8_t *)(d))[1])) << 8)             \
466*b2ed49a5SDavid van Moolenbroek                        +(uint32_t)(((const uint8_t *)(d))[0]) )
467*b2ed49a5SDavid van Moolenbroek #endif
468*b2ed49a5SDavid van Moolenbroek #define HASH_SFH(key,keylen,num_bkts,hashv,bkt)                                  \
469*b2ed49a5SDavid van Moolenbroek do {                                                                             \
470*b2ed49a5SDavid van Moolenbroek   unsigned char *_sfh_key=(unsigned char*)(key);                                 \
471*b2ed49a5SDavid van Moolenbroek   uint32_t _sfh_tmp, _sfh_len = keylen;                                          \
472*b2ed49a5SDavid van Moolenbroek                                                                                  \
473*b2ed49a5SDavid van Moolenbroek   int _sfh_rem = _sfh_len & 3;                                                   \
474*b2ed49a5SDavid van Moolenbroek   _sfh_len >>= 2;                                                                \
475*b2ed49a5SDavid van Moolenbroek   hashv = 0xcafebabe;                                                            \
476*b2ed49a5SDavid van Moolenbroek                                                                                  \
477*b2ed49a5SDavid van Moolenbroek   /* Main loop */                                                                \
478*b2ed49a5SDavid van Moolenbroek   for (;_sfh_len > 0; _sfh_len--) {                                              \
479*b2ed49a5SDavid van Moolenbroek     hashv    += get16bits (_sfh_key);                                            \
480*b2ed49a5SDavid van Moolenbroek     _sfh_tmp       = (uint32_t)(get16bits (_sfh_key+2)) << 11  ^ hashv;          \
481*b2ed49a5SDavid van Moolenbroek     hashv     = (hashv << 16) ^ _sfh_tmp;                                        \
482*b2ed49a5SDavid van Moolenbroek     _sfh_key += 2*sizeof (uint16_t);                                             \
483*b2ed49a5SDavid van Moolenbroek     hashv    += hashv >> 11;                                                     \
484*b2ed49a5SDavid van Moolenbroek   }                                                                              \
485*b2ed49a5SDavid van Moolenbroek                                                                                  \
486*b2ed49a5SDavid van Moolenbroek   /* Handle end cases */                                                         \
487*b2ed49a5SDavid van Moolenbroek   switch (_sfh_rem) {                                                            \
488*b2ed49a5SDavid van Moolenbroek     case 3: hashv += get16bits (_sfh_key);                                       \
489*b2ed49a5SDavid van Moolenbroek             hashv ^= hashv << 16;                                                \
490*b2ed49a5SDavid van Moolenbroek             hashv ^= (uint32_t)(_sfh_key[sizeof (uint16_t)] << 18);              \
491*b2ed49a5SDavid van Moolenbroek             hashv += hashv >> 11;                                                \
492*b2ed49a5SDavid van Moolenbroek             break;                                                               \
493*b2ed49a5SDavid van Moolenbroek     case 2: hashv += get16bits (_sfh_key);                                       \
494*b2ed49a5SDavid van Moolenbroek             hashv ^= hashv << 11;                                                \
495*b2ed49a5SDavid van Moolenbroek             hashv += hashv >> 17;                                                \
496*b2ed49a5SDavid van Moolenbroek             break;                                                               \
497*b2ed49a5SDavid van Moolenbroek     case 1: hashv += *_sfh_key;                                                  \
498*b2ed49a5SDavid van Moolenbroek             hashv ^= hashv << 10;                                                \
499*b2ed49a5SDavid van Moolenbroek             hashv += hashv >> 1;                                                 \
500*b2ed49a5SDavid van Moolenbroek   }                                                                              \
501*b2ed49a5SDavid van Moolenbroek                                                                                  \
502*b2ed49a5SDavid van Moolenbroek     /* Force "avalanching" of final 127 bits */                                  \
503*b2ed49a5SDavid van Moolenbroek     hashv ^= hashv << 3;                                                         \
504*b2ed49a5SDavid van Moolenbroek     hashv += hashv >> 5;                                                         \
505*b2ed49a5SDavid van Moolenbroek     hashv ^= hashv << 4;                                                         \
506*b2ed49a5SDavid van Moolenbroek     hashv += hashv >> 17;                                                        \
507*b2ed49a5SDavid van Moolenbroek     hashv ^= hashv << 25;                                                        \
508*b2ed49a5SDavid van Moolenbroek     hashv += hashv >> 6;                                                         \
509*b2ed49a5SDavid van Moolenbroek     bkt = hashv & (num_bkts-1);                                                  \
510*b2ed49a5SDavid van Moolenbroek } while(0)
511*b2ed49a5SDavid van Moolenbroek 
512*b2ed49a5SDavid van Moolenbroek #ifdef HASH_USING_NO_STRICT_ALIASING
513*b2ed49a5SDavid van Moolenbroek /* The MurmurHash exploits some CPU's (x86,x86_64) tolerance for unaligned reads.
514*b2ed49a5SDavid van Moolenbroek  * For other types of CPU's (e.g. Sparc) an unaligned read causes a bus error.
515*b2ed49a5SDavid van Moolenbroek  * MurmurHash uses the faster approach only on CPU's where we know it's safe.
516*b2ed49a5SDavid van Moolenbroek  *
517*b2ed49a5SDavid van Moolenbroek  * Note the preprocessor built-in defines can be emitted using:
518*b2ed49a5SDavid van Moolenbroek  *
519*b2ed49a5SDavid van Moolenbroek  *   gcc -m64 -dM -E - < /dev/null                  (on gcc)
520*b2ed49a5SDavid van Moolenbroek  *   cc -## a.c (where a.c is a simple test file)   (Sun Studio)
521*b2ed49a5SDavid van Moolenbroek  */
522*b2ed49a5SDavid van Moolenbroek #if (defined(__i386__) || defined(__x86_64__)  || defined(_M_IX86))
523*b2ed49a5SDavid van Moolenbroek #define MUR_GETBLOCK(p,i) p[i]
524*b2ed49a5SDavid van Moolenbroek #else /* non intel */
525*b2ed49a5SDavid van Moolenbroek #define MUR_PLUS0_ALIGNED(p) (((unsigned long)p & 0x3) == 0)
526*b2ed49a5SDavid van Moolenbroek #define MUR_PLUS1_ALIGNED(p) (((unsigned long)p & 0x3) == 1)
527*b2ed49a5SDavid van Moolenbroek #define MUR_PLUS2_ALIGNED(p) (((unsigned long)p & 0x3) == 2)
528*b2ed49a5SDavid van Moolenbroek #define MUR_PLUS3_ALIGNED(p) (((unsigned long)p & 0x3) == 3)
529*b2ed49a5SDavid van Moolenbroek #define WP(p) ((uint32_t*)((unsigned long)(p) & ~3UL))
530*b2ed49a5SDavid van Moolenbroek #if (defined(__BIG_ENDIAN__) || defined(SPARC) || defined(__ppc__) || defined(__ppc64__))
531*b2ed49a5SDavid van Moolenbroek #define MUR_THREE_ONE(p) ((((*WP(p))&0x00ffffff) << 8) | (((*(WP(p)+1))&0xff000000) >> 24))
532*b2ed49a5SDavid van Moolenbroek #define MUR_TWO_TWO(p)   ((((*WP(p))&0x0000ffff) <<16) | (((*(WP(p)+1))&0xffff0000) >> 16))
533*b2ed49a5SDavid van Moolenbroek #define MUR_ONE_THREE(p) ((((*WP(p))&0x000000ff) <<24) | (((*(WP(p)+1))&0xffffff00) >>  8))
534*b2ed49a5SDavid van Moolenbroek #else /* assume little endian non-intel */
535*b2ed49a5SDavid van Moolenbroek #define MUR_THREE_ONE(p) ((((*WP(p))&0xffffff00) >> 8) | (((*(WP(p)+1))&0x000000ff) << 24))
536*b2ed49a5SDavid van Moolenbroek #define MUR_TWO_TWO(p)   ((((*WP(p))&0xffff0000) >>16) | (((*(WP(p)+1))&0x0000ffff) << 16))
537*b2ed49a5SDavid van Moolenbroek #define MUR_ONE_THREE(p) ((((*WP(p))&0xff000000) >>24) | (((*(WP(p)+1))&0x00ffffff) <<  8))
538*b2ed49a5SDavid van Moolenbroek #endif
539*b2ed49a5SDavid van Moolenbroek #define MUR_GETBLOCK(p,i) (MUR_PLUS0_ALIGNED(p) ? ((p)[i]) :           \
540*b2ed49a5SDavid van Moolenbroek                             (MUR_PLUS1_ALIGNED(p) ? MUR_THREE_ONE(p) : \
541*b2ed49a5SDavid van Moolenbroek                              (MUR_PLUS2_ALIGNED(p) ? MUR_TWO_TWO(p) :  \
542*b2ed49a5SDavid van Moolenbroek                                                       MUR_ONE_THREE(p))))
543*b2ed49a5SDavid van Moolenbroek #endif
544*b2ed49a5SDavid van Moolenbroek #define MUR_ROTL32(x,r) (((x) << (r)) | ((x) >> (32 - (r))))
545*b2ed49a5SDavid van Moolenbroek #define MUR_FMIX(_h) \
546*b2ed49a5SDavid van Moolenbroek do {                 \
547*b2ed49a5SDavid van Moolenbroek   _h ^= _h >> 16;    \
548*b2ed49a5SDavid van Moolenbroek   _h *= 0x85ebca6b;  \
549*b2ed49a5SDavid van Moolenbroek   _h ^= _h >> 13;    \
550*b2ed49a5SDavid van Moolenbroek   _h *= 0xc2b2ae35l; \
551*b2ed49a5SDavid van Moolenbroek   _h ^= _h >> 16;    \
552*b2ed49a5SDavid van Moolenbroek } while(0)
553*b2ed49a5SDavid van Moolenbroek 
554*b2ed49a5SDavid van Moolenbroek #define HASH_MUR(key,keylen,num_bkts,hashv,bkt)                        \
555*b2ed49a5SDavid van Moolenbroek do {                                                                   \
556*b2ed49a5SDavid van Moolenbroek   const uint8_t *_mur_data = (const uint8_t*)(key);                    \
557*b2ed49a5SDavid van Moolenbroek   const int _mur_nblocks = (keylen) / 4;                               \
558*b2ed49a5SDavid van Moolenbroek   uint32_t _mur_h1 = 0xf88D5353;                                       \
559*b2ed49a5SDavid van Moolenbroek   uint32_t _mur_c1 = 0xcc9e2d51;                                       \
560*b2ed49a5SDavid van Moolenbroek   uint32_t _mur_c2 = 0x1b873593;                                       \
561*b2ed49a5SDavid van Moolenbroek   uint32_t _mur_k1 = 0;                                                \
562*b2ed49a5SDavid van Moolenbroek   const uint8_t *_mur_tail;                                            \
563*b2ed49a5SDavid van Moolenbroek   const uint32_t *_mur_blocks = (const uint32_t*)(_mur_data+_mur_nblocks*4); \
564*b2ed49a5SDavid van Moolenbroek   int _mur_i;                                                          \
565*b2ed49a5SDavid van Moolenbroek   for(_mur_i = -_mur_nblocks; _mur_i; _mur_i++) {                      \
566*b2ed49a5SDavid van Moolenbroek     _mur_k1 = MUR_GETBLOCK(_mur_blocks,_mur_i);                        \
567*b2ed49a5SDavid van Moolenbroek     _mur_k1 *= _mur_c1;                                                \
568*b2ed49a5SDavid van Moolenbroek     _mur_k1 = MUR_ROTL32(_mur_k1,15);                                  \
569*b2ed49a5SDavid van Moolenbroek     _mur_k1 *= _mur_c2;                                                \
570*b2ed49a5SDavid van Moolenbroek                                                                        \
571*b2ed49a5SDavid van Moolenbroek     _mur_h1 ^= _mur_k1;                                                \
572*b2ed49a5SDavid van Moolenbroek     _mur_h1 = MUR_ROTL32(_mur_h1,13);                                  \
573*b2ed49a5SDavid van Moolenbroek     _mur_h1 = _mur_h1*5+0xe6546b64;                                    \
574*b2ed49a5SDavid van Moolenbroek   }                                                                    \
575*b2ed49a5SDavid van Moolenbroek   _mur_tail = (const uint8_t*)(_mur_data + _mur_nblocks*4);            \
576*b2ed49a5SDavid van Moolenbroek   _mur_k1=0;                                                           \
577*b2ed49a5SDavid van Moolenbroek   switch((keylen) & 3) {                                               \
578*b2ed49a5SDavid van Moolenbroek     case 3: _mur_k1 ^= _mur_tail[2] << 16;                             \
579*b2ed49a5SDavid van Moolenbroek     case 2: _mur_k1 ^= _mur_tail[1] << 8;                              \
580*b2ed49a5SDavid van Moolenbroek     case 1: _mur_k1 ^= _mur_tail[0];                                   \
581*b2ed49a5SDavid van Moolenbroek     _mur_k1 *= _mur_c1;                                                \
582*b2ed49a5SDavid van Moolenbroek     _mur_k1 = MUR_ROTL32(_mur_k1,15);                                  \
583*b2ed49a5SDavid van Moolenbroek     _mur_k1 *= _mur_c2;                                                \
584*b2ed49a5SDavid van Moolenbroek     _mur_h1 ^= _mur_k1;                                                \
585*b2ed49a5SDavid van Moolenbroek   }                                                                    \
586*b2ed49a5SDavid van Moolenbroek   _mur_h1 ^= (keylen);                                                 \
587*b2ed49a5SDavid van Moolenbroek   MUR_FMIX(_mur_h1);                                                   \
588*b2ed49a5SDavid van Moolenbroek   hashv = _mur_h1;                                                     \
589*b2ed49a5SDavid van Moolenbroek   bkt = hashv & (num_bkts-1);                                          \
590*b2ed49a5SDavid van Moolenbroek } while(0)
591*b2ed49a5SDavid van Moolenbroek #endif  /* HASH_USING_NO_STRICT_ALIASING */
592*b2ed49a5SDavid van Moolenbroek 
593*b2ed49a5SDavid van Moolenbroek /* key comparison function; return 0 if keys equal */
594*b2ed49a5SDavid van Moolenbroek #define HASH_KEYCMP(a,b,len) memcmp(a,b,len)
595*b2ed49a5SDavid van Moolenbroek 
596*b2ed49a5SDavid van Moolenbroek /* iterate over items in a known bucket to find desired item */
597*b2ed49a5SDavid van Moolenbroek #define HASH_FIND_IN_BKT(tbl,hh,head,keyptr,keylen_in,out)                       \
598*b2ed49a5SDavid van Moolenbroek do {                                                                             \
599*b2ed49a5SDavid van Moolenbroek  if (head.hh_head) DECLTYPE_ASSIGN(out,ELMT_FROM_HH(tbl,head.hh_head));          \
600*b2ed49a5SDavid van Moolenbroek  else out=NULL;                                                                  \
601*b2ed49a5SDavid van Moolenbroek  while (out) {                                                                   \
602*b2ed49a5SDavid van Moolenbroek     if ((out)->hh.keylen == keylen_in) {                                           \
603*b2ed49a5SDavid van Moolenbroek         if ((HASH_KEYCMP((out)->hh.key,keyptr,keylen_in)) == 0) break;             \
604*b2ed49a5SDavid van Moolenbroek     }                                                                            \
605*b2ed49a5SDavid van Moolenbroek     if ((out)->hh.hh_next) DECLTYPE_ASSIGN(out,ELMT_FROM_HH(tbl,(out)->hh.hh_next)); \
606*b2ed49a5SDavid van Moolenbroek     else out = NULL;                                                             \
607*b2ed49a5SDavid van Moolenbroek  }                                                                               \
608*b2ed49a5SDavid van Moolenbroek } while(0)
609*b2ed49a5SDavid van Moolenbroek 
610*b2ed49a5SDavid van Moolenbroek /* add an item to a bucket  */
611*b2ed49a5SDavid van Moolenbroek #define HASH_ADD_TO_BKT(head,addhh)                                              \
612*b2ed49a5SDavid van Moolenbroek do {                                                                             \
613*b2ed49a5SDavid van Moolenbroek  head.count++;                                                                   \
614*b2ed49a5SDavid van Moolenbroek  (addhh)->hh_next = head.hh_head;                                                \
615*b2ed49a5SDavid van Moolenbroek  (addhh)->hh_prev = NULL;                                                        \
616*b2ed49a5SDavid van Moolenbroek  if (head.hh_head) { (head).hh_head->hh_prev = (addhh); }                        \
617*b2ed49a5SDavid van Moolenbroek  (head).hh_head=addhh;                                                           \
618*b2ed49a5SDavid van Moolenbroek  if (head.count >= ((head.expand_mult+1) * HASH_BKT_CAPACITY_THRESH)             \
619*b2ed49a5SDavid van Moolenbroek      && (addhh)->tbl->noexpand != 1) {                                           \
620*b2ed49a5SDavid van Moolenbroek        HASH_EXPAND_BUCKETS((addhh)->tbl);                                        \
621*b2ed49a5SDavid van Moolenbroek  }                                                                               \
622*b2ed49a5SDavid van Moolenbroek } while(0)
623*b2ed49a5SDavid van Moolenbroek 
624*b2ed49a5SDavid van Moolenbroek /* remove an item from a given bucket */
625*b2ed49a5SDavid van Moolenbroek #define HASH_DEL_IN_BKT(hh,head,hh_del)                                          \
626*b2ed49a5SDavid van Moolenbroek     (head).count--;                                                              \
627*b2ed49a5SDavid van Moolenbroek     if ((head).hh_head == hh_del) {                                              \
628*b2ed49a5SDavid van Moolenbroek       (head).hh_head = hh_del->hh_next;                                          \
629*b2ed49a5SDavid van Moolenbroek     }                                                                            \
630*b2ed49a5SDavid van Moolenbroek     if (hh_del->hh_prev) {                                                       \
631*b2ed49a5SDavid van Moolenbroek         hh_del->hh_prev->hh_next = hh_del->hh_next;                              \
632*b2ed49a5SDavid van Moolenbroek     }                                                                            \
633*b2ed49a5SDavid van Moolenbroek     if (hh_del->hh_next) {                                                       \
634*b2ed49a5SDavid van Moolenbroek         hh_del->hh_next->hh_prev = hh_del->hh_prev;                              \
635*b2ed49a5SDavid van Moolenbroek     }
636*b2ed49a5SDavid van Moolenbroek 
637*b2ed49a5SDavid van Moolenbroek /* Bucket expansion has the effect of doubling the number of buckets
638*b2ed49a5SDavid van Moolenbroek  * and redistributing the items into the new buckets. Ideally the
639*b2ed49a5SDavid van Moolenbroek  * items will distribute more or less evenly into the new buckets
640*b2ed49a5SDavid van Moolenbroek  * (the extent to which this is true is a measure of the quality of
641*b2ed49a5SDavid van Moolenbroek  * the hash function as it applies to the key domain).
642*b2ed49a5SDavid van Moolenbroek  *
643*b2ed49a5SDavid van Moolenbroek  * With the items distributed into more buckets, the chain length
644*b2ed49a5SDavid van Moolenbroek  * (item count) in each bucket is reduced. Thus by expanding buckets
645*b2ed49a5SDavid van Moolenbroek  * the hash keeps a bound on the chain length. This bounded chain
646*b2ed49a5SDavid van Moolenbroek  * length is the essence of how a hash provides constant time lookup.
647*b2ed49a5SDavid van Moolenbroek  *
648*b2ed49a5SDavid van Moolenbroek  * The calculation of tbl->ideal_chain_maxlen below deserves some
649*b2ed49a5SDavid van Moolenbroek  * explanation. First, keep in mind that we're calculating the ideal
650*b2ed49a5SDavid van Moolenbroek  * maximum chain length based on the *new* (doubled) bucket count.
651*b2ed49a5SDavid van Moolenbroek  * In fractions this is just n/b (n=number of items,b=new num buckets).
652*b2ed49a5SDavid van Moolenbroek  * Since the ideal chain length is an integer, we want to calculate
653*b2ed49a5SDavid van Moolenbroek  * ceil(n/b). We don't depend on floating point arithmetic in this
654*b2ed49a5SDavid van Moolenbroek  * hash, so to calculate ceil(n/b) with integers we could write
655*b2ed49a5SDavid van Moolenbroek  *
656*b2ed49a5SDavid van Moolenbroek  *      ceil(n/b) = (n/b) + ((n%b)?1:0)
657*b2ed49a5SDavid van Moolenbroek  *
658*b2ed49a5SDavid van Moolenbroek  * and in fact a previous version of this hash did just that.
659*b2ed49a5SDavid van Moolenbroek  * But now we have improved things a bit by recognizing that b is
660*b2ed49a5SDavid van Moolenbroek  * always a power of two. We keep its base 2 log handy (call it lb),
661*b2ed49a5SDavid van Moolenbroek  * so now we can write this with a bit shift and logical AND:
662*b2ed49a5SDavid van Moolenbroek  *
663*b2ed49a5SDavid van Moolenbroek  *      ceil(n/b) = (n>>lb) + ( (n & (b-1)) ? 1:0)
664*b2ed49a5SDavid van Moolenbroek  *
665*b2ed49a5SDavid van Moolenbroek  */
666*b2ed49a5SDavid van Moolenbroek #define HASH_EXPAND_BUCKETS(tbl)                                                 \
667*b2ed49a5SDavid van Moolenbroek do {                                                                             \
668*b2ed49a5SDavid van Moolenbroek     unsigned _he_bkt;                                                            \
669*b2ed49a5SDavid van Moolenbroek     unsigned _he_bkt_i;                                                          \
670*b2ed49a5SDavid van Moolenbroek     struct UT_hash_handle *_he_thh, *_he_hh_nxt;                                 \
671*b2ed49a5SDavid van Moolenbroek     UT_hash_bucket *_he_new_buckets, *_he_newbkt;                                \
672*b2ed49a5SDavid van Moolenbroek     _he_new_buckets = (UT_hash_bucket*)uthash_malloc(                            \
673*b2ed49a5SDavid van Moolenbroek              2 * tbl->num_buckets * sizeof(struct UT_hash_bucket));              \
674*b2ed49a5SDavid van Moolenbroek     if (!_he_new_buckets) { uthash_fatal( "out of memory"); }                    \
675*b2ed49a5SDavid van Moolenbroek     memset(_he_new_buckets, 0,                                                   \
676*b2ed49a5SDavid van Moolenbroek             2 * tbl->num_buckets * sizeof(struct UT_hash_bucket));               \
677*b2ed49a5SDavid van Moolenbroek     tbl->ideal_chain_maxlen =                                                    \
678*b2ed49a5SDavid van Moolenbroek        (tbl->num_items >> (tbl->log2_num_buckets+1)) +                           \
679*b2ed49a5SDavid van Moolenbroek        ((tbl->num_items & ((tbl->num_buckets*2)-1)) ? 1 : 0);                    \
680*b2ed49a5SDavid van Moolenbroek     tbl->nonideal_items = 0;                                                     \
681*b2ed49a5SDavid van Moolenbroek     for(_he_bkt_i = 0; _he_bkt_i < tbl->num_buckets; _he_bkt_i++)                \
682*b2ed49a5SDavid van Moolenbroek     {                                                                            \
683*b2ed49a5SDavid van Moolenbroek         _he_thh = tbl->buckets[ _he_bkt_i ].hh_head;                             \
684*b2ed49a5SDavid van Moolenbroek         while (_he_thh) {                                                        \
685*b2ed49a5SDavid van Moolenbroek            _he_hh_nxt = _he_thh->hh_next;                                        \
686*b2ed49a5SDavid van Moolenbroek            HASH_TO_BKT( _he_thh->hashv, tbl->num_buckets*2, _he_bkt);            \
687*b2ed49a5SDavid van Moolenbroek            _he_newbkt = &(_he_new_buckets[ _he_bkt ]);                           \
688*b2ed49a5SDavid van Moolenbroek            if (++(_he_newbkt->count) > tbl->ideal_chain_maxlen) {                \
689*b2ed49a5SDavid van Moolenbroek              tbl->nonideal_items++;                                              \
690*b2ed49a5SDavid van Moolenbroek              _he_newbkt->expand_mult = _he_newbkt->count /                       \
691*b2ed49a5SDavid van Moolenbroek                                         tbl->ideal_chain_maxlen;                 \
692*b2ed49a5SDavid van Moolenbroek            }                                                                     \
693*b2ed49a5SDavid van Moolenbroek            _he_thh->hh_prev = NULL;                                              \
694*b2ed49a5SDavid van Moolenbroek            _he_thh->hh_next = _he_newbkt->hh_head;                               \
695*b2ed49a5SDavid van Moolenbroek            if (_he_newbkt->hh_head) _he_newbkt->hh_head->hh_prev =               \
696*b2ed49a5SDavid van Moolenbroek                 _he_thh;                                                         \
697*b2ed49a5SDavid van Moolenbroek            _he_newbkt->hh_head = _he_thh;                                        \
698*b2ed49a5SDavid van Moolenbroek            _he_thh = _he_hh_nxt;                                                 \
699*b2ed49a5SDavid van Moolenbroek         }                                                                        \
700*b2ed49a5SDavid van Moolenbroek     }                                                                            \
701*b2ed49a5SDavid van Moolenbroek     uthash_free( tbl->buckets, tbl->num_buckets*sizeof(struct UT_hash_bucket) ); \
702*b2ed49a5SDavid van Moolenbroek     tbl->num_buckets *= 2;                                                       \
703*b2ed49a5SDavid van Moolenbroek     tbl->log2_num_buckets++;                                                     \
704*b2ed49a5SDavid van Moolenbroek     tbl->buckets = _he_new_buckets;                                              \
705*b2ed49a5SDavid van Moolenbroek     tbl->ineff_expands = (tbl->nonideal_items > (tbl->num_items >> 1)) ?         \
706*b2ed49a5SDavid van Moolenbroek         (tbl->ineff_expands+1) : 0;                                              \
707*b2ed49a5SDavid van Moolenbroek     if (tbl->ineff_expands > 1) {                                                \
708*b2ed49a5SDavid van Moolenbroek         tbl->noexpand=1;                                                         \
709*b2ed49a5SDavid van Moolenbroek         uthash_noexpand_fyi(tbl);                                                \
710*b2ed49a5SDavid van Moolenbroek     }                                                                            \
711*b2ed49a5SDavid van Moolenbroek     uthash_expand_fyi(tbl);                                                      \
712*b2ed49a5SDavid van Moolenbroek } while(0)
713*b2ed49a5SDavid van Moolenbroek 
714*b2ed49a5SDavid van Moolenbroek 
715*b2ed49a5SDavid van Moolenbroek /* This is an adaptation of Simon Tatham's O(n log(n)) mergesort */
716*b2ed49a5SDavid van Moolenbroek /* Note that HASH_SORT assumes the hash handle name to be hh.
717*b2ed49a5SDavid van Moolenbroek  * HASH_SRT was added to allow the hash handle name to be passed in. */
718*b2ed49a5SDavid van Moolenbroek #define HASH_SORT(head,cmpfcn) HASH_SRT(hh,head,cmpfcn)
719*b2ed49a5SDavid van Moolenbroek #define HASH_SRT(hh,head,cmpfcn)                                                 \
720*b2ed49a5SDavid van Moolenbroek do {                                                                             \
721*b2ed49a5SDavid van Moolenbroek   unsigned _hs_i;                                                                \
722*b2ed49a5SDavid van Moolenbroek   unsigned _hs_looping,_hs_nmerges,_hs_insize,_hs_psize,_hs_qsize;               \
723*b2ed49a5SDavid van Moolenbroek   struct UT_hash_handle *_hs_p, *_hs_q, *_hs_e, *_hs_list, *_hs_tail;            \
724*b2ed49a5SDavid van Moolenbroek   if (head) {                                                                    \
725*b2ed49a5SDavid van Moolenbroek       _hs_insize = 1;                                                            \
726*b2ed49a5SDavid van Moolenbroek       _hs_looping = 1;                                                           \
727*b2ed49a5SDavid van Moolenbroek       _hs_list = &((head)->hh);                                                  \
728*b2ed49a5SDavid van Moolenbroek       while (_hs_looping) {                                                      \
729*b2ed49a5SDavid van Moolenbroek           _hs_p = _hs_list;                                                      \
730*b2ed49a5SDavid van Moolenbroek           _hs_list = NULL;                                                       \
731*b2ed49a5SDavid van Moolenbroek           _hs_tail = NULL;                                                       \
732*b2ed49a5SDavid van Moolenbroek           _hs_nmerges = 0;                                                       \
733*b2ed49a5SDavid van Moolenbroek           while (_hs_p) {                                                        \
734*b2ed49a5SDavid van Moolenbroek               _hs_nmerges++;                                                     \
735*b2ed49a5SDavid van Moolenbroek               _hs_q = _hs_p;                                                     \
736*b2ed49a5SDavid van Moolenbroek               _hs_psize = 0;                                                     \
737*b2ed49a5SDavid van Moolenbroek               for ( _hs_i = 0; _hs_i  < _hs_insize; _hs_i++ ) {                  \
738*b2ed49a5SDavid van Moolenbroek                   _hs_psize++;                                                   \
739*b2ed49a5SDavid van Moolenbroek                   _hs_q = (UT_hash_handle*)((_hs_q->next) ?                      \
740*b2ed49a5SDavid van Moolenbroek                           ((void*)((char*)(_hs_q->next) +                        \
741*b2ed49a5SDavid van Moolenbroek                           (head)->hh.tbl->hho)) : NULL);                         \
742*b2ed49a5SDavid van Moolenbroek                   if (! (_hs_q) ) break;                                         \
743*b2ed49a5SDavid van Moolenbroek               }                                                                  \
744*b2ed49a5SDavid van Moolenbroek               _hs_qsize = _hs_insize;                                            \
745*b2ed49a5SDavid van Moolenbroek               while ((_hs_psize > 0) || ((_hs_qsize > 0) && _hs_q )) {           \
746*b2ed49a5SDavid van Moolenbroek                   if (_hs_psize == 0) {                                          \
747*b2ed49a5SDavid van Moolenbroek                       _hs_e = _hs_q;                                             \
748*b2ed49a5SDavid van Moolenbroek                       _hs_q = (UT_hash_handle*)((_hs_q->next) ?                  \
749*b2ed49a5SDavid van Moolenbroek                               ((void*)((char*)(_hs_q->next) +                    \
750*b2ed49a5SDavid van Moolenbroek                               (head)->hh.tbl->hho)) : NULL);                     \
751*b2ed49a5SDavid van Moolenbroek                       _hs_qsize--;                                               \
752*b2ed49a5SDavid van Moolenbroek                   } else if ( (_hs_qsize == 0) || !(_hs_q) ) {                   \
753*b2ed49a5SDavid van Moolenbroek                       _hs_e = _hs_p;                                             \
754*b2ed49a5SDavid van Moolenbroek                       _hs_p = (UT_hash_handle*)((_hs_p->next) ?                  \
755*b2ed49a5SDavid van Moolenbroek                               ((void*)((char*)(_hs_p->next) +                    \
756*b2ed49a5SDavid van Moolenbroek                               (head)->hh.tbl->hho)) : NULL);                     \
757*b2ed49a5SDavid van Moolenbroek                       _hs_psize--;                                               \
758*b2ed49a5SDavid van Moolenbroek                   } else if ((                                                   \
759*b2ed49a5SDavid van Moolenbroek                       cmpfcn(DECLTYPE(head)(ELMT_FROM_HH((head)->hh.tbl,_hs_p)), \
760*b2ed49a5SDavid van Moolenbroek                              DECLTYPE(head)(ELMT_FROM_HH((head)->hh.tbl,_hs_q))) \
761*b2ed49a5SDavid van Moolenbroek                              ) <= 0) {                                           \
762*b2ed49a5SDavid van Moolenbroek                       _hs_e = _hs_p;                                             \
763*b2ed49a5SDavid van Moolenbroek                       _hs_p = (UT_hash_handle*)((_hs_p->next) ?                  \
764*b2ed49a5SDavid van Moolenbroek                               ((void*)((char*)(_hs_p->next) +                    \
765*b2ed49a5SDavid van Moolenbroek                               (head)->hh.tbl->hho)) : NULL);                     \
766*b2ed49a5SDavid van Moolenbroek                       _hs_psize--;                                               \
767*b2ed49a5SDavid van Moolenbroek                   } else {                                                       \
768*b2ed49a5SDavid van Moolenbroek                       _hs_e = _hs_q;                                             \
769*b2ed49a5SDavid van Moolenbroek                       _hs_q = (UT_hash_handle*)((_hs_q->next) ?                  \
770*b2ed49a5SDavid van Moolenbroek                               ((void*)((char*)(_hs_q->next) +                    \
771*b2ed49a5SDavid van Moolenbroek                               (head)->hh.tbl->hho)) : NULL);                     \
772*b2ed49a5SDavid van Moolenbroek                       _hs_qsize--;                                               \
773*b2ed49a5SDavid van Moolenbroek                   }                                                              \
774*b2ed49a5SDavid van Moolenbroek                   if ( _hs_tail ) {                                              \
775*b2ed49a5SDavid van Moolenbroek                       _hs_tail->next = ((_hs_e) ?                                \
776*b2ed49a5SDavid van Moolenbroek                             ELMT_FROM_HH((head)->hh.tbl,_hs_e) : NULL);          \
777*b2ed49a5SDavid van Moolenbroek                   } else {                                                       \
778*b2ed49a5SDavid van Moolenbroek                       _hs_list = _hs_e;                                          \
779*b2ed49a5SDavid van Moolenbroek                   }                                                              \
780*b2ed49a5SDavid van Moolenbroek                   _hs_e->prev = ((_hs_tail) ?                                    \
781*b2ed49a5SDavid van Moolenbroek                      ELMT_FROM_HH((head)->hh.tbl,_hs_tail) : NULL);              \
782*b2ed49a5SDavid van Moolenbroek                   _hs_tail = _hs_e;                                              \
783*b2ed49a5SDavid van Moolenbroek               }                                                                  \
784*b2ed49a5SDavid van Moolenbroek               _hs_p = _hs_q;                                                     \
785*b2ed49a5SDavid van Moolenbroek           }                                                                      \
786*b2ed49a5SDavid van Moolenbroek           _hs_tail->next = NULL;                                                 \
787*b2ed49a5SDavid van Moolenbroek           if ( _hs_nmerges <= 1 ) {                                              \
788*b2ed49a5SDavid van Moolenbroek               _hs_looping=0;                                                     \
789*b2ed49a5SDavid van Moolenbroek               (head)->hh.tbl->tail = _hs_tail;                                   \
790*b2ed49a5SDavid van Moolenbroek               DECLTYPE_ASSIGN(head,ELMT_FROM_HH((head)->hh.tbl, _hs_list));      \
791*b2ed49a5SDavid van Moolenbroek           }                                                                      \
792*b2ed49a5SDavid van Moolenbroek           _hs_insize *= 2;                                                       \
793*b2ed49a5SDavid van Moolenbroek       }                                                                          \
794*b2ed49a5SDavid van Moolenbroek       HASH_FSCK(hh,head);                                                        \
795*b2ed49a5SDavid van Moolenbroek  }                                                                               \
796*b2ed49a5SDavid van Moolenbroek } while (0)
797*b2ed49a5SDavid van Moolenbroek 
798*b2ed49a5SDavid van Moolenbroek /* This function selects items from one hash into another hash.
799*b2ed49a5SDavid van Moolenbroek  * The end result is that the selected items have dual presence
800*b2ed49a5SDavid van Moolenbroek  * in both hashes. There is no copy of the items made; rather
801*b2ed49a5SDavid van Moolenbroek  * they are added into the new hash through a secondary hash
802*b2ed49a5SDavid van Moolenbroek  * hash handle that must be present in the structure. */
803*b2ed49a5SDavid van Moolenbroek #define HASH_SELECT(hh_dst, dst, hh_src, src, cond)                              \
804*b2ed49a5SDavid van Moolenbroek do {                                                                             \
805*b2ed49a5SDavid van Moolenbroek   unsigned _src_bkt, _dst_bkt;                                                   \
806*b2ed49a5SDavid van Moolenbroek   void *_last_elt=NULL, *_elt;                                                   \
807*b2ed49a5SDavid van Moolenbroek   UT_hash_handle *_src_hh, *_dst_hh, *_last_elt_hh=NULL;                         \
808*b2ed49a5SDavid van Moolenbroek   ptrdiff_t _dst_hho = ((char*)(&(dst)->hh_dst) - (char*)(dst));                 \
809*b2ed49a5SDavid van Moolenbroek   if (src) {                                                                     \
810*b2ed49a5SDavid van Moolenbroek     for(_src_bkt=0; _src_bkt < (src)->hh_src.tbl->num_buckets; _src_bkt++) {     \
811*b2ed49a5SDavid van Moolenbroek       for(_src_hh = (src)->hh_src.tbl->buckets[_src_bkt].hh_head;                \
812*b2ed49a5SDavid van Moolenbroek           _src_hh;                                                               \
813*b2ed49a5SDavid van Moolenbroek           _src_hh = _src_hh->hh_next) {                                          \
814*b2ed49a5SDavid van Moolenbroek           _elt = ELMT_FROM_HH((src)->hh_src.tbl, _src_hh);                       \
815*b2ed49a5SDavid van Moolenbroek           if (cond(_elt)) {                                                      \
816*b2ed49a5SDavid van Moolenbroek             _dst_hh = (UT_hash_handle*)(((char*)_elt) + _dst_hho);               \
817*b2ed49a5SDavid van Moolenbroek             _dst_hh->key = _src_hh->key;                                         \
818*b2ed49a5SDavid van Moolenbroek             _dst_hh->keylen = _src_hh->keylen;                                   \
819*b2ed49a5SDavid van Moolenbroek             _dst_hh->hashv = _src_hh->hashv;                                     \
820*b2ed49a5SDavid van Moolenbroek             _dst_hh->prev = _last_elt;                                           \
821*b2ed49a5SDavid van Moolenbroek             _dst_hh->next = NULL;                                                \
822*b2ed49a5SDavid van Moolenbroek             if (_last_elt_hh) { _last_elt_hh->next = _elt; }                     \
823*b2ed49a5SDavid van Moolenbroek             if (!dst) {                                                          \
824*b2ed49a5SDavid van Moolenbroek               DECLTYPE_ASSIGN(dst,_elt);                                         \
825*b2ed49a5SDavid van Moolenbroek               HASH_MAKE_TABLE(hh_dst,dst);                                       \
826*b2ed49a5SDavid van Moolenbroek             } else {                                                             \
827*b2ed49a5SDavid van Moolenbroek               _dst_hh->tbl = (dst)->hh_dst.tbl;                                  \
828*b2ed49a5SDavid van Moolenbroek             }                                                                    \
829*b2ed49a5SDavid van Moolenbroek             HASH_TO_BKT(_dst_hh->hashv, _dst_hh->tbl->num_buckets, _dst_bkt);    \
830*b2ed49a5SDavid van Moolenbroek             HASH_ADD_TO_BKT(_dst_hh->tbl->buckets[_dst_bkt],_dst_hh);            \
831*b2ed49a5SDavid van Moolenbroek             (dst)->hh_dst.tbl->num_items++;                                      \
832*b2ed49a5SDavid van Moolenbroek             _last_elt = _elt;                                                    \
833*b2ed49a5SDavid van Moolenbroek             _last_elt_hh = _dst_hh;                                              \
834*b2ed49a5SDavid van Moolenbroek           }                                                                      \
835*b2ed49a5SDavid van Moolenbroek       }                                                                          \
836*b2ed49a5SDavid van Moolenbroek     }                                                                            \
837*b2ed49a5SDavid van Moolenbroek   }                                                                              \
838*b2ed49a5SDavid van Moolenbroek   HASH_FSCK(hh_dst,dst);                                                         \
839*b2ed49a5SDavid van Moolenbroek } while (0)
840*b2ed49a5SDavid van Moolenbroek 
841*b2ed49a5SDavid van Moolenbroek #define HASH_CLEAR(hh,head)                                                      \
842*b2ed49a5SDavid van Moolenbroek do {                                                                             \
843*b2ed49a5SDavid van Moolenbroek   if (head) {                                                                    \
844*b2ed49a5SDavid van Moolenbroek     uthash_free((head)->hh.tbl->buckets,                                         \
845*b2ed49a5SDavid van Moolenbroek                 (head)->hh.tbl->num_buckets*sizeof(struct UT_hash_bucket));      \
846*b2ed49a5SDavid van Moolenbroek     HASH_BLOOM_FREE((head)->hh.tbl);                                             \
847*b2ed49a5SDavid van Moolenbroek     uthash_free((head)->hh.tbl, sizeof(UT_hash_table));                          \
848*b2ed49a5SDavid van Moolenbroek     (head)=NULL;                                                                 \
849*b2ed49a5SDavid van Moolenbroek   }                                                                              \
850*b2ed49a5SDavid van Moolenbroek } while(0)
851*b2ed49a5SDavid van Moolenbroek 
852*b2ed49a5SDavid van Moolenbroek #define HASH_OVERHEAD(hh,head)                                                   \
853*b2ed49a5SDavid van Moolenbroek  (size_t)((((head)->hh.tbl->num_items   * sizeof(UT_hash_handle))   +            \
854*b2ed49a5SDavid van Moolenbroek            ((head)->hh.tbl->num_buckets * sizeof(UT_hash_bucket))   +            \
855*b2ed49a5SDavid van Moolenbroek             (sizeof(UT_hash_table))                                 +            \
856*b2ed49a5SDavid van Moolenbroek             (HASH_BLOOM_BYTELEN)))
857*b2ed49a5SDavid van Moolenbroek 
858*b2ed49a5SDavid van Moolenbroek #ifdef NO_DECLTYPE
859*b2ed49a5SDavid van Moolenbroek #define HASH_ITER(hh,head,el,tmp)                                                \
860*b2ed49a5SDavid van Moolenbroek for((el)=(head), (*(char**)(&(tmp)))=(char*)((head)?(head)->hh.next:NULL);       \
861*b2ed49a5SDavid van Moolenbroek   el; (el)=(tmp),(*(char**)(&(tmp)))=(char*)((tmp)?(tmp)->hh.next:NULL))
862*b2ed49a5SDavid van Moolenbroek #else
863*b2ed49a5SDavid van Moolenbroek #define HASH_ITER(hh,head,el,tmp)                                                \
864*b2ed49a5SDavid van Moolenbroek for((el)=(head),(tmp)=DECLTYPE(el)((head)?(head)->hh.next:NULL);                 \
865*b2ed49a5SDavid van Moolenbroek   el; (el)=(tmp),(tmp)=DECLTYPE(el)((tmp)?(tmp)->hh.next:NULL))
866*b2ed49a5SDavid van Moolenbroek #endif
867*b2ed49a5SDavid van Moolenbroek 
868*b2ed49a5SDavid van Moolenbroek /* obtain a count of items in the hash */
869*b2ed49a5SDavid van Moolenbroek #define HASH_COUNT(head) HASH_CNT(hh,head)
870*b2ed49a5SDavid van Moolenbroek #define HASH_CNT(hh,head) ((head)?((head)->hh.tbl->num_items):0)
871*b2ed49a5SDavid van Moolenbroek 
872*b2ed49a5SDavid van Moolenbroek typedef struct UT_hash_bucket {
873*b2ed49a5SDavid van Moolenbroek    struct UT_hash_handle *hh_head;
874*b2ed49a5SDavid van Moolenbroek    unsigned count;
875*b2ed49a5SDavid van Moolenbroek 
876*b2ed49a5SDavid van Moolenbroek    /* expand_mult is normally set to 0. In this situation, the max chain length
877*b2ed49a5SDavid van Moolenbroek     * threshold is enforced at its default value, HASH_BKT_CAPACITY_THRESH. (If
878*b2ed49a5SDavid van Moolenbroek     * the bucket's chain exceeds this length, bucket expansion is triggered).
879*b2ed49a5SDavid van Moolenbroek     * However, setting expand_mult to a non-zero value delays bucket expansion
880*b2ed49a5SDavid van Moolenbroek     * (that would be triggered by additions to this particular bucket)
881*b2ed49a5SDavid van Moolenbroek     * until its chain length reaches a *multiple* of HASH_BKT_CAPACITY_THRESH.
882*b2ed49a5SDavid van Moolenbroek     * (The multiplier is simply expand_mult+1). The whole idea of this
883*b2ed49a5SDavid van Moolenbroek     * multiplier is to reduce bucket expansions, since they are expensive, in
884*b2ed49a5SDavid van Moolenbroek     * situations where we know that a particular bucket tends to be overused.
885*b2ed49a5SDavid van Moolenbroek     * It is better to let its chain length grow to a longer yet-still-bounded
886*b2ed49a5SDavid van Moolenbroek     * value, than to do an O(n) bucket expansion too often.
887*b2ed49a5SDavid van Moolenbroek     */
888*b2ed49a5SDavid van Moolenbroek    unsigned expand_mult;
889*b2ed49a5SDavid van Moolenbroek 
890*b2ed49a5SDavid van Moolenbroek } UT_hash_bucket;
891*b2ed49a5SDavid van Moolenbroek 
892*b2ed49a5SDavid van Moolenbroek /* random signature used only to find hash tables in external analysis */
893*b2ed49a5SDavid van Moolenbroek #define HASH_SIGNATURE 0xa0111fe1
894*b2ed49a5SDavid van Moolenbroek #define HASH_BLOOM_SIGNATURE 0xb12220f2
895*b2ed49a5SDavid van Moolenbroek 
896*b2ed49a5SDavid van Moolenbroek typedef struct UT_hash_table {
897*b2ed49a5SDavid van Moolenbroek    UT_hash_bucket *buckets;
898*b2ed49a5SDavid van Moolenbroek    unsigned num_buckets, log2_num_buckets;
899*b2ed49a5SDavid van Moolenbroek    unsigned num_items;
900*b2ed49a5SDavid van Moolenbroek    struct UT_hash_handle *tail; /* tail hh in app order, for fast append    */
901*b2ed49a5SDavid van Moolenbroek    ptrdiff_t hho; /* hash handle offset (byte pos of hash handle in element */
902*b2ed49a5SDavid van Moolenbroek 
903*b2ed49a5SDavid van Moolenbroek    /* in an ideal situation (all buckets used equally), no bucket would have
904*b2ed49a5SDavid van Moolenbroek     * more than ceil(#items/#buckets) items. that's the ideal chain length. */
905*b2ed49a5SDavid van Moolenbroek    unsigned ideal_chain_maxlen;
906*b2ed49a5SDavid van Moolenbroek 
907*b2ed49a5SDavid van Moolenbroek    /* nonideal_items is the number of items in the hash whose chain position
908*b2ed49a5SDavid van Moolenbroek     * exceeds the ideal chain maxlen. these items pay the penalty for an uneven
909*b2ed49a5SDavid van Moolenbroek     * hash distribution; reaching them in a chain traversal takes >ideal steps */
910*b2ed49a5SDavid van Moolenbroek    unsigned nonideal_items;
911*b2ed49a5SDavid van Moolenbroek 
912*b2ed49a5SDavid van Moolenbroek    /* ineffective expands occur when a bucket doubling was performed, but
913*b2ed49a5SDavid van Moolenbroek     * afterward, more than half the items in the hash had nonideal chain
914*b2ed49a5SDavid van Moolenbroek     * positions. If this happens on two consecutive expansions we inhibit any
915*b2ed49a5SDavid van Moolenbroek     * further expansion, as it's not helping; this happens when the hash
916*b2ed49a5SDavid van Moolenbroek     * function isn't a good fit for the key domain. When expansion is inhibited
917*b2ed49a5SDavid van Moolenbroek     * the hash will still work, albeit no longer in constant time. */
918*b2ed49a5SDavid van Moolenbroek    unsigned ineff_expands, noexpand;
919*b2ed49a5SDavid van Moolenbroek 
920*b2ed49a5SDavid van Moolenbroek    uint32_t signature; /* used only to find hash tables in external analysis */
921*b2ed49a5SDavid van Moolenbroek #ifdef HASH_BLOOM
922*b2ed49a5SDavid van Moolenbroek    uint32_t bloom_sig; /* used only to test bloom exists in external analysis */
923*b2ed49a5SDavid van Moolenbroek    uint8_t *bloom_bv;
924*b2ed49a5SDavid van Moolenbroek    char bloom_nbits;
925*b2ed49a5SDavid van Moolenbroek #endif
926*b2ed49a5SDavid van Moolenbroek 
927*b2ed49a5SDavid van Moolenbroek } UT_hash_table;
928*b2ed49a5SDavid van Moolenbroek 
929*b2ed49a5SDavid van Moolenbroek typedef struct UT_hash_handle {
930*b2ed49a5SDavid van Moolenbroek    struct UT_hash_table *tbl;
931*b2ed49a5SDavid van Moolenbroek    void *prev;                       /* prev element in app order      */
932*b2ed49a5SDavid van Moolenbroek    void *next;                       /* next element in app order      */
933*b2ed49a5SDavid van Moolenbroek    struct UT_hash_handle *hh_prev;   /* previous hh in bucket order    */
934*b2ed49a5SDavid van Moolenbroek    struct UT_hash_handle *hh_next;   /* next hh in bucket order        */
935*b2ed49a5SDavid van Moolenbroek    void *key;                        /* ptr to enclosing struct's key  */
936*b2ed49a5SDavid van Moolenbroek    unsigned keylen;                  /* enclosing struct's key len     */
937*b2ed49a5SDavid van Moolenbroek    unsigned hashv;                   /* result of hash-fcn(key)        */
938*b2ed49a5SDavid van Moolenbroek } UT_hash_handle;
939*b2ed49a5SDavid van Moolenbroek 
940*b2ed49a5SDavid van Moolenbroek #endif /* UTHASH_H */
941