s/full\>/ful/.
[libfirm] / ir / adt / set.c
index 1370703..3ebaf82 100644 (file)
@@ -1,5 +1,28 @@
-/* Set --- collection of entries that are unique wrt to a key.
-   Copyright (C) 1995, 1996 Markus Armbruster */
+/*
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
+
+/**
+ * @file
+ * @brief       implementation of set
+ * @author      Markus Armbruster
+ * @version     $Id$
+ */
 
 /*  This code is derived from:
 
 
     TODO: Fix Esmond's ugly MixedCapsIdentifiers ;->
  */
-
-/* $Id$ */
-
-#ifdef HAVE_CONFIG_H
-# include <config.h>
-#endif
-
-#ifdef USE_GCC_INLINE
-#define INLINE inline
-#else
-#define INLINE
-#endif
-
-/* bcopy is not ISO C *
-#define bcopy(X, Y, Z) memcpy((Y), (X), (Z))
-*/
+#include "config.h"
 
 #ifdef PSET
 # define SET pset
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
-#include "misc.h"
+#include "xmalloc.h"
 #ifdef PSET
 # include "pset.h"
 #else
 # include "set.h"
 #endif
 
+
 #define TOBSTACK_ID MANGLEP(tag)
 #include "obst.h"
 
 #define SEGMENT_SIZE           (1 << SEGMENT_SIZE_SHIFT)
 #define DIRECTORY_SIZE_SHIFT   8
 #define DIRECTORY_SIZE         (1 << DIRECTORY_SIZE_SHIFT)
-#define MAX_LOAD_FACTOR        4
+#define MAX_LOAD_FACTOR                4
 
 
 typedef struct element {
-  struct element *chain;
+  struct element *chain;       /**< for chaining Elements */
   MANGLEP (entry) entry;
 } Element, *Segment;
 
 
 struct SET {
-  short        p;                      /* Next bucket to be split      */
-  short        maxp;                   /* upper bound on p during expansion    */
-  int nkey;                    /* current # keys       */
-  short        nseg;                   /* current # segments   */
+  unsigned p;                  /**< Next bucket to be split    */
+  unsigned maxp;               /**< upper bound on p during expansion  */
+  unsigned nkey;               /**< current # keys     */
+  unsigned nseg;               /**< current # segments */
   Segment *dir[DIRECTORY_SIZE];
-  MANGLEP(cmp_fun) cmp;                /* function comparing entries */
-  int iter_i, iter_j;
-  Element *iter_tail;          /* non-NULL while iterating over elts */
+  MANGLEP(cmp_fun) cmp;                /**< function comparing entries */
+  unsigned iter_i, iter_j;
+  Element *iter_tail;          /**< non-NULL while iterating over elts */
 #ifdef PSET
-  Element *free_list;
+  Element *free_list;          /**< list of free Elements */
 #endif
-  struct obstack obst;
+  struct obstack obst;         /**< obstack for allocation all data */
 #ifdef STATS
   int naccess, ncollision, ndups;
   int max_chain_len;
 #endif
 #ifdef DEBUG
-  const char *tag;
+  const char *tag;              /**< an optionally tag for distinguishing sets */
 #endif
 };
 
 
 #ifdef STATS
 
-void
-MANGLEP(stats) (SET *table)
+void MANGLEP(stats) (SET *table)
 {
   int nfree = 0;
 #ifdef PSET
@@ -117,8 +125,7 @@ MANGLEP(stats) (SET *table)
          table->naccess, table->ncollision, table->nkey, table->ndups, table->max_chain_len, nfree);
 }
 
-static INLINE void
-stat_chain_len (SET *table, int chain_len)
+static inline void stat_chain_len(SET *table, int chain_len)
 {
   table->ncollision += chain_len;
   if (table->max_chain_len < chain_len) table->max_chain_len = chain_len;
@@ -129,7 +136,7 @@ stat_chain_len (SET *table, int chain_len)
 
 #else /* !STATS */
 
-# define stat_chain_len(table, chain_len) ((void)0)
+# define stat_chain_len(table, chain_len) ((void)chain_len)
 # define stat_access(table) ((void)0)
 # define stat_dup(table) ((void)0)
 
@@ -140,14 +147,13 @@ stat_chain_len (SET *table, int chain_len)
 const char *MANGLEP(tag);
 
 
-static void
-MANGLEP(describe) (SET *table)
+void MANGLEP(describe) (SET *table)
 {
-  int i, j, collide;
+  unsigned i, j, collide;
   Element *ptr;
   Segment *seg;
 
-  printf ("p=%d maxp=%d nkey=%d nseg=%d\n",
+  printf ("p=%u maxp=%u nkey=%u nseg=%u\n",
          table->p, table->maxp, table->nkey, table->nseg);
   for (i = 0;  i < table->nseg;  i++) {
     seg = table->dir[i];
@@ -157,27 +163,34 @@ MANGLEP(describe) (SET *table)
       while (ptr) {
        if (collide) printf ("<%3d>", collide);
        else printf ("table");
-       printf ("[%d][%3d]: %u %p\n", i, j, ptr->entry.hash, ptr->entry.dptr);
+       printf ("[%d][%3d]: %u %p\n", i, j, ptr->entry.hash, (void *)ptr->entry.dptr);
        ptr = ptr->chain;
        collide++;
       }
     }
   }
+#ifdef STATS
+  MANGLEP(stats)(table);
+#endif
 }
 
 #endif /* !DEBUG */
 
 
-SET *
-(PMANGLE(new)) (MANGLEP(cmp_fun) cmp, int nslots)
+SET *(PMANGLE(new)) (MANGLEP(cmp_fun) cmp, int nslots)
 {
   int i;
-  SET *table = xmalloc (sizeof (SET));
-
-  /* Adjust nslots up to next power of 2, minimum SEGMENT_SIZE */
-  assert (nslots >= 0);
-  for (i = SEGMENT_SIZE;  i < nslots;  i <<= 1) assert (i < (i << 1));
-  nslots = i >> SEGMENT_SIZE_SHIFT;
+  SET *table = XMALLOC(SET);
+
+  if (nslots > SEGMENT_SIZE * DIRECTORY_SIZE)
+    nslots = DIRECTORY_SIZE;
+  else {
+    assert (nslots >= 0);
+    /* Adjust nslots up to next power of 2, minimum SEGMENT_SIZE */
+    for (i = SEGMENT_SIZE;  i < nslots;  i <<= 1) {
+       }
+    nslots = i >> SEGMENT_SIZE_SHIFT;
+  }
 
   table->nseg = table->p = table->nkey = 0;
   table->maxp = nslots << SEGMENT_SIZE_SHIFT;
@@ -190,10 +203,7 @@ SET *
 
   /* Make segments */
   for (i = 0;  i < nslots;  ++i) {
-    table->dir[i] = (Segment *)obstack_alloc (&table->obst,
-                                             sizeof (Segment) * SEGMENT_SIZE);
-
-    memset (table->dir[i], 0, sizeof (Segment) * SEGMENT_SIZE);
+    table->dir[i] = OALLOCNZ(&table->obst, Segment, SEGMENT_SIZE);
     table->nseg++;
   }
 
@@ -208,8 +218,7 @@ SET *
 }
 
 
-void
-PMANGLE(del) (SET *table)
+void PMANGLE(del) (SET *table)
 {
 #ifdef DEBUG
   MANGLEP(tag) = table->tag;
@@ -218,9 +227,16 @@ PMANGLE(del) (SET *table)
   xfree (table);
 }
 
+int MANGLEP(count) (SET *table)
+{
+  return table->nkey;
+}
 
-static INLINE int
-iter_step (SET *table)
+/*
+ * do one iteration step, return 1
+ * if still data in the set, 0 else
+ */
+static inline int iter_step(SET *table)
 {
   if (++table->iter_j >= SEGMENT_SIZE) {
     table->iter_j = 0;
@@ -232,9 +248,10 @@ iter_step (SET *table)
   return 1;
 }
 
-
-void *
-MANGLEP(first) (SET *table)
+/*
+ * finds the first entry in the table
+ */
+void * MANGLEP(first) (SET *table)
 {
   assert (!table->iter_tail);
   table->iter_i = 0;
@@ -247,13 +264,18 @@ MANGLEP(first) (SET *table)
   return table->iter_tail->entry.dptr;
 }
 
-
-void *
-MANGLEP(next) (SET *table)
+/*
+ * returns next entry in the table
+ */
+void *MANGLEP(next) (SET *table)
 {
-  assert (table->iter_tail);
+  if (!table->iter_tail)
+    return NULL;
+
+  /* follow collision chain */
   table->iter_tail = table->iter_tail->chain;
   if (!table->iter_tail) {
+    /* go to next segment */
     do {
       if (!iter_step (table)) return NULL;
     } while (!table->dir[table->iter_i][table->iter_j]);
@@ -263,36 +285,42 @@ MANGLEP(next) (SET *table)
   return table->iter_tail->entry.dptr;
 }
 
-void
-MANGLEP(break) (SET *table)
+void MANGLEP(break) (SET *table)
 {
-  assert (table->iter_tail);
   table->iter_tail = NULL;
 }
 
-
-static INLINE unsigned
-Hash (SET *table, unsigned h)
+/*
+ * limit the hash value
+ */
+static inline unsigned Hash(SET *table, unsigned h)
 {
   unsigned address;
-
-  address = h & (table->maxp - 1);
+  address = h & (table->maxp - 1);          /* h % table->maxp */
   if (address < (unsigned)table->p)
     address = h & ((table->maxp << 1) - 1); /* h % (2*table->maxp) */
   return address;
 }
 
-
-static INLINE int
-loaded (SET *table)
+/*
+ * returns non-zero if the number of elements in
+ * the set is greater then number of segments * MAX_LOAD_FACTOR
+ */
+static inline int loaded(SET *table)
 {
   return (  ++table->nkey
          > (table->nseg << SEGMENT_SIZE_SHIFT) * MAX_LOAD_FACTOR);
 }
 
-
-static void
-expand_table (SET *table)
+/*
+ * expand the hash-table: the algorithm is split, so on every
+ * insert, only ONE segment is rehashed!
+ *
+ * table->p contains the current segment to split
+ * after all segments were split, table->p is set to zero and
+ * table->maxp is duplicated.
+ */
+static void expand_table(SET *table)
 {
   unsigned NewAddress;
   int OldSegmentIndex, NewSegmentIndex;
@@ -305,18 +333,17 @@ expand_table (SET *table)
 
   if (table->maxp + table->p < (DIRECTORY_SIZE << SEGMENT_SIZE_SHIFT)) {
     /* Locate the bucket to be split */
-    OldSegmentDir = table->p >> SEGMENT_SIZE_SHIFT;
-    OldSegment = table->dir[OldSegmentDir];
+    OldSegmentDir   = table->p >> SEGMENT_SIZE_SHIFT;
+    OldSegment      = table->dir[OldSegmentDir];
     OldSegmentIndex = table->p & (SEGMENT_SIZE-1);
 
     /* Expand address space; if necessary create a new segment */
-    NewAddress = table->maxp + table->p;
-    NewSegmentDir = NewAddress >> SEGMENT_SIZE_SHIFT;
+    NewAddress      = table->maxp + table->p;
+    NewSegmentDir   = NewAddress >> SEGMENT_SIZE_SHIFT;
     NewSegmentIndex = NewAddress & (SEGMENT_SIZE-1);
     if (NewSegmentIndex == 0) {
-      table->dir[NewSegmentDir] =
-       (Segment *)obstack_alloc (&table->obst,
-                                 sizeof(Segment) * SEGMENT_SIZE);
+      table->dir[NewSegmentDir] = OALLOCNZ(&table->obst, Segment, SEGMENT_SIZE);
+      table->nseg++;
     }
     NewSegment = table->dir[NewSegmentDir];
 
@@ -326,7 +353,6 @@ expand_table (SET *table)
       table->maxp <<= 1;       /* table->maxp *= 2     */
       table->p = 0;
     }
-    table->nseg++;
 
     /* Relocate records to the new bucket */
     Previous = &OldSegment[OldSegmentIndex];
@@ -337,9 +363,9 @@ expand_table (SET *table)
       if (Hash (table, Current->entry.hash) == NewAddress) {
        /* move to new chain */
        *LastOfNew = Current;
-       *Previous = Current->chain;
-       LastOfNew = &Current->chain;
-       Current = Current->chain;
+       *Previous  = Current->chain;
+       LastOfNew  = &Current->chain;
+       Current    = Current->chain;
        *LastOfNew = NULL;
       } else {
        /* leave on old chain */
@@ -351,8 +377,7 @@ expand_table (SET *table)
 }
 
 
-void *
-MANGLE(_,_search) (SET *table,
+void * MANGLE(_,_search) (SET *table,
                   const void *key,
 #ifndef PSET
                   size_t size,
@@ -368,7 +393,6 @@ MANGLE(_,_search) (SET *table,
   int chain_len = 0;
 
   assert (table);
-  assert (!table->iter_tail);
   assert (key);
 #ifdef DEBUG
   MANGLEP(tag) = table->tag;
@@ -377,7 +401,7 @@ MANGLE(_,_search) (SET *table,
 
   /* Find collision chain */
   h = Hash (table, hash);
-  SegmentIndex = h & (SEGMENT_SIZE-1);
+  SegmentIndex   = h & (SEGMENT_SIZE-1);
   CurrentSegment = table->dir[h >> SEGMENT_SIZE_SHIFT];
   assert (CurrentSegment != NULL);
   q = CurrentSegment[SegmentIndex];
@@ -391,6 +415,8 @@ MANGLE(_,_search) (SET *table,
   stat_chain_len (table, chain_len);
 
   if (!q && (action != MANGLE(_,_find))) { /* not found, insert */
+    assert (!table->iter_tail && "insert an element into a set that is iterated");
+
     if (CurrentSegment[SegmentIndex]) stat_dup (table);
 
 #ifdef PSET
@@ -398,12 +424,15 @@ MANGLE(_,_search) (SET *table,
       q = table->free_list;
       table->free_list = table->free_list->chain;
     } else {
-      q = obstack_alloc (&table->obst, sizeof (Element));
+      q = OALLOC(&table->obst, Element);
     }
     q->entry.dptr = (void *)key;
 #else
     obstack_blank (&table->obst, offsetof (Element, entry.dptr));
-    obstack_grow (&table->obst, key, size);
+    if (action == _set_hinsert0)
+      obstack_grow0 (&table->obst, key, size);
+    else
+      obstack_grow (&table->obst, key, size);
     q = obstack_finish (&table->obst);
     q->entry.size = size;
 #endif
@@ -417,15 +446,23 @@ MANGLE(_,_search) (SET *table,
   }
 
   if (!q) return NULL;
-  if (action == MANGLE(_,_hinsert)) return &q->entry;
+#ifdef PSET
+  if (action == _pset_hinsert) return &q->entry;
+#else
+  if (action == _set_hinsert || action == _set_hinsert0) return &q->entry;
+#endif
   return q->entry.dptr;
 }
 
 
 #ifdef PSET
 
-void *
-pset_remove (SET *table, const void *key, unsigned hash)
+int pset_default_ptr_cmp(const void *x, const void *y)
+{
+       return x != y;
+}
+
+void *pset_remove(SET *table, const void *key, unsigned hash)
 {
   unsigned h;
   Segment *CurrentSegment;
@@ -455,23 +492,36 @@ pset_remove (SET *table, const void *key, unsigned hash)
   stat_chain_len (table, chain_len);
 
   q = *p;
+
+  if (q == table->iter_tail) {
+    /* removing current element */
+    table->iter_tail = q->chain;
+    if (!table->iter_tail) {
+      /* go to next segment */
+      do {
+       if (!iter_step (table))
+         break;
+      } while (!table->dir[table->iter_i][table->iter_j]);
+      table->iter_tail = table->dir[table->iter_i][table->iter_j];
+    }
+  }
+
   *p = (*p)->chain;
   q->chain = table->free_list;
   table->free_list = q;
+  --table->nkey;
 
   return q->entry.dptr;
 }
 
 
-void *
-(pset_find) (SET *se, const void *key, unsigned hash)
+void *(pset_find) (SET *se, const void *key, unsigned hash)
 {
   return pset_find (se, key, hash);
 }
 
 
-void *
-(pset_insert) (SET *se, const void *key, unsigned hash)
+void *(pset_insert) (SET *se, const void *key, unsigned hash)
 {
   return pset_insert (se, key, hash);
 }
@@ -483,24 +533,29 @@ MANGLEP(entry) *
   return pset_hinsert (se, key, hash);
 }
 
+void pset_insert_pset_ptr(pset *target, pset *src)
+{
+  void *elt;
+  for (elt = pset_first(src); elt; elt = pset_next(src)) {
+    pset_insert_ptr(target, elt);
+  }
+}
+
 #else /* !PSET */
 
-void *
-(set_find) (set *se, const void *key, size_t size, unsigned hash)
+void *(set_find) (set *se, const void *key, size_t size, unsigned hash)
 {
   return set_find (se, key, size, hash);
 }
 
 
-void *
-(set_insert) (set *se, const void *key, size_t size, unsigned hash)
+void *(set_insert) (set *se, const void *key, size_t size, unsigned hash)
 {
   return set_insert (se, key, size, hash);
 }
 
 
-set_entry *
-(set_hinsert) (set *se, const void *key, size_t size, unsigned hash)
+set_entry *(set_hinsert) (set *se, const void *key, size_t size, unsigned hash)
 {
   return set_hinsert (se, key, size, hash);
 }