27b2d836b203536d387277b3779923c64b6dbdf4
[libfirm] / ir / be / beifg_std.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  * @brief   Default ifg implementation.
23  * @author  Sebastian Hack
24  * @date    18.11.2005
25  * @version $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <stdlib.h>
32
33 #include "list.h"
34
35 #include "irnode_t.h"
36 #include "irnodeset.h"
37 #include "irgraph_t.h"
38 #include "irgwalk.h"
39 #include "irtools.h"
40
41 #include "bearch_t.h"
42 #include "be_t.h"
43 #include "belive_t.h"
44 #include "bera.h"
45 #include "beifg_t.h"
46 #include "bechordal_t.h"
47 #include "beirg_t.h"
48 #include "beintlive_t.h"
49
50 typedef struct _ifg_std_t ifg_std_t;
51
52 struct _ifg_std_t {
53         const be_ifg_impl_t    *impl;
54         const be_chordal_env_t *env;
55 };
56
57 static void ifg_std_free(void *self)
58 {
59         free(self);
60 }
61
62 static int ifg_std_connected(const void *self, const ir_node *a, const ir_node *b)
63 {
64         const ifg_std_t *ifg = self;
65         return values_interfere(ifg->env->birg, a, b);
66 }
67
68 typedef struct _nodes_iter_t {
69         const be_chordal_env_t *env;
70         struct obstack         obst;
71         int                    n;
72         int                    curr;
73         ir_node                **nodes;
74 } nodes_iter_t;
75
76 static void nodes_walker(ir_node *bl, void *data)
77 {
78         nodes_iter_t     *it   = data;
79         struct list_head *head = get_block_border_head(it->env, bl);
80         border_t         *b;
81
82         foreach_border_head(head, b) {
83                 if (b->is_def && b->is_real) {
84                         obstack_ptr_grow(&it->obst, b->irn);
85                         it->n++;
86                 }
87         }
88 }
89
90 static void find_nodes(const void *self, void *iter) {
91         const ifg_std_t *ifg = self;
92         nodes_iter_t *it = iter;
93
94         obstack_init(&it->obst);
95         it->n     = 0;
96         it->curr  = 0;
97         it->env   = ifg->env;
98
99         irg_block_walk_graph(ifg->env->irg, nodes_walker, NULL, iter);
100         obstack_ptr_grow(&it->obst, NULL);
101         it->nodes = obstack_finish(&it->obst);
102 }
103
104 static INLINE void node_break(nodes_iter_t *it, int force)
105 {
106         if((it->curr >= it->n || force) && it->nodes) {
107                 obstack_free(&it->obst, NULL);
108                 it->nodes = NULL;
109         }
110 }
111
112 static ir_node *get_next_node(void *iter)
113 {
114         nodes_iter_t *it = iter;
115         ir_node *res     = NULL;
116
117         if(it->curr < it->n)
118                 res = it->nodes[it->curr++];
119
120         node_break(it, 0);
121
122         return res;
123 }
124
125 static ir_node *ifg_std_nodes_begin(const void *self, void *iter)
126 {
127         find_nodes(self, iter);
128         return get_next_node(iter);
129 }
130
131 static ir_node *ifg_std_nodes_next(const void *self, void *iter)
132 {
133         (void) self;
134         return get_next_node(iter);
135 }
136
137 static void ifg_std_nodes_break(const void *self, void *iter)
138 {
139         (void) self;
140         node_break(iter, 1);
141 }
142
143 typedef struct _adj_iter_t {
144         const be_chordal_env_t *env;
145         const ir_node        *irn;
146         int                   valid;
147         ir_nodeset_t          neighbours;
148         ir_nodeset_iterator_t iter;
149 } adj_iter_t;
150
151 static void find_neighbour_walker(ir_node *block, void *data)
152 {
153         adj_iter_t *it          = data;
154         struct list_head *head  = get_block_border_head(it->env, block);
155
156         border_t *b;
157         int has_started = 0;
158
159         if(!be_is_live_in(it->env->birg->lv, block, it->irn) && block != get_nodes_block(it->irn))
160                 return;
161
162         foreach_border_head(head, b) {
163                 ir_node *irn = b->irn;
164
165                 if(irn == it->irn) {
166                         if(b->is_def)
167                                 has_started = 1;
168                         else
169                                 break; /* if we reached the end of the node's lifetime we can safely break */
170                 }
171                 else if(b->is_def) {
172                         /* if any other node than the one in question starts living, add it to the set */
173                         ir_nodeset_insert(&it->neighbours, irn);
174                 }
175                 else if(!has_started) {
176                         /* we only delete, if the live range in question has not yet started */
177                         ir_nodeset_remove(&it->neighbours, irn);
178                 }
179
180         }
181 }
182
183 static void find_neighbours(const ifg_std_t *ifg, adj_iter_t *it, const ir_node *irn)
184 {
185         it->env         = ifg->env;
186         it->irn         = irn;
187         it->valid       = 1;
188         ir_nodeset_init(&it->neighbours);
189
190         dom_tree_walk(get_nodes_block(irn), find_neighbour_walker, NULL, it);
191
192         ir_nodeset_iterator_init(&it->iter, &it->neighbours);
193 }
194
195 static INLINE void neighbours_break(adj_iter_t *it, int force)
196 {
197         (void) force;
198         assert(it->valid == 1);
199         ir_nodeset_destroy(&it->neighbours);
200         it->valid = 0;
201 }
202
203 static ir_node *get_next_neighbour(adj_iter_t *it) {
204         ir_node *res = ir_nodeset_iterator_next(&it->iter);
205
206         if (res == NULL) {
207                 ir_nodeset_destroy(&it->neighbours);
208         }
209         return res;
210 }
211
212 static ir_node *ifg_std_neighbours_begin(const void *self, void *iter, const ir_node *irn)
213 {
214         adj_iter_t *it = iter;
215         find_neighbours(self, iter, irn);
216         return ir_nodeset_iterator_next(&it->iter);
217 }
218
219 static ir_node *ifg_std_neighbours_next(const void *self, void *iter)
220 {
221         (void) self;
222         return get_next_neighbour(iter);
223 }
224
225 static void ifg_std_neighbours_break(const void *self, void *iter)
226 {
227         (void) self;
228         neighbours_break(iter, 1);
229 }
230
231 typedef struct _cliques_iter_t {
232         struct obstack ob;
233         const be_chordal_env_t *cenv;
234         ir_node **buf;
235         ir_node **blocks;
236         int n_blocks, blk;
237         struct list_head *bor;
238         pset *living;
239 } cliques_iter_t;
240
241 static INLINE void free_clique_iter(cliques_iter_t *it) {
242         it->n_blocks = -1;
243         obstack_free(&it->ob, NULL);
244         del_pset(it->living);
245 }
246
247 static void get_blocks_dom_order(ir_node *blk, void *env) {
248         cliques_iter_t *it = env;
249         obstack_ptr_grow(&it->ob, blk);
250 }
251
252 #define pset_foreach(pset, irn)  for(irn=pset_first(pset); irn; irn=pset_next(pset))
253
254
255 /**
256  * NOTE: Be careful when changing this function!
257  *       First understand the control flow of consecutive calls.
258  */
259 static INLINE int get_next_clique(cliques_iter_t *it) {
260
261         /* continue in the block we left the last time */
262         for (; it->blk < it->n_blocks; it->blk++) {
263                 int output_on_shrink = 0;
264                 struct list_head *head = get_block_border_head(it->cenv, it->blocks[it->blk]);
265
266                 /* on entry to a new block set the first border ... */
267                 if (!it->bor)
268                         it->bor = head->prev;
269
270                 /* ... otherwise continue with the border we left the last time */
271                 for (; it->bor != head; it->bor = it->bor->prev) {
272                         border_t *b = list_entry(it->bor, border_t, list);
273
274                         /* if its a definition irn starts living */
275                         if (b->is_def) {
276                                 pset_insert_ptr(it->living, b->irn);
277                                 if (b->is_real)
278                                         output_on_shrink = 1;
279                         } else
280
281                         /* if its the last usage the irn dies */
282                         {
283                                 /* before shrinking the set, return the current maximal clique */
284                                 if (output_on_shrink) {
285                                         int count = 0;
286                                         ir_node *irn;
287
288                                         /* fill the output buffer */
289                                         pset_foreach(it->living, irn)
290                                                 it->buf[count++] = irn;
291
292                                         assert(count > 0 && "We have a 'last usage', so there must be sth. in it->living");
293
294                                         return count;
295                                 }
296
297                                 pset_remove_ptr(it->living, b->irn);
298                         }
299                 }
300
301                 it->bor = NULL;
302                 assert(0 == pset_count(it->living) && "Something has survived! (At the end of the block it->living must be empty)");
303         }
304
305         if (it->n_blocks != -1)
306                 free_clique_iter(it);
307
308         return -1;
309 }
310
311 static int ifg_std_cliques_begin(const void *self, void *iter, ir_node **buf)
312 {
313         const ifg_std_t *ifg = self;
314         cliques_iter_t *it = iter;
315         ir_node *start_bl = get_irg_start_block(ifg->env->irg);
316
317         obstack_init(&it->ob);
318         dom_tree_walk(start_bl, get_blocks_dom_order, NULL, it);
319
320         it->cenv     = ifg->env;
321         it->buf      = buf;
322         it->n_blocks = obstack_object_size(&it->ob) / sizeof(void *);
323         it->blocks   = obstack_finish(&it->ob);
324         it->blk      = 0;
325         it->bor      = NULL;
326         it->living   = pset_new_ptr(2 * arch_register_class_n_regs(it->cenv->cls));
327
328         return get_next_clique(it);
329 }
330
331 static int ifg_std_cliques_next(const void *self, void *iter)
332 {
333         (void) self;
334         return get_next_clique(iter);
335 }
336
337 static void ifg_std_cliques_break(const void *self, void *iter)
338 {
339         (void) self;
340         free_clique_iter(iter);
341 }
342
343
344 static int ifg_std_degree(const void *self, const ir_node *irn)
345 {
346         adj_iter_t it;
347         int degree;
348         find_neighbours(self, &it, irn);
349         degree = ir_nodeset_size(&it.neighbours);
350         neighbours_break(&it, 1);
351         return degree;
352 }
353
354 static const be_ifg_impl_t ifg_std_impl = {
355         sizeof(nodes_iter_t),
356         sizeof(adj_iter_t),
357         sizeof(cliques_iter_t),
358
359         ifg_std_free,
360         ifg_std_connected,
361         ifg_std_neighbours_begin,
362         ifg_std_neighbours_next,
363         ifg_std_neighbours_break,
364         ifg_std_nodes_begin,
365         ifg_std_nodes_next,
366         ifg_std_nodes_break,
367         ifg_std_cliques_begin,
368         ifg_std_cliques_next,
369         ifg_std_cliques_break,
370         ifg_std_degree
371 };
372
373 be_ifg_t *be_ifg_std_new(const be_chordal_env_t *env)
374 {
375         ifg_std_t *ifg = XMALLOC(ifg_std_t);
376
377         ifg->impl = &ifg_std_impl;
378         ifg->env  = env;
379
380         return (be_ifg_t *) ifg;
381 }