remove opt_manage, provide assure_irg_properties
[libfirm] / ir / ana / irouts.c
index b99169a..c95fd43 100644 (file)
-/* Copyright (C) 2002 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors:  Goetz Lindenmaier
-**
-** irouts.c --- Compute out edges for ir nodes (also called def-use
-** edges).
-**
-*/
-
-/* $Id$ */
-
+/*
+ * Copyright (C) 1995-2011 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.
+ */
+
+/**
+ * @file
+ * @brief    Compute and access out edges (also called def-use edges).
+ * @author   Goetz Lindenmaier, Michael Beck
+ * @date     1.2002
+ */
+#include "config.h"
+
+#include <string.h>
+
+#include "xmalloc.h"
 #include "irouts.h"
 #include "irnode_t.h"
-#include "irgraph_t.h"     /* To access irg->outs field (which is private to this module)
-                             without public access routine */
-
-/**********************************************************************/
+#include "irgraph_t.h"
+#include "irprog_t.h"
+#include "irgwalk.h"
+#include "util.h"
+#include "irprintf.h"
+#include "error.h"
+#include "ircons.h"
+
+/*--------------------------------------------------------------------*/
 /** Accessing the out datastructures                                 **/
-/**********************************************************************/
+/*--------------------------------------------------------------------*/
+
+#ifdef DEBUG_libfirm
+/** Clear the outs of a node */
+static void reset_outs(ir_node *node, void *unused)
+{
+       (void) unused;
+       node->out       = NULL;
+       node->out_valid = 0;
+}
+#endif
+
+int get_irn_outs_computed(const ir_node *node)
+{
+       return node->out != NULL;
+}
+
+int get_irn_n_outs(const ir_node *node)
+{
+       assert(node && node->kind == k_ir_node);
+#ifdef DEBUG_libfirm
+       assert(node->out_valid);
+#endif /* defined DEBUG_libfirm */
+       /* we misuse the first for the size info of the out array */
+       return node->out[0].pos;
+}
+
+ir_node *get_irn_out(const ir_node *def, int pos)
+{
+       assert(pos >= 0 && pos < get_irn_n_outs(def));
+#ifdef DEBUG_libfirm
+       assert(def->out_valid);
+#endif /* defined DEBUG_libfirm */
+       return def->out[pos+1].use;
+}
 
-/* returns the number of successors of the node: */
-inline int              get_irn_n_outs    (ir_node *node) {
-  return (int)(node->out[0]);
+ir_node *get_irn_out_ex(const ir_node *def, int pos, int *in_pos)
+{
+       assert(pos >= 0 && pos < get_irn_n_outs(def));
+#ifdef DEBUG_libfirm
+       assert(def->out_valid);
+#endif /* defined DEBUG_libfirm */
+       *in_pos = def->out[pos+1].pos;
+       return def->out[pos+1].use;
 }
 
-/* Access successor n */
-inline ir_node  *get_irn_out      (ir_node *node, int pos) {
-  assert(node);
-  assert(pos >= 0 && pos < get_irn_n_outs(node));
-  return node->out[pos+1];
+void set_irn_out(ir_node *def, int pos, ir_node *use, int in_pos)
+{
+       assert(def && use);
+       assert(pos >= 0 && pos < get_irn_n_outs(def));
+#ifdef DEBUG_libfirm
+       assert(def->out_valid);
+#endif /* defined DEBUG_libfirm */
+       def->out[pos+1].use = use;
+       def->out[pos+1].pos = in_pos;
 }
 
-inline void      set_irn_out      (ir_node *node, int pos, ir_node *out) {
-  assert(node && out);
-  assert(pos >= 0 && pos < get_irn_n_outs(node));
-  node->out[pos+1] = out;
+int get_Block_n_cfg_outs(const ir_node *bl)
+{
+       int i, n_cfg_outs = 0;
+       assert(bl && is_Block(bl));
+#ifdef DEBUG_libfirm
+       assert(bl->out_valid);
+#endif /* defined DEBUG_libfirm */
+       for (i = 1; i <= bl->out[0].pos; ++i) {
+               ir_node *succ = bl->out[i].use;
+               if (get_irn_mode(succ) == mode_X && !is_End(succ) && !is_Bad(succ))
+                       n_cfg_outs += succ->out[0].pos;
+       }
+       return n_cfg_outs;
 }
 
-void irg_out_walk_2(ir_node *node,  void (pre)(ir_node*, void*),
-                   void (post)(ir_node*, void*), void *env) {
-  int i;
-  ir_node *succ;
+int get_Block_n_cfg_outs_ka(const ir_node *bl)
+{
+       int i, n_cfg_outs = 0;
+       assert(bl && is_Block(bl));
+#ifdef DEBUG_libfirm
+       assert(bl->out_valid);
+#endif /* defined DEBUG_libfirm */
+       for (i = 1; i <= bl->out[0].pos; ++i) {
+               ir_node *succ = bl->out[i].use;
+               if (get_irn_mode(succ) == mode_X) {
+                       if (is_Bad(succ))
+                               continue;
+                       if (is_End(succ)) {
+                               /* ignore End if we are in the Endblock */
+                               if (get_nodes_block(succ) == bl)
+                                       continue;
+                               else /* count Keep-alive as one */
+                                       n_cfg_outs += 1;
+                       } else
+                               n_cfg_outs += succ->out[0].pos;
+               }
+       }
+       return n_cfg_outs;
+}
 
-  //printf("++ in walker (%d outs) ", get_irn_n_outs(node)); DDMSG2(node);
+ir_node *get_Block_cfg_out(const ir_node *bl, int pos)
+{
+       int i;
+       assert(bl && is_Block(bl));
+#ifdef DEBUG_libfirm
+       assert(bl->out_valid);
+#endif /* defined DEBUG_libfirm */
+       for (i = 1; i <= bl->out[0].pos; ++i) {
+               ir_node *succ = bl->out[i].use;
+               if (get_irn_mode(succ) == mode_X && !is_End(succ) && !is_Bad(succ)) {
+                       int n_outs = succ->out[0].pos;
+                       if (pos < n_outs)
+                               return succ->out[pos + 1].use;
+                       else
+                               pos -= n_outs;
+               }
+       }
+       return NULL;
+}
 
-  assert(node);
-  assert(get_irn_visited(node) < get_irg_visited(current_ir_graph));
+ir_node *get_Block_cfg_out_ka(const ir_node *bl, int pos)
+{
+       int i, n_outs;
+       assert(bl && is_Block(bl));
+#ifdef DEBUG_libfirm
+       assert (bl->out_valid);
+#endif /* defined DEBUG_libfirm */
+       for (i = 1; i <= bl->out[0].pos; ++i) {
+               ir_node *succ = bl->out[i].use;
+               if (get_irn_mode(succ) == mode_X) {
+                       if (is_Bad(succ))
+                               continue;
+                       if (is_End(succ)) {
+                               ir_node *end_bl = get_nodes_block(succ);
+                               if (end_bl == bl) {
+                                       /* ignore End if we are in the Endblock */
+                                       continue;
+                               }
+                               if (pos == 0) {
+                                       /* handle keep-alive here: return the Endblock instead of the End node */
+                                       return end_bl;
+                               } else
+                                       --pos;
+                       } else {
+                               n_outs = succ->out[0].pos;
+                               if (pos < n_outs)
+                                       return succ->out[pos + 1].use;
+                               else
+                                       pos -= n_outs;
+                       }
+               }
+       }
+       return NULL;
+}
 
-  set_irn_visited(node, get_irg_visited(current_ir_graph));
+static void irg_out_walk_2(ir_node *node, irg_walk_func *pre,
+                           irg_walk_func *post, void *env)
+{
+       int     i, n;
+       ir_node *succ;
 
-  if (pre) pre(node, env);
+       assert(node);
+       assert(get_irn_visited(node) < get_irg_visited(current_ir_graph));
 
-  for (i = 0; i < get_irn_n_outs(node); i++) {
-    succ = get_irn_out(node, i);
-    if (get_irn_visited(succ) < get_irg_visited(current_ir_graph))
-      irg_out_walk_2(succ, pre, post, env);
-  }
+       set_irn_visited(node, get_irg_visited(current_ir_graph));
 
-  if (post) post(node, env);
+       if (pre) pre(node, env);
 
-  //printf("++ done walking "); DDMSG2(node);
-  return;
+       for (i = 0, n = get_irn_n_outs(node); i < n; ++i) {
+               succ = get_irn_out(node, i);
+               if (get_irn_visited(succ) < get_irg_visited(current_ir_graph))
+                       irg_out_walk_2(succ, pre, post, env);
+       }
+
+       if (post) post(node, env);
 }
 
-void irg_out_walk(ir_node *node,
-                 void (pre)(ir_node*, void*), void (post)(ir_node*, void*),
-                 void *env) {
-  assert(node);
-  if (get_irg_outs_state(current_ir_graph) != no_outs) {
-    inc_irg_visited (current_ir_graph);
-    irg_out_walk_2(node, pre, post, env);
-  }
-  return;
+void irg_out_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post,
+                  void *env)
+{
+       assert(node);
+       ir_graph *irg = get_irn_irg(node);
+       if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUTS)) {
+               inc_irg_visited (irg);
+               irg_out_walk_2(node, pre, post, env);
+       }
 }
 
-/* Walks only over Block nodes in the graph.  Has it's own visited
-   flag, so that it can be interleaved with the other walker.         */
-void irg_out_block_walk(ir_node *node,
-                       void (pre)(ir_node*, void*), void (post)(ir_node*, void*),
-                       void *env) {
+static void irg_out_block_walk2(ir_node *bl, irg_walk_func *pre,
+                                irg_walk_func *post, void *env)
+{
+       int i, n;
+
+       if (!Block_block_visited(bl)) {
+               mark_Block_block_visited(bl);
+
+               if (pre)
+                       pre(bl, env);
+
+               for (i = 0, n =  get_Block_n_cfg_outs(bl); i < n; ++i) {
+                       /* find the corresponding predecessor block. */
+                       ir_node *pred = get_Block_cfg_out(bl, i);
+                       /* recursion */
+                       irg_out_block_walk2(pred, pre, post, env);
+               }
+
+               if (post)
+                       post(bl, env);
+       }
 }
 
-/**********************************************************************/
-/** Building and Removing the out datasturcture                      **/
+void irg_out_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post,
+                        void *env)
+{
+
+       assert(is_Block(node) || (get_irn_mode(node) == mode_X));
+
+       inc_irg_block_visited(current_ir_graph);
+
+       if (get_irn_mode(node) == mode_X) {
+               int i, n;
+
+               for (i = 0, n = get_irn_n_outs(node); i < n; ++i) {
+                       ir_node *succ = get_irn_out(node, i);
+                       irg_out_block_walk2(succ, pre, post, env);
+               }
+       }
+       else {
+               irg_out_block_walk2(node, pre, post, env);
+       }
+}
+
+/*--------------------------------------------------------------------*/
+/** Building and Removing the out datastructure                      **/
 /**                                                                  **/
 /** The outs of a graph are allocated in a single, large array.      **/
 /** This allows to allocate and deallocate the memory for the outs   **/
@@ -97,90 +285,217 @@ void irg_out_block_walk(ir_node *node,
 /** Then the large array is allocated.  The second iteration chops   **/
 /** the large array into smaller parts, sets the out edges and       **/
 /** recounts the out edges.                                          **/
-/**********************************************************************/
+/** Removes Tuple nodes!                                             **/
+/*--------------------------------------------------------------------*/
+
+
+/** Returns the amount of out edges for not yet visited successors. */
+static int _count_outs(ir_node *n)
+{
+       int start, i, res, irn_arity;
+
+       mark_irn_visited(n);
+       n->out = (ir_def_use_edge*) INT_TO_PTR(1);     /* Space for array size. */
+
+       start = is_Block(n) ? 0 : -1;
+       irn_arity = get_irn_arity(n);
+       res = irn_arity - start + 1;  /* --1 or --0; 1 for array size. */
 
+       for (i = start; i < irn_arity; ++i) {
+               /* Optimize Tuples.  They annoy if walking the cfg. */
+               ir_node *pred         = get_irn_n(n, i);
+               ir_node *skipped_pred = skip_Tuple(pred);
 
-/* Returns the amount of out edges for not yet visited successors. */
-int count_outs(ir_node *n) {
-  int start, i, res;
-  ir_node *succ;
+               if (skipped_pred != pred) {
+                       set_irn_n(n, i, skipped_pred);
+               }
 
-  set_irn_visited(n, get_irg_visited(current_ir_graph));
-  n->out = (ir_node **) 1;     /* Space for array size. */
+               /* count Def-Use edges for predecessors */
+               if (!irn_visited(skipped_pred))
+                       res += _count_outs(skipped_pred);
 
-  if ((get_irn_op(n) == op_Block)) start = 0; else start = -1;
-  res = get_irn_arity(n) - start +1;  /* --1 or --0; 1 for array size. */
-  for (i = start; i < get_irn_arity(n); i++) {
-    succ = get_irn_n(n, i);
-    /* count outs for successors */
-    if (get_irn_visited(succ) < get_irg_visited(current_ir_graph))
-      res += count_outs(succ);
-    /* Count my outs */
-    succ->out = (ir_node **)( (int)succ->out +1);
-  }
-  return res;
+               /*count my Def-Use edges */
+               skipped_pred->out = (ir_def_use_edge*) INT_TO_PTR(PTR_TO_INT(skipped_pred->out) + 1);
+       }
+       return res;
 }
 
-ir_node **set_out_edges(ir_node *n, ir_node **free) {
-  int n_outs, start, i;
-  ir_node *succ;
 
-  set_irn_visited(n, get_irg_visited(current_ir_graph));
+/** Returns the amount of out edges for not yet visited successors.
+ *  This version handles some special nodes like irg_frame, irg_args etc.
+ */
+static int count_outs(ir_graph *irg)
+{
+       ir_node *n;
+       int     i, res;
+
+       inc_irg_visited(irg);
+       res = _count_outs(get_irg_end(irg));
+
+       /* Now handle anchored nodes. We need the out count of those
+          even if they are not visible. */
+       for (i = anchor_last; i >= anchor_first; --i) {
+               n = get_irg_anchor(irg, i);
+               if (!irn_visited_else_mark(n)) {
+                       n->out = (ir_def_use_edge*) INT_TO_PTR(1);
+                       ++res;
+               }
+       }
+       return res;
+}
 
-  /* Allocate my array */
-  n_outs = (int) n->out;
-  n->out = free;
-  free = &free[n_outs];
-  /* We count the successors again, the space will be sufficient.
-     We use this counter to remember the position for the next back
-     edge. */
-  n->out[0] = (ir_node *)0;
+/**
+ * Enter memory for the outs to a node.
+ *
+ * @param use    current node
+ * @param free   current free address in the chunk allocated for the outs
+ *
+ * @return The next free address
+ */
+static ir_def_use_edge *_set_out_edges(ir_node *use, ir_def_use_edge *free)
+{
+       int    start, i, irn_arity, pos;
+       size_t n_outs;
+
+       mark_irn_visited(use);
+
+       /* Allocate my array */
+       n_outs = PTR_TO_INT(use->out);
+       use->out = free;
+#ifdef DEBUG_libfirm
+       use->out_valid = 1;
+#endif /* defined DEBUG_libfirm */
+       free += n_outs;
+       /* We count the successors again, the space will be sufficient.
+          We use this counter to remember the position for the next back
+          edge. */
+       use->out[0].pos = 0;
+
+       start = is_Block(use) ? 0 : -1;
+       irn_arity = get_irn_arity(use);
+
+       for (i = start; i < irn_arity; ++i) {
+               ir_node *def = get_irn_n(use, i);
+
+               /* Recursion */
+               if (!irn_visited(def))
+                       free = _set_out_edges(def, free);
+
+               /* Remember this Def-Use edge */
+               pos = def->out[0].pos + 1;
+               def->out[pos].use = use;
+               def->out[pos].pos = i;
+
+               /* increase the number of Def-Use edges so far */
+               def->out[0].pos = pos;
+       }
+       return free;
+}
 
-  if (get_irn_op(n) == op_Block) start = 0; else start = -1;
-  for (i = start; i < get_irn_arity(n); i++) {
-    succ = get_irn_n(n, i);
-    /* Recursion */
-    if (get_irn_visited(succ) < get_irg_visited(current_ir_graph))
-      free = set_out_edges(succ, free);
-    /* Remember our back edge */
-    succ->out[get_irn_n_outs(succ)+1] = n;
-    succ->out[0] = (ir_node *) (get_irn_n_outs(succ) + 1);
-  }
-  return free;
+/**
+ * Enter memory for the outs to a node. Handles special nodes
+ *
+ * @param irg    the graph
+ * @param free   current free address in the chunk allocated for the outs
+ *
+ * @return The next free address
+ */
+static ir_def_use_edge *set_out_edges(ir_graph *irg, ir_def_use_edge *free)
+{
+       ir_node *n;
+       int     i;
+
+       inc_irg_visited(irg);
+       free = _set_out_edges(get_irg_end(irg), free);
+
+       /* handle anchored nodes */
+       for (i = anchor_last; i >= anchor_first; --i) {
+               n = get_irg_anchor(irg, i);
+               if (!irn_visited_else_mark(n)) {
+                       size_t n_outs = PTR_TO_INT(n->out);
+                       n->out = free;
+#ifdef DEBUG_libfirm
+                       n->out_valid = 1;
+#endif /* defined DEBUG_libfirm */
+                       free += n_outs;
+               }
+       }
+
+       return free;
 }
 
-void compute_outs(ir_graph *irg) {
-  ir_graph *rem = current_ir_graph;
-  int n_out_edges = 0;
+void compute_irg_outs(ir_graph *irg)
+{
+       ir_graph        *rem = current_ir_graph;
+       int             n_out_edges = 0;
+       ir_def_use_edge *end = NULL;         /* Only for debugging */
+
+       current_ir_graph = irg;
+
+       /* Update graph state */
+       assert(get_irg_phase_state(current_ir_graph) != phase_building);
 
-  current_ir_graph = irg;
+       free_irg_outs(current_ir_graph);
 
-  /* Update graph state */
-  assert(get_irg_phase_state(current_ir_graph) != phase_building);
-  current_ir_graph->outs_state = outs_consistent;
+       /* This first iteration counts the overall number of out edges and the
+          number of out edges for each node. */
+       n_out_edges = count_outs(irg);
 
-  /* This first iteration counts the overall number of out edges and the
-     number of out edges for each node. */
-  inc_irg_visited(irg);
-  n_out_edges = count_outs(get_irg_end(irg));
+       /* allocate memory for all out edges. */
+       irg->outs = XMALLOCNZ(ir_def_use_edge, n_out_edges);
+#ifdef DEBUG_libfirm
+       irg->n_outs = n_out_edges;
+#endif /* defined DEBUG_libfirm */
 
-  /* allocate memory for all out edges. */
-  irg->outs = (ir_node **) malloc (n_out_edges * sizeof(ir_node *));
+       /* The second iteration splits the irg->outs array into smaller arrays
+          for each node and writes the back edges into this array. */
+       end = set_out_edges(irg, irg->outs);
 
-  /* The second iteration splits the irg->outs array into smaller arrays
-     for each node and writes the back edges into this array. */
-  inc_irg_visited(irg);
-  set_out_edges(get_irg_end(irg), irg->outs);
+       /* Check how much memory we have used */
+       assert (end == (irg->outs + n_out_edges));
 
-  current_ir_graph = rem;
+       add_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUTS);
+       current_ir_graph = rem;
 }
 
-void free_outs(ir_graph *irg) {
+void assure_irg_outs(ir_graph *irg)
+{
+       if (! irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUTS))
+               compute_irg_outs(irg);
+}
+
+void compute_irp_outs(void)
+{
+       size_t i, n;
+       for (i = 0, n = get_irp_n_irgs(); i < n; ++i)
+               compute_irg_outs(get_irp_irg(i));
+}
 
-  /* Update graph state */
-  // assert(get_irg_phase_state(current_ir_graph) != phase_building);
-  current_ir_graph->outs_state = no_outs;
+void free_irp_outs(void)
+{
+       size_t i, n;
+       for (i = 0, n = get_irp_n_irgs(); i < n; ++i)
+               free_irg_outs(get_irp_irg(i));
+}
 
-  if (irg->outs) free(irg->outs);
-  irg->outs = NULL;
+void free_irg_outs(ir_graph *irg)
+{
+       /*   current_ir_graph->outs_state = outs_none; */
+
+       if (irg->outs) {
+#ifdef DEBUG_libfirm
+               memset(irg->outs, 0, irg->n_outs);
+#endif /* defined DEBUG_libfirm */
+               free(irg->outs);
+               irg->outs = NULL;
+#ifdef DEBUG_libfirm
+               irg->n_outs = 0;
+#endif /* defined DEBUG_libfirm */
+       }
+
+#ifdef DEBUG_libfirm
+       /* when debugging, *always* reset all nodes' outs!  irg->outs might
+          have been lying to us */
+       irg_walk_graph (irg, reset_outs, NULL, NULL);
+#endif /* defined DEBUG_libfirm */
 }