Fix comment.
[libfirm] / ir / be / ia32 / ia32_address_mode.c
index 72f204a..17c0d9d 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
 /**
  * @file
  * @brief       This file contains functions for matching firm graphs for
- *              nodes that can be used as addressmode for x86 commands
+ *              nodes that can be used as address mode for x86 instructions
  * @author      Matthias Braun
- * @version     $Id: ia32_transform.c 15462 2007-08-03 16:50:59Z matze $
+ * @version     $Id$
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
 #include "ia32_address_mode.h"
+#include "ia32_transform.h"
 
 #include "irtypes.h"
 #include "irnode_t.h"
 #include "irprintf.h"
 #include "error.h"
 #include "iredges_t.h"
+#include "irgwalk.h"
 
 #include "../benode_t.h"
 
-#undef AGGRESSIVE_AM
+#define AGGRESSIVE_AM
 
-static int is_immediate_2(const ir_node *node, int *symconsts)
+/* gas/ld don't support negative symconsts :-( */
+#undef SUPPORT_NEGATIVE_SYMCONSTS
+
+static be_lv_t  *lv;
+static bitset_t *non_address_mode_nodes;
+
+/**
+ * Recursive worker for checking if a DAG with root node can be represented as a simple immediate,
+ *
+ * @param node       the node
+ * @param symconsts  number of symconsts found so far
+ * @param negate     if set, the immediate must be negated
+ *
+ * @return non-zero if the DAG represents an immediate, 0 else
+ */
+static int do_is_immediate(const ir_node *node, int *symconsts, int negate)
 {
        ir_node *left;
        ir_node *right;
 
-       switch(get_irn_opcode(node)) {
+       switch (get_irn_opcode(node)) {
        case iro_Const:
-               if(!tarval_is_long(get_Const_tarval(node))) {
+               /* Consts are typically immediates */
+               if (!tarval_is_long(get_Const_tarval(node))) {
 #ifdef DEBUG_libfirm
-                       ir_fprintf(stderr, "Optimisation warning tarval of %+F is not a "
-                                  "long.");
+                       ir_fprintf(stderr,
+                                  "Optimisation warning tarval of %+F(%+F) is not a long.\n",
+                                  node, current_ir_graph);
 #endif
                        return 0;
                }
                return 1;
        case iro_SymConst:
+               /* the first SymConst of a DAG can be fold into an immediate */
+#ifndef SUPPORT_NEGATIVE_SYMCONSTS
+               /* unfortunately the assembler/linker doesn't support -symconst */
+               if(negate)
+                       return 0;
+#endif
+
                if(get_SymConst_kind(node) != symconst_addr_ent)
                        return 0;
                (*symconsts)++;
@@ -65,60 +91,98 @@ static int is_immediate_2(const ir_node *node, int *symconsts)
                return 1;
        case iro_Add:
        case iro_Sub:
+               /* Add's and Sub's are typically supported as long as both operands are
+                * immediates */
+               if(bitset_is_set(non_address_mode_nodes, get_irn_idx(node)))
+                       return 0;
+
                left  = get_binop_left(node);
                right = get_binop_right(node);
-               if(!is_immediate_2(left, symconsts))
+               if(!do_is_immediate(left, symconsts, negate))
                        return 0;
-               if(!is_immediate_2(right, symconsts))
+               if(!do_is_immediate(right, symconsts, is_Sub(node) ? !negate : negate))
                        return 0;
 
                return 1;
        default:
-               break;
+               /* all other nodes are NO immediates */
+               return 0;
        }
-
-       return 0;
 }
 
-static int is_immediate(ia32_address_t *addr, const ir_node *node)
-{
+/**
+ * Checks if a DAG with a single root node can be represented as a simple immediate.
+ *
+ * @param node  the node
+ *
+ * @return non-zero if the DAG represents an immediate, 0 else
+ */
+#if 0
+static int is_immediate_simple(const ir_node *node) {
        int symconsts = 0;
-       if(addr->symconst_ent != NULL)
-               symconsts = 1;
+       return do_is_immediate(node, &symconsts, 0);
+}
+#endif
 
-       return is_immediate_2(node, &symconsts);
+/**
+ * Check if a DAG starting with root node can be folded into an address mode
+ * as an immediate.
+ *
+ * @param addr    the address mode data so far
+ * @param node    the node
+ * @param negate  if set, the immediate must be negated
+ */
+static int is_immediate(ia32_address_t *addr, const ir_node *node, int negate)
+{
+       int symconsts = (addr->symconst_ent != NULL);
+       return do_is_immediate(node, &symconsts, negate);
 }
 
+/**
+ * Place a DAG with root node into an address mode.
+ *
+ * @param addr    the address mode data so far
+ * @param node    the node
+ * @param negate  if set, the immediate must be negated
+ */
 static void eat_immediate(ia32_address_t *addr, ir_node *node, int negate)
 {
        tarval  *tv;
        ir_node *left;
        ir_node *right;
+       long    val;
 
-       switch(get_irn_opcode(node)) {
+       switch (get_irn_opcode(node)) {
        case iro_Const:
+               /* simply add the value to the offset */
                tv = get_Const_tarval(node);
-               if(negate) {
-                       addr->offset -= get_tarval_long(tv);
+               val = get_tarval_long(tv);
+               if (negate) {
+                       addr->offset -= val;
                } else {
-                       addr->offset += get_tarval_long(tv);
+                       addr->offset += val;
                }
                break;
        case iro_SymConst:
-               if(addr->symconst_ent != NULL) {
-                       panic("Internal error: more than 1 symconst in address "
-                             "calculation");
+               /* place the entity into the symconst */
+               if (addr->symconst_ent != NULL) {
+                       panic("Internal error: more than 1 symconst in address calculation");
                }
                addr->symconst_ent  = get_SymConst_entity(node);
+#ifndef SUPPORT_NEGATIVE_SYMCONSTS
+               assert(!negate);
+#endif
                addr->symconst_sign = negate;
                break;
        case iro_Add:
+               assert(!bitset_is_set(non_address_mode_nodes, get_irn_idx(node)));
                left  = get_Add_left(node);
                right = get_Add_right(node);
                eat_immediate(addr, left, negate);
                eat_immediate(addr, right, negate);
                break;
        case iro_Sub:
+               assert(!bitset_is_set(non_address_mode_nodes, get_irn_idx(node)));
                left  = get_Sub_left(node);
                right = get_Sub_right(node);
                eat_immediate(addr, left, negate);
@@ -129,26 +193,29 @@ static void eat_immediate(ia32_address_t *addr, ir_node *node, int negate)
        }
 }
 
+/**
+ * Place operands of node into an address mode.
+ *
+ * @param addr    the address mode data so far
+ * @param node    the node
+ * @param force   if set, ignore the marking of node as a non-address-mode node
+ *
+ * @return the folded node
+ */
 static ir_node *eat_immediates(ia32_address_t *addr, ir_node *node, int force)
 {
+       if(!force && bitset_is_set(non_address_mode_nodes, get_irn_idx(node)))
+               return node;
+
        if(is_Add(node)) {
                ir_node *left  = get_Add_left(node);
                ir_node *right = get_Add_right(node);
 
-#if 0
-#ifndef AGGRESSIVE_AM
-               if(!force && get_irn_n_edges(node) > 1)
-                       return node;
-#else
-               (void) force;
-#endif
-#endif
-
-               if(is_immediate(addr, left)) {
+               if(is_immediate(addr, left, 0)) {
                        eat_immediate(addr, left, 0);
                        return eat_immediates(addr, right, 0);
                }
-               if(is_immediate(addr, right)) {
+               if(is_immediate(addr, right, 0)) {
                        eat_immediate(addr, right, 0);
                        return eat_immediates(addr, left, 0);
                }
@@ -156,14 +223,7 @@ static ir_node *eat_immediates(ia32_address_t *addr, ir_node *node, int force)
                ir_node *left  = get_Sub_left(node);
                ir_node *right = get_Sub_right(node);
 
-#if 0
-#ifndef AGGRESSIVE_AM
-               if(!force && get_irn_n_edges(node) > 1)
-                       return node;
-#endif
-#endif
-
-               if(is_immediate(addr, right)) {
+               if(is_immediate(addr, right, 1)) {
                        eat_immediate(addr, right, 1);
                        return eat_immediates(addr, left, 0);
                }
@@ -172,28 +232,59 @@ static ir_node *eat_immediates(ia32_address_t *addr, ir_node *node, int force)
        return node;
 }
 
+/**
+ * Try to place a Shl into an address mode.
+ *
+ * @param addr    the address mode data so far
+ * @param node   the node to place
+ *
+ * @return non-zero on success
+ */
 static int eat_shl(ia32_address_t *addr, ir_node *node)
 {
-       ir_node *right = get_Shl_right(node);
-       tarval  *tv;
+       ir_node *shifted_val;
        long     val;
 
-       /* we can only eat a shl if we don't have a scale or index set */
-       if(addr->scale != 0 || addr->index != NULL)
-               return 0;
+       if(is_Shl(node)) {
+               ir_node *right = get_Shl_right(node);
+               tarval  *tv;
 
-       /* we can use shl with 1, 2 or 3 shift */
-       if(!is_Const(right))
+               /* we can use shl with 1, 2 or 3 shift */
+               if(!is_Const(right))
+                       return 0;
+               tv = get_Const_tarval(right);
+               if(!tarval_is_long(tv))
+                       return 0;
+
+               val = get_tarval_long(tv);
+               if(val < 0 || val > 3)
+                       return 0;
+               if(val == 0) {
+                       ir_fprintf(stderr, "Optimisation warning: unoptimized Shl(,0) found\n");
+               }
+
+               shifted_val = get_Shl_left(node);
+       } else if(is_Add(node)) {
+               /* might be an add x, x */
+               ir_node *left  = get_Add_left(node);
+               ir_node *right = get_Add_right(node);
+
+               if(left != right)
+                       return 0;
+               if(is_Const(left))
+                       return 0;
+
+               val         = 1;
+               shifted_val = left;
+       } else {
                return 0;
-       tv = get_Const_tarval(right);
-       if(!tarval_is_long(tv))
+       }
+
+       /* we can only eat a shl if we don't have a scale or index set yet */
+       if(addr->scale != 0 || addr->index != NULL)
                return 0;
-       val = get_tarval_long(tv);
-       if(val < 0 || val > 3)
+       if(bitset_is_set(non_address_mode_nodes, get_irn_idx(node)))
                return 0;
-       if(val == 0) {
-               ir_fprintf(stderr, "Optimisation warning: unoptimized Shl(,0) found\n");
-       }
 
 #ifndef AGGRESSIVE_AM
        if(get_irn_n_edges(node) > 1)
@@ -201,16 +292,17 @@ static int eat_shl(ia32_address_t *addr, ir_node *node)
 #endif
 
        addr->scale = val;
-       addr->index = eat_immediates(addr, get_Shl_left(node), 0);
+       addr->index = shifted_val;
        return 1;
 }
 
+/* Create an address mode for a given node. */
 void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, int force)
 {
        int      res = 0;
        ir_node *eat_imms;
 
-       if(is_immediate(addr, node)) {
+       if(is_immediate(addr, node, 0)) {
                eat_immediate(addr, node, 0);
                return;
        }
@@ -222,8 +314,17 @@ void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, int force)
        }
 #endif
 
+       if(!force && bitset_is_set(non_address_mode_nodes, get_irn_idx(node))) {
+               addr->base = node;
+               return;
+       }
+
        eat_imms = eat_immediates(addr, node, force);
        if(eat_imms != node) {
+               if(force) {
+                       eat_imms = ia32_skip_downconv(eat_imms);
+               }
+
                res  = 1;
                node = eat_imms;
 #ifndef AGGRESSIVE_AM
@@ -232,13 +333,19 @@ void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, int force)
                        return;
                }
 #endif
+               if(bitset_is_set(non_address_mode_nodes, get_irn_idx(node))) {
+                       addr->base = node;
+                       return;
+               }
        }
 
        /* starting point Add, Sub or Shl, FrameAddr */
        if(is_Shl(node)) {
+               /* We don't want to eat add x, x as shl here, so only test for real Shl
+                * instructions, because we want the former as Lea x, x, not Shl x, 1 */
                if(eat_shl(addr, node))
                        return;
-       } else if(is_immediate(addr, node)) {
+       } else if(is_immediate(addr, node, 0)) {
                eat_immediate(addr, node, 0);
                return;
        } else if(be_is_FrameAddr(node)) {
@@ -251,22 +358,30 @@ void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, int force)
        } else if(is_Add(node)) {
                ir_node *left  = get_Add_left(node);
                ir_node *right = get_Add_right(node);
-               assert(force || !is_immediate(addr, left));
-               assert(force || !is_immediate(addr, right));
 
-               if(is_Shl(left) && eat_shl(addr, left)) {
+               if(force) {
+                       left  = ia32_skip_downconv(left);
+                       right = ia32_skip_downconv(right);
+               }
+
+               assert(force || !is_immediate(addr, left, 0));
+               assert(force || !is_immediate(addr, right, 0));
+
+               if(eat_shl(addr, left)) {
                        left = NULL;
-               } else if(is_Shl(right) && eat_shl(addr, right)) {
+               } else if(eat_shl(addr, right)) {
                        right = NULL;
                }
-               if(left != NULL && be_is_FrameAddr(left)) {
+               if(left != NULL && be_is_FrameAddr(left)
+                               && !bitset_is_set(non_address_mode_nodes, get_irn_idx(left))) {
                        assert(addr->base == NULL);
                        assert(addr->frame_entity == NULL);
                        addr->base         = be_get_FrameAddr_frame(left);
                        addr->use_frame    = 1;
                        addr->frame_entity = be_get_FrameAddr_entity(left);
                        left               = NULL;
-               } else if(right != NULL && be_is_FrameAddr(right)) {
+               } else if(right != NULL && be_is_FrameAddr(right)
+                               && !bitset_is_set(non_address_mode_nodes, get_irn_idx(right))) {
                        assert(addr->base == NULL);
                        assert(addr->frame_entity == NULL);
                        addr->base         = be_get_FrameAddr_frame(right);
@@ -298,38 +413,113 @@ void ia32_create_address_mode(ia32_address_t *addr, ir_node *node, int force)
        addr->base = node;
 }
 
+void ia32_mark_non_am(ir_node *node)
+{
+       bitset_set(non_address_mode_nodes, get_irn_idx(node));
+}
 
-typedef struct mark_evn_t mark_evn_t;
-struct mark_evn_t {
-       bitset_t *non_address_nodes;
-};
+static int value_last_used_here(ir_node *here, ir_node *value)
+{
+       ir_node *block = get_nodes_block(here);
+       const ir_edge_t *edge;
+
+       /* If the value is live end it is for sure it does not die here */
+       if (be_is_live_end(lv, block, value)) return 0;
+
+       /* if multiple nodes in this block use the value, then we cannot decide
+        * whether the value will die here (because there is no schedule yet).
+        * Assume it does not die in this case. */
+       foreach_out_edge(value, edge) {
+               ir_node *user = get_edge_src_irn(edge);
+               if (user != here && get_nodes_block(user) == block) {
+                       return 0;
+               }
+       }
 
+       return 1;
+}
 
-static void mark_non_address_nodes(mark_evn_t *env, ir_node *node)
+/**
+ * Walker: mark those nodes that cannot be part of an address mode because
+ * their value must be accessed through a register
+ */
+static void mark_non_address_nodes(ir_node *node, void *env)
 {
-       bitset_set(env->non_address_nodes, get_irn_idx(node));
-
-       if(is_Load(node)) {
-               ir_node *ptr = get_Load_ptr(node);
-               ir_node *mem = get_Load_mem(node);
-
-               mark_non_address_nodes(env, mem);
-               (void) ptr;
-       } else if(is_Store(node)) {
-               ir_node *val = get_Store_value(node);
-               ir_node *ptr = get_Store_ptr(node);
-               ir_node *mem = get_Store_mem(node);
-
-               mark_non_address_nodes(env, val);
-               mark_non_address_nodes(env, mem);
-               (void) ptr;
-       } else {
-               int i;
-               int arity = get_irn_arity(node);
+       int i, arity;
+       ir_node *val;
+       ir_node *left;
+       ir_node *right;
+       ir_mode *mode;
+       (void) env;
+
+       mode = get_irn_mode(node);
+       if(!mode_is_int(mode) && !mode_is_reference(mode) && mode != mode_b)
+               return;
+
+       switch(get_irn_opcode(node)) {
+       case iro_Load:
+               /* Nothing to do. especially do not mark the pointer, because we want to
+                * turn it into AM. */
+               break;
+
+       case iro_Store:
+               /* Do not mark the pointer, because we want to turn it into AM. */
+               val = get_Store_value(node);
+               bitset_set(non_address_mode_nodes, get_irn_idx(val));
+               break;
+
+       case iro_Shl:
+       case iro_Add:
+               /* only 1 user: AM folding is always beneficial */
+               if(get_irn_n_edges(node) <= 1)
+                       break;
+
+               /* for adds and shls with multiple users we use this heuristic:
+                * we do not fold them into address mode if their operands don't live
+                * out of the block, because in this case we will reduce register
+                * pressure. Otherwise we fold them in aggressively in the hope, that
+                * the node itself doesn't exist anymore and we were able to save the
+                * register for the result */
+               left  = get_binop_left(node);
+               right = get_binop_right(node);
+
+               /* Fold AM if any of the two operands does not die here.  This duplicates
+                * an addition and has the same register pressure for the case that only
+                * one operand dies, but is faster (on Pentium 4).
+                * && instead of || only folds AM if both operands do not die here */
+               if (!value_last_used_here(node, left) ||
+                               !value_last_used_here(node, right)) {
+                       return;
+               }
+
+               /* At least one of left and right are not used by anyone else, so it is
+                * beneficial for the register pressure (if both are unused otherwise,
+                * else neutral) and ALU use to not fold AM. */
+               bitset_set(non_address_mode_nodes, get_irn_idx(node));
+               break;
+
+       default:
+               arity = get_irn_arity(node);
 
                for(i = 0; i < arity; ++i) {
                        ir_node *in = get_irn_n(node, i);
-                       mark_non_address_nodes(env, in);
+                       bitset_set(non_address_mode_nodes, get_irn_idx(in));
                }
+               break;
        }
 }
+
+void ia32_calculate_non_address_mode_nodes(be_irg_t *birg)
+{
+       ir_graph *irg = be_get_birg_irg(birg);
+
+       lv                     = be_assure_liveness(birg);
+       non_address_mode_nodes = bitset_malloc(get_irg_last_idx(irg));
+
+       irg_walk_graph(irg, NULL, mark_non_address_nodes, NULL);
+}
+
+void ia32_free_non_address_mode_nodes(void)
+{
+       bitset_free(non_address_mode_nodes);
+}