nsz Git - libfirm/blob - ir/be/bespilldaemel.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       Naive 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  * @brief
  27  *   This implements a naive spilling algorithm. It is designed 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 #include "config.h"
  37
  38 #include "debug.h"
  39
  40 #include "irnodeset.h"
  41 #include "irgwalk.h"
  42 #include "irprintf.h"
  43 #include "iredges_t.h"
  44 #include "error.h"
  45
  46 #include "beirg.h"
  47 #include "bespill.h"
  48 #include "bespillutil.h"
  49 #include "bemodule.h"
  50 #include "besched.h"
  51 #include "bearch.h"
  52 #include "be_t.h"
  53 #include "benode.h"
  54 #include "beirg.h"
  55 #include "belive.h"
  56
  57 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
  58
  59 static spill_env_t                 *spill_env;
  60 static int                          n_regs;
  61 static const arch_register_class_t *cls;
  62 static const be_lv_t               *lv;
  63 static bitset_t                    *spilled_nodes;
  64
  65 typedef struct spill_candidate_t spill_candidate_t;
  66 struct spill_candidate_t {
  67         double   costs;
  68         ir_node *node;
  69 };
  70
  71 static int compare_spill_candidates_desc(const void *d1, const void *d2)
  72 {
  73         const spill_candidate_t *c1 = d1;
  74         const spill_candidate_t *c2 = d2;
  75
  76         return (int) (c1->costs - c2->costs);
  77 }
  78
  79 static double get_spill_costs(ir_node *node)
  80 {
  81         const ir_edge_t *edge;
  82         ir_node         *spill_place = skip_Proj(node);
  83         double           costs       = be_get_spill_costs(spill_env, node,
  84                                                           spill_place);
  85
  86         foreach_out_edge(node, edge) {
  87                 ir_node *use = get_edge_src_irn(edge);
  88
  89                 /* keeps should be directly below the node */
  90                 if (be_is_Keep(use)) {
  91                         continue;
  92                 }
  93
  94                 if (is_Phi(use)) {
  95                         int      in    = get_edge_src_pos(edge);
  96                         ir_node *block = get_nodes_block(use);
  97
  98                         costs += be_get_reload_costs_on_edge(spill_env, node, block, in);
  99                 } else {
 100                         costs += be_get_reload_costs(spill_env, node, use);
 101                 }
 102         }
 103
 104         /* TODO cache costs? */
 105
 106         return costs;
 107 }
 108
 109 /**
 110  * spills a node by placing a reload before each usage
 111  */
 112 static void spill_node(ir_node *node)
 113 {
 114         const ir_edge_t *edge;
 115
 116         DBG((dbg, LEVEL_3, "\tspilling %+F\n", node));
 117
 118         foreach_out_edge(node, edge) {
 119                 ir_node *use = get_edge_src_irn(edge);
 120                 if (is_Anchor(use))
 121                         continue;
 122                 if (be_is_Keep(use))
 123                         continue;
 124
 125                 if (is_Phi(use)) {
 126                         int      in         = get_edge_src_pos(edge);
 127                         ir_node *block      = get_nodes_block(use);
 128
 129                         be_add_reload_on_edge(spill_env, node, block, in, cls, 1);
 130                 } else {
 131                         be_add_reload(spill_env, node, use, cls, 1);
 132                 }
 133         }
 134
 135         bitset_set(spilled_nodes, get_irn_idx(node));
 136 }
 137
 138 /**
 139  * spill @p n nodes from a nodeset. Removes the nodes from the nodeset and
 140  * sets the spilled bits in spilled_nodes.
 141  */
 142 static void do_spilling(ir_nodeset_t *live_nodes, ir_node *node)
 143 {
 144         size_t                 n_live_nodes     = ir_nodeset_size(live_nodes);
 145         size_t                 values_defined   = 0;
 146         size_t                 free_regs_needed = 0;
 147         spill_candidate_t     *candidates;
 148         ir_nodeset_iterator_t  iter;
 149         size_t                 i, arity;
 150         int                    spills_needed;
 151         size_t                 cand_idx;
 152         ir_node               *n;
 153         ir_node               *value;
 154
 155         be_foreach_definition(node, cls, value,
 156                 ++values_defined;
 157         );
 158
 159         /* we need registers for the non-live argument values */
 160         arity = get_irn_arity(node);
 161         for (i = 0; i < arity; ++i) {
 162                 ir_node *pred = get_irn_n(node, i);
 163                 if (arch_irn_consider_in_reg_alloc(cls, pred)
 164                                 && !ir_nodeset_contains(live_nodes, pred)) {
 165                         ++free_regs_needed;
 166                 }
 167         }
 168
 169         /* we can reuse all reloaded values for the defined values, but we might
 170            need even more registers */
 171         if (values_defined > free_regs_needed)
 172                 free_regs_needed = values_defined;
 173
 174         spills_needed = (n_live_nodes + free_regs_needed) - n_regs;
 175         if (spills_needed <= 0)
 176                 return;
 177         DBG((dbg, LEVEL_2, "\tspills needed after %+F: %d\n", node, spills_needed));
 178
 179         candidates = ALLOCAN(spill_candidate_t, n_live_nodes);
 180
 181         /* construct array with spill candidates and calculate their costs */
 182         i = 0;
 183         foreach_ir_nodeset(live_nodes, n, iter) {
 184                 spill_candidate_t *candidate = & candidates[i];
 185
 186                 assert(!bitset_is_set(spilled_nodes, get_irn_idx(n)));
 187
 188                 candidate->node  = n;
 189                 candidate->costs = get_spill_costs(n);
 190                 ++i;
 191         }
 192         assert(i == n_live_nodes);
 193
 194         /* sort spill candidates */
 195         qsort(candidates, n_live_nodes, sizeof(candidates[0]),
 196               compare_spill_candidates_desc);
 197
 198         /* spill cheapest ones */
 199         cand_idx = 0;
 200         while (spills_needed > 0) {
 201                 spill_candidate_t *candidate;
 202                 ir_node           *cand_node;
 203                 int               is_use;
 204
 205                 if (cand_idx >= n_live_nodes) {
 206                         panic("can't spill enough values for node %+F", node);
 207                 }
 208
 209
 210                 candidate = &candidates[cand_idx];
 211                 cand_node = candidate->node;
 212                 ++cand_idx;
 213
 214                 if (arch_irn_is(skip_Proj_const(cand_node), dont_spill))
 215                         continue;
 216
 217                 /* make sure the node is not an argument of the instruction */
 218                 is_use = 0;
 219                 for (i = 0; i < arity; ++i) {
 220                         ir_node *in = get_irn_n(node, i);
 221                         if (in == cand_node) {
 222                                 is_use = 1;
 223                                 break;
 224                         }
 225                 }
 226                 if (is_use) {
 227                         continue;
 228                 }
 229
 230                 spill_node(cand_node);
 231                 ir_nodeset_remove(live_nodes, cand_node);
 232                 --spills_needed;
 233         }
 234 }
 235
 236 /**
 237  * removes all values from the nodeset that are defined by node
 238  */
 239 static void remove_defs(ir_node *node, ir_nodeset_t *nodeset)
 240 {
 241         ir_node *value;
 242         /* You should better break out of your loop when hitting the first phi
 243          * function. */
 244         assert(!is_Phi(node) && "liveness_transfer produces invalid results for phi nodes");
 245
 246         be_foreach_definition(node, cls, value,
 247                 ir_nodeset_remove(nodeset, value);
 248         );
 249 }
 250
 251 static void add_uses(ir_node *node, ir_nodeset_t *nodeset)
 252 {
 253         int i, arity;
 254
 255         arity = get_irn_arity(node);
 256         for (i = 0; i < arity; ++i) {
 257                 ir_node *op = get_irn_n(node, i);
 258
 259                 if (arch_irn_consider_in_reg_alloc(cls, op) &&
 260                                 !bitset_is_set(spilled_nodes, get_irn_idx(op))) {
 261                         ir_nodeset_insert(nodeset, op);
 262                 }
 263         }
 264 }
 265
 266 static __attribute__((unused))
 267 void print_nodeset(ir_nodeset_t *nodeset)
 268 {
 269         ir_nodeset_iterator_t  iter;
 270         ir_node               *node;
 271
 272         foreach_ir_nodeset(nodeset, node, iter) {
 273                 ir_fprintf(stderr, "%+F ", node);
 274         }
 275         fprintf(stderr, "\n");
 276 }
 277
 278 /**
 279  * make sure register pressure in a block is always equal or below the number
 280  * of available registers
 281  */
 282 static void spill_block(ir_node *block, void *data)
 283 {
 284         ir_nodeset_t           live_nodes;
 285         ir_nodeset_iterator_t  iter;
 286         ir_node               *node;
 287         int                    n_phi_values_spilled;
 288         int                    regpressure;
 289         int                    phi_spills_needed;
 290         (void) data;
 291
 292         DBG((dbg, LEVEL_1, "spilling block %+F\n", block));
 293
 294         /* construct set of live nodes at end of block */
 295         ir_nodeset_init(&live_nodes);
 296         be_liveness_end_of_block(lv, cls, block, &live_nodes);
 297
 298         /* remove already spilled nodes from liveset */
 299         foreach_ir_nodeset(&live_nodes, node, iter) {
 300                 DBG((dbg, LEVEL_2, "\t%+F is live-end... ", node));
 301                 if (bitset_is_set(spilled_nodes, get_irn_idx(node))) {
 302                         DBG((dbg, LEVEL_2, "but spilled; removing.\n"));
 303                         ir_nodeset_remove_iterator(&live_nodes, &iter);
 304                 } else {
 305                         DBG((dbg, LEVEL_2, "keeping.\n"));
 306                 }
 307         }
 308
 309         /* walk schedule backwards and spill until register pressure is fine at
 310          * each node */
 311         sched_foreach_reverse(block, node) {
 312                 if (is_Phi(node))
 313                         break;
 314
 315                 remove_defs(node, &live_nodes);
 316                 do_spilling(&live_nodes, node);
 317                 add_uses(node, &live_nodes);
 318         }
 319
 320         /* until now only the values of some phis have been spilled the phis itself
 321          * are still there and occupy registers, so we need to count them and might
 322          * have to spill some of them.
 323          */
 324         n_phi_values_spilled = 0;
 325         sched_foreach(block, node) {
 326                 if (!is_Phi(node))
 327                         break;
 328
 329                 if (bitset_is_set(spilled_nodes, get_irn_idx(node))) {
 330                         ++n_phi_values_spilled;
 331                 }
 332         }
 333
 334         /* calculate how many of the phis need to be spilled */
 335         regpressure       = ir_nodeset_size(&live_nodes) + n_phi_values_spilled;
 336         phi_spills_needed = regpressure - n_regs;
 337         DBG((dbg, LEVEL_3, "Regpressure before phis: %d phispills: %d\n",
 338              regpressure, phi_spills_needed));
 339
 340         /* spill as many phis as needed */
 341         /* TODO: we should really estimate costs of the phi spill as well...
 342          * and preferably spill phis with lower costs... */
 343         sched_foreach(block, node) {
 344                 if (!is_Phi(node))
 345                         break;
 346                 if (phi_spills_needed <= 0)
 347                         break;
 348
 349                 if (bitset_is_set(spilled_nodes, get_irn_idx(node))) {
 350                         be_spill_phi(spill_env, node);
 351                         --phi_spills_needed;
 352                 }
 353         }
 354         assert(phi_spills_needed <= 0);
 355
 356         ir_nodeset_destroy(&live_nodes);
 357 }
 358
 359 static void be_spill_daemel(ir_graph *irg, const arch_register_class_t *new_cls)
 360 {
 361         n_regs = new_cls->n_regs - be_put_ignore_regs(irg, new_cls, NULL);
 362
 363         if (n_regs == 0)
 364                 return;
 365
 366         be_liveness_assure_sets(be_assure_liveness(irg));
 367
 368         spill_env     = be_new_spill_env(irg);
 369         cls           = new_cls;
 370         lv            = be_get_irg_liveness(irg);
 371         spilled_nodes = bitset_malloc(get_irg_last_idx(irg));
 372
 373         DBG((dbg, LEVEL_1, "*** RegClass %s\n", cls->name));
 374
 375         irg_block_walk_graph(irg, spill_block, NULL, NULL);
 376
 377         bitset_free(spilled_nodes);
 378         spilled_nodes = NULL;
 379
 380         be_insert_spills_reloads(spill_env);
 381
 382         be_delete_spill_env(spill_env);
 383         spill_env = NULL;
 384 }
 385
 386 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_daemelspill);
 387 void be_init_daemelspill(void)
 388 {
 389         static be_spiller_t daemel_spiller = {
 390                 be_spill_daemel
 391         };
 392
 393         be_register_spiller("daemel", &daemel_spiller);
 394         FIRM_DBG_REGISTER(dbg, "firm.be.spilldaemel");
 395 }