xf86drmHash.c

   1 /* xf86drmHash.c -- Small hash table support for integer -> integer mapping
   2  * Created: Sun Apr 18 09:35:45 1999 by faith@precisioninsight.com
   3  *
   4  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
   5  * All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the next
  15  * paragraph) shall be included in all copies or substantial portions of the
  16  * Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  21  * PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  22  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  23  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24  * DEALINGS IN THE SOFTWARE.
  25  *
  26  * Authors: Rickard E. (Rik) Faith <faith@valinux.com>
  27  *
  28  * DESCRIPTION
  29  *
  30  * This file contains a straightforward implementation of a fixed-sized
  31  * hash table using self-organizing linked lists [Knuth73, pp. 398-399] for
  32  * collision resolution.  There are two potentially interesting things
  33  * about this implementation:
  34  *
  35  * 1) The table is power-of-two sized.  Prime sized tables are more
  36  * traditional, but do not have a significant advantage over power-of-two
  37  * sized table, especially when double hashing is not used for collision
  38  * resolution.
  39  *
  40  * 2) The hash computation uses a table of random integers [Hanson97,
  41  * pp. 39-41].
  42  *
  43  * FUTURE ENHANCEMENTS
  44  *
  45  * With a table size of 512, the current implementation is sufficient for a
  46  * few hundred keys.  Since this is well above the expected size of the
  47  * tables for which this implementation was designed, the implementation of
  48  * dynamic hash tables was postponed until the need arises.  A common (and
  49  * naive) approach to dynamic hash table implementation simply creates a
  50  * new hash table when necessary, rehashes all the data into the new table,
  51  * and destroys the old table.  The approach in [Larson88] is superior in
  52  * two ways: 1) only a portion of the table is expanded when needed,
  53  * distributing the expansion cost over several insertions, and 2) portions
  54  * of the table can be locked, enabling a scalable thread-safe
  55  * implementation.
  56  *
  57  * REFERENCES
  58  *
  59  * [Hanson97] David R. Hanson.  C Interfaces and Implementations:
  60  * Techniques for Creating Reusable Software.  Reading, Massachusetts:
  61  * Addison-Wesley, 1997.
  62  *
  63  * [Knuth73] Donald E. Knuth. The Art of Computer Programming.  Volume 3:
  64  * Sorting and Searching.  Reading, Massachusetts: Addison-Wesley, 1973.
  65  *
  66  * [Larson88] Per-Ake Larson. "Dynamic Hash Tables".  CACM 31(4), April
  67  * 1988, pp. 446-457.
  68  *
  69  */
  70
  71 #include <stdio.h>
  72 #include <stdlib.h>
  73
  74 #include "xf86drm.h"
  75 #include "xf86drmHash.h"
  76
  77 #define HASH_MAGIC 0xdeadbeef
  78 #define HASH_DEBUG 0
  79
  80 static unsigned long HashHash(unsigned long key)
  81 {
  82     unsigned long        hash = 0;
  83     unsigned long        tmp  = key;
  84     static int           init = 0;
  85     static unsigned long scatter[256];
  86     int                  i;
  87
  88     if (!init) {
  89         void *state;
  90         state = drmRandomCreate(37);
  91         for (i = 0; i < 256; i++) scatter[i] = drmRandom(state);
  92         drmRandomDestroy(state);
  93         ++init;
  94     }
  95
  96     while (tmp) {
  97         hash = (hash << 1) + scatter[tmp & 0xff];
  98         tmp >>= 8;
  99     }
 100
 101     hash %= HASH_SIZE;
 102 #if HASH_DEBUG
 103     printf( "Hash(%d) = %d\n", key, hash);
 104 #endif
 105     return hash;
 106 }
 107
 108 void *drmHashCreate(void)
 109 {
 110     HashTablePtr table;
 111     int          i;
 112
 113     table           = drmMalloc(sizeof(*table));
 114     if (!table) return NULL;
 115     table->magic    = HASH_MAGIC;
 116     table->entries  = 0;
 117     table->hits     = 0;
 118     table->partials = 0;
 119     table->misses   = 0;
 120
 121     for (i = 0; i < HASH_SIZE; i++) table->buckets[i] = NULL;
 122     return table;
 123 }
 124
 125 int drmHashDestroy(void *t)
 126 {
 127     HashTablePtr  table = (HashTablePtr)t;
 128     HashBucketPtr bucket;
 129     HashBucketPtr next;
 130     int           i;
 131
 132     if (table->magic != HASH_MAGIC) return -1; /* Bad magic */
 133
 134     for (i = 0; i < HASH_SIZE; i++) {
 135         for (bucket = table->buckets[i]; bucket;) {
 136             next = bucket->next;
 137             drmFree(bucket);
 138             bucket = next;
 139         }
 140     }
 141     drmFree(table);
 142     return 0;
 143 }
 144
 145 /* Find the bucket and organize the list so that this bucket is at the
 146    top. */
 147
 148 static HashBucketPtr HashFind(HashTablePtr table,
 149                               unsigned long key, unsigned long *h)
 150 {
 151     unsigned long hash = HashHash(key);
 152     HashBucketPtr prev = NULL;
 153     HashBucketPtr bucket;
 154
 155     if (h) *h = hash;
 156
 157     for (bucket = table->buckets[hash]; bucket; bucket = bucket->next) {
 158         if (bucket->key == key) {
 159             if (prev) {
 160                                 /* Organize */
 161                 prev->next           = bucket->next;
 162                 bucket->next         = table->buckets[hash];
 163                 table->buckets[hash] = bucket;
 164                 ++table->partials;
 165             } else {
 166                 ++table->hits;
 167             }
 168             return bucket;
 169         }
 170         prev = bucket;
 171     }
 172     ++table->misses;
 173     return NULL;
 174 }
 175
 176 int drmHashLookup(void *t, unsigned long key, void **value)
 177 {
 178     HashTablePtr  table = (HashTablePtr)t;
 179     HashBucketPtr bucket;
 180
 181     if (!table || table->magic != HASH_MAGIC) return -1; /* Bad magic */
 182
 183     bucket = HashFind(table, key, NULL);
 184     if (!bucket) return 1;      /* Not found */
 185     *value = bucket->value;
 186     return 0;                   /* Found */
 187 }
 188
 189 int drmHashInsert(void *t, unsigned long key, void *value)
 190 {
 191     HashTablePtr  table = (HashTablePtr)t;
 192     HashBucketPtr bucket;
 193     unsigned long hash;
 194
 195     if (table->magic != HASH_MAGIC) return -1; /* Bad magic */
 196
 197     if (HashFind(table, key, &hash)) return 1; /* Already in table */
 198
 199     bucket               = drmMalloc(sizeof(*bucket));
 200     if (!bucket) return -1;     /* Error */
 201     bucket->key          = key;
 202     bucket->value        = value;
 203     bucket->next         = table->buckets[hash];
 204     table->buckets[hash] = bucket;
 205 #if HASH_DEBUG
 206     printf("Inserted %d at %d/%p\n", key, hash, bucket);
 207 #endif
 208     return 0;                   /* Added to table */
 209 }
 210
 211 int drmHashDelete(void *t, unsigned long key)
 212 {
 213     HashTablePtr  table = (HashTablePtr)t;
 214     unsigned long hash;
 215     HashBucketPtr bucket;
 216
 217     if (table->magic != HASH_MAGIC) return -1; /* Bad magic */
 218
 219     bucket = HashFind(table, key, &hash);
 220
 221     if (!bucket) return 1;      /* Not found */
 222
 223     table->buckets[hash] = bucket->next;
 224     drmFree(bucket);
 225     return 0;
 226 }
 227
 228 int drmHashNext(void *t, unsigned long *key, void **value)
 229 {
 230     HashTablePtr  table = (HashTablePtr)t;
 231
 232     while (table->p0 < HASH_SIZE) {
 233         if (table->p1) {
 234             *key       = table->p1->key;
 235             *value     = table->p1->value;
 236             table->p1  = table->p1->next;
 237             return 1;
 238         }
 239         table->p1 = table->buckets[table->p0];
 240         ++table->p0;
 241     }
 242     return 0;
 243 }
 244
 245 int drmHashFirst(void *t, unsigned long *key, void **value)
 246 {
 247     HashTablePtr  table = (HashTablePtr)t;
 248
 249     if (table->magic != HASH_MAGIC) return -1; /* Bad magic */
 250
 251     table->p0 = 0;
 252     table->p1 = table->buckets[0];
 253     return drmHashNext(table, key, value);
 254 }