nsz Git - libfirm/blob - ir/be/beuses.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       Methods to compute when a value will be used again.
  23  * @author      Sebastian Hack, Matthias Braun
  24  * @date        27.06.2005
  25  */
  26 #include "config.h"
  27
  28 #include <limits.h>
  29 #include <stdlib.h>
  30
  31 #include "config.h"
  32 #include "obst.h"
  33 #include "pmap.h"
  34 #include "debug.h"
  35
  36 #include "irgwalk.h"
  37 #include "irnode_t.h"
  38 #include "ircons_t.h"
  39 #include "irgraph_t.h"
  40 #include "iredges_t.h"
  41 #include "irdom_t.h"
  42 #include "util.h"
  43
  44 #include "be_t.h"
  45 #include "beutil.h"
  46 #include "belive_t.h"
  47 #include "benode.h"
  48 #include "besched.h"
  49 #include "beirgmod.h"
  50 #include "bearch.h"
  51 #include "beuses.h"
  52
  53 #define UNKNOWN_OUTERMOST_LOOP  ((unsigned)-1)
  54
  55 typedef struct be_use_t {
  56         const ir_node *block;
  57         const ir_node *node;
  58         unsigned outermost_loop;
  59         unsigned next_use;
  60         ir_visited_t visited;
  61 } be_use_t;
  62
  63 /**
  64  * The "uses" environment.
  65  */
  66 struct be_uses_t {
  67         set *uses;                          /**< cache: contains all computed uses so far. */
  68         ir_graph *irg;                      /**< the graph for this environment. */
  69         const be_lv_t *lv;                  /**< the liveness for the graph. */
  70         ir_visited_t visited_counter;       /**< current search counter. */
  71         DEBUG_ONLY(firm_dbg_module_t *dbg;  /**< debug module for debug messages. */)
  72 };
  73
  74 /**
  75  * Set-compare two uses.
  76  */
  77 static int cmp_use(const void *a, const void *b, size_t n)
  78 {
  79         const be_use_t *p = (const be_use_t*)a;
  80         const be_use_t *q = (const be_use_t*)b;
  81         (void) n;
  82
  83         return !(p->block == q->block && p->node == q->node);
  84 }
  85
  86 static be_next_use_t get_next_use(be_uses_t *env, ir_node *from,
  87                                                                   const ir_node *def, int skip_from_uses);
  88
  89 /**
  90  * Return the use for the given definition in the given block if exists,
  91  * else create it.
  92  *
  93  * @param env    the uses environment
  94  * @param block  the block we search the use in
  95  * @param def    the definition of the value we are searching
  96  */
  97 static const be_use_t *get_or_set_use_block(be_uses_t *env,
  98                                             const ir_node *block,
  99                                             const ir_node *def)
 100 {
 101         unsigned hash = hash_combine(hash_irn(block), hash_irn(def));
 102         be_use_t temp;
 103         be_use_t* result;
 104
 105         temp.block = block;
 106         temp.node = def;
 107         result = set_find(be_use_t, env->uses, &temp, sizeof(temp), hash);
 108
 109         if (result == NULL) {
 110                 // insert templ first as we might end in a loop in the get_next_use
 111                 // call otherwise
 112                 temp.next_use = USES_INFINITY;
 113                 temp.outermost_loop = UNKNOWN_OUTERMOST_LOOP;
 114                 temp.visited = 0;
 115                 result = set_insert(be_use_t, env->uses, &temp, sizeof(temp), hash);
 116         }
 117
 118         if (result->outermost_loop == UNKNOWN_OUTERMOST_LOOP && result->visited < env->visited_counter) {
 119                 be_next_use_t next_use;
 120
 121                 result->visited = env->visited_counter;
 122                 next_use = get_next_use(env, sched_first(block), def, 0);
 123                 if (next_use.outermost_loop != UNKNOWN_OUTERMOST_LOOP) {
 124                         result->next_use = next_use.time;
 125                         result->outermost_loop = next_use.outermost_loop;
 126                         DBG((env->dbg, LEVEL_5, "Setting nextuse of %+F in block %+F to %u (outermostloop %d)\n",
 127                                 def, block, result->next_use, result->outermost_loop));
 128                 }
 129         }
 130
 131         return result;
 132 }
 133
 134 /**
 135  * Check if a value of the given definition is used in the given block
 136  * as a Phi argument.
 137  *
 138  * @param block  the block to check
 139  * @param def    the definition of the value
 140  *
 141  * @return non-zero if the value is used in the given block as a Phi argument
 142  * in one of its successor blocks.
 143  */
 144 static int be_is_phi_argument(const ir_node *block, const ir_node *def)
 145 {
 146         if (get_irn_n_edges_kind(block, EDGE_KIND_BLOCK) < 1)
 147                 return 0;
 148
 149         ir_node *const succ_block = get_first_block_succ(block);
 150
 151         if (get_Block_n_cfgpreds(succ_block) <= 1) {
 152                 /* no Phis in the successor */
 153                 return 0;
 154         }
 155
 156         /* find the index of block in its successor */
 157         int const i = get_Block_cfgpred_pos(succ_block, block);
 158         assert(i >= 0);
 159
 160         /* iterate over the Phi nodes in the successor and check if def is
 161          * one of its arguments */
 162         sched_foreach(succ_block, node) {
 163                 ir_node *arg;
 164
 165                 if (!is_Phi(node)) {
 166                         /* found first non-Phi node, we can stop the search here */
 167                         break;
 168                 }
 169
 170                 arg = get_irn_n(node, i);
 171                 if (arg == def)
 172                         return 1;
 173         }
 174
 175         return 0;
 176 }
 177
 178 /**
 179  * Retrieve the scheduled index (the "step") of this node in its
 180  * block.
 181  *
 182  * @param node  the node
 183  */
 184 static inline unsigned get_step(const ir_node *node)
 185 {
 186         return (unsigned)PTR_TO_INT(get_irn_link(node));
 187 }
 188
 189 /**
 190  * Set the scheduled index (the "step") of this node in its
 191  * block.
 192  *
 193  * @param node  the node
 194  * @param step  the scheduled index of the node
 195  */
 196 static inline void set_step(ir_node *node, unsigned step)
 197 {
 198         set_irn_link(node, INT_TO_PTR(step));
 199 }
 200
 201 /**
 202  * Find the next use of a value defined by def, starting at node from.
 203  *
 204  * @param env             the uses environment
 205  * @param from            the node at which we should start the search
 206  * @param def             the definition of the value
 207  * @param skip_from_uses  if non-zero, ignore from uses
 208  */
 209 static be_next_use_t get_next_use(be_uses_t *env, ir_node *from,
 210                                                                   const ir_node *def, int skip_from_uses)
 211 {
 212         unsigned  step;
 213         ir_node  *block = get_nodes_block(from);
 214         ir_node  *next_use_node;
 215         ir_node  *node;
 216         unsigned  timestep;
 217         unsigned  next_use_step;
 218
 219         assert(skip_from_uses == 0 || skip_from_uses == 1);
 220         if (skip_from_uses) {
 221                 from = sched_next(from);
 222         }
 223
 224         next_use_node = NULL;
 225         next_use_step = INT_MAX;
 226         timestep      = get_step(from);
 227         foreach_out_edge(def, edge) {
 228                 unsigned node_step;
 229                 node = get_edge_src_irn(edge);
 230
 231                 if (is_Anchor(node))
 232                         continue;
 233                 if (get_nodes_block(node) != block)
 234                         continue;
 235                 if (is_Phi(node))
 236                         continue;
 237
 238                 node_step = get_step(node);
 239                 if (node_step < timestep)
 240                         continue;
 241                 if (node_step < next_use_step) {
 242                         next_use_node = node;
 243                         next_use_step = node_step;
 244                 }
 245         }
 246
 247         if (next_use_node != NULL) {
 248                 be_next_use_t result;
 249                 result.time           = next_use_step - timestep + skip_from_uses;
 250                 result.outermost_loop = get_loop_depth(get_irn_loop(block));
 251                 result.before         = next_use_node;
 252                 return result;
 253         }
 254
 255         node = sched_last(block);
 256         step = get_step(node) + 1 + timestep + skip_from_uses;
 257
 258         if (be_is_phi_argument(block, def)) {
 259                 // TODO we really should continue searching the uses of the phi,
 260                 // as a phi isn't a real use that implies a reload (because we could
 261                 // easily spill the whole phi)
 262
 263                 be_next_use_t result;
 264                 result.time           = step;
 265                 result.outermost_loop = get_loop_depth(get_irn_loop(block));
 266                 result.before         = block;
 267                 return result;
 268         }
 269
 270         {
 271         unsigned  next_use   = USES_INFINITY;
 272         unsigned  outermost_loop;
 273         be_next_use_t result;
 274         ir_loop  *loop          = get_irn_loop(block);
 275         unsigned  loopdepth     = get_loop_depth(loop);
 276         int       found_visited = 0;
 277         int       found_use     = 0;
 278
 279         result.before  = NULL;
 280         outermost_loop = loopdepth;
 281         foreach_block_succ(block, edge) {
 282                 const be_use_t *use;
 283                 const ir_node *succ_block = get_edge_src_irn(edge);
 284                 ir_loop *succ_loop;
 285                 unsigned use_dist;
 286
 287                 DBG((env->dbg, LEVEL_5, "Checking succ of block %+F: %+F (for use of %+F)\n", block, succ_block, def));
 288                 if (!be_is_live_in(env->lv, succ_block, def)) {
 289                         //next_use = USES_INFINITY;
 290                         DBG((env->dbg, LEVEL_5, "   not live in\n"));
 291                         continue;
 292                 }
 293
 294                 use = get_or_set_use_block(env, succ_block, def);
 295                 DBG((env->dbg, LEVEL_5, "Found %u (loopdepth %u) (we're in block %+F)\n", use->next_use,
 296                                         use->outermost_loop, block));
 297                 if (USES_IS_INFINITE(use->next_use)) {
 298                         if (use->outermost_loop == UNKNOWN_OUTERMOST_LOOP) {
 299                                 found_visited = 1;
 300                         }
 301                         continue;
 302                 }
 303
 304                 found_use = 1;
 305                 use_dist = use->next_use;
 306
 307                 succ_loop = get_irn_loop(succ_block);
 308                 if (get_loop_depth(succ_loop) < loopdepth) {
 309                         unsigned factor = (loopdepth - get_loop_depth(succ_loop)) * 5000;
 310                         DBG((env->dbg, LEVEL_5, "Increase usestep because of loop out edge %d -> %d (%u)\n", factor));
 311                         // TODO we should use the number of nodes in the loop or so...
 312                         use_dist += factor;
 313                 }
 314
 315                 if (use_dist < next_use) {
 316                         next_use       = use_dist;
 317                         outermost_loop = use->outermost_loop;
 318                         result.before  = use->node;
 319                 }
 320         }
 321
 322         if (loopdepth < outermost_loop)
 323                 outermost_loop = loopdepth;
 324
 325         result.time           = next_use + step;
 326         result.outermost_loop = outermost_loop;
 327
 328         if (!found_use && found_visited) {
 329                 // the current result is correct for the current search, but isn't
 330                 // generally correct, so mark it
 331                 result.outermost_loop = UNKNOWN_OUTERMOST_LOOP;
 332         }
 333         DBG((env->dbg, LEVEL_5, "Result: %d (outerloop: %u)\n", result.time, result.outermost_loop));
 334         return result;
 335         }
 336 }
 337
 338 be_next_use_t be_get_next_use(be_uses_t *env, ir_node *from,
 339                          const ir_node *def, int skip_from_uses)
 340 {
 341         ++env->visited_counter;
 342         return get_next_use(env, from, def, skip_from_uses);
 343 }
 344
 345 /**
 346  * Pre-block walker, set the step number for every scheduled node
 347  * in increasing order.
 348  *
 349  * After this, two scheduled nodes can be easily compared for the
 350  * "scheduled earlier in block" property.
 351  */
 352 static void set_sched_step_walker(ir_node *block, void *data)
 353 {
 354         unsigned step = 0;
 355         (void) data;
 356
 357         sched_foreach(block, node) {
 358                 set_step(node, step);
 359                 if (is_Phi(node))
 360                         continue;
 361                 ++step;
 362         }
 363 }
 364
 365 be_uses_t *be_begin_uses(ir_graph *irg, const be_lv_t *lv)
 366 {
 367         be_uses_t *env = XMALLOC(be_uses_t);
 368
 369         assure_edges(irg);
 370
 371         //set_using_irn_link(irg);
 372
 373         /* precalculate sched steps */
 374         irg_block_walk_graph(irg, set_sched_step_walker, NULL, NULL);
 375
 376         env->uses = new_set(cmp_use, 512);
 377         env->irg = irg;
 378         env->lv = lv;
 379         env->visited_counter = 0;
 380         FIRM_DBG_REGISTER(env->dbg, "firm.be.uses");
 381
 382         return env;
 383 }
 384
 385 void be_end_uses(be_uses_t *env)
 386 {
 387         //clear_using_irn_link(env->irg);
 388         del_set(env->uses);
 389         free(env);
 390 }