Put opening curly brace of functions on a separate line.
[libfirm] / ir / adt / set.c
index de188b6..b8eebef 100644 (file)
@@ -1,13 +1,27 @@
 /*
- * Project:     libFIRM
- * File name:   ir/adt/set.c
- * Purpose:     Set --- collection of entries that are unique wrt to a key.
- * Author:      Markus Armbruster
- * Modified by:
- * Created:     1999 by getting from fiasco
- * CVS-ID:      $Id$
- * Copyright:   (c) 1995, 1996 Markus Armbruster
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * 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
-
-/* bcopy is not ISO C *
-#define bcopy(X, Y, Z) memcpy((Y), (X), (Z))
-*/
+#include "config.h"
 
 #ifdef PSET
 # define SET pset
 
 
 typedef struct element {
-  struct element *chain;       /* for chaining Elements */
+  struct element *chain;       /**< for chaining Elements */
   MANGLEP (entry) entry;
 } Element, *Segment;
 
 
 struct SET {
-  unsigned p;                  /* Next bucket to be split      */
-  unsigned maxp;               /* upper bound on p during expansion    */
-  unsigned nkey;               /* current # keys       */
-  unsigned 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 */
+  MANGLEP(cmp_fun) cmp;                /**< function comparing entries */
   unsigned iter_i, iter_j;
-  Element *iter_tail;          /* non-NULL while iterating over elts */
+  Element *iter_tail;          /**< non-NULL while iterating over elts */
 #ifdef PSET
-  Element *free_list;          /* list of free Elements */
+  Element *free_list;          /**< list of free Elements */
 #endif
-  struct obstack obst;         /* obstack for allocation all data */
+  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
 };
 
@@ -121,7 +126,7 @@ MANGLEP(stats) (SET *table)
          table->naccess, table->ncollision, table->nkey, table->ndups, table->max_chain_len, nfree);
 }
 
-static INLINE void
+static inline void
 stat_chain_len (SET *table, int chain_len)
 {
   table->ncollision += chain_len;
@@ -144,7 +149,7 @@ stat_chain_len (SET *table, int chain_len)
 const char *MANGLEP(tag);
 
 
-static void
+void
 MANGLEP(describe) (SET *table)
 {
   unsigned i, j, collide;
@@ -161,12 +166,15 @@ 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 */
@@ -176,16 +184,16 @@ SET *
 (PMANGLE(new)) (MANGLEP(cmp_fun) cmp, int nslots)
 {
   int i;
-  SET *table = xmalloc (sizeof (SET));
+  SET *table = XMALLOC(SET);
 
   if (nslots > SEGMENT_SIZE * DIRECTORY_SIZE)
-    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;
   }
-  nslots = i >> SEGMENT_SIZE_SHIFT;
 
   table->nseg = table->p = table->nkey = 0;
   table->maxp = nslots << SEGMENT_SIZE_SHIFT;
@@ -198,10 +206,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++;
   }
 
@@ -236,7 +241,7 @@ MANGLEP(count) (SET *table)
  * do one iteration step, return 1
  * if still data in the set, 0 else
  */
-static INLINE int
+static inline int
 iter_step (SET *table)
 {
   if (++table->iter_j >= SEGMENT_SIZE) {
@@ -297,11 +302,10 @@ MANGLEP(break) (SET *table)
 /*
  * limit the hash value
  */
-static INLINE unsigned
+static inline unsigned
 Hash (SET *table, unsigned h)
 {
   unsigned address;
-
   address = h & (table->maxp - 1);          /* h % table->maxp */
   if (address < (unsigned)table->p)
     address = h & ((table->maxp << 1) - 1); /* h % (2*table->maxp) */
@@ -312,7 +316,7 @@ Hash (SET *table, unsigned h)
  * returns non-zero if the number of elements in
  * the set is greater then number of segments * MAX_LOAD_FACTOR
  */
-static INLINE int
+static inline int
 loaded (SET *table)
 {
   return (  ++table->nkey
@@ -350,10 +354,7 @@ expand_table (SET *table)
     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);
-      memset(table->dir[NewSegmentDir], 0, sizeof(Segment) * SEGMENT_SIZE);
+      table->dir[NewSegmentDir] = OALLOCNZ(&table->obst, Segment, SEGMENT_SIZE);
       table->nseg++;
     }
     NewSegment = table->dir[NewSegmentDir];
@@ -405,7 +406,6 @@ MANGLE(_,_search) (SET *table,
   int chain_len = 0;
 
   assert (table);
-  assert (!table->iter_tail);
   assert (key);
 #ifdef DEBUG
   MANGLEP(tag) = table->tag;
@@ -428,6 +428,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
@@ -435,7 +437,7 @@ 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
@@ -468,6 +470,11 @@ MANGLE(_,_search) (SET *table,
 
 #ifdef PSET
 
+int pset_default_ptr_cmp(const void *x, const void *y)
+{
+       return x != y;
+}
+
 void *
 pset_remove (SET *table, const void *key, unsigned hash)
 {
@@ -542,6 +549,14 @@ 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 *