nsz Git - libfirm/blob - ir/be/bespilldaemel.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       Naiv spilling algorithm
  23  * @author      Matthias Braun
  24  * @date        20.09.2005
  25  * @version     $Id: bespillbelady.c 13913 2007-05-18 12:48:56Z matze $
  26  * @summary
  27  *   This implements a naiv spilling algorithm. It is design to produce similar
  28  *   effects to the spill decisions produced by traditional graph coloring
  29  *   register allocators that spill while they are coloring the graph.
  30  *
  31  *   This spiller walks over all blocks and looks for places with too high
  32  *   register pressure where it spills the values that are cheapest to spill.
  33  *   Spilling in this context means placing a spill instruction behind the
  34  *   definition of the value and a reload before each usage.
  35  */
  36 #ifdef HAVE_CONFIG_H
  37 #include "config.h"
  38 #endif
  39
  40 #include "debug.h"
  41
  42 #include "irnodeset.h"
  43 #include "irgwalk.h"
  44 #include "irprintf.h"
  45 #include "iredges_t.h"
  46 #include "error.h"
  47
  48 #include "beirg.h"
  49 #include "bespilloptions.h"
  50 #include "bespill.h"
  51 #include "bemodule.h"
  52 #include "besched.h"
  53 #include "bearch_t.h"
  54 #include "be_t.h"
  55 #include "benode_t.h"
  56 #include "beirg.h"
  57
  58 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
  59
  60 typedef struct daemel_env_t daemel_env_t;
  61 struct daemel_env_t {
  62         spill_env_t                 *spill_env;
  63         int                          n_regs;
  64         const arch_env_t            *arch_env;
  65         const arch_register_class_t *cls;
  66         const be_lv_t               *lv;
  67         bitset_t                    *spilled_nodes;
  68 };
  69
  70 typedef struct spill_candidate_t spill_candidate_t;
  71 struct spill_candidate_t {
  72         double   costs;
  73         ir_node *node;
  74 };
  75
  76 static
  77 int compare_spill_candidates_desc(const void *d1, const void *d2)
  78 {
  79         const spill_candidate_t *c1 = d1;
  80         const spill_candidate_t *c2 = d2;
  81
  82         return (int) (c1->costs - c2->costs);
  83 }
  84
  85 static
  86 double get_spill_costs(daemel_env_t *env, ir_node *node)
  87 {
  88         const ir_edge_t *edge;
  89         spill_env_t     *spill_env = env->spill_env;
  90         double           costs     = be_get_spill_costs(spill_env, node, node);
  91
  92         foreach_out_edge(node, edge) {
  93                 ir_node *use = get_edge_src_irn(edge);
  94
  95                 if(is_Phi(use)) {
  96                         int      in         = get_edge_src_pos(edge);
  97                         ir_node *block      = get_nodes_block(use);
  98
  99                         costs += be_get_reload_costs_on_edge(spill_env, node, block, in);
 100                 } else {
 101                         costs += be_get_reload_costs(spill_env, node, use);
 102                 }
 103         }
 104
 105         return costs;
 106 }
 107
 108 /**
 109  * spills a node by placing a reload before each usage
 110  */
 111 static
 112 void spill_node(daemel_env_t *env, ir_node *node)
 113 {
 114         const ir_edge_t *edge;
 115         spill_env_t     *spill_env       = env->spill_env;
 116         const arch_register_class_t *cls = env->cls;
 117
 118         DBG((dbg, LEVEL_3, "\tspilling %+F\n", node));
 119
 120         foreach_out_edge(node, edge) {
 121                 ir_node *use = get_edge_src_irn(edge);
 122
 123                 if(is_Phi(use)) {
 124                         int      in         = get_edge_src_pos(edge);
 125                         ir_node *block      = get_nodes_block(use);
 126
 127                         be_add_reload_on_edge(spill_env, node, block, in, cls, 1);
 128                 } else if(!be_is_Keep(use)) {
 129                         be_add_reload(spill_env, node, use, cls, 1);
 130                 }
 131         }
 132
 133         bitset_set(env->spilled_nodes, get_irn_idx(node));
 134 }
 135
 136 /**
 137  * spill @p n nodes from a nodeset. Removes the nodes from the nodeset and
 138  * sets the spilled bits in env->spilled_nodes.
 139  */
 140 static
 141 void do_spilling(daemel_env_t *env, ir_nodeset_t *live_nodes, ir_node *node)
 142 {
 143         size_t                       node_count      = ir_nodeset_size(live_nodes);
 144         size_t                       additional_defines = 0;
 145         size_t                       reload_values      = 0;
 146         int                          registers          = env->n_regs;
 147         const arch_env_t            *arch_env           = env->arch_env;
 148         const arch_register_class_t *cls                = env->cls;
 149         spill_candidate_t           *candidates;
 150         ir_nodeset_iterator_t        iter;
 151         size_t                       i, arity;
 152         int                          spills_needed;
 153         size_t                       cand_idx;
 154         ir_node                     *n;
 155         const bitset_t              *spilled_nodes = env->spilled_nodes;
 156
 157         /* mode_T nodes define several values at once. Count them */
 158         if(get_irn_mode(node) == mode_T) {
 159                 ir_node *proj  = sched_next(node);
 160
 161                 while(is_Proj(proj)) {
 162                         if(arch_irn_consider_in_reg_alloc(arch_env, cls, proj)) {
 163                                 ++additional_defines;
 164                         }
 165                         proj = sched_next(proj);
 166                 }
 167         }
 168         if(bitset_is_set(spilled_nodes, get_irn_idx(node)))
 169                 ++additional_defines;
 170
 171         /* we need registers for the non-live argument values */
 172         arity = get_irn_arity(node);
 173         for(i = 0; i < arity; ++i) {
 174                 ir_node *pred = get_irn_n(node, i);
 175                 if(arch_irn_consider_in_reg_alloc(arch_env, cls, pred)
 176                                 && !ir_nodeset_contains(live_nodes, pred)) {
 177                         ++reload_values;
 178                 }
 179         }
 180
 181         if(reload_values > additional_defines)
 182                 additional_defines = reload_values;
 183
 184         spills_needed = (node_count + additional_defines) - registers;
 185         if(spills_needed <= 0)
 186                 return;
 187         DBG((dbg, LEVEL_2, "\tspills needed after %+F: %d\n", node, spills_needed));
 188
 189         candidates = xmalloc(node_count * sizeof(candidates[0]));
 190
 191         /* construct array with spill candidates and calculate their costs */
 192         i = 0;
 193         foreach_ir_nodeset(live_nodes, n, iter) {
 194                 spill_candidate_t *candidate = & candidates[i];
 195
 196                 assert(!bitset_is_set(spilled_nodes, get_irn_idx(n)));
 197
 198                 candidate->node  = n;
 199                 candidate->costs = get_spill_costs(env, n);
 200                 ++i;
 201         }
 202         assert(i == node_count);
 203
 204         /* sort spill candidates */
 205         qsort(candidates, node_count, sizeof(candidates[0]),
 206               compare_spill_candidates_desc);
 207
 208         /* spill cheapest ones */
 209         cand_idx = 0;
 210         while(spills_needed > 0) {
 211                 spill_candidate_t *candidate;
 212                 ir_node           *cand_node;
 213                 int               is_use;
 214
 215                 if (cand_idx >= node_count) {
 216                         panic("can't spill enough values for node %+F\n", node);
 217                 }
 218
 219
 220                 candidate = &candidates[cand_idx];
 221                 cand_node = candidate->node;
 222                 ++cand_idx;
 223
 224                 if(arch_irn_is(arch_env, cand_node, dont_spill))
 225                         continue;
 226
 227                 /* make sure the node is not an argument of the instruction */
 228                 is_use = 0;
 229                 for (i = 0; i < arity; ++i) {
 230                         ir_node *in = get_irn_n(node, i);
 231                         if(in == cand_node) {
 232                                 is_use = 1;
 233                                 break;
 234                         }
 235                 }
 236                 if(is_use) {
 237                         continue;
 238                 }
 239
 240                 spill_node(env, cand_node);
 241                 ir_nodeset_remove(live_nodes, cand_node);
 242                 --spills_needed;
 243         }
 244
 245         free(candidates);
 246 }
 247
 248 /**
 249  * similar to be_liveness_transfer.
 250  * custom liveness transfer function, that doesn't place already spilled values
 251  * into the liveness set
 252  */
 253 static
 254 void liveness_transfer(daemel_env_t *env, ir_node *node, ir_nodeset_t *nodeset)
 255 {
 256         int i, arity;
 257         const arch_register_class_t *cls      = env->cls;
 258         const arch_env_t            *arch_env = env->arch_env;
 259         const bitset_t              *bitset   = env->spilled_nodes;
 260
 261         /* You should better break out of your loop when hitting the first phi
 262          * function. */
 263         assert(!is_Phi(node) && "liveness_transfer produces invalid results for phi nodes");
 264
 265     if(arch_irn_consider_in_reg_alloc(arch_env, cls, node)) {
 266         ir_nodeset_remove(nodeset, node);
 267     }
 268
 269     arity = get_irn_arity(node);
 270     for(i = 0; i < arity; ++i) {
 271         ir_node *op = get_irn_n(node, i);
 272
 273         if(arch_irn_consider_in_reg_alloc(arch_env, cls, op)
 274                    && !bitset_is_set(bitset, get_irn_idx(op))) {
 275             ir_nodeset_insert(nodeset, op);
 276                 }
 277     }
 278 }
 279
 280 static __attribute__((unused))
 281 void print_nodeset(ir_nodeset_t *nodeset)
 282 {
 283         ir_nodeset_iterator_t  iter;
 284         ir_node               *node;
 285
 286         foreach_ir_nodeset(nodeset, node, iter) {
 287                 ir_fprintf(stderr, "%+F ", node);
 288         }
 289         fprintf(stderr, "\n");
 290 }
 291
 292 /**
 293  * make sure register pressure in a block is always equal or below the number
 294  * of available registers
 295  */
 296 static
 297 void spill_block(ir_node *block, void *data)
 298 {
 299         daemel_env_t                *env           = data;
 300         const arch_env_t            *arch_env      = env->arch_env;
 301         const arch_register_class_t *cls           = env->cls;
 302         const be_lv_t               *lv            = env->lv;
 303         ir_nodeset_t                 live_nodes;
 304         ir_nodeset_iterator_t        iter;
 305         ir_node                     *node;
 306         bitset_t                    *spilled_nodes = env->spilled_nodes;
 307         int                          phi_count, spilled_phis, regpressure, phi_spills_needed;
 308
 309         DBG((dbg, LEVEL_1, "spilling block %+F\n", block));
 310
 311         ir_nodeset_init(&live_nodes);
 312         be_liveness_end_of_block_ir_nodeset(lv, arch_env, cls, block, &live_nodes);
 313
 314         foreach_ir_nodeset(&live_nodes, node, iter) {
 315                 DBG((dbg, LEVEL_2, "\t%+F is live-end... ", node));
 316                 if(bitset_is_set(spilled_nodes, get_irn_idx(node))) {
 317                         DBG((dbg, LEVEL_2, "but spilled; removing.\n"));
 318                         ir_nodeset_remove_iterator(&live_nodes, &iter);
 319                 } else {
 320                         DBG((dbg, LEVEL_2, "keeping.\n"));
 321                 }
 322         }
 323
 324         sched_foreach_reverse(block, node) {
 325                 if(is_Phi(node))
 326                         break;
 327
 328                 if(is_Proj(node) || be_is_Keep(node)) {
 329                         liveness_transfer(env, node, &live_nodes);
 330                         continue;
 331                 }
 332
 333                 do_spilling(env, &live_nodes, node);
 334                 liveness_transfer(env, node, &live_nodes);
 335         }
 336
 337         phi_count = 0;
 338         spilled_phis = 0;
 339         sched_foreach(block, node) {
 340                 if(!is_Phi(node))
 341                         break;
 342
 343                 ++phi_count;
 344                 if(bitset_is_set(spilled_nodes, get_irn_idx(node))) {
 345                         ++spilled_phis;
 346                 }
 347         }
 348         regpressure       = ir_nodeset_size(&live_nodes) + spilled_phis;
 349         phi_spills_needed = regpressure - env->n_regs;
 350         DBG((dbg, LEVEL_3, "Regpressure before phis: %d phispills: %d\n",
 351              regpressure, phi_spills_needed));
 352         sched_foreach(block, node) {
 353                 if(!is_Phi(node))
 354                         break;
 355                 if(phi_spills_needed <= 0)
 356                         break;
 357
 358                 if(bitset_is_set(spilled_nodes, get_irn_idx(node))) {
 359                         be_spill_phi(env->spill_env, node);
 360                         --phi_spills_needed;
 361                 }
 362         }
 363         assert(phi_spills_needed <= 0);
 364
 365         ir_nodeset_destroy(&live_nodes);
 366 }
 367
 368 void be_spill_daemel(be_irg_t *birg, const arch_register_class_t *cls)
 369 {
 370         daemel_env_t  env;
 371         ir_graph     *irg    = be_get_birg_irg(birg);
 372         int           n_regs = cls->n_regs - be_put_ignore_regs(birg, cls, NULL);
 373
 374         if(n_regs == 0)
 375                 return;
 376
 377         be_liveness_assure_sets(be_assure_liveness(birg));
 378
 379         env.spill_env     = be_new_spill_env(birg);
 380         env.n_regs        = n_regs;
 381         env.arch_env      = be_get_birg_arch_env(birg);
 382         env.cls           = cls;
 383         env.lv            = be_get_birg_liveness(birg);
 384         env.spilled_nodes = bitset_malloc(get_irg_last_idx(irg));
 385
 386         DBG((dbg, LEVEL_1, "*** RegClass %s\n", cls->name));
 387
 388         irg_block_walk_graph(irg, spill_block, NULL, &env);
 389
 390         bitset_free(env.spilled_nodes);
 391
 392         be_insert_spills_reloads(env.spill_env);
 393
 394         be_delete_spill_env(env.spill_env);
 395 }
 396
 397 void be_init_daemelspill(void)
 398 {
 399         static be_spiller_t daemel_spiller = {
 400                 be_spill_daemel
 401         };
 402
 403         be_register_spiller("daemel", &daemel_spiller);
 404         FIRM_DBG_REGISTER(dbg, "ir.be.spilldaemel");
 405 }
 406
 407 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_doedelspill);