2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Chordal register allocation.
23 * @author Sebastian Hack
34 #include "raw_bitset.h"
35 #include "bipartite.h"
36 #include "hungarian.h"
39 #include "irgraph_t.h"
40 #include "irprintf_t.h"
59 #include "beintlive_t.h"
61 #include "bechordal_t.h"
62 #include "bechordal_draw.h"
65 #include "bechordal_common.h"
67 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
69 typedef struct be_chordal_alloc_env_t {
70 be_chordal_env_t *chordal_env;
72 pset *pre_colored; /**< Set of precolored nodes. */
73 bitset_t *live; /**< A liveness bitset. */
74 bitset_t *tmp_colors; /**< An auxiliary bitset which is as long as the number of colors in the class. */
75 bitset_t *colors; /**< The color mask. */
76 bitset_t *in_colors; /**< Colors used by live in values. */
77 int colors_n; /**< The number of colors. */
78 } be_chordal_alloc_env_t;
80 static int get_next_free_reg(const be_chordal_alloc_env_t *alloc_env, bitset_t *colors)
82 bitset_t *tmp = alloc_env->tmp_colors;
83 bitset_copy(tmp, colors);
85 bitset_and(tmp, alloc_env->chordal_env->allocatable_regs);
86 return bitset_next_set(tmp, 0);
89 static bitset_t const *get_decisive_partner_regs(be_operand_t const *const o1)
91 be_operand_t const *const o2 = o1->partner;
92 assert(!o2 || o1->req->cls == o2->req->cls);
94 if (!o2 || bitset_contains(o1->regs, o2->regs)) {
96 } else if (bitset_contains(o2->regs, o1->regs)) {
103 static void pair_up_operands(const be_chordal_alloc_env_t *alloc_env, be_insn_t *insn)
105 const be_chordal_env_t *env = alloc_env->chordal_env;
106 bitset_t *bs = bitset_alloca(env->cls->n_regs);
111 * For each out operand, try to find an in operand which can be assigned the
112 * same register as the out operand.
114 for (j = 0; j < insn->use_start; ++j) {
115 be_operand_t *smallest = NULL;
116 int smallest_n_regs = env->cls->n_regs + 1;
117 be_operand_t *out_op = &insn->ops[j];
119 /* Try to find an in operand which has ... */
120 for (i = insn->use_start; i < insn->n_ops; ++i) {
122 be_operand_t *op = &insn->ops[i];
125 if (op->partner != NULL)
127 lv = be_get_irg_liveness(env->irg);
128 if (be_values_interfere(lv, op->irn, op->carrier))
131 bitset_copy(bs, op->regs);
132 bitset_and(bs, out_op->regs);
133 n_total = bitset_popcount(op->regs);
135 if (!bitset_is_empty(bs) && n_total < smallest_n_regs) {
137 smallest_n_regs = n_total;
141 if (smallest != NULL) {
142 for (i = insn->use_start; i < insn->n_ops; ++i) {
143 if (insn->ops[i].carrier == smallest->carrier)
144 insn->ops[i].partner = out_op;
147 out_op->partner = smallest;
148 smallest->partner = out_op;
153 static void handle_constraints(be_chordal_alloc_env_t *alloc_env,
157 ir_node **alloc_nodes;
158 //hungarian_problem_t *bp;
162 ir_node *perm = NULL;
163 //int match_res, cost;
164 be_chordal_env_t *env = alloc_env->chordal_env;
165 void *base = obstack_base(env->obst);
166 be_insn_t *insn = be_scan_insn(env, irn);
169 if (insn->pre_colored) {
171 for (i = 0; i < insn->use_start; ++i)
172 pset_insert_ptr(alloc_env->pre_colored, insn->ops[i].carrier);
176 * Perms inserted before the constraint handling phase are considered to be
177 * correctly precolored. These Perms arise during the ABI handling phase.
179 if (!insn->has_constraints || is_Phi(irn))
182 n_regs = env->cls->n_regs;
183 alloc_nodes = ALLOCAN(ir_node*, n_regs);
184 //bp = hungarian_new(n_regs, n_regs, 2, HUNGARIAN_MATCH_PERFECT);
185 bp = bipartite_new(n_regs, n_regs);
186 assignment = ALLOCAN(int, n_regs);
187 partners = pmap_create();
190 * prepare the constraint handling of this node.
191 * Perms are constructed and Copies are created for constrained values
192 * interfering with the instruction.
194 perm = pre_process_constraints(alloc_env->chordal_env, &insn);
196 /* find suitable in operands to the out operands of the node. */
197 pair_up_operands(alloc_env, insn);
200 * look at the in/out operands and add each operand (and its possible partner)
201 * to a bipartite graph (left: nodes with partners, right: admissible colors).
203 for (i = 0, n_alloc = 0; i < insn->n_ops; ++i) {
204 be_operand_t *op = &insn->ops[i];
207 * If the operand has no partner or the partner has not been marked
208 * for allocation, determine the admissible registers and mark it
209 * for allocation by associating the node and its partner with the
210 * set of admissible registers via a bipartite graph.
212 if (!op->partner || !pmap_contains(partners, op->partner->carrier)) {
213 ir_node *partner = op->partner ? op->partner->carrier : NULL;
216 pmap_insert(partners, op->carrier, partner);
218 pmap_insert(partners, partner, op->carrier);
220 /* don't insert a node twice */
221 for (i = 0; i < n_alloc; ++i) {
222 if (alloc_nodes[i] == op->carrier) {
229 alloc_nodes[n_alloc] = op->carrier;
231 DBG((dbg, LEVEL_2, "\tassociating %+F and %+F\n", op->carrier,
234 bitset_t const *const bs = get_decisive_partner_regs(op);
236 DBG((dbg, LEVEL_2, "\tallowed registers for %+F: %B\n", op->carrier, bs));
238 bitset_foreach(bs, col) {
239 //hungarian_add(bp, n_alloc, col, 1);
240 bipartite_add(bp, n_alloc, col);
243 DBG((dbg, LEVEL_2, "\tallowed registers for %+F: none\n", op->carrier));
251 * Put all nodes which live through the constrained instruction also to the
252 * allocation bipartite graph. They are considered unconstrained.
255 foreach_out_edge(perm, edge) {
257 ir_node *proj = get_edge_src_irn(edge);
258 be_lv_t *lv = be_get_irg_liveness(env->irg);
260 assert(is_Proj(proj));
262 if (!be_values_interfere(lv, proj, irn)
263 || pmap_contains(partners, proj))
266 /* don't insert a node twice */
267 for (i = 0; i < n_alloc; ++i) {
268 if (alloc_nodes[i] == proj) {
276 assert(n_alloc < n_regs);
278 alloc_nodes[n_alloc] = proj;
279 pmap_insert(partners, proj, NULL);
281 bitset_foreach(env->allocatable_regs, col) {
282 //hungarian_add(bp, n_alloc, col, 1);
283 bipartite_add(bp, n_alloc, col);
290 /* Compute a valid register allocation. */
292 hungarian_prepare_cost_matrix(bp, HUNGARIAN_MODE_MAXIMIZE_UTIL);
293 match_res = hungarian_solve(bp, assignment, &cost, 1);
294 assert(match_res == 0 && "matching failed");
296 /*bipartite_dump_f(stderr, bp);*/
297 bipartite_matching(bp, assignment);
300 /* Assign colors obtained from the matching. */
301 for (i = 0; i < n_alloc; ++i) {
302 const arch_register_t *reg;
305 assert(assignment[i] >= 0 && "there must have been a register assigned (node not register pressure faithful?)");
306 reg = arch_register_for_index(env->cls, assignment[i]);
308 irn = alloc_nodes[i];
310 arch_set_irn_register(irn, reg);
311 (void) pset_hinsert_ptr(alloc_env->pre_colored, irn);
312 DBG((dbg, LEVEL_2, "\tsetting %+F to register %s\n", irn, reg->name));
315 irn = pmap_get(ir_node, partners, alloc_nodes[i]);
317 arch_set_irn_register(irn, reg);
318 (void) pset_hinsert_ptr(alloc_env->pre_colored, irn);
319 DBG((dbg, LEVEL_2, "\tsetting %+F to register %s\n", irn, reg->name));
323 /* Allocate the non-constrained Projs of the Perm. */
325 /* Put the colors of all Projs in a bitset. */
326 bitset_t *const bs = bitset_alloca(n_regs);
327 foreach_out_edge(perm, edge) {
328 ir_node *proj = get_edge_src_irn(edge);
329 const arch_register_t *reg = arch_get_irn_register(proj);
332 bitset_set(bs, reg->index);
335 /* Assign the not yet assigned Projs of the Perm a suitable color. */
336 foreach_out_edge(perm, edge) {
337 ir_node *proj = get_edge_src_irn(edge);
338 const arch_register_t *reg = arch_get_irn_register(proj);
340 DBG((dbg, LEVEL_2, "\tchecking reg of %+F: %s\n", proj, reg ? reg->name : "<none>"));
343 size_t const col = get_next_free_reg(alloc_env, bs);
344 reg = arch_register_for_index(env->cls, col);
345 bitset_set(bs, reg->index);
346 arch_set_irn_register(proj, reg);
347 pset_insert_ptr(alloc_env->pre_colored, proj);
348 DBG((dbg, LEVEL_2, "\tsetting %+F to register %s\n", proj, reg->name));
354 //hungarian_free(bp);
355 pmap_destroy(partners);
358 obstack_free(env->obst, base);
362 * Handle constraint nodes in each basic block.
363 * handle_constraints() inserts Perm nodes which perm
364 * over all values live at the constrained node right in front
365 * of the constrained node. These Perms signal a constrained node.
366 * For further comments, refer to handle_constraints().
368 static void constraints(ir_node *bl, void *data)
370 be_chordal_alloc_env_t *env = (be_chordal_alloc_env_t*)data;
373 for (irn = sched_first(bl); !sched_is_end(irn);) {
374 ir_node *const next = sched_next(irn);
375 handle_constraints(env, irn);
380 static void assign(ir_node *block, void *env_ptr)
382 be_chordal_alloc_env_t *alloc_env = (be_chordal_alloc_env_t*)env_ptr;
383 be_chordal_env_t *env = alloc_env->chordal_env;
384 bitset_t *live = alloc_env->live;
385 bitset_t *colors = alloc_env->colors;
386 bitset_t *in_colors = alloc_env->in_colors;
387 struct list_head *head = get_block_border_head(env, block);
388 be_lv_t *lv = be_get_irg_liveness(env->irg);
390 bitset_clear_all(colors);
391 bitset_clear_all(live);
392 bitset_clear_all(in_colors);
394 DBG((dbg, LEVEL_4, "Assigning colors for block %+F\n", block));
395 DBG((dbg, LEVEL_4, "\tusedef chain for block\n"));
396 foreach_border_head(head, b) {
397 DBG((dbg, LEVEL_4, "\t%s %+F/%d\n", b->is_def ? "def" : "use",
398 b->irn, get_irn_idx(b->irn)));
402 * Add initial defs for all values live in.
403 * Since their colors have already been assigned (The dominators were
404 * allocated before), we have to mark their colors as used also.
406 be_lv_foreach(lv, block, be_lv_state_in, irn) {
407 if (has_reg_class(env, irn)) {
408 const arch_register_t *reg = arch_get_irn_register(irn);
410 assert(reg && "Node must have been assigned a register");
411 DBG((dbg, LEVEL_4, "%+F has reg %s\n", irn, reg->name));
413 /* Mark the color of the live in value as used. */
414 int const col = reg->index;
415 bitset_set(colors, col);
416 bitset_set(in_colors, col);
418 /* Mark the value live in. */
419 bitset_set(live, get_irn_idx(irn));
424 * Mind that the sequence of defs from back to front defines a perfect
425 * elimination order. So, coloring the definitions from first to last
428 foreach_border_head(head, b) {
429 ir_node *irn = b->irn;
430 int nr = get_irn_idx(irn);
431 int ignore = arch_irn_is_ignore(irn);
434 * Assign a color, if it is a local def. Global defs already have a
437 if (b->is_def && !be_is_live_in(lv, block, irn)) {
438 const arch_register_t *reg;
441 if (ignore || pset_find_ptr(alloc_env->pre_colored, irn)) {
442 reg = arch_get_irn_register(irn);
444 assert(!bitset_is_set(colors, col) && "pre-colored register must be free");
446 col = get_next_free_reg(alloc_env, colors);
447 reg = arch_register_for_index(env->cls, col);
448 assert(arch_get_irn_register(irn) == NULL && "This node must not have been assigned a register yet");
451 bitset_set(colors, col);
452 arch_set_irn_register(irn, reg);
454 DBG((dbg, LEVEL_1, "\tassigning register %s(%d) to %+F\n", reg->name, col, irn));
456 assert(!bitset_is_set(live, nr) && "Value's definition must not have been encountered");
457 bitset_set(live, nr);
458 } else if (!b->is_def) {
459 /* Clear the color upon a use. */
460 const arch_register_t *reg = arch_get_irn_register(irn);
462 assert(reg && "Register must have been assigned");
464 bitset_clear(colors, reg->index);
465 bitset_clear(live, nr);
470 static void be_ra_chordal_color(be_chordal_env_t *const chordal_env)
472 be_chordal_alloc_env_t env;
474 const arch_register_class_t *cls = chordal_env->cls;
476 int colors_n = arch_register_class_n_regs(cls);
477 ir_graph *irg = chordal_env->irg;
479 be_assure_live_sets(irg);
482 env.chordal_env = chordal_env;
483 env.colors_n = colors_n;
484 env.colors = bitset_alloca(colors_n);
485 env.tmp_colors = bitset_alloca(colors_n);
486 env.in_colors = bitset_alloca(colors_n);
487 env.pre_colored = pset_new_ptr_default();
489 be_timer_push(T_SPLIT);
491 if (chordal_env->opts->dump_flags & BE_CH_DUMP_SPLIT) {
492 snprintf(buf, sizeof(buf), "%s-split", chordal_env->cls->name);
493 dump_ir_graph(chordal_env->irg, buf);
496 be_timer_pop(T_SPLIT);
498 be_timer_push(T_CONSTR);
500 /* Handle register targeting constraints */
501 dom_tree_walk_irg(irg, constraints, NULL, &env);
503 if (chordal_env->opts->dump_flags & BE_CH_DUMP_CONSTR) {
504 snprintf(buf, sizeof(buf), "%s-constr", chordal_env->cls->name);
505 dump_ir_graph(chordal_env->irg, buf);
508 be_timer_pop(T_CONSTR);
510 env.live = bitset_malloc(get_irg_last_idx(chordal_env->irg));
512 /* First, determine the pressure */
513 dom_tree_walk_irg(irg, create_borders, NULL, env.chordal_env);
515 /* Assign the colors */
516 dom_tree_walk_irg(irg, assign, NULL, &env);
518 if (chordal_env->opts->dump_flags & BE_CH_DUMP_TREE_INTV) {
520 ir_snprintf(buf, sizeof(buf), "ifg_%s_%F.eps", chordal_env->cls->name, irg);
521 plotter = new_plotter_ps(buf);
522 draw_interval_tree(&draw_chordal_def_opts, chordal_env, plotter);
523 plotter_free(plotter);
526 bitset_free(env.live);
527 del_pset(env.pre_colored);
530 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_chordal)
531 void be_init_chordal(void)
533 static be_ra_chordal_coloring_t coloring = {
536 FIRM_DBG_REGISTER(dbg, "firm.be.chordal");
538 be_register_chordal_coloring("default", &coloring);