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