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                 const ir_edge_t *edge;
 160
 161                 foreach_out_edge(node, edge) {
 162                         const ir_node *proj = get_edge_src_irn(edge);
 163
 164                         if(arch_irn_consider_in_reg_alloc(arch_env, cls, proj)) {
 165                                 ++additional_defines;
 166                         }
 167                 }
 168         }
 169         if(bitset_is_set(spilled_nodes, get_irn_idx(node)))
 170                 ++additional_defines;
 171
 172         /* we need registers for the non-live argument values */
 173         arity = get_irn_arity(node);
 174         for(i = 0; i < arity; ++i) {
 175                 ir_node *pred = get_irn_n(node, i);
 176                 if(arch_irn_consider_in_reg_alloc(arch_env, cls, pred)
 177                                 && !ir_nodeset_contains(live_nodes, pred)) {
 178                         ++reload_values;
 179                 }
 180         }
 181
 182         if(reload_values > additional_defines)
 183                 additional_defines = reload_values;
 184
 185         spills_needed = (node_count + additional_defines) - registers;
 186         if(spills_needed <= 0)
 187                 return;
 188         DBG((dbg, LEVEL_2, "\tspills needed after %+F: %d\n", node, spills_needed));
 189
 190         candidates = xmalloc(node_count * sizeof(candidates[0]));
 191
 192         /* construct array with spill candidates and calculate their costs */
 193         i = 0;
 194         foreach_ir_nodeset(live_nodes, n, iter) {
 195                 spill_candidate_t *candidate = & candidates[i];
 196
 197                 assert(!bitset_is_set(spilled_nodes, get_irn_idx(n)));
 198
 199                 candidate->node  = n;
 200                 candidate->costs = get_spill_costs(env, n);
 201                 ++i;
 202         }
 203         assert(i == node_count);
 204
 205         /* sort spill candidates */
 206         qsort(candidates, node_count, sizeof(candidates[0]),
 207               compare_spill_candidates_desc);
 208
 209         /* spill cheapest ones */
 210         cand_idx = 0;
 211         while(spills_needed > 0) {
 212                 spill_candidate_t *candidate;
 213                 ir_node           *cand_node;
 214                 int               is_use;
 215
 216                 if (cand_idx >= node_count) {
 217                         panic("can't spill enough values for node %+F\n", node);
 218                 }
 219
 220
 221                 candidate = &candidates[cand_idx];
 222                 cand_node = candidate->node;
 223                 ++cand_idx;
 224
 225                 if(arch_irn_is(arch_env, cand_node, dont_spill))
 226                         continue;
 227
 228                 /* make sure the node is not an argument of the instruction */
 229                 is_use = 0;
 230                 for (i = 0; i < arity; ++i) {
 231                         ir_node *in = get_irn_n(node, i);
 232                         if(in == cand_node) {
 233                                 is_use = 1;
 234                                 break;
 235                         }
 236                 }
 237                 if(is_use) {
 238                         continue;
 239                 }
 240
 241                 spill_node(env, cand_node);
 242                 ir_nodeset_remove(live_nodes, cand_node);
 243                 --spills_needed;
 244         }
 245
 246         free(candidates);
 247 }
 248
 249 /**
 250  * similar to be_liveness_transfer.
 251  * custom liveness transfer function, that doesn't place already spilled values
 252  * into the liveness set
 253  */
 254 static
 255 void liveness_transfer_remove_defs(daemel_env_t *env, ir_node *node,
 256                                    ir_nodeset_t *nodeset)
 257 {
 258         const arch_register_class_t *cls      = env->cls;
 259         const arch_env_t            *arch_env = env->arch_env;
 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 (get_irn_mode(node) == mode_T) {
 266                 const ir_edge_t *edge;
 267
 268                 foreach_out_edge(node, edge) {
 269                         const ir_node *proj = get_edge_src_irn(edge);
 270
 271                         if (arch_irn_consider_in_reg_alloc(arch_env, cls, proj)) {
 272                                 ir_nodeset_remove(nodeset, proj);
 273                         }
 274                 }
 275         }
 276
 277     if(arch_irn_consider_in_reg_alloc(arch_env, cls, node)) {
 278         ir_nodeset_remove(nodeset, node);
 279     }
 280 }
 281
 282 static void liveness_transfer_add_uses(daemel_env_t *env, ir_node *node,
 283                                    ir_nodeset_t *nodeset)
 284 {
 285         int i, arity;
 286         const arch_register_class_t *cls      = env->cls;
 287         const arch_env_t            *arch_env = env->arch_env;
 288         const bitset_t              *bitset   = env->spilled_nodes;
 289
 290
 291     arity = get_irn_arity(node);
 292     for(i = 0; i < arity; ++i) {
 293         ir_node *op = get_irn_n(node, i);
 294
 295         if(arch_irn_consider_in_reg_alloc(arch_env, cls, op)
 296                    && !bitset_is_set(bitset, get_irn_idx(op))) {
 297             ir_nodeset_insert(nodeset, op);
 298                 }
 299     }
 300 }
 301
 302 static __attribute__((unused))
 303 void print_nodeset(ir_nodeset_t *nodeset)
 304 {
 305         ir_nodeset_iterator_t  iter;
 306         ir_node               *node;
 307
 308         foreach_ir_nodeset(nodeset, node, iter) {
 309                 ir_fprintf(stderr, "%+F ", node);
 310         }
 311         fprintf(stderr, "\n");
 312 }
 313
 314 /**
 315  * make sure register pressure in a block is always equal or below the number
 316  * of available registers
 317  */
 318 static
 319 void spill_block(ir_node *block, void *data)
 320 {
 321         daemel_env_t                *env           = data;
 322         const arch_env_t            *arch_env      = env->arch_env;
 323         const arch_register_class_t *cls           = env->cls;
 324         const be_lv_t               *lv            = env->lv;
 325         ir_nodeset_t                 live_nodes;
 326         ir_nodeset_iterator_t        iter;
 327         ir_node                     *node;
 328         bitset_t                    *spilled_nodes = env->spilled_nodes;
 329         int                          phi_count, spilled_phis, regpressure, phi_spills_needed;
 330
 331         DBG((dbg, LEVEL_1, "spilling block %+F\n", block));
 332
 333         ir_nodeset_init(&live_nodes);
 334         be_liveness_end_of_block(lv, arch_env, cls, block, &live_nodes);
 335
 336         foreach_ir_nodeset(&live_nodes, node, iter) {
 337                 DBG((dbg, LEVEL_2, "\t%+F is live-end... ", node));
 338                 if(bitset_is_set(spilled_nodes, get_irn_idx(node))) {
 339                         DBG((dbg, LEVEL_2, "but spilled; removing.\n"));
 340                         ir_nodeset_remove_iterator(&live_nodes, &iter);
 341                 } else {
 342                         DBG((dbg, LEVEL_2, "keeping.\n"));
 343                 }
 344         }
 345
 346         sched_foreach_reverse(block, node) {
 347                 if(is_Phi(node))
 348                         break;
 349
 350                 if(be_is_Keep(node)) {
 351                         /* remove defs should never do something for keep nodes, but we
 352                          * leave it here for consistency */
 353                         liveness_transfer_remove_defs(env, node, &live_nodes);
 354                         liveness_transfer_add_uses(env, node, &live_nodes);
 355                         continue;
 356                 }
 357
 358                 liveness_transfer_remove_defs(env, node, &live_nodes);
 359                 do_spilling(env, &live_nodes, node);
 360                 liveness_transfer_add_uses(env, node, &live_nodes);
 361         }
 362
 363         phi_count = 0;
 364         spilled_phis = 0;
 365         sched_foreach(block, node) {
 366                 if(!is_Phi(node))
 367                         break;
 368
 369                 ++phi_count;
 370                 if(bitset_is_set(spilled_nodes, get_irn_idx(node))) {
 371                         ++spilled_phis;
 372                 }
 373         }
 374         regpressure       = ir_nodeset_size(&live_nodes) + spilled_phis;
 375         phi_spills_needed = regpressure - env->n_regs;
 376         DBG((dbg, LEVEL_3, "Regpressure before phis: %d phispills: %d\n",
 377              regpressure, phi_spills_needed));
 378         sched_foreach(block, node) {
 379                 if(!is_Phi(node))
 380                         break;
 381                 if(phi_spills_needed <= 0)
 382                         break;
 383
 384                 if(bitset_is_set(spilled_nodes, get_irn_idx(node))) {
 385                         be_spill_phi(env->spill_env, node);
 386                         --phi_spills_needed;
 387                 }
 388         }
 389         assert(phi_spills_needed <= 0);
 390
 391         ir_nodeset_destroy(&live_nodes);
 392 }
 393
 394 void be_spill_daemel(be_irg_t *birg, const arch_register_class_t *cls)
 395 {
 396         daemel_env_t  env;
 397         ir_graph     *irg    = be_get_birg_irg(birg);
 398         int           n_regs = cls->n_regs - be_put_ignore_regs(birg, cls, NULL);
 399
 400         if(n_regs == 0)
 401                 return;
 402
 403         be_liveness_assure_sets(be_assure_liveness(birg));
 404
 405         env.spill_env     = be_new_spill_env(birg);
 406         env.n_regs        = n_regs;
 407         env.arch_env      = be_get_birg_arch_env(birg);
 408         env.cls           = cls;
 409         env.lv            = be_get_birg_liveness(birg);
 410         env.spilled_nodes = bitset_malloc(get_irg_last_idx(irg));
 411
 412         DBG((dbg, LEVEL_1, "*** RegClass %s\n", cls->name));
 413
 414         irg_block_walk_graph(irg, spill_block, NULL, &env);
 415
 416         bitset_free(env.spilled_nodes);
 417
 418         be_insert_spills_reloads(env.spill_env);
 419
 420         be_delete_spill_env(env.spill_env);
 421 }
 422
 423 void be_init_daemelspill(void)
 424 {
 425         static be_spiller_t daemel_spiller = {
 426                 be_spill_daemel
 427         };
 428
 429         be_register_spiller("daemel", &daemel_spiller);
 430         FIRM_DBG_REGISTER(dbg, "ir.be.spilldaemel");
 431 }
 432
 433 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_doedelspill);