- implemented firm_clear_node_and_phi_links()
[libfirm] / ir / ir / irgmod.c
index 39f255c..d7f9705 100644 (file)
 /*
- * Project:     libFIRM
- * File name:   ir/ir/irgmod.h
- * Purpose:     Support for ir graph modification.
- * Author:      Martin Trapp, Christian Schaefer
- * Modified by: Goetz Lindenmaier
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2003 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
-
-# include "irvrfy.h"
-# include "irflag_t.h"
-# include "irgwalk.h"
-# include "irnode_t.h"
-# include "irgraph_t.h"
-# include "irgmod.h"
-# include "array.h"
-# include "ircons.h"
-# include "firmstat.h"
-
-/* Turns a node into a "useless" Tuple.  The Tuple just forms a tuple
-   from several inputs.
-   This is useful if a node returning a tuple is removed, but the Projs
-   extracting values from the tuple are not available. */
-void
-turn_into_tuple (ir_node *node, int arity)
-{
-  assert(node);
-  set_irn_op(node, op_Tuple);
-  if (get_irn_arity(node) == arity) {
-    /* keep old array */
-  } else {
-    /* Allocate new array, don't free old in_array, it's on the obstack. */
-    ir_node *block = get_nodes_block(node);
-    node->in = NEW_ARR_D (ir_node *, current_ir_graph->obst, arity+1);
-    set_nodes_block(node, block);
-  }
+/**
+ * @file
+ * @brief    Support for ir graph modification.
+ * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier
+ * @version  $Id$
+ */
+#include "config.h"
+
+#include "irvrfy.h"
+#include "irflag_t.h"
+#include "irgwalk.h"
+#include "irnode_t.h"
+#include "irgraph_t.h"
+#include "irgmod.h"
+#include "array.h"
+#include "ircons.h"
+#include "irhooks.h"
+#include "iredges_t.h"
+#include "irtools.h"
+#include "error.h"
+
+/**
+ * Turns a node into a "useless" Tuple.  The Tuple just forms a tuple
+ * from several inputs.
+ * This is useful if a node returning a tuple is removed, but the Projs
+ * extracting values from the tuple are not available.
+ */
+void turn_into_tuple(ir_node *node, int arity) {
+       assert(node);
+       set_irn_op(node, op_Tuple);
+       if (get_irn_arity(node) == arity) {
+               /* keep old array */
+       } else {
+               ir_graph *irg = get_irn_irg(node);
+               ir_node *block = get_nodes_block(node);
+               edges_node_deleted(node, irg);
+               /* Allocate new array, don't free old in_array, it's on the obstack. */
+               node->in = NEW_ARR_D(ir_node *, irg->obst, arity+1);
+               /* clear the new in array, else edge_notify tries to delete garbage */
+               memset(node->in, 0, (arity+1) * sizeof(node->in[0]));
+               /* set the block back */
+               set_nodes_block(node, block);
+       }
 }
 
-/* Insert irnode `new' in place of irnode `old'
-   Since `new' may be bigger than `old' replace `old'
-   by an op_Id which is smaller than everything */
-INLINE void
-exchange (ir_node *old, ir_node *nw)
-{
-  ir_node *block;
-  ir_graph *irg = get_irn_irg (old);
-
-  assert(old != nw);
-  assert (irg);
-  assert(get_irn_op(old)->opar != oparity_dynamic);
-
-  stat_turn_into_id(old);
-
-  block = old->in[0];
-  if (!block) {
-    if (is_Block(nw)) block = nw;
-    else (block = nw->in[0]);
-    if (!block) { DDMN(old); DDMN(nw); assert(0 && "cannot find legal block for id"); }
-  }
-
-  old->op = op_Id;
-  old->in = NEW_ARR_D (ir_node *, irg->obst, 2);
-  old->in[0] = block;
-  old->in[1] = nw;
+/**
+ * Insert irnode `new' in place of irnode `old'
+ * Since `new' may be bigger than `old' replace `old'
+ * by an op_Id which is smaller than everything.
+ */
+void exchange(ir_node *old, ir_node *nw) {
+       ir_graph *irg;
+
+       assert(old && nw);
+       assert(old != nw && "Exchanging node with itself is not allowed");
+
+       irg = get_irn_irg(old);
+       assert(irg == get_irn_irg(nw) && "New node must be in same irg as old node");
+
+       hook_replace(old, nw);
+
+       /*
+        * If new outs are on, we can skip the id node creation and reroute
+        * the edges from the old node to the new directly.
+        */
+       if (edges_activated(irg)) {
+               /* copy all dependencies from old to new */
+               add_irn_deps(nw, old);
+
+               edges_reroute(old, nw, irg);
+               edges_reroute_kind(old, nw, EDGE_KIND_DEP, irg);
+               edges_node_deleted(old, irg);
+               old->op = op_Bad;
+       } else {
+               /* Else, do it the old-fashioned way. */
+               ir_node *block;
+
+               hook_turn_into_id(old);
+
+               block = old->in[0];
+               if (! block) {
+                       block = is_Block(nw) ? nw : get_nodes_block(nw);
+
+                       if (! block) {
+                               panic("cannot find legal block for id");
+                       }
+               }
+
+               if (get_irn_op(old)->opar == oparity_dynamic) {
+                       DEL_ARR_F(get_irn_in(old));
+               }
+
+               old->op    = op_Id;
+               old->in    = NEW_ARR_D (ir_node *, irg->obst, 2);
+               old->in[0] = block;
+               old->in[1] = nw;
+       }
 }
 
 /*--------------------------------------------------------------------*/
 /*  Functionality for collect_phis                                    */
 /*--------------------------------------------------------------------*/
 
-static void
-clear_link (ir_node *n, void *env) {
-  set_irn_link(n, NULL);
-}
-
-static void
-collect (ir_node *n, void *env) {
-  ir_node *pred;
-  if (get_irn_op(n) == op_Phi) {
-    set_irn_link(n, get_irn_link(get_nodes_block(n)));
-    set_irn_link(get_nodes_block(n), n);
-  }
-  if (get_irn_op(n) == op_Proj) {
-    pred = n;
-    while (get_irn_op(pred) == op_Proj)
-      pred = get_Proj_pred(pred);
-    set_irn_link(n, get_irn_link(pred));
-    set_irn_link(pred, n);
-  }
-}
-
-void collect_phiprojs(ir_graph *irg) {
-  ir_graph *rem;
+/**
+ * Walker: links all Phi nodes to their Blocks lists,
+ *         all Proj nodes to there predecessors and all
+ *         partBlocks to there MacroBlock header.
+ */
+static void collect_phiprojs_walker(ir_node *n, void *env) {
+       ir_node *pred;
+       (void) env;
 
-  /* Remember external state of current_ir_graph. */
-  rem = current_ir_graph;
-  current_ir_graph = irg;
+       if (is_Phi(n)) {
+               ir_node *block = get_nodes_block(n);
+               add_Block_phi(block, n);
+       } else if (is_Proj(n)) {
+               pred = n;
+               do {
+                       pred = get_Proj_pred(pred);
+               } while (is_Proj(pred));
 
-  irg_walk(get_irg_end(current_ir_graph), clear_link, collect, NULL);
+               set_irn_link(n, get_irn_link(pred));
+               set_irn_link(pred, n);
+       } else if (is_Block(n)) {
+               ir_node *mbh = get_Block_MacroBlock(n);
 
-  current_ir_graph = rem;
+               if (mbh != n) {
+                       set_irn_link(n, get_irn_link(mbh));
+                       set_irn_link(mbh, n);
+               }
+       }
 }
 
+void collect_phiprojs(ir_graph *irg) {
+       assert((ir_resources_reserved(irg) & (IR_RESOURCE_IRN_LINK|IR_RESOURCE_PHI_LIST)) ==
+               (IR_RESOURCE_IRN_LINK|IR_RESOURCE_PHI_LIST));
+       irg_walk_graph(irg, firm_clear_node_and_phi_links, collect_phiprojs_walker, NULL);
+}
 
 /*--------------------------------------------------------------------*/
 /*  Functionality for part_block                                      */
@@ -117,69 +164,153 @@ void collect_phiprojs(ir_graph *irg) {
  * Moves node and all predecessors of node from from_bl to to_bl.
  * Does not move predecessors of Phi nodes (or block nodes).
  */
-static void move (ir_node *node, ir_node *from_bl, ir_node *to_bl) {
-  int i, arity;
-  ir_node *proj, *pred;
-
-  /* move this node */
-  set_nodes_block(node, to_bl);
-
-  /* move its projs */
-  if (get_irn_mode(node) == mode_T) {
-    proj = get_irn_link(node);
-    while (proj) {
-      if (get_nodes_block(proj) == from_bl)
-       set_nodes_block(proj, to_bl);
-      proj = get_irn_link(proj);
-    }
-  }
-
-  /* recursion ... */
-  if (get_irn_op(node) == op_Phi) return;
-
-  arity = get_irn_arity(node);
-  for (i = 0; i < arity; i++) {
-    pred = get_irn_n(node, i);
-    if (get_nodes_block(pred) == from_bl)
-      move(pred, from_bl, to_bl);
-  }
+static void move(ir_node *node, ir_node *from_bl, ir_node *to_bl) {
+       int i, arity;
+
+       /* move this node */
+       set_nodes_block(node, to_bl);
+
+       /* move its Projs */
+       if (get_irn_mode(node) == mode_T) {
+               ir_node *proj = get_irn_link(node);
+               while (proj) {
+                       if (get_nodes_block(proj) == from_bl)
+                               set_nodes_block(proj, to_bl);
+                       proj = get_irn_link(proj);
+               }
+       }
+
+       /* recursion ... */
+       if (is_Phi(node))
+               return;
+
+       arity = get_irn_arity(node);
+       for (i = 0; i < arity; i++) {
+               ir_node *pred = get_irn_n(node, i);
+               if (get_nodes_block(pred) == from_bl)
+                       move(pred, from_bl, to_bl);
+       }
 }
 
 void part_block(ir_node *node) {
-  ir_node *new_block;
-  ir_node *old_block;
-  ir_node *phi;
-
-  /* Turn off optimizations so that blocks are not merged again. */
-  int rem_opt = get_opt_optimize();
-  set_optimize(0);
-
-  /* Transform the control flow */
-  old_block = get_nodes_block(node);
-  new_block = new_Block(get_Block_n_cfgpreds(old_block),
-            get_Block_cfgpred_arr(old_block));
-  set_irg_current_block(current_ir_graph, new_block);
-  {
-    ir_node *in[1];
-    in[0] = new_Jmp();
-    set_irn_in(old_block, 1, in);
-    irn_vrfy_irg(old_block, current_ir_graph);
-  }
-
-  /* move node and its predecessors to new_block */
-  move(node, old_block, new_block);
-
-  /* move Phi nodes to new_block */
-  phi = get_irn_link(old_block);
-  set_irn_link(new_block, phi);
-  set_irn_link(old_block, NULL);
-  while (phi) {
-    if(get_nodes_block(phi) == old_block);   /* @@@ inlinening chokes on phis that don't
-                           obey this condition.  How do they get into
-                           the list??? Example: InterfaceIII */
-      set_nodes_block(phi, new_block);
-    phi = get_irn_link(phi);
-  }
-
-  set_optimize(rem_opt);
+       ir_node *new_block;
+       ir_node *old_block;
+       ir_node *phi;
+       ir_node *mbh;
+       ir_node *next, *block;
+
+       /* Turn off optimizations so that blocks are not merged again. */
+       int rem_opt = get_opt_optimize();
+       set_optimize(0);
+
+       /* Transform the control flow */
+       old_block = get_nodes_block(node);
+       mbh       = get_Block_MacroBlock(old_block);
+       new_block = new_Block(get_Block_n_cfgpreds(old_block),
+                             get_Block_cfgpred_arr(old_block));
+
+       if (mbh != old_block) {
+               /* we splitting a partBlock */
+               set_Block_MacroBlock(new_block, mbh);
+       } else {
+               /* we are splitting a header: this creates a new header */
+               set_Block_MacroBlock(new_block, new_block);
+       }
+       set_irg_current_block(current_ir_graph, new_block);
+       {
+               ir_node *jmp = new_Jmp();
+               set_irn_in(old_block, 1, &jmp);
+               irn_vrfy_irg(old_block, current_ir_graph);
+       }
+
+       /* move node and its predecessors to new_block */
+       move(node, old_block, new_block);
+
+       /* move Phi nodes to new_block */
+       phi = get_Block_phis(old_block);
+       set_Block_phis(new_block, phi);
+       set_Block_phis(old_block, NULL);
+       while (phi) {
+               set_nodes_block(phi, new_block);
+               phi = get_Phi_next(phi);
+       }
+
+       /* rewire partBlocks */
+       if (mbh != old_block) {
+               ir_node *list = NULL;
+
+               /* move blocks from mbh to old_block if old_block dominates them */
+               block = get_irn_link(mbh);
+
+               set_irn_link(mbh, NULL);
+               set_Block_MacroBlock(old_block, old_block);
+
+               /* note that we must splice the list of partBlock here */
+               for (; block != NULL; block = next) {
+                       ir_node *curr = block;
+                       assert(is_Block(curr));
+
+                       next = get_irn_link(block);
+
+                       if (block == old_block)
+                               continue;
+
+                       assert(get_Block_MacroBlock(curr) == mbh);
+
+                       for (;;) {
+                               if (curr == old_block) {
+                                       /* old_block dominates the block, so old_block will be
+                                          the new macro block header */
+                                       set_Block_MacroBlock(block, old_block);
+                                       set_irn_link(block, list);
+                                       list = block;
+                                       break;
+                               }
+                               if (curr == mbh) {
+                                       /* leave it in the mbh */
+                                       set_irn_link(block, get_irn_link(mbh));
+                                       set_irn_link(mbh, block);
+                                       break;
+                               }
+
+                               assert(get_Block_n_cfgpreds(curr) == 1);
+                               curr = get_Block_cfgpred_block(curr, 0);
+                       }
+               }
+               /* beware: do NOT directly manipulate old_block's list, as old_block is
+                  in mbh's list and this would destroy the list! */
+               set_irn_link(old_block, list);
+
+               /* finally add new_block to mbh's list */
+               set_irn_link(new_block, get_irn_link(mbh));
+               set_irn_link(mbh, new_block);
+       } else {
+               /* move blocks from mbh to new_block */
+               block = get_irn_link(mbh);
+
+               set_irn_link(mbh, NULL);
+               set_irn_link(new_block, NULL);
+
+               for (; block != NULL; block = next) {
+                       next = get_irn_link(block);
+
+                       set_Block_MacroBlock(block, new_block);
+                       set_irn_link(block, get_irn_link(new_block));
+                       set_irn_link(new_block, block);
+               }
+       }
+
+       set_optimize(rem_opt);
+}
+
+/* kill a node by setting its predecessors to Bad and finally exchange the node by Bad itself. */
+void kill_node(ir_node *node) {
+       ir_graph *irg = get_irn_irg(node);
+       ir_node *bad = get_irg_bad(irg);
+       int i;
+
+       for (i = get_irn_arity(node) - 1; i >= -1; --i) {
+               set_irn_n(node, i, bad);
+       }
+       exchange(node, bad);
 }