becopyilp: Do not advertise the switch to dump the solution, because this is not...
[libfirm] / ir / ana / vrp.c
index d1d0a67..fdc3b70 100644 (file)
@@ -1,27 +1,12 @@
 /*
- * Copyright (C) 1995-2010 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.
+ * Copyright (C) 2012 University of Karlsruhe.
  */
 
 /**
  * @file
  * @brief   analyze graph to provide value range information
  * @author  Jonas Fietz
- * @version $Id$
  */
 #include "config.h"
 
 #include "tv.h"
 #include "irop.h"
 #include "pdeq.h"
-#include "irphase_t.h"
+#include "irnodemap.h"
+#include "irhooks.h"
 #include "bitset.h"
 #include "debug.h"
 
-DEBUG_ONLY(static firm_dbg_module_t *dbg);
+DEBUG_ONLY(static firm_dbg_module_t *dbg;)
 
 typedef struct vrp_env_t {
-       waitq    *workqueue;
-       bitset_t *visited;
+       waitq       *workqueue;
+       bitset_t    *visited;
+       ir_vrp_info *info;
 } vrp_env_t;
 
-static vrp_attr *get_vrp_attr(const ir_node *node)
+static vrp_attr *vrp_get_or_set_info(ir_vrp_info *info, const ir_node *node)
 {
-       return (vrp_attr*) get_or_set_irn_phase_info(node, PHASE_VRP);
+       vrp_attr *attr = ir_nodemap_get(vrp_attr, &info->infos, node);
+       if (attr == NULL) {
+               ir_mode *mode = get_irn_mode(node);
+               assert(mode_is_int(mode));
+
+               attr = OALLOCZ(&info->obst, vrp_attr);
+               attr->range_type   = VRP_UNDEFINED;
+               attr->bits_set     = get_mode_null(mode);
+               attr->bits_not_set = get_mode_all_one(mode);
+               attr->range_bottom = get_tarval_top();
+               attr->range_top    = get_tarval_top();
+
+               ir_nodemap_insert(&info->infos, node, attr);
+       }
+       return attr;
+}
+
+vrp_attr *vrp_get_info(const ir_node *node)
+{
+       ir_graph *irg = get_irn_irg(node);
+       if (irg->vrp.infos.data == NULL)
+               return NULL;
+       return ir_nodemap_get(vrp_attr, &irg->vrp.infos, node);
 }
 
-static int vrp_update_node(ir_node *node)
+static int vrp_update_node(ir_vrp_info *info, ir_node *node)
 {
        ir_tarval *new_bits_set = get_tarval_bad();
        ir_tarval *new_bits_not_set = get_tarval_bad();
@@ -67,7 +76,7 @@ static int vrp_update_node(ir_node *node)
                return 0; /* we don't optimize for non-int-nodes*/
        }
 
-       vrp = get_vrp_attr(node);
+       vrp = vrp_get_or_set_info(info, node);
 
        /* TODO: Check if all predecessors have valid VRP information*/
 
@@ -87,8 +96,8 @@ static int vrp_update_node(ir_node *node)
 
                left = get_And_left(node);
                right = get_And_right(node);
-               vrp_left = get_vrp_attr(left);
-               vrp_right = get_vrp_attr(right);
+               vrp_left = vrp_get_or_set_info(info, left);
+               vrp_right = vrp_get_or_set_info(info, right);
                new_bits_set = tarval_and(vrp_left->bits_set, vrp_right->bits_set);
                new_bits_not_set = tarval_and(vrp_left->bits_not_set, vrp_right->bits_not_set);
 
@@ -96,64 +105,71 @@ static int vrp_update_node(ir_node *node)
        }
 
        case iro_Add: {
-               int overflow_top, overflow_bottom;
-               ir_tarval *new_top, *new_bottom;
-               const vrp_attr *vrp_left, *vrp_right;
-               vrp_left = get_vrp_attr(get_Add_left(node));
-               vrp_right = get_vrp_attr(get_Add_right(node));
+               const vrp_attr *vrp_left  = vrp_get_or_set_info(info, get_Add_left(node));
+               const vrp_attr *vrp_right = vrp_get_or_set_info(info, get_Add_right(node));
 
-               if (vrp_left->range_type == VRP_UNDEFINED || vrp_right->range_type ==
-                               VRP_UNDEFINED || vrp_left->range_type == VRP_VARYING ||
-                               vrp_right->range_type == VRP_VARYING) {
+               if (vrp_left->range_type == VRP_UNDEFINED
+                || vrp_right->range_type == VRP_UNDEFINED
+                || vrp_left->range_type == VRP_VARYING
+                || vrp_right->range_type == VRP_VARYING) {
                        return 0;
                }
 
-               new_top = tarval_add(vrp_left->range_top, vrp_right->range_top);
-               overflow_top = tarval_carry();
-               new_bottom = tarval_add(vrp_left->range_bottom, vrp_right->range_bottom);
-               overflow_bottom = tarval_carry();
-
-               if (!overflow_top && !overflow_bottom && vrp_left->range_type == VRP_RANGE
-                               &&vrp_right->range_type == VRP_RANGE) {
-                       new_range_bottom = new_bottom;
-                       new_range_top = new_top;
-                       new_range_type = VRP_RANGE;
-               }
-
-               if (overflow_top || overflow_bottom) {
-                       /* TODO Implement overflow handling*/
-                       new_range_type = VRP_UNDEFINED;
+               if (vrp_left->range_type == VRP_RANGE
+                && vrp_right->range_type == VRP_RANGE) {
+                       tarval_int_overflow_mode_t rem = tarval_get_integer_overflow_mode();
+                       tarval_set_integer_overflow_mode(TV_OVERFLOW_BAD);
+                       ir_tarval *new_top
+                               = tarval_add(vrp_left->range_top, vrp_right->range_top);
+                       ir_tarval *new_bottom
+                               = tarval_add(vrp_left->range_bottom, vrp_right->range_bottom);
+                       tarval_set_integer_overflow_mode(rem);
+
+                       if (new_top != tarval_bad && new_bottom != tarval_bad) {
+                               new_range_bottom = new_bottom;
+                               new_range_top    = new_top;
+                               new_range_type   = VRP_RANGE;
+                       } else {
+                               /* TODO Implement overflow handling*/
+                               new_range_type = VRP_UNDEFINED;
+                       }
                }
                break;
        }
 
        case iro_Sub: {
-               int overflow_top, overflow_bottom;
-               ir_tarval *new_top, *new_bottom;
-               const vrp_attr *vrp_left, *vrp_right;
-               vrp_left = get_vrp_attr(get_Sub_left(node));
-               vrp_right = get_vrp_attr(get_Sub_right(node));
+               ir_node *left  = get_Sub_left(node);
+               ir_node *right = get_Sub_right(node);
 
-               if (vrp_left->range_type == VRP_UNDEFINED || vrp_right->range_type ==
-                               VRP_UNDEFINED || vrp_left->range_type == VRP_VARYING ||
-                               vrp_right->range_type == VRP_VARYING) {
+               if (!mode_is_int(get_irn_mode(left)))
                        return 0;
-               }
 
-               new_top = tarval_sub(vrp_left->range_top, vrp_right->range_top, NULL);
-               overflow_top = tarval_carry();
-               new_bottom = tarval_sub(vrp_left->range_bottom, vrp_right->range_bottom, NULL);
-               overflow_bottom = tarval_carry();
+               const vrp_attr *vrp_left  = vrp_get_or_set_info(info, left);
+               const vrp_attr *vrp_right = vrp_get_or_set_info(info, right);
 
-               if (!overflow_top && !overflow_bottom && vrp_left->range_type == VRP_RANGE
-                               &&vrp_right->range_type == VRP_RANGE) {
-                       new_range_bottom = new_bottom;
-                       new_range_top = new_top;
-                       new_range_type = VRP_RANGE;
+               if (vrp_left->range_type == VRP_UNDEFINED
+                || vrp_right->range_type == VRP_UNDEFINED
+                || vrp_left->range_type == VRP_VARYING
+                || vrp_right->range_type == VRP_VARYING) {
+                       return 0;
                }
 
-               if (overflow_top || overflow_bottom) {
-                       /* TODO Implement overflow handling*/
+               if (vrp_left->range_type == VRP_RANGE
+                && vrp_right->range_type == VRP_RANGE) {
+                       tarval_int_overflow_mode_t rem = tarval_get_integer_overflow_mode();
+                       tarval_set_integer_overflow_mode(TV_OVERFLOW_BAD);
+                       ir_tarval *new_top = tarval_sub(vrp_left->range_top, vrp_right->range_top, NULL);
+                       ir_tarval *new_bottom = tarval_sub(vrp_left->range_bottom, vrp_right->range_bottom, NULL);
+                       tarval_set_integer_overflow_mode(rem);
+
+                       if (new_top != tarval_bad && new_bottom != tarval_bad) {
+                               new_range_bottom = new_bottom;
+                               new_range_top = new_top;
+                               new_range_type = VRP_RANGE;
+                       } else {
+                               /* TODO Implement overflow handling*/
+                               new_range_type = VRP_UNDEFINED;
+                       }
                }
                break;
        }
@@ -161,8 +177,8 @@ static int vrp_update_node(ir_node *node)
        case iro_Or: {
                const vrp_attr *vrp_left, *vrp_right;
 
-               vrp_left = get_vrp_attr(get_Or_left(node));
-               vrp_right = get_vrp_attr(get_Or_right(node));
+               vrp_left = vrp_get_or_set_info(info, get_Or_left(node));
+               vrp_right = vrp_get_or_set_info(info, get_Or_right(node));
 
                new_bits_set = tarval_or(vrp_left->bits_set, vrp_right->bits_set);
                new_bits_not_set = tarval_or(vrp_left->bits_not_set, vrp_right->bits_not_set);
@@ -174,7 +190,7 @@ static int vrp_update_node(ir_node *node)
                const vrp_attr *vrp_left;
                const ir_node *right = get_Rotl_right(node);
 
-               vrp_left = get_vrp_attr(get_Rotl_left(node));
+               vrp_left = vrp_get_or_set_info(info, get_Rotl_left(node));
 
                /* We can only compute this if the right value is a constant*/
                if (is_Const(right)) {
@@ -187,7 +203,7 @@ static int vrp_update_node(ir_node *node)
        case iro_Shl: {
                const vrp_attr *vrp_left;
                const ir_node *right = get_Shl_right(node);
-               vrp_left = get_vrp_attr(get_Shl_left(node));
+               vrp_left = vrp_get_or_set_info(info, get_Shl_left(node));
 
                /* We can only compute this if the right value is a constant*/
                if (is_Const(right)) {
@@ -201,7 +217,7 @@ static int vrp_update_node(ir_node *node)
                const vrp_attr *vrp_left;
                const ir_node *right = get_Shr_right(node);
 
-               vrp_left = get_vrp_attr(get_Shr_left(node));
+               vrp_left = vrp_get_or_set_info(info, get_Shr_left(node));
 
                /* We can only compute this if the right value is a constant*/
                if (is_Const(right)) {
@@ -215,7 +231,7 @@ static int vrp_update_node(ir_node *node)
                const vrp_attr *vrp_left;
                const ir_node *right = get_Shrs_right(node);
 
-               vrp_left = get_vrp_attr(get_Shrs_left(node));
+               vrp_left = vrp_get_or_set_info(info, get_Shrs_left(node));
 
                /* We can only compute this if the right value is a constant*/
                if (is_Const(right)) {
@@ -228,8 +244,8 @@ static int vrp_update_node(ir_node *node)
        case iro_Eor: {
                const vrp_attr *vrp_left, *vrp_right;
 
-               vrp_left = get_vrp_attr(get_Eor_left(node));
-               vrp_right = get_vrp_attr(get_Eor_right(node));
+               vrp_left = vrp_get_or_set_info(info, get_Eor_left(node));
+               vrp_right = vrp_get_or_set_info(info, get_Eor_right(node));
 
                new_bits_set = tarval_or(
                                                tarval_and(vrp_left->bits_set, tarval_not(vrp_right->bits_not_set)),
@@ -244,7 +260,7 @@ static int vrp_update_node(ir_node *node)
        }
 
        case iro_Id: {
-               const vrp_attr *vrp_pred = get_vrp_attr(get_Id_pred(node));
+               const vrp_attr *vrp_pred = vrp_get_or_set_info(info, get_Id_pred(node));
                new_bits_set = vrp_pred->bits_set;
                new_bits_not_set = vrp_pred->bits_not_set;
                new_range_top = vrp_pred->range_top;
@@ -254,7 +270,7 @@ static int vrp_update_node(ir_node *node)
        }
 
        case iro_Not: {
-               const vrp_attr *vrp_pred = get_vrp_attr(get_Not_op(node));
+               const vrp_attr *vrp_pred = vrp_get_or_set_info(info, get_Not_op(node));
                new_bits_set = tarval_not(vrp_pred->bits_not_set);
                new_bits_not_set = tarval_not(vrp_pred->bits_set);
                break;
@@ -263,13 +279,14 @@ static int vrp_update_node(ir_node *node)
        case iro_Conv: {
                const ir_node *pred = get_Conv_op(node);
                ir_mode *old_mode = get_irn_mode(pred);
-               const vrp_attr *vrp_pred = get_vrp_attr(pred);
+               const vrp_attr *vrp_pred;
 
                ir_mode *new_mode;
 
                if (!mode_is_int(old_mode))
                        return 0;
 
+               vrp_pred = vrp_get_or_set_info(info, pred);
                new_mode = get_irn_mode(node);
 
                /* The second and is needed if target type is smaller*/
@@ -320,7 +337,7 @@ static int vrp_update_node(ir_node *node)
                int i;
 
                const ir_node *pred = get_Phi_pred(node,0);
-               const vrp_attr *vrp_pred = get_vrp_attr(pred);
+               const vrp_attr *vrp_pred = vrp_get_or_set_info(info, pred);
                new_range_top = vrp_pred->range_top;
                new_range_bottom = vrp_pred->range_bottom;
                new_range_type = vrp_pred->range_type;
@@ -331,7 +348,7 @@ static int vrp_update_node(ir_node *node)
 
                for (i = 1; i < num; i++) {
                        pred = get_Phi_pred(node, i);
-                       vrp_pred = get_vrp_attr(pred);
+                       vrp_pred = vrp_get_or_set_info(info, pred);
                        if (new_range_type == VRP_RANGE && vrp_pred->range_type ==
                                        VRP_RANGE) {
                                relation = tarval_cmp(new_range_top, vrp_pred->range_top);
@@ -362,7 +379,7 @@ static int vrp_update_node(ir_node *node)
        /* TODO: Check, if there can be information derived from any of these:
        is_Abs(node) is_Alloc(node) is_Anchor(node) is_Borrow(node) is_Bound(node)
        is_Break(node) is_Builtin(node) is_Call(node)
-       is_Carry(node) is_Cast(node) is_Cmp(node) is_Cond(node)
+       is_Carry(node) is_Cmp(node) is_Cond(node)
        is_CopyB(node) is_Div(node) is_Dummy(node)
        is_End(node) is_Free(node)
        is_IJmp(node) is_InstOf(node) is_Jmp(node) is_Load(node) is_Minus(node)
@@ -392,7 +409,7 @@ static int vrp_update_node(ir_node *node)
        /* Merge the newly calculated values with those that might already exist*/
        if (new_bits_set != tarval_bad) {
                new_bits_set = tarval_or(new_bits_set, vrp->bits_set);
-               if (tarval_cmp(new_bits_set, vrp->bits_set) != ir_relation_equal) {
+               if (new_bits_set != vrp->bits_set) {
                        something_changed = 1;
                        vrp->bits_set = new_bits_set;
                }
@@ -400,7 +417,7 @@ static int vrp_update_node(ir_node *node)
        if (new_bits_not_set != tarval_bad) {
                new_bits_not_set = tarval_and(new_bits_not_set, vrp->bits_not_set);
 
-               if (tarval_cmp(new_bits_not_set, vrp->bits_not_set) != ir_relation_equal) {
+               if (new_bits_not_set != vrp->bits_not_set) {
                        something_changed = 1;
                        vrp->bits_not_set = new_bits_not_set;
                }
@@ -482,9 +499,8 @@ static void vrp_first_pass(ir_node *n, void *e)
 
        bitset_set(env->visited, get_irn_idx(n));
 
-       vrp_update_node(n);
+       vrp_update_node(env->info, n);
 
-       assure_irg_outs(get_current_ir_graph());
        for (i = get_irn_n_outs(n) - 1; i >=0; --i) {
                ir_node *succ = get_irn_out(n, i);
                if (bitset_is_set(env->visited, get_irn_idx(succ))) {
@@ -494,70 +510,54 @@ static void vrp_first_pass(ir_node *n, void *e)
        }
 }
 
-static void *vrp_init_node(ir_phase *phase, const ir_node *n)
+static void dump_vrp_info(void *ctx, FILE *F, const ir_node *node)
 {
-       ir_mode *mode;
        vrp_attr *vrp;
 
-       DBG((dbg, LEVEL_2, "initialized node nr: %d\n", get_irn_node_nr(n)));
-       vrp = (vrp_attr*) phase_alloc(phase, sizeof(vrp_attr));
-
-       memset(vrp, 0, sizeof(vrp_attr));
-       /* Initialize the vrp information to default */
-
-       mode = get_irn_mode(n);
+       (void) ctx;
+       if (!mode_is_int(get_irn_mode(node)))
+               return;
 
-       vrp->range_type = VRP_UNDEFINED;
+       vrp = vrp_get_info(node);
+       if (vrp == NULL)
+               return;
 
-       /* TODO: We might be able to optimize space usage if we do not allocate
-        * vrp space for non-int nodes. (currently caught by vrp_update_node)
-        */
-       if (mode_is_int(mode)) {
-               /* We are assuming that 0 is always represented as this modes null */
-               vrp->valid = 1;
-               vrp->bits_set = get_mode_null(mode);
-               vrp->bits_not_set = get_mode_all_one(mode);
-               vrp->range_bottom = get_tarval_top();
-               vrp->range_top = get_tarval_top();
-       } else {
-               vrp->valid = 0;
-               vrp->bits_set = get_tarval_bad();
-               vrp->bits_not_set = get_tarval_bad();
-               vrp->range_bottom = get_tarval_bad();
-               vrp->range_top = get_tarval_bad();
+       fprintf(F, "vrp range type: %d\n", (int) vrp->range_type);
+       if (vrp->range_type == VRP_RANGE || vrp->range_type == VRP_ANTIRANGE) {
+               ir_fprintf(F, "vrp range bottom: %T\n",vrp->range_bottom);
+               ir_fprintf(F, "vrp range top: %T\n", vrp->range_top);
        }
-
-       /* TODO: We might be able to set better vrp info at this time, if this is
-        * a node which is newly created in an already initialized irg
-        *
-        * maybe just call vrp_update_node and if it returns one, iterate over
-        * successors
-        */
-       return vrp;
+       ir_fprintf(F, "vrp bits set: %T\n", vrp->bits_set);
+       ir_fprintf(F, "vrp bits not set: %T\n", vrp->bits_not_set);
 }
 
+static hook_entry_t dump_hook;
+
 void set_vrp_data(ir_graph *irg)
 {
        ir_node *succ, *node;
        int i;
        vrp_env_t *env;
-       ir_phase *phase;
+       ir_vrp_info *info;
+
+       if (irg->vrp.infos.data != NULL)
+               free_vrp_data(irg);
 
        FIRM_DBG_REGISTER(dbg, "ir.ana.vrp");
 
        assure_irg_outs(irg); /* ensure that out edges are consistent*/
-       phase = irg_get_phase(irg, PHASE_VRP);
-       if (phase == NULL) {
-               /* this is our first run */
-               phase = new_phase(irg, vrp_init_node);
-               irg_register_phase(irg, PHASE_VRP, phase);
-               env = (vrp_env_t*) phase_alloc(phase, sizeof(*env));
-               phase->priv = env;
-       } else {
-               env = (vrp_env_t*) phase->priv;
+       ir_nodemap_init(&irg->vrp.infos, irg);
+       obstack_init(&irg->vrp.obst);
+       info = &irg->vrp;
+
+       if (dump_hook.hook._hook_node_info == NULL) {
+               dump_hook.hook._hook_node_info = dump_vrp_info;
+               register_hook(hook_node_info, &dump_hook);
        }
 
+       env = OALLOCZ(&irg->vrp.obst, vrp_env_t);
        env->workqueue = new_waitq();
+       env->info      = info;
 
        env->visited = bitset_malloc(get_irg_last_idx(irg));
        irg_walk_graph(irg, NULL, vrp_first_pass, env);
@@ -567,7 +567,7 @@ void set_vrp_data(ir_graph *irg)
        while (!waitq_empty(env->workqueue)) {
                node = (ir_node*) waitq_get(env->workqueue);
 
-               if (vrp_update_node(node)) {
+               if (vrp_update_node(info, node)) {
                        /* if something changed, add successors to worklist*/
                        for (i = get_irn_n_outs(node) - 1; i >= 0; --i) {
                                succ =  get_irn_out(node, i);
@@ -578,6 +578,14 @@ void set_vrp_data(ir_graph *irg)
        del_waitq(env->workqueue);
 }
 
+void free_vrp_data(ir_graph *irg)
+{
+       if (irg->vrp.infos.data == NULL)
+               return;
+       obstack_free(&irg->vrp.obst, NULL);
+       ir_nodemap_destroy(&irg->vrp.infos);
+}
+
 ir_graph_pass_t *set_vrp_pass(const char *name)
 {
        return def_graph_pass(name ? name : "set_vrp", set_vrp_data);
@@ -587,6 +595,9 @@ ir_relation vrp_cmp(const ir_node *left, const ir_node *right)
 {
        vrp_attr *vrp_left, *vrp_right;
 
+       if (!mode_is_int(get_irn_mode(left)))
+               return ir_relation_true;
+
        vrp_left = vrp_get_info(left);
        vrp_right = vrp_get_info(right);
 
@@ -610,22 +621,3 @@ ir_relation vrp_cmp(const ir_node *left, const ir_node *right)
        /* TODO: We can get way more information here*/
        return ir_relation_true;
 }
-
-vrp_attr *vrp_get_info(const ir_node *node)
-{
-       const ir_graph *irg   = get_irn_irg(node);
-       const ir_phase *phase = irg_get_phase(irg, PHASE_VRP);
-       vrp_attr       *vrp;
-
-       if (phase == NULL) {
-               /* phase has not yet been initialized */
-               return NULL;
-       }
-
-       vrp = (vrp_attr*) phase_get_irn_data(phase, node);
-       if (vrp && vrp->valid) {
-               return vrp;
-       }
-
-       return NULL;
-}