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