nsz Git - libfirm/blob - ir/ana/structure.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    Structure Analysis
  23  * @author   Michael Beck
  24  * @date     5.4.2007
  25  * @version  $Id$
  26  */
  27 #include "config.h"
  28
  29 #include "firm_common.h"
  30 #include "irnode_t.h"
  31 #include "structure.h"
  32 #include "irdom.h"
  33 #include "irouts.h"
  34 #include "irtools.h"
  35 #include "irgwalk.h"
  36 #include "array.h"
  37 #include "irdump.h"
  38
  39 #include "debug.h"
  40
  41 typedef union ir_reg_or_blk ir_reg_or_blk;
  42
  43 /* The structure tree. */
  44 struct ir_reg_tree {
  45         struct obstack obst;   /**< The obstack where the data is allocated. */
  46         ir_region *top;        /**< The top region. */
  47         ir_graph *irg;         /**< Associated graph. */
  48 };
  49
  50 /* A region. */
  51 struct ir_region {
  52         firm_kind      kind;      /**< Must be k_ir_region. */
  53         ir_region_kind type;      /**< The type of this region. */
  54         ir_region      *parent;   /**< points to the parent. */
  55         ir_reg_or_blk  *parts;    /**< The list of all region parts. */
  56         ir_region      **pred;    /**< The predecessor (control flow) regions of this region. */
  57         ir_region      **succ;    /**< The successor (control flow) regions of this region. */
  58         unsigned       prenum;    /**< DFS pre-oder number */
  59         unsigned       postnum;   /**< DFS post-oder number */
  60         void           *link;     /**< A link field. */
  61         unsigned long  nr;        /**< for debugging */
  62         unsigned       visited:1; /**< The visited flag. */
  63         unsigned       exit:1;    /**< If set, the parent region can be left by this node. */
  64         unsigned       enter:1;   /**< If set, the parent region can be entered by this node. */
  65 };
  66
  67 /* A helper type for unioning blocks and regions. */
  68 union ir_reg_or_blk {
  69         firm_kind *kind;    /**< For easier check. */
  70         ir_node   *blk;     /**< A node */
  71         ir_region *region;  /**< A region. */
  72 };
  73
  74 /* The debug handle. */
  75 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
  76
  77 /**
  78  * Returns the link of a region.
  79  */
  80 void *get_region_link(const ir_region *reg)
  81 {
  82         return reg->link;
  83 }
  84
  85 /**
  86  * Sets the link of a region.
  87  */
  88 void set_region_link(ir_region *reg, void *data)
  89 {
  90         reg->link = data;
  91 }
  92
  93 /**
  94  * Get the immediate region of a block.
  95  */
  96 ir_region *get_block_region(const ir_node *block)
  97 {
  98         assert(is_Block(block));
  99         return block->attr.block.region;
 100 }
 101
 102 /**
 103  * Sets the immediate region of a block.
 104  */
 105 void set_block_region(ir_node *block, ir_region *reg)
 106 {
 107         assert(is_Block(block));
 108         block->attr.block.region = reg;
 109 }
 110
 111 /**
 112  * Get the immediate region of a node.
 113  */
 114 ir_region *get_irn_region(ir_node *n)
 115 {
 116         if (!is_Block(n))
 117                 n = get_nodes_block(n);
 118         return get_block_region(n);
 119 }
 120
 121 /**
 122  * Return non-zero if a given firm thing is a region.
 123  */
 124 int is_region(const void *thing)
 125 {
 126         const firm_kind *kind = (const firm_kind*) thing;
 127         return *kind == k_ir_region;
 128 }
 129
 130 /**
 131  * Return the number of predecessors of a region.
 132  */
 133 int get_region_n_preds(const ir_region *reg)
 134 {
 135         return ARR_LEN(reg->pred);
 136 }
 137
 138 /**
 139  * Return the predecessor region at position pos.
 140  */
 141 ir_region *get_region_pred(const ir_region *reg, int pos)
 142 {
 143         assert(0 <= pos && pos <= get_region_n_preds(reg));
 144         return reg->pred[pos];
 145 }
 146
 147 /**
 148  * Set the predecessor region at position pos.
 149  */
 150 void set_region_pred(ir_region *reg, int pos, ir_region *n)
 151 {
 152         assert(0 <= pos && pos <= get_region_n_preds(reg));
 153         reg->pred[pos] = n;
 154 }
 155
 156 /**
 157  * Return the number of successors in a region.
 158  */
 159 int get_region_n_succs(const ir_region *reg)
 160 {
 161         return ARR_LEN(reg->succ);
 162 }
 163
 164 /**
 165  * Return the successor region at position pos.
 166  */
 167 ir_region *get_region_succ(const ir_region *reg, int pos)
 168 {
 169         assert(0 <= pos && pos <= get_region_n_succs(reg));
 170         return reg->succ[pos];
 171 }
 172
 173 /**
 174  * Set the successor region at position pos.
 175  */
 176 void set_region_succ(ir_region *reg, int pos, ir_region *n)
 177 {
 178         assert(0 <= pos && pos <= get_region_n_succs(reg));
 179         reg->succ[pos] = n;
 180 }
 181
 182 /* ----------------------- construction -------------------------- */
 183
 184 /** Walker environment. */
 185 typedef struct walk_env {
 186         struct obstack *obst;  /**< An obstack to allocate from. */
 187         ir_region **post;      /**< The list of all currently existent top regions. */
 188         unsigned l_post;       /**< The length of the allocated regions array. */
 189         unsigned premax;       /**< maximum pre counter */
 190         unsigned postmax;      /**< maximum post counter */
 191         ir_node *start_block;  /**< The start block of the graph. */
 192         ir_node *end_block;    /**< The end block of the graph. */
 193 } walk_env;
 194
 195 /**
 196  * Do a DFS search on the initial regions, assign a prenum and a postnum to every
 197  * node and store the region nodes into the post array.
 198  */
 199 static void dfs_walk2(ir_region *reg, walk_env *env)
 200 {
 201         int i, n;
 202
 203         if (reg->visited == 0) {
 204                 reg->visited = 1;
 205
 206                 reg->prenum = env->premax++;
 207                 for (i = 0, n = get_region_n_succs(reg); i < n; ++i) {
 208                         /* recursion */
 209                         ir_region *succ = get_region_succ(reg, i);
 210                         dfs_walk2(succ, env);
 211                 }
 212
 213                 env->post[env->postmax] = reg;
 214                 reg->postnum = env->postmax++;
 215         }
 216 }
 217
 218 /**
 219  * Do a DFS search on the initial regions, assign a prenum and a postnum to every
 220  * node and store the region nodes into the post array.
 221  */
 222 static void dfs_walk(ir_graph *irg, walk_env *env)
 223 {
 224         ir_graph *rem = current_ir_graph;
 225         ir_region *reg;
 226
 227         current_ir_graph = irg;
 228         reg              = (ir_region*) get_irn_link(get_irg_start_block(irg));
 229
 230         env->premax  = 0;
 231         env->postmax = 0;
 232         dfs_walk2(reg, env);
 233         current_ir_graph = rem;
 234 }
 235
 236 /**
 237  * Post-walker: wrap all blocks with a BasicBlock region
 238  * and count them
 239  */
 240 static void wrap_BasicBlocks(ir_node *block, void *ctx)
 241 {
 242         walk_env *env = (walk_env*) ctx;
 243         ir_region *reg;
 244
 245         /* Allocate a Block wrapper */
 246         reg          = OALLOC(env->obst, ir_region);
 247         reg->kind    = k_ir_region;
 248         reg->type    = ir_rk_BasicBlock;
 249         reg->parent  = NULL;
 250         reg->prenum  = 0;
 251         reg->postnum = 0;
 252         reg->visited = 0;
 253         reg->exit    = 0;
 254         reg->enter   = 0;
 255         reg->link    = NULL;
 256         reg->nr      = get_irn_node_nr(block);
 257         reg->parts   = NEW_ARR_D(ir_reg_or_blk, env->obst, 1);
 258
 259         reg->parts[0].blk = block;
 260         set_irn_link(block, reg);
 261
 262         ++env->l_post;
 263 }  /* wrap_BasicBlocks */
 264
 265 /**
 266  * Post-walker: Create the pred and succ edges for Block wrapper.
 267  * Kill edges to the Start and End blocks.
 268  */
 269 static void update_BasicBlock_regions(ir_node *blk, void *ctx)
 270 {
 271         walk_env *env = (walk_env*) ctx;
 272         ir_region *reg = (ir_region*) get_irn_link(blk);
 273         int i, j, len;
 274
 275         if (blk == env->start_block) {
 276                 /* handle Firm's self loop: Start block has no predecessors */
 277                 reg->pred = NEW_ARR_D(ir_region *, env->obst, 0);
 278         } else {
 279                 len = get_Block_n_cfgpreds(blk);
 280                 reg->pred = NEW_ARR_D(ir_region *, env->obst, len);
 281                 for (i = j = 0; i < len; ++i) {
 282                         ir_node *pred = get_Block_cfgpred_block(blk, i);
 283                         reg->pred[j++] = (ir_region*) get_irn_link(pred);
 284                 }
 285                 ARR_SHRINKLEN(reg->pred, j);
 286         }
 287
 288         len = get_Block_n_cfg_outs(blk);
 289         reg->succ = NEW_ARR_D(ir_region *, env->obst, len);
 290         for (i = j = 0; i < len; ++i) {
 291                 ir_node *succ = get_Block_cfg_out(blk, i);
 292                 reg->succ[j++] = (ir_region*) get_irn_link(succ);
 293         }
 294         ARR_SHRINKLEN(reg->succ, j);
 295 }  /* update_BasicBlock_regions */
 296
 297 /** Allocate a new region on an obstack */
 298 #define ALLOC_REG(obst, reg, tp) \
 299         do { \
 300                 (reg)          = OALLOC((obst), ir_region); \
 301                 (reg)->kind    = k_ir_region; \
 302                 (reg)->type    = tp; \
 303                 (reg)->parent  = NULL; \
 304                 (reg)->prenum  = 0; \
 305                 (reg)->postnum = 0; \
 306                 (reg)->visited = 0; \
 307                 (reg)->exit    = 0; \
 308                 (reg)->enter   = 0; \
 309                 (reg)->link    = NULL; \
 310         } while (0)
 311
 312 /**
 313  * Creates a new Sequence region.
 314  */
 315 static ir_region *new_Sequence(struct obstack *obst, ir_region *nset, int nset_len)
 316 {
 317         ir_region *reg, *next;
 318         int i;
 319
 320         ALLOC_REG(obst, reg, ir_rk_Sequence);
 321
 322         reg->parts = NEW_ARR_D(ir_reg_or_blk, obst, nset_len);
 323
 324         /* beware: list is in reverse order, reverse */
 325         next = nset;
 326         for (i = nset_len - 1; i >= 0; --i) {
 327                 nset = next;
 328                 reg->parts[i].region = nset;
 329                 nset->parent = reg;
 330                 next = (ir_region*) nset->link;
 331                 nset->link = NULL;
 332         }
 333
 334         reg->nr   = reg->parts[0].region->nr;
 335         reg->pred = DUP_ARR_D(ir_region *, obst, reg->parts[0].region->pred);
 336         reg->succ = DUP_ARR_D(ir_region *, obst, reg->parts[nset_len - 1].region->succ);
 337
 338         DEBUG_ONLY(
 339                 DB((dbg, LEVEL_2, " Created Sequence "));
 340                 for (i = 0; i < nset_len; ++i) {
 341                         DB((dbg, LEVEL_2, "(%u)", reg->parts[i].region->nr));
 342                 }
 343                 DB((dbg, LEVEL_2, "\n"));
 344         )
 345         return reg;
 346 }  /* new_Sequence */
 347
 348 /**
 349  * Create a new IfThenElse region.
 350  */
 351 static ir_region *new_IfThenElse(struct obstack *obst, ir_region *if_b, ir_region *then_b, ir_region *else_b)
 352 {
 353         ir_region *reg;
 354
 355         ALLOC_REG(obst, reg, ir_rk_IfThenElse);
 356
 357         reg->nr    = if_b->nr;
 358         reg->parts = NEW_ARR_D(ir_reg_or_blk, obst, 3);
 359
 360         reg->parts[0].region = if_b;   if_b->parent   = reg;
 361         reg->parts[1].region = then_b; then_b->parent = reg;
 362         reg->parts[2].region = else_b; else_b->parent = reg;
 363
 364         reg->pred = DUP_ARR_D(ir_region *, obst, if_b->pred);
 365         reg->succ = DUP_ARR_D(ir_region *, obst, then_b->succ);
 366
 367         DB((dbg, LEVEL_2, " Created If(%u)Then(%u)Else(%u)\n", reg->nr, then_b->nr, else_b->nr));
 368
 369         return reg;
 370 }  /* new_IfThenElse */
 371
 372 /**
 373  * Create a new IfThen region.
 374  */
 375 static ir_region *new_IfThen(struct obstack *obst, ir_region *if_b, ir_region *then_b)
 376 {
 377         ir_region *reg;
 378
 379         ALLOC_REG(obst, reg, ir_rk_IfThen);
 380
 381         reg->nr    = if_b->nr;
 382         reg->parts = NEW_ARR_D(ir_reg_or_blk, obst, 2);
 383
 384         reg->parts[0].region = if_b;   if_b->parent   = reg;
 385         reg->parts[1].region = then_b; then_b->parent = reg;
 386
 387         reg->pred = DUP_ARR_D(ir_region *, obst, if_b->pred);
 388         reg->succ = DUP_ARR_D(ir_region *, obst, then_b->succ);
 389
 390         DB((dbg, LEVEL_2, " Created If(%u)Then(%u)\n", reg->nr, then_b->nr));
 391
 392         return reg;
 393 }  /* new_IfThenElse */
 394
 395 /**
 396  * Create a new Switch/case region.
 397  */
 398 static ir_region *new_SwitchCase(struct obstack *obst, ir_region_kind type, ir_region *head, ir_region *exit,
 399                                  ir_region *cases, int cases_len)
 400 {
 401         ir_region *reg, *c, *n;
 402         int i;
 403         int add = 1;
 404
 405         /* check, if the exit block is in the list */
 406         for (c = cases; c != NULL; c = (ir_region*) c->link) {
 407                 if (c == exit) {
 408                         add = 0;
 409                         break;
 410                 }
 411         }
 412
 413         ALLOC_REG(obst, reg, type);
 414
 415         reg->nr    = head->nr;
 416         reg->parts = NEW_ARR_D(ir_reg_or_blk, obst, cases_len + add);
 417
 418         reg->parts[0].region = head; head->parent = reg;
 419         i = 1;
 420         for (c = cases; c != NULL; c = n) {
 421                 n = (ir_region*) c->link;
 422                 if (c != exit) {
 423                         reg->parts[i++].region = c;
 424                         c->parent = reg;
 425                 }
 426                 c->link = NULL;
 427         }
 428
 429         reg->pred = DUP_ARR_D(ir_region *, obst, head->pred);
 430         reg->succ = NEW_ARR_D(ir_region *, obst, 1);
 431         reg->succ[0] = exit;
 432
 433         DEBUG_ONLY({
 434                 size_t i;
 435                 DB((dbg, LEVEL_2, " Created %s(%u)\n", reg->type == ir_rk_Switch ? "Switch" : "Case", reg->nr));
 436                 for (i = 1; i < ARR_LEN(reg->parts); ++i) {
 437                         DB((dbg, LEVEL_2, "  Case(%u)\n", reg->parts[i].region->nr));
 438                 }
 439                 DB((dbg, LEVEL_2, "  Exit(%u)\n", exit->nr));
 440         })
 441         return reg;
 442 }  /* new_SwitchCase */
 443
 444 /**
 445  * Create a new SelfLoop region.
 446  */
 447 static ir_region *new_SelfLoop(struct obstack *obst, ir_region *head)
 448 {
 449         ir_region *reg, *succ;
 450         int i, j, len;
 451
 452         ALLOC_REG(obst, reg, ir_rk_SelfLoop);
 453
 454         reg->nr      = head->nr;
 455         reg->parts   = NEW_ARR_D(ir_reg_or_blk, obst, 1);
 456
 457         reg->parts[0].region = head; head->parent = reg;
 458
 459         len = ARR_LEN(head->pred);
 460         reg->pred = NEW_ARR_D(ir_region *, obst, len - 1);
 461         for (i = j = 0; i < len; ++i) {
 462                 ir_region *pred = get_region_pred(head, i);
 463                 if (pred != head)
 464                         reg->pred[j++] = pred;
 465         }
 466         assert(j == len - 1);
 467
 468         reg->succ = NEW_ARR_D(ir_region *, obst, 1);
 469         assert(ARR_LEN(head->succ) == 2);
 470
 471         succ = get_region_succ(head, 0);
 472         if (succ != head)
 473                 reg->succ[0] = succ;
 474         else
 475                 reg->succ[0] = get_region_succ(head, 1);
 476
 477         DB((dbg, LEVEL_2, " Created SelfLoop(%u)\n", reg->nr));
 478
 479         return reg;
 480 }  /* new_SelfLoop */
 481
 482 /**
 483  * Create a new RepeatLoop region.
 484  */
 485 static ir_region *new_RepeatLoop(struct obstack *obst, ir_region *head, ir_region *body)
 486 {
 487         ir_region *reg, *succ;
 488
 489         ALLOC_REG(obst, reg, ir_rk_RepeatLoop);
 490
 491         reg->nr      = head->nr;
 492         reg->parts   = NEW_ARR_D(ir_reg_or_blk, obst, 2);
 493
 494         reg->parts[0].region = head; head->parent = reg;
 495         reg->parts[1].region = body; body->parent = reg;
 496
 497         reg->pred = DUP_ARR_D(ir_region *, obst, head->pred);
 498         reg->succ = NEW_ARR_D(ir_region *, obst, 1);
 499         assert(ARR_LEN(body->succ) == 2);
 500
 501         succ = get_region_succ(body, 0);
 502         if (succ != head)
 503                 reg->succ[0] = succ;
 504         else
 505                 reg->succ[0] = get_region_succ(body, 1);
 506
 507         DB((dbg, LEVEL_2, " Created RepeatLoop(%u)Body(%u)\n", reg->nr, body->nr));
 508
 509         return reg;
 510 }  /* new_RepeatLoop */
 511
 512 /**
 513  * Create a new WhileLoop region.
 514  */
 515 static ir_region *new_WhileLoop(struct obstack *obst, ir_region *head)
 516 {
 517         ir_region *reg, *succ;
 518         ir_region *body = (ir_region*) head->link;
 519         int i, j, len;
 520
 521         head->link = NULL;
 522
 523         ALLOC_REG(obst, reg, ir_rk_WhileLoop);
 524
 525         reg->nr      = head->nr;
 526         reg->parts   = NEW_ARR_D(ir_reg_or_blk, obst, 2);
 527
 528         reg->parts[0].region = head; head->parent = reg;
 529         reg->parts[1].region = body; body->parent = reg;
 530
 531         len = ARR_LEN(head->pred);
 532         reg->pred = NEW_ARR_D(ir_region *, obst, len - 1);
 533         for (i = j = 0; i < len; ++i) {
 534                 ir_region *pred = get_region_pred(head, i);
 535                 if (pred != body)
 536                         reg->pred[j++] = pred;
 537         }
 538         assert(j == len - 1);
 539
 540         reg->succ = NEW_ARR_D(ir_region *, obst, 1);
 541         assert(ARR_LEN(head->succ) == 2);
 542
 543         succ = get_region_succ(head, 0);
 544         if (succ != body)
 545                 reg->succ[0] = succ;
 546         else
 547                 reg->succ[0] = get_region_succ(head, 1);
 548
 549         DB((dbg, LEVEL_2, " Created WhileLoop(%u)Body(%u)\n", reg->nr, body->nr));
 550
 551         return reg;
 552 }  /* new_WhileLoop */
 553
 554 /**
 555  * Create a new new_NaturalLoop region.
 556  */
 557 static ir_region *new_NaturalLoop(struct obstack *obst, ir_region *head)
 558 {
 559         ir_region *reg, *c, *n;
 560         int i, j, k, len, n_pred, n_succ;
 561
 562         /* count number of parts */
 563         for (len = 0, c = head; c != NULL; c = (ir_region*) c->link)
 564                 ++len;
 565
 566         ALLOC_REG(obst, reg, ir_rk_WhileLoop);
 567
 568         reg->nr      = head->nr;
 569         reg->parts   = NEW_ARR_D(ir_reg_or_blk, obst, len);
 570
 571         /* enter all parts */
 572         for (i = 0, c = head; c != NULL; c = n) {
 573                 reg->parts[i++].region = c;
 574                 c->parent = reg;
 575                 n = (ir_region*) c->link;
 576                 c->link = NULL;
 577         }
 578
 579         /* count number of preds */
 580         n_pred = 0;
 581         for (i = get_region_n_preds(head) - 1; i >= 0; --i) {
 582                 ir_region *pred = get_region_pred(head, i);
 583                 if (pred->parent != reg)
 584                         ++n_pred;
 585         }
 586         reg->pred = NEW_ARR_D(ir_region *, obst, n_pred);
 587         for (j = 0, i = get_region_n_preds(head) - 1; i >= 0; --i) {
 588                 ir_region *pred = get_region_pred(head, i);
 589                 if (pred->parent != reg)
 590                         reg->pred[j++] = pred;
 591         }
 592
 593         /* count number of succs */
 594         n_succ = 0;
 595         for (j = 0; j < len; ++j) {
 596                 ir_region *pc = reg->parts[j].region;
 597                 for (i = get_region_n_succs(pc) - 1; i >= 0; --i) {
 598                         ir_region *succ = get_region_succ(pc, i);
 599                         if (succ->parent != reg)
 600                                 ++n_succ;
 601                 }
 602         }
 603         reg->succ = NEW_ARR_D(ir_region *, obst, n_succ);
 604         k = 0;
 605         for (j = 0; j < len; ++j) {
 606                 ir_region *pc = reg->parts[j].region;
 607                 for (i = get_region_n_succs(pc) - 1; i >= 0; --i) {
 608                         ir_region *succ = get_region_succ(pc, i);
 609                         if (succ->parent != reg)
 610                                 reg->succ[k++] = succ;
 611                 }
 612         }
 613
 614         DEBUG_ONLY(
 615                 DB((dbg, LEVEL_2, " Created NaturalLoop(%u)Head(%u)\n", reg->nr, head->nr));
 616                 for (i = 1; i < len; ++i) {
 617                         ir_region *p = reg->parts[i].region;
 618                         DB((dbg, LEVEL_2, "  Body(%u)\n", p->nr));
 619                 }
 620         )
 621         return reg;
 622 }  /* new_NaturalLoop */
 623
 624 /**
 625  * Return true if region a is an ancestor of region b in DFS search.
 626  */
 627 static int is_ancestor(const ir_region *a, const ir_region *b)
 628 {
 629         return (a->prenum <= b->prenum && a->postnum > b->postnum);
 630 }
 631
 632 /**
 633  * Return true if region pred is a predecessor of region n.
 634  */
 635 static int pred_of(const ir_region *pred, const ir_region *n)
 636 {
 637         int i;
 638         for (i = get_region_n_preds(n) - 1; i >= 0; --i) {
 639                 if (get_region_pred(n, i) == pred)
 640                         return 1;
 641         }
 642         return 0;
 643 }
 644
 645 /**
 646  * Return true if region succ is a successor of region n.
 647  */
 648 static int succ_of(const ir_region *succ, const ir_region *n)
 649 {
 650         int i;
 651         for (i = get_region_n_succs(n) - 1; i >= 0; --i) {
 652                 if (get_region_succ(n, i) == succ)
 653                         return 1;
 654         }
 655         return 0;
 656 }
 657
 658 /**
 659  * Reverse a linked list of regions.
 660  */
 661 static struct ir_region *reverse_list(ir_region *n)
 662 {
 663         ir_region *prev = NULL, *next;
 664
 665         for (; n; n = next) {
 666                 next = (ir_region*) n->link;
 667                 n->link = prev;
 668                 prev = n;
 669         }
 670         return prev;
 671 }
 672
 673 /**
 674  * Find the cyclic region in the subgraph entered by node.
 675  */
 676 static ir_region *find_cyclic_region(ir_region *node)
 677 {
 678         int i;
 679         ir_region *last = node;
 680         int improper = 0;
 681
 682         for (i = get_region_n_preds(node) - 1; i >= 0; --i) {
 683                 ir_region *pred = get_region_pred(node, i);
 684
 685                 /* search backedges */
 686                 if (!pred->link && pred != last && is_ancestor(node, pred)) {
 687                         ir_region *rem = last;
 688                         int j;
 689
 690                         last->link = pred;
 691                         last       = pred;
 692                         for (j = get_region_n_preds(pred) - 1; j >= 0; --j) {
 693                                 ir_region *p = get_region_pred(pred, j);
 694
 695                                 /* Search regions we didn't visited yet and
 696                                    link them into the list. */
 697                                 if (!p->link && p != last) {
 698                                         if (is_ancestor(node, p)) {
 699                                                 last->link = p;
 700                                                 last       = p;
 701                                         } else {
 702                                                 improper = 1;
 703                                         }
 704                                 }
 705                         }
 706                         /* reverse the list. */
 707                         last = (ir_region*) rem->link;
 708                         rem->link = reverse_list((ir_region*) rem->link);
 709                 }
 710         }
 711
 712         if (node->link && improper) {
 713                 /* found an improper region, do minimization */
 714
 715         }
 716         return node;
 717 }
 718
 719 #define LINK(list) ((ir_region *)list->link)
 720
 721 /**
 722  * Detect a cyclic region.
 723  */
 724 static ir_region *cyclic_region_type(struct obstack *obst, ir_region *node)
 725 {
 726         ir_region *list;
 727
 728         /* simple cases first */
 729         if (succ_of(node, node)) {
 730                 return new_SelfLoop(obst, node);
 731         }
 732         if (get_region_n_succs(node) == 1) {
 733                 ir_region *succ = get_region_succ(node, 0);
 734                 if (get_region_n_preds(succ) == 1 && succ_of(node, succ)) {
 735                         return new_RepeatLoop(obst, node, succ);
 736                 }
 737         }
 738         list = find_cyclic_region(node);
 739
 740         if (list->link) {
 741                 if (!LINK(list)->link && get_region_n_succs((ir_region*) list->link) == 1) {
 742                         /* only one body block with only one successor (the head) */
 743                         return new_WhileLoop(obst, list);
 744                 }
 745                 /* A Loop with one head */
 746                 return new_NaturalLoop(obst, list);
 747         }
 748
 749         return NULL;
 750 }
 751
 752 /**
 753  * Clear all links on a list. Needed, because we expect cleared links.
 754  */
 755 static void clear_list(ir_region *list)
 756 {
 757         ir_region *next;
 758
 759         for (next = list; next; list = next) {
 760                 next = (ir_region*) list->link;
 761                 list->link = NULL;
 762         }
 763 }
 764
 765 #define ADD_LIST(list, n) do { n->link = list; list = n; ++list##_len; } while (0)
 766
 767 /**
 768  * Detect an acyclic region.
 769  */
 770 static ir_region *acyclic_region_type(struct obstack *obst, ir_region *node)
 771 {
 772         ir_region *n, *m;
 773         int p, s, i, k;
 774         ir_region *nset = NULL;
 775         int nset_len = 0;
 776         ir_region *res;
 777
 778         /* check for a block containing node */
 779         n = node;
 780         p = get_region_n_preds(n) == 1;
 781         s = 1;
 782         while (p & s) {
 783                 n = get_region_pred(n, 0);
 784                 p = get_region_n_preds(n) == 1;
 785                 s = get_region_n_succs(n) == 1;
 786         }
 787         p = 1;
 788         s = get_region_n_succs(n) == 1;
 789         while (p & s) {
 790                 ADD_LIST(nset, n);
 791                 n = get_region_succ(n, 0);
 792                 p = get_region_n_preds(n) == 1;
 793                 s = get_region_n_succs(n) == 1;
 794         }
 795         if (p) {
 796                 ADD_LIST(nset, n);
 797         }
 798         if (nset_len > 1) {
 799                 /* node --> .. --> .. */
 800                 res = new_Sequence(obst, nset, nset_len);
 801                 return res;
 802         }
 803         node = n;
 804
 805         /* check for IfThenElse */
 806         k = get_region_n_succs(node);
 807         if (k == 2) {
 808                 int n_succs, m_succs, n_preds, m_preds;
 809
 810                 n = get_region_succ(node, 0);
 811                 m = get_region_succ(node, 1);
 812
 813                 n_succs = get_region_n_succs(n);
 814                 m_succs = get_region_n_succs(m);
 815                 n_preds = get_region_n_preds(n);
 816                 m_preds = get_region_n_preds(m);
 817                 if (n_succs == 1 && n_succs == m_succs && n_preds == m_preds &&
 818                     get_region_succ(n, 0) == get_region_succ(m, 0)) {
 819                         /*
 820                          *    /-->n---\
 821                          * node      ...
 822                          *    \-->m---/
 823                          */
 824                         return new_IfThenElse(obst, node, n, m);
 825                 }
 826                 if (n_succs == 1 &&
 827                     get_region_succ(n, 0) == m &&
 828                     pred_of(node, m)) {
 829                         /*
 830                          * node -->n-->m
 831                          *    \-------/
 832                          */
 833                         return new_IfThen(obst, node, n);
 834                 }
 835                 if (m_succs == 1 &&
 836                     get_region_succ(m, 0) == m &&
 837                     pred_of(node, n)) {
 838                         /*
 839                          * node -->m-->n
 840                          *    \-------/
 841                          */
 842                         return new_IfThen(obst, node, m);
 843                 }
 844         }
 845         /* check for Switch, case */
 846         if (k > 0) {
 847                 ir_region *rexit = NULL;
 848                 nset = NULL; nset_len = 0;
 849                 p = 0;
 850                 for (i = k - 1; i >= 0; --i) {
 851                         n = get_region_succ(node, i);
 852                         ADD_LIST(nset, n);
 853                         if (get_region_n_succs(n) != 1) {
 854                                 /* must be the exit */
 855                                 rexit = n;
 856                                 ++p;
 857                                 if (p > 1)
 858                                         break;
 859                         }
 860                 }
 861                 if (p <= 1) {
 862                         ir_region_kind kind = ir_rk_Case;
 863                         ir_region *pos_exit_1 = NULL;
 864                         ir_region *pos_exit_2 = NULL;
 865
 866                         /* find the exit */
 867                         for (m = (ir_region*) nset; m != NULL; m = (ir_region*) m->link) {
 868                                 if (get_region_n_succs(m) != 1) {
 869                                         /* must be the exit block */
 870                                         if (rexit == NULL) {
 871                                                 rexit = m;
 872                                         } else if (rexit != m) {
 873                                                 /* two exits */
 874                                                 rexit = NULL;
 875                                                 break;
 876                                         }
 877                                 } else {
 878                                         ir_region *succ = get_region_succ(m, 0);
 879
 880                                         if (succ->link == NULL) {
 881                                                 if (rexit == NULL) {
 882                                                         if (succ == pos_exit_1)
 883                                                                 rexit = succ;
 884                                                         else if (succ == pos_exit_2)
 885                                                                 rexit = succ;
 886                                                         else if (pos_exit_1 == NULL)
 887                                                                 pos_exit_1 = succ;
 888                                                         else if (pos_exit_2 == NULL)
 889                                                                 pos_exit_2 = succ;
 890                                                         else {
 891                                                                 /* more than two possible exits */
 892                                                                 break;
 893                                                         }
 894                                                 } else if (rexit != succ) {
 895                                                         /* two exits */
 896                                                         rexit = NULL;
 897                                                         break;
 898                                                 }
 899                                         }
 900                                 }
 901                         }
 902                         if (rexit != NULL) {
 903                                 /* do the checks */
 904                                 for (n = (ir_region*) nset; n != NULL; n = (ir_region*) n->link) {
 905                                         ir_region *succ;
 906                                         if (n == rexit) {
 907                                                 /* good, default fall through */
 908                                                 continue;
 909                                         }
 910                                         succ = get_region_succ(n, 0);
 911                                         if (succ == rexit) {
 912                                                 /* good, switch to exit */
 913                                                 continue;
 914                                         }
 915                                         if (succ->link == NULL) {
 916                                                 /* another exit */
 917                                                 break;
 918                                         } else {
 919                                                 /* a fall through */
 920                                                 kind = ir_rk_Switch;
 921                                         }
 922                                 }
 923
 924                                 if (n == NULL) {
 925                                         /* detected */
 926                                         return new_SwitchCase(obst, kind, node, rexit, nset, nset_len);
 927                                 }
 928                         }
 929                 }
 930                 clear_list(nset);
 931         }
 932         return NULL;
 933 }
 934
 935 /**
 936  * replace all pred edges from region pred that points to any of the set set
 937  * to ONE edge to reg.
 938  */
 939 static void replace_pred(ir_region *succ, ir_region *reg)
 940 {
 941         int i, len = get_region_n_preds(succ);
 942         int have_one = 0;
 943
 944         for (i = 0; i < len; ++i) {
 945                 ir_region *pred = get_region_pred(succ, i);
 946
 947                 if (pred->parent == reg) {
 948                         ir_region *r;
 949
 950                         if (have_one) {
 951                                 /* kill it */
 952                                 r = get_region_pred(succ, --len);
 953                         } else {
 954                                 /* replace it */
 955                                 have_one = 1;
 956                                 r = reg;
 957                         }
 958                         set_region_pred(succ, i, r);
 959                 } else {
 960                         /* the current region can be entered by this node */
 961                         pred->enter = 1;
 962                 }
 963         }
 964         ARR_SHRINKLEN(succ->pred, len);
 965 }
 966
 967 /**
 968  * replace all succ edges from region pred that points to any of the set set
 969  * to ONE edge to reg.
 970  */
 971 static void replace_succ(ir_region *pred, ir_region *reg)
 972 {
 973         int i, len = get_region_n_succs(pred);
 974         int have_one = 0;
 975
 976         for (i = 0; i < len; ++i) {
 977                 ir_region *succ = get_region_succ(pred, i);
 978
 979                 if (succ->parent == reg) {
 980                         ir_region *r;
 981
 982                         if (have_one) {
 983                                 /* kill it */
 984                                 r = get_region_succ(pred, --len);
 985                         } else {
 986                                 /* replace it */
 987                                 have_one = 1;
 988                                 r = reg;
 989                         }
 990                         set_region_succ(pred, i, r);
 991                 } else {
 992                         /* current region can be left by this node */
 993                         succ->exit = 1;
 994                 }
 995         }
 996         ARR_SHRINKLEN(pred->succ, len);
 997 }
 998
 999 /**
1000  * Reduce the graph by the node reg.
1001  */
1002 static void reduce(walk_env *env, ir_region *reg)
1003 {
1004         int i;
1005         ir_region *head = reg->parts[0].region;
1006         unsigned maxorder = head->postnum;
1007         unsigned minorder = head->prenum;
1008
1009         /* second step: replace all preds in successors */
1010         for (i = get_region_n_succs(reg) - 1; i >= 0; --i) {
1011                 ir_region *succ = get_region_succ(reg, i);
1012
1013                 replace_pred(succ, reg);
1014         }
1015
1016         /* third step: replace all succs in predessors */
1017         for (i = get_region_n_preds(reg) - 1; i >= 0; --i) {
1018                 ir_region *pred = get_region_pred(reg, i);
1019
1020                 replace_succ(pred, reg);
1021         }
1022
1023         reg->prenum  = minorder;
1024         reg->postnum = maxorder;
1025         env->post[maxorder] = reg;
1026 }
1027
1028 /**
1029  * Construct the region tree of a graph by doing
1030  * structural analysis.
1031  *
1032  * Uses link fields of nodes.
1033  *
1034  * @param irg  the graph
1035  */
1036 ir_reg_tree *construct_region_tree(ir_graph *irg)
1037 {
1038         walk_env env;
1039         ir_graph *rem = current_ir_graph;
1040         ir_reg_tree *res = XMALLOC(ir_reg_tree);
1041
1042         obstack_init(&res->obst);
1043
1044         current_ir_graph = irg;
1045
1046         FIRM_DBG_REGISTER(dbg, "firm.ana.structure");
1047         firm_dbg_set_mask(dbg, SET_LEVEL_5);
1048
1049         DB((dbg, LEVEL_1, "Structural analysis on %+F starts...\n", irg));
1050
1051         /* we need dominance info */
1052         assure_doms(irg);
1053         /* and out edges */
1054         assure_irg_outs(irg);
1055
1056         env.start_block = get_irg_start_block(irg);
1057         env.end_block   = get_irg_end_block(irg);
1058
1059         /* create the Block wrapper and count them */
1060         env.l_post = 0;
1061         env.obst   = &res->obst;
1062         irg_block_walk_graph(irg, NULL, wrap_BasicBlocks, &env);
1063         irg_block_walk_graph(irg, NULL, update_BasicBlock_regions, &env);
1064
1065         env.post = NEW_ARR_F(ir_region *, env.l_post);
1066
1067         /* do the DFS walk */
1068         dfs_walk(irg, &env);
1069
1070         DB((dbg, LEVEL_1, "%d regions left\n", env.postmax));
1071         if (env.postmax > 1) {
1072                 unsigned postctr = 0;
1073                 do {
1074                         ir_region *reg, *n = env.post[postctr];
1075                         do {
1076                                 if (n->parent != NULL) {
1077                                         /* already folded */
1078                                         break;
1079                                 }
1080                                 /* locate an acyclic region if present */
1081                                 reg = acyclic_region_type(env.obst, n);
1082                                 if (reg == NULL) {
1083                                         /* locate a cyclic region */
1084                                         reg = cyclic_region_type(env.obst, n);
1085                                 }
1086                                 if (reg != NULL) {
1087                                         /* found a new region */
1088                                         reduce(&env, reg);
1089                                         n = reg;
1090                                 }
1091                         } while (reg != NULL);
1092                         ++postctr;
1093                 } while (postctr < env.postmax);
1094         }
1095         DB((dbg, LEVEL_1, "Structural analysis finished.\n"));
1096
1097         DEL_ARR_F(env.post);
1098         current_ir_graph = rem;
1099
1100         res->top = env.post[0];
1101         res->irg = irg;
1102         return res;
1103 }
1104
1105 /**
1106  * Walk over the region tree.
1107  *
1108  * @param reg   a region node
1109  * @param pre   walker function, executed before the children of a tree node are visited
1110  * @param post  walker function, executed after the children of a tree node are visited
1111  * @param env   environment, passed to pre and post
1112  */
1113 static void region_tree_walk2(ir_region *reg, irg_reg_walk_func *pre, irg_reg_walk_func *post, void *env)
1114 {
1115         int i, n;
1116
1117         if (pre)
1118                 pre(reg, env);
1119         if (reg->type != ir_rk_BasicBlock) {
1120                 for (i = 0, n = ARR_LEN(reg->parts); i < n; ++i)
1121                         region_tree_walk2(reg->parts[i].region, pre, post, env);
1122         }
1123         if (post)
1124                 post(reg, env);
1125 }
1126
1127 /**
1128  * Walk over the region tree.
1129  *
1130  * @param tree  the tree
1131  * @param pre   walker function, executed before the children of a tree node are visited
1132  * @param post  walker function, executed after the children of a tree node are visited
1133  * @param env   environment, passed to pre and post
1134  */
1135 void region_tree_walk(ir_reg_tree *tree, irg_reg_walk_func *pre, irg_reg_walk_func *post, void *env)
1136 {
1137         region_tree_walk2(tree->top, pre, post, env);
1138 }