nsz Git - libfirm/blob - ir/ir/irgwalk_blk.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   Blockwise walker implementation
  23  * @author  Michael Beck
  24  * @version $Id$
  25  */
  26 #ifdef HAVE_CONFIG_H
  27 # include "config.h"
  28 #endif
  29
  30 #include "irnode_t.h"
  31 #include "irgraph_t.h" /* visited flag */
  32 #include "irgwalk.h"
  33 #include "pset.h"
  34 #include "irhooks.h"
  35 #include "array.h"
  36 #include "hashptr.h"
  37
  38 #define _get_walk_arity(env, node) \
  39         ((env)->follow_deps ? get_irn_ins_or_deps((node)) : get_irn_arity((node)))
  40 #define _get_walk_irn_n(env, node, pos) \
  41         ((env)->follow_deps ? get_irn_in_or_dep((node), (pos)) : get_irn_n((node), (pos)))
  42
  43 /**
  44  * Metadata for block walker
  45  */
  46 typedef struct _blk_collect_data_t {
  47         struct obstack obst;            /**< obstack to allocate objects on */
  48         pset           *blk_map;        /**< Hash map: Block -> List */
  49         ir_node        **blk_list;      /**< the Block list */
  50         unsigned       follow_deps : 1; /**< follow dependency edges */
  51 } blk_collect_data_t;
  52
  53 /**
  54  * An entry for a block in the blk_map
  55  */
  56 typedef struct _block_entry_t {
  57         ir_node *block;       /**< the block */
  58         ir_node **phi_list;   /**< the list of Phi instruction */
  59         ir_node **df_list;    /**< the list of data flow instruction */
  60         ir_node **cf_list;    /**< the list of control flow instructions */
  61         ir_node **entry_list; /**< list of all block entries */
  62 } block_entry_t;
  63
  64 /**
  65  * compare two block_entries
  66  */
  67 static int addr_cmp(const void *elt, const void *key) {
  68         const block_entry_t *e1 = elt;
  69         const block_entry_t *e2 = key;
  70
  71         return e1->block != e2->block;
  72 }
  73
  74 /**
  75  * Returns the associates block_entry_t for an block
  76  */
  77 static block_entry_t *block_find_entry(ir_node *block, blk_collect_data_t *ctx)
  78 {
  79         block_entry_t key;
  80         block_entry_t *elem;
  81
  82         key.block = block;
  83         elem = pset_find(ctx->blk_map, &key, HASH_PTR(block));
  84         if (elem)
  85                 return elem;
  86
  87         elem = obstack_alloc(&ctx->obst, sizeof(*elem));
  88
  89         elem->block      = block;
  90         elem->phi_list   = NEW_ARR_F(ir_node *, 0);
  91         elem->df_list    = NEW_ARR_F(ir_node *, 0);
  92         elem->cf_list    = NEW_ARR_F(ir_node *, 0);
  93         elem->entry_list = NEW_ARR_F(ir_node *, 0);
  94
  95         return pset_insert(ctx->blk_map, elem, HASH_PTR(block));
  96 }
  97
  98 /**
  99  * Traverse a block in pre order.
 100  */
 101 static void traverse_block_pre(ir_node *block, block_entry_t *entry, irg_walk_func *pre, void *env) {
 102         int j;
 103
 104         for (j = ARR_LEN(entry->cf_list) - 1; j >= 0; --j) {
 105                 ir_node *node = entry->cf_list[j];
 106                 pre(node, env);
 107         }
 108
 109         for (j = ARR_LEN(entry->df_list) - 1; j >= 0; --j) {
 110                 ir_node *node = entry->df_list[j];
 111                 pre(node, env);
 112         }
 113
 114         for (j = ARR_LEN(entry->phi_list) - 1; j >= 0; --j) {
 115                 ir_node *node = entry->phi_list[j];
 116                 pre(node, env);
 117         }
 118
 119         pre(block, env);
 120 }
 121
 122 /**
 123  * Traverse a block in post order.
 124  */
 125 void traverse_block_post(ir_node *block, block_entry_t *entry, irg_walk_func *post, void *env)  {
 126         int j, n;
 127
 128         post(block, env);
 129
 130         for (j = 0, n = ARR_LEN(entry->phi_list); j < n; ++j) {
 131                 ir_node *node = entry->phi_list[j];
 132                 post(node, env);
 133         }
 134
 135         for (j = 0, n = ARR_LEN(entry->df_list); j < n; ++j) {
 136                 ir_node *node = entry->df_list[j];
 137                 post(node, env);
 138         }
 139
 140         for (j = 0, n = ARR_LEN(entry->cf_list); j < n; ++j) {
 141                 ir_node *node = entry->cf_list[j];
 142                 post(node, env);
 143         }
 144 }
 145
 146 /**
 147  * traverse the pre order only, from End to Start
 148  */
 149 static void traverse_pre(blk_collect_data_t *blks, irg_walk_func *pre, void *env) {
 150         int i;
 151
 152         for (i = ARR_LEN(blks->blk_list) - 1; i >= 0; --i) {
 153                 ir_node       *block = blks->blk_list[i];
 154                 block_entry_t *entry = block_find_entry(block, blks);
 155
 156                 traverse_block_pre(block, entry, pre, env);
 157
 158                 DEL_ARR_F(entry->entry_list);
 159                 DEL_ARR_F(entry->phi_list);
 160                 DEL_ARR_F(entry->df_list);
 161                 DEL_ARR_F(entry->cf_list);
 162         }
 163 }
 164
 165 /**
 166  * traverse the post order only, from Start to End
 167  */
 168 static void traverse_post(blk_collect_data_t *blks, irg_walk_func *post, void *env) {
 169         int i, k;
 170
 171         for (i = 0, k = ARR_LEN(blks->blk_list); i < k; ++i) {
 172                 ir_node       *block = blks->blk_list[i];
 173                 block_entry_t *entry = block_find_entry(block, blks);
 174
 175                 traverse_block_post(block, entry, post, env);
 176
 177                 DEL_ARR_F(entry->entry_list);
 178                 DEL_ARR_F(entry->phi_list);
 179                 DEL_ARR_F(entry->df_list);
 180                 DEL_ARR_F(entry->cf_list);
 181         }
 182 }
 183
 184 /**
 185  * traverse both
 186  */
 187 static void traverse_both(blk_collect_data_t *blks, irg_walk_func *pre, irg_walk_func *post, void *env)
 188 {
 189         int i;
 190
 191         for (i = ARR_LEN(blks->blk_list) - 1; i >= 0; --i) {
 192                 ir_node       *block = blks->blk_list[i];
 193                 block_entry_t *entry = block_find_entry(block, blks);
 194
 195                 traverse_block_pre(block, entry, pre, env);
 196         }
 197
 198         /* second step */
 199         traverse_post(blks, post, env);
 200 }
 201
 202 /**
 203  * Do the traversal.
 204  */
 205 static void traverse_blocks(blk_collect_data_t *blks, irg_walk_func *pre, irg_walk_func *post, void *env) {
 206         if      (!post) traverse_pre (blks, pre, env);
 207         else if (!pre)  traverse_post(blks, post, env);
 208         else            traverse_both(blks, pre, post, env);
 209 }
 210
 211 typedef struct dom_traversal_t {
 212         blk_collect_data_t *blks;
 213         irg_walk_func      *pre;
 214         irg_walk_func      *post;
 215         void               *env;
 216 } dom_traversal_t;
 217
 218 /**
 219  * Dom block walker. Visit all nodes in pre oder.
 220  */
 221 static void dom_block_visit_pre(ir_node *block, void *env) {
 222         dom_traversal_t *ctx   = env;
 223         block_entry_t   *entry = block_find_entry(block, ctx->blks);
 224
 225         traverse_block_pre(block, entry, ctx->pre, ctx->env);
 226 }
 227
 228 /**
 229  * Dom block walker. Visit all nodes in post oder.
 230  */
 231 static void dom_block_visit_post(ir_node *block, void *env) {
 232         dom_traversal_t *ctx   = env;
 233         block_entry_t   *entry = block_find_entry(block, ctx->blks);
 234
 235         traverse_block_post(block, entry, ctx->post, ctx->env);
 236 }
 237
 238 /**
 239  * Dom block walker. Visit all nodes in pre oder, than in post order.
 240  */
 241 static void dom_block_visit_both(ir_node *block, void *env) {
 242         dom_traversal_t *ctx   = env;
 243         block_entry_t   *entry = block_find_entry(block, ctx->blks);
 244
 245         traverse_block_pre(block, entry, ctx->pre, ctx->env);
 246         traverse_block_post(block, entry, ctx->post, ctx->env);
 247 }
 248
 249 /**
 250  * Do the traversal in the dominator tree in top-down order.
 251  */
 252 static void traverse_dom_blocks_top_down(blk_collect_data_t* blks, irg_walk_func *pre, irg_walk_func *post, void *env) {
 253         dom_traversal_t ctx;
 254
 255         ctx.blks = blks;
 256         ctx.pre  = pre;
 257         ctx.post = post;
 258         ctx.env  = env;
 259
 260         if (pre != NULL && post != NULL)
 261                 dom_tree_walk_irg(current_ir_graph,     dom_block_visit_both, NULL, &ctx);
 262         else if (pre != NULL)
 263                 dom_tree_walk_irg(current_ir_graph,     dom_block_visit_pre, NULL, &ctx);
 264         else if (post != NULL)
 265                 dom_tree_walk_irg(current_ir_graph,     dom_block_visit_post, NULL, &ctx);
 266 }
 267
 268 /**
 269  * walks over the graph and collects all blocks and all block entries
 270  */
 271 static void collect_walk(ir_node *node, blk_collect_data_t *env)
 272 {
 273         int           i, is_phi;
 274         block_entry_t *entry;
 275         ir_node       *block;
 276
 277         mark_irn_visited(node);
 278
 279         if (node->op == op_Block) {
 280                 /* predecessors of a block are control flow nodes */
 281                 for (i = _get_walk_arity(env, node) - 1; i >= 0; --i) {
 282                         ir_node *pred = _get_walk_irn_n(env, node, i);
 283                         ir_node *blk  = get_nodes_block(pred);
 284
 285                         if (!irn_visited(pred)) {
 286                                 collect_walk(pred, env);
 287
 288                                 /* control flow predecessors are always block inputs */
 289                                 entry = block_find_entry(blk, env);
 290                                 ARR_APP1(ir_node *, entry->entry_list, pred);
 291                         }
 292                 }
 293
 294                 /* it's a block, put it into the block list */
 295                 if (node == get_irg_end_block(current_ir_graph)) {
 296                         /* Put the end block always last. If we don't do it here,
 297                          * it might be placed elsewhere if the graph contains
 298                          * endless loops.
 299                          */
 300                 } else {
 301                         ARR_APP1(ir_node *, env->blk_list, node);
 302                 }
 303         }
 304         else {
 305                 block = get_nodes_block(node);
 306
 307                 if (!irn_visited(block))
 308                         collect_walk(block, env);
 309
 310                 is_phi = is_Phi(node);
 311                 for (i = _get_walk_arity(env, node) - 1; i >= 0; --i) {
 312                         ir_node *pred = _get_walk_irn_n(env, node, i);
 313
 314                         if (!irn_visited(pred)) {
 315                                 collect_walk(pred, env);
 316
 317                                 /* BEWARE: predecessors of End nodes might be blocks */
 318                                 if (is_no_Block(pred)) {
 319                                         ir_node *blk  = get_nodes_block(pred);
 320
 321                                         /*
 322                                          * Note that Phi predecessors are always block entries
 323                                          * because Phi edges are always "outside" a block
 324                                          */
 325                                         if (block != blk || is_phi) {
 326                                                 entry = block_find_entry(blk, env);
 327                                                 ARR_APP1(ir_node *, entry->entry_list, pred);
 328                                         }
 329                                 }
 330                         }
 331                 }
 332         }
 333 }
 334
 335 /**
 336  * walks over the nodes of a block
 337  * and collects them into the right list
 338  */
 339 static void collect_blks_lists(ir_node *node, ir_node *block,
 340                                block_entry_t *entry, blk_collect_data_t *env)
 341 {
 342         int i;
 343
 344         mark_irn_visited(node);
 345
 346         /*
 347          * Do not descent into Phi predecessors, these are always
 348          * outside the current block because Phi edges are always
 349          * "outside".
 350          */
 351         if (! is_Phi(node)) {
 352                 for (i = _get_walk_arity(env, node) - 1; i >= 0; --i) {
 353                         ir_node *pred = _get_walk_irn_n(env, node, i);
 354
 355                         /* BEWARE: predecessors of End nodes might be blocks */
 356                         if (is_no_Block(pred)) {
 357                                 ir_node *blk  = get_nodes_block(pred);
 358
 359                                 if (!irn_visited(pred)) {
 360                                         if (block != blk)
 361                                                 continue;
 362                                         collect_blks_lists(pred, block, entry, env);
 363                                 }
 364                         }
 365                 }
 366         } else {
 367                 ARR_APP1(ir_node *, entry->phi_list, node);
 368                 return;
 369         }
 370
 371         if (get_irn_mode(node) == mode_X) {
 372                 ARR_APP1(ir_node *, entry->cf_list, node);
 373         } else {
 374                 ARR_APP1(ir_node *, entry->df_list, node);
 375         }
 376 }
 377
 378 /**
 379  * walk over the graph and collect all lists
 380  */
 381 static void collect_lists(blk_collect_data_t *env)
 382 {
 383         int             i, j;
 384         ir_node         *block, *node;
 385         block_entry_t   *entry;
 386
 387         inc_irg_visited(current_ir_graph);
 388
 389         for (i = ARR_LEN(env->blk_list) - 1; i >= 0; --i) {
 390                 block = env->blk_list[i];
 391                 entry = block_find_entry(block, env);
 392
 393                 for (j = ARR_LEN(entry->entry_list) - 1; j >= 0; --j) {
 394                         node = entry->entry_list[j];
 395
 396                         /* a entry might already be visited due to Phi loops */
 397                         if (node->visited < current_ir_graph->visited)
 398                                 collect_blks_lists(node, block, entry, env);
 399                 }
 400         }
 401 }
 402
 403 /**
 404  * Intraprozedural graph walker over blocks.
 405  */
 406 static void
 407 do_irg_walk_blk(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env, unsigned follow_deps,
 408                 void (*traverse)(blk_collect_data_t* blks, irg_walk_func *pre, irg_walk_func *post, void *env))
 409 {
 410         ir_node            *end_node = get_irg_end(irg);
 411         ir_node            *end_blk = get_irg_end_block(irg);
 412         blk_collect_data_t blks;
 413         block_entry_t      *entry;
 414
 415 #ifdef INTERPROCEDURAL_VIEW
 416         /* switch off interprocedural view */
 417         int old_view       = get_interprocedural_view();
 418         set_interprocedural_view(0);
 419 #endif
 420
 421         obstack_init(&blks.obst);
 422         blks.blk_map     = new_pset(addr_cmp, 1);
 423         blks.blk_list    = NEW_ARR_F(ir_node *, 0);
 424         blks.follow_deps = follow_deps != 0;
 425
 426         /* first step: traverse the graph and fill the lists */
 427         ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
 428         inc_irg_visited(irg);
 429         collect_walk(end_node, &blks);
 430
 431         /* add the end block */
 432         ARR_APP1(ir_node *, blks.blk_list, end_blk);
 433
 434         /* and the end node */
 435         entry = block_find_entry(end_blk, &blks);
 436         ARR_APP1(ir_node *, entry->entry_list, end_node);
 437
 438         collect_lists(&blks);
 439
 440         /* second step: traverse the list */
 441         traverse(&blks, pre, post, env);
 442
 443         DEL_ARR_F(blks.blk_list);
 444         del_pset(blks.blk_map);
 445         obstack_free(&blks.obst, NULL);
 446
 447 #ifdef INTERPROCEDURAL_VIEW
 448         set_interprocedural_view(old_view);
 449 #endif
 450         ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
 451 }
 452
 453 void irg_walk_blkwise_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
 454         ir_graph * rem = current_ir_graph;
 455
 456         hook_irg_walk_blkwise(irg, (generic_func *)pre, (generic_func *)post);
 457         current_ir_graph = irg;
 458         do_irg_walk_blk(irg, pre, post, env, 0, traverse_blocks);
 459         current_ir_graph = rem;
 460 }
 461
 462 void irg_walk_in_or_dep_blkwise_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
 463         ir_graph * rem = current_ir_graph;
 464
 465         hook_irg_walk_blkwise(irg, (generic_func *)pre, (generic_func *)post);
 466         current_ir_graph = irg;
 467         do_irg_walk_blk(irg, pre, post, env, 1, traverse_blocks);
 468         current_ir_graph = rem;
 469 }
 470
 471 void irg_walk_blkwise_dom_top_down(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
 472         ir_graph * rem = current_ir_graph;
 473
 474         hook_irg_walk_blkwise(irg, (generic_func *)pre, (generic_func *)post);
 475         current_ir_graph = irg;
 476         do_irg_walk_blk(irg, pre, post, env, 0, traverse_dom_blocks_top_down);
 477         current_ir_graph = rem;
 478 }