- BugFix: *__remove_iterator(): after _next(), the iterator already points to the...
[libfirm] / ir / ir / irlinkednodeset.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @author    Michael Beck
23  * @brief     A linked nodeset.
24  * @version   $Id$
25  */
26 #include "config.h"
27
28 #include "irlinkednodeset.h"
29 #include "irnode_t.h"
30 #include "hashptr.h"
31
32 static ir_lnk_nodeset_entry_t null_nodeset_entry;
33
34 #define DO_REHASH
35 #define HashSet                   ir_lnk_nodeset_t
36 #define HashSetIterator           ir_lnk_nodeset_iterator_t
37 #define ValueType                 ir_lnk_nodeset_entry_t
38 #define NullValue                 null_nodeset_entry
39 #define KeyType                   ir_node*
40 #define ConstKeyType              const ir_node*
41 #define GetKey(value)             (value).node
42 #define InitData(self,value,key)  do { (value).node = (key); (value).list.next = NULL; (value).list.prev = NULL; } while(0)
43 #ifdef DEBUG_libfirm
44 #define Hash(self,key)            ((unsigned)((key)->node_nr))
45 #else
46 #define Hash(self,key)            HASH_PTR(key)
47 #endif
48 #define KeysEqual(self,key1,key2) (key1) == (key2)
49 #define SetRangeEmpty(ptr,size)   memset(ptr, 0, (size) * sizeof((ptr)[0]))
50 #define EntrySetEmpty(value)      (value).node = NULL
51 #define EntrySetDeleted(value)    do { (value).node = (ir_node*) -1; list_del(&(value).list); } while(0)
52 #define EntryIsEmpty(value)       ((value).node == NULL)
53 #define EntryIsDeleted(value)     ((value).node == (ir_node*)-1)
54
55 #define hashset_init            ir_lnk_nodeset_init
56 #define hashset_init_size       ir_lnk_nodeset_init_size
57 #define hashset_destroy         ir_lnk_nodeset_destroy
58 #define hashset_insert          _ir_lnk_nodeset_insert
59 #define hashset_remove          ir_lnk_nodeset_remove
60 #define hashset_find            _ir_lnk_nodeset_find
61 #define hashset_size            ir_lnk_nodeset_size
62
63 #define ADDITIONAL_INIT         INIT_LIST_HEAD(&self->elem_list); INIT_LIST_HEAD(&self->all_iters);
64 #define ADDITIONAL_TERM         INIT_LIST_HEAD(&self->elem_list); INIT_LIST_HEAD(&self->all_iters);
65
66 #define NO_ITERATOR
67 #define HAVE_OWN_RESIZE
68
69 #include "hashset.c"
70
71 /**
72  * Resize the hashset
73  * @internal
74  */
75 static INLINE
76 void resize(HashSet *self, size_t new_size)
77 {
78         size_t num_buckets = self->num_buckets;
79         HashSetEntry *old_entries = self->entries;
80         HashSetEntry *new_entries;
81         list_head    list = self->elem_list;
82         HashSetEntry *entry;
83         int          res = 1;
84
85         /* allocate a new array with double size */
86         new_entries = Alloc(new_size);
87         SetRangeEmpty(new_entries, new_size);
88
89         /* use the new array */
90         self->entries      = new_entries;
91         self->num_buckets  = new_size;
92         self->num_elements = 0;
93         self->num_deleted  = 0;
94 #ifndef NDEBUG
95         self->entries_version++;
96 #endif
97         reset_thresholds(self);
98
99         assert(!list_empty(&self->elem_list));
100         list.next->prev = &list;
101         list.prev->next = &list;
102
103         /* reinsert all elements */
104         INIT_LIST_HEAD(&self->elem_list);
105         list_for_each_entry(ValueType, entry, &list, list) {
106                 res &= ir_lnk_nodeset_insert(self, EntryGetValue(*entry).node);
107         }
108         /* all re-inserted data must be new, if not, we found a node twice ... */
109         assert(res == 1);
110
111         /* now we can free the old array */
112         Free(old_entries);
113 }
114
115
116 /* Inserts a node into a linked nodeset. */
117 int ir_lnk_nodeset_insert(ir_lnk_nodeset_t *nodeset, ir_node *node) {
118         ir_lnk_nodeset_entry_t *entry = _ir_lnk_nodeset_insert(nodeset, node);
119
120         if (entry->list.next == NULL) {
121                 /* we have added a new element */
122                 list_add_tail(&entry->list, &nodeset->elem_list);
123                 return 1;
124         }
125         return 0;
126 }
127
128 int ir_lnk_nodeset_contains(const ir_lnk_nodeset_t *nodeset, const ir_node *node)
129 {
130         return _ir_lnk_nodeset_find(nodeset, node) != NULL;
131 }
132
133 /**
134  * Initializes a nodeset iterator. Sets the iterator before the first element in
135  * the linked nodeset.
136  *
137  * @param iterator   Pointer to already allocated iterator memory
138  * @param nodeset       Pointer to the nodeset
139  */
140 void ir_lnk_nodeset_iterator_init(ir_lnk_nodeset_iterator_t *iterator,
141                                   const ir_lnk_nodeset_t *nodeset) {
142         iterator->iter    = nodeset->elem_list.next;
143         iterator->nodeset = nodeset;
144 }
145
146 /**
147  * Advances the iterator and returns the current element or NULL if all elements
148  * in the linked nodeset have been processed.
149  * @attention It is not allowed to use ir_lnk_nodeset_insert or ir_lnk_nodeset_remove while
150  *            iterating over a nodeset.
151  *
152  * @param iterator  Pointer to the nodeset iterator.
153  * @returns         Next element in the nodeset or NULL
154  */
155 ir_node *ir_lnk_nodeset_iterator_next(ir_lnk_nodeset_iterator_t *iterator) {
156         ir_node *res;
157         if (iterator->iter == &iterator->nodeset->elem_list)
158                 return NULL;
159
160         res = list_entry(iterator->iter, ir_lnk_nodeset_entry_t, list)->node;
161         iterator->iter = iterator->iter->next;
162
163         return res;
164 }
165
166 /**
167  * Removes the element the iterator currently points to.
168  *
169  * @param nodeset   Pointer to the linked nodeset
170  * @param iterator  Pointer to the nodeset iterator.
171  */
172 void ir_lnk_nodeset_remove_iterator(ir_lnk_nodeset_t *nodeset,
173                                     ir_lnk_nodeset_iterator_t *iterator) {
174         ir_lnk_nodeset_entry_t *rem = list_entry(iterator->iter->prev, ir_lnk_nodeset_entry_t, list);
175
176         ir_lnk_nodeset_remove(nodeset, rem->node);
177 }