nsz Git - libfirm/blob - ir/be/becopyopt.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       Copy minimization driver.
  23  * @author      Daniel Grund
  24  * @date        12.04.2005
  25  *
  26  * Main file for the optimization reducing the copies needed for:
  27  * - Phi coalescing
  28  * - Register-constrained nodes
  29  * - Two-address code instructions
  30  */
  31 #include "config.h"
  32
  33 #include "debug.h"
  34 #include "error.h"
  35 #include "execfreq.h"
  36 #include "irdump_t.h"
  37 #include "iredges_t.h"
  38 #include "irgraph.h"
  39 #include "irgwalk.h"
  40 #include "irloop_t.h"
  41 #include "irnode.h"
  42 #include "irprintf_t.h"
  43 #include "irprog.h"
  44 #include "irtools.h"
  45 #include "pmap.h"
  46 #include "raw_bitset.h"
  47 #include "util.h"
  48 #include "xmalloc.h"
  49
  50 #include "bearch.h"
  51 #include "becopyopt_t.h"
  52 #include "becopystat.h"
  53 #include "bedump.h"
  54 #include "beifg.h"
  55 #include "beinsn_t.h"
  56 #include "beintlive_t.h"
  57 #include "beirg.h"
  58 #include "belive_t.h"
  59 #include "bemodule.h"
  60 #include "benode.h"
  61 #include "besched.h"
  62 #include "bestatevent.h"
  63 #include "beutil.h"
  64
  65 #include "lc_opts.h"
  66 #include "lc_opts_enum.h"
  67
  68 #define DUMP_BEFORE 1
  69 #define DUMP_AFTER  2
  70 #define DUMP_APPEL  4
  71 #define DUMP_ALL    2 * DUMP_APPEL - 1
  72
  73 #define COST_FUNC_FREQ     1
  74 #define COST_FUNC_LOOP     2
  75 #define COST_FUNC_ALL_ONE  3
  76
  77 /**
  78  * Flags for dumping the IFG.
  79  */
  80 enum {
  81         CO_IFG_DUMP_COLORS = 1 << 0, /**< Dump the graph colored. */
  82         CO_IFG_DUMP_LABELS = 1 << 1, /**< Dump node/edge labels. */
  83         CO_IFG_DUMP_SHAPE  = 1 << 2, /**< Give constrained nodes special shapes. */
  84         CO_IFG_DUMP_CONSTR = 1 << 3, /**< Dump the node constraints in the label. */
  85 };
  86
  87 static int co_get_costs_loop_depth(const ir_node *root, int pos);
  88 static int co_get_costs_exec_freq(const ir_node *root, int pos);
  89 static int co_get_costs_all_one(const ir_node *root, int pos);
  90
  91 static unsigned   dump_flags  = 0;
  92 static unsigned   style_flags = CO_IFG_DUMP_COLORS;
  93 static int        do_stats    = 0;
  94 static cost_fct_t cost_func   = co_get_costs_exec_freq;
  95 static int        improve     = 1;
  96
  97 static const lc_opt_enum_mask_items_t dump_items[] = {
  98         { "before",  DUMP_BEFORE },
  99         { "after",   DUMP_AFTER  },
 100         { "appel",   DUMP_APPEL  },
 101         { "all",     DUMP_ALL    },
 102         { NULL,      0 }
 103 };
 104
 105 static const lc_opt_enum_mask_items_t style_items[] = {
 106         { "color",   CO_IFG_DUMP_COLORS },
 107         { "labels",  CO_IFG_DUMP_LABELS },
 108         { "constr",  CO_IFG_DUMP_CONSTR },
 109         { "shape",   CO_IFG_DUMP_SHAPE  },
 110         { "full",    2 * CO_IFG_DUMP_SHAPE - 1 },
 111         { NULL,      0 }
 112 };
 113
 114 typedef int (*opt_funcptr)(void);
 115 static const lc_opt_enum_func_ptr_items_t cost_func_items[] = {
 116         { "freq",   (opt_funcptr) co_get_costs_exec_freq },
 117         { "loop",   (opt_funcptr) co_get_costs_loop_depth },
 118         { "one",    (opt_funcptr) co_get_costs_all_one },
 119         { NULL,     NULL }
 120 };
 121
 122 static lc_opt_enum_mask_var_t dump_var = {
 123         &dump_flags, dump_items
 124 };
 125
 126 static lc_opt_enum_mask_var_t style_var = {
 127         &style_flags, style_items
 128 };
 129
 130 static lc_opt_enum_func_ptr_var_t cost_func_var = {
 131         (opt_funcptr*) &cost_func, cost_func_items
 132 };
 133
 134 static const lc_opt_table_entry_t options[] = {
 135         LC_OPT_ENT_ENUM_FUNC_PTR ("cost",    "select a cost function",                                  &cost_func_var),
 136         LC_OPT_ENT_ENUM_MASK     ("dump",    "dump ifg before or after copy optimization",              &dump_var),
 137         LC_OPT_ENT_ENUM_MASK     ("style",   "dump style for ifg dumping",                              &style_var),
 138         LC_OPT_ENT_BOOL          ("stats",   "dump statistics after each optimization",                 &do_stats),
 139         LC_OPT_ENT_BOOL          ("improve", "run heur1 before if algo can exploit start solutions",    &improve),
 140         LC_OPT_LAST
 141 };
 142
 143 static be_module_list_entry_t *copyopts = NULL;
 144 static const co_algo_info *selected_copyopt = NULL;
 145
 146 void be_register_copyopt(const char *name, co_algo_info *copyopt)
 147 {
 148         if (selected_copyopt == NULL)
 149                 selected_copyopt = copyopt;
 150         be_add_module_to_list(&copyopts, name, copyopt);
 151 }
 152
 153 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copyopt)
 154 void be_init_copyopt(void)
 155 {
 156         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
 157         lc_opt_entry_t *ra_grp = lc_opt_get_grp(be_grp, "ra");
 158         lc_opt_entry_t *chordal_grp = lc_opt_get_grp(ra_grp, "chordal");
 159         lc_opt_entry_t *co_grp = lc_opt_get_grp(chordal_grp, "co");
 160
 161         lc_opt_add_table(co_grp, options);
 162         be_add_module_list_opt(co_grp, "algo", "select copy optimization algo",
 163                                        &copyopts, (void**) &selected_copyopt);
 164 }
 165
 166 static int void_algo(copy_opt_t *co)
 167 {
 168         (void) co;
 169         return 0;
 170 }
 171
 172 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copynone)
 173 void be_init_copynone(void)
 174 {
 175         static co_algo_info copyheur = {
 176                 void_algo, 0
 177         };
 178
 179         be_register_copyopt("none", &copyheur);
 180 }
 181
 182 #undef QUICK_AND_DIRTY_HACK
 183
 184 static int nodes_interfere(const be_chordal_env_t *env, const ir_node *a, const ir_node *b)
 185 {
 186         if (env->ifg)
 187                 return be_ifg_connected(env->ifg, a, b);
 188         else {
 189                 be_lv_t *lv = be_get_irg_liveness(env->irg);
 190                 return be_values_interfere(lv, a, b);
 191         }
 192 }
 193
 194
 195 /******************************************************************************
 196     _____                           _
 197    / ____|                         | |
 198   | |  __  ___ _ __   ___ _ __ __ _| |
 199   | | |_ |/ _ \ '_ \ / _ \ '__/ _` | |
 200   | |__| |  __/ | | |  __/ | | (_| | |
 201    \_____|\___|_| |_|\___|_|  \__,_|_|
 202
 203  ******************************************************************************/
 204
 205 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
 206
 207
 208 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs)
 209 {
 210         const char *s1, *s2, *s3;
 211         size_t len;
 212         copy_opt_t *co;
 213
 214         FIRM_DBG_REGISTER(dbg, "ir.be.copyopt");
 215
 216         co = XMALLOCZ(copy_opt_t);
 217         co->cenv      = chordal_env;
 218         co->irg       = chordal_env->irg;
 219         co->cls       = chordal_env->cls;
 220         co->get_costs = get_costs;
 221
 222         s1 = get_irp_name();
 223         s2 = get_entity_name(get_irg_entity(co->irg));
 224         s3 = chordal_env->cls->name;
 225         len = strlen(s1) + strlen(s2) + strlen(s3) + 5;
 226         co->name = XMALLOCN(char, len);
 227         snprintf(co->name, len, "%s__%s__%s", s1, s2, s3);
 228
 229         return co;
 230 }
 231
 232 void free_copy_opt(copy_opt_t *co)
 233 {
 234         xfree(co->name);
 235         free(co);
 236 }
 237
 238 /**
 239  * Checks if a node is optimizable, viz. has something to do with coalescing
 240  * @param irn  The irn to check
 241  */
 242 static int co_is_optimizable_root(ir_node *irn)
 243 {
 244         const arch_register_req_t *req;
 245
 246         if (arch_irn_is_ignore(irn))
 247                 return 0;
 248
 249         if (is_Reg_Phi(irn) || is_Perm_Proj(irn))
 250                 return 1;
 251
 252         req = arch_get_irn_register_req(irn);
 253         if (is_2addr_code(req))
 254                 return 1;
 255
 256         return 0;
 257 }
 258
 259 /**
 260  * Computes the costs of a copy according to loop depth
 261  * @param pos  the argument position of arg in the root arguments
 262  * @return     Must be >= 0 in all cases.
 263  */
 264 static int co_get_costs_loop_depth(const ir_node *root, int pos)
 265 {
 266         ir_node *block = get_nodes_block(root);
 267         ir_loop *loop;
 268         int      cost;
 269
 270         if (is_Phi(root)) {
 271                 block = get_Block_cfgpred_block(block, pos);
 272         }
 273         loop = get_irn_loop(block);
 274         if (loop) {
 275                 int d = get_loop_depth(loop);
 276                 cost = d*d;
 277         } else {
 278                 cost = 0;
 279         }
 280         return 1+cost;
 281 }
 282
 283 /**
 284  * Computes the costs of a copy according to execution frequency
 285  * @param pos  the argument position of arg in the root arguments
 286  * @return Must be >= 0 in all cases.
 287  */
 288 static int co_get_costs_exec_freq(const ir_node *root, int pos)
 289 {
 290         ir_graph     *irg       = get_irn_irg(root);
 291         ir_node      *root_bl   = get_nodes_block(root);
 292         ir_node      *copy_bl
 293                 = is_Phi(root) ? get_Block_cfgpred_block(root_bl, pos) : root_bl;
 294         ir_exec_freq *exec_freq = be_get_irg_exec_freq(irg);
 295         int           res       = get_block_execfreq_ulong(exec_freq, copy_bl);
 296
 297         /* don't allow values smaller than one. */
 298         return res < 1 ? 1 : res;
 299 }
 300
 301 /**
 302  * All costs equal 1. Using this will reduce the _number_ of copies.
 303  * @param co   The copy opt object.
 304  * @return Must be >= 0 in all cases.
 305  */
 306 static int co_get_costs_all_one(const ir_node *root, int pos)
 307 {
 308         (void) root;
 309         (void) pos;
 310         return 1;
 311 }
 312
 313 /******************************************************************************
 314    ____        _   _    _       _ _          _____ _
 315   / __ \      | | | |  | |     (_) |        / ____| |
 316  | |  | |_ __ | |_| |  | |_ __  _| |_ ___  | (___ | |_ ___  _ __ __ _  __ _  ___
 317  | |  | | '_ \| __| |  | | '_ \| | __/ __|  \___ \| __/ _ \| '__/ _` |/ _` |/ _ \
 318  | |__| | |_) | |_| |__| | | | | | |_\__ \  ____) | || (_) | | | (_| | (_| |  __/
 319   \____/| .__/ \__|\____/|_| |_|_|\__|___/ |_____/ \__\___/|_|  \__,_|\__, |\___|
 320         | |                                                            __/ |
 321         |_|                                                           |___/
 322  ******************************************************************************/
 323
 324 /**
 325  * Determines a maximum weighted independent set with respect to
 326  * the interference and conflict edges of all nodes in a qnode.
 327  */
 328 static int ou_max_ind_set_costs(unit_t *ou)
 329 {
 330         be_chordal_env_t *chordal_env = ou->co->cenv;
 331         ir_node **safe, **unsafe;
 332         int i, o, safe_count, safe_costs, unsafe_count, *unsafe_costs;
 333         bitset_t *curr;
 334         int curr_weight, best_weight = 0;
 335
 336         /* assign the nodes into two groups.
 337          * safe: node has no interference, hence it is in every max stable set.
 338          * unsafe: node has an interference
 339          */
 340         safe         = ALLOCAN(ir_node*, ou->node_count - 1);
 341         safe_costs   = 0;
 342         safe_count   = 0;
 343         unsafe       = ALLOCAN(ir_node*, ou->node_count - 1);
 344         unsafe_costs = ALLOCAN(int,      ou->node_count - 1);
 345         unsafe_count = 0;
 346         for (i=1; i<ou->node_count; ++i) {
 347                 int is_safe = 1;
 348                 for (o=1; o<ou->node_count; ++o) {
 349                         if (i==o)
 350                                 continue;
 351                         if (nodes_interfere(chordal_env, ou->nodes[i], ou->nodes[o])) {
 352                                 unsafe_costs[unsafe_count] = ou->costs[i];
 353                                 unsafe[unsafe_count] = ou->nodes[i];
 354                                 ++unsafe_count;
 355                                 is_safe = 0;
 356                                 break;
 357                         }
 358                 }
 359                 if (is_safe) {
 360                         safe_costs += ou->costs[i];
 361                         safe[safe_count++] = ou->nodes[i];
 362                 }
 363         }
 364
 365
 366         /* now compute the best set out of the unsafe nodes*/
 367         if (unsafe_count > MIS_HEUR_TRIGGER) {
 368                 bitset_t *best = bitset_alloca(unsafe_count);
 369                 /* Heuristic: Greedy trial and error form index 0 to unsafe_count-1 */
 370                 for (i=0; i<unsafe_count; ++i) {
 371                         bitset_set(best, i);
 372                         /* check if it is a stable set */
 373                         for (o=bitset_next_set(best, 0); o!=-1 && o<i; o=bitset_next_set(best, o+1))
 374                                 if (nodes_interfere(chordal_env, unsafe[i], unsafe[o])) {
 375                                         bitset_clear(best, i); /* clear the bit and try next one */
 376                                         break;
 377                                 }
 378                 }
 379                 /* compute the weight */
 380                 bitset_foreach(best, pos)
 381                         best_weight += unsafe_costs[pos];
 382         } else {
 383                 /* Exact Algorithm: Brute force */
 384                 curr = bitset_alloca(unsafe_count);
 385                 bitset_set_all(curr);
 386                 while (bitset_popcount(curr) != 0) {
 387                         /* check if curr is a stable set */
 388                         for (i=bitset_next_set(curr, 0); i!=-1; i=bitset_next_set(curr, i+1))
 389                                 for (o=bitset_next_set(curr, i+1); o!=-1; o=bitset_next_set(curr, o+1)) /* !!!!! difference to qnode_max_ind_set(): NOT (curr, i) */
 390                                                 if (nodes_interfere(chordal_env, unsafe[i], unsafe[o]))
 391                                                         goto no_stable_set;
 392
 393                         /* if we arrive here, we have a stable set */
 394                         /* compute the weight of the stable set*/
 395                         curr_weight = 0;
 396                         bitset_foreach(curr, pos)
 397                                 curr_weight += unsafe_costs[pos];
 398
 399                         /* any better ? */
 400                         if (curr_weight > best_weight) {
 401                                 best_weight = curr_weight;
 402                         }
 403
 404         no_stable_set:
 405                         bitset_minus1(curr);
 406                 }
 407         }
 408
 409         return safe_costs+best_weight;
 410 }
 411
 412 static void co_collect_units(ir_node *irn, void *env)
 413 {
 414         const arch_register_req_t *req;
 415         copy_opt_t                *co  = (copy_opt_t*)env;
 416         unit_t *unit;
 417
 418         if (get_irn_mode(irn) == mode_T)
 419                 return;
 420         req = arch_get_irn_register_req(irn);
 421         if (req->cls != co->cls)
 422                 return;
 423         if (!co_is_optimizable_root(irn))
 424                 return;
 425
 426         /* Init a new unit */
 427         unit = XMALLOCZ(unit_t);
 428         unit->co = co;
 429         unit->node_count = 1;
 430         INIT_LIST_HEAD(&unit->queue);
 431
 432         /* Phi with some/all of its arguments */
 433         if (is_Reg_Phi(irn)) {
 434                 int i, arity;
 435
 436                 /* init */
 437                 arity = get_irn_arity(irn);
 438                 unit->nodes = XMALLOCN(ir_node*, arity + 1);
 439                 unit->costs = XMALLOCN(int,      arity + 1);
 440                 unit->nodes[0] = irn;
 441
 442                 /* fill */
 443                 for (i=0; i<arity; ++i) {
 444                         int o, arg_pos;
 445                         ir_node *arg = get_irn_n(irn, i);
 446
 447                         assert(arch_get_irn_reg_class(arg) == co->cls && "Argument not in same register class.");
 448                         if (arg == irn)
 449                                 continue;
 450                         if (nodes_interfere(co->cenv, irn, arg)) {
 451                                 unit->inevitable_costs += co->get_costs(irn, i);
 452                                 continue;
 453                         }
 454
 455                         /* Else insert the argument of the phi to the members of this ou */
 456                         DBG((dbg, LEVEL_1, "\t   Member: %+F\n", arg));
 457
 458                         if (arch_irn_is_ignore(arg))
 459                                 continue;
 460
 461                         /* Check if arg has occurred at a prior position in the arg/list */
 462                         arg_pos = 0;
 463                         for (o=1; o<unit->node_count; ++o) {
 464                                 if (unit->nodes[o] == arg) {
 465                                         arg_pos = o;
 466                                         break;
 467                                 }
 468                         }
 469
 470                         if (!arg_pos) { /* a new argument */
 471                                 /* insert node, set costs */
 472                                 unit->nodes[unit->node_count] = arg;
 473                                 unit->costs[unit->node_count] = co->get_costs(irn, i);
 474                                 unit->node_count++;
 475                         } else { /* arg has occurred before in same phi */
 476                                 /* increase costs for existing arg */
 477                                 unit->costs[arg_pos] += co->get_costs(irn, i);
 478                         }
 479                 }
 480                 unit->nodes = XREALLOC(unit->nodes, ir_node*, unit->node_count);
 481                 unit->costs = XREALLOC(unit->costs, int,      unit->node_count);
 482         } else if (is_Perm_Proj(irn)) {
 483                 /* Proj of a perm with corresponding arg */
 484                 assert(!nodes_interfere(co->cenv, irn, get_Perm_src(irn)));
 485                 unit->nodes = XMALLOCN(ir_node*, 2);
 486                 unit->costs = XMALLOCN(int,      2);
 487                 unit->node_count = 2;
 488                 unit->nodes[0] = irn;
 489                 unit->nodes[1] = get_Perm_src(irn);
 490                 unit->costs[1] = co->get_costs(irn, -1);
 491         } else {
 492                 /* Src == Tgt of a 2-addr-code instruction */
 493                 if (is_2addr_code(req)) {
 494                         const unsigned other = req->other_same;
 495                         int            count = 0;
 496                         int            i;
 497
 498                         for (i = 0; (1U << i) <= other; ++i) {
 499                                 if (other & (1U << i)) {
 500                                         ir_node *o  = get_irn_n(skip_Proj(irn), i);
 501                                         if (arch_irn_is_ignore(o))
 502                                                 continue;
 503                                         if (nodes_interfere(co->cenv, irn, o))
 504                                                 continue;
 505                                         ++count;
 506                                 }
 507                         }
 508
 509                         if (count != 0) {
 510                                 int k = 0;
 511                                 ++count;
 512                                 unit->nodes = XMALLOCN(ir_node*, count);
 513                                 unit->costs = XMALLOCN(int,      count);
 514                                 unit->node_count = count;
 515                                 unit->nodes[k++] = irn;
 516
 517                                 for (i = 0; 1U << i <= other; ++i) {
 518                                         if (other & (1U << i)) {
 519                                                 ir_node *o  = get_irn_n(skip_Proj(irn), i);
 520                                                 if (!arch_irn_is_ignore(o) &&
 521                                                                 !nodes_interfere(co->cenv, irn, o)) {
 522                                                         unit->nodes[k] = o;
 523                                                         unit->costs[k] = co->get_costs(irn, -1);
 524                                                         ++k;
 525                                                 }
 526                                         }
 527                                 }
 528                         }
 529                 } else {
 530                         assert(0 && "This is not an optimizable node!");
 531                 }
 532         }
 533
 534         /* Insert the new unit at a position according to its costs */
 535         if (unit->node_count > 1) {
 536                 int i;
 537                 struct list_head *tmp;
 538
 539                 /* Determine the maximum costs this unit can cause: all_nodes_cost */
 540                 for (i=1; i<unit->node_count; ++i) {
 541                         unit->sort_key = MAX(unit->sort_key, unit->costs[i]);
 542                         unit->all_nodes_costs += unit->costs[i];
 543                 }
 544
 545                 /* Determine the minimal costs this unit will cause: min_nodes_costs */
 546                 unit->min_nodes_costs += unit->all_nodes_costs - ou_max_ind_set_costs(unit);
 547                 /* Insert the new ou according to its sort_key */
 548                 tmp = &co->units;
 549                 while (tmp->next != &co->units && list_entry_units(tmp->next)->sort_key > unit->sort_key)
 550                         tmp = tmp->next;
 551                 list_add(&unit->units, tmp);
 552         } else {
 553                 free(unit);
 554         }
 555 }
 556
 557 #ifdef QUICK_AND_DIRTY_HACK
 558
 559 static int compare_ous(const void *k1, const void *k2)
 560 {
 561         const unit_t *u1 = *((const unit_t **) k1);
 562         const unit_t *u2 = *((const unit_t **) k2);
 563         int i, o, u1_has_constr, u2_has_constr;
 564         arch_register_req_t req;
 565
 566         /* Units with constraints come first */
 567         u1_has_constr = 0;
 568         for (i=0; i<u1->node_count; ++i) {
 569                 arch_get_irn_register_req(&req, u1->nodes[i]);
 570                 if (arch_register_req_is(&req, limited)) {
 571                         u1_has_constr = 1;
 572                         break;
 573                 }
 574         }
 575
 576         u2_has_constr = 0;
 577         for (i=0; i<u2->node_count; ++i) {
 578                 arch_get_irn_register_req(&req, u2->nodes[i]);
 579                 if (arch_register_req_is(&req, limited)) {
 580                         u2_has_constr = 1;
 581                         break;
 582                 }
 583         }
 584
 585         if (u1_has_constr != u2_has_constr)
 586                 return u2_has_constr - u1_has_constr;
 587
 588         /* Now check, whether the two units are connected */
 589 #if 0
 590         for (i=0; i<u1->node_count; ++i)
 591                 for (o=0; o<u2->node_count; ++o)
 592                         if (u1->nodes[i] == u2->nodes[o])
 593                                 return 0;
 594 #endif
 595
 596         /* After all, the sort key decides. Greater keys come first. */
 597         return u2->sort_key - u1->sort_key;
 598
 599 }
 600
 601 /**
 602  * Sort the ou's according to constraints and their sort_key
 603  */
 604 static void co_sort_units(copy_opt_t *co)
 605 {
 606         int i, count = 0, costs;
 607         unit_t *ou, **ous;
 608
 609         /* get the number of ous, remove them form the list and fill the array */
 610         list_for_each_entry(unit_t, ou, &co->units, units)
 611                 count++;
 612         ous = ALLOCAN(unit_t, count);
 613
 614         costs = co_get_max_copy_costs(co);
 615
 616         i = 0;
 617         list_for_each_entry(unit_t, ou, &co->units, units)
 618                 ous[i++] = ou;
 619
 620         INIT_LIST_HEAD(&co->units);
 621
 622         assert(count == i && list_empty(&co->units));
 623
 624         for (i=0; i<count; ++i)
 625                 ir_printf("%+F\n", ous[i]->nodes[0]);
 626
 627         qsort(ous, count, sizeof(*ous), compare_ous);
 628
 629         ir_printf("\n\n");
 630         for (i=0; i<count; ++i)
 631                 ir_printf("%+F\n", ous[i]->nodes[0]);
 632
 633         /* reinsert into list in correct order */
 634         for (i=0; i<count; ++i)
 635                 list_add_tail(&ous[i]->units, &co->units);
 636
 637         assert(costs == co_get_max_copy_costs(co));
 638 }
 639 #endif
 640
 641 void co_build_ou_structure(copy_opt_t *co)
 642 {
 643         DBG((dbg, LEVEL_1, "\tCollecting optimization units\n"));
 644         INIT_LIST_HEAD(&co->units);
 645         irg_walk_graph(co->irg, co_collect_units, NULL, co);
 646 #ifdef QUICK_AND_DIRTY_HACK
 647         co_sort_units(co);
 648 #endif
 649 }
 650
 651 void co_free_ou_structure(copy_opt_t *co)
 652 {
 653         unit_t *curr, *tmp;
 654         ASSERT_OU_AVAIL(co);
 655         list_for_each_entry_safe(unit_t, curr, tmp, &co->units, units) {
 656                 xfree(curr->nodes);
 657                 xfree(curr->costs);
 658                 xfree(curr);
 659         }
 660         co->units.next = NULL;
 661 }
 662
 663 /* co_solve_heuristic() is implemented in becopyheur.c */
 664
 665 int co_get_max_copy_costs(const copy_opt_t *co)
 666 {
 667         int i, res = 0;
 668         unit_t *curr;
 669
 670         ASSERT_OU_AVAIL(co);
 671
 672         list_for_each_entry(unit_t, curr, &co->units, units) {
 673                 res += curr->inevitable_costs;
 674                 for (i=1; i<curr->node_count; ++i)
 675                         res += curr->costs[i];
 676         }
 677         return res;
 678 }
 679
 680 int co_get_inevit_copy_costs(const copy_opt_t *co)
 681 {
 682         int res = 0;
 683         unit_t *curr;
 684
 685         ASSERT_OU_AVAIL(co);
 686
 687         list_for_each_entry(unit_t, curr, &co->units, units)
 688                 res += curr->inevitable_costs;
 689         return res;
 690 }
 691
 692 int co_get_copy_costs(const copy_opt_t *co)
 693 {
 694         int i, res = 0;
 695         unit_t *curr;
 696
 697         ASSERT_OU_AVAIL(co);
 698
 699         list_for_each_entry(unit_t, curr, &co->units, units) {
 700                 int root_col = get_irn_col(curr->nodes[0]);
 701                 DBG((dbg, LEVEL_1, "  %3d costs for root %+F color %d\n", curr->inevitable_costs, curr->nodes[0], root_col));
 702                 res += curr->inevitable_costs;
 703                 for (i=1; i<curr->node_count; ++i) {
 704                         int arg_col = get_irn_col(curr->nodes[i]);
 705                         if (root_col != arg_col) {
 706                                 DBG((dbg, LEVEL_1, "  %3d for arg %+F color %d\n", curr->costs[i], curr->nodes[i], arg_col));
 707                                 res += curr->costs[i];
 708                         }
 709                 }
 710         }
 711         return res;
 712 }
 713
 714 int co_get_lower_bound(const copy_opt_t *co)
 715 {
 716         int res = 0;
 717         unit_t *curr;
 718
 719         ASSERT_OU_AVAIL(co);
 720
 721         list_for_each_entry(unit_t, curr, &co->units, units)
 722                 res += curr->inevitable_costs + curr->min_nodes_costs;
 723         return res;
 724 }
 725
 726 void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat)
 727 {
 728         bitset_t *seen = bitset_malloc(get_irg_last_idx(co->irg));
 729
 730         memset(stat, 0, sizeof(stat[0]));
 731
 732         /* count affinity edges. */
 733         co_gs_foreach_aff_node(co, an) {
 734                 stat->aff_nodes += 1;
 735                 bitset_set(seen, get_irn_idx(an->irn));
 736                 co_gs_foreach_neighb(an, neigh) {
 737                         if (!bitset_is_set(seen, get_irn_idx(neigh->irn))) {
 738                                 stat->aff_edges += 1;
 739                                 stat->max_costs += neigh->costs;
 740
 741                                 if (get_irn_col(an->irn) != get_irn_col(neigh->irn)) {
 742                                         stat->costs += neigh->costs;
 743                                         stat->unsatisfied_edges += 1;
 744                                 }
 745
 746                                 if (nodes_interfere(co->cenv, an->irn, neigh->irn)) {
 747                                         stat->aff_int += 1;
 748                                         stat->inevit_costs += neigh->costs;
 749                                 }
 750
 751                         }
 752                 }
 753         }
 754
 755         bitset_free(seen);
 756 }
 757
 758 /******************************************************************************
 759    _____                 _        _____ _
 760   / ____|               | |      / ____| |
 761  | |  __ _ __ __ _ _ __ | |__   | (___ | |_ ___  _ __ __ _  __ _  ___
 762  | | |_ | '__/ _` | '_ \| '_ \   \___ \| __/ _ \| '__/ _` |/ _` |/ _ \
 763  | |__| | | | (_| | |_) | | | |  ____) | || (_) | | | (_| | (_| |  __/
 764   \_____|_|  \__,_| .__/|_| |_| |_____/ \__\___/|_|  \__,_|\__, |\___|
 765                   | |                                       __/ |
 766                   |_|                                      |___/
 767  ******************************************************************************/
 768
 769 static int compare_affinity_node_t(const void *k1, const void *k2, size_t size)
 770 {
 771         const affinity_node_t *n1 = (const affinity_node_t*)k1;
 772         const affinity_node_t *n2 = (const affinity_node_t*)k2;
 773         (void) size;
 774
 775         return (n1->irn != n2->irn);
 776 }
 777
 778 static void add_edge(copy_opt_t *co, ir_node *n1, ir_node *n2, int costs)
 779 {
 780         affinity_node_t new_node, *node;
 781         neighb_t        *nbr;
 782         int             allocnew = 1;
 783
 784         new_node.irn        = n1;
 785         new_node.degree     = 0;
 786         new_node.neighbours = NULL;
 787         node = set_insert(affinity_node_t, co->nodes, &new_node, sizeof(new_node), hash_irn(new_node.irn));
 788
 789         for (nbr = node->neighbours; nbr; nbr = nbr->next)
 790                 if (nbr->irn == n2) {
 791                         allocnew = 0;
 792                         break;
 793                 }
 794
 795         /* if we did not find n2 in n1's neighbourhood insert it */
 796         if (allocnew) {
 797                 nbr        = OALLOC(&co->obst, neighb_t);
 798                 nbr->irn   = n2;
 799                 nbr->costs = 0;
 800                 nbr->next  = node->neighbours;
 801
 802                 node->neighbours = nbr;
 803                 node->degree++;
 804         }
 805
 806         /* now nbr points to n1's neighbour-entry of n2 */
 807         nbr->costs += costs;
 808 }
 809
 810 static inline void add_edges(copy_opt_t *co, ir_node *n1, ir_node *n2, int costs)
 811 {
 812         if (! be_ifg_connected(co->cenv->ifg, n1, n2)) {
 813                 add_edge(co, n1, n2, costs);
 814                 add_edge(co, n2, n1, costs);
 815         }
 816 }
 817
 818 static void build_graph_walker(ir_node *irn, void *env)
 819 {
 820         const arch_register_req_t *req;
 821         copy_opt_t                *co  = (copy_opt_t*)env;
 822         int pos, max;
 823
 824         if (get_irn_mode(irn) == mode_T)
 825                 return;
 826         req = arch_get_irn_register_req(irn);
 827         if (req->cls != co->cls || arch_irn_is_ignore(irn))
 828                 return;
 829
 830         if (is_Reg_Phi(irn)) { /* Phis */
 831                 for (pos=0, max=get_irn_arity(irn); pos<max; ++pos) {
 832                         ir_node *arg = get_irn_n(irn, pos);
 833                         add_edges(co, irn, arg, co->get_costs(irn, pos));
 834                 }
 835         } else if (is_Perm_Proj(irn)) { /* Perms */
 836                 ir_node *arg = get_Perm_src(irn);
 837                 add_edges(co, irn, arg, co->get_costs(irn, -1));
 838         } else { /* 2-address code */
 839                 if (is_2addr_code(req)) {
 840                         const unsigned other = req->other_same;
 841                         int i;
 842
 843                         for (i = 0; 1U << i <= other; ++i) {
 844                                 if (other & (1U << i)) {
 845                                         ir_node *other = get_irn_n(skip_Proj(irn), i);
 846                                         if (!arch_irn_is_ignore(other))
 847                                                 add_edges(co, irn, other, co->get_costs(irn, -1));
 848                                 }
 849                         }
 850                 }
 851         }
 852 }
 853
 854 void co_build_graph_structure(copy_opt_t *co)
 855 {
 856         obstack_init(&co->obst);
 857         co->nodes = new_set(compare_affinity_node_t, 32);
 858
 859         irg_walk_graph(co->irg, build_graph_walker, NULL, co);
 860 }
 861
 862 void co_free_graph_structure(copy_opt_t *co)
 863 {
 864         ASSERT_GS_AVAIL(co);
 865
 866         del_set(co->nodes);
 867         obstack_free(&co->obst, NULL);
 868         co->nodes = NULL;
 869 }
 870
 871 int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn)
 872 {
 873         affinity_node_t new_node, *n;
 874
 875         ASSERT_GS_AVAIL(co);
 876
 877         new_node.irn = irn;
 878         n = set_find(affinity_node_t, co->nodes, &new_node, sizeof(new_node), hash_irn(new_node.irn));
 879         if (n) {
 880                 return (n->degree > 0);
 881         } else
 882                 return 0;
 883 }
 884
 885 static int co_dump_appel_disjoint_constraints(const copy_opt_t *co, ir_node *a, ir_node *b)
 886 {
 887         ir_node *nodes[]  = { a, b };
 888         bitset_t *constr[] = { NULL, NULL };
 889         int j;
 890
 891         constr[0] = bitset_alloca(co->cls->n_regs);
 892         constr[1] = bitset_alloca(co->cls->n_regs);
 893
 894         for (j = 0; j < 2; ++j) {
 895                 const arch_register_req_t *req = arch_get_irn_register_req(nodes[j]);
 896                 if (arch_register_req_is(req, limited))
 897                         rbitset_copy_to_bitset(req->limited, constr[j]);
 898                 else
 899                         bitset_set_all(constr[j]);
 900
 901         }
 902
 903         return !bitset_intersect(constr[0], constr[1]);
 904 }
 905
 906 /**
 907  * Dump the interference graph according to the Appel/George coalescing contest file format.
 908  * See: http://www.cs.princeton.edu/~appel/coalesce/format.html
 909  * @note Requires graph structure.
 910  * @param co The copy opt object.
 911  * @param f  A file to dump to.
 912  */
 913 static void co_dump_appel_graph(const copy_opt_t *co, FILE *f)
 914 {
 915         be_ifg_t *ifg       = co->cenv->ifg;
 916         int      *color_map = ALLOCAN(int, co->cls->n_regs);
 917         int      *node_map  = XMALLOCN(int, get_irg_last_idx(co->irg) + 1);
 918         ir_graph *irg       = co->irg;
 919         be_irg_t *birg      = be_birg_from_irg(irg);
 920
 921         ir_node *irn;
 922         nodes_iter_t it;
 923         neighbours_iter_t nit;
 924         int n, n_regs;
 925         unsigned i;
 926
 927         n_regs = 0;
 928         for (i = 0; i < co->cls->n_regs; ++i) {
 929                 const arch_register_t *reg = &co->cls->regs[i];
 930                 if (rbitset_is_set(birg->allocatable_regs, reg->global_index)) {
 931                         color_map[i] = n_regs++;
 932                 } else {
 933                         color_map[i] = -1;
 934                 }
 935         }
 936
 937         /*
 938          * n contains the first node number.
 939          * the values below n are the pre-colored register nodes
 940          */
 941
 942         n = n_regs;
 943         be_ifg_foreach_node(ifg, &it, irn) {
 944                 if (arch_irn_is_ignore(irn))
 945                         continue;
 946                 node_map[get_irn_idx(irn)] = n++;
 947         }
 948
 949         fprintf(f, "%d %d\n", n, n_regs);
 950
 951         be_ifg_foreach_node(ifg, &it, irn) {
 952                 if (!arch_irn_is_ignore(irn)) {
 953                         int idx                        = node_map[get_irn_idx(irn)];
 954                         affinity_node_t           *a   = get_affinity_info(co, irn);
 955                         const arch_register_req_t *req = arch_get_irn_register_req(irn);
 956                         ir_node                   *adj;
 957
 958                         if (arch_register_req_is(req, limited)) {
 959                                 for (i = 0; i < co->cls->n_regs; ++i) {
 960                                         if (!rbitset_is_set(req->limited, i) && color_map[i] >= 0)
 961                                                 fprintf(f, "%d %d -1\n", color_map[i], idx);
 962                                 }
 963                         }
 964
 965                         be_ifg_foreach_neighbour(ifg, &nit, irn, adj) {
 966                                 if (!arch_irn_is_ignore(adj) &&
 967                                                 !co_dump_appel_disjoint_constraints(co, irn, adj)) {
 968                                         int adj_idx = node_map[get_irn_idx(adj)];
 969                                         if (idx < adj_idx)
 970                                                 fprintf(f, "%d %d -1\n", idx, adj_idx);
 971                                 }
 972                         }
 973
 974                         if (a) {
 975                                 co_gs_foreach_neighb(a, n) {
 976                                         if (!arch_irn_is_ignore(n->irn)) {
 977                                                 int n_idx = node_map[get_irn_idx(n->irn)];
 978                                                 if (idx < n_idx)
 979                                                         fprintf(f, "%d %d %d\n", idx, n_idx, (int) n->costs);
 980                                         }
 981                                 }
 982                         }
 983                 }
 984         }
 985
 986         xfree(node_map);
 987 }
 988
 989 static FILE *my_open(const be_chordal_env_t *env, const char *prefix,
 990                      const char *suffix)
 991 {
 992         FILE *result;
 993         char buf[1024];
 994         size_t i, n;
 995         char *tu_name;
 996         const char *cup_name = be_get_irg_main_env(env->irg)->cup_name;
 997
 998         n = strlen(cup_name);
 999         tu_name = XMALLOCN(char, n + 1);
1000         strcpy(tu_name, cup_name);
1001         for (i = 0; i < n; ++i)
1002                 if (tu_name[i] == '.')
1003                         tu_name[i] = '_';
1004
1005
1006         ir_snprintf(buf, sizeof(buf), "%s%s_%F_%s%s", prefix, tu_name, env->irg, env->cls->name, suffix);
1007         xfree(tu_name);
1008         result = fopen(buf, "wt");
1009         if (result == NULL) {
1010                 panic("Couldn't open '%s' for writing.", buf);
1011         }
1012
1013         return result;
1014 }
1015
1016 void co_driver(be_chordal_env_t *cenv)
1017 {
1018         ir_timer_t          *timer = ir_timer_new();
1019         co_complete_stats_t before, after;
1020         copy_opt_t          *co;
1021         int                 was_optimal = 0;
1022
1023         assert(selected_copyopt);
1024
1025         /* skip copymin if algo is 'none' */
1026         if (selected_copyopt->copyopt == void_algo)
1027                 return;
1028
1029         be_assure_live_chk(cenv->irg);
1030
1031         co = new_copy_opt(cenv, cost_func);
1032         co_build_ou_structure(co);
1033         co_build_graph_structure(co);
1034
1035         co_complete_stats(co, &before);
1036
1037         be_stat_ev_ull("co_aff_nodes",    before.aff_nodes);
1038         be_stat_ev_ull("co_aff_edges",    before.aff_edges);
1039         be_stat_ev_ull("co_max_costs",    before.max_costs);
1040         be_stat_ev_ull("co_inevit_costs", before.inevit_costs);
1041         be_stat_ev_ull("co_aff_int",      before.aff_int);
1042
1043         be_stat_ev_ull("co_init_costs",   before.costs);
1044         be_stat_ev_ull("co_init_unsat",   before.unsatisfied_edges);
1045
1046         if (dump_flags & DUMP_BEFORE) {
1047                 FILE *f = my_open(cenv, "", "-before.vcg");
1048                 be_dump_ifg_co(f, co, style_flags & CO_IFG_DUMP_LABELS, style_flags & CO_IFG_DUMP_COLORS);
1049                 fclose(f);
1050         }
1051
1052         /* if the algo can improve results, provide an initial solution with heur1 */
1053         if (improve && selected_copyopt->can_improve_existing) {
1054                 co_complete_stats_t stats;
1055
1056                 /* produce a heuristic solution */
1057                 co_solve_heuristic(co);
1058
1059                 /* do the stats and provide the current costs */
1060                 co_complete_stats(co, &stats);
1061                 be_stat_ev_ull("co_prepare_costs", stats.costs);
1062         }
1063
1064         /* perform actual copy minimization */
1065         ir_timer_reset_and_start(timer);
1066         was_optimal = selected_copyopt->copyopt(co);
1067         ir_timer_stop(timer);
1068
1069         be_stat_ev("co_time", ir_timer_elapsed_msec(timer));
1070         be_stat_ev_ull("co_optimal", was_optimal);
1071         ir_timer_free(timer);
1072
1073         if (dump_flags & DUMP_AFTER) {
1074                 FILE *f = my_open(cenv, "", "-after.vcg");
1075                 be_dump_ifg_co(f, co, style_flags & CO_IFG_DUMP_LABELS, style_flags & CO_IFG_DUMP_COLORS);
1076                 fclose(f);
1077         }
1078
1079         co_complete_stats(co, &after);
1080
1081         if (do_stats) {
1082                 unsigned long long optimizable_costs = after.max_costs - after.inevit_costs;
1083                 unsigned long long evitable          = after.costs     - after.inevit_costs;
1084
1085                 ir_printf("%30F ", cenv->irg);
1086                 printf("%10s %10llu%10llu%10llu", cenv->cls->name, after.max_costs, before.costs, after.inevit_costs);
1087
1088                 if (optimizable_costs > 0)
1089                         printf("%10llu %5.2f\n", after.costs, (evitable * 100.0) / optimizable_costs);
1090                 else
1091                         printf("%10llu %5s\n", after.costs, "-");
1092         }
1093
1094         /* Dump the interference graph in Appel's format. */
1095         if (dump_flags & DUMP_APPEL) {
1096                 FILE *f = my_open(cenv, "", ".apl");
1097                 fprintf(f, "# %llu %llu\n", after.costs, after.unsatisfied_edges);
1098                 co_dump_appel_graph(co, f);
1099                 fclose(f);
1100         }
1101
1102         be_stat_ev_ull("co_after_costs", after.costs);
1103         be_stat_ev_ull("co_after_unsat", after.unsatisfied_edges);
1104
1105         co_free_graph_structure(co);
1106         co_free_ou_structure(co);
1107         free_copy_opt(co);
1108 }