8aec639b57c0900bacbc0bbe8d101228dafc44b7
[libfirm] / ir / be / bechordal.c
1 /*
2  * Copyright (C) 1995-2007 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       Chordal register allocation.
23  * @author      Sebastian Hack
24  * @date        08.12.2004
25  * @version     $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <ctype.h>
32
33 #include "obst.h"
34 #include "pset.h"
35 #include "list.h"
36 #include "bitset.h"
37 #include "raw_bitset.h"
38 #include "iterator.h"
39 #include "bipartite.h"
40 #include "hungarian.h"
41
42 #include "irmode_t.h"
43 #include "irgraph_t.h"
44 #include "irprintf_t.h"
45 #include "irgwalk.h"
46 #include "irdump.h"
47 #include "irdom.h"
48 #include "irtools.h"
49 #include "irbitset.h"
50 #include "debug.h"
51 #include "xmalloc.h"
52 #include "iredges.h"
53
54 #include "beutil.h"
55 #include "besched.h"
56 #include "besched_t.h"
57 #include "belive_t.h"
58 #include "benode_t.h"
59 #include "bearch_t.h"
60 #include "beirgmod.h"
61 #include "beifg.h"
62 #include "beinsn_t.h"
63 #include "bestatevent.h"
64 #include "beirg_t.h"
65 #include "beintlive_t.h"
66 #include "bera.h"
67 #include "bechordal_t.h"
68 #include "bechordal_draw.h"
69 #include "bemodule.h"
70
71 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
72
73 #define NO_COLOR (-1)
74
75 #define DUMP_INTERVALS
76
77 /* new style assign routine without borders. */
78 #undef NEW_STYLE_ASSIGN
79
80 typedef struct _be_chordal_alloc_env_t {
81         be_chordal_env_t *chordal_env;
82
83         pset *pre_colored;              /**< Set of precolored nodes. */
84         bitset_t *live;                             /**< A liveness bitset. */
85         bitset_t *tmp_colors;           /**< An auxiliary bitset which is as long as the number of colors in the class. */
86         bitset_t *colors;                           /**< The color mask. */
87         bitset_t *in_colors;            /**< Colors used by live in values. */
88         int colors_n;                   /**< The number of colors. */
89 } be_chordal_alloc_env_t;
90
91 #include "fourcc.h"
92
93 /* Make a fourcc for border checking. */
94 #define BORDER_FOURCC                           FOURCC('B', 'O', 'R', 'D')
95
96 #if 0
97 static void check_border_list(struct list_head *head)
98 {
99   border_t *x;
100   list_for_each_entry(border_t, x, head, list) {
101     assert(x->magic == BORDER_FOURCC);
102   }
103 }
104
105 static void check_heads(be_chordal_env_t *env)
106 {
107   pmap_entry *ent;
108   for(ent = pmap_first(env->border_heads); ent; ent = pmap_next(env->border_heads)) {
109     /* ir_printf("checking border list of block %+F\n", ent->key); */
110     check_border_list(ent->value);
111   }
112 }
113 #endif
114
115 /**
116  * Add an interval border to the list of a block's list
117  * of interval border.
118  * @note You always have to create the use before the def.
119  * @param env The environment.
120  * @param head The list head to enqueue the borders.
121  * @param irn The node (value) the border belongs to.
122  * @param pressure The pressure at this point in time.
123  * @param step A time step for the border.
124  * @param is_def Is the border a use or a def.
125  * @return The created border.
126  */
127 static INLINE border_t *border_add(be_chordal_env_t *env, struct list_head *head,
128                         ir_node *irn, unsigned step, unsigned pressure,
129                         unsigned is_def, unsigned is_real)
130 {
131         border_t *b;
132
133         if(!is_def) {
134                 border_t *def;
135
136                 b = obstack_alloc(env->obst, sizeof(*b));
137
138                 /* also allocate the def and tie it to the use. */
139                 def = obstack_alloc(env->obst, sizeof(*def));
140                 memset(def, 0, sizeof(*def));
141                 b->other_end = def;
142                 def->other_end = b;
143
144                 /*
145                  * Set the link field of the irn to the def.
146                  * This strongly relies on the fact, that the use is always
147                  * made before the def.
148                  */
149                 set_irn_link(irn, def);
150
151                 DEBUG_ONLY(b->magic = BORDER_FOURCC);
152                 DEBUG_ONLY(def->magic = BORDER_FOURCC);
153         }
154
155         /*
156          * If the def is encountered, the use was made and so was the
157          * the def node (see the code above). It was placed into the
158          * link field of the irn, so we can get it there.
159          */
160         else {
161                 b = get_irn_link(irn);
162
163                 assert(b && b->magic == BORDER_FOURCC && "Illegal border encountered");
164         }
165
166         b->pressure = pressure;
167         b->is_def = is_def;
168         b->is_real = is_real;
169         b->irn = irn;
170         b->step = step;
171         list_add_tail(&b->list, head);
172         DBG((dbg, LEVEL_5, "\t\t%s adding %+F, step: %d\n", is_def ? "def" : "use", irn, step));
173
174
175         return b;
176 }
177
178 /**
179  * Check, if an irn is of the register class currently under processing.
180  * @param env The chordal environment.
181  * @param irn The node.
182  * @return 1, if the node is of that register class, 0 if not.
183  */
184 static INLINE int has_reg_class(const be_chordal_env_t *env, const ir_node *irn)
185 {
186         return arch_irn_consider_in_reg_alloc(env->birg->main_env->arch_env, env->cls, irn);
187 }
188
189 #define has_limited_constr(req, irn) \
190         (arch_get_register_req(arch_env, (req), irn, -1) && (req)->type == arch_register_req_type_limited)
191
192 static int get_next_free_reg(const be_chordal_alloc_env_t *alloc_env, bitset_t *colors)
193 {
194         bitset_t *tmp = alloc_env->tmp_colors;
195         bitset_copy(tmp, colors);
196         bitset_or(tmp, alloc_env->chordal_env->ignore_colors);
197         return bitset_next_clear(tmp, 0);
198 }
199
200 static bitset_t *get_decisive_partner_regs(bitset_t *bs, const be_operand_t *o1, const be_operand_t *o2)
201 {
202         bitset_t *res = bs;
203
204         if(!o1) {
205                 bitset_copy(bs, o2->regs);
206                 return bs;
207         }
208
209         if(!o2) {
210                 bitset_copy(bs, o1->regs);
211                 return bs;
212         }
213
214         assert(o1->req->cls == o2->req->cls || ! o1->req->cls || ! o2->req->cls);
215
216         if(bitset_contains(o1->regs, o2->regs))
217                 bitset_copy(bs, o1->regs);
218         else if(bitset_contains(o2->regs, o1->regs))
219                 bitset_copy(bs, o2->regs);
220         else
221                 res = NULL;
222
223         return res;
224 }
225
226 static be_insn_t *chordal_scan_insn(be_chordal_env_t *env, ir_node *irn)
227 {
228         be_insn_env_t ie;
229
230         ie.ignore_colors = env->ignore_colors;
231         ie.aenv          = env->birg->main_env->arch_env;
232         ie.obst          = env->obst;
233         ie.cls           = env->cls;
234         return be_scan_insn(&ie, irn);
235 }
236
237 static ir_node *prepare_constr_insn(be_chordal_env_t *env, ir_node *irn)
238 {
239         const be_irg_t *birg   = env->birg;
240         const arch_env_t *aenv = birg->main_env->arch_env;
241         bitset_t *tmp          = bitset_alloca(env->cls->n_regs);
242         bitset_t *def_constr   = bitset_alloca(env->cls->n_regs);
243         ir_node *bl            = get_nodes_block(irn);
244         be_lv_t *lv            = env->birg->lv;
245
246         be_insn_t *insn;
247         int i, j;
248
249         for (i = get_irn_arity(irn) - 1; i >= 0; --i) {
250                 ir_node *op = get_irn_n(irn, i);
251                 ir_node *copy;
252                 const arch_register_t *reg;
253                 const arch_register_req_t *req;
254
255                 if (arch_get_irn_reg_class(aenv, irn, i) != env->cls)
256                         continue;
257
258                 reg = arch_get_irn_register(aenv, op);
259
260                 if (reg == NULL || !arch_register_type_is(reg, ignore))
261                         continue;
262                 if(arch_register_type_is(reg, joker))
263                         continue;
264
265                 req = arch_get_register_req(aenv, irn, i);
266                 if (!arch_register_req_is(req, limited))
267                         continue;
268
269                 if (rbitset_is_set(req->limited, reg->index))
270                         continue;
271
272                 copy = be_new_Copy(env->cls, env->irg, bl, op);
273                 be_stat_ev("constr_copy", 1);
274
275                 sched_add_before(irn, copy);
276                 set_irn_n(irn, i, copy);
277                 DBG((dbg, LEVEL_3, "inserting ignore arg copy %+F for %+F pos %d\n", copy, irn, i));
278         }
279
280     insn = chordal_scan_insn(env, irn);
281
282         if(!insn->has_constraints)
283                 goto end;
284
285         /* insert copies for nodes that occur constrained more than once. */
286         for(i = insn->use_start; i < insn->n_ops; ++i) {
287                 be_operand_t *op = &insn->ops[i];
288
289                 if(!op->has_constraints)
290                         continue;
291
292                 for(j = i + 1; j < insn->n_ops; ++j) {
293                         ir_node *copy;
294                         be_operand_t *a_op = &insn->ops[j];
295
296                         if(a_op->carrier != op->carrier || !a_op->has_constraints)
297                                 continue;
298
299                         if (be_is_Copy(get_irn_n(insn->irn, a_op->pos)))
300                                 continue;
301
302                         copy = be_new_Copy(env->cls, env->irg, bl, op->carrier);
303                         be_stat_ev("constr_copy", 1);
304
305                         sched_add_before(insn->irn, copy);
306                         set_irn_n(insn->irn, a_op->pos, copy);
307                         DBG((dbg, LEVEL_3, "inserting multiple constr copy %+F for %+F pos %d\n", copy, insn->irn, a_op->pos));
308                 }
309         }
310
311         /* collect all registers occuring in out constraints. */
312         for(i = 0; i < insn->use_start; ++i) {
313                 be_operand_t *op = &insn->ops[i];
314                 if(op->has_constraints)
315                         bitset_or(def_constr, op->regs);
316         }
317
318         /*
319                 insert copies for all constrained arguments living through the node
320                 and being constrained to a register which also occurs in out constraints.
321         */
322         for(i = insn->use_start; i < insn->n_ops; ++i) {
323                 ir_node *copy;
324                 be_operand_t *op = &insn->ops[i];
325
326                 bitset_copy(tmp, op->regs);
327                 bitset_and(tmp, def_constr);
328
329                 /*
330                         Check, if
331                         1) the operand is constrained.
332                         2) lives through the node.
333                         3) is constrained to a register occuring in out constraints.
334                 */
335                 if(!op->has_constraints ||
336                                 !values_interfere(birg, insn->irn, op->carrier) ||
337                                 bitset_popcnt(tmp) == 0)
338                         continue;
339
340                 /*
341                    only create the copy if the operand is no copy.
342                    this is necessary since the assure constraints phase inserts
343                    Copies and Keeps for operands which must be different from the results.
344                    Additional copies here would destroy this.
345                  */
346                 if (be_is_Copy(get_irn_n(insn->irn, op->pos)))
347                         continue;
348
349                 copy = be_new_Copy(env->cls, env->irg, bl, op->carrier);
350
351                 sched_add_before(insn->irn, copy);
352                 set_irn_n(insn->irn, op->pos, copy);
353                 DBG((dbg, LEVEL_3, "inserting constr copy %+F for %+F pos %d\n", copy, insn->irn, op->pos));
354                 be_liveness_update(lv, op->carrier);
355         }
356
357 end:
358         obstack_free(env->obst, insn);
359         return insn->next_insn;
360 }
361
362 static void pre_spill_prepare_constr_walker(ir_node *bl, void *data)
363 {
364         be_chordal_env_t *env = data;
365         ir_node *irn;
366         for(irn = sched_first(bl); !sched_is_end(irn);) {
367                 irn = prepare_constr_insn(env, irn);
368         }
369 }
370
371 void be_pre_spill_prepare_constr(be_chordal_env_t *cenv) {
372         irg_block_walk_graph(cenv->irg, pre_spill_prepare_constr_walker, NULL, (void *) cenv);
373 }
374
375 static void pair_up_operands(const be_chordal_alloc_env_t *alloc_env, be_insn_t *insn)
376 {
377         const be_chordal_env_t *env = alloc_env->chordal_env;
378
379         int n_uses   = be_insn_n_uses(insn);
380         int n_defs   = be_insn_n_defs(insn);
381         bitset_t *bs = bitset_alloca(env->cls->n_regs);
382         int *pairing = alloca(MAX(n_defs, n_uses) * sizeof(pairing[0]));
383
384         int i, j;
385
386         /*
387                 For each out operand, try to find an in operand which can be assigned the
388                 same register as the out operand.
389         */
390         for (j = 0; j < insn->use_start; ++j) {
391                 int smallest         = -1;
392                 int smallest_n_regs  = 2 * env->cls->n_regs + 1;
393                 be_operand_t *out_op = &insn->ops[j];
394
395                 /* Try to find an in operand which has ... */
396                 for(i = insn->use_start; i < insn->n_ops; ++i) {
397                         int n_total;
398                         const be_operand_t *op = &insn->ops[i];
399
400                         if (op->partner != NULL)
401                                 continue;
402                         if (values_interfere(env->birg, op->irn, op->carrier))
403                                 continue;
404
405                         bitset_clear_all(bs);
406                         bitset_copy(bs, op->regs);
407                         bitset_and(bs, out_op->regs);
408                         n_total = bitset_popcnt(op->regs) + bitset_popcnt(out_op->regs);
409
410                         if (bitset_popcnt(bs) > 0 && n_total < smallest_n_regs) {
411                                 smallest = i;
412                                 smallest_n_regs = n_total;
413                         }
414                 }
415
416                 if (smallest >= 0) {
417                         be_operand_t *partner = &insn->ops[smallest];
418
419                         for(i = insn->use_start; i < insn->n_ops; ++i) {
420                                 if(insn->ops[i].carrier == partner->carrier)
421                                         insn->ops[i].partner = out_op;
422                         }
423
424                         out_op->partner  = partner;
425                         partner->partner = out_op;
426                 }
427         }
428 }
429
430
431 static ir_node *pre_process_constraints(be_chordal_alloc_env_t *alloc_env,
432                                         be_insn_t **the_insn)
433 {
434         be_chordal_env_t *env       = alloc_env->chordal_env;
435         const arch_env_t *aenv      = env->birg->main_env->arch_env;
436         be_insn_t *insn             = *the_insn;
437         ir_node *perm               = NULL;
438         bitset_t *out_constr        = bitset_alloca(env->cls->n_regs);
439         const ir_edge_t *edge;
440         int i;
441
442         assert(insn->has_constraints && "only do this for constrained nodes");
443
444         /*
445                 Collect all registers that occur in output constraints.
446                 This is necessary, since if the insn has one of these as an input constraint
447                 and the corresponding operand interferes with the insn, the operand must
448                 be copied.
449         */
450         for(i = 0; i < insn->use_start; ++i) {
451                 be_operand_t *op = &insn->ops[i];
452                 if(op->has_constraints)
453                         bitset_or(out_constr, op->regs);
454         }
455
456         /*
457                 Make the Perm, recompute liveness and re-scan the insn since the
458                 in operands are now the Projs of the Perm.
459         */
460         perm = insert_Perm_after(env->birg, env->cls, sched_prev(insn->irn));
461
462         /* Registers are propagated by insert_Perm_after(). Clean them here! */
463         if(perm == NULL)
464                 return NULL;
465
466         be_stat_ev("constr_perm", get_irn_arity(perm));
467         foreach_out_edge(perm, edge) {
468                 ir_node *proj = get_edge_src_irn(edge);
469                 arch_set_irn_register(aenv, proj, NULL);
470         }
471
472         /*
473                 We also have to re-build the insn since the input operands are now the Projs of
474                 the Perm. Recomputing liveness is also a good idea if a Perm is inserted, since
475                 the live sets may change.
476         */
477         // be_liveness_recompute(lv);
478         obstack_free(env->obst, insn);
479         *the_insn = insn = chordal_scan_insn(env, insn->irn);
480
481         /*
482                 Copy the input constraints of the insn to the Perm as output
483                 constraints. Succeeding phases (coalescing) will need that.
484         */
485         for(i = insn->use_start; i < insn->n_ops; ++i) {
486                 be_operand_t *op = &insn->ops[i];
487                 ir_node *proj = op->carrier;
488                 /*
489                         Note that the predecessor must not be a Proj of the Perm,
490                         since ignore-nodes are not Perm'ed.
491                 */
492                 if(op->has_constraints &&  is_Proj(proj) && get_Proj_pred(proj) == perm) {
493                         be_set_constr_limited(perm, BE_OUT_POS(get_Proj_proj(proj)), op->req);
494                 }
495         }
496
497         return perm;
498 }
499
500 static ir_node *handle_constraints(be_chordal_alloc_env_t *alloc_env,
501                                    ir_node *irn, int *silent)
502 {
503         const arch_env_t *aenv;
504         int n_regs;
505         bitset_t *bs;
506         ir_node **alloc_nodes;
507         hungarian_problem_t *bp;
508         int *assignment;
509         pmap *partners;
510         int i, n_alloc;
511         bitset_pos_t col;
512         const ir_edge_t *edge;
513         ir_node *perm = NULL;
514         int match_res, cost;
515         be_chordal_env_t *env  = alloc_env->chordal_env;
516         void *base             = obstack_base(env->obst);
517         be_insn_t *insn        = chordal_scan_insn(env, irn);
518         ir_node *res           = insn->next_insn;
519         int be_silent          = *silent;
520         be_irg_t *birg         = env->birg;
521
522         if(insn->pre_colored) {
523                 int i;
524                 for(i = 0; i < insn->use_start; ++i)
525                         pset_insert_ptr(alloc_env->pre_colored, insn->ops[i].carrier);
526         }
527
528         /*
529                 If the current node is a barrier toggle the silent flag.
530                 If we are in the start block, we are ought to be silent at the beginning,
531                 so the toggling activates the constraint handling but skips the barrier.
532                 If we are in the end block we handle the in requirements of the barrier
533                 and set the rest to silent.
534         */
535         if(be_is_Barrier(irn))
536                 *silent = !*silent;
537
538         if(be_silent)
539                 goto end;
540
541         /*
542                 Perms inserted before the constraint handling phase are considered to be
543                 correctly precolored. These Perms arise during the ABI handling phase.
544         */
545         if(!insn->has_constraints)
546                 goto end;
547
548         aenv        = env->birg->main_env->arch_env;
549         n_regs      = env->cls->n_regs;
550         bs          = bitset_alloca(n_regs);
551         alloc_nodes = alloca(n_regs * sizeof(alloc_nodes[0]));
552         bp          = hungarian_new(n_regs, n_regs, 2, HUNGARIAN_MATCH_PERFECT);
553         // bipartite_t *bp        = bipartite_new(n_regs, n_regs);
554         assignment  = alloca(n_regs * sizeof(assignment[0]));
555         partners    = pmap_create();
556
557         /*
558                 prepare the constraint handling of this node.
559                 Perms are constructed and Copies are created for constrained values
560                 interfering with the instruction.
561         */
562         perm = pre_process_constraints(alloc_env, &insn);
563
564         /* find suitable in operands to the out operands of the node. */
565         pair_up_operands(alloc_env, insn);
566
567         /*
568                 look at the in/out operands and add each operand (and its possible partner)
569                 to a bipartite graph (left: nodes with partners, right: admissible colors).
570         */
571         for(i = 0, n_alloc = 0; i < insn->n_ops; ++i) {
572                 be_operand_t *op = &insn->ops[i];
573
574                 /*
575                         If the operand has no partner or the partner has not been marked
576                         for allocation, determine the admissible registers and mark it
577                         for allocation by associating the node and its partner with the
578                         set of admissible registers via a bipartite graph.
579                 */
580                 if(!op->partner || !pmap_contains(partners, op->partner->carrier)) {
581                         pmap_insert(partners, op->carrier,
582                                     op->partner ? op->partner->carrier : NULL);
583
584                         alloc_nodes[n_alloc] = op->carrier;
585
586                         DBG((dbg, LEVEL_2, "\tassociating %+F and %+F\n", op->carrier,
587                              op->partner ? op->partner->carrier : NULL));
588
589                         bitset_clear_all(bs);
590                         get_decisive_partner_regs(bs, op, op->partner);
591
592                         DBG((dbg, LEVEL_2, "\tallowed registers for %+F: %B\n", op->carrier,
593                              bs));
594
595                         bitset_foreach(bs, col) {
596                                 hungarian_add(bp, n_alloc, col, 1);
597                                 // bipartite_add(bp, n_alloc, col);
598                         }
599
600                         n_alloc++;
601                 }
602         }
603
604         /*
605                 Put all nodes which live through the constrained instruction also to the
606                 allocation bipartite graph. They are considered unconstrained.
607         */
608         if(perm != NULL) {
609                 foreach_out_edge(perm, edge) {
610                         ir_node *proj = get_edge_src_irn(edge);
611
612                         assert(is_Proj(proj));
613
614                         if(!values_interfere(birg, proj, irn) || pmap_contains(partners, proj))
615                                 continue;
616
617                         assert(n_alloc < n_regs);
618
619                         alloc_nodes[n_alloc] = proj;
620                         pmap_insert(partners, proj, NULL);
621
622                         bitset_clear_all(bs);
623                         arch_put_non_ignore_regs(aenv, env->cls, bs);
624                         bitset_andnot(bs, env->ignore_colors);
625                         bitset_foreach(bs, col) {
626                                 hungarian_add(bp, n_alloc, col, 1);
627                                 // bipartite_add(bp, n_alloc, col);
628                         }
629
630                         n_alloc++;
631                 }
632         }
633
634         /* Compute a valid register allocation. */
635         hungarian_prepare_cost_matrix(bp, HUNGARIAN_MODE_MAXIMIZE_UTIL);
636         match_res = hungarian_solve(bp, assignment, &cost, 1);
637         assert(match_res == 0 && "matching failed");
638         //bipartite_matching(bp, assignment);
639
640         /* Assign colors obtained from the matching. */
641         for(i = 0; i < n_alloc; ++i) {
642                 const arch_register_t *reg;
643                 ir_node *nodes[2];
644                 int j;
645
646                 assert(assignment[i] >= 0 && "there must have been a register assigned");
647                 reg = arch_register_for_index(env->cls, assignment[i]);
648
649                 nodes[0] = alloc_nodes[i];
650                 nodes[1] = pmap_get(partners, alloc_nodes[i]);
651
652                 for(j = 0; j < 2; ++j) {
653                         if(!nodes[j])
654                                 continue;
655
656                         assert(! (reg->type & arch_register_type_ignore));
657                         arch_set_irn_register(aenv, nodes[j], reg);
658                         (void) pset_hinsert_ptr(alloc_env->pre_colored, nodes[j]);
659                         DBG((dbg, LEVEL_2, "\tsetting %+F to register %s\n", nodes[j], reg->name));
660                 }
661         }
662
663         /* Allocate the non-constrained Projs of the Perm. */
664         if(perm != NULL) {
665                 bitset_clear_all(bs);
666
667                 /* Put the colors of all Projs in a bitset. */
668                 foreach_out_edge(perm, edge) {
669                         ir_node *proj              = get_edge_src_irn(edge);
670                         const arch_register_t *reg = arch_get_irn_register(aenv, proj);
671
672                         if(reg != NULL)
673                                 bitset_set(bs, reg->index);
674                 }
675
676                 /* Assign the not yet assigned Projs of the Perm a suitable color. */
677                 foreach_out_edge(perm, edge) {
678                         ir_node *proj              = get_edge_src_irn(edge);
679                         const arch_register_t *reg = arch_get_irn_register(aenv, proj);
680
681                         DBG((dbg, LEVEL_2, "\tchecking reg of %+F: %s\n", proj, reg ? reg->name : "<none>"));
682
683                         if(reg == NULL) {
684                                 col = get_next_free_reg(alloc_env, bs);
685                                 reg = arch_register_for_index(env->cls, col);
686                                 bitset_set(bs, reg->index);
687                                 arch_set_irn_register(aenv, proj, reg);
688                                 pset_insert_ptr(alloc_env->pre_colored, proj);
689                                 DBG((dbg, LEVEL_2, "\tsetting %+F to register %s\n", proj, reg->name));
690                         }
691                 }
692         }
693
694         //bipartite_free(bp);
695         hungarian_free(bp);
696         pmap_destroy(partners);
697
698 end:
699         obstack_free(env->obst, base);
700         return res;
701 }
702
703 /**
704  * Handle constraint nodes in each basic block.
705  * handle_constraints() inserts Perm nodes which perm
706  * over all values live at the constrained node right in front
707  * of the constrained node. These Perms signal a constrained node.
708  * For further comments, refer to handle_constraints().
709  */
710 static void constraints(ir_node *bl, void *data)
711 {
712         be_chordal_alloc_env_t *env = data;
713
714         /*
715                 Start silent in the start block.
716                 The silence remains until the first barrier is seen.
717                 Each other block is begun loud.
718         */
719         int silent                  = bl == get_irg_start_block(get_irn_irg(bl));
720         ir_node *irn;
721
722         /*
723                 If the block is the start block search the barrier and
724                 start handling constraints from there.
725         */
726
727         for(irn = sched_first(bl); !sched_is_end(irn);) {
728                 irn = handle_constraints(env, irn, &silent);
729         }
730 }
731
732 /**
733  * Annotate the register pressure to the nodes and compute
734  * the liveness intervals.
735  * @param block The block to do it for.
736  * @param env_ptr The environment.
737  */
738 static void pressure(ir_node *block, void *env_ptr)
739 {
740 /* Convenience macro for a def */
741 #define border_def(irn, step, real) \
742         border_add(env, head, irn, step, pressure--, 1, real)
743
744 /* Convenience macro for a use */
745 #define border_use(irn, step, real) \
746         border_add(env, head, irn, step, ++pressure, 0, real)
747
748         be_chordal_alloc_env_t *alloc_env = env_ptr;
749         be_chordal_env_t *env             = alloc_env->chordal_env;
750         bitset_t *live                    = alloc_env->live;
751         ir_node *irn;
752         be_lv_t *lv                       = env->birg->lv;
753
754         int i, n;
755         bitset_pos_t elm;
756         unsigned step = 0;
757         unsigned pressure = 0;
758         struct list_head *head;
759
760         DBG((dbg, LEVEL_1, "Computing pressure in block %+F\n", block));
761         bitset_clear_all(live);
762
763         /* Set up the border list in the block info */
764         head = obstack_alloc(env->obst, sizeof(*head));
765         INIT_LIST_HEAD(head);
766         assert(pmap_get(env->border_heads, block) == NULL);
767         pmap_insert(env->border_heads, block, head);
768
769         /*
770          * Make final uses of all values live out of the block.
771          * They are necessary to build up real intervals.
772          */
773         be_lv_foreach(lv, block, be_lv_state_end, i) {
774                 ir_node *irn = be_lv_get_irn(lv, block, i);
775                 if(has_reg_class(env, irn)) {
776                         DBG((dbg, LEVEL_3, "\tMaking live: %+F/%d\n", irn, get_irn_idx(irn)));
777                         bitset_set(live, get_irn_idx(irn));
778                         border_use(irn, step, 0);
779                 }
780         }
781         ++step;
782
783         /*
784          * Determine the last uses of a value inside the block, since they are
785          * relevant for the interval borders.
786          */
787         sched_foreach_reverse(block, irn) {
788                 DBG((dbg, LEVEL_1, "\tinsn: %+F, pressure: %d\n", irn, pressure));
789                 DBG((dbg, LEVEL_2, "\tlive: %B\n", live));
790
791 #ifndef SCHEDULE_PROJS
792                 if (get_irn_mode(irn) == mode_T) {
793                         const ir_edge_t *edge;
794
795                         foreach_out_edge(irn, edge) {
796                                 ir_node *proj = get_edge_src_irn(edge);
797
798                                 /*
799                                  * If the node defines some value, which can put into a
800                                  * register of the current class, make a border for it.
801                                  */
802                                 if(has_reg_class(env, proj)) {
803                                         int nr = get_irn_idx(proj);
804
805                                         bitset_clear(live, nr);
806                                         border_def(proj, step, 1);
807                                 }
808                         }
809                 }
810 #endif
811                 /*
812                  * If the node defines some value, which can put into a
813                  * register of the current class, make a border for it.
814                  */
815                 if(has_reg_class(env, irn)) {
816                         int nr = get_irn_idx(irn);
817
818                         bitset_clear(live, nr);
819                         border_def(irn, step, 1);
820                 }
821
822                 /*
823                  * If the node is no phi node we can examine the uses.
824                  */
825                 if(!is_Phi(irn)) {
826                         for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
827                                 ir_node *op = get_irn_n(irn, i);
828
829                                 if(has_reg_class(env, op)) {
830                                         int nr = get_irn_idx(op);
831                                         const char *msg = "-";
832
833                                         if(!bitset_is_set(live, nr)) {
834                                                 border_use(op, step, 1);
835                                                 bitset_set(live, nr);
836                                                 msg = "X";
837                                         }
838
839                                         DBG((dbg, LEVEL_4, "\t\t%s pos: %d, use: %+F\n", msg, i, op));
840                                 }
841                         }
842                 }
843                 ++step;
844         }
845
846         bitset_foreach(live, elm) {
847                 ir_node *irn = get_idx_irn(env->irg, elm);
848                 if (be_is_live_in(lv, block, irn))
849                         border_def(irn, step, 0);
850         }
851 }
852
853 static void assign(ir_node *block, void *env_ptr)
854 {
855         be_chordal_alloc_env_t *alloc_env = env_ptr;
856         be_chordal_env_t *env       = alloc_env->chordal_env;
857         bitset_t *live              = alloc_env->live;
858         bitset_t *colors            = alloc_env->colors;
859         bitset_t *in_colors         = alloc_env->in_colors;
860         const arch_env_t *arch_env  = env->birg->main_env->arch_env;
861         struct list_head *head      = get_block_border_head(env, block);
862         be_lv_t *lv                 = env->birg->lv;
863         pset *live_in               = be_lv_pset_put_in(lv, block, pset_new_ptr_default());
864
865         const ir_node *irn;
866         border_t *b;
867
868         bitset_clear_all(colors);
869         bitset_clear_all(live);
870         bitset_clear_all(in_colors);
871
872         DBG((dbg, LEVEL_4, "Assigning colors for block %+F\n", block));
873         DBG((dbg, LEVEL_4, "\tusedef chain for block\n"));
874         list_for_each_entry(border_t, b, head, list) {
875                 DBG((dbg, LEVEL_4, "\t%s %+F/%d\n", b->is_def ? "def" : "use",
876                                         b->irn, get_irn_idx(b->irn)));
877         }
878
879         /*
880          * Add initial defs for all values live in.
881          * Since their colors have already been assigned (The dominators were
882          * allocated before), we have to mark their colors as used also.
883          */
884         foreach_pset(live_in, irn) {
885                 if(has_reg_class(env, irn)) {
886                         const arch_register_t *reg = arch_get_irn_register(arch_env, irn);
887                         int col;
888
889                         assert(reg && "Node must have been assigned a register");
890                         col = arch_register_get_index(reg);
891
892                         DBG((dbg, LEVEL_4, "%+F has reg %s\n", irn, reg->name));
893
894                         /* Mark the color of the live in value as used. */
895                         bitset_set(colors, col);
896                         bitset_set(in_colors, col);
897
898                         /* Mark the value live in. */
899                         bitset_set(live, get_irn_idx(irn));
900                 }
901         }
902
903         /*
904          * Mind that the sequence of defs from back to front defines a perfect
905          * elimination order. So, coloring the definitions from first to last
906          * will work.
907          */
908         list_for_each_entry_reverse(border_t, b, head, list) {
909                 ir_node *irn = b->irn;
910                 int nr       = get_irn_idx(irn);
911                 int ignore   = arch_irn_is(arch_env, irn, ignore);
912
913                 /*
914                  * Assign a color, if it is a local def. Global defs already have a
915                  * color.
916                  */
917                 if(b->is_def && !be_is_live_in(lv, block, irn)) {
918                         const arch_register_t *reg;
919                         int col = NO_COLOR;
920
921                         if(ignore || pset_find_ptr(alloc_env->pre_colored, irn)) {
922                                 reg = arch_get_irn_register(arch_env, irn);
923                                 col = reg->index;
924                                 assert(!bitset_is_set(colors, col) && "pre-colored register must be free");
925                         } else {
926                                 col = get_next_free_reg(alloc_env, colors);
927                                 reg = arch_register_for_index(env->cls, col);
928                                 assert(arch_get_irn_register(arch_env, irn) == NULL && "This node must not have been assigned a register yet");
929                                 assert(!arch_register_type_is(reg, ignore) && "Must not assign ignore register");
930                         }
931
932                         bitset_set(colors, col);
933                         arch_set_irn_register(arch_env, irn, reg);
934
935                         DBG((dbg, LEVEL_1, "\tassigning register %s(%d) to %+F\n", arch_register_get_name(reg), col, irn));
936
937                         assert(!bitset_is_set(live, nr) && "Value's definition must not have been encountered");
938                         bitset_set(live, nr);
939                 }
940
941                 /* Clear the color upon a use. */
942                 else if(!b->is_def) {
943                         const arch_register_t *reg = arch_get_irn_register(arch_env, irn);
944                         int col;
945
946                         assert(reg && "Register must have been assigned");
947
948                         col = arch_register_get_index(reg);
949 #ifndef NDEBUG
950                         if(!arch_register_type_is(reg, ignore)) {
951                                 assert(bitset_is_set(live, nr) && "Cannot have a non live use");
952                         }
953 #endif
954
955                         bitset_clear(colors, col);
956                         bitset_clear(live, nr);
957                 }
958         }
959
960         del_pset(live_in);
961 }
962
963 /**
964  * A new assign...
965  */
966 static void assign_new(ir_node *block, be_chordal_alloc_env_t *alloc_env, bitset_t *live_end_dom)
967 {
968         be_chordal_env_t *env      = alloc_env->chordal_env;
969         bitset_t *colors           = alloc_env->colors;
970         bitset_t *in_colors        = alloc_env->in_colors;
971         bitset_t *live             = bitset_irg_malloc(env->irg);
972         const arch_env_t *arch_env = env->birg->main_env->arch_env;
973         be_irg_t *birg             = env->birg;
974
975         bitset_pos_t elm;
976         ir_node *irn;
977
978         bitset_clear_all(colors);
979         bitset_clear_all(in_colors);
980
981         /*
982          * All variables which are live in to this block are live out
983          * of the immediate dominator thanks to SSA properties. As we
984          * have already visited the immediate dominator, we know these
985          * variables. The only tjing left is to check wheather they are live
986          * in here (they also could be phi arguments to some ohi not
987          * in this block, hence we have to check).
988          */
989         bitset_foreach (live_end_dom, elm) {
990                 ir_node *irn = get_idx_irn(env->irg, elm);
991                 if (be_is_live_in(birg->lv, block, irn)) {
992                         const arch_register_t *reg = arch_get_irn_register(arch_env, irn);
993                         int col;
994
995                         assert(be_is_live_in(env->birg->lv, block, irn));
996                         assert(reg && "Node must have been assigned a register");
997                         col = arch_register_get_index(reg);
998
999                         DBG((dbg, LEVEL_4, "%+F has reg %s\n", irn, reg->name));
1000
1001                         /* Mark the color of the live in value as used. */
1002                         bitset_set(colors, col);
1003                         bitset_set(in_colors, col);
1004
1005                         /* Mark the value live in. */
1006                         bitset_set(live, elm);
1007                 }
1008
1009                 else {
1010                         assert(!be_is_live_in(env->birg->lv, block, irn));
1011                 }
1012         }
1013
1014         /*
1015          * Mind that the sequence of defs from back to front defines a perfect
1016          * elimination order. So, coloring the definitions from first to last
1017          * will work.
1018          */
1019         sched_foreach (block, irn) {
1020                 int nr       = get_irn_idx(irn);
1021                 int ignore   = arch_irn_is(arch_env, irn, ignore);
1022
1023                 /* Clear the color upon a last use. */
1024                 if(!is_Phi(irn)) {
1025                         int i;
1026                         for (i = get_irn_arity(irn) - 1; i >= 0; --i) {
1027                                 ir_node *op = get_irn_n(irn, i);
1028
1029                                 /*
1030                                  * If the reg class matches and the operand is not live after
1031                                  * the node, irn is a last use of op and the register can
1032                                  * be freed.
1033                                  */
1034                                 if (has_reg_class(env, op)) {
1035                                         if (!be_lv_chk_after_irn(birg, op, irn)) {
1036                                                 const arch_register_t *reg = arch_get_irn_register(arch_env, op);
1037                                                 int col;
1038
1039                                                 assert(reg && "Register must have been assigned");
1040                                                 col = arch_register_get_index(reg);
1041                                                 bitset_clear(colors, col);
1042                                                 bitset_clear(live, nr);
1043                                         }
1044                                 }
1045                         }
1046                 }
1047
1048                 if (has_reg_class(env, irn)) {
1049                         const arch_register_t *reg;
1050                         int col = NO_COLOR;
1051
1052                         /*
1053                          * Assign a color, if it is a local def. Global defs already have a
1054                          * color.
1055                          */
1056                         if(ignore || pset_find_ptr(alloc_env->pre_colored, irn)) {
1057                                 reg = arch_get_irn_register(arch_env, irn);
1058                                 col = reg->index;
1059                                 assert(!bitset_is_set(colors, col) && "pre-colored register must be free");
1060                         } else {
1061                                 col = get_next_free_reg(alloc_env, colors);
1062                                 reg = arch_register_for_index(env->cls, col);
1063                                 assert(arch_get_irn_register(arch_env, irn) == NULL && "This node must not have been assigned a register yet");
1064                                 assert(!arch_register_type_is(reg, ignore) && "Must not assign ignore register");
1065                         }
1066
1067                         bitset_set(colors, col);
1068                         arch_set_irn_register(arch_env, irn, reg);
1069
1070                         DBG((dbg, LEVEL_1, "\tassigning register %s(%d) to %+F\n", arch_register_get_name(reg), col, irn));
1071
1072                         assert(!bitset_is_set(live, nr) && "Value's definition must not have been encountered");
1073                         bitset_set(live, nr);
1074                 }
1075
1076         }
1077
1078         dominates_for_each (block, irn) {
1079                 assign_new(irn, alloc_env, live);
1080         }
1081
1082         bitset_free(live);
1083 }
1084
1085 void be_ra_chordal_color(be_chordal_env_t *chordal_env)
1086 {
1087         be_chordal_alloc_env_t env;
1088         char buf[256];
1089         be_lv_t *lv;
1090         be_irg_t *birg = chordal_env->birg;
1091         const arch_register_class_t *cls = chordal_env->cls;
1092
1093         int colors_n          = arch_register_class_n_regs(cls);
1094         ir_graph *irg         = chordal_env->irg;
1095         int allocatable_regs  = colors_n - be_put_ignore_regs(birg, cls, NULL);
1096
1097         /* some special classes contain only ignore regs, no work to be done */
1098         if(allocatable_regs == 0)
1099                 return;
1100
1101         be_assure_dom_front(birg);
1102         lv = be_assure_liveness(birg);
1103         be_liveness_assure_sets(lv);
1104         be_liveness_assure_chk(lv);
1105
1106         assure_doms(irg);
1107
1108         env.chordal_env   = chordal_env;
1109         env.colors_n      = colors_n;
1110         env.colors        = bitset_alloca(colors_n);
1111         env.tmp_colors    = bitset_alloca(colors_n);
1112         env.in_colors     = bitset_alloca(colors_n);
1113         env.pre_colored   = pset_new_ptr_default();
1114
1115         /* Handle register targeting constraints */
1116         dom_tree_walk_irg(irg, constraints, NULL, &env);
1117
1118         if(chordal_env->opts->dump_flags & BE_CH_DUMP_CONSTR) {
1119                 snprintf(buf, sizeof(buf), "-%s-constr", chordal_env->cls->name);
1120                 be_dump(chordal_env->irg, buf, dump_ir_block_graph_sched);
1121         }
1122
1123         env.live = bitset_malloc(get_irg_last_idx(chordal_env->irg));
1124
1125         /* First, determine the pressure */
1126         dom_tree_walk_irg(irg, pressure, NULL, &env);
1127
1128         /* Assign the colors */
1129 #ifdef NEW_STYLE_ASSIGN
1130         assign_new(get_irg_start_block(irg), &env, env.live);
1131 #else
1132         dom_tree_walk_irg(irg, assign, NULL, &env);
1133 #endif
1134
1135         if(chordal_env->opts->dump_flags & BE_CH_DUMP_TREE_INTV) {
1136                 plotter_t *plotter;
1137                 ir_snprintf(buf, sizeof(buf), "ifg_%s_%F.eps", chordal_env->cls->name, irg);
1138                 plotter = new_plotter_ps(buf);
1139                 draw_interval_tree(&draw_chordal_def_opts, chordal_env, plotter);
1140                 plotter_free(plotter);
1141         }
1142
1143         bitset_free(env.live);
1144         del_pset(env.pre_colored);
1145 }
1146
1147 void be_init_chordal(void)
1148 {
1149         FIRM_DBG_REGISTER(dbg, "firm.be.chordal");
1150 }
1151
1152 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_chordal);