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