lib/hash.c

   1 /***************************************************************************
   2  *                                  _   _ ____  _
   3  *  Project                     ___| | | |  _ \| |
   4  *                             / __| | | | |_) | |
   5  *                            | (__| |_| |  _ <| |___
   6  *                             \___|\___/|_| \_\_____|
   7  *
   8  * Copyright (C) 1998 - 2008, Daniel Stenberg, <daniel@haxx.se>, et al.
   9  *
  10  * This software is licensed as described in the file COPYING, which
  11  * you should have received as part of this distribution. The terms
  12  * are also available at http://curl.haxx.se/docs/copyright.html.
  13  *
  14  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15  * copies of the Software, and permit persons to whom the Software is
  16  * furnished to do so, under the terms of the COPYING file.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  * $Id$
  22  ***************************************************************************/
  23
  24 #include "setup.h"
  25
  26 #include <string.h>
  27 #include <stdlib.h>
  28
  29 #include "hash.h"
  30 #include "llist.h"
  31 #include "memory.h"
  32
  33 /* this must be the last include file */
  34 #include "memdebug.h"
  35
  36 static void
  37 hash_element_dtor(void *user, void *element)
  38 {
  39   struct curl_hash *h = (struct curl_hash *) user;
  40   struct curl_hash_element *e = (struct curl_hash_element *) element;
  41
  42   if(e->key)
  43     free(e->key);
  44
  45   h->dtor(e->ptr);
  46
  47   free(e);
  48 }
  49
  50 /* return 1 on error, 0 is fine */
  51 int
  52 Curl_hash_init(struct curl_hash *h,
  53                int slots,
  54                hash_function hfunc,
  55                comp_function comparator,
  56                curl_hash_dtor dtor)
  57 {
  58   int i;
  59
  60   if(!slots || !hfunc || !comparator ||!dtor) {
  61     return 1; /* failure */
  62   }
  63
  64   h->hash_func = hfunc;
  65   h->comp_func = comparator;
  66   h->dtor = dtor;
  67   h->size = 0;
  68   h->slots = slots;
  69
  70   h->table = malloc(slots * sizeof(struct curl_llist *));
  71   if(h->table) {
  72     for (i = 0; i < slots; ++i) {
  73       h->table[i] = Curl_llist_alloc((curl_llist_dtor) hash_element_dtor);
  74       if(!h->table[i]) {
  75         while(i--)
  76           Curl_llist_destroy(h->table[i], NULL);
  77         free(h->table);
  78         return 1; /* failure */
  79       }
  80     }
  81     return 0; /* fine */
  82   }
  83   else
  84     return 1; /* failure */
  85 }
  86
  87 struct curl_hash *
  88 Curl_hash_alloc(int slots,
  89                 hash_function hfunc,
  90                 comp_function comparator,
  91                 curl_hash_dtor dtor)
  92 {
  93   struct curl_hash *h;
  94
  95   if(!slots || !hfunc || !comparator ||!dtor) {
  96     return NULL; /* failure */
  97   }
  98
  99   h = malloc(sizeof(struct curl_hash));
 100   if(h) {
 101     if(Curl_hash_init(h, slots, hfunc, comparator, dtor)) {
 102       /* failure */
 103       free(h);
 104       h = NULL;
 105     }
 106   }
 107
 108   return h;
 109 }
 110
 111
 112
 113 static struct curl_hash_element *
 114 mk_hash_element(const void *key, size_t key_len, const void *p)
 115 {
 116   struct curl_hash_element *he = malloc(sizeof(struct curl_hash_element));
 117
 118   if(he) {
 119     void *dupkey = malloc(key_len);
 120     if(dupkey) {
 121       /* copy the key */
 122       memcpy(dupkey, key, key_len);
 123
 124       he->key = dupkey;
 125       he->key_len = key_len;
 126       he->ptr = (void *) p;
 127     }
 128     else {
 129       /* failed to duplicate the key, free memory and fail */
 130       free(he);
 131       he = NULL;
 132     }
 133   }
 134   return he;
 135 }
 136
 137 #define FETCH_LIST(x,y,z) x->table[x->hash_func(y, z, x->slots)]
 138
 139 /* Return the data in the hash. If there already was a match in the hash,
 140    that data is returned. */
 141 void *
 142 Curl_hash_add(struct curl_hash *h, void *key, size_t key_len, void *p)
 143 {
 144   struct curl_hash_element  *he;
 145   struct curl_llist_element *le;
 146   struct curl_llist *l = FETCH_LIST (h, key, key_len);
 147
 148   for (le = l->head; le; le = le->next) {
 149     he = (struct curl_hash_element *) le->ptr;
 150     if(h->comp_func(he->key, he->key_len, key, key_len)) {
 151       h->dtor(p);     /* remove the NEW entry */
 152       return he->ptr; /* return the EXISTING entry */
 153     }
 154   }
 155
 156   he = mk_hash_element(key, key_len, p);
 157   if(he) {
 158     if(Curl_llist_insert_next(l, l->tail, he)) {
 159       ++h->size;
 160       return p; /* return the new entry */
 161     }
 162     /*
 163      * Couldn't insert it, destroy the 'he' element and the key again. We
 164      * don't call hash_element_dtor() since that would also call the
 165      * "destructor" for the actual data 'p'. When we fail, we shall not touch
 166      * that data.
 167      */
 168     free(he->key);
 169     free(he);
 170   }
 171
 172   return NULL; /* failure */
 173 }
 174
 175 /* remove the identified hash entry, returns non-zero on failure */
 176 int Curl_hash_delete(struct curl_hash *h, void *key, size_t key_len)
 177 {
 178   struct curl_llist_element *le;
 179   struct curl_hash_element  *he;
 180   struct curl_llist *l = FETCH_LIST(h, key, key_len);
 181
 182   for (le = l->head; le; le = le->next) {
 183     he = le->ptr;
 184     if(h->comp_func(he->key, he->key_len, key, key_len)) {
 185       Curl_llist_remove(l, le, (void *) h);
 186       return 0;
 187     }
 188   }
 189   return 1;
 190 }
 191
 192 void *
 193 Curl_hash_pick(struct curl_hash *h, void *key, size_t key_len)
 194 {
 195   struct curl_llist_element *le;
 196   struct curl_hash_element  *he;
 197   struct curl_llist *l = FETCH_LIST(h, key, key_len);
 198
 199   for (le = l->head; le; le = le->next) {
 200     he = le->ptr;
 201     if(h->comp_func(he->key, he->key_len, key, key_len)) {
 202       return he->ptr;
 203     }
 204   }
 205
 206   return NULL;
 207 }
 208
 209 #if defined(CURLDEBUG) && defined(AGGRESIVE_TEST)
 210 void
 211 Curl_hash_apply(curl_hash *h, void *user,
 212                 void (*cb)(void *user, void *ptr))
 213 {
 214   struct curl_llist_element  *le;
 215   int                  i;
 216
 217   for (i = 0; i < h->slots; ++i) {
 218     for (le = (h->table[i])->head;
 219          le;
 220          le = le->next) {
 221       curl_hash_element *el = le->ptr;
 222       cb(user, el->ptr);
 223     }
 224   }
 225 }
 226 #endif
 227
 228 void
 229 Curl_hash_clean(struct curl_hash *h)
 230 {
 231   int i;
 232
 233   for (i = 0; i < h->slots; ++i) {
 234     Curl_llist_destroy(h->table[i], (void *) h);
 235     h->table[i] = NULL;
 236   }
 237
 238   free(h->table);
 239 }
 240
 241 void
 242 Curl_hash_clean_with_criterium(struct curl_hash *h, void *user,
 243                                int (*comp)(void *, void *))
 244 {
 245   struct curl_llist_element *le;
 246   struct curl_llist_element *lnext;
 247   struct curl_llist *list;
 248   int i;
 249
 250   for (i = 0; i < h->slots; ++i) {
 251     list = h->table[i];
 252     le = list->head; /* get first list entry */
 253     while(le) {
 254       struct curl_hash_element *he = le->ptr;
 255       lnext = le->next;
 256       /* ask the callback function if we shall remove this entry or not */
 257       if(comp(user, he->ptr)) {
 258         Curl_llist_remove(list, le, (void *) h);
 259         --h->size; /* one less entry in the hash now */
 260       }
 261       le = lnext;
 262     }
 263   }
 264 }
 265
 266 void
 267 Curl_hash_destroy(struct curl_hash *h)
 268 {
 269   if(!h)
 270     return;
 271
 272   Curl_hash_clean(h);
 273
 274   free(h);
 275 }
 276
 277 size_t Curl_hash_str(void* key, size_t key_length, size_t slots_num)
 278 {
 279   const char* key_str = (const char *) key;
 280   const char *end = key_str + key_length;
 281   unsigned long h = 5381;
 282
 283   while(key_str < end) {
 284     h += h << 5;
 285     h ^= (unsigned long) *key_str++;
 286   }
 287
 288   return (h % slots_num);
 289 }
 290
 291 size_t Curl_str_key_compare(void*k1, size_t key1_len, void*k2, size_t key2_len)
 292 {
 293   char *key1 = (char *)k1;
 294   char *key2 = (char *)k2;
 295
 296   if(key1_len == key2_len &&
 297       *key1 == *key2 &&
 298       memcmp(key1, key2, key1_len) == 0) {
 299     return 1;
 300   }
 301
 302   return 0;
 303 }
 304
 305 #if 0 /* useful function for debugging hashes and their contents */
 306 void Curl_hash_print(struct curl_hash *h,
 307                      void (*func)(void *))
 308 {
 309   int i;
 310   struct curl_llist_element *le;
 311   struct curl_llist *list;
 312   struct curl_hash_element  *he;
 313   if(!h)
 314     return;
 315
 316   fprintf(stderr, "=Hash dump=\n");
 317
 318   for (i = 0; i < h->slots; i++) {
 319     list = h->table[i];
 320     le = list->head; /* get first list entry */
 321     if(le) {
 322       fprintf(stderr, "index %d:", i);
 323       while(le) {
 324         he = le->ptr;
 325         if(func)
 326           func(he->ptr);
 327         else
 328           fprintf(stderr, " [%p]", he->ptr);
 329         le = le->next;
 330       }
 331       fprintf(stderr, "\n");
 332     }
 333   }
 334 }
 335 #endif