nsz Git - libfirm/blob - ir/adt/set.c

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/adt/set.c
   4  * Purpose:     Set --- collection of entries that are unique wrt to a key.
   5  * Author:      Markus Armbruster
   6  * Modified by:
   7  * Created:     1999 by getting from fiasco
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1995, 1996 Markus Armbruster
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13 /*  This code is derived from:
  14
  15     From: ejp@ausmelb.oz.AU (Esmond Pitt)
  16     Date: Tue, 7 Mar 1989 22:06:26 GMT
  17     Subject: v06i042: dynamic hashing version of hsearch(3)
  18     Message-ID: <1821@basser.oz>
  19     Newsgroups: comp.sources.misc
  20     Sender: msgs@basser.oz
  21
  22     Posting-number: Volume 6, Issue 42
  23     Submitted-By: Esmond Pitt <ejp@ausmelb.oz.AU>
  24     Archive-name: dynamic-hash
  25
  26     * Dynamic hashing, after CACM April 1988 pp 446-457, by Per-Ake Larson.
  27     * Coded into C, with minor code improvements, and with hsearch(3) interface,
  28     * by ejp@ausmelb.oz, Jul 26, 1988: 13:16;
  29
  30     TODO: Fix Esmond's ugly MixedCapsIdentifiers ;->
  31  */
  32
  33 /* $Id$ */
  34
  35 #ifdef HAVE_CONFIG_H
  36 # include "config.h"
  37 #endif
  38
  39 /* bcopy is not ISO C *
  40 #define bcopy(X, Y, Z) memcpy((Y), (X), (Z))
  41 */
  42
  43 #ifdef PSET
  44 # define SET pset
  45 # define PMANGLE(pre) pre##_pset
  46 # define MANGLEP(post) pset_##post
  47 # define MANGLE(pre, post) pre##pset##post
  48 # define EQUAL(cmp, elt, key, siz) (!(cmp) ((elt)->entry.dptr, (key)))
  49 #else
  50 # define SET set
  51 # define PMANGLE(pre) pre##_set
  52 # define MANGLEP(post) set_##post
  53 # define MANGLE(pre, post) pre##set##post
  54 # define EQUAL(cmp, elt, key, siz) \
  55     (((elt)->entry.size == (siz)) && !(cmp) ((elt)->entry.dptr, (key), (siz)))
  56 #endif
  57
  58 #include <assert.h>
  59 #include <stdlib.h>
  60 #include <stdio.h>
  61 #include <string.h>
  62 #include "xmalloc.h"
  63 #ifdef PSET
  64 # include "pset.h"
  65 #else
  66 # include "set.h"
  67 #endif
  68
  69
  70 #define TOBSTACK_ID MANGLEP(tag)
  71 #include "obst.h"
  72
  73
  74 #define SEGMENT_SIZE_SHIFT      8
  75 #define SEGMENT_SIZE            (1 << SEGMENT_SIZE_SHIFT)
  76 #define DIRECTORY_SIZE_SHIFT    8
  77 #define DIRECTORY_SIZE          (1 << DIRECTORY_SIZE_SHIFT)
  78 #define MAX_LOAD_FACTOR         4
  79
  80
  81 typedef struct element {
  82   struct element *chain;        /**< for chaining Elements */
  83   MANGLEP (entry) entry;
  84 } Element, *Segment;
  85
  86
  87 struct SET {
  88   unsigned p;                   /**< Next bucket to be split    */
  89   unsigned maxp;                /**< upper bound on p during expansion  */
  90   unsigned nkey;                /**< current # keys     */
  91   unsigned nseg;                /**< current # segments */
  92   Segment *dir[DIRECTORY_SIZE];
  93   MANGLEP(cmp_fun) cmp;         /**< function comparing entries */
  94   unsigned iter_i, iter_j;
  95   Element *iter_tail;           /**< non-NULL while iterating over elts */
  96 #ifdef PSET
  97   Element *free_list;           /**< list of free Elements */
  98 #endif
  99   struct obstack obst;          /**< obstack for allocation all data */
 100 #ifdef STATS
 101   int naccess, ncollision, ndups;
 102   int max_chain_len;
 103 #endif
 104 #ifdef DEBUG
 105   const char *tag;              /**< an optionally tag for distinguishing sets */
 106 #endif
 107 };
 108
 109
 110 #ifdef STATS
 111
 112 void
 113 MANGLEP(stats) (SET *table)
 114 {
 115   int nfree = 0;
 116 #ifdef PSET
 117   Element *q = table->free_list;
 118   while (q) { q = q->chain; ++nfree; }
 119 #endif
 120   printf ("     accesses  collisions        keys  duplicates     longest      wasted\n%12d%12d%12d%12d%12d%12d\n",
 121           table->naccess, table->ncollision, table->nkey, table->ndups, table->max_chain_len, nfree);
 122 }
 123
 124 static INLINE void
 125 stat_chain_len (SET *table, int chain_len)
 126 {
 127   table->ncollision += chain_len;
 128   if (table->max_chain_len < chain_len) table->max_chain_len = chain_len;
 129 }
 130
 131 # define stat_access(table) (++(table)->naccess)
 132 # define stat_dup(table) (++(table)->ndups)
 133
 134 #else /* !STATS */
 135
 136 # define stat_chain_len(table, chain_len) ((void)0)
 137 # define stat_access(table) ((void)0)
 138 # define stat_dup(table) ((void)0)
 139
 140 #endif /* !STATS */
 141
 142 #ifdef DEBUG
 143
 144 const char *MANGLEP(tag);
 145
 146
 147 void
 148 MANGLEP(describe) (SET *table)
 149 {
 150   unsigned i, j, collide;
 151   Element *ptr;
 152   Segment *seg;
 153
 154   printf ("p=%u maxp=%u nkey=%u nseg=%u\n",
 155           table->p, table->maxp, table->nkey, table->nseg);
 156   for (i = 0;  i < table->nseg;  i++) {
 157     seg = table->dir[i];
 158     for (j = 0;  j < SEGMENT_SIZE;  j++) {
 159       collide = 0;
 160       ptr = seg[j];
 161       while (ptr) {
 162         if (collide) printf ("<%3d>", collide);
 163         else printf ("table");
 164         printf ("[%d][%3d]: %u %p\n", i, j, ptr->entry.hash, (void *)ptr->entry.dptr);
 165         ptr = ptr->chain;
 166         collide++;
 167       }
 168     }
 169   }
 170 #ifdef STATS
 171   MANGLEP(stats)(table);
 172 #endif
 173 }
 174
 175 #endif /* !DEBUG */
 176
 177
 178 SET *
 179 (PMANGLE(new)) (MANGLEP(cmp_fun) cmp, int nslots)
 180 {
 181   int i;
 182   SET *table = xmalloc (sizeof (SET));
 183
 184   if (nslots > SEGMENT_SIZE * DIRECTORY_SIZE)
 185     nslots = DIRECTORY_SIZE;
 186   else {
 187     assert (nslots >= 0);
 188     /* Adjust nslots up to next power of 2, minimum SEGMENT_SIZE */
 189     for (i = SEGMENT_SIZE;  i < nslots;  i <<= 1);
 190     nslots = i >> SEGMENT_SIZE_SHIFT;
 191   }
 192
 193   table->nseg = table->p = table->nkey = 0;
 194   table->maxp = nslots << SEGMENT_SIZE_SHIFT;
 195   table->cmp = cmp;
 196   table->iter_tail = NULL;
 197 #ifdef PSET
 198   table->free_list = NULL;
 199 #endif
 200   obstack_init (&table->obst);
 201
 202   /* Make segments */
 203   for (i = 0;  i < nslots;  ++i) {
 204     table->dir[i] = (Segment *)obstack_alloc (&table->obst,
 205                                               sizeof (Segment) * SEGMENT_SIZE);
 206
 207     memset(table->dir[i], 0, sizeof (Segment) * SEGMENT_SIZE);
 208     table->nseg++;
 209   }
 210
 211 #ifdef STATS
 212   table->naccess = table->ncollision = table->ndups = 0;
 213   table->max_chain_len = 0;
 214 #endif
 215 #ifdef DEBUG
 216   table->tag = MANGLEP(tag);
 217 #endif
 218   return table;
 219 }
 220
 221
 222 void
 223 PMANGLE(del) (SET *table)
 224 {
 225 #ifdef DEBUG
 226   MANGLEP(tag) = table->tag;
 227 #endif
 228   obstack_free (&table->obst, NULL);
 229   xfree (table);
 230 }
 231
 232 int
 233 MANGLEP(count) (SET *table)
 234 {
 235   return table->nkey;
 236 }
 237
 238 /*
 239  * do one iteration step, return 1
 240  * if still data in the set, 0 else
 241  */
 242 static INLINE int
 243 iter_step (SET *table)
 244 {
 245   if (++table->iter_j >= SEGMENT_SIZE) {
 246     table->iter_j = 0;
 247     if (++table->iter_i >= table->nseg) {
 248       table->iter_i = 0;
 249       return 0;
 250     }
 251   }
 252   return 1;
 253 }
 254
 255 /*
 256  * finds the first entry in the table
 257  */
 258 void *
 259 MANGLEP(first) (SET *table)
 260 {
 261   assert (!table->iter_tail);
 262   table->iter_i = 0;
 263   table->iter_j = 0;
 264   while (!table->dir[table->iter_i][table->iter_j]) {
 265     if (!iter_step (table)) return NULL;
 266   }
 267   table->iter_tail = table->dir[table->iter_i][table->iter_j];
 268   assert (table->iter_tail->entry.dptr);
 269   return table->iter_tail->entry.dptr;
 270 }
 271
 272 /*
 273  * returns next entry in the table
 274  */
 275 void *
 276 MANGLEP(next) (SET *table)
 277 {
 278   if (!table->iter_tail)
 279     return NULL;
 280
 281   /* follow collision chain */
 282   table->iter_tail = table->iter_tail->chain;
 283   if (!table->iter_tail) {
 284     /* go to next segment */
 285     do {
 286       if (!iter_step (table)) return NULL;
 287     } while (!table->dir[table->iter_i][table->iter_j]);
 288     table->iter_tail = table->dir[table->iter_i][table->iter_j];
 289   }
 290   assert (table->iter_tail->entry.dptr);
 291   return table->iter_tail->entry.dptr;
 292 }
 293
 294 void
 295 MANGLEP(break) (SET *table)
 296 {
 297   table->iter_tail = NULL;
 298 }
 299
 300 /*
 301  * limit the hash value
 302  */
 303 static INLINE unsigned
 304 Hash (SET *table, unsigned h)
 305 {
 306   unsigned address;
 307
 308   address = h & (table->maxp - 1);          /* h % table->maxp */
 309   if (address < (unsigned)table->p)
 310     address = h & ((table->maxp << 1) - 1); /* h % (2*table->maxp) */
 311   return address;
 312 }
 313
 314 /*
 315  * returns non-zero if the number of elements in
 316  * the set is greater then number of segments * MAX_LOAD_FACTOR
 317  */
 318 static INLINE int
 319 loaded (SET *table)
 320 {
 321   return (  ++table->nkey
 322           > (table->nseg << SEGMENT_SIZE_SHIFT) * MAX_LOAD_FACTOR);
 323 }
 324
 325 /*
 326  * expand the hash-table: the algorithm is split, so on every
 327  * insert, only ONE segment is rehashed!
 328  *
 329  * table->p contains the current segment to split
 330  * after all segments were split, table->p is set to zero and
 331  * table->maxp is duplicated.
 332  */
 333 static void
 334 expand_table (SET *table)
 335 {
 336   unsigned NewAddress;
 337   int OldSegmentIndex, NewSegmentIndex;
 338   int OldSegmentDir, NewSegmentDir;
 339   Segment *OldSegment;
 340   Segment *NewSegment;
 341   Element *Current;
 342   Element **Previous;
 343   Element **LastOfNew;
 344
 345   if (table->maxp + table->p < (DIRECTORY_SIZE << SEGMENT_SIZE_SHIFT)) {
 346     /* Locate the bucket to be split */
 347     OldSegmentDir   = table->p >> SEGMENT_SIZE_SHIFT;
 348     OldSegment      = table->dir[OldSegmentDir];
 349     OldSegmentIndex = table->p & (SEGMENT_SIZE-1);
 350
 351     /* Expand address space; if necessary create a new segment */
 352     NewAddress      = table->maxp + table->p;
 353     NewSegmentDir   = NewAddress >> SEGMENT_SIZE_SHIFT;
 354     NewSegmentIndex = NewAddress & (SEGMENT_SIZE-1);
 355     if (NewSegmentIndex == 0) {
 356       table->dir[NewSegmentDir] =
 357         (Segment *)obstack_alloc (&table->obst,
 358                                   sizeof(Segment) * SEGMENT_SIZE);
 359       memset(table->dir[NewSegmentDir], 0, sizeof(Segment) * SEGMENT_SIZE);
 360       table->nseg++;
 361     }
 362     NewSegment = table->dir[NewSegmentDir];
 363
 364     /* Adjust state variables */
 365     table->p++;
 366     if (table->p == table->maxp) {
 367       table->maxp <<= 1;        /* table->maxp *= 2     */
 368       table->p = 0;
 369     }
 370
 371     /* Relocate records to the new bucket */
 372     Previous = &OldSegment[OldSegmentIndex];
 373     Current = *Previous;
 374     LastOfNew = &NewSegment[NewSegmentIndex];
 375     *LastOfNew = NULL;
 376     while (Current != NULL) {
 377       if (Hash (table, Current->entry.hash) == NewAddress) {
 378         /* move to new chain */
 379         *LastOfNew = Current;
 380         *Previous  = Current->chain;
 381         LastOfNew  = &Current->chain;
 382         Current    = Current->chain;
 383         *LastOfNew = NULL;
 384       } else {
 385         /* leave on old chain */
 386         Previous = &Current->chain;
 387         Current = Current->chain;
 388       }
 389     }
 390   }
 391 }
 392
 393
 394 void *
 395 MANGLE(_,_search) (SET *table,
 396                    const void *key,
 397 #ifndef PSET
 398                    size_t size,
 399 #endif
 400                    unsigned hash,
 401                    MANGLE(_,_action) action)
 402 {
 403   unsigned h;
 404   Segment *CurrentSegment;
 405   int SegmentIndex;
 406   MANGLEP(cmp_fun) cmp = table->cmp;
 407   Segment q;
 408   int chain_len = 0;
 409
 410   assert (table);
 411   assert (key);
 412 #ifdef DEBUG
 413   MANGLEP(tag) = table->tag;
 414 #endif
 415   stat_access (table);
 416
 417   /* Find collision chain */
 418   h = Hash (table, hash);
 419   SegmentIndex   = h & (SEGMENT_SIZE-1);
 420   CurrentSegment = table->dir[h >> SEGMENT_SIZE_SHIFT];
 421   assert (CurrentSegment != NULL);
 422   q = CurrentSegment[SegmentIndex];
 423
 424   /* Follow collision chain */
 425   while (q && !EQUAL (cmp, q, key, size)) {
 426     q = q->chain;
 427     ++chain_len;
 428   }
 429
 430   stat_chain_len (table, chain_len);
 431
 432   if (!q && (action != MANGLE(_,_find))) { /* not found, insert */
 433     assert (!table->iter_tail && "insert an element into a set that is iterated");
 434
 435     if (CurrentSegment[SegmentIndex]) stat_dup (table);
 436
 437 #ifdef PSET
 438     if (table->free_list) {
 439       q = table->free_list;
 440       table->free_list = table->free_list->chain;
 441     } else {
 442       q = obstack_alloc (&table->obst, sizeof (Element));
 443     }
 444     q->entry.dptr = (void *)key;
 445 #else
 446     obstack_blank (&table->obst, offsetof (Element, entry.dptr));
 447     if (action == _set_hinsert0)
 448       obstack_grow0 (&table->obst, key, size);
 449     else
 450       obstack_grow (&table->obst, key, size);
 451     q = obstack_finish (&table->obst);
 452     q->entry.size = size;
 453 #endif
 454     q->chain = CurrentSegment[SegmentIndex];
 455     q->entry.hash = hash;
 456     CurrentSegment[SegmentIndex] = q;
 457
 458     if (loaded (table)) {
 459       expand_table(table);      /* doesn't affect q */
 460     }
 461   }
 462
 463   if (!q) return NULL;
 464 #ifdef PSET
 465   if (action == _pset_hinsert) return &q->entry;
 466 #else
 467   if (action == _set_hinsert || action == _set_hinsert0) return &q->entry;
 468 #endif
 469   return q->entry.dptr;
 470 }
 471
 472
 473 #ifdef PSET
 474
 475 void *
 476 pset_remove (SET *table, const void *key, unsigned hash)
 477 {
 478   unsigned h;
 479   Segment *CurrentSegment;
 480   int SegmentIndex;
 481   pset_cmp_fun cmp = table->cmp;
 482   Segment *p;
 483   Segment q;
 484   int chain_len = 0;
 485
 486   assert (table && !table->iter_tail);
 487   stat_access (table);
 488
 489   /* Find collision chain */
 490   h = Hash (table, hash);
 491   SegmentIndex = h & (SEGMENT_SIZE-1);
 492   CurrentSegment = table->dir[h >> SEGMENT_SIZE_SHIFT];
 493   assert (CurrentSegment != NULL);
 494   p = &CurrentSegment[SegmentIndex];
 495
 496   /* Follow collision chain */
 497   while (!EQUAL (cmp, *p, key, size)) {
 498     p = &(*p)->chain;
 499     assert (*p);
 500     ++chain_len;
 501   }
 502
 503   stat_chain_len (table, chain_len);
 504
 505   q = *p;
 506
 507   if (q == table->iter_tail) {
 508     /* removing current element */
 509     table->iter_tail = q->chain;
 510     if (!table->iter_tail) {
 511       /* go to next segment */
 512       do {
 513         if (!iter_step (table))
 514           break;
 515       } while (!table->dir[table->iter_i][table->iter_j]);
 516       table->iter_tail = table->dir[table->iter_i][table->iter_j];
 517     }
 518   }
 519
 520   *p = (*p)->chain;
 521   q->chain = table->free_list;
 522   table->free_list = q;
 523   --table->nkey;
 524
 525   return q->entry.dptr;
 526 }
 527
 528
 529 void *
 530 (pset_find) (SET *se, const void *key, unsigned hash)
 531 {
 532   return pset_find (se, key, hash);
 533 }
 534
 535
 536 void *
 537 (pset_insert) (SET *se, const void *key, unsigned hash)
 538 {
 539   return pset_insert (se, key, hash);
 540 }
 541
 542
 543 MANGLEP(entry) *
 544 (pset_hinsert) (SET *se, const void *key, unsigned hash)
 545 {
 546   return pset_hinsert (se, key, hash);
 547 }
 548
 549 #else /* !PSET */
 550
 551 void *
 552 (set_find) (set *se, const void *key, size_t size, unsigned hash)
 553 {
 554   return set_find (se, key, size, hash);
 555 }
 556
 557
 558 void *
 559 (set_insert) (set *se, const void *key, size_t size, unsigned hash)
 560 {
 561   return set_insert (se, key, size, hash);
 562 }
 563
 564
 565 set_entry *
 566 (set_hinsert) (set *se, const void *key, size_t size, unsigned hash)
 567 {
 568   return set_hinsert (se, key, size, hash);
 569 }
 570
 571 #endif /* !PSET */