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