a new better version.
[libfirm] / ir / be / bechordal.c
1 /**
2  * Chordal register allocation.
3  * @author Sebastian Hack
4  * @date 8.12.2004
5  *
6  * Copyright (C) Universitaet Karlsruhe
7  * Released under the GPL
8  */
9
10 #ifdef HAVE_CONFIG_H
11 #include "config.h"
12 #endif
13
14 #include <ctype.h>
15
16 #include "obst.h"
17 #include "pset.h"
18 #include "list.h"
19 #include "bitset.h"
20 #include "iterator.h"
21
22 #include "irmode_t.h"
23 #include "irgraph_t.h"
24 #include "irprintf_t.h"
25 #include "irgwalk.h"
26 #include "irdump.h"
27 #include "irdom.h"
28 #include "debug.h"
29 #include "xmalloc.h"
30
31 #include "beutil.h"
32 #include "besched.h"
33 #include "benumb_t.h"
34 #include "besched_t.h"
35 #include "belive_t.h"
36 #include "bearch.h"
37
38 #include "bechordal_t.h"
39 #include "bechordal_draw.h"
40
41 #define DBG_LEVEL SET_LEVEL_0
42 #define NO_COLOR (-1)
43
44 #undef DUMP_INTERVALS
45 #undef DUMP_PRESSURE
46 #undef DUMP_IFG
47
48 #if defined(DUMP_IFG) && !defined(BUILD_GRAPH)
49 #error Must define BUILD_GRAPH to be able to dump it.
50 #endif
51
52
53 #include "fourcc.h"
54
55 /* Make a fourcc for border checking. */
56 #define BORDER_FOURCC                           FOURCC('B', 'O', 'R', 'D')
57
58 static firm_dbg_module_t *dbg;
59
60 #ifdef BUILD_GRAPH
61
62 #define IF_EDGE_HASH(e) ((e)->src ^ (e)->tgt)
63 #define IF_NODE_HASH(n) ((n)->nnr)
64
65 static int if_edge_cmp(const void *p1, const void *p2, size_t size)
66 {
67         const if_edge_t *e1 = p1;
68         const if_edge_t *e2 = p2;
69
70         return !(e1->src == e2->src && e1->tgt == e2->tgt);
71 }
72
73 static int if_node_cmp(const void *p1, const void *p2, size_t size)
74 {
75         const if_node_t *n1 = p1;
76         const if_node_t *n2 = p2;
77
78         return n1->nnr != n2->nnr;
79 }
80
81 static INLINE if_edge_t *edge_init(if_edge_t *edge, int src, int tgt)
82 {
83         /* Bring the smaller entry to src. */
84         if(src > tgt) {
85                 edge->src = tgt;
86                 edge->tgt = src;
87         } else {
88                 edge->src = src;
89                 edge->tgt = tgt;
90         }
91
92         return edge;
93 }
94
95 static INLINE void add_if(const be_chordal_env_t *env, int src, int tgt)
96 {
97         if_edge_t edge;
98         if_node_t node, *src_node, *tgt_node;
99         /* insert edge */
100         edge_init(&edge, src, tgt);
101         set_insert(env->edges, &edge, sizeof(edge), IF_EDGE_HASH(&edge));
102
103         /* insert nodes */
104         node.nnr = src;
105         node.neighb = pset_new_ptr(8);
106         src_node = set_insert(env->nodes, &node, sizeof(node), IF_NODE_HASH(&node));
107         node.nnr = tgt;
108         node.neighb = pset_new_ptr(8);
109         tgt_node = set_insert(env->nodes, &node, sizeof(node), IF_NODE_HASH(&node));
110
111         /* insert neighbors into nodes */
112         pset_insert_ptr(src_node->neighb, tgt_node);
113         pset_insert_ptr(tgt_node->neighb, src_node);
114 }
115
116 static INLINE int are_connected(const be_chordal_env_t *env, int src, int tgt)
117 {
118         if_edge_t edge;
119         edge_init(&edge, src, tgt);
120         return set_find(env->edges, &edge, sizeof(edge), IF_EDGE_HASH(&edge)) != NULL;
121 }
122
123 int ifg_has_edge(const be_chordal_env_t *env, const if_node_t *n1, const if_node_t* n2) {
124         return are_connected(env, n1->nnr, n2->nnr);
125 }
126
127 #ifdef DUMP_IFG
128
129 static void dump_ifg(const be_chordal_env_t *env)
130 {
131         FILE *f;
132         set *edges = env->edges;
133         ir_graph *irg = env->irg;
134         char filename[128];
135
136         ir_snprintf(filename, sizeof(filename), "ifg_%s_%F.dot", env->cls->name, irg);
137
138         if((f = fopen(filename, "wt")) != NULL) {
139                 bitset_pos_t pos;
140                 int n_edges = 0;
141                 if_edge_t *edge;
142                 bitset_t *bs = bitset_malloc(get_graph_node_count(irg));
143
144                 ir_fprintf(f, "graph \"%F\" {\n", irg);
145                 fprintf(f, "\tnode [shape=box,style=filled]\n");
146
147                 for(edge = set_first(edges); edge; edge = set_next(edges)) {
148                         bitset_set(bs, edge->src);
149                         bitset_set(bs, edge->tgt);
150                         n_edges++;
151                 }
152
153                 fprintf(f, "\tx [label=\"nodes: %u, edges: %d\"]\n", bitset_popcnt(bs), n_edges);
154
155                 bitset_foreach(bs, pos) {
156                         int nr = (int) pos;
157                         ir_node *irn = get_irn_for_graph_nr(irg, nr);
158
159                         ir_fprintf(f, "\tn%d [label=\"%+F\"]\n", nr, irn);
160                 }
161
162                 for(edge = set_first(edges); edge; edge = set_next(edges)) {
163                         fprintf(f, "\tn%d -- n%d [len=5]\n", edge->src, edge->tgt);
164                 }
165
166                 fprintf(f, "}\n");
167                 fclose(f);
168
169                 bitset_free(bs);
170         }
171
172 }
173
174 #endif /* DUMP_IFG */
175
176 #endif /* BUILD_GRAPH */
177
178 static void check_border_list(struct list_head *head)
179 {
180   border_t *x;
181   list_for_each_entry(border_t, x, head, list) {
182     assert(x->magic == BORDER_FOURCC);
183   }
184 }
185
186 static void check_heads(be_chordal_env_t *env)
187 {
188   pmap_entry *ent;
189   for(ent = pmap_first(env->border_heads); ent; ent = pmap_next(env->border_heads)) {
190     /* ir_printf("checking border list of block %+F\n", ent->key); */
191     check_border_list(ent->value);
192   }
193 }
194
195
196 /**
197  * Add an interval border to the list of a block's list
198  * of interval border.
199  * @note You always have to create the use before the def.
200  * @param env The environment.
201  * @param head The list head to enqueue the borders.
202  * @param irn The node (value) the border belongs to.
203  * @param pressure The pressure at this point in time.
204  * @param step A time step for the border.
205  * @param is_def Is the border a use or a def.
206  * @return The created border.
207  */
208 static INLINE border_t *border_add(be_chordal_env_t *env, struct list_head *head,
209                         ir_node *irn, unsigned step, unsigned pressure,
210                         unsigned is_def, unsigned is_real)
211 {
212         border_t *b;
213
214         if(!is_def) {
215                 border_t *def;
216
217                 b = obstack_alloc(&env->obst, sizeof(*b));
218
219                 /* also allocate the def and tie it to the use. */
220                 def = obstack_alloc(&env->obst, sizeof(*def));
221     memset(def, 0, sizeof(*def));
222                 b->other_end = def;
223                 def->other_end = b;
224
225                 /*
226                  * Set the link field of the irn to the def.
227                  * This strongly relies on the fact, that the use is always
228                  * made before the def.
229                  */
230                 set_irn_link(irn, def);
231
232                 b->magic = BORDER_FOURCC;
233                 def->magic = BORDER_FOURCC;
234         }
235
236         /*
237          * If the def is encountered, the use was made and so was the
238          * the def node (see the code above). It was placed into the
239          * link field of the irn, so we can get it there.
240          */
241         else {
242                 b = get_irn_link(irn);
243
244                 assert(b && b->magic == BORDER_FOURCC && "Illegal border encountered");
245         }
246
247         b->pressure = pressure;
248         b->is_def = is_def;
249         b->is_real = is_real;
250         b->irn = irn;
251         b->step = step;
252         list_add_tail(&b->list, head);
253         DBG((dbg, LEVEL_5, "\t\t%s adding %+F, step: %d\n",
254                                 is_def ? "def" : "use", irn, step));
255
256
257         return b;
258 }
259
260 static INLINE int has_reg_class(const be_chordal_env_t *env, const ir_node *irn)
261 {
262   return arch_irn_has_reg_class(env->session_env->main_env->arch_env,
263                         irn, arch_pos_make_out(0), env->cls);
264 }
265
266 /**
267  * Annotate the register pressure to the nodes and compute
268  * the liveness intervals.
269  * @param block The block to do it for.
270  * @param env_ptr The environment.
271  */
272 static void pressure(ir_node *block, void *env_ptr)
273 {
274 /* Convenience macro for a def */
275 #define border_def(irn, step, real) \
276         border_add(env, head, irn, step, pressure--, 1, real)
277
278 /* Convenience macro for a use */
279 #define border_use(irn, step, real) \
280         border_add(env, head, irn, step, ++pressure, 0, real)
281
282         be_chordal_env_t *env = env_ptr;
283         bitset_t *live = env->live;
284         ir_node *irn;
285
286         int i, n;
287         unsigned step = 0;
288         unsigned pressure = 0;
289         struct list_head *head;
290         pset *live_in = put_live_in(block, pset_new_ptr_default());
291         pset *live_end = put_live_end(block, pset_new_ptr_default());
292
293         DBG((dbg, LEVEL_1, "Computing pressure in block %+F\n", block));
294         bitset_clear_all(live);
295
296         /* Set up the border list in the block info */
297         head = obstack_alloc(&env->obst, sizeof(*head));
298         INIT_LIST_HEAD(head);
299   assert(pmap_get(env->border_heads, block) == NULL);
300         pmap_insert(env->border_heads, block, head);
301
302         /*
303          * Make final uses of all values live out of the block.
304          * They are necessary to build up real intervals.
305          */
306         for(irn = pset_first(live_end); irn; irn = pset_next(live_end)) {
307                 if(has_reg_class(env, irn)) {
308                         DBG((dbg, LEVEL_3, "\tMaking live: %+F/%d\n", irn, get_irn_graph_nr(irn)));
309                         bitset_set(live, get_irn_graph_nr(irn));
310                         border_use(irn, step, 0);
311                 }
312         }
313         ++step;
314
315         /*
316          * Determine the last uses of a value inside the block, since they are
317          * relevant for the interval borders.
318          */
319         sched_foreach_reverse(block, irn) {
320                 DBG((dbg, LEVEL_1, "\tinsn: %+F, pressure: %d\n", irn, pressure));
321                 DBG((dbg, LEVEL_2, "\tlive: %b\n", live));
322
323             /*
324              * If the node defines some value, which can put into a
325              * register of the current class, make a border for it.
326              */
327                 if(has_reg_class(env, irn)) {
328                         bitset_pos_t elm;
329                         int nr = get_irn_graph_nr(irn);
330
331                         bitset_clear(live, nr);
332                         border_def(irn, step, 1);
333
334 #ifdef BUILD_GRAPH
335                         bitset_foreach(live, elm)
336                                 add_if(env, nr, (int) elm);
337 #endif
338                 }
339
340                 /*
341                  * If the node is no phi node we can examine the uses.
342                  */
343                 if(!is_Phi(irn)) {
344                         for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
345                                 ir_node *op = get_irn_n(irn, i);
346
347                                 if(has_reg_class(env, op)) {
348                                         int nr = get_irn_graph_nr(op);
349
350                                         DBG((dbg, LEVEL_4, "\t\tpos: %d, use: %+F\n", i, op));
351
352                                         if(!bitset_is_set(live, nr)) {
353                                                 border_use(op, step, 1);
354                                                 bitset_set(live, nr);
355                                         }
356                                 }
357                         }
358                 }
359                 ++step;
360         }
361
362         /*
363          * Add initial defs for all values live in.
364          */
365         for(irn = pset_first(live_in); irn; irn = pset_next(live_in)) {
366                 if(has_reg_class(env, irn)) {
367
368                         /* Mark the value live in. */
369                         bitset_set(live, get_irn_graph_nr(irn));
370
371                         /* Add the def */
372                         border_def(irn, step, 0);
373                 }
374         }
375
376
377   del_pset(live_in);
378   del_pset(live_end);
379 }
380
381 static void assign(ir_node *block, void *env_ptr)
382 {
383         be_chordal_env_t *env = env_ptr;
384         bitset_t *live = env->live;
385         bitset_t *colors = env->colors;
386         bitset_t *in_colors = env->in_colors;
387         const arch_env_t *arch_env = env->session_env->main_env->arch_env;
388
389         const ir_node *irn;
390         border_t *b;
391         struct list_head *head = get_block_border_head(env, block);
392         pset *live_in = put_live_in(block, pset_new_ptr_default());
393
394         bitset_clear_all(live);
395         bitset_clear_all(colors);
396         bitset_clear_all(in_colors);
397
398         DBG((dbg, LEVEL_4, "Assigning colors for block %+F\n", block));
399         DBG((dbg, LEVEL_4, "\tusedef chain for block\n"));
400         list_for_each_entry(border_t, b, head, list) {
401                 DBG((dbg, LEVEL_4, "\t%s %+F/%d\n", b->is_def ? "def" : "use",
402                                         b->irn, get_irn_graph_nr(b->irn)));
403         }
404
405         /*
406          * Add initial defs for all values live in.
407          * Since their colors have already been assigned (The dominators were
408          * allocated before), we have to mark their colors as used also.
409          */
410         for(irn = pset_first(live_in); irn; irn = pset_next(live_in)) {
411                 if(has_reg_class(env, irn)) {
412                         const arch_register_t *reg = arch_get_irn_register(arch_env, irn, 0);
413                         int col;
414
415                         assert(reg && "Node must have been assigned a register");
416                         col = arch_register_get_index(reg);
417
418                         /* Mark the color of the live in value as used. */
419                         bitset_set(colors, col);
420                         bitset_set(in_colors, col);
421
422                         /* Mark the value live in. */
423                         bitset_set(live, get_irn_graph_nr(irn));
424                 }
425         }
426
427         /*
428          * Mind that the sequence of defs from back to front defines a perfect
429          * elimination order. So, coloring the definitions from first to last
430          * will work.
431          */
432         list_for_each_entry_reverse(border_t, b, head, list) {
433                 ir_node *irn = b->irn;
434                 int nr = get_irn_graph_nr(irn);
435
436                 /*
437                  * Assign a color, if it is a local def. Global defs already have a
438                  * color.
439                  */
440                 if(b->is_def && !is_live_in(block, irn)) {
441                         const arch_register_t *reg;
442                         int col = NO_COLOR;
443
444                         DBG((dbg, LEVEL_4, "\tcolors in use: %b\n", colors));
445
446                         col = bitset_next_clear(colors, 0);
447                         reg = arch_register_for_index(env->cls, col);
448
449                         assert(arch_get_irn_register(arch_env, irn, 0) == NULL && "This node must not have been assigned a register yet");
450                         assert(!bitset_is_set(live, nr) && "Value's definition must not have been encountered");
451
452                         bitset_set(colors, col);
453                         bitset_set(live, nr);
454
455                         arch_set_irn_register(arch_env, irn, 0, reg);
456                         DBG((dbg, LEVEL_1, "\tassigning register %s(%d) to %+F\n",
457             arch_register_get_name(reg), col, irn));
458                 }
459
460                 /* Clear the color upon a use. */
461                 else if(!b->is_def) {
462                         const arch_register_t *reg = arch_get_irn_register(arch_env, irn, 0);
463                         int col;
464
465                         assert(reg && "Register must have been assigned");
466
467                         col = arch_register_get_index(reg);
468                         assert(bitset_is_set(live, nr) && "Cannot have a non live use");
469
470                         bitset_clear(colors, col);
471                         bitset_clear(live, nr);
472                 }
473         }
474
475         del_pset(live_in);
476 }
477
478 void be_ra_chordal_init(void)
479 {
480         dbg = firm_dbg_register(DBG_CHORDAL);
481         firm_dbg_set_mask(dbg, DBG_LEVEL);
482 }
483
484 be_chordal_env_t *be_ra_chordal(
485     const be_main_session_env_t *session,
486     const arch_register_class_t *cls)
487 {
488   ir_graph *irg = session->irg;
489         int node_count = get_graph_node_count(irg);
490         int colors_n = arch_register_class_n_regs(cls);
491         be_chordal_env_t *env = malloc(sizeof(*env));
492
493         if(get_irg_dom_state(irg) != dom_consistent)
494                 compute_doms(irg);
495
496         obstack_init(&env->obst);
497
498 #ifdef BUILD_GRAPH
499         env->edges = new_set(if_edge_cmp, node_count);
500         env->nodes = new_set(if_node_cmp, node_count);
501 #endif
502
503   env->session_env = session;
504         env->live = bitset_obstack_alloc(&env->obst, node_count);
505         env->colors = bitset_obstack_alloc(&env->obst, colors_n);
506         env->in_colors = bitset_obstack_alloc(&env->obst, colors_n);
507         env->colors_n = colors_n;
508         env->cls = cls;
509         env->border_heads = pmap_create();
510
511         /* First, determine the pressure */
512         dom_tree_walk_irg(irg, pressure, NULL, env);
513
514         /* Insert probable spills */
515         be_ra_chordal_spill(env);
516
517         /* Assign the colors */
518         dom_tree_walk_irg(irg, assign, NULL, env);
519
520 #ifdef DUMP_IFG
521         dump_ifg(env);
522 #endif
523
524 #ifdef DUMP_INTERVALS
525         {
526                 char buf[128];
527         plotter_t *plotter;
528
529                 ir_snprintf(buf, sizeof(buf), "ifg_%s_%F.eps", cls->name, irg);
530         plotter = new_plotter_ps(buf);
531
532         draw_interval_tree(&draw_chordal_def_opts, env, plotter, env->session_env->main_env->arch_env, cls);
533         plotter_free(plotter);
534         }
535 #endif
536         return env;
537 }
538
539 void be_ra_chordal_check(be_chordal_env_t *chordal_env) {
540         const arch_env_t *arch_env = chordal_env->session_env->main_env->arch_env;
541         struct obstack ob;
542         pmap_entry *pme;
543         ir_node **nodes, *n1, *n2;
544         int i, o;
545
546         /* Collect all irns */
547         obstack_init(&ob);
548         pmap_foreach(chordal_env->border_heads, pme) {
549                 border_t *curr;
550                 struct list_head *head = pme->value;
551                 list_for_each_entry(border_t, curr, head, list)
552                         if (curr->is_def && curr->is_real)
553                                 if (arch_get_irn_reg_class(arch_env, curr->irn, arch_pos_make_out(0)) == chordal_env->cls)
554                                         obstack_ptr_grow(&ob, curr->irn);
555         }
556         obstack_ptr_grow(&ob, NULL);
557         nodes = (ir_node **) obstack_finish(&ob);
558
559         /* Check them */
560         for (i = 0, n1 = nodes[i]; n1; n1 = nodes[++i]) {
561                 const arch_register_t *n1_reg, *n2_reg;
562
563                 n1_reg = arch_get_irn_register(arch_env, n1, 0);
564                 if (!arch_reg_is_allocatable(arch_env, n1, arch_pos_make_out(0), n1_reg)) {
565                         DBG((dbg, 0, "Register assigned to %+F is not allowed\n", n1));
566                         assert(0 && "Register constraint does not hold");
567                 }
568                 for (o = i+1, n2 = nodes[o]; n2; n2 = nodes[++o]) {
569                         n2_reg = arch_get_irn_register(arch_env, n2, 0);
570                         if (nodes_interfere(chordal_env, n1, n2) && n1_reg == n2_reg) {
571                                 DBG((dbg, 0, "Values %+F and %+F interfere and have the same register assigned\n", n1, n2));
572                                 assert(0 && "Interfering values have the same color!");
573                         }
574                 }
575         }
576         obstack_free(&ob, NULL);
577 }
578
579 /* BETTER #ifdef BUILD_GRAPH --> faster version of checker with edges */
580
581 void be_ra_chordal_done(be_chordal_env_t *env)
582 {
583 #ifdef BUILD_GRAPH
584         {
585                 if_node_t *ifn;
586                 for(ifn = set_first(env->nodes); ifn; ifn = set_next(env->nodes))
587                         free(ifn->neighb);
588                 free(env->nodes);
589                 free(env->edges);
590         }
591 #endif
592
593   pmap_destroy(env->border_heads);
594         obstack_free(&env->obst, NULL);
595         free(env);
596 }
597
598
599
600 int nodes_interfere(const be_chordal_env_t *env, const ir_node *a, const ir_node *b)
601 {
602 #ifdef BUILD_GRAPH
603         return are_connected(env, get_irn_graph_nr(a), get_irn_graph_nr(b));
604 #else
605         return values_interfere(a, b);
606 #endif /* BUILD_GRAPH */
607 }
608
609 #ifdef BUILD_GRAPH
610
611 set *be_ra_get_ifg_edges(const be_chordal_env_t *env) {
612         return env->edges;
613 }
614
615 set *be_ra_get_ifg_nodes(const be_chordal_env_t *env) {
616         return env->nodes;
617 }
618
619 #endif
620
621 typedef struct {
622         const be_main_session_env_t *env;
623         const arch_register_class_t *cls;
624 } check_pressure_info_t;
625
626
627 static int check_pressure_has_class(const check_pressure_info_t *i, const ir_node *irn)
628 {
629   return arch_irn_has_reg_class(i->env->main_env->arch_env,
630       irn, arch_pos_make_out(0), i->cls);
631 }
632
633 static void check_pressure_walker(ir_node *bl, void *data)
634 {
635         firm_dbg_module_t *dbg = firm_dbg_register("be.ra.pressure");
636         check_pressure_info_t *info = data;
637         int n_regs = arch_register_class_n_regs(info->cls);
638
639         pset *live = pset_new_ptr_default();
640         int step = 0;
641         ir_node *irn;
642         irn_live_t *li;
643
644 //      firm_dbg_set_mask(dbg, -1);
645
646         live_foreach(bl, li) {
647                 if(live_is_end(li) && check_pressure_has_class(info, li->irn)) {
648                         ir_node *irn = (ir_node *) li->irn;
649                         pset_insert_ptr(live, irn);
650                 }
651         }
652
653         DBG((dbg, LEVEL_1, "end set for %+F\n", bl));
654         for(irn = pset_first(live); irn; irn = pset_next(live))
655                 DBG((dbg, LEVEL_1, "\t%+F\n", irn));
656
657         sched_foreach_reverse(bl, irn) {
658                 int i, n;
659                 int pressure = pset_count(live);
660
661                 DBG((dbg, LEVEL_1, "%+10F@%+10F: pressure %d\n", bl, irn, pressure));
662
663                 if(pressure > n_regs) {
664                         ir_node *x;
665                         ir_printf("%+10F@%+10F: pressure to high: %d\n", bl, irn, pressure);
666                         for(x = pset_first(live); x; x = pset_next(live))
667                                 ir_printf("\t%+10F\n", x);
668                 }
669
670                 if(check_pressure_has_class(info, irn))
671                         pset_remove_ptr(live, irn);
672
673                 for(i = 0, n = get_irn_arity(irn); i < n; i++) {
674                         ir_node *op = get_irn_n(irn, i);
675                         if(check_pressure_has_class(info, op) && !is_Phi(irn))
676                                 pset_insert_ptr(live, op);
677                 }
678                 step++;
679         }
680 }
681
682 void be_check_pressure(const be_main_session_env_t *env, const arch_register_class_t *cls)
683 {
684         check_pressure_info_t i;
685         i.env = env;
686         i.cls = cls;
687         irg_block_walk_graph(env->irg, check_pressure_walker, NULL, &i);
688 }