nsz Git - libfirm/blob - ir/be/bespilldaemel.c

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